#DevHack: Dynamic manifests for Progressive Web App aka PWA

This post is over a year old, some of this information may be out of date.

In the previous #DevHack, I told you how to use deep links in your PWA for Microsoft Teams. This approach I currently implemented in one of my proof of concepts. Another functionality that my POC needed to have is to have dynamic manifest creating for the PWA.

{{< blockquote type="info" text="#DevHack: Deep linking to Microsoft Teams in Android and iOS

In this #DevHack, I will tell you how you can make it possible to get dynamic manifests for your PWA using Azure Static Web Apps and Azure Functions.

Approaches

When I started my journey with PWAs and dynamic manifests, I found two approaches:

Create the manifest on the fly with JavaScript;
Use a dynamically generated manifest.

The first approach is what I used from the start. This approach does not require anything special, except some extra JavaScript code to add the page’s manifest data.

This approach worked fine on iOS and Windows/macOS, but we noticed a different behavior when testing it on Android devices. Android never recognized our PWA as a “real” PWA. Instead, Android created it as a bookmark to the site.

Solution

The only working solution for dynamically generated manifests is to make use of an API. My POC created as an Azure Static Web App can handle this by adding an Azure Function.

1
import { AzureFunction, Context, HttpRequest } from "@azure/functions";
2

3
const httpTrigger: AzureFunction = async function (
4
  context: Context,
5
  req: HttpRequest
6
): Promise<void> {
7
  const name = req.query.name;
8
  const enityId = req.query.enityId;
9
  const appId = req.query.appId;
10

11
  context.res = {
12
    body: {
13
      name,
14
      short_name: name,
15
      description: name,
16
      background_color: "#ffffff",
17
      theme_color: "#ffffff",
18
      display: "standalone",
19
      start_url: `/entity/?appId=${appId}&enityId=${enityId}&name=${name}`,
20
      icons: [
21
        {
22
          src: "/android-chrome-192x192.png",
23
          sizes: "192x192",
24
          type: "image/png",
25
        },
26
        {
27
          src: "/android-chrome-512x512.png",
28
          sizes: "512x512",
29
          type: "image/png",
30
        },
31
        {
32
          src: "/maskable_icon.png",
33
          sizes: "196x196",
34
          type: "image/png",
35
          purpose: "any maskable",
36
        },
37
      ],
38
    },
39
    headers: {
40
      "Content-Type": "application/json",
41
    },
42
  };
43
};
44

45
export default httpTrigger;

In my React application, I call the Azure Function with the following logic:

1
<Helmet>
2
  <link id="teams_manifest" rel="manifest"
3
  href={`/api/manifest.webmanifest?${QS_APP_ID}=${encodeURIComponent(appId)}&${QS_ENTITY_ID}=${encodeURIComponent(enityId)}&${QS_NAME}=${appName}`}
4
  />
5
</Helmet>

#DevHack: Dynamic manifests for Progressive Web App aka PWA

Approaches

Solution

Related articles

#DevHack: Simple caching in Node.js Azure Functions

#DevHack: Microsoft Edge - Network Console

#DevHack: Deep linking to Microsoft Teams in Android and iOS

Report issues or make changes on GitHub

Comments

Elio Struyf