@quadnix/octo 0.0.2 → 0.0.3

package/src/index.ts

@@ -1,62 +0,0 @@
-export { Anchor } from './decorators/anchor.decorator.js';
-export { Action } from './decorators/action.decorator.js';
-export { Container } from './decorators/container.js';
-export { Factory } from './decorators/factory.decorator.js';
-export { Model } from './decorators/model.decorator.js';
-export { Module } from './decorators/module.decorator.js';
-export { Overlay } from './decorators/overlay.decorator.js';
-export { Resource } from './decorators/resource.decorator.js';
-export { TestContainer } from './decorators/test-container.js';
-
-export { Diff, DiffAction } from './functions/diff/diff.model.js';
-export { DiffUtility } from './functions/diff/diff.utility.js';
-export { DiffMetadata } from './functions/diff/diff-metadata.model.js';
-export { AModule } from './functions/module/module.abstract.js';
-export { IModule } from './functions/module/module.interface.js';
-
-export { App } from './models/app/app.model.js';
-export { IApp } from './models/app/app.interface.js';
-export { Deployment } from './models/deployment/deployment.model.js';
-export { IDeployment } from './models/deployment/deployment.interface.js';
-export { Environment } from './models/environment/environment.model.js';
-export { IEnvironment } from './models/environment/environment.interface.js';
-export { Execution } from './models/execution/execution.model.js';
-export { IExecution } from './models/execution/execution.interface.js';
-export { IImageDockerOptions, Image } from './models/image/image.model.js';
-export { IImage } from './models/image/image.interface.js';
-export { Pipeline } from './models/pipeline/pipeline.model.js';
-export { IPipeline } from './models/pipeline/pipeline.interface.js';
-export { Region } from './models/region/region.model.js';
-export { IRegion } from './models/region/region.interface.js';
-export { Server } from './models/server/server.model.js';
-export { IServer } from './models/server/server.interface.js';
-export { Service } from './models/service/service.model.js';
-export { IService } from './models/service/service.interface.js';
-export { Support } from './models/support/support.model.js';
-export { ISupport } from './models/support/support.interface.js';
-
-export { IAction } from './models/action.interface.js';
-export { AModel } from './models/model.abstract.js';
-export { IModel, IModelReference } from './models/model.interface.js';
-
-export { AAnchor } from './overlays/anchor.abstract.js';
-export { IAnchor } from './overlays/anchor.interface.js';
-export { AOverlay } from './overlays/overlay.abstract.js';
-export { IOverlay } from './overlays/overlay.interface.js';
-export { OverlayService } from './overlays/overlay.service.js';
-
-export { AResource } from './resources/resource.abstract.js';
-export { IResource } from './resources/resource.interface.js';
-export { IResourceAction } from './resources/resource-action.interface.js';
-export { ASharedResource } from './resources/shared-resource.abstract.js';
-
-export { ModelSerializationService } from './services/serialization/model/model-serialization.service.js';
-export { ResourceSerializationService } from './services/serialization/resource/resource-serialization.service.js';
-
-export { LocalStateProvider } from './services/state-management/local.state-provider.js';
-export { StateManagementService } from './services/state-management/state-management.service.js';
-export { IStateProvider } from './services/state-management/state-provider.interface.js';
-
-export { TransactionService } from './services/transaction/transaction.service.js';
-
-export * from './app.type.js';

package/src/models/action.interface.ts

@@ -1,35 +0,0 @@
-import { ActionInputs, ActionOutputs } from '../app.type.js';
-import { Diff } from '../functions/diff/diff.model.js';
-
-/**
- * Actions are translation functions between Diff and underlying infrastructure.
- * An action can translate a specific type of Diff into underlying infrastructure, and can revert it back.
- */
-export interface IAction<I extends ActionInputs, O extends ActionOutputs> {
-  /**
-   * The name of the action.
-   * It can be used to easily identify an action and its purpose.
-   */
-  readonly ACTION_NAME: string;
-
-  /**
-   * This function contains the list of inputs to ask before processing the diff.
-   * A missing input key will not be populated in the inputs provided to the action.
-   */
-  collectInput(diff: Diff): (keyof I)[];
-
-  /**
-   * This function determines if the handle is applicable to the diff.
-   */
-  filter(diff: Diff): boolean;
-
-  /**
-   * This function contains the logic to apply the diff(s) to the underlying infrastructure.
-   */
-  handle(diff: Diff, actionInputs: I): Promise<O>;
-
-  /**
-   * This function contains the logic to revert the diff(s) from the underlying infrastructure.
-   */
-  revert(diff: Diff, actionInputs: I, actionOutputs: O): Promise<O>;
-}

