Doc UI not loading on servers

[shurwit]

When attempting to load the Swagger documentation UI on the Core BB hosted on the servers it currently returns a blank page (see https://api.rokwire.illinois.edu/core/doc/ui/index.html). This is consistent across all server environments (dev, test, prod), however issue does not seem to occur when running locally. This issue also does not occur on the version hosted on our ROKMETRO servers.

After investigating with the browser "inspect" tool, we found that this page is making several requests that are failing with 404 errors.

GET https://api.rokwire.illinois.edu/core/doc/ui/swagger-ui.css net::ERR_ABORTED 404  index.html:68
GET https://api.rokwire.illinois.edu/core/doc/ui/swagger-ui-bundle.js net::ERR_ABORTED 404  index.html:69
GET https://api.rokwire.illinois.edu/core/doc/ui/swagger-ui-standalone-preset.js net::ERR_ABORTED 404  index.html:73
Uncaught ReferenceError: SwaggerUIBundle is not defined
    at window.onload (index.html:73:14)

We verified that on our servers these requests return successfully with content served by the http-swagger package.

I found a related issue on the http-swagger library: swaggo/http-swagger#10

[shurwit]

Hi @petyos, after looking into this for a while I am still not sure what could be causing this in the Illinois environments. Could you please take a look when you get a chance to see if you notice any issues? Thanks!

[petyos]

Hi @shurwit , for me it works on dev but not on test and prod.
BTW the url for accessing it is https://api-dev.rokwire.illinois.edu/core/doc/ui/ , i.e. without index.html at the end.
test and prod does not work for me.

cc @stefanvit

[shurwit]

Hi @shurwit , for me it works on dev but not on test and prod. BTW the url for accessing it is https://api-dev.rokwire.illinois.edu/core/doc/ui/ , i.e. without index.html at the end. test and prod does not work for me.

cc @stefanvit

Hi @petyos, thanks for trying this out! This is very interesting because dev is working for me too now. I am pretty sure I tried it earlier today and found that it had the same issue as test and prod. The https://api-dev.rokwire.illinois.edu/core/doc/ui/ endpoint simply reroutes to https://api-dev.rokwire.illinois.edu/core/doc/ui/index.html so I do not believe that should make a difference.

Since you mentioned it, one interesting thing to note is that https://api.rokwire.illinois.edu/core/doc/ui/ is actually rerouting to https://api.rokwire.illinois.edu/core/doc/index.html (missing the /ui component), while in dev it goes to the correct path (including the /ui component). I suspect this may indicate that the base path for the Swagger handler is getting mixed up in some cases. For example, it looks like it is expecting to find/serve the internal documents (index.html, swagger-ui-bundle.js...) on the /core/doc path, while they are supposed to be hosted on the /core/doc/ui path. I am still not sure what would be causing that mixup though.

[stefanvit]

HI @petyos @shurwit, i've been trying to find the solution all day. I think the problem is somewhere in the library but I couldn't find it.

[shurwit]

HI @petyos @shurwit, i've been trying to find the solution all day. I think the problem is somewhere in the library but I couldn't find it.

Hi @stefanvit, thanks for looking into this! I'll take another look today too.

[stefanvit]

@shurwit Thanks!

[shurwit]

This issue seems to have resolved itself for now. This may have been the result of an issue with a specific deployment. Closing for now