@enspirit/emb 0.4.0 → 0.4.2

package/dist/src/monorepo/resources/abstract/AbstractResourceBuilder.d.ts

@@ -0,0 +1,23 @@
+import { ResourceInfo } from '../../../index.js';
+import { Writable } from 'node:stream';
+import { IOperation } from '../../../operations/types.js';
+import { ResourceBuildContext } from '../ResourceFactory.js';
+import { IResourceBuilder } from '../types.js';
+export declare abstract class AbstractResourceBuilder<I, O, R> implements IResourceBuilder<I, O, R> {
+    protected context: ResourceBuildContext<I>;
+    constructor(context: ResourceBuildContext<I>);
+    abstract _build(resource: ResourceInfo<I>, out?: Writable): Promise<{
+        input: I;
+        operation: IOperation<I, O>;
+    }>;
+    build(resource: ResourceInfo<I>, out?: Writable): Promise<{
+        input: I;
+        operation: IOperation<I, O>;
+    }>;
+    abstract _mustBuild?(resource: ResourceInfo<I>): Promise<R | undefined> | undefined;
+    mustBuild(resource: ResourceInfo<I>): Promise<R | undefined>;
+    _publish?(resource: ResourceInfo<I>, out?: Writable): Promise<void>;
+    publish?(resource: ResourceInfo<I>, out?: Writable): Promise<void>;
+    abstract _commit(resource: ResourceInfo<I>, output: O, reason: R): Promise<void>;
+    commit(resource: ResourceInfo<I>, output: O, reason: R): Promise<void>;
+}

package/dist/src/monorepo/resources/abstract/AbstractResourceBuilder.js

@@ -0,0 +1,18 @@
+export class AbstractResourceBuilder {
+    context;
+    constructor(context) {
+        this.context = context;
+    }
+    build(resource, out) {
+        return this._build(resource, out);
+    }
+    async mustBuild(resource) {
+        return this._mustBuild?.(resource);
+    }
+    async publish(resource, out) {
+        return this._publish?.(resource, out);
+    }
+    async commit(resource, output, reason) {
+        return this._commit?.(resource, output, reason);
+    }
+}

package/dist/src/monorepo/resources/abstract/SentinelFileBasedBuilder.d.ts

@@ -0,0 +1,27 @@
+import { ResourceInfo } from '../../../index.js';
+import { Writable } from 'node:stream';
+import { IOperation } from '../../../operations/types.js';
+import { AbstractResourceBuilder } from './AbstractResourceBuilder.js';
+export type SentinelFile<T> = {
+    mtime: number;
+    data?: T;
+};
+export declare abstract class SentinelFileBasedBuilder<I, O, SentinelData extends {
+    mtime: number;
+}> extends AbstractResourceBuilder<I, O, SentinelData> {
+    private lastSentinelFile?;
+    private newSentinelData?;
+    /**
+     * Checks wether or not the sentinel file is more recent
+     * that the output of the builder's sentinel data
+     */
+    mustBuild(resource: ResourceInfo<I>): Promise<SentinelData | undefined>;
+    build(resource: ResourceInfo<I>, out?: Writable): Promise<{
+        input: I;
+        operation: IOperation<I, O>;
+    }>;
+    private get sentinelFileName();
+    private storeSentinelData;
+    private readSentinel;
+    _commit(_resource: ResourceInfo<I>, _output: O, reason: SentinelData): Promise<void>;
+}

package/dist/src/monorepo/resources/abstract/SentinelFileBasedBuilder.js