package/src/models/app/app.interface.ts

@@ -1,5 +0,0 @@
-import { App } from './app.model.js';
-
-export interface IApp {
-  name: App['name'];
-}

package/src/models/app/app.model.ts

@@ -1,111 +0,0 @@
-import { UnknownModel } from '../../app.type.js';
-import { Model } from '../../decorators/model.decorator.js';
-import { Image } from '../image/image.model.js';
-import { AModel } from '../model.abstract.js';
-import { Pipeline } from '../pipeline/pipeline.model.js';
-import { Region } from '../region/region.model.js';
-import { Server } from '../server/server.model.js';
-import { Service } from '../service/service.model.js';
-import { Support } from '../support/support.model.js';
-import { IApp } from './app.interface.js';
-
-@Model()
-export class App extends AModel<IApp, App> {
-  readonly MODEL_NAME: string = 'app';
-
-  readonly name: string;
-
-  constructor(name: string) {
-    super();
-    this.name = name;
-  }
-
-  addImage(image: Image): void {
-    const childrenDependencies = this.getChildren('image');
-    if (!childrenDependencies['image']) childrenDependencies['image'] = [];
-
-    // Check for duplicates.
-    const images = childrenDependencies['image'].map((d) => d.to);
-    if (images.find((i: Image) => i.imageId === image.imageId)) {
-      throw new Error('Image already exists!');
-    }
-    this.addChild('name', image, 'imageId');
-  }
-
-  addPipeline(pipeline: Pipeline): void {
-    const childrenDependencies = this.getChildren('pipeline');
-    if (!childrenDependencies['pipeline']) childrenDependencies['pipeline'] = [];
-
-    // Check for duplicates.
-    const pipelines = childrenDependencies['pipeline'].map((d) => d.to);
-    if (pipelines.find((p: Pipeline) => p.pipelineName === pipeline.pipelineName)) {
-      throw new Error('Pipeline already exists!');
-    }
-    this.addChild('name', pipeline, 'pipelineName');
-  }
-
-  addRegion(region: Region): void {
-    const childrenDependencies = this.getChildren('region');
-    if (!childrenDependencies['region']) childrenDependencies['region'] = [];
-
-    // Check for duplicates.
-    const regions = childrenDependencies['region'].map((d) => d.to);
-    if (regions.find((r: Region) => r.regionId === region.regionId)) {
-      throw new Error('Region already exists!');
-    }
-    this.addChild('name', region, 'regionId');
-  }
-
-  addServer(server: Server): void {
-    const childrenDependencies = this.getChildren('server');
-    if (!childrenDependencies['server']) childrenDependencies['server'] = [];
-
-    // Check for duplicates.
-    const servers = childrenDependencies['server'].map((d) => d.to);
-    if (servers.find((s: Server) => s.serverKey === server.serverKey)) {
-      throw new Error('Server already exists!');
-    }
-    this.addChild('name', server, 'serverKey');
-  }
-
-  addService(service: Service): void {
-    const childrenDependencies = this.getChildren('service');
-    if (!childrenDependencies['service']) childrenDependencies['service'] = [];
-
-    // Check for duplicates.
-    const services = childrenDependencies['service'].map((d) => d.to);
-    if (services.find((s: Service) => s.serviceId === service.serviceId)) {
-      throw new Error('Service already exists!');
-    }
-    this.addChild('name', service, 'serviceId');
-  }
-
-  addSupport(support: Support): void {
-    const childrenDependencies = this.getChildren('support');
-    if (!childrenDependencies['support']) childrenDependencies['support'] = [];
-
-    // Check for duplicates.
-    const supports = childrenDependencies['support'].map((d) => d.to);
-    if (supports.find((s: Support) => s.serverKey === support.serverKey)) {
-      throw new Error('Support already exists!');
-    }
-    this.addChild('name', support, 'serverKey');
-  }
-
-  getContext(): string {
-    return `${this.MODEL_NAME}=${this.name}`;
-  }
-
-  synth(): IApp {
-    return {
-      name: this.name,
-    };
-  }
-
-  static override async unSynth(
-    app: IApp,
-    deReferenceContext: (context: string) => Promise<UnknownModel>,
-  ): Promise<App> {
-    return new App(app.name);
-  }
-}

