Hosting SPA with Static Website option on Azure Blob Storage (clean URLs and Deep links)

14
votes

I have succesfully set up a static website on Azure Blob storage using the $web container as advised within the Microsoft documentation. In addition, I have defined index.html for both the 'Index Document Name' and the 'Error Document Name'. This is because I want my JavaScript application to handle the 404 responses.

However, when looking at the network tab in Chrome, I can see that a 404 is being thrown for the URL that I am requesting, despite the page actually working.

My theory is as follows:

  • Azure checks to see if the 'file' exists
  • If the file exists, it returns it
  • If the file doesn't exist, it throws a 404 and rewrites the url to the 'Error Document Name' i.e. index.html in my case (hence my pages still work)

The problem I have is that my URLs are clean urls, for example:

/activities/some-slug is never going to exist as a file, this just tells my JavaScript application where to route the request i.e. what view to load.

Just to be clear, the page does work because it is still routing 404 errors to index.html.

How can I tell Azure blob to just route absolutely everything to index.html and let my app throw the 404 if necessary?

We do have a Premium Verizon CDN set up already because I was not originally aware of the static website option on Azure Blob. If the CDN is the best route, please can you provide instructions on how to configure the CDN to provide what I am looking for?

What I have tried/researched

I have read numerous articles (specifically the comments in this one) and I believe that there may be various solutions i.e. Azure Functions, Proxy, CDN etc. That said, none provide clear instructions of what to actually do with those specific services.

I usually work on AWS so am not familiar with all of the Azure services and available configurations.

2
azuresingle-page-applicationazure-storage-blobsstatic-siteazure-cdn
Did you ever find a solution for this? Because I am in the same boat as you, and I was just about to follow the same approach you did, but I don't want 404 status codes actually being thrown. I just want to catch every URL with my SPA. – Lev
@Lev - I am not familiar enough with Azure to know all of the potential solutions but I am confident that there are various choices. Fortunately for me, we require the Premium CDN (for other reasons), and this offers the required rewrite functionality to achieve what I need. – Ben Carey
Actually, I found the solution last night as well. It is the rewrite URL functionality, which is now a part of the Standard Microsoft CDN plan. All the references and documentation suggests you need the premium plan, but it was added to the standard plan some time last year. :) – Lev

2 Answers

24
votes

I think I found a solution

  1. Add a new rule

  2. Condition: URL file extension

    a. Operator: Less than

    b. Extension: 1

    c. Case transform: No transform

    [This basically means that the URL requested has no file (extension) but is a route of the app which will be taken care of by the app routing]

  3. Action: URL rewrite

    a. Source pattern: /

    b. Destination: /index.html

    c. Preserve unmatched path: No

  4. Save rule

Screenshot.

2
votes

Kudos to Andreas Wendl at https://github.com/MicrosoftDocs/azure-docs/issues/43257#issuecomment-580668444

Here's a simpler / possibly more correct solution:

enter image description here

  • leave /static/* be
  • rewrite everything else to /index.html

So, index.html is served in response to deep links like /users/ and let's say /users/alexa.siri.