@appsemble/node-utils 0.29.5 → 0.29.6

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.6/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.6/pipeline.svg)](https://gitlab.com/appsemble/appsemble/-/releases/0.29.6)
 [![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.6/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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@appsemble/node-utils",
-  "version": "0.29.5",
+  "version": "0.29.6",
   "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.6",
+    "@appsemble/utils": "0.29.6",
     "@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/types.d.ts

@@ -86,6 +86,7 @@ declare module 'koas-parameters' {
         memberEmail: string;
         trainingBlockId: number;
         trainingId: number;
+        container: string;
     }
     interface QueryParams {
         domains: string[];