package/src/models/deployment/deployment.interface.ts

@@ -1,5 +0,0 @@
-import { Deployment } from './deployment.model.js';
-
-export interface IDeployment {
-  deploymentTag: Deployment['deploymentTag'];
-}

package/src/models/deployment/deployment.model.ts

@@ -1,35 +0,0 @@
-import { UnknownModel } from '../../app.type.js';
-import { Model } from '../../decorators/model.decorator.js';
-import { AModel } from '../model.abstract.js';
-import { IDeployment } from './deployment.interface.js';
-
-@Model()
-export class Deployment extends AModel<IDeployment, Deployment> {
-  readonly MODEL_NAME: string = 'deployment';
-
-  readonly deploymentTag: string;
-
-  constructor(deploymentTag: string) {
-    super();
-    this.deploymentTag = deploymentTag;
-  }
-
-  getContext(): string {
-    const parents = this.getParents();
-    const parent = (parents['server'] || parents['support'])[0].to;
-    return [`${this.MODEL_NAME}=${this.deploymentTag}`, parent.getContext()].join(',');
-  }
-
-  synth(): IDeployment {
-    return {
-      deploymentTag: this.deploymentTag,
-    };
-  }
-
-  static override async unSynth(
-    deployment: IDeployment,
-    deReferenceContext: (context: string) => Promise<UnknownModel>,
-  ): Promise<Deployment> {
-    return new Deployment(deployment.deploymentTag);
-  }
-}

package/src/models/environment/environment.interface.ts

@@ -1,6 +0,0 @@
-import { Environment } from './environment.model.js';
-
-export interface IEnvironment {
-  environmentName: Environment['environmentName'];
-  environmentVariables: { [key: string]: string };
-}

package/src/models/environment/environment.model.spec.ts

@@ -1,125 +0,0 @@
-import { Environment } from './environment.model.js';
-
-describe('Environment UT', () => {
-  describe('diff()', () => {
-    describe('when diff of environmentVariables', () => {
-      it('should capture addition', async () => {
-        const environment0 = new Environment('qa');
-
-        const environment1 = new Environment('qa');
-        environment1.environmentVariables.set('key', 'value');
-
-        const diff = await environment1.diff(environment0);
-
-        expect(diff).toMatchInlineSnapshot(`
-        [
-          {
-            "action": "add",
-            "field": "environmentVariables",
-            "value": {
-              "key": "key",
-              "value": "value",
-            },
-          },
-        ]
-      `);
-      });
-
-      it('should capture update', async () => {
-        const environment0 = new Environment('qa');
-        environment0.environmentVariables.set('key', 'value 1');
-
-        const environment1 = new Environment('qa');
-        environment1.environmentVariables.set('key', 'value 2');
-
-        const diff = await environment1.diff(environment0);
-
-        expect(diff).toMatchInlineSnapshot(`
-        [
-          {
-            "action": "update",
-            "field": "environmentVariables",
-            "value": {
-              "key": "key",
-              "value": "value 2",
-            },
-          },
-        ]
-      `);
-      });
-
-      it('should capture replace', async () => {
-        const environment0 = new Environment('qa');
-        environment0.environmentVariables.set('key1', 'value 1');
-
-        const environment1 = new Environment('qa');
-        environment1.environmentVariables.set('key2', 'value 2');
-
-        const diff = await environment1.diff(environment0);
-
-        expect(diff).toMatchInlineSnapshot(`
-        [
-          {
-            "action": "delete",
-            "field": "environmentVariables",
-            "value": {
-              "key": "key1",
-              "value": "value 1",
-            },
-          },
-          {
-            "action": "add",
-            "field": "environmentVariables",
-            "value": {
-              "key": "key2",
-              "value": "value 2",
-            },
-          },
-        ]
-      `);
-      });
-
-      it('should capture deletion', async () => {
-        const environment0 = new Environment('qa');
-        environment0.environmentVariables.set('key', 'value');
-
-        const environment1 = new Environment('qa');
-
-        const diff = await environment1.diff(environment0);
-
-        expect(diff).toMatchInlineSnapshot(`
-        [
-          {
-            "action": "delete",
-            "field": "environmentVariables",
-            "value": {
-              "key": "key",
-              "value": "value",
-            },
-          },
-        ]
-      `);
-      });
-
-      it('should capture diff without a previous instance', async () => {
-        const environment = new Environment('qa');
-        environment.environmentVariables.set('key', 'value');
-
-        const diff = await environment.diff();
-
-        expect(diff).toMatchInlineSnapshot(`
-        [
-          {
-            "action": "add",
-            "field": "environmentVariables",
-            "value": {
-              "key": "key",
-              "value": "value",
-            },
-          },
-        ]
-      `);
-      });
-    });
-  });
-});