@@ -0,0 +1,46 @@
+import { AbstractResourceBuilder } from './AbstractResourceBuilder.js';
+export class SentinelFileBasedBuilder extends AbstractResourceBuilder {
+    lastSentinelFile;
+    newSentinelData;
+    /**
+     * Checks wether or not the sentinel file is more recent
+     * that the output of the builder's sentinel data
+     */
+    async mustBuild(resource) {
+        if (!this._mustBuild) {
+            return;
+        }
+        this.lastSentinelFile = await this.readSentinel();
+        this.newSentinelData = await this._mustBuild(resource);
+        if (!(this.lastSentinelFile && this.newSentinelData)) {
+            return this.newSentinelData;
+        }
+        if (this.lastSentinelFile.mtime < this.newSentinelData.mtime) {
+            return this.newSentinelData;
+        }
+    }
+    async build(resource, out) {
+        return this._build(resource, out);
+    }
+    get sentinelFileName() {
+        const { monorepo, config } = this.context;
+        return `sentinels/flavors/${monorepo.currentFlavor}/${config.component}/${config.name}.built`;
+    }
+    async storeSentinelData(data) {
+        await this.context.monorepo.store.writeFile(this.sentinelFileName, JSON.stringify(data));
+    }
+    async readSentinel() {
+        const stats = await this.context.monorepo.store.stat(this.sentinelFileName, false);
+        if (!stats) {
+            return undefined;
+        }
+        const data = await this.context.monorepo.store.readFile(this.sentinelFileName, false);
+        return {
+            data: data ? JSON.parse(data) : data,
+            mtime: stats.mtime.getTime(),
+        };
+    }
+    async _commit(_resource, _output, reason) {
+        this.storeSentinelData(reason);
+    }
+}

package/dist/src/monorepo/resources/abstract/index.d.ts

@@ -0,0 +1,2 @@
+export * from './AbstractResourceBuilder.js';
+export * from './SentinelFileBasedBuilder.js';

package/dist/src/monorepo/resources/abstract/index.js

@@ -0,0 +1,2 @@
+export * from './AbstractResourceBuilder.js';
+export * from './SentinelFileBasedBuilder.js';

package/dist/src/monorepo/resources/index.d.ts

@@ -1 +1,3 @@
-import './FileResource.js';
+import './FileResourceBuilder.js';
+export * from './abstract/index.js';
+export * from './types.js';

package/dist/src/monorepo/resources/index.js

@@ -1 +1,3 @@
-import './FileResource.js';
+import './FileResourceBuilder.js';
+export * from './abstract/index.js';
+export * from './types.js';

package/dist/src/monorepo/resources/types.d.ts

@@ -0,0 +1,36 @@
+import { ResourceInfo } from '../../index.js';
+import { Writable } from 'node:stream';
+import { IOperation } from '../../operations/types.js';
+export type IResourceBuilder<Input, Output, Reason> = {
+    /**
+     * Returns input and operation required to actually
+     * build the resources.
+     * This allows the dry-run mechanism to be implemented outside
+     * resource implementations
+     *
+     * @param resource The resource config
+     * @param out The Writable to use to write logs
+     */
+    build(resource: ResourceInfo<Input>, out?: Writable): Promise<{
+        input: Input;
+        operation: IOperation<Input, Output>;
+    }>;
+    mustBuild?: (resource: ResourceInfo<Input>) => Promise<Reason | undefined>;
+    /**
+     * Resource builders will be informed when a successful build of resource
+     * has been produced through them
+     *
+     * This allows them to store metadata to improve their caching algorithm
+     */
+    commit?: (resource: ResourceInfo<Input>, output: Output, reason: Reason) => Promise<void>;
+    /**
+     * Similar to .build(), must return input and operation required to actually
+     * publish the resources.
+     * This allows the dry-run mechanism to be implemented outside
+     * resource implementations
+     *
+     * @param resource The resource config
+     * @param out The Writable to use to write logs
+     */
+    publish?(resource: ResourceInfo<Input>, out?: Writable): Promise<void>;
+};

package/dist/src/monorepo/types.d.ts

@@ -4,7 +4,9 @@ export type ComponentIdentifiable<T> = T & {
     name: string;
     component: string;
 };
-export type ResourceInfo = ComponentIdentifiable<IResourceConfig>;
+export type ResourceInfo<T = unknown> = ComponentIdentifiable<IResourceConfig> & {
+    params?: T;
+};
 export type Resources = {
     [k: string]: ResourceInfo;
 };

