Dev

Dockerfile

@@ -1,4 +1,4 @@
-FROM node:18
+FROM node:22
 
 WORKDIR /data
 

README.md

@@ -8,7 +8,6 @@ NSM is a robust service manager built on Docker Engine. Its primary purpose is t
 
 - **Dynamic Service Generation**: Create and manage services on-the-fly using RESTful APIs.
 - **Template-Based Configuration**: Use customizable templates to define service configurations.
-- **No-template mode**: NSM supports integrating custom engine with no template mode to disable templates completely.
 - **Docker Integration**: Leverage Docker Engine for reliable and scalable service management.
 - **Resources usage management**: NSM provides ability to limit or extend resources limits and view current usage.
 

TODO.txt

@@ -0,0 +1,10 @@
+fixnout stop flow pomocí stop cmd
+přidat created at a last started at do service info
+abstrahovat template management a udělat další sources jako například používání images z docker registry
+předělat usages monitoring na nějaký standardizovaný formát/způsob
+pořešit /resources/config.yml aby měl víc možností a možná byl uložený jinde v systému podle platformy
+port retrieval strategy pro spouštění servis, aby nebyla jenom random ale i jiné strategies
+udělat nějaký auto packaging do balíčků na githubu jako bundle aby se dal spustit jako systémový proces v systemctl například
+restart policy
+předělat addons systém
+flagy servis, každý flag bude mít jiný účel a půjdou přidávat přes addony které je budou taky managovat

jest.config.js