package/src/models/environment/environment.model.ts

@@ -1,55 +0,0 @@
-import { UnknownModel } from '../../app.type.js';
-import { Model } from '../../decorators/model.decorator.js';
-import { DiffUtility } from '../../functions/diff/diff.utility.js';
-import { Diff } from '../../functions/diff/diff.model.js';
-import { AModel } from '../model.abstract.js';
-import { IEnvironment } from './environment.interface.js';
-
-@Model()
-export class Environment extends AModel<IEnvironment, Environment> {
-  readonly MODEL_NAME: string = 'environment';
-
-  readonly environmentName: string;
-
-  readonly environmentVariables: Map<string, string> = new Map();
-
-  constructor(environmentName: string) {
-    super();
-    this.environmentName = environmentName;
-  }
-
-  override async diff(previous?: Environment): Promise<Diff[]> {
-    // Generate diff of environmentVariables.
-    return DiffUtility.diffMap(
-      previous || ({ environmentVariables: new Map() } as Environment),
-      this,
-      'environmentVariables',
-    );
-  }
-
-  getContext(): string {
-    const parents = this.getParents();
-    const region = parents['region'][0].to;
-    return [`${this.MODEL_NAME}=${this.environmentName}`, region.getContext()].join(',');
-  }
-
-  synth(): IEnvironment {
-    return {
-      environmentName: this.environmentName,
-      environmentVariables: Object.fromEntries(this.environmentVariables || new Map()),
-    };
-  }
-
-  static override async unSynth(
-    environment: IEnvironment,
-    deReferenceContext: (context: string) => Promise<UnknownModel>,
-  ): Promise<Environment> {
-    const newEnvironment = new Environment(environment.environmentName);
-
-    for (const key in environment.environmentVariables) {
-      newEnvironment.environmentVariables.set(key, environment.environmentVariables[key]);
-    }
-
-    return newEnvironment;
-  }
-}

package/src/models/execution/execution.interface.ts

@@ -1,8 +0,0 @@
-import { IModelReference } from '../model.interface.js';
-
-export interface IExecution {
-  deployment: IModelReference;
-  environment: IModelReference;
-  environmentVariables: { [key: string]: string };
-  image: IModelReference;
-}

package/src/models/execution/execution.model.spec.ts

@@ -1,62 +0,0 @@
-import { Container } from '../../decorators/container.js';
-import { ModelSerializationService } from '../../services/serialization/model/model-serialization.service.js';
-import { App } from '../app/app.model.js';
-import { Deployment } from '../deployment/deployment.model.js';
-import { Environment } from '../environment/environment.model.js';
-import { Image } from '../image/image.model.js';
-import { Region } from '../region/region.model.js';
-import { Support } from '../support/support.model.js';
-import { Execution } from './execution.model.js';
-
-describe('Execution UT', () => {
-  let modelSerializationService: ModelSerializationService;
-
-  beforeAll(async () => {
-    modelSerializationService = await Container.get(ModelSerializationService);
-  });
-
-  describe('diff()', () => {
-    describe('when diff of object with children', () => {
-      it('should capture delete of children', async () => {
-        const app0_0 = new App('test');
-        const image0_0 = new Image('test', 'imageTag', {
-          dockerfilePath: 'path/to/Dockerfile',
-        });
-        app0_0.addImage(image0_0);
-        const region0_0 = new Region('region');
-        app0_0.addRegion(region0_0);
-        const environment0_0 = new Environment('qa');
-        region0_0.addEnvironment(environment0_0);
-        const support0_0 = new Support('nginx', 'nginx');
-        app0_0.addSupport(support0_0);
-        const deployment0_0 = new Deployment('nginx@0.0.1');
-        support0_0.addDeployment(deployment0_0);
-        new Execution(deployment0_0, environment0_0, image0_0);
-
-        const app0_1 = (await modelSerializationService.deserialize(
-          await modelSerializationService.serialize(app0_0),
-        )) as App;
-        const region0_1 = app0_1.getChild('region', [{ key: 'regionId', value: 'region' }]) as Region;
-        const environment0_1 = region0_1.getChild('environment', [
-          { key: 'environmentName', value: 'qa' },
-        ]) as Environment;
-        const execution0_1 = environment0_1.getChild('execution', [
-          { key: 'executionId', value: 'nginx@0.0.1_qa' },
-        ]) as Execution;
-
-        execution0_1.remove(true);
-        const diff = await app0_1.diff(app0_0);
-
-        expect(diff).toMatchInlineSnapshot(`
-          [
-            {
-              "action": "delete",
-              "field": "executionId",
-              "value": "nginx@0.0.1_qa",
-            },
-          ]
-        `);
-      });
-    });
-  });
-});

