@appsemble/node-utils 0.37.0 → 0.37.2

package/README.md

@@ -1,9 +1,9 @@
-# ![](https://gitlab.com/appsemble/appsemble/-/raw/0.37.0/config/assets/logo.svg) Appsemble Node Utilities
+# ![](https://gitlab.com/appsemble/appsemble/-/raw/0.37.2/config/assets/logo.svg) Appsemble Node Utilities
 
 > NodeJS utilities used by Appsemble internally.
 
 [![npm](https://img.shields.io/npm/v/@appsemble/node-utils)](https://www.npmjs.com/package/@appsemble/node-utils)
-[![GitLab CI](https://gitlab.com/appsemble/appsemble/badges/0.37.0/pipeline.svg)](https://gitlab.com/appsemble/appsemble/-/releases/0.37.0)
+[![GitLab CI](https://gitlab.com/appsemble/appsemble/badges/0.37.2/pipeline.svg)](https://gitlab.com/appsemble/appsemble/-/releases/0.37.2)
 [![Prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://prettier.io)
 
 ## Table of Contents
@@ -26,5 +26,5 @@ compatibility is not guaranteed.
 
 ## License
 
-[LGPL-3.0-only](https://gitlab.com/appsemble/appsemble/-/blob/0.37.0/LICENSE.md) ©
+[LGPL-3.0-only](https://gitlab.com/appsemble/appsemble/-/blob/0.37.2/LICENSE.md) ©
 [Appsemble](https://appsemble.com)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@appsemble/node-utils",
-  "version": "0.37.0",
+  "version": "0.37.2",
   "description": "NodeJS utilities used by Appsemble internally.",
   "keywords": [
     "app",
@@ -40,9 +40,9 @@
     "test": "vitest"
   },
   "dependencies": {
-    "@appsemble/lang-sdk": "0.37.0",
-    "@appsemble/types": "0.37.0",
-    "@appsemble/utils": "0.37.0",
+    "@appsemble/lang-sdk": "0.37.2",
+    "@appsemble/types": "0.37.2",
+    "@appsemble/utils": "0.37.2",
     "@formatjs/fast-memoize": "^2.0.0",
     "@fortawesome/fontawesome-free": "^6.0.0",
     "@inquirer/prompts": "^8.0.0",

package/resource.d.ts

@@ -17,6 +17,11 @@ export declare function serializeServerResource(data: any): JsonValue | {
     assets: TempFile[];
 };
 export type SerializedServerResourceBody = ReturnType<typeof serializeServerResource>;
+export type SerializedMultipartBody = Extract<SerializedServerResourceBody, {
+    resource: JsonValue;
+    assets: TempFile[];
+}>;
+export declare function isSerializedMultipartBody(value: SerializedServerResourceBody): value is SerializedMultipartBody;
 /**
  * Get the resource definition of an app by name.
  *

package/resource.js

@@ -44,7 +44,7 @@ export function serializeServerResource(data) {
         assets,
     };
 }
-function isSerializedMultipartBody(value) {
+export function isSerializedMultipartBody(value) {
     return (value != null &&
         typeof value === 'object' &&
         !Array.isArray(value) &&

package/server/routes/appRouter/indexHandler.d.ts

@@ -2,4 +2,4 @@ import { type Middleware } from 'koa';
 import { type Options } from '../../types.js';
 export declare const bulmaURL: string;
 export declare const faURL: string;
-export declare function createIndexHandler({ createSettings, getApp, getAppDetails, getAppMessages, getAppUrl, getCsp, getHost, }: Options): Middleware;
+export declare function createIndexHandler(options: Options): Middleware;

package/server/routes/appRouter/indexHandler.js

@@ -1,4 +1,4 @@
-import { randomBytes } from 'node:crypto';
+import { createHash, randomBytes } from 'node:crypto';
 import { getAppBlocks } from '@appsemble/lang-sdk';
 import { createThemeURL, defaultLocale, mergeThemes } from '@appsemble/utils';
 import { organizationBlocklist } from '../../../organizationBlocklist.js';
@@ -6,8 +6,50 @@ import { makeCSP, render } from '../../../render.js';
 import { bulmaVersion, faVersion } from '../../../versions.js';
 export const bulmaURL = `/bulma/${bulmaVersion}/bulma.min.css`;
 export const faURL = `/fa/${faVersion}/css/all.min.css`;
-export function createIndexHandler({ createSettings, getApp, getAppDetails, getAppMessages, getAppUrl, getCsp, getHost, }) {
+function hash(value) {
+    return createHash('sha256').update(JSON.stringify(value)).digest('base64url');
+}
+function getAppUpdated(app) {
+    return app.$updated ?? '';
+}
+function getAppSnapshotId(app) {
+    return app.version ?? 'none';
+}
+function getSettingsCacheKey({ app, host, hostname, identifiableBlocks, languages, }) {
+    const blocks = identifiableBlocks
+        .map(({ type, version }) => ({ type, version }))
+        .sort((a, b) => a.type.localeCompare(b.type) || a.version.localeCompare(b.version));
+    return [
+        'app-settings',
+        app.id,
+        getAppUpdated(app),
+        getAppSnapshotId(app),
+        hash({ host, hostname }),
+        hash(languages),
+        hash(blocks),
+    ].join(':');
+}
+function getMessagesCacheKey({ app }) {
+    return ['app-messages', app.id, getAppUpdated(app)].join(':');
+}
+async function getCachedValue(cache, key, fallback) {
+    if (!cache) {
+        return [await fallback(), 'disabled'];
+    }
+    const cached = await cache.get(key);
+    if (cached.status === 'hit') {
+        return [cached.value, 'hit'];
+    }
+    const value = await fallback();
+    if (cached.status === 'miss') {
+        const setStatus = await cache.set(key, value);
+        return [value, setStatus === 'error' ? 'error' : 'miss'];
+    }
+    return [value, cached.status];
+}
+export function createIndexHandler(options) {
     return async (ctx) => {
+        const { appServingCache, createSettings, getApp, getAppDetails, getAppMessages, getAppUrl, getCsp, getHost, } = options;
         const { hostname, path } = ctx;
         const host = getHost({ context: ctx });
         // Prevent mime-type sniffing,
@@ -40,21 +82,26 @@ export function createIndexHandler({ createSettings, getApp, getAppDetails, getA
             return;
         }
         const defaultLanguage = app.definition.defaultLanguage || defaultLocale;
-        const appMessages = await getAppMessages({ app, context: ctx });
+        const [appMessages, messagesCacheStatus] = await getCachedValue(appServingCache, getMessagesCacheKey({ app }), () => getAppMessages({ app, context: ctx }));
+        ctx.set('X-Appsemble-Messages-Cache', messagesCacheStatus);
         const languages = [
             ...new Set([...appMessages.map(({ language }) => language), defaultLanguage]),
         ].sort();
         const identifiableBlocks = getAppBlocks(app.definition);
         const nonce = randomBytes(16).toString('base64');
-        const [settingsHash, settings] = await createSettings({
-            context: ctx,
-            app,
-            host,
-            hostname,
-            identifiableBlocks,
-            languages,
-            nonce,
+        const [{ settingsHash, settings }, settingsCacheStatus] = await getCachedValue(appServingCache, getSettingsCacheKey({ app, host, hostname, identifiableBlocks, languages }), async () => {
+            const [digest, script] = await createSettings({
+                context: ctx,
+                app,
+                host,
+                hostname,
+                identifiableBlocks,
+                languages,
+                nonce,
+            });
+            return { settingsHash: digest, settings: script };
         });
+        ctx.set('X-Appsemble-Settings-Cache', settingsCacheStatus);
         const csp = getCsp({ app, settingsHash, hostname, host, nonce });
         ctx.set('Content-Security-Policy', makeCSP(csp));
         const updated = app.$updated ? new Date(app.$updated) : new Date();

package/server/routes/appRouter/serviceWorkerHandler.js

@@ -1,3 +1,4 @@
+import { createHash } from 'node:crypto';
 import { readFile } from 'node:fs/promises';
 export function createServiceWorkerHandler() {
     return async (ctx) => {
@@ -6,8 +7,18 @@ export function createServiceWorkerHandler() {
         const serviceWorker = await (production
             ? readFile(new URL('../../../../../dist/app/service-worker.js', import.meta.url), 'utf8')
             : ctx.fs.promises.readFile(filename, 'utf8'));
-        ctx.body = serviceWorker;
         ctx.type = 'application/javascript';
+        // Browsers bypass their HTTP cache when checking for service worker updates, so a strong ETag
+        // lets them revalidate with a 304 instead of downloading the full script on every check.
+        ctx.set('etag', `"${createHash('sha256').update(serviceWorker).digest('base64url')}"`);
+        ctx.set('cache-control', 'no-cache');
+        ctx.status = 200;
+        if (ctx.fresh) {
+            ctx.status = 304;
+        }
+        else {
+            ctx.body = serviceWorker;
+        }
     };
 }
 //# sourceMappingURL=serviceWorkerHandler.js.map

package/server/types.d.ts

@@ -404,6 +404,15 @@ export interface ParsedQuery {
     where: WhereOptions;
 }
 export type ContentSecurityPolicy = Record<string, (string | false)[]>;
+export type AppServingCacheStatus = 'disabled' | 'error' | 'hit' | 'miss';
+export interface AppServingCacheResult<T> {
+    status: AppServingCacheStatus;
+    value?: T;
+}
+export interface AppServingCache {
+    get: <T>(key: string) => Promise<AppServingCacheResult<T>>;
+    set: <T>(key: string, value: T) => Promise<AppServingCacheStatus>;
+}
 export interface Options {
     getSecurityEmail: () => string;
     getCurrentAppMember: (params: GetCurrentAppMemberParams) => Promise<AppMemberInfo | null>;
@@ -423,11 +432,12 @@ export interface Options {
     getBlockMessages: (params: GetBlockMessagesParams) => Promise<BlockMessages[]>;
     getBlockAsset: (params: GetBlockAssetParams) => Promise<ProjectAsset>;
     getBlocksAssetsPaths: (params: GetBlocksAssetsPathsParams) => Promise<string[]>;
-    getTheme: (params: GetThemeParams) => Promise<Theme>;
+    getTheme: (params: GetThemeParams) => Promise<Theme | null>;
     createTheme: (params: CreateThemeParams) => Promise<Theme>;
     getHost: (params: GetHostParams) => string;
     getCsp: (params: GetCspParams) => ContentSecurityPolicy;
     createSettings: (params: CreateSettingsParams) => Promise<[digest: string, script: string]>;
+    appServingCache?: AppServingCache;
     applyAppServiceSecrets: (params: ApplyAppServiceSecretsParams) => Promise<RawAxiosRequestConfig<any>>;
     checkAppMemberAppPermissions: (params: CheckAppMemberAppPermissionsParams) => Promise<void>;
     checkUserOrganizationPermissions: (params: CheckUserOrganizationPermissionsParams) => Promise<void>;

package/server/utils/actions.js

@@ -1,7 +1,8 @@
 import { defaultLocale, remap, } from '@appsemble/lang-sdk';
 import { assertKoaCondition, createFormData, EmailQuotaExceededError, getContainerNamespace, getRemapperContext, getSSRFProtectedAgents, logger, parseServiceUrl, scaleDeployment, setLastRequestAnnotation, throwKoaError, version, waitForPodReadiness, } from '@appsemble/node-utils';
+import { deserializeResource } from '@appsemble/utils';
 import axios from 'axios';
-import { get, mapValues, pick } from 'lodash-es';
+import { get, pick } from 'lodash-es';
 /**
  * These response headers are forwarded when proxying requests.
  */
@@ -40,26 +41,6 @@ export async function handleNotify(ctx, app, action, options) {
     await sendNotifications({ app, to, title, body, link });
     ctx.status = 204;
 }
-function deserializeResource(data) {
-    // Extract the resource and assets from the JSON object
-    const { resource } = data;
-    const assets = data.assets;
-    // Function to replace asset placeholders with actual Blobs
-    const replaceAssets = (value) => {
-        if (Array.isArray(value)) {
-            return value.map(replaceAssets);
-        }
-        if (typeof value === 'string' && /^\d+$/.test(value)) {
-            return assets[Number(value)];
-        }
-        if (value && typeof value === 'object') {
-            return mapValues(value, replaceAssets);
-        }
-        return value;
-    };
-    // Replace placeholders and return the deserialized resource
-    return replaceAssets(resource);
-}
 async function handleRequestProxy(ctx, app, action, useBody, options) {
     const { method, query, request: { body, headers }, } = ctx;
     let data;