@@ -2,10 +2,10 @@ const tsconfig = require("./tsconfig.json")
 const moduleNameMapper = require("tsconfig-paths-jest")(tsconfig)
 
 module.exports = {
-    "modulePathIgnorePatterns": [
-        "<rootDir>/tests/"
-    ],
     moduleNameMapper,
+    transformIgnorePatterns: [
+        "/node_modules/(?!(env-paths)/)",
+    ],
     reporters: [
         'default',
         ['jest-ctrf-json-reporter', {}],

openapi.yml

@@ -86,12 +86,13 @@ components:
       type: "object"
       description: "The session information about a running service, if running"
       properties:
-        serviceId:
-          type: "string"
-        nodeId:
-          type: "string"
-        containerId:
+        id:
           type: "string"
+          description: "The currently active session ID"
+        startedAt:
+          type: "number"
+          format: "int64"
+          description: "The timestamp when the session started, in milliseconds since epoch"
         stats:
           type: "object"
           properties:
@@ -136,8 +137,16 @@ components:
         id:
           type: "string"
           description: "The service UID in the system"
-        template:
-          $ref: "#/components/schemas/TemplateLookup"
+        templateId:
+          type: "string"
+          description: "The template ID used to create the service"
+        state:
+          type: string
+          description: "The current state of the service. One of: 'RUNNING', 'BUILDING', 'STOPPED'."
+          enum:
+            - "RUNNING"
+            - "BUILDING"
+            - "STOPPED"
         port:
           type: "integer"
           format: "int32"
@@ -537,4 +546,8 @@ paths:
           content:
             application/json:
               schema:
-                $ref: "#/components/schemas/Result"
+                $ref: "#/components/schemas/Result"
+
+# TODO: /v1/service/{serviceId}/sessions
+# TODO: /v1/service/{serviceId}/logs
+# TODO: /v1/session/{sessionId}/logs

package.json

@@ -6,7 +6,7 @@
   "scripts": {
     "build": "node installTempDeps.js && tsc && tscp",
     "start": "cross-env TS_NODE_BASEURL=./dist node -r tsconfig-paths/register dist/index.js",
-    "test": "npm run build && cross-env TS_NODE_BASEURL=./dist jest"
+    "test": "jest"
   },
   "keywords": [],
   "author": "ZorTik",
@@ -54,6 +54,7 @@
     "crypto": "^1.0.1",
     "dockerode": "^4.0.2",
     "dotenv": "^16.4.5",
+    "env-paths": "^3.0.0",
     "express": "^4.18.2",
     "express-fileupload": "^1.5.0",
     "folder-hash": "^4.1.1",

prisma/migrations/20260316232423_remove_session/migration.sql

@@ -0,0 +1,8 @@
+/*
+  Warnings:
+
+  - You are about to drop the `Session` table. If the table is not empty, all the data it contains will be lost.
+
+*/
+-- DropTable
+DROP TABLE `Session`;

prisma/migrations/20260319213658_service_session/migration.sql

@@ -0,0 +1,24 @@
+-- CreateTable
+CREATE TABLE `ServiceSession` (
+    `id` VARCHAR(191) NOT NULL,
+    `serviceId` VARCHAR(191) NOT NULL,
+
+    PRIMARY KEY (`id`)
+) DEFAULT CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;
+
+-- CreateTable
+CREATE TABLE `ServiceLogRecord` (
+    `id` BIGINT NOT NULL AUTO_INCREMENT,
+    `sessionId` VARCHAR(191) NOT NULL,
+    `timestamp` DATETIME(3) NOT NULL DEFAULT CURRENT_TIMESTAMP(3),
+    `logLevel` VARCHAR(191) NOT NULL,
+    `message` VARCHAR(191) NOT NULL,
+
+    PRIMARY KEY (`id`)
+) DEFAULT CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;
+
+-- AddForeignKey
+ALTER TABLE `ServiceSession` ADD CONSTRAINT `ServiceSession_serviceId_fkey` FOREIGN KEY (`serviceId`) REFERENCES `Service`(`serviceId`) ON DELETE CASCADE ON UPDATE CASCADE;
+
+-- AddForeignKey
+ALTER TABLE `ServiceLogRecord` ADD CONSTRAINT `ServiceLogRecord_sessionId_fkey` FOREIGN KEY (`sessionId`) REFERENCES `ServiceSession`(`id`) ON DELETE CASCADE ON UPDATE CASCADE;

prisma/migrations/20260320025242_service_log_source/migration.sql

@@ -0,0 +1,8 @@
+/*
+  Warnings:
+
+  - Added the required column `source` to the `ServiceLogRecord` table without a default value. This is not possible if the table is not empty.
+
+*/
+-- AlterTable
+ALTER TABLE `ServiceLogRecord` ADD COLUMN `source` ENUM('ENGINE', 'CONTAINER') NOT NULL;

prisma/migrations/20260320114548_log_record_message_length/migration.sql

@@ -0,0 +1,2 @@
+-- AlterTable
+ALTER TABLE `ServiceLogRecord` MODIFY `message` LONGTEXT NOT NULL;

prisma/migrations/20260320184831_service_session_startedat/migration.sql

@@ -0,0 +1,2 @@
+-- AlterTable
+ALTER TABLE `ServiceSession` ADD COLUMN `startedAt` DATETIME(3) NOT NULL DEFAULT CURRENT_TIMESTAMP(3);

prisma/schema.prisma

@@ -9,29 +9,27 @@ generator client {
 }
 
 datasource db {
-  provider          = "mysql"
-  url               = env("DATABASE_URL")
-  shadowDatabaseUrl = env("SHADOW_DATABASE_URL")
+  provider = "mysql"
+  url      = env("DATABASE_URL")
 }
 
-model Session {
-  serviceId   String   @id @default(uuid())
-  createdAt   DateTime @default(now())
-  nodeId      String
-  containerId String
+enum ServiceLogSource {
+  ENGINE
+  CONTAINER
 }
 
 model Service {
-  serviceId String  @id @default(uuid())
+  serviceId String           @id @default(uuid())
   nodeId    String
   imageId   String?
   template  String
   port      Int
   options   Json
-  meta      Json    @default("{}")
+  meta      Json             @default("{}")
   env       Json
   network   Json?
-  image     Image?  @relation(fields: [imageId], references: [id])
+  image     Image?           @relation(fields: [imageId], references: [id])
+  sessions  ServiceSession[]
 }
 
 model ServiceMeta {
@@ -40,6 +38,24 @@ model ServiceMeta {
   value     Json
 }
 
+model ServiceSession {
+  id        String             @id @default(uuid())
+  serviceId String
+  service   Service            @relation(fields: [serviceId], references: [serviceId], onDelete: Cascade)
+  logs      ServiceLogRecord[]
+  startedAt DateTime           @default(now())
+}
+
+model ServiceLogRecord {
+  id        BigInt           @id @default(autoincrement())
+  sessionId String
+  timestamp DateTime         @default(now())
+  source    ServiceLogSource
+  logLevel  String
+  message   String           @db.LongText
+  session   ServiceSession   @relation(fields: [sessionId], references: [id], onDelete: Cascade)
+}
+
 // Persistent key-value storage for system-wide attributes.
 model Meta {
   id        Int      @id @default(autoincrement())

resources/config.yml

@@ -9,4 +9,6 @@ port: 3000
 # Supported types: 'none', 'auth_token'
 auth: 'none'
 docker_host: 'unix:///var/run/docker.sock'
-service_logs: true
+# Override resources path if needed.
+# By default, an explicit system-specific data path is used.
+# resources_path: '/srv/resources'

src/app.ts

@@ -1,37 +1,43 @@
 import dotenv from "dotenv";
-import config from "@nsm/configuration/appConfig";
+import {loadAppConfig} from "@nsm/config";
+import {init as initFileStructure, getResourcesTargetPath, prepareFolders} from "@nsm/filestructure";
 
 // Load .env
 dotenv.config();
 // Preload app config here to set needed env variables
 // before some modules require them.
-config();
+const appConfig = loadAppConfig();
+initFileStructure(appConfig);
 
 import {Router} from 'express';
 import {Database} from "@nsm/database";
 import {ServiceManager} from "@nsm/engine";
 import loadAddons from "./addon";
 import loadAppRoutes from '@nsm/router';
 import createDbManager from '@nsm/database';
-import initServiceManager from '@nsm/engine';
 import loadSecurity from "@nsm/security";
-import * as r from "@nsm/configuration/resources";
-import * as manager from "@nsm/engine";
+import * as manager from "@nsm/engine/manager";
+import * as sessionManager from "@nsm/engine/session";
 import * as logging from "./logger";
 import winston from "winston";
 import {Application} from "express-ws";
 import fs from "fs";
 import isInsideContainer from "@nsm/lib/isInsideContainer";
 import {middleLayer} from "@nsm/engine/middle";
+import {SessionManager} from "@nsm/engine/session";
+import {mkdirResource, saveResource} from "@nsm/resources";
+import path from "path";
+import {AppConfig} from "@nsm/config";
 
 export type AppBootContext = AppContext & { steps: any };
 
 // Passed context to the routes
 export type AppContext = {
     router: Router;
     manager: ServiceManager;
+    sessionManager: SessionManager;
     database: Database;
-    appConfig: any;
+    appConfig: AppConfig;
     logger: winston.Logger;
     debug: boolean;
     workers: boolean;
@@ -42,20 +48,11 @@ export type AppBootOptions = {
     disableWorkers?: boolean;
 }
 
-let currentContext: AppContext;
-
-function prepareServiceLogs(appConfig: any, logger: winston.Logger) {
-    if (appConfig.service_logs === true) {
-        logger.info('Service logs are enabled');
-        const path = process.cwd() + '/service_logs';
-        if (!fs.existsSync(path)) {
-            fs.mkdirSync(path);
-        }
-    }
-}
+export let currentContext: AppContext;
 
 function initGlobalLogger() {
-    logging.createNewLatest();
+    logging.createLatestLogFile();
+
     return logging.createLogger();
 }
 
@@ -79,23 +76,28 @@ function managerForUnsafeUse() {
     return new Proxy(manager, handler);
 }
 
-// App orchestration code
+/**
+ * App orchestration code.
+ *
+ * @param router The app router.
+ * @param options The optional boot options.
+ */
 export const init = async (router: Application, options?: AppBootOptions): Promise<AppBootContext> => {
     // Prepare logging
     const logger = initGlobalLogger();
 
-    r.prepareTemplatesFolder();
+    prepareFolders();
+
+    // Prepare templates folder
+    mkdirResource("templates");
     if (options?.test === true) {
-        r.prepareTestResources(); // Copy resources for test
+        prepareTestResources(); // Copy resources for test
     }
 
     // Load addon steps
     const steps = await loadAddons(logger);
 
     steps('BEFORE_CONFIG', { logger });
-    const appConfig = config();
-
-    prepareServiceLogs(appConfig, logger);
 
     // Database connection layer
     steps('BEFORE_DB', { logger, appConfig });
@@ -105,6 +107,7 @@ export const init = async (router: Application, options?: AppBootOptions): Promi
     const ctx = currentContext = {
         router,
         manager: managerForUnsafeUse(),
+        sessionManager,
         database,
         appConfig,
         logger,
@@ -114,7 +117,7 @@ export const init = async (router: Application, options?: AppBootOptions): Promi
 
     // Service (virtualization) layer
     steps('BEFORE_ENGINE', ctx);
-    await initServiceManager({ db: database, appConfig, logger });
+    await manager.init(database, appConfig, logger);
 
     // Bring back original manager
     ctx.manager = currentContext.manager = middleLayer(manager);
@@ -139,16 +142,20 @@ export const init = async (router: Application, options?: AppBootOptions): Promi
     let srv = undefined;
     if (options?.test == undefined || options.test == false) {
         logger.info(`Starting server`);
-        srv = router.listen(appConfig.port, () => {
-            logger.info(`Server started on port ${appConfig.port}`);
+        srv = router.listen(appConfig.getPort(), () => {
+            logger.info(`Server started on port ${appConfig.getPort()}`);
         });
     }
     steps('BOOT', ctx, srv);
     return { ...ctx, steps };
 }
 
-export {
-    Database,
-    ServiceManager,
-    currentContext
+const prepareTestResources = () => {
+    if (fs.existsSync(path.join(getResourcesTargetPath(), 'templates', 'test'))) {
+        return;
+    }
+
+    saveResource('template/test/test_settings.yml', 'templates/test/settings.yml')
+    saveResource('template/test/test_dockerfile', 'templates/test/Dockerfile')
+    saveResource('template/test/test_nsmignore', 'templates/test/.nsmignore')
 }