jitar 0.1.0 → 0.1.1

package/dist/core/SegmentBuilder.js

@@ -10,7 +10,6 @@ export default class SegmentBuilder {
             const procedure = this.#buildProcedure(definition);
             segment.addProcedure(procedure);
         }
-        ;
         return segment;
     }
     static #buildProcedure(definition) {

package/dist/runtime/ClientId.d.ts

@@ -0,0 +1,4 @@
+export default class ClientId {
+    static generate(): string;
+    static validate(clientId: string): boolean;
+}

package/dist/runtime/ClientId.js

@@ -0,0 +1,11 @@
+const CLIENT_ID_PREFIX = 'CLIENT_';
+const CLIENT_ID_REGEX = /^CLIENT_\d+$/;
+let lastClientId = 0;
+export default class ClientId {
+    static generate() {
+        return `${CLIENT_ID_PREFIX}${lastClientId++}`;
+    }
+    static validate(clientId) {
+        return CLIENT_ID_REGEX.test(clientId);
+    }
+}

package/dist/runtime/LocalRepository.d.ts

@@ -1,8 +1,8 @@
 import Module from '../core/types/Module.js';
-import FileManager from './interfaces/FileManager.js';
 import LocalNode from './LocalNode.js';
-import File from './models/File.js';
 import Repository from './Repository.js';
