Exclude context path from application generated links

[litvinovg]

VIVO GitHub issue: (please link to issue)
Vitro PR

What does this pull request do?

New boolean configuration property context.path.exclude to exclude tomcat application context from generated links useful in case the application is deployed with reverse proxy.

What's new?

Created context.path.exclude configuration property to exclude context path from generated links.
Replaced calls for context path to utility methods that allow overriding default context path.

How should this be tested?

Default behavior when configuration property is not set should be the same.

• To test application behind proxy one would need to configure webserver and tomcat in proxy mode like described in workaround of linked issue and set context.path.exclude = true in runtime.properties
• General navigation between application pages
• Authorization
• Edit this individual page should work the same

#Additional notes

• Duplicate tests were removed.
• This change require documentation to be updated.

Interested parties

@VIVO-project/vivo-committers

Reviewers' expertise

Candidates for reviewing this PR should have some of the following expertises:

1. Java

Reviewers' report template

General comment

A reviewer should provide here comments and suggestions for requested changes if any.

Testing

A reviewer should briefly describe here how it was tested

Code reviewing

A reviewer should briefly describe here which part was code reviewed

[chenejac]

@litvinovg this is not fully functional in my case. I conducted the following testing steps on windows:

1. Installed nginx for Windows
2. Configure nginx.conf

location / {
proxy_pass http://localhost:8080/vivo/;
include proxy_params;
}

3. Add proxy_params file with the following content

proxy_set_header Host $http_host;
proxy_set_header X-Real-IP $remote_addr;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
proxy_set_header X-Forwarded-Proto $scheme;

4. Add in vivo_home/config/runtime.properties

context.path=

The first page is loaded properly including css. Moreover, I can browse through individual pages, persons, organizations, etc. Search page is also working.

I can't login. Also, I can't open any visualization (capability map, map of science, co-author network, and there is always the same message:

Inappropriate query parameters were submitted.

[chenejac]

@litvinovg after configuring sessionCookiePath="/" for Context in tomcat, I can log in, but the issue with visualization is still there.

I can edit data properties, for instance publication date for an academic article, but if I select Edit individual I am getting the error message (in the form of java script alert) - A server error has occurred.

[litvinovg]

Visualizations should work now, I reverted one mistakenly made change that broke it.
Regarding "Edit this individual" page please take a look at the apache2 example configuration in the issue.
There is a need for specific location match for requests that start with /vivo_app_name/dwr/ as DWR can't be configured to use custom context path.
So I guess you need something like that in addition to your configuration in nginx.conf
location ^~ /vivo/dwr/ {
proxy_pass http://localhost:8080;
include proxy_params;
}

[chenejac]

Visualizations should work now, I reverted one mistakenly made change that broke it. Regarding "Edit this individual" page please take a look at the apache2 example configuration in the issue. There is a need for specific location match for requests that start with /vivo_app_name/dwr/ as DWR can't be configured to use custom context path. So I guess you need something like that in addition to your configuration in nginx.conf location ^~ /vivo/dwr/ { proxy_pass http://localhost:8080; include proxy_params; }

@litvinovg I can confirm visualizations work now. Moreover, after additional configuration DWR is not an issue anymore. In my case, the configuration is

 location /vivo/dwr/ {
			proxy_pass http://localhost:8080;
			include proxy_params;
        }
		
location / {
			proxy_pass http://localhost:8080/vivo/;
			include proxy_params;
        }

I think we should point/warn customers to this specific location configuration for DWR in example.runtime.properties in the comment above contextPath parameter (in Vitro and VIVO).

[litvinovg]

Rebased on top of main branch

[brianjlowe]

Tested and works great! Same minor comments about example.runtime.properties as on companion Vitro PR.

[litvinovg]

Description for the new configuration property has been updated.