feat: make node deployable (#92)

* chore: port main.ts from id proxy

* build: add server script

* chore: use variables to determine host and port

* test: test createVariables

Author: wouteraj

packages/semcom-node/bin/server.js

@@ -0,0 +1,7 @@
+#!/usr/bin/env node
+
+const { launch, createVariables } = require('../dist/main.js');
+
+const variabes = createVariables(process.argv);
+
+launch(variabes);

packages/semcom-node/config/presets/server.json

@@ -4,11 +4,35 @@
     "https://linkedsoftwaredependencies.org/bundles/npm/@digita-ai/handlersjs-http/^0.0.0/components/context.jsonld"
   ],
   "@graph": [
+    {
+      "@id": "urn:semcom-node:variables:customConfigPath",
+      "@type": "Variable"
+    },
+    {
+      "@id": "urn:semcom-node:variables:mainModulePath",
+      "@type": "Variable"
+    },
+    {
+      "@id": "urn:semcom-node:variables:schema",
+      "@type": "Variable"
+    },
+    {
+      "@id": "urn:semcom-node:variables:host",
+      "@type": "Variable"
+    },
+    {
+      "@id": "urn:semcom-node:variables:port",
+      "@type": "Variable"
+    },
     {
       "@id": "urn:semcom-node:default:NodeHttpServer",
       "@type": "NodeHttpServer",
-      "NodeHttpServer:_port": "3000",
-      "NodeHttpServer:_host": "localhost",
+      "NodeHttpServer:_port": {
+        "@id": "urn:semcom-node:variables:port"
+      },
+      "NodeHttpServer:_host": {
+        "@id": "urn:semcom-node:variables:host"
+      },
       "NodeHttpServer:_nodeHttpStreamsHandler": {
         "@id": "urn:semcom-node:default:NodeHttpRequestResponseHandler",
         "@type": "NodeHttpRequestResponseHandler",

packages/semcom-node/lib/main.spec.ts

@@ -0,0 +1,59 @@
+import { ComponentsManager } from 'componentsjs';
+import { createVariables, launch } from './main';
+
+describe('launch', () => {
+
+  afterEach(() => {
+
+    jest.clearAllMocks();
+
+  });
+
+  // it('should call ComponentManager.build', async () => {
+
+  //   const buildSpy = jest.spyOn(ComponentsManager, 'build');
+
+  //   await launch(createVariables([ ]));
+
+  //   expect(buildSpy).toHaveBeenCalled();
+
+  // });
+
+});
+
+describe('createVariables', () => {
+
+  it('should create default variables when no arguments are given', (() => {
+
+    const variables = createVariables([ ]);
+
+    expect(variables).toEqual({
+      'urn:semcom-node:variables:customConfigPath': undefined,
+      'urn:semcom-node:variables:mainModulePath': undefined,
+      'urn:semcom-node:variables:schema': undefined,
+      'urn:semcom-node:variables:host': 'localhost',
+      'urn:semcom-node:variables:port': '3000',
+    });
+
+  }));
+
+  it('should create variables based on given arguments', (() => {
+
+    const variables = createVariables([
+      'bin',
+      'bin',
+      '-c',
+      'bla',
+    ]);
+
+    expect(variables).toEqual({
+      'urn:semcom-node:variables:customConfigPath': 'bla',
+      'urn:semcom-node:variables:mainModulePath': undefined,
+      'urn:semcom-node:variables:schema': undefined,
+      'urn:semcom-node:variables:host': 'localhost',
+      'urn:semcom-node:variables:port': '3000',
+    });
+
+  }));
+
+});

packages/semcom-node/lib/main.ts

@@ -1,24 +1,55 @@
 import * as path from 'path';
 import { ComponentsManager } from 'componentsjs';
 import { NodeHttpServer } from '@digita-ai/handlersjs-http';
+import yargs from 'yargs';
+import { hideBin } from 'yargs/helpers';
 
-const launch = async () => {
+/**
+ * Instantiates a server from the passed configuration and starts it.
+ *
+ * @param {Record<string, any>} variables - a record of values for the variables left open in the configuration.
+ */
+export const launch: (variables: Record<string, any>) => Promise<void> = async (variables: Record<string, any>) => {
 
-  const mainModulePath = path.join(__dirname, '../');
-  const configPath = path.join(__dirname, '../config/config-default.json');
+  const mainModulePath = variables['urn:semcom-node:variables:mainModulePath']
+    ? path.join(process.cwd(), variables['urn:semcom-node:variables:mainModulePath'])
+    : path.join(__dirname, '../');
+
+  const configPath = variables['urn:semcom-node:variables:customConfigPath']
+    ? path.join(process.cwd(), variables['urn:semcom-node:variables:customConfigPath'])
+    : path.join(__dirname, '../config/config-default.json');
 
   const manager = await ComponentsManager.build({
     mainModulePath,
+    logLevel: 'silly',
   });
 
   await manager.configRegistry.register(configPath);
 
-  const server: NodeHttpServer = await manager.instantiate(
-    'urn:semcom-node:default:NodeHttpServer',
-  );
-
+  const server: NodeHttpServer = await manager.instantiate('urn:semcom-node:default:NodeHttpServer', { variables });
   server.start();
 
 };
 
-launch();
+export const createVariables = (args: string[]): Record<string, any> => {
+
+  const { argv: params } = yargs(hideBin(args))
+    .usage('node ./dist/main.js [args]')
+    .options({
+      config: { type: 'string', alias: 'c' },
+      port: { type: 'number', alias: 'p' },
+      host: { type: 'string', alias: 'h' },
+      schema: { type: 'string', alias: 's' },
+      mainModulePath: { type: 'string', alias: 'm' },
+    })
+    .help();
+
+  return {
+    'urn:semcom-node:variables:customConfigPath': params.config,
+    'urn:semcom-node:variables:mainModulePath': params.mainModulePath,
+    'urn:semcom-node:variables:schema': params.schema,
+    'urn:semcom-node:variables:host': params.host ?? 'localhost',
+    'urn:semcom-node:variables:port': params.port ?? '3000',
+  };
+
+};