Add UI and API docs custom context path support #12923

PierreBesson · 2020-11-01T12:25:29Z

Depend on #jhipster/jhipster-bom#42
Fixes #12649

These changes follow @clocken's great suggestions and analysis for supporting a custom context-path for JHipster apps including UI and openapi docs support.

How to test

export SERVER_SERVLET_CONTEXT_PATH=/myapp
mvn || gradle

TODO:

update docs (relating to custom path and war support)

CLAassistant · 2020-11-01T12:25:34Z

All committers have signed the CLA.

DanielFran · 2020-11-01T12:29:49Z

@PierreBesson It seems you have conflicts and you need to sign CLA also

PierreBesson · 2020-11-01T15:18:00Z

@clocken Could you sign the CLA please as I have included your commit. Thanks!

PierreBesson · 2020-11-01T15:21:51Z

As for the conflict, I am unable to see it locally 🤔.

pascalgrimaud · 2020-11-01T15:31:04Z

@PierreBesson : check with your main branch, instead of master branch ;)

PierreBesson · 2020-11-01T16:39:11Z

I had totally forgot that it's not the same.

clocken · 2020-11-09T20:02:58Z

@PierreBesson Thanks for the implementation but it looks like we had a bit of a "race condition" here.
In the meantime the client app has switched to Angular CLI and the webpack.common.js.ejs has been removed - see 805e5cc.
I accounted for that in a copy of your branch and also removed the quotes around the default value for the management-include-pattern. I also found two more places for relative paths in the React and Vue clients.
Feel free to cherry-pick again from my branch:
clocken/ui-context-path-support

PS: PR for doc update is here: jhipster.github.io#1030

ruddell · 2020-11-13T21:07:09Z

Before merging, please make sure a path with multiple slashes (such as /admin/metrics) is tested both with and without a context-path. This includes refreshing or directly navigating to the path. This will fail if the context-path is relative (like in @clocken's changes).

Without the changes from @clocken, this PR causes the initial page load to fail in prod (attempts to find /main.js instead of /myapp/main.js).

PierreBesson · 2020-12-13T20:48:48Z

I think the PR is finalized now. Let's validate those cases (including the metrics page as @ruddell pointed out) :

Framework	UI without context-path	UI with context-path
Angular
React
Vue

Note: the control center should also be checked for context-path support.

clocken · 2020-12-18T13:14:23Z

Ok, I'm done testing now. The base-href has to be reverted back to an absolute path and set to a context path manually to be able to page refresh or directly navigate to paths with multiple slashes, changes ready for cherry-picking in d072af0 @PierreBesson. I also updated the docs accordingly.
With that small revert all cases tested positive:

Framework	UI without context-path	UI with context-path
Angular	✔️	✔️
React	✔️	✔️
Vue	✔️	✔️

PierreBesson · 2020-12-20T18:13:39Z

I have done extensive testing and rebased to main. I confirm @clocken tests and everything should be fine now. However CI does seem to have issues due to loading jhipster dependencies 7.0.0-beta and not the 7.0.0-SNAPSHOT from the context-path branch. Maybe this is related to the current in-progress release.

@pascalgrimaud if this is not included in the first v7 beta, it can be included in the next beta version.

pascalgrimaud · 2020-12-20T18:15:36Z

yes, I think it's better to include it in beta.1
The beta.0 is for tomorrow, I prefer to secure the release

mraible · 2021-01-13T03:36:00Z

Any updates @PierreBesson?

* inject <base href="./"> instead of <base href="/"> into index.html via Webpack * use '../swagger-resources' for axios-request in SwaggerUI * use '..' + resource.location for Resource-URLs displayed in SwaggerUI

…es to take into account the application context-path fixes jhipster#12649

Directly set it in the template and remove webpack.common.js.ejs as client app now uses AngularCLI.

Be consistent with the default api doc pattern :)

Emit relative paths for hashed resources from webpack asset modules

This reverts commit 641f991.

mshima

index.html moved to https://github.com/jhipster/generator-jhipster/blob/main/generators/client/templates/common/src/main/webapp/index.html.ejs

swagger-ui/index.html moved to https://github.com/jhipster/generator-jhipster/blob/main/generators/client/templates/common/src/main/webapp/swagger-ui/index.html.ejs.

They should be dropped and any changes should be implemented there.

generators/generator-constants.js

Co-authored-by: Marcelo Shima <marceloshima@gmail.com>

PierreBesson · 2021-03-06T13:56:25Z

index.html moved to https://github.com/jhipster/generator-jhipster/blob/main/generators/client/templates/common/src/main/webapp/index.html.ejs

swagger-ui/index.html moved to https://github.com/jhipster/generator-jhipster/blob/main/generators/client/templates/common/src/main/webapp/swagger-ui/index.html.ejs.

They should be dropped and any changes should be implemented there.

Yes I have also noticed this. Thanks !

PierreBesson · 2021-03-07T18:39:57Z

I am currently not able to make this works on my machine. This is not such a big change but it might be impacted by some recent changes in spring boot 2.4, I'm not sure.
I repeat myself but this would be really nice to have for microservices that use a context-path.

pascalgrimaud · 2021-03-07T19:10:10Z

There are several major changes with Spring Boot 2.4:

all gateway are reactive now
swagger ui was broken until the fix by @nassimerrahoui, few days ago -> Add swagger for reactive gateway #14029
then, the swagger ui was still broken because of compression, and has been fixed by @nassimerrahoui few hours ago -> Handle swagger with compression for reactive gateway #14204