package/dist/src/operations/abstract/AbstractOperation.d.ts

@@ -3,10 +3,10 @@ import * as z from 'zod';
 import { IOperation } from '../index.js';
 export type OpInput<A extends AbstractOperation<z.Schema, unknown>> = A extends AbstractOperation<infer I, unknown> ? z.infer<I> : never;
 export type OpOutput<A extends AbstractOperation<z.Schema, unknown>> = A extends AbstractOperation<z.Schema, infer O> ? O : never;
-export declare abstract class AbstractOperation<S extends z.Schema, O = unknown> implements IOperation<z.infer<S>, O> {
-    protected inputSchema: S;
+export declare abstract class AbstractOperation<I extends z.Schema, O> implements IOperation<z.infer<I>, O> {
+    protected inputSchema: I;
     protected context: EmbContext;
-    constructor(inputSchema: S);
-    protected abstract _run(input: z.infer<S>): Promise<O>;
-    run(input: unknown | z.infer<S>): Promise<O>;
+    constructor(inputSchema: I);
+    protected abstract _run(input: z.infer<I>): Promise<O>;
+    run(input: z.infer<I>): Promise<O>;
 }

package/dist/src/operations/types.d.ts

@@ -1,3 +1,3 @@
-export interface IOperation<I, O> {
+export interface IOperation<I = void, O = unknown> {
     run(input: I): Promise<O>;
 }

package/oclif.manifest.json

@@ -268,10 +268,12 @@
         "shell.js"
       ]
     },
-    "config:print": {
-      "aliases": [],
+    "containers": {
+      "aliases": [
+        "ps"
+      ],
       "args": {},
-      "description": "Print the current config.",
+      "description": "List docker containers.",
       "examples": [
         "<%= config.bin %> <%= command.id %>"
       ],
@@ -283,21 +285,22 @@
           "allowNo": false,
           "type": "boolean"
         },
-        "flavor": {
-          "description": "Specify the flavor to use.",
-          "name": "flavor",
+        "all": {
+          "char": "a",
+          "description": "Retun all containers. By default, only running containers are shown",
+          "name": "all",
           "required": false,
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "type": "option"
+          "allowNo": false,
+          "type": "boolean"
         }
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "config:print",
+      "id": "containers",
       "pluginAlias": "@enspirit/emb",
       "pluginName": "@enspirit/emb",
       "pluginType": "core",
+      "strict": true,
       "enableJsonFlag": true,
       "isESM": true,
       "relativePath": [
@@ -305,16 +308,14 @@
         "src",
         "cli",
         "commands",
-        "config",
-        "print.js"
+        "containers",
+        "index.js"
       ]
     },
-    "containers": {
-      "aliases": [
-        "ps"
-      ],
+    "containers:prune": {
+      "aliases": [],
       "args": {},
-      "description": "List docker containers.",
+      "description": "Prune containers.",
       "examples": [
         "<%= config.bin %> <%= command.id %>"
       ],
@@ -325,19 +326,11 @@
           "name": "json",
           "allowNo": false,
           "type": "boolean"
-        },
-        "all": {
-          "char": "a",
-          "description": "Retun all containers. By default, only running containers are shown",
-          "name": "all",
-          "required": false,
-          "allowNo": false,
-          "type": "boolean"
         }
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "containers",
+      "id": "containers:prune",
       "pluginAlias": "@enspirit/emb",
       "pluginName": "@enspirit/emb",
       "pluginType": "core",
@@ -350,13 +343,13 @@
         "cli",
         "commands",
         "containers",
-        "index.js"
+        "prune.js"
       ]
     },
