openfaas / of-watchdog

Reverse proxy for STDIO and HTTP microservices
MIT License
262 stars 115 forks source link

[Feature Request] Static Mode With Catch-all Capability #94

Open Janaka-Steph opened 4 years ago

Janaka-Steph commented 4 years ago

This issue is a feature request asking to add a catch-all capability to the static mode. The static server should redirect every possible url pointed to the function to the root path. Example: http:127.0.0.1:8080/function/hello/subpath -> http:127.0.0.1:8080/function/hello

In Nginx, this is accomplished with the try_files directive. https://docs.nginx.com/nginx/admin-guide/web-server/serving-static-content/#trying-several-options

Current Behaviour

Currently, requesting any function subpath, i.e http:127.0.0.1:8080/function/hello/subpath, will return a 404 error.

Context

This capability is mandatory in the context of Single Page Applications, like React.js apps. Using Hash History adding # in the URL brings other issues and is not a valid solution for professional modern web applications. A Single Page Application technically only have a single index.html, and a server should redirect every possible url pointed to the domain at this index.html located at the root.

In Nginx, we implement a catch-all rule for SPA like so:

location / {
    try_files  $uri  $uri/  index.html;
}

Link to your project or a code example to reproduce issue

Minimal React.js Single Page Application packaged for OpenFaaS with the dockerfile template and the watchdog in static mode: https://github.com/Janaka-Steph/react-spa-openfaas

alexellis commented 4 years ago

Hi @Janaka-Steph thanks for your interest in the project and for writing up an example.

Using Hash History adding # in the URL brings other issues and is not a valid solution for professional modern web applications.

Can you substantiate that claim?

If you redirect every URI to index.html, how do you expect to serve your CSS and JS bundles? I don't quite follow that part.

Alex

Janaka-Steph commented 4 years ago

If you redirect every URI to index.html, how do you expect to serve your CSS and JS bundles?

Yes, we should not redirect every possible url, only the ones that fails. In Nginx, the try_files directive will try the request, and fallback otherwise. In Express.js, we apply the static middleware before any others.

Why not Hash History?

The first issue is subjective, I think that a # in the url is ugly. The second issue is that Hash History is not SEO friendly.

Feel free to close this issue if you think that adding this feature is out of the scope of the static mode.

matart15 commented 3 years ago

I want this to be implemented as well.

Now I am using an unnecessary express server to serve my react app