@appsemble/node-utils 0.29.5 → 0.29.7

package/README.md

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

package/container/helpers.js

@@ -5,7 +5,7 @@ export const maxCPU = (_a = process.env.MAX_CONTAINER_CPU) !== null && _a !== vo
 // In gigabytes
 export const maxMemoryGi = (_b = process.env.MAX_CONTAINER_MEMORY) !== null && _b !== void 0 ? _b : 3;
 export const appIdLabel = 'appId';
-export const resourceDefaults = { memory: '512Mi', cpu: '0.5' };
+export const resourceDefaults = { memory: '128Mi', cpu: '0.1' };
 export function getKubeConfig() {
     const kubeconfig = new KubeConfig();
     kubeconfig.loadFromDefault();
@@ -15,7 +15,7 @@ export function getKubeConfig() {
 }
 export function getContainerNamespace() {
     var _a;
-    return (_a = process.env.COMPANION_CONTAINER_NAMESPACE) !== null && _a !== void 0 ? _a : 'companion-containers';
+    return `companion-containers-${(_a = process.env.SERVICE_NAME) !== null && _a !== void 0 ? _a : 'appsemble'}`;
 }
 export function formatServiceName(containerName, appName, appId) {
     const serviceName = `${containerName}-${appName}-${appId}`.replaceAll(' ', '-').toLowerCase();
@@ -92,7 +92,7 @@ export function validateContainerResources(resources) {
             unit === 'Gi' && parsedValue > maxMemoryGi,
             unit === 'Mi' && parsedValue > maxMemoryGi * 1024,
         ];
-        if (conditionsMemory.some((c) => !c)) {
+        if (conditionsMemory.some(Boolean)) {
             result.limits.memory = resourceDefaults.memory;
         }
     }

package/container/index.d.ts

@@ -2,3 +2,4 @@ export * from './helpers.js';
 export * from './operations.js';
 export * from './scale.js';
 export * from './specs.js';
+export * from './logs.js';

package/container/index.js

@@ -2,4 +2,5 @@ export * from './helpers.js';
 export * from './operations.js';
 export * from './scale.js';
 export * from './specs.js';
+export * from './logs.js';
 //# sourceMappingURL=index.js.map

package/container/logs.d.ts

@@ -0,0 +1,2 @@
+import { type LogObject } from '@appsemble/types';
+export declare function getLogs(deploymentName: string, fromAppsemble?: boolean): Promise<LogObject[]>;

package/container/logs.js

@@ -0,0 +1,91 @@
+import { readFile } from 'node:fs/promises';
+import stream from 'node:stream';
+import { Log } from '@kubernetes/client-node';
+import { getContainerNamespace, getKubeConfig, handleKubernetesError } from './helpers.js';
+import { logger } from '../logger.js';
+function fetchLogs(namespace, podName, containerName) {
+    const { kubeconfig } = getKubeConfig();
+    const log = new Log(kubeconfig);
+    const logStream = new stream.PassThrough();
+    return new Promise((resolve, reject) => {
+        log
+            .log(namespace, podName, containerName || '', logStream)
+            .then(() => {
+            let logs = '';
+            logStream.on('data', (chunk) => {
+                logs += String(chunk);
+            });
+            logStream.on('end', () => {
+                resolve(logs);
+            });
+            logStream.on('error', (err) => {
+                reject(err);
+            });
+        })
+            .catch((err) => {
+            reject(err);
+        });
+    });
+}
+function filterLogEntries(entries, deploymentName, fromAppsemble) {
+    let res = entries;
+    if (fromAppsemble) {
+        res = entries.filter((e) => e.includes(deploymentName));
+    }
+    return res;
+}
+export async function getLogs(deploymentName, fromAppsemble) {
+    var _a, _b, _c, _d, _e, _f, _g, _h, _j;
+    const { coreApi } = getKubeConfig();
+    let pods;
+    const containerNamespace = getContainerNamespace();
+    let appsembleNamespace = 'appsemble';
+    const appsembleServiceName = (_a = process.env.SERVICE_NAME) !== null && _a !== void 0 ? _a : 'appsemble';
+    logger.silly(`Using service name ${appsembleServiceName}`);
+    try {
+        const NAMESPACE_FILE_PATH = '/var/run/secrets/kubernetes.io/serviceaccount/namespace';
+        const namespace = await readFile(NAMESPACE_FILE_PATH, 'utf8');
+        appsembleNamespace = namespace.trim();
+    }
+    catch (error) {
+        logger.error('Error fetching namespace name. Using `appsemble` as default');
+        logger.error(error);
+    }
+    logger.silly(`Using namespace ${appsembleNamespace}`);
+    try {
+        pods = (await coreApi.listNamespacedPod(fromAppsemble ? appsembleNamespace : containerNamespace)).body;
+    }
+    catch (error) {
+        handleKubernetesError(error);
+        return [];
+    }
+    if (pods.items.length === 0) {
+        logger.warn(`No pods found for deployment ${deploymentName} in namespace ${containerNamespace}`);
+        return [];
+    }
+    const podLogs = [];
+    for (const pod of pods.items) {
+        if (((_c = (_b = pod.metadata) === null || _b === void 0 ? void 0 : _b.ownerReferences) === null || _c === void 0 ? void 0 : _c.find((r) => r.kind === 'ReplicaSet')) &&
+            ((_d = pod.status) === null || _d === void 0 ? void 0 : _d.phase) === 'Running') {
+            if (fromAppsemble && !((_e = pod.metadata) === null || _e === void 0 ? void 0 : _e.name.includes(appsembleServiceName))) {
+                continue;
+            }
+            if (!fromAppsemble && !((_f = pod.metadata) === null || _f === void 0 ? void 0 : _f.name.includes(deploymentName))) {
+                continue;
+            }
+            logger.silly(`Pod: ${(_g = pod.metadata) === null || _g === void 0 ? void 0 : _g.name}, status: ${pod.status}, deployment: ${deploymentName}`);
+            try {
+                const res = await fetchLogs(fromAppsemble ? appsembleNamespace : containerNamespace, (_h = pod.metadata) === null || _h === void 0 ? void 0 : _h.name, fromAppsemble ? 'appsemble' : deploymentName);
+                let entries = res.split('\n');
+                logger.silly(`Number of entries found for pod ${(_j = pod.metadata) === null || _j === void 0 ? void 0 : _j.name}: ${entries.length}`);
+                entries = filterLogEntries([...entries], deploymentName, fromAppsemble);
+                podLogs.push({ fromAppsemble, entries });
+            }
+            catch (error) {
+                handleKubernetesError(error);
+            }
+        }
+    }
+    return podLogs;
+}
+//# sourceMappingURL=logs.js.map

package/getMessagesUtil.d.ts

@@ -0,0 +1,3 @@
+import { type Options } from '@appsemble/node-utils';
+import { type Context } from 'koa';
+export declare function getMessagesUtil(ctx: Context, language: string, appId: number, merge: string[] | string, { getApp, getAppMessages, getBlockMessages }: Options, override?: string[] | string): Promise<Record<string, any>>;

package/getMessagesUtil.js

@@ -0,0 +1,70 @@
+import { getAppsembleMessages, mergeMessages, } from '@appsemble/node-utils';
+import { defaultLocale, extractAppMessages, normalizeBlockName, } from '@appsemble/utils';
+import tags from 'language-tags';
+import { assertKoaError, throwKoaError } from './koa.js';
+export async function getMessagesUtil(ctx, language, appId, merge, { getApp, getAppMessages, getBlockMessages }, override = 'true') {
+    var _a, _b, _c, _d, _e;
+    if (!tags.check(language)) {
+        throwKoaError(ctx, 400, '`Language “${language}” is invalid`');
+    }
+    const lang = language.toLowerCase();
+    const baseLanguage = tags(language)
+        .subtags()
+        .find((sub) => sub.type() === 'language');
+    const baseLang = baseLanguage && String(baseLanguage).toLowerCase();
+    const app = await getApp({ context: ctx, query: { where: { id: appId } } });
+    assertKoaError(!app, ctx, 404, 'App not found');
+    const blockPrefixes = [];
+    const blockQuery = [];
+    const appMessages = await getAppMessages({ context: ctx, app, language });
+    const coreMessages = await getAppsembleMessages(lang, baseLang);
+    const messages = {
+        core: Object.fromEntries(Object.entries(coreMessages).filter(([key]) => key.startsWith('app') || key.startsWith('react-components') || key.startsWith('server'))),
+        blocks: {},
+        ...extractAppMessages(app.definition, (block, prefix) => {
+            const blockName = normalizeBlockName(block.type);
+            const [org, name] = blockName.split('/');
+            blockQuery.push({ version: block.version, OrganizationId: org.slice(1), name });
+            blockPrefixes.push([blockName, prefix]);
+        }),
+    };
+    const blockMessages = await getBlockMessages({ context: ctx, blockQuery, baseLang, lang });
+    if ((!appMessages.length || (merge && !appMessages.some((m) => m.language === lang))) &&
+        lang !== (app.definition.defaultLanguage || defaultLocale)) {
+        throwKoaError(ctx, 404, `Language “${language}” could not be found`);
+    }
+    const baseLanguageMessages = override === 'true' && appMessages.find((m) => m.language === baseLang);
+    const languageMessages = override === 'true' && appMessages.find((m) => m.language === lang);
+    for (const block of blockMessages) {
+        const { name } = block;
+        const defaultMessages = (_a = block.messages) === null || _a === void 0 ? void 0 : _a[defaultLocale];
+        const blockBaseLanguageMessages = baseLang && ((_b = block.messages) === null || _b === void 0 ? void 0 : _b[baseLang]);
+        const blockLanguageMessages = (_c = block.messages) === null || _c === void 0 ? void 0 : _c[language];
+        const blockVersionMessages = {
+            ...defaultMessages,
+            ...Object.fromEntries(Object.entries(blockBaseLanguageMessages !== null && blockBaseLanguageMessages !== void 0 ? blockBaseLanguageMessages : {}).filter(([, value]) => value)),
+            ...Object.fromEntries(Object.entries(blockLanguageMessages !== null && blockLanguageMessages !== void 0 ? blockLanguageMessages : {}).filter(([, value]) => value)),
+        };
+        if (messages.blocks[name]) {
+            messages.blocks[name][block.version] = blockVersionMessages;
+        }
+        else {
+            messages.blocks[name] = {
+                [block.version]: blockVersionMessages,
+            };
+        }
+        if (override !== 'true') {
+            const prefixed = blockPrefixes.filter(([b]) => b === name);
+            for (const [messageId, value] of Object.entries(blockVersionMessages)) {
+                for (const [, prefix] of prefixed) {
+                    messages.app[`${prefix.join('.')}.${messageId}`] = value;
+                }
+            }
+        }
+    }
+    return {
+        language: lang,
+        messages: mergeMessages(messages, (_d = baseLanguageMessages === null || baseLanguageMessages === void 0 ? void 0 : baseLanguageMessages.messages) !== null && _d !== void 0 ? _d : {}, (_e = languageMessages === null || languageMessages === void 0 ? void 0 : languageMessages.messages) !== null && _e !== void 0 ? _e : {}),
+    };
+}
+//# sourceMappingURL=getMessagesUtil.js.map

package/index.d.ts

@@ -35,4 +35,5 @@ export * from './EmailQuotaExceededError.js';
 export * from './EmailError.js';
 export * from './UserPropertiesError.js';
 export * from './authentication.js';
+export * from './getMessagesUtil.js';
 export * from './container/index.js';

package/index.js

@@ -35,5 +35,6 @@ export * from './EmailQuotaExceededError.js';
 export * from './EmailError.js';
 export * from './UserPropertiesError.js';
 export * from './authentication.js';
+export * from './getMessagesUtil.js';
 export * from './container/index.js';
 //# sourceMappingURL=index.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@appsemble/node-utils",
-  "version": "0.29.5",
+  "version": "0.29.7",
   "description": "NodeJS utilities used by Appsemble internally.",
   "keywords": [
     "app",
@@ -38,8 +38,8 @@
     "test": "vitest"
   },
   "dependencies": {
-    "@appsemble/types": "0.29.5",
-    "@appsemble/utils": "0.29.5",
+    "@appsemble/types": "0.29.7",
+    "@appsemble/utils": "0.29.7",
     "@formatjs/fast-memoize": "^2.0.0",
     "@fortawesome/fontawesome-free": "^6.0.0",
     "@kubernetes/client-node": "0.21.0",

package/server/controllers/action.js

@@ -1,4 +1,4 @@
-import { assertKoaError, createFormData, getRemapperContext, logger, parseServiceUrl, scaleDeployment, setLastRequestAnnotation, throwKoaError, version, waitForPodReadiness, } from '@appsemble/node-utils';
+import { assertKoaError, createFormData, getContainerNamespace, getRemapperContext, logger, parseServiceUrl, scaleDeployment, setLastRequestAnnotation, throwKoaError, version, waitForPodReadiness, } from '@appsemble/node-utils';
 import { defaultLocale, remap } from '@appsemble/utils';
 import axios from 'axios';
 import { get, mapValues, pick } from 'lodash-es';
@@ -137,6 +137,7 @@ async function handleRequestProxy(ctx, app, action, useBody, options) {
     const urlPattern = /^http:\/\/(([\da-z-]+).){2}svc.cluster.local/;
     // Restricting access to only the containers defined by the app
     if (urlPattern.test(String(proxyUrl))) {
+        axiosConfig.url = axiosConfig.url.replace(axiosConfig.url.split('.')[1], getContainerNamespace());
         const { appId } = parseServiceUrl(String(proxyUrl));
         if (appId !== String(app.id)) {
             throwKoaError(ctx, 403, 'Forbidden');

package/server/controllers/appMessages.d.ts

@@ -1,3 +1,3 @@
 import { type Options } from '@appsemble/node-utils';
 import { type Middleware } from 'koa';
-export declare function createGetMessages({ getApp, getAppMessages, getBlockMessages, }: Options): Middleware;
+export declare function createGetMessages(options: Options): Middleware;

package/server/controllers/appMessages.js

@@ -1,72 +1,8 @@
-import { assertKoaError, getAppsembleMessages, mergeMessages, throwKoaError, } from '@appsemble/node-utils';
-import { defaultLocale, extractAppMessages, normalizeBlockName, } from '@appsemble/utils';
-import tags from 'language-tags';
-export function createGetMessages({ getApp, getAppMessages, getBlockMessages, }) {
+import { getMessagesUtil } from '@appsemble/node-utils';
+export function createGetMessages(options) {
     return async (ctx) => {
-        var _a, _b, _c, _d, _e;
         const { pathParams: { appId, language }, query: { merge, override = 'true' }, } = ctx;
-        if (!tags.check(language)) {
-            throwKoaError(ctx, 400, '`Language “${language}” is invalid`');
-        }
-        const lang = language.toLowerCase();
-        const baseLanguage = tags(language)
-            .subtags()
-            .find((sub) => sub.type() === 'language');
-        const baseLang = baseLanguage && String(baseLanguage).toLowerCase();
-        const app = await getApp({ context: ctx, query: { where: { id: appId } } });
-        assertKoaError(!app, ctx, 404, 'App not found');
-        const blockPrefixes = [];
-        const blockQuery = [];
-        const appMessages = await getAppMessages({ context: ctx, app, language });
-        const coreMessages = await getAppsembleMessages(lang, baseLang);
-        const messages = {
-            core: Object.fromEntries(Object.entries(coreMessages).filter(([key]) => key.startsWith('app') || key.startsWith('react-components') || key.startsWith('server'))),
-            blocks: {},
-            ...extractAppMessages(app.definition, (block, prefix) => {
-                const blockName = normalizeBlockName(block.type);
-                const [org, name] = blockName.split('/');
-                blockQuery.push({ version: block.version, OrganizationId: org.slice(1), name });
-                blockPrefixes.push([blockName, prefix]);
-            }),
-        };
-        const blockMessages = await getBlockMessages({ context: ctx, blockQuery, baseLang, lang });
-        if ((!appMessages.length || (merge && !appMessages.some((m) => m.language === lang))) &&
-            lang !== (app.definition.defaultLanguage || defaultLocale)) {
-            throwKoaError(ctx, 404, `Language “${language}” could not be found`);
-        }
-        const baseLanguageMessages = override === 'true' && appMessages.find((m) => m.language === baseLang);
-        const languageMessages = override === 'true' && appMessages.find((m) => m.language === lang);
-        for (const block of blockMessages) {
-            const { name } = block;
-            const defaultMessages = (_a = block.messages) === null || _a === void 0 ? void 0 : _a[defaultLocale];
-            const blockBaseLanguageMessages = baseLang && ((_b = block.messages) === null || _b === void 0 ? void 0 : _b[baseLang]);
-            const blockLanguageMessages = (_c = block.messages) === null || _c === void 0 ? void 0 : _c[language];
-            const blockVersionMessages = {
-                ...defaultMessages,
-                ...Object.fromEntries(Object.entries(blockBaseLanguageMessages !== null && blockBaseLanguageMessages !== void 0 ? blockBaseLanguageMessages : {}).filter(([, value]) => value)),
-                ...Object.fromEntries(Object.entries(blockLanguageMessages !== null && blockLanguageMessages !== void 0 ? blockLanguageMessages : {}).filter(([, value]) => value)),
-            };
-            if (messages.blocks[name]) {
-                messages.blocks[name][block.version] = blockVersionMessages;
-            }
-            else {
-                messages.blocks[name] = {
-                    [block.version]: blockVersionMessages,
-                };
-            }
-            if (override !== 'true') {
-                const prefixed = blockPrefixes.filter(([b]) => b === name);
-                for (const [messageId, value] of Object.entries(blockVersionMessages)) {
-                    for (const [, prefix] of prefixed) {
-                        messages.app[`${prefix.join('.')}.${messageId}`] = value;
-                    }
-                }
-            }
-        }
-        ctx.body = {
-            language: lang,
-            messages: mergeMessages(messages, (_d = baseLanguageMessages === null || baseLanguageMessages === void 0 ? void 0 : baseLanguageMessages.messages) !== null && _d !== void 0 ? _d : {}, (_e = languageMessages === null || languageMessages === void 0 ? void 0 : languageMessages.messages) !== null && _e !== void 0 ? _e : {}),
-        };
+        ctx.body = await getMessagesUtil(ctx, language, appId, merge, options, override);
     };
 }
 //# sourceMappingURL=appMessages.js.map

package/server/types.d.ts

@@ -86,6 +86,7 @@ declare module 'koas-parameters' {
         memberEmail: string;
         trainingBlockId: number;
         trainingId: number;
+        container: string;
     }
     interface QueryParams {
         domains: string[];
@@ -104,6 +105,7 @@ declare module 'koas-parameters' {
         screenshots: boolean;
         readmes: boolean;
         roles: string[];
+        includeMessages: boolean;
     }
 }
 export type Operator = 'and' | 'not' | 'or';