We had to adapt our code, to change the result from API, it was not easy but I'm confident it's done today.
For adding support for context path, we need to look at these 2 PRs and do similar change. It would be with the same complexity.

Important thing, about context path. You can easily add this property, but there will be several things which are broken:

npm start, will be broken
swagger
logout with OAuth2
deployment
etc

I forgot probably some items, as I already did this for my customer. And as I said, I'm not sure we can automate this, because the property comes from Spring Boot property and I needed to put this context path in some .vue / .ts file. These files can't guess this property.
So adding this support is difficult IMO :-)

DanielFran · 2021-03-13T16:49:40Z

@PierreBesson @pascalgrimaud Following #14250, this PR should be closed?

PierreBesson force-pushed the ui-context-path-support branch from 018ea1d to 3c6608f Compare November 1, 2020 16:43

PierreBesson force-pushed the ui-context-path-support branch from 3c6608f to 9db704a Compare November 9, 2020 19:49

DanielFran added the pr: needs-change label Dec 13, 2020

PierreBesson force-pushed the ui-context-path-support branch from 9db704a to f6c8ac6 Compare December 13, 2020 20:40

clocken mentioned this pull request Dec 15, 2020

add jhipster.api-docs.management-include-pattern property jhipster/jhipster-bom#42

Merged

clocken mentioned this pull request Dec 20, 2020

Deploying JHipster with a context path breaks SwaggerUI #12649

Closed

1 task

PierreBesson force-pushed the ui-context-path-support branch from a4043bc to 3ac3b02 Compare December 20, 2020 16:37

clocken and others added 9 commits March 6, 2021 14:22

Use relative URLs for client app to enable context-based deployments

ffdb2fe

* inject <base href="./"> instead of <base href="/"> into index.html via Webpack * use '../swagger-resources' for axios-request in SwaggerUI * use '..' + resource.location for Resource-URLs displayed in SwaggerUI

change api-docs and management api docs include patterns default valu…

514f9df

…es to take into account the application context-path fixes jhipster#12649

Use relative base href in index.html

b03c44d

Directly set it in the template and remove webpack.common.js.ejs as client app now uses AngularCLI.

Remove quotes around management api doc include pattern default value

04bdb3d

Be consistent with the default api doc pattern :)

Use relative paths in Vue client

d544ac8

Emit relative paths for hashed resources from webpack asset modules

Use relative path for Swagger UI in react client

abbaaa5

Revert base-href to absolute path

a70c97b

Revert "change jhipster dependency to 7.0.0-SNAPSHOT"

2b71b32

This reverts commit 641f991.

add context-path property to eureka and consul metadata map

b2a7050

PierreBesson force-pushed the ui-context-path-support branch from f104ccf to b2a7050 Compare March 6, 2021 13:26

fix bad rebase

c8c630b

mshima reviewed Mar 6, 2021

View reviewed changes

generators/generator-constants.js Outdated Show resolved Hide resolved

Update generators/generator-constants.js

e2b6001

Co-authored-by: Marcelo Shima <marceloshima@gmail.com>

PierreBesson mentioned this pull request Mar 9, 2021

Correctly set the spring context-path for api-docs #14250

Merged

5 tasks

pascalgrimaud closed this Mar 13, 2021

pascalgrimaud added this to the v7.0.0 milestone Mar 20, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add UI and API docs custom context path support #12923

Add UI and API docs custom context path support #12923

PierreBesson commented Nov 1, 2020

CLAassistant commented Nov 1, 2020 •

edited

Loading

DanielFran commented Nov 1, 2020

PierreBesson commented Nov 1, 2020

PierreBesson commented Nov 1, 2020

pascalgrimaud commented Nov 1, 2020

PierreBesson commented Nov 1, 2020 •

edited

Loading

clocken commented Nov 9, 2020 •

edited

Loading

ruddell commented Nov 13, 2020 •

edited

Loading

PierreBesson commented Dec 13, 2020

clocken commented Dec 18, 2020

PierreBesson commented Dec 20, 2020

pascalgrimaud commented Dec 20, 2020

mraible commented Jan 13, 2021

mshima left a comment

PierreBesson commented Mar 6, 2021

PierreBesson commented Mar 7, 2021

pascalgrimaud commented Mar 7, 2021

DanielFran commented Mar 13, 2021

Add UI and API docs custom context path support #12923

Add UI and API docs custom context path support #12923

Conversation

PierreBesson commented Nov 1, 2020

How to test

CLAassistant commented Nov 1, 2020 • edited Loading

DanielFran commented Nov 1, 2020

PierreBesson commented Nov 1, 2020

PierreBesson commented Nov 1, 2020

pascalgrimaud commented Nov 1, 2020

PierreBesson commented Nov 1, 2020 • edited Loading

clocken commented Nov 9, 2020 • edited Loading

ruddell commented Nov 13, 2020 • edited Loading

PierreBesson commented Dec 13, 2020

clocken commented Dec 18, 2020

PierreBesson commented Dec 20, 2020

pascalgrimaud commented Dec 20, 2020

mraible commented Jan 13, 2021

mshima left a comment

Choose a reason for hiding this comment

PierreBesson commented Mar 6, 2021

PierreBesson commented Mar 7, 2021

pascalgrimaud commented Mar 7, 2021

DanielFran commented Mar 13, 2021

CLAassistant commented Nov 1, 2020 •

edited

Loading

PierreBesson commented Nov 1, 2020 •

edited

Loading

clocken commented Nov 9, 2020 •

edited

Loading

ruddell commented Nov 13, 2020 •

edited

Loading