package/src/models/execution/execution.model.ts

@@ -1,89 +0,0 @@
-import { UnknownModel } from '../../app.type.js';
-import { Model } from '../../decorators/model.decorator.js';
-import { DiffUtility } from '../../functions/diff/diff.utility.js';
-import { Diff } from '../../functions/diff/diff.model.js';
-import { Deployment } from '../deployment/deployment.model.js';
-import { Environment } from '../environment/environment.model.js';
-import { Image } from '../image/image.model.js';
-import { AModel } from '../model.abstract.js';
-import { IExecution } from './execution.interface.js';
-
-@Model()
-export class Execution extends AModel<IExecution, Execution> {
-  readonly MODEL_NAME: string = 'execution';
-
-  readonly environmentVariables: Map<string, string> = new Map();
-
-  readonly executionId: string;
-
-  readonly image: Image;
-
-  constructor(deployment: Deployment, environment: Environment, image: Image) {
-    super();
-    this.executionId = [deployment.deploymentTag, environment.environmentName].join('_');
-
-    // Check for duplicates.
-    if (
-      deployment.getChild('execution', [{ key: 'executionId', value: this.executionId }]) ||
-      environment.getChild('execution', [{ key: 'executionId', value: this.executionId }])
-    ) {
-      throw new Error('Execution already exists!');
-    }
-
-    // In order for this execution to properly have defined its parent-child relationship, both execution and deployment
-    // must claim it as their child. Doing it here, prevents the confusion.
-    deployment.addChild('deploymentTag', this, 'executionId');
-    environment.addChild('environmentName', this, 'executionId');
-
-    this.image = image;
-    this.addRelationship('executionId', image, 'imageId');
-  }
-
-  override async diff(previous?: Execution): Promise<Diff[]> {
-    // deployment, environment, and executionId intentionally not included in diff,
-    // since they all contribute to executionId (primary key) which can never change.
-
-    // Generate diff of environmentVariables.
-    return DiffUtility.diffMap(
-      previous || ({ environmentVariables: new Map() } as Execution),
-      this,
-      'environmentVariables',
-    );
-  }
-
-  getContext(): string {
-    const parents = this.getParents();
-    const deployment: Deployment = parents['deployment'][0]['to'] as Deployment;
-    const environment: Environment = parents['environment'][0]['to'] as Environment;
-    return [`${this.MODEL_NAME}=${this.executionId}`, deployment.getContext(), environment.getContext()].join(',');
-  }
-
-  synth(): IExecution {
-    const parents = this.getParents();
-    const deployment: Deployment = parents['deployment'][0]['to'] as Deployment;
-    const environment: Environment = parents['environment'][0]['to'] as Environment;
-
-    return {
-      deployment: { context: deployment.getContext() },
-      environment: { context: environment.getContext() },
-      environmentVariables: Object.fromEntries(this.environmentVariables || new Map()),
-      image: { context: this.image.getContext() },
-    };
-  }
-
-  static override async unSynth(
-    execution: IExecution,
-    deReferenceContext: (context: string) => Promise<UnknownModel>,
-  ): Promise<Execution> {
-    const deployment = (await deReferenceContext(execution.deployment.context)) as Deployment;
-    const environment = (await deReferenceContext(execution.environment.context)) as Environment;
-    const image = (await deReferenceContext(execution.image.context)) as Image;
-    const newExecution = new Execution(deployment, environment, image);
-
-    for (const key in execution.environmentVariables) {
-      newExecution.environmentVariables.set(key, execution.environmentVariables[key]);
-    }
-
-    return newExecution;
-  }
-}

package/src/models/image/image.interface.ts

@@ -1,8 +0,0 @@
-import { Image } from './image.model.js';
-
-export interface IImage {
-  dockerOptions: Image['dockerOptions'];
-  imageId: Image['imageId'];
-  imageName: Image['imageName'];
-  imageTag: Image['imageTag'];
-}