@appsemble/node-utils 0.36.3 → 0.36.5-test.0

package/README.md

@@ -1,9 +1,9 @@
-# ![](https://gitlab.com/appsemble/appsemble/-/raw/0.36.3/config/assets/logo.svg) Appsemble Node Utilities
+# ![](https://gitlab.com/appsemble/appsemble/-/raw/0.36.5-test.0/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.36.3/pipeline.svg)](https://gitlab.com/appsemble/appsemble/-/releases/0.36.3)
+[![GitLab CI](https://gitlab.com/appsemble/appsemble/badges/0.36.5-test.0/pipeline.svg)](https://gitlab.com/appsemble/appsemble/-/releases/0.36.5-test.0)
 [![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.36.3/LICENSE.md) ©
+[LGPL-3.0-only](https://gitlab.com/appsemble/appsemble/-/blob/0.36.5-test.0/LICENSE.md) ©
 [Appsemble](https://appsemble.com)

package/container/helpers.js

@@ -1,5 +1,5 @@
 import { logger } from '@appsemble/node-utils';
-import { AppsV1Api, CoreV1Api, HttpError, KubeConfig, } from '@kubernetes/client-node';
+import { ApiException, AppsV1Api, CoreV1Api, KubeConfig, } from '@kubernetes/client-node';
 export const maxCPU = process.env.MAX_CONTAINER_CPU ?? 3;
 // In gigabytes
 export const maxMemoryGi = process.env.MAX_CONTAINER_MEMORY ?? 3;
@@ -23,10 +23,9 @@ export function formatSecretName(appName, appId) {
     return `${appName}-${appId}`.toLocaleLowerCase().replaceAll(' ', '-');
 }
 export function handleKubernetesError(error) {
-    if (error instanceof HttpError) {
-        const { statusCode } = error;
-        if (statusCode) {
-            logger.warn(`Kubernetes error with status code ${statusCode}:`);
+    if (error instanceof ApiException) {
+        if (error.code) {
+            logger.warn(`Kubernetes error with status code ${error.code}:`);
         }
         logger.warn(error.body);
         return;
@@ -42,13 +41,17 @@ export async function deleteResource(type, namespace, name) {
         logger.silly(`Deleting ${type} '${name}' from namespace ${namespace} ... `);
         switch (type) {
             case 'deployment':
-                await appsApi.deleteNamespacedDeployment(name, namespace, undefined, undefined, undefined, undefined, 'Background');
+                await appsApi.deleteNamespacedDeployment({
+                    name,
+                    namespace,
+                    propagationPolicy: 'Background',
+                });
                 break;
             case 'service':
-                await coreApi.deleteNamespacedService(name, namespace);
+                await coreApi.deleteNamespacedService({ name, namespace });
                 break;
             default:
-                await coreApi.deleteNamespacedSecret(name, namespace);
+                await coreApi.deleteNamespacedSecret({ name, namespace });
         }
         logger.verbose(`Deleted ${type} '${name}' from namespace ${namespace}`);
     }

package/container/logs.js

@@ -52,7 +52,9 @@ export async function getLogs(deploymentName, fromAppsemble) {
     }
     logger.silly(`Using namespace ${appsembleNamespace}`);
     try {
-        pods = (await coreApi.listNamespacedPod(fromAppsemble ? appsembleNamespace : containerNamespace)).body;
+        pods = await coreApi.listNamespacedPod({
+            namespace: fromAppsemble ? appsembleNamespace : containerNamespace,
+        });
     }
     catch (error) {
         handleKubernetesError(error);

package/container/operations.js

@@ -28,7 +28,7 @@ export async function updateNamespacedSecret(secretName, value, appName, appId)
     };
     let existing;
     try {
-        existing = (await coreApi.readNamespacedSecret(formattedName, namespace)).body;
+        existing = await coreApi.readNamespacedSecret({ name: formattedName, namespace });
     }
     catch (error) {
         handleKubernetesError(error);
@@ -40,7 +40,11 @@ export async function updateNamespacedSecret(secretName, value, appName, appId)
         }
         existing.data[secretName] = Buffer.from(value).toString('base64');
         try {
-            const { body: updatedSecret } = await coreApi.replaceNamespacedSecret(formattedName, namespace, existing);
+            const updatedSecret = await coreApi.replaceNamespacedSecret({
+                name: formattedName,
+                namespace,
+                body: existing,
+            });
             logger.info(`Secret ${updatedSecret.metadata?.name} updated successfully`);
         }
         catch (error) {
@@ -50,7 +54,7 @@ export async function updateNamespacedSecret(secretName, value, appName, appId)
     }
     try {
         logger.verbose(`Creating secret ${secretSpec.metadata?.name} ...`);
-        const { body: secret } = await coreApi.createNamespacedSecret(namespace, secretSpec);
+        const secret = await coreApi.createNamespacedSecret({ namespace, body: secretSpec });
         logger.info(`Secret ${secret.metadata?.name} created successfully`);
     }
     catch (error) {
@@ -66,14 +70,14 @@ export async function deleteSecret(appName, appId, key) {
     const secretName = formatSecretName(appName, appId);
     if (key) {
         try {
-            const { body: secret } = await coreApi.readNamespacedSecret(secretName, namespace);
+            const secret = await coreApi.readNamespacedSecret({ name: secretName, namespace });
             logger.verbose(`Deleteing key ${key} of secret ${secretName} from namespace ${namespace} ...`);
             if (!(secret.data && key in secret.data)) {
                 logger.warn(`Key ${key} does not exist on secret ${secret.metadata?.name}`);
                 return;
             }
             delete secret.data[key];
-            await coreApi.replaceNamespacedSecret(secretName, namespace, secret);
+            await coreApi.replaceNamespacedSecret({ name: secretName, namespace, body: secret });
             logger.verbose(`Deleted key ${key} of secret ${secretName} from namespace ${namespace}.`);
         }
         catch (error) {
@@ -103,7 +107,7 @@ export async function updateCompanionContainers(definitions, appName, appId, reg
     let services;
     logger.silly(`Listing services in namespace ${namespace} ...`);
     try {
-        services = (await coreApi.listNamespacedService(namespace)).body;
+        services = await coreApi.listNamespacedService({ namespace });
     }
     catch (error) {
         logger.error(`Error listing services in namespace ${namespace}`);
@@ -117,39 +121,36 @@ export async function updateCompanionContainers(definitions, appName, appId, reg
         // Update
         if (existing) {
             logger.verbose(`Updating resources for ${existing.metadata?.name} in namespace ${namespace}`);
-            const patchOptions = [
-                // @ts-expect-error 18048 variable is possibly undefined (strictNullChecks)
-                existing.metadata.name,
-                namespace,
-                [
-                    {
-                        op: 'replace',
-                        path: '/metadata',
-                        // @ts-expect-error 18048 variable is possibly undefined (strictNullChecks)
-                        value: { ...def.metadata, name: existing.metadata.name },
-                    },
-                    {
-                        op: 'replace',
-                        path: '/spec/ports/0/targetPort',
-                        value: def.port ?? 8080,
-                    },
-                    {
-                        op: 'add',
-                        path: '/metadata/labels',
-                        value: { appId },
-                    },
-                ],
-                undefined,
-                undefined,
-                undefined,
-                undefined,
-                undefined,
-                { headers: { 'Content-Type': 'application/json-patch+json' } },
+            const existingServiceName = existing.metadata?.name;
+            if (!existingServiceName) {
+                logger.warn(`Service without metadata.name found in namespace ${namespace}, skipping ...`);
+                continue;
+            }
+            const servicePatch = [
+                {
+                    op: 'replace',
+                    path: '/metadata',
+                    value: { ...def.metadata, name: existingServiceName },
+                },
+                {
+                    op: 'replace',
+                    path: '/spec/ports/0/targetPort',
+                    value: def.port ?? 8080,
+                },
+                {
+                    op: 'add',
+                    path: '/metadata/labels',
+                    value: { appId },
+                },
             ];
             // Update service
             try {
-                const updatedService = await coreApi.patchNamespacedService(...patchOptions);
-                logger.info(`Service ${updatedService?.body?.metadata?.name} updated`);
+                const updatedService = await coreApi.patchNamespacedService({
+                    name: existingServiceName,
+                    namespace,
+                    body: servicePatch,
+                });
+                logger.info(`Service ${updatedService?.metadata?.name} updated`);
             }
             catch (error) {
                 logger.error('Error updating service:');
@@ -157,12 +158,11 @@ export async function updateCompanionContainers(definitions, appName, appId, reg
             }
             // Update deployment
             const resources = validateContainerResources(def.resources);
-            patchOptions[2] = [
+            const deploymentPatch = [
                 {
                     op: 'replace',
                     path: '/metadata',
-                    // @ts-expect-error 18048 variable is possibly undefined (strictNullChecks)
-                    value: { ...def.metadata, name: existing.metadata.name },
+                    value: { ...def.metadata, name: existingServiceName },
                 },
                 {
                     op: 'replace',
@@ -186,8 +186,12 @@ export async function updateCompanionContainers(definitions, appName, appId, reg
                 },
             ];
             try {
-                const updatedDeployment = await appsApi.patchNamespacedDeployment(...patchOptions);
-                logger.info(`Deployment ${updatedDeployment?.body?.metadata?.name} updated`);
+                const updatedDeployment = await appsApi.patchNamespacedDeployment({
+                    name: existingServiceName,
+                    namespace,
+                    body: deploymentPatch,
+                });
+                logger.info(`Deployment ${updatedDeployment?.metadata?.name} updated`);
             }
             catch (error) {
                 logger.error('Error updating deployment:');
@@ -195,12 +199,19 @@ export async function updateCompanionContainers(definitions, appName, appId, reg
             }
             // Update pod
             try {
-                const { body } = await coreApi.listNamespacedPod(namespace, undefined, undefined, undefined, undefined, `appId=${appId}`);
-                if (body?.items?.length === 0) {
+                const podList = await coreApi.listNamespacedPod({
+                    namespace,
+                    labelSelector: `appId=${appId}`,
+                });
+                if (podList.items.length === 0) {
                     logger.silly(`Deployment ${serviceName} has 0 pods, skipping ...`);
                     continue;
                 }
-                const pod = body?.items?.find((i) => i.metadata?.labels?.app === existing.metadata?.name);
+                const pod = podList.items.find((item) => item.metadata?.labels?.app === existingServiceName);
+                if (!pod?.metadata?.name) {
+                    logger.silly(`Deployment ${serviceName} has no matching pod with metadata.name, skipping`);
+                    continue;
+                }
                 // Set base labels, such as selector, pod name, pod hash
                 const props = {
                     ...def.metadata,
@@ -210,19 +221,21 @@ export async function updateCompanionContainers(definitions, appName, appId, reg
                         'pod-template-hash': pod?.metadata?.labels?.['pod-template-hash'],
                         appId,
                     },
-                    name: pod?.metadata?.name,
+                    name: pod.metadata.name,
                 };
-                // @ts-expect-error 2322 null is not assignable to type (strictNullChecks)
-                patchOptions[0] = pod?.metadata?.name;
-                patchOptions[2] = [
+                const podPatch = [
                     {
                         op: 'replace',
                         path: '/metadata',
                         value: props,
                     },
                 ];
-                const updatedPod = await coreApi.patchNamespacedPod(...patchOptions);
-                logger.verbose(`Pod updated: ${updatedPod?.body?.metadata?.name}`);
+                const updatedPod = await coreApi.patchNamespacedPod({
+                    name: pod.metadata.name,
+                    namespace,
+                    body: podPatch,
+                });
+                logger.verbose(`Pod updated: ${updatedPod?.metadata?.name}`);
             }
             catch (error) {
                 handleKubernetesError(error);
@@ -236,16 +249,19 @@ export async function updateCompanionContainers(definitions, appName, appId, reg
             if (isWhitelisted(deployment.spec?.template.spec?.containers[0].image)) {
                 logger.verbose(`Creating resources in namespace ${namespace} ...`);
                 try {
-                    const deploymentObj = await appsApi.createNamespacedDeployment(namespace, deployment);
-                    logger.info(`Deployment created: ${deploymentObj.body?.metadata?.name}`);
+                    const deploymentObj = await appsApi.createNamespacedDeployment({
+                        namespace,
+                        body: deployment,
+                    });
+                    logger.info(`Deployment created: ${deploymentObj.metadata?.name}`);
                 }
                 catch (error) {
                     handleKubernetesError(error);
                     return;
                 }
                 try {
-                    const serviceObj = await coreApi.createNamespacedService(namespace, service);
-                    logger.info(`Service created: ${serviceObj.body.metadata?.name}`);
+                    const serviceObj = await coreApi.createNamespacedService({ namespace, body: service });
+                    logger.info(`Service created: ${serviceObj.metadata?.name}`);
                 }
                 catch (error) {
                     handleKubernetesError(error);
@@ -266,9 +282,10 @@ export async function updateCompanionContainers(definitions, appName, appId, reg
             service.metadata.labels[appIdLabel] === appId) {
             const existing = definitions.find((d) => formatServiceName(d.name, appName, appId) === service.metadata?.name);
             if (!existing) {
-                // @ts-expect-error 2345 argument of type is not assignable to parameter of type
-                // (strictNullChecks)
-                await deleteCompanionContainers(service.metadata?.name);
+                if (!service.metadata?.name) {
+                    continue;
+                }
+                await deleteCompanionContainers(service.metadata.name);
             }
         }
     }

package/container/scale.js

@@ -10,7 +10,11 @@ export async function scaleDeployment(namespace, deploymentName, replicas = 0) {
     });
     try {
         logger.verbose(`Scaling deployment ${deploymentName} to ${replicas} replicas ... `);
-        await appsApi.patchNamespacedDeployment(deploymentName, namespace, patch, undefined, undefined, undefined, undefined, undefined, { headers: { 'Content-Type': 'application/json-patch+json' } });
+        await appsApi.patchNamespacedDeployment({
+            name: deploymentName,
+            namespace,
+            body: patch,
+        });
         logger.verbose(`Deployment ${deploymentName} scaled to ${replicas} replicas successfully `);
     }
     catch (error) {
@@ -23,7 +27,7 @@ export async function stopIdleContainers(interval = 10) {
     let deployments;
     logger.verbose('Scaling containers');
     try {
-        deployments = (await appsApi.listDeploymentForAllNamespaces()).body;
+        deployments = await appsApi.listDeploymentForAllNamespaces();
     }
     catch (error) {
         handleKubernetesError(error);
@@ -52,7 +56,7 @@ export async function stopIdleContainers(interval = 10) {
             ];
             try {
                 logger.silly(`Updating metadata of deployment ${name}`);
-                await appsApi.patchNamespacedDeployment(name, namespace, patch, undefined, undefined, undefined, undefined, undefined, { headers: { 'Content-Type': 'application/json-patch+json' } });
+                await appsApi.patchNamespacedDeployment({ name, namespace, body: patch });
                 logger.verbose(`Updated metadata of deployment ${name} successfully `);
             }
             catch (error) {
@@ -73,9 +77,12 @@ export async function waitForPodReadiness(namespace, appSelector, maxWait = 1000
     let elapsed = 0;
     const { coreApi } = getKubeConfig();
     while (!isReady) {
-        const pods = await coreApi.listNamespacedPod(namespace, undefined, undefined, undefined, undefined, `app=${appSelector}`);
-        if (pods.body.items.length > 0) {
-            isReady = pods.body?.items.every((pod) => pod.status?.conditions?.some((condition) => condition.type === 'Ready' && condition.status === 'True'));
+        const pods = await coreApi.listNamespacedPod({
+            namespace,
+            labelSelector: `app=${appSelector}`,
+        });
+        if (pods.items.length > 0) {
+            isReady = pods.items.every((pod) => pod.status?.conditions?.some((condition) => condition.type === 'Ready' && condition.status === 'True'));
         }
         if (!isReady) {
             logger.silly(`Waiting for ${appSelector} to be ready ...`);
@@ -102,7 +109,11 @@ export async function setLastRequestAnnotation(namespace, deploymentName) {
     ];
     try {
         logger.silly(`Setting 'lastRequestTimestamp' annotation of '${deploymentName}' to ${now.toISOString()}`);
-        await appsApi.patchNamespacedDeployment(deploymentName, namespace, patch, undefined, undefined, undefined, undefined, undefined, { headers: { 'Content-Type': 'application/json-patch+json' } });
+        await appsApi.patchNamespacedDeployment({
+            name: deploymentName,
+            namespace,
+            body: patch,
+        });
         logger.silly(`'LastRequestTimestamp' annotation of '${deploymentName}' updated successfully`);
     }
     catch (error) {

package/icon.js

@@ -16,7 +16,6 @@ export async function serveIcon(ctx, { background, cache, fallback, height, icon
     if (raw) {
         const { format } = await img.metadata();
         ctx.body = buffer;
-        // @ts-expect-error 2322 null is not assignable to type (strictNullChecks)
         ctx.type = format;
         return;
     }
@@ -42,7 +41,6 @@ export async function serveIcon(ctx, { background, cache, fallback, height, icon
         // Make the regular icon maskable
         const actual = img;
         const metadata = await actual.metadata();
-        // @ts-expect-error 18048 variable is possibly undefined (strictNullChecks)
         const angle = Math.atan(metadata.height / metadata.width);
         actual.resize({
             // @ts-expect-error 18048 variable is possibly undefined (strictNullChecks)

package/index.d.ts

@@ -7,6 +7,7 @@ export * from './handleError.js';
 export * from './interceptors.js';
 export * from './logger.js';
 export * from './middleware/loggerMiddleware.js';
+export * from './requestContext.js';
 export * from './middleware/error.js';
 export * from './middleware/conditional.js';
 export * from './middleware/frontend.js';

package/index.js

@@ -7,6 +7,7 @@ export * from './handleError.js';
 export * from './interceptors.js';
 export * from './logger.js';
 export * from './middleware/loggerMiddleware.js';
+export * from './requestContext.js';
 export * from './middleware/error.js';
 export * from './middleware/conditional.js';
 export * from './middleware/frontend.js';

package/middleware/loggerMiddleware.js

@@ -1,5 +1,6 @@
 import chalk from 'chalk';
 import { logger } from '../logger.js';
+import { createRequestContext, requestStore } from '../requestContext.js';
 function rangeFormat(value, map) {
     // @ts-expect-error 2532 Object is possibly 'undefined'.
     return Object.entries(map).find(([v]) => v === 'default' || value < Number(v))[1];
@@ -14,7 +15,9 @@ export function loggerMiddleware() {
         const { href, res } = ctx;
         const start = Date.now();
         const method = chalk.bold(ctx.method);
-        logger.info(`${method} ${href} — ${chalk.white(ctx.ip)}`);
+        const context = createRequestContext(ctx.method, ctx.path);
+        const reqIdPrefix = `[${context.requestId.slice(0, 8)}] `;
+        logger.info(`${reqIdPrefix}${method} ${href} — ${chalk.white(ctx.ip)}`);
         function logResponse() {
             res.removeListener('finish', logResponse);
             // eslint-disable-next-line @typescript-eslint/no-use-before-define
@@ -40,7 +43,7 @@ export function loggerMiddleware() {
                 500: 'warn',
                 default: 'error',
             });
-            logger.log(level, `${method} ${href} ${formatStatus(location ? `${s} → ${location}` : s)} ${formatDuration(`${duration}ms`)}`);
+            logger.log(level, `${reqIdPrefix}${method} ${href} ${formatStatus(location ? `${s} → ${location}` : s)} ${formatDuration(`${duration}ms`)}`);
         }
         function logCancel() {
             res.removeListener('finish', logResponse);
@@ -51,11 +54,11 @@ export function loggerMiddleware() {
                 1000: chalk.yellow,
                 default: chalk.red,
             });
-            logger.warn(`${method} ${href} ${chalk.grey('Cancelled')} ${formatDuration(`${duration}ms`)}`);
+            logger.warn(`${reqIdPrefix}${method} ${href} ${chalk.grey('Cancelled')} ${formatDuration(`${duration}ms`)}`);
         }
         res.once('finish', logResponse);
         res.once('close', logCancel);
-        return next();
+        return requestStore.run(context, next);
     };
 }
 //# sourceMappingURL=loggerMiddleware.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@appsemble/node-utils",
-  "version": "0.36.3",
+  "version": "0.36.5-test.0",
   "description": "NodeJS utilities used by Appsemble internally.",
   "keywords": [
     "app",
@@ -40,12 +40,12 @@
     "test": "vitest"
   },
   "dependencies": {
-    "@appsemble/lang-sdk": "0.36.3",
-    "@appsemble/types": "0.36.3",
-    "@appsemble/utils": "0.36.3",
+    "@appsemble/lang-sdk": "0.36.5-test.0",
+    "@appsemble/types": "0.36.5-test.0",
+    "@appsemble/utils": "0.36.5-test.0",
     "@formatjs/fast-memoize": "^2.0.0",
     "@fortawesome/fontawesome-free": "^6.0.0",
-    "@kubernetes/client-node": "^0.22.2",
+    "@kubernetes/client-node": "1.4.0",
     "@odata/parser": "^0.2.0",
     "@types/koa": "^2.0.0",
     "axios": "^1.0.0",
@@ -91,7 +91,7 @@
     "pg": "^8.16.3",
     "request-filtering-agent": "^3.2.0",
     "sass": "^1.0.0",
-    "sharp": "^0.32.0",
+    "sharp": "0.34.5",
     "sort-keys": "^5.0.0",
     "strip-bom": "^5.0.0",
     "type-fest": "^4.0.0",

package/requestContext.d.ts

@@ -0,0 +1,10 @@
+import { AsyncLocalStorage } from 'node:async_hooks';
+interface RequestContext {
+    requestId: string;
+    method: string;
+    path: string;
+}
+export declare const requestStore: AsyncLocalStorage<RequestContext>;
+export declare function getRequestId(): string | undefined;
+export declare function createRequestContext(method: string, path: string): RequestContext;
+export {};

package/requestContext.js

@@ -0,0 +1,14 @@
+import { AsyncLocalStorage } from 'node:async_hooks';
+import { randomUUID } from 'node:crypto';
+export const requestStore = new AsyncLocalStorage();
+export function getRequestId() {
+    return requestStore.getStore()?.requestId;
+}
+export function createRequestContext(method, path) {
+    return {
+        requestId: randomUUID(),
+        method,
+        path,
+    };
+}
+//# sourceMappingURL=requestContext.js.map

package/server/types.d.ts

@@ -118,6 +118,7 @@ declare module 'koas-parameters' {
         email: string;
         width?: number;
         height?: number;
+        secret: string;
     }
 }
 export type Operator = 'and' | 'not' | 'or';