jitar 0.1.1 → 0.1.2

package/src/server/utils/LocalFileManager.ts

@@ -1,122 +0,0 @@
-
-import fs from 'fs-extra';
-import glob from 'glob-promise';
-import mime from 'mime-types';
-import path from 'path';
-
-import FileNotFound from '../../runtime/errors/FileNotFound.js';
-import FileManager from '../../runtime/interfaces/FileManager.js';
-import File from '../../runtime/models/File.js';
-
-export default class LocalFileManager implements FileManager
-{
-    #location: string;
-
-    constructor(location: string)
-    {
-        this.#location = location;
-    }
-
-    getRootLocation(): string
-    {
-        return path.resolve(this.#location);
-    }
-
-    getAbsoluteLocation(filename: string): string
-    {
-        const location = filename.startsWith('/') ? filename : path.join(this.#location, filename);
-
-        return path.resolve(location);
-    }
-
-    getRelativeLocation(filename: string): string
-    {
-        return path.relative(this.#location, filename);
-    }
-
-    async getType(filename: string): Promise<string>
-    {
-        const location = this.getAbsoluteLocation(filename);
-
-        return mime.lookup(location) || 'application/octet-stream';
-    }
-
-    async getContent(filename: string): Promise<Buffer>
-    {
-        const location = this.getAbsoluteLocation(filename);
-
-        if (fs.existsSync(location) === false)
-        {
-            // Do NOT use the location in the error message,
-            // as it may contain sensitive information.
-            throw new FileNotFound(filename);
-        }
-
-        return fs.readFile(location);
-    }
-
-    async load(filename: string): Promise<File>
-    {
-        const type = await this.getType(filename);
-        const content = await this.getContent(filename);
-
-        return new File(filename, type, content);
-    }
-
-    async store(filename: string, content: string): Promise<void>
-    {
-        const location = this.getAbsoluteLocation(filename);
-        const directory = path.dirname(location);
-
-        await fs.mkdir(directory, { recursive: true });
-
-        return fs.writeFile(location, content);
-    }
-
-    async copy(source: string, destination: string): Promise<void>
-    {
-        const sourceLocation = this.getAbsoluteLocation(source);
-        const destinationLocation = this.getAbsoluteLocation(destination);
-
-        return fs.copy(sourceLocation, destinationLocation, { overwrite: true });
-    }
-
-    async remove(filename: string): Promise<void>
-    {
-        const location = this.getAbsoluteLocation(filename);
-
-        return fs.remove(location);
-    }
-
-    async getModuleFileNames(): Promise<string[]>
-    {
-        const location = this.getAbsoluteLocation('./');
-        const filenames = await glob(`${location}/**/*.js`);
-
-        return filenames;
-    }
-
-    async getSegmentFiles(): Promise<string[]>
-    {
-        const location = this.getAbsoluteLocation('./');
-        const filenames = await glob(`${location}/**/*.segment.json`);
-
-        return filenames;
-    }
-
-    async getNodeSegmentFiles(): Promise<string[]>
-    {
-        const location = this.getAbsoluteLocation('./');
-        const filenames = await glob(`${location}/**/*.segment.local.js`);
-
-        return filenames;
-    }
-
-    async getRepositorySegmentFiles(): Promise<string[]>
-    {
-        const location = this.getAbsoluteLocation('./');
-        const filenames = await glob(`${location}/**/*.segment.repository.js`);
-
-        return filenames;
-    }
-}

package/src/server/utils/RuntimeConfigurationLoader.ts

@@ -1,19 +0,0 @@
-
-import { readFileSync } from 'fs';
-
-import RuntimeConfiguration from '../configuration/RuntimeConfiguration.js';
-
-import DataConverter from './DataConverter.js';
-
-export default class RuntimeConfigurationLoader
-{
-    static async load(filename: string): Promise<RuntimeConfiguration>
-    {
-        const plainContents = readFileSync(filename, 'utf-8');
-        const parsedContents = JSON.parse(plainContents);
-
-        const configuration = await DataConverter.convert<RuntimeConfiguration>(RuntimeConfiguration, parsedContents);
-
-        return configuration;
-    }
-}

package/src/server/utils/RuntimeConfigurator.ts

@@ -1,207 +0,0 @@
-
-import CacheBuilder from '../../runtime/caching/CacheBuilder.js';
-import Gateway from '../../runtime/Gateway.js';
-import LocalGateway from '../../runtime/LocalGateway.js';
-import LocalNode from '../../runtime/LocalNode.js';
-import LocalRepository from '../../runtime/LocalRepository.js';
-import Node from '../../runtime/Node.js';
-import NodeMonitor from '../../runtime/NodeMonitor.js';
-import Proxy from '../../runtime/Proxy.js';
-import RemoteGateway from '../../runtime/RemoteGateway.js';
-import RemoteNode from '../../runtime/RemoteNode.js';
-import RemoteRepository from '../../runtime/RemoteRepository.js';
-import Repository from '../../runtime/Repository.js';
-import Runtime from '../../runtime/Runtime.js';
-
-import LocalFileManager from './LocalFileManager.js';
-
-import RuntimeConfiguration from '../configuration/RuntimeConfiguration.js';
-import StandaloneConfiguration from '../configuration/StandaloneConfiguration.js';
-import RepositoryConfiguration from '../configuration/RepositoryConfiguration.js';
-import GatewayConfiguration from '../configuration/GatewayConfiguration.js';
-import NodeConfiguration from '../configuration/NodeConfiguration.js';
-import ProxyConfiguration from '../configuration/ProxyConfiguration.js';
-
-import RuntimeDefaults from '../definitions/RuntimeDefaults.js';
-
-import MissingConfigurationValue from '../errors/MissingConfigurationValue.js';
-import UnknownRuntimeMode from '../errors/UnknownRuntimeMode.js';
-
-export default class RuntimeConfigurator
-{
-    static async configure(configuration: RuntimeConfiguration): Promise<Runtime>
-    {
-        const url = configuration.url ?? RuntimeDefaults.URL;
-
-        if (configuration.standalone !== undefined) return this.#configureStandAlone(url, configuration.standalone);
-        if (configuration.repository !== undefined) return this.#configureRepository(url, configuration.repository);
-        if (configuration.gateway !== undefined) return this.#configureGateway(url, configuration.gateway);
-        if (configuration.node !== undefined) return this.#configureNode(url, configuration.node);
-        if (configuration.proxy !== undefined) return this.#configureProxy(url, configuration.proxy);
-
-        throw new UnknownRuntimeMode();
-    }
-
-    static async #configureStandAlone(url: string, configuration: StandaloneConfiguration): Promise<Proxy>
-    {
-        const sourceLocation = configuration.source ?? RuntimeDefaults.SOURCE;
-        const cacheLocation = configuration.cache ?? RuntimeDefaults.CACHE;
-
-        await this.#buildCache(sourceLocation, cacheLocation);
-
-        const segmentNames = configuration.segments === undefined
-            ? await this.#getSegmentNames(cacheLocation)
-            : configuration.segments;
-
-        const repository = await this.#buildRepository(url, cacheLocation);
-        const node = await this.#buildNode(url, segmentNames, repository);
-
-        return this.#buildProxy(url, repository, node);
-    }
-
-    static async #configureRepository(url: string, configuration: RepositoryConfiguration): Promise<LocalRepository>
-    {
-        const sourceLocation = configuration.source ?? RuntimeDefaults.SOURCE;
-        const cacheLocation = configuration.cache ?? RuntimeDefaults.CACHE;
-
-        await this.#buildCache(sourceLocation, cacheLocation);
-        return this.#buildRepository(url, cacheLocation);
-    }
-
-    static async #configureGateway(url: string, configuration: GatewayConfiguration): Promise<LocalGateway>
-    {
-        return this.#buildGateway(url, configuration.monitor);
-    }
-
-    static async #configureNode(url: string, configuration: NodeConfiguration): Promise<LocalNode>
-    {
-        const segmentNames = configuration.segments ?? [];
-
-        const repository = configuration.repository !== undefined
-            ? new RemoteRepository(configuration.repository)
-            : undefined;
-
-        const gateway = configuration.gateway !== undefined
-            ? new RemoteGateway(configuration.gateway)
-            : undefined;
-
-        return this.#buildNode(url, segmentNames, repository, gateway);
-    }
-
-    static async #configureProxy(url: string, configuration: ProxyConfiguration): Promise<Proxy>
-    {
-        if (configuration.repository === undefined)
-        {
-            throw new MissingConfigurationValue('proxy.repository');
-        }
-
-        const repository = new RemoteRepository(configuration.repository);
-
-        const gateway = configuration.gateway !== undefined
-            ? new RemoteGateway(configuration.gateway)
-            : undefined;
-
-        const node = configuration.node !== undefined
-            ? new RemoteNode(configuration.node, [])
-            : undefined;
-
-        const runner = gateway ?? node;
-
-        if (runner === undefined)
-        {
-            throw new MissingConfigurationValue('proxy.gateway or proxy.node');
-        }
-
-        return this.#buildProxy(url, repository, runner);
-    }
-
-    static async #buildCache(sourceLocation: string, cacheLocation: string): Promise<LocalFileManager>
-    {
-        const rootManager = new LocalFileManager('./');
-        await rootManager.remove(cacheLocation);
-        await rootManager.copy(sourceLocation, cacheLocation);
-
-        const sourceManager = new LocalFileManager(sourceLocation);
-        const cacheManager = new LocalFileManager(cacheLocation);
-
-        const segmentFiles = await rootManager.getSegmentFiles();
-        const moduleFiles = await sourceManager.getModuleFileNames();
-
-        const cacheBuilder = new CacheBuilder(sourceManager, cacheManager);
-        await cacheBuilder.build(segmentFiles, moduleFiles);
-
-        return cacheManager;
-    }
-
-    static async #getSegmentNames(cacheLocation: string): Promise<string[]>
-    {
-        const fileManager = new LocalFileManager(cacheLocation);
-        const segmentFilenames = await fileManager.getNodeSegmentFiles();
-
-        return segmentFilenames.map(filename => this.#extractSegmentName(filename));
-    }
-
-    static #extractSegmentName(filename: string): string
-    {
-        const name = filename.split('/').pop() ?? '';
-        const endIndex = name.indexOf('.segment');
-
-        return name.substring(0, endIndex);
-    }
-
-    static async #buildRepository(url: string | undefined, cacheLocation: string): Promise<LocalRepository>
-    {
-        const fileManager = new LocalFileManager(cacheLocation);
-        const repository = new LocalRepository(fileManager, url);
-
-        const segmentFilenames = await fileManager.getRepositorySegmentFiles();
-        const segmentNames = segmentFilenames.map(filename => this.#extractSegmentName(filename));
-
-        for (const name of segmentNames)
-        {
-            await repository.loadSegment(name);
-        }
-
-        return repository;
-    }
-
-    static async #buildGateway(url?: string, monitorInterval?: number): Promise<LocalGateway>
-    {
-        const gateway = new LocalGateway(url);
-        const monitor = new NodeMonitor(gateway, monitorInterval);
-
-        monitor.start();
-
-        return gateway;
-    }
-
-    static async #buildNode(url: string | undefined, segmentNames: string[], repository?: Repository, gateway?: Gateway): Promise<LocalNode>
-    {
-        const node = new LocalNode(url);
-
-        if (repository !== undefined)
-        {
-            await node.setRepository(repository, segmentNames);
-        }
-
-        for (const segmentName of segmentNames)
-        {
-            await node.loadSegment(segmentName);
-        }
-
-        // All segments have to be loaded before a node
-        // can be registered at the gateway
-
-        if (gateway !== undefined)
-        {
-            node.setGateway(gateway);
-        }
-
-        return node;
-    }
-
-    static async #buildProxy(url: string | undefined, repository: Repository, runner: Gateway | Node): Promise<Proxy>
-    {
-        return new Proxy(repository, runner, url);
-    }
-}

package/src/server/utils/ServerOptionsReader.ts

@@ -1,17 +0,0 @@
-
-import yargs from 'yargs';
-
-import ServerOptions from '../configuration/ServerOptions.js';
-
-import DataConverter from './DataConverter.js';
-
-export default class ServerOptionsReader
-{
-    static async read(): Promise<ServerOptions>
-    {
-        const args: object = yargs(process.argv).argv
-        const options = await DataConverter.convert<ServerOptions>(ServerOptions, args);
-
-        return options;
-    }
-}

package/src/server.ts

@@ -1,16 +0,0 @@
-
-import ModuleImporter from './runtime/types/ModuleImporter.js';
-import ModuleLoader from './runtime/utils/ModuleLoader.js';
-
-import JitarServer from './server/JitarServer.js';
-
-export async function startServer(moduleImporter: ModuleImporter): Promise<JitarServer>
-{
-    ModuleLoader.setImporter(moduleImporter);
-
-    const server = new JitarServer();
-
-    await server.start();
-
-    return server;
-}

package/test/_fixtures/core/Implementation.fixture.ts

@@ -1,33 +0,0 @@
-
-import * as AccessLevel from '../../../src/core/definitions/AccessLevel';
-import Implementation from '../../../src/core/Implementation';
-import Version from '../../../src/core/Version';
-import ReflectionHelper from '../../../src/core/reflection/ReflectionHelper';
-
-function getPrivate(): string
-{
-    return 'private';
-}
-
-function getPublic(): string
-{
-    return 'public';
-}
-
-function getParameters(mandatory: string, optional = 'default')
-{
-    return `${mandatory} ${optional}`;
-}
-
-const parameters = ReflectionHelper.getFunctionParameters(getParameters);
-
-const privateImplementation = new Implementation(Version.DEFAULT, AccessLevel.PRIVATE, [], getPrivate);
-const publicImplementation = new Implementation(Version.DEFAULT, AccessLevel.PUBLIC, [], getPublic);
-const parameterImplementation = new Implementation(Version.DEFAULT, AccessLevel.PUBLIC, parameters, getParameters);
-
-export
-{
-    privateImplementation,
-    publicImplementation,
-    parameterImplementation
-}

package/test/_fixtures/core/Procedure.fixture.ts

@@ -1,33 +0,0 @@
-
-import Procedure from '../../../src/core/Procedure';
-import * as AccessLevel from '../../../src/core/definitions/AccessLevel';
-import Implementation from '../../../src/core/Implementation';
-import Version from '../../../src/core/Version';
-
-function v1_0_0(): string { return '1.0.0'; }
-function v1_0_5(): string { return '1.0.5'; }
-function v1_1_0(): string { return '1.1.0'; }
-
-const v100Implementation = new Implementation(new Version(1, 0, 0), AccessLevel.PRIVATE, [], v1_0_0);
-const v105Implementation = new Implementation(new Version(1, 0, 5), AccessLevel.PUBLIC, [], v1_0_5);
-const v110Implementation = new Implementation(new Version(1, 1, 0), AccessLevel.PUBLIC, [], v1_1_0);
-
-const rootProcedure = new Procedure('', 'myRootProcedure');
-rootProcedure.addImplementation(v100Implementation);
-rootProcedure.addImplementation(v105Implementation);
-rootProcedure.addImplementation(v110Implementation);
-
-const moduleProcedure = new Procedure('my/module', 'myModuleProcedure');
-moduleProcedure.addImplementation(v100Implementation);
-moduleProcedure.addImplementation(v105Implementation);
-moduleProcedure.addImplementation(v110Implementation);
-
-const privateProcedure = new Procedure('my/module', 'myPrivateProcedure');
-privateProcedure.addImplementation(v100Implementation);
-
-export
-{
-    rootProcedure,
-    moduleProcedure,
-    privateProcedure
-}

package/test/_fixtures/core/Segment.fixture.ts

@@ -1,36 +0,0 @@
-
-import Procedure from '../../../src/core/Procedure';
-import * as AccessLevel from '../../../src/core/definitions/AccessLevel';
-import Implementation from '../../../src/core/Implementation';
-import Version from '../../../src/core/Version';
-import Segment from '../../../src/core/Segment';
-
-function getPrivate(): string { return 'private'; }
-function getPublic(): string { return 'public'; }
-function getModule(): string { return 'my/module'; }
-function throwError(): void { throw new Error('broken'); }
-
-const privateImplementation = new Implementation(Version.DEFAULT, AccessLevel.PRIVATE, [], getPrivate);
-const publicImplementation = new Implementation(Version.DEFAULT, AccessLevel.PUBLIC, [], getPublic);
-const moduleImplementation = new Implementation(Version.DEFAULT, AccessLevel.PRIVATE, [], getModule);
-const errorImplementation = new Implementation(Version.DEFAULT, AccessLevel.PRIVATE, [], throwError);
-
-const privateProcedure = new Procedure('', 'getPrivate');
-privateProcedure.addImplementation(privateImplementation);
-
-const publicProcedure = new Procedure('', 'getPublic');
-publicProcedure.addImplementation(publicImplementation);
-
-const moduleProcedure = new Procedure('my/module', 'getModule');
-moduleProcedure.addImplementation(moduleImplementation);
-
-const errorProcedure = new Procedure('', 'throwError');
-errorProcedure.addImplementation(errorImplementation);
-
-const segment = new Segment('my-segment');
-segment.addProcedure(privateProcedure);
-segment.addProcedure(publicProcedure);
-segment.addProcedure(moduleProcedure);
-segment.addProcedure(errorProcedure);
-
-export { segment }

package/test/_fixtures/core/SegmentBuilder.fixture.ts

@@ -1,45 +0,0 @@
-
-import SegmentModule from '../../../src/core/types/SegmentModule';
-
-function defaultFunction(): string
-{
-    return 'default';
-}
-
-function anotherFunction(a: string, b: string): string
-{
-    return a + b;
-}
-
-const segmentModule: SegmentModule =
-{
-    procedures:
-        [
-            {
-                module: '',
-                name: 'defaultFunction',
-                implementations:
-                    [
-                        {
-                            access: 'public',
-                            version: '0.0.0',
-                            executable: defaultFunction
-                        }
-                    ]
-            },
-            {
-                module: '',
-                name: 'anotherFunction',
-                implementations:
-                    [
-                        {
-                            access: 'public',
-                            version: '1.0.0',
-                            executable: anotherFunction
-                        }
-                    ]
-            }
-        ]
-}
-
-export { segmentModule }

package/test/_fixtures/core/Version.fixture.ts

@@ -1,18 +0,0 @@
-
-import Version from '../../../src/core/Version';
-
-const actualVersion = new Version(1, 2, 3);
-const equalVersion = new Version(1, 2, 3);
-const greaterVersion = new Version(10, 2, 3);
-const lesserVersion = new Version(1, 1, 3);
-const majorVersion = new Version(1, 0, 0);
-const majorMinorVersion = new Version(1, 2, 0);
-
-export {
-    actualVersion,
-    equalVersion,
-    greaterVersion,
-    lesserVersion,
-    majorVersion,
-    majorMinorVersion,
-}

package/test/_fixtures/core/reflection/ReflectionHelper.fixture.ts

@@ -1,56 +0,0 @@
-
-class Human {}
-
-class Person extends Human
-{
-    id: number;
-    #firstName: string; // No getter and setter
-    #lastName: string; // No getter and setter
-    #age: number; // No setter
-    #state: string; // No getter
-
-    constructor(id: number, firstName: string, lastName: string, age: number)
-    {
-        super();
-
-        this.id = id;
-        this.#firstName = firstName;
-        this.#lastName = lastName;
-        this.#age = age;
-        this.#state = 'Ottawa';
-    }
-
-    get fullName() { return `${this.#firstName} ${this.#lastName}`; }
-
-    get age() { return this.#age; }
-
-    set state(state: string) { this.#state = state; }
-
-    toString(): string
-    {
-        return `${this.fullName} is ${this.#age} years old and lives in ${this.#state}`;
-    }
-}
-
-class User extends Person {}
-
-const johnDoe = new Person(1, 'John', 'Doe', 42);
-
-function requiredArgedFunction(a: string, b: Person, c: number): string
-{
-    return a + b + c;
-}
-
-function optionalArgedFunction(a: string, b = new Person(1, 'Jane', 'Doe', 42), c = 0): string
-{
-    return a + b + c;
-}
-
-export
-{
-    Person,
-    User,
-    johnDoe,
-    requiredArgedFunction,
-    optionalArgedFunction
-};

package/test/_fixtures/runtime/LocalGateway.fixture.ts

@@ -1,24 +0,0 @@
-
-import LocalNode from '../../../src/runtime/LocalNode';
-import LocalGateway from '../../../src/runtime/LocalGateway';
-
-import { setRuntime } from '../../../src/hooks';
-
-import { firstSegment, secondSegment } from './segments';
-
-const API_URL = 'http://localhost:80';
-
-const gateway = new LocalGateway(API_URL);
-
-const firstNode = new LocalNode();
-firstNode.addSegment(firstSegment);
-firstNode.setGateway(gateway);
-
-const secondNode = new LocalNode();
-secondNode.addSegment(secondSegment);
-secondNode.setGateway(gateway);
-
-// All test cases have to start from this node
-setRuntime(firstNode);
-
-export { API_URL, gateway }

package/test/_fixtures/runtime/LocalNode.fixture.ts

@@ -1,16 +0,0 @@
-
-import LocalNode from '../../../src/runtime/LocalNode';
-
-import { setRuntime } from '../../../src/hooks';
-
-import { firstSegment, secondSegment } from './segments';
-
-const API_URL = 'http://localhost:80';
-
-const node = new LocalNode(API_URL);
-node.addSegment(firstSegment);
-node.addSegment(secondSegment);
-
-setRuntime(node);
-
-export { API_URL, node }