-    "containers:prune": {
+    "config:print": {
       "aliases": [],
       "args": {},
-      "description": "Prune containers.",
+      "description": "Print the current config.",
       "examples": [
         "<%= config.bin %> <%= command.id %>"
       ],
@@ -367,15 +360,22 @@
           "name": "json",
           "allowNo": false,
           "type": "boolean"
+        },
+        "flavor": {
+          "description": "Specify the flavor to use.",
+          "name": "flavor",
+          "required": false,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
         }
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "containers:prune",
+      "id": "config:print",
       "pluginAlias": "@enspirit/emb",
       "pluginName": "@enspirit/emb",
       "pluginType": "core",
-      "strict": true,
       "enableJsonFlag": true,
       "isESM": true,
       "relativePath": [
@@ -383,8 +383,8 @@
         "src",
         "cli",
         "commands",
-        "containers",
-        "prune.js"
+        "config",
+        "print.js"
       ]
     },
     "images:delete": {
@@ -520,12 +520,18 @@
         "prune.js"
       ]
     },
-    "tasks": {
+    "resources:build": {
       "aliases": [],
-      "args": {},
-      "description": "List tasks.",
+      "args": {
+        "component": {
+          "description": "List of resources to build (defaults to all)",
+          "name": "component",
+          "required": false
+        }
+      },
+      "description": "Build the resources of the monorepo",
       "examples": [
-        "<%= config.bin %> <%= command.id %>"
+        "<%= config.bin %> <%= command.id %> build --flavor development"
       ],
       "flags": {
         "json": {
@@ -534,15 +540,38 @@
           "name": "json",
           "allowNo": false,
           "type": "boolean"
+        },
+        "flavor": {
+          "description": "Specify the flavor to use.",
+          "name": "flavor",
+          "required": false,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "dry-run": {
+          "description": "Do not build the resources but only produce build meta information",
+          "name": "dry-run",
+          "required": false,
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "force": {
+          "char": "f",
+          "description": "Bypass the cache and force the build",
+          "name": "force",
+          "required": false,
+          "allowNo": false,
+          "type": "boolean"
         }
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "tasks",
+      "id": "resources:build",
       "pluginAlias": "@enspirit/emb",
       "pluginName": "@enspirit/emb",
       "pluginType": "core",
-      "strict": true,
+      "strict": false,
       "enableJsonFlag": true,
       "isESM": true,
       "relativePath": [
@@ -550,20 +579,14 @@
         "src",
         "cli",
         "commands",
-        "tasks",
-        "index.js"
+        "resources",
+        "build.js"
       ]
     },
-    "tasks:run": {
+    "resources": {
       "aliases": [],
-      "args": {
-        "task": {
-          "description": "List of tasks to run. You can provide either ids or names (eg: component:task or task)",
-          "name": "task",
-          "required": true
-        }
-      },
-      "description": "Run tasks.",
+      "args": {},
+      "description": "List resources.",
       "examples": [
         "<%= config.bin %> <%= command.id %>"
       ],
@@ -575,33 +598,21 @@
           "allowNo": false,
           "type": "boolean"
         },
-        "executor": {
-          "char": "x",
-          "description": "Where to run the task. (experimental!)",
-          "name": "executor",
+        "flavor": {
+          "description": "Specify the flavor to use.",
+          "name": "flavor",
+          "required": false,
           "hasDynamicHelp": false,
           "multiple": false,
-          "options": [
-            "container",
-            "local"
-          ],
           "type": "option"
-        },
-        "all-matching": {
-          "char": "a",
-          "description": "Run all tasks matching (when multiple matches)",
-          "name": "all-matching",
-          "allowNo": false,
-          "type": "boolean"
         }
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "tasks:run",
+      "id": "resources",
       "pluginAlias": "@enspirit/emb",
       "pluginName": "@enspirit/emb",
       "pluginType": "core",
-      "strict": false,
       "enableJsonFlag": true,
       "isESM": true,
       "relativePath": [
@@ -609,22 +620,16 @@
         "src",
         "cli",
         "commands",
-        "tasks",
-        "run.js"
+        "resources",
+        "index.js"
       ]
     },
-    "resources:build": {
+    "tasks": {
       "aliases": [],
-      "args": {
-        "component": {
-          "description": "List of resources to build (defaults to all)",
-          "name": "component",
-          "required": false
-        }
-      },
-      "description": "Build the resources of the monorepo",
+      "args": {},
+      "description": "List tasks.",
       "examples": [
-        "<%= config.bin %> <%= command.id %> build --flavor development"
+        "<%= config.bin %> <%= command.id %>"
       ],
       "flags": {
         "json": {
@@ -633,38 +638,15 @@
           "name": "json",
           "allowNo": false,
           "type": "boolean"
-        },
-        "flavor": {
-          "description": "Specify the flavor to use.",
-          "name": "flavor",
-          "required": false,
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "type": "option"
-        },
-        "dry-run": {
-          "description": "Do not build the resources but only produce build meta information",
-          "name": "dry-run",
-          "required": false,
-          "allowNo": false,
-          "type": "boolean"
-        },
-        "force": {
-          "char": "f",
-          "description": "Bypass the cache and force the build",
-          "name": "force",
-          "required": false,
-          "allowNo": false,
-          "type": "boolean"
         }
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "resources:build",
+      "id": "tasks",
       "pluginAlias": "@enspirit/emb",
       "pluginName": "@enspirit/emb",
       "pluginType": "core",
-      "strict": false,
+      "strict": true,
       "enableJsonFlag": true,
       "isESM": true,
       "relativePath": [
@@ -672,14 +654,20 @@
         "src",
         "cli",
         "commands",
-        "resources",
-        "build.js"
+        "tasks",
+        "index.js"
       ]
     },
-    "resources": {
+    "tasks:run": {
       "aliases": [],
-      "args": {},
-      "description": "List resources.",
+      "args": {
+        "task": {
+          "description": "List of tasks to run. You can provide either ids or names (eg: component:task or task)",
+          "name": "task",
+          "required": true
+        }
+      },
+      "description": "Run tasks.",
       "examples": [
         "<%= config.bin %> <%= command.id %>"
       ],
@@ -691,21 +679,33 @@
           "allowNo": false,
           "type": "boolean"
         },
-        "flavor": {
-          "description": "Specify the flavor to use.",
-          "name": "flavor",
-          "required": false,
+        "executor": {
+          "char": "x",
+          "description": "Where to run the task. (experimental!)",
+          "name": "executor",
           "hasDynamicHelp": false,
           "multiple": false,
+          "options": [
+            "container",
+            "local"
+          ],
           "type": "option"
+        },
+        "all-matching": {
+          "char": "a",
+          "description": "Run all tasks matching (when multiple matches)",
+          "name": "all-matching",
+          "allowNo": false,
+          "type": "boolean"
         }
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "resources",
+      "id": "tasks:run",
       "pluginAlias": "@enspirit/emb",
       "pluginName": "@enspirit/emb",
       "pluginType": "core",
+      "strict": false,
       "enableJsonFlag": true,
       "isESM": true,
       "relativePath": [
@@ -713,10 +713,10 @@
         "src",
         "cli",
         "commands",
-        "resources",
-        "index.js"
+        "tasks",
+        "run.js"
       ]
     }
   },
-  "version": "0.4.0"
+  "version": "0.4.2"
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@enspirit/emb",
   "type": "module",
-  "version": "0.4.0",
+  "version": "0.4.2",
   "keywords": [
     "monorepo",
     "docker",

package/dist/src/monorepo/resources/FileResource.js

@@ -1,17 +0,0 @@
-import { CreateFileOperation } from '../index.js';
-import { ResourceFactory } from './ResourceFactory.js';
-// Bring better abstraction and register as part of the plugin initialization
-ResourceFactory.register('file', async ({ config, component }) => {
-    return {
-        async build() {
-            const fromConfig = (config.params || {});
-            const input = {
-                path: component.join(fromConfig?.path || config.name),
-            };
-            return {
-                input,
-                operation: new CreateFileOperation(),
-            };
-        },
-    };
-});