+import FileManager from './interfaces/FileManager.js';
+import File from './models/File.js';
 export default class LocalRepository extends Repository {
     #private;
     constructor(fileManager: FileManager, url?: string);

package/dist/runtime/LocalRepository.js

@@ -1,12 +1,11 @@
-import File from './models/File.js';
+import ClientId from './ClientId.js';
 import Repository from './Repository.js';
+import File from './models/File.js';
 import ModuleLoader from './utils/ModuleLoader.js';
 import ClientNotFound from './errors/ClientNotFound.js';
 import InvalidClientId from './errors/InvalidClientId.js';
 import InvalidSegmentFile from './errors/InvalidSegmentFile.js';
 import { setRuntime } from '../hooks.js';
-let lastClientId = 0;
-const CLIENT_ID_PREFIX = 'CLIENT_';
 export default class LocalRepository extends Repository {
     #fileManager;
     #segments = new Map();
@@ -29,7 +28,7 @@ export default class LocalRepository extends Repository {
         files.forEach((file) => this.#segments.set(file, name));
     }
     async registerClient(segmentFilenames) {
-        const clientId = `${CLIENT_ID_PREFIX}${lastClientId++}`;
+        const clientId = ClientId.generate();
         this.#clients.set(clientId, segmentFilenames);
         return clientId;
     }
@@ -57,7 +56,7 @@ export default class LocalRepository extends Repository {
         return ModuleLoader.import(location);
     }
     #validateClientId(clientId) {
-        if (clientId.startsWith(CLIENT_ID_PREFIX) === false) {
+        if (ClientId.validate(clientId) === false) {
             throw new InvalidClientId(clientId);
         }
         if (this.#clients.has(clientId) === false) {

package/dist/runtime/caching/CacheBuilder.js

@@ -175,12 +175,12 @@ export default class CacheBuilder {
         return `${importCode}\n\n${modelCode}`;
     }
     #createSegmentImportCode(segment) {
-        let codes = [];
+        const codes = [];
         for (const module of segment.modules) {
             const relativeLocation = this.#sourceManager.getRelativeLocation(module.filename);
             const imports = [];
             for (const [importKey, implementation] of module.implementations) {
-                imports.push(`${importKey} as \$${implementation.id}`);
+                imports.push(`${importKey} as $${implementation.id}`);
             }
             codes.push(`import { ${imports.join(',')} } from "./${relativeLocation}";`);
         }
@@ -191,7 +191,7 @@ export default class CacheBuilder {
         for (const procedure of segment.procedures.values()) {
             const implementationCode = [];
             for (const implementation of procedure.implementations) {
-                implementationCode.push(`{ access: "${implementation.access}", version: "${implementation.version}", executable: \$${implementation.id} }`);
+                implementationCode.push(`{ access: "${implementation.access}", version: "${implementation.version}", executable: $${implementation.id} }`);
             }
             procedureCode.push(`{ module: "${procedure.module}", name: "${procedure.name}", implementations: [\n\t\t${implementationCode.join(',\n\t\t')}\n\t]}`);
         }

package/dist/runtime/serialization/ClassSerializer.js

@@ -2,6 +2,7 @@ import ReflectionHelper from '../../core/reflection/ReflectionHelper.js';
 import ModuleLoader from '../utils/ModuleLoader.js';
 import ClassNotFound from './errors/ClassNotFound.js';
 import InvalidClass from './errors/InvalidClass.js';
+import InvalidPropertyType from './errors/InvalidPropertyType.js';
 import ValueSerializer from './ValueSerializer.js';
 class ClassSerializer {
     serialize(object) {
@@ -30,6 +31,7 @@ class ClassSerializer {
         return { serialized: true, name: name, source: source, args: args, fields: fields };
     }
     async deserialize(object) {
+        this.#validateSerializedClass(object);
         const clazz = await this.#loadClass(object.source, object.name);
         if (clazz === undefined) {
             throw new ClassNotFound(object.name);
@@ -45,6 +47,20 @@ class ClassSerializer {
         }
         return instance;
     }
+    #validateSerializedClass(object) {
+        if (typeof object.name !== 'string') {
+            throw new InvalidPropertyType('class', 'name', 'string');
+        }
+        if (object.source !== null && typeof object.source !== 'string') {
+            throw new InvalidPropertyType(`class '${object.name}'`, 'source', 'string | null');
+        }
+        if ((object.args instanceof Array) === false) {
+            throw new InvalidPropertyType(`class '${object.name}'`, 'args', 'Array');
+        }
+        if ((object.fields instanceof Object) === false) {
+            throw new InvalidPropertyType(`class '${object.name}'`, 'fields', 'Object');
+        }
+    }
     async #loadClass(source, name) {
         if (source === null) {
             const system = typeof window !== 'undefined' ? window : global;

package/dist/runtime/serialization/MapSerializer.d.ts

@@ -1,6 +1,7 @@
 import Serializer from './interfaces/Serializer.js';
 import SerializedMap from './types/SerializedMap.js';
 declare class MapSerializer implements Serializer {
+    #private;
     serialize(map: Map<unknown, unknown>): SerializedMap;
     deserialize(object: SerializedMap): Promise<Map<unknown, unknown>>;
 }

package/dist/runtime/serialization/MapSerializer.js

@@ -1,3 +1,4 @@
+import InvalidPropertyType from './errors/InvalidPropertyType.js';
 import ValueSerializer from './ValueSerializer.js';
 class MapSerializer {
     serialize(map) {
@@ -10,6 +11,7 @@ class MapSerializer {
         return { serialized: true, name: 'Map', entries: { keys: keys, values: values } };
     }
     async deserialize(object) {
+        this.#validateSerializedMap(object);
         const keys = object.entries.keys;
         const values = object.entries.values;
         const result = new Map();
@@ -20,6 +22,14 @@ class MapSerializer {
         }
         return result;
     }
+    #validateSerializedMap(object) {
+        if ((object.entries?.keys instanceof Array) === false) {
+            throw new InvalidPropertyType('map', 'entries.keys', 'Array');
+        }
+        if ((object.entries?.values instanceof Array) === false) {
+            throw new InvalidPropertyType('map', 'entries.values', 'Array');
+        }
+    }
 }
 const instance = new MapSerializer();
 export default instance;

package/dist/runtime/serialization/SetSerializer.d.ts

@@ -1,6 +1,7 @@
 import Serializer from './interfaces/Serializer.js';
 import SerializedSet from './types/SerializedSet.js';
 declare class SetSerializer implements Serializer {
+    #private;
     serialize(set: Set<unknown>): SerializedSet;
     deserialize(object: SerializedSet): Promise<Set<unknown>>;
 }

package/dist/runtime/serialization/SetSerializer.js

@@ -1,3 +1,4 @@
+import InvalidPropertyType from './errors/InvalidPropertyType.js';
 import ValueSerializer from './ValueSerializer.js';
 class SetSerializer {
     serialize(set) {
@@ -8,9 +9,15 @@ class SetSerializer {
         return { serialized: true, name: 'Set', values: values };
     }
     async deserialize(object) {
+        this.#validateSerializedSet(object);
         const values = await Promise.all(object.values.map(async (value) => await ValueSerializer.deserialize(value)));
         return new Set([...values]);
     }
+    #validateSerializedSet(object) {
+        if ((object.values instanceof Array) === false) {
+            throw new InvalidPropertyType('set', 'values', 'Array');
+        }
+    }
 }
 const instance = new SetSerializer();
 export default instance;

package/dist/runtime/serialization/errors/InvalidPropertyType.d.ts

@@ -0,0 +1,3 @@
+export default class InvalidPropertyType extends Error {
+    constructor(typeName: string, propertyName: string, expectedType: string);
+}

package/dist/runtime/serialization/errors/InvalidPropertyType.js

@@ -0,0 +1,6 @@
+export default class InvalidPropertyType extends Error {
+    constructor(typeName, propertyName, expectedType) {
+        super(`The ${typeName} property '${propertyName}' has an invalid type (expected '${expectedType}')`);
+    }
+}
+InvalidPropertyType.source = '/jitar/runtime/serialization/errors/InvalidPropertyType.js';

package/dist/server/controllers/ModulesController.js

@@ -9,6 +9,7 @@ var __metadata = (this && this.__metadata) || function (k, v) {
 };
 import { Controller, Get, Post } from '@overnightjs/core';
 import { Logger } from 'tslog';
+import ClientId from '../../runtime/ClientId.js';
 import ValueSerializer from '../../runtime/serialization/ValueSerializer.js';
 let ModulesController = class ModulesController {
     #repository;
@@ -18,6 +19,8 @@ let ModulesController = class ModulesController {
         this.#logger = logger;
     }
     async registerClient(request, response) {
+        if ((request.body instanceof Array) === false) {
+        }
         const segmentFiles = request.body;
         const clientId = await this.#repository.registerClient(segmentFiles);
         this.#logger.info(`Registered client -> ${clientId} [${segmentFiles.join(',')}]`);
@@ -25,6 +28,9 @@ let ModulesController = class ModulesController {
     }
     async getModule(request, response) {
         const clientId = request.params.clientId;
+        if (typeof clientId !== 'string' || ClientId.validate(clientId) === false) {
+            return response.status(400).send('Invalid client id.');
+        }
         const pathKey = `/${clientId}/`;
         const pathIndex = request.path.indexOf(pathKey) + pathKey.length;
         const filename = request.path.substring(pathIndex);

package/package.json

@@ -1,6 +1,7 @@
 {
     "name": "jitar",
-    "version": "0.1.0",
+    "version": "0.1.1",
+    "description": "Distributed runtime for JavaScript and TypeScript to chop monolithic applications into micros.",
     "author": "Masking Technology <info@masking.tech> (https://jitar.dev)",
     "license": "MIT",
     "type": "module",
@@ -30,7 +31,7 @@
         "glob-promise": "^5.0.0",
         "mime-types": "^2.1.35",
         "tslog": "^3.3.3",
-        "yargs": "^17.5.1"
+        "yargs": "^17.6.0"
     },
     "devDependencies": {
         "@types/express": "^4.17.13",
@@ -38,11 +39,29 @@
         "@types/fs-extra": "^9.0.13",
         "@types/jest": "^28.1.3",
         "@types/mime-types": "^2.1.1",
-        "@types/yargs": "^17.0.10",
+        "@types/yargs": "^17.0.13",
         "@typescript-eslint/eslint-plugin": "^5.29.0",
         "@typescript-eslint/parser": "^5.29.0",
         "eslint": "^8.18.0",
         "jest": "^28.1.3",
         "ts-jest": "^28.0.8"
-    }
+    },
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/MaskingTechnology/jitar"
+    },
+    "bugs": {
+        "url": "https://github.com/MaskingTechnology/jitar/issues"
+    },
+    "homepage": "https://jitar.dev",
+    "keywords": [
+        "distributed",
+        "runtime",
+        "javascript",
+        "typescript",
+        "microservices",
+        "monolith",
+        "full stack",
+        "web applications"
+    ]
 }

package/src/core/SegmentBuilder.ts

@@ -21,7 +21,7 @@ export default class SegmentBuilder
             const procedure = this.#buildProcedure(definition);
 
             segment.addProcedure(procedure);
-        };
+        }
 
         return segment;
     }

package/src/runtime/ClientId.ts

@@ -0,0 +1,18 @@
+
+const CLIENT_ID_PREFIX = 'CLIENT_';
+const CLIENT_ID_REGEX = /^CLIENT_\d+$/;
+
+let lastClientId = 0;
+
+export default class ClientId
+{
+    static generate(): string
+    {
+        return `${CLIENT_ID_PREFIX}${lastClientId++}`;
+    }
+
+    static validate(clientId: string): boolean
+    {
+        return CLIENT_ID_REGEX.test(clientId);
+    }
+}

package/src/runtime/LocalRepository.ts

@@ -1,10 +1,11 @@
 
 import Module from '../core/types/Module.js';
 
-import FileManager from './interfaces/FileManager.js';
+import ClientId from './ClientId.js';
 import LocalNode from './LocalNode.js';
-import File from './models/File.js';
 import Repository from './Repository.js';
+import FileManager from './interfaces/FileManager.js';
+import File from './models/File.js';
 import ModuleLoader from './utils/ModuleLoader.js';
 
 import ClientNotFound from './errors/ClientNotFound.js';
@@ -13,10 +14,6 @@ import InvalidSegmentFile from './errors/InvalidSegmentFile.js';
 
 import { setRuntime } from '../hooks.js';
 
-let lastClientId = 0;
-
-const CLIENT_ID_PREFIX = 'CLIENT_';
-
 export default class LocalRepository extends Repository
 {
     #fileManager: FileManager;
@@ -52,7 +49,7 @@ export default class LocalRepository extends Repository
 
     async registerClient(segmentFilenames: string[]): Promise<string>
     {
-        const clientId = `${CLIENT_ID_PREFIX}${lastClientId++}`;
+        const clientId = ClientId.generate();
 
         this.#clients.set(clientId, segmentFilenames);
 
@@ -105,7 +102,7 @@ export default class LocalRepository extends Repository
 
     #validateClientId(clientId: string): void
     {
-        if (clientId.startsWith(CLIENT_ID_PREFIX) === false)
+        if (ClientId.validate(clientId) === false)
         {
             throw new InvalidClientId(clientId);
         }

package/src/runtime/caching/CacheBuilder.ts

@@ -297,7 +297,7 @@ export default class CacheBuilder
 
     #createSegmentImportCode(segment: Segment): string
     {
-        let codes: string[] = [];
+        const codes: string[] = [];
 
         for (const module of segment.modules)
         {
@@ -306,7 +306,7 @@ export default class CacheBuilder
 
             for (const [importKey, implementation] of module.implementations)
             {
-                imports.push(`${importKey} as \$${implementation.id}`);
+                imports.push(`${importKey} as $${implementation.id}`);
             }
 
             codes.push(`import { ${imports.join(',')} } from "./${relativeLocation}";`);
@@ -325,7 +325,7 @@ export default class CacheBuilder
 
             for (const implementation of procedure.implementations)
             {
-                implementationCode.push(`{ access: "${implementation.access}", version: "${implementation.version}", executable: \$${implementation.id} }`);
+                implementationCode.push(`{ access: "${implementation.access}", version: "${implementation.version}", executable: $${implementation.id} }`);
             }
 
             procedureCode.push(`{ module: "${procedure.module}", name: "${procedure.name}", implementations: [\n\t\t${implementationCode.join(',\n\t\t')}\n\t]}`);

package/src/runtime/serialization/ClassSerializer.ts

@@ -7,10 +7,13 @@ import Module from '../../core/types/Module.js';
 import ModuleLoader from '../utils/ModuleLoader.js';
 import ClassNotFound from './errors/ClassNotFound.js';
 import InvalidClass from './errors/InvalidClass.js';
+import InvalidPropertyType from './errors/InvalidPropertyType.js';
 
 import Serializer from './interfaces/Serializer.js';
+
 import SerializableObject from './types/SerializableObject.js';
 import SerializedClass from './types/SerializedClass.js';
+
 import ValueSerializer from './ValueSerializer.js';
 
 class ClassSerializer implements Serializer
@@ -59,6 +62,8 @@ class ClassSerializer implements Serializer
 
     async deserialize(object: SerializedClass): Promise<SerializableObject>
     {
+        this.#validateSerializedClass(object);
+
         const clazz = await this.#loadClass(object.source, object.name);
 
         if (clazz === undefined)
@@ -85,6 +90,29 @@ class ClassSerializer implements Serializer
         return instance;
     }
 
+    #validateSerializedClass(object: SerializedClass): void
+    {
+        if (typeof object.name !== 'string')
+        {
+            throw new InvalidPropertyType('class', 'name', 'string');
+        }
+
+        if (object.source !== null && typeof object.source !== 'string')
+        {
+            throw new InvalidPropertyType(`class '${object.name}'`, 'source', 'string | null');
+        }
+
+        if ((object.args instanceof Array) === false)
+        {
+            throw new InvalidPropertyType(`class '${object.name}'`, 'args', 'Array');
+        }
+
+        if ((object.fields instanceof Object) === false)
+        {
+            throw new InvalidPropertyType(`class '${object.name}'`, 'fields', 'Object');
+        }
+    }
+
     async #loadClass(source: string | null, name: string): Promise<unknown>
     {
         if (source === null)

package/src/runtime/serialization/MapSerializer.ts

@@ -1,7 +1,8 @@
 
+import InvalidPropertyType from './errors/InvalidPropertyType.js';
 import Serializer from './interfaces/Serializer.js';
-
 import SerializedMap from './types/SerializedMap.js';
+
 import ValueSerializer from './ValueSerializer.js';
 
 class MapSerializer implements Serializer
@@ -22,6 +23,8 @@ class MapSerializer implements Serializer
 
     async deserialize(object: SerializedMap): Promise<Map<unknown, unknown>>
     {
+        this.#validateSerializedMap(object);
+
         const keys = object.entries.keys;
         const values = object.entries.values;
 
@@ -37,6 +40,19 @@ class MapSerializer implements Serializer
 
         return result;
     }
+
+    #validateSerializedMap(object: SerializedMap): void
+    {
+        if ((object.entries?.keys instanceof Array) === false)
+        {
+            throw new InvalidPropertyType('map', 'entries.keys', 'Array');
+        }
+
+        if ((object.entries?.values instanceof Array) === false)
+        {
+            throw new InvalidPropertyType('map', 'entries.values', 'Array');
+        }
+    }
 }
 
 const instance = new MapSerializer();

package/src/runtime/serialization/SetSerializer.ts

@@ -1,4 +1,5 @@
 
+import InvalidPropertyType from './errors/InvalidPropertyType.js';
 import Serializer from './interfaces/Serializer.js';
 import SerializedSet from './types/SerializedSet.js';
 
@@ -20,10 +21,20 @@ class SetSerializer implements Serializer
 
     async deserialize(object: SerializedSet): Promise<Set<unknown>>
     {
+        this.#validateSerializedSet(object);
+
         const values = await Promise.all(object.values.map(async (value: unknown) => await ValueSerializer.deserialize(value)));
 
         return new Set([...values]);
     }
+
+    #validateSerializedSet(object: SerializedSet): void
+    {
+        if ((object.values instanceof Array) === false)
+        {
+            throw new InvalidPropertyType('set', 'values', 'Array');
+        }
+    }
 }
 
 const instance = new SetSerializer();

package/src/runtime/serialization/ValueSerializer.ts

@@ -35,7 +35,7 @@ class ValueSerializer implements Serializer
         {
             // The error class is like Array, Map and Set in that it's a native class.
             // Native classes cannot be defined as a class object by the reflection helper.
-            // Unlike Array, Map and Set, the error class can be serialzed by the class serializer.
+            // Unlike Array, Map and Set, the error class can be serialized by the class serializer.
 
             // The type casting below isn't pretty, but works for now...
             return ClassSerializer.serialize(value as unknown as SerializableObject);

package/src/runtime/serialization/errors/InvalidPropertyType.ts

@@ -0,0 +1,12 @@
+
+import Component from '../../../core/types/Component.js';
+
+export default class InvalidPropertyType extends Error
+{
+    constructor(typeName: string, propertyName: string, expectedType: string)
+    {
+        super(`The ${typeName} property '${propertyName}' has an invalid type (expected '${expectedType}')`);
+    }
+}
+
+(InvalidPropertyType as Component).source = '/jitar/runtime/serialization/errors/InvalidPropertyType.js';

package/src/server/controllers/ModulesController.ts

@@ -3,6 +3,7 @@ import { Controller, Get, Post } from '@overnightjs/core';
 import { Request, Response } from 'express';
 import { Logger } from 'tslog';
 
+import ClientId from '../../runtime/ClientId.js';
 import LocalRepository from '../../runtime/LocalRepository.js';
 import Proxy from '../../runtime/Proxy.js';
 import ValueSerializer from '../../runtime/serialization/ValueSerializer.js';
@@ -22,6 +23,11 @@ export default class ModulesController
     @Post()
     async registerClient(request: Request, response: Response): Promise<Response>
     {
+        if ((request.body instanceof Array) === false)
+        {
+            // TODO: Throw error.
+        }
+
         const segmentFiles = request.body as string[];
 
         const clientId = await this.#repository.registerClient(segmentFiles);
@@ -36,6 +42,11 @@ export default class ModulesController
     {
         const clientId = request.params.clientId;
 
+        if (typeof clientId !== 'string' || ClientId.validate(clientId) === false)
+        {
+            return response.status(400).send('Invalid client id.');
+        }
+
         const pathKey = `/${clientId}/`;
         const pathIndex = request.path.indexOf(pathKey) + pathKey.length;
         const filename = request.path.substring(pathIndex);

package/test/runtime/ClientId.spec.ts

@@ -0,0 +1,43 @@
+
+import ClientId from '../../src/runtime/ClientId';
+
+describe('runtime/ClientId', () =>
+{
+    describe('.generate()', () =>
+    {
+        it('should generate a client id', () =>
+        {
+            const clientId = ClientId.generate();
+
+            expect(clientId).toMatch(/^CLIENT_\d+$/);
+        });
+
+        it('should generate a different client id each time', () =>
+        {
+            const clientId1 = ClientId.generate();
+            const clientId2 = ClientId.generate();
+
+            expect(clientId1).not.toBe(clientId2);
+        });
+    });
+
+    describe('.validate(clientId)', () =>
+    {
+        it('should return true if the client id is valid', () =>
+        {
+            expect(ClientId.validate('CLIENT_0')).toBe(true);
+            expect(ClientId.validate('CLIENT_42')).toBe(true);
+            expect(ClientId.validate('CLIENT_007')).toBe(true);
+        });
+
+        it('should return false if the client id is invalid', () =>
+        {
+            expect(ClientId.validate('CLIENT_')).toBe(false);
+            expect(ClientId.validate('CLIENT_X')).toBe(false);
+            expect(ClientId.validate('CLIENT_0a')).toBe(false);
+            expect(ClientId.validate('CLIENT_0.1')).toBe(false);
+            expect(ClientId.validate('Client_0')).toBe(false);
+            expect(ClientId.validate('SERVER_0')).toBe(false);
+        });
+    });
+});

package/test/runtime/LocalRepository.spec.ts

@@ -21,9 +21,9 @@ describe('runtime/LocalRepository', () =>
 
         it('should not accept an unknown client id', () =>
         {
-            const run = async () => await repository.loadModule('CLIENT_X', '/some/file');
+            const run = async () => await repository.loadModule('CLIENT_9999', '/some/file');
 
-            expect(run).rejects.toEqual(new ClientNotFound('CLIENT_X'));
+            expect(run).rejects.toEqual(new ClientNotFound('CLIENT_9999'));
         });
 
         it('should return an unsegmented module file', async () =>

package/test/runtime/serialization/ValueSerializer.spec.ts

@@ -81,7 +81,7 @@ describe('serialization/ValueSerializer', () =>
 
         it('should serialize error', () =>
         {
-            const error = ValueSerializer.serialize(errorClass) as any;
+            const error = ValueSerializer.serialize(errorClass) as unknown;
 
             expect(error).toEqual(serializedError);
         });