@enspirit/emb 0.5.2 → 0.6.0

package/README.md

@@ -14,7 +14,7 @@ $ npm install -g @enspirit/emb
 $ emb COMMAND
 running command...
 $ emb (--version)
-@enspirit/emb/0.5.2 darwin-x64 node-v22.18.0
+@enspirit/emb/0.6.0 darwin-x64 node-v22.18.0
 $ emb --help [COMMAND]
 USAGE
   $ emb COMMAND
@@ -36,10 +36,13 @@ USAGE
 * [`emb images`](#emb-images)
 * [`emb images delete`](#emb-images-delete)
 * [`emb images prune`](#emb-images-prune)
+* [`emb images push`](#emb-images-push)
 * [`emb logs COMPONENT`](#emb-logs-component)
 * [`emb ps`](#emb-ps)
 * [`emb resources`](#emb-resources)
 * [`emb resources build [COMPONENT]`](#emb-resources-build-component)
+* [`emb restart [COMPONENT]`](#emb-restart-component)
+* [`emb run TASK`](#emb-run-task)
 * [`emb shell COMPONENT`](#emb-shell-component)
 * [`emb stop`](#emb-stop)
 * [`emb tasks`](#emb-tasks)
@@ -132,7 +135,7 @@ ARGUMENTS
   COMPONENT  The component you want to see the logs of
 
 FLAGS
-  -f, --follow  Follow log output
+  -f, --[no-]follow  Follow log output
 
 DESCRIPTION
   Get components logs.
@@ -336,6 +339,31 @@ EXAMPLES
   $ emb images prune
 ```
 
+## `emb images push`
+
+Push docker images.
+
+```
+USAGE
+  $ emb images push [--json] [--flavor <value>] [--registry <value>] [--retag <value>]
+
+FLAGS
+  --flavor=<value>    Specify the flavor to use.
+  --registry=<value>  Override the registry to push to
+  --retag=<value>     Override the original tag to push to a new tag
+
+GLOBAL FLAGS
+  --json  Format output as json.
+
+DESCRIPTION
+  Push docker images.
+
+EXAMPLES
+  $ emb images push
+
+  $ emb images push --registry my.registry.io --retag newtag
+```
+
 ## `emb logs COMPONENT`
 
 Get components logs.
@@ -348,7 +376,7 @@ ARGUMENTS
   COMPONENT  The component you want to see the logs of
 
 FLAGS
-  -f, --follow  Follow log output
+  -f, --[no-]follow  Follow log output
 
 DESCRIPTION
   Get components logs.
@@ -431,6 +459,59 @@ EXAMPLES
   $ emb resources build build --flavor development
 ```
 
+## `emb restart [COMPONENT]`
+
+Restart the whole project.
+
+```
+USAGE
+  $ emb restart [COMPONENT...] [--json] [-f]
+
+ARGUMENTS
+  COMPONENT...  The component(s) to restart
+
+FLAGS
+  -f, --no-deps  Don't restart depdendent components
+
+GLOBAL FLAGS
+  --json  Format output as json.
+
+DESCRIPTION
+  Restart the whole project.
+
+EXAMPLES
+  $ emb restart
+```
+
+## `emb run TASK`
+
+Run tasks.
+
+```
+USAGE
+  $ emb run TASK... [--json] [-x container|local] [-a]
+
+ARGUMENTS
+  TASK...  List of tasks to run. You can provide either ids or names (eg: component:task or task)
+
+FLAGS
+  -a, --all-matching       Run all tasks matching (when multiple matches)
+  -x, --executor=<option>  Where to run the task. (experimental!)
+                           <options: container|local>
+
+GLOBAL FLAGS
+  --json  Format output as json.
+
+DESCRIPTION
+  Run tasks.
+
+ALIASES
+  $ emb run
+
+EXAMPLES
+  $ emb run
+```
+
 ## `emb shell COMPONENT`
 
 Get a shell on a running component.
@@ -516,6 +597,9 @@ GLOBAL FLAGS
 DESCRIPTION
   Run tasks.
 
+ALIASES
+  $ emb run
+
 EXAMPLES
   $ emb tasks run
 ```

package/dist/src/cli/abstract/BaseCommand.js

@@ -1,4 +1,4 @@
-import { getContext, setContext } from '../../index.js';
+import { DockerComposeClient, getContext, setContext } from '../../index.js';
 import { Command, Performance } from '@oclif/core';
 import Dockerode from 'dockerode';
 import { loadConfig } from '../../config/index.js';
@@ -21,9 +21,11 @@ export class BaseCommand extends Command {
             const monorepo = await withMarker('emb:monorepo', 'init', () => {
                 return new Monorepo(config, rootDir).init();
             });
+            const compose = new DockerComposeClient(monorepo);
             this.context = setContext({
                 docker: new Dockerode(),
                 monorepo,
+                compose,
             });
         }
         catch (error) {

package/dist/src/cli/commands/components/logs.js

@@ -1,6 +1,5 @@
 import { Args, Flags } from '@oclif/core';
 import { BaseCommand, getContext } from '../../index.js';
-import { ListContainersOperation } from '../../../docker/index.js';
 export default class ComponentsLogs extends BaseCommand {
     static aliases = ['logs'];
     static description = 'Get components logs.';
@@ -10,8 +9,9 @@ export default class ComponentsLogs extends BaseCommand {
         follow: Flags.boolean({
             name: 'follow',
             char: 'f',
+            allowNo: true,
             description: 'Follow log output',
-            default: false,
+            default: true,
         }),
     };
     static args = {
@@ -23,31 +23,19 @@ export default class ComponentsLogs extends BaseCommand {
     };
     async run() {
         const { flags, args } = await this.parse(ComponentsLogs);
-        const { monorepo, docker } = await getContext();
+        const { monorepo, docker, compose } = await getContext();
         const component = monorepo.component(args.component);
-        const containers = await monorepo.run(new ListContainersOperation(), {
-            filters: {
-                label: [
-                    `emb/project=${monorepo.name}`,
-                    `emb/component=${component.name}`,
-                    `emb/flavor=${monorepo.currentFlavor}`,
-                ],
-            },
+        const containerId = await compose.getContainer(component.name, {
+            mustBeRunning: false,
         });
-        if (containers.length === 0) {
-            return this.error(`No container found for component \`${component.name}\``);
-        }
-        if (containers.length > 1) {
-            return this.error(`More than one container found for component \`${component.name}\``);
-        }
-        const container = await docker.getContainer(containers[0].Id);
+        const container = await docker.getContainer(containerId);
         if (flags.follow) {
             const stream = await container.logs({
                 follow: true,
                 stderr: true,
                 stdout: true,
             });
-            stream.pipe(process.stdout);
+            docker.modem.demuxStream(stream, process.stdout, process.stderr);
         }
         else {
             const res = await container.logs({

package/dist/src/cli/commands/images/push.d.ts

@@ -0,0 +1,11 @@
+import { FlavoredCommand } from '../../index.js';
+export default class ImagesPush extends FlavoredCommand<typeof ImagesPush> {
+    static description: string;
+    static enableJsonFlag: boolean;
+    static examples: string[];
+    static flags: {
+        registry: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        retag: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+    };
+    run(): Promise<void>;
+}

package/dist/src/cli/commands/images/push.js

@@ -0,0 +1,29 @@
+import { Flags } from '@oclif/core';
+import { FlavoredCommand } from '../../index.js';
+import { PushImagesOperation } from '../../../docker/operations/images/PushImagesOperation.js';
+export default class ImagesPush extends FlavoredCommand {
+    static description = 'Push docker images.';
+    static enableJsonFlag = true;
+    static examples = [
+        '<%= config.bin %> <%= command.id %>',
+        '<%= config.bin %> <%= command.id %> --registry my.registry.io --retag newtag',
+    ];
+    static flags = {
+        registry: Flags.string({
+            name: 'registry',
+            description: 'Override the registry to push to',
+        }),
+        retag: Flags.string({
+            name: 'retag',
+            description: 'Override the original tag to push to a new tag',
+        }),
+    };
+    async run() {
+        const { flags } = await this.parse(ImagesPush);
+        const { monorepo } = this.context;
+        await monorepo.run(new PushImagesOperation(process.stdout), {
+            registry: flags.registry,
+            retag: flags.retag,
+        });
+    }
+}

package/dist/src/cli/commands/resources/index.js

@@ -1,5 +1,6 @@
 import { printTable } from '@oclif/table';
 import { FlavoredCommand, getContext, TABLE_DEFAULTS } from '../../index.js';
+import { ResourceFactory } from '../../../monorepo/resources/ResourceFactory.js';
 export default class ResourcesIndex extends FlavoredCommand {
     static description = 'List resources.';
     static enableJsonFlag = true;
@@ -9,14 +10,21 @@ export default class ResourcesIndex extends FlavoredCommand {
         const { flags } = await this.parse(ResourcesIndex);
         const { monorepo } = await getContext();
         const resources = await Promise.all(monorepo.resources.map(async (config) => {
+            const component = monorepo.component(config.component);
+            const builder = ResourceFactory.factor(config.type, {
+                config,
+                monorepo,
+                component,
+            });
             return {
                 ...config,
+                reference: await builder.getReference(),
             };
         }));
         if (!flags.json) {
             printTable({
                 ...TABLE_DEFAULTS,
-                columns: ['name', 'type', 'id'],
+                columns: ['name', 'type', 'reference', 'id'],
                 data: resources,
                 sort: {
                     name: 'asc',

package/dist/src/cli/commands/restart.d.ts

@@ -0,0 +1,14 @@
+import { BaseCommand } from '../index.js';
+export default class RestartComand extends BaseCommand {
+    static description: string;
+    static enableJsonFlag: boolean;
+    static examples: string[];
+    static flags: {
+        'no-deps': import("@oclif/core/interfaces").BooleanFlag<boolean>;
+    };
+    static args: {
+        component: import("@oclif/core/interfaces").Arg<string | undefined, Record<string, unknown>>;
+    };
+    static strict: boolean;
+    run(): Promise<void>;
+}

package/dist/src/cli/commands/restart.js

@@ -0,0 +1,38 @@
+import { Args, Flags } from '@oclif/core';
+import { BaseCommand, getContext } from '../index.js';
+import { ComposeRestartOperation } from '../../docker/index.js';
+export default class RestartComand extends BaseCommand {
+    static description = 'Restart the whole project.';
+    static enableJsonFlag = true;
+    static examples = ['<%= config.bin %> <%= command.id %>'];
+    static flags = {
+        'no-deps': Flags.boolean({
+            char: 'f',
+            default: false,
+            description: "Don't restart depdendent components",
+            name: 'no-deps',
+        }),
+    };
+    static args = {
+        component: Args.string({
+            name: 'component',
+            description: 'The component(s) to restart',
+        }),
+    };
+    static strict = false;
+    async run() {
+        const { flags, argv } = await this.parse(RestartComand);
+        const { monorepo } = getContext();
+        let components;
+        if (argv.length > 0) {
+            components =
+                argv.length > 0
+                    ? argv.map((name) => monorepo.component(name))
+                    : monorepo.components;
+        }
+        await monorepo.run(new ComposeRestartOperation(), {
+            noDeps: flags['no-deps'],
+            services: components?.map((c) => c.name),
+        });
+    }
+}

package/dist/src/cli/commands/stop.js

@@ -1,6 +1,6 @@
 import { Listr } from 'listr2';
 import { FlavoredCommand, getContext } from '../index.js';
-import { ComposeDownOperation } from '../../docker/index.js';
+import { ComposeStopOperation } from '../../docker/index.js';
 export default class StopCommand extends FlavoredCommand {
     static description = 'Stop the whole project.';
     static enableJsonFlag = true;
@@ -12,7 +12,7 @@ export default class StopCommand extends FlavoredCommand {
             {
                 rendererOptions: { persistentOutput: true },
                 async task(ctx, task) {
-                    return monorepo.run(new ComposeDownOperation(task.stdout()), {});
+                    return monorepo.run(new ComposeStopOperation(task.stdout()), {});
                 },
                 title: 'Stopping project',
             },

package/dist/src/cli/commands/tasks/index.js

@@ -20,7 +20,7 @@ export default class TasksIndex extends BaseCommand {
                 return 1;
             }
             // Compare components (if both not null)
-            if (Boolean(ac) && Boolean(bc)) {
+            if (ac && bc && Boolean(ac) && Boolean(bc)) {
                 const cmp = ac.localeCompare(bc);
                 if (cmp !== 0) {
                     return cmp;

package/dist/src/cli/commands/tasks/run.d.ts

@@ -1,5 +1,6 @@
 import { BaseCommand } from '../../index.js';
 export default class RunTask extends BaseCommand {
+    static aliases: string[];
     static args: {
         task: import("@oclif/core/interfaces").Arg<string, Record<string, unknown>>;
     };

package/dist/src/cli/commands/tasks/run.js

@@ -3,6 +3,7 @@ import { Args, Flags } from '@oclif/core';
 import { BaseCommand } from '../../index.js';
 import { ExecutorType, RunTasksOperation } from '../../../monorepo/index.js';
 export default class RunTask extends BaseCommand {
+    static aliases = ['run'];
     static args = {
         task: Args.string({
             description: 'List of tasks to run. You can provide either ids or names (eg: component:task or task)',

package/dist/src/config/schema.d.ts

@@ -12,6 +12,12 @@ export type TaskConfig = TaskConfig1 & {
         [k: string]: unknown;
     };
     pre?: Identifier[];
+    /**
+     * Variables to pass onto the task
+     */
+    vars?: {
+        [k: string]: string;
+    };
 };
 export type TaskConfig1 = {
     [k: string]: unknown;

package/dist/src/config/schema.json

@@ -136,6 +136,13 @@
                     "items": {
                         "$ref": "#/definitions/Identifier"
                     }
+                },
+                "vars": {
+                    "type": "object",
+                    "description": "Variables to pass onto the task",
+                    "additionalProperties": {
+                        "type": "string"
+                    }
                 }
             },
             "additionalProperties": false

package/dist/src/docker/compose/client.d.ts

@@ -0,0 +1,24 @@
+import { Monorepo } from '../../index.js';
+export type ComposeContainer = {
+    Name: string;
+    ID: string;
+    State: 'exited' | 'running';
+};
+export type ComposeService = {
+    name: string;
+    containers: Array<ComposeContainer>;
+};
+export type ComposeServices = Map<string, ComposeService>;
+export type GetContainerOptions = {
+    mustBeRunning: boolean;
+    mustBeUnique: boolean;
+};
+export declare const DefaultGetContainerOptions: GetContainerOptions;
+export declare class DockerComposeClient {
+    protected monorepo: Monorepo;
+    protected containers?: ComposeServices;
+    constructor(monorepo: Monorepo);
+    init(): Promise<void>;
+    getContainer(serviceName: string, options?: Partial<GetContainerOptions>): Promise<string>;
+    private loadContainers;
+}

package/dist/src/docker/compose/client.js

@@ -0,0 +1,55 @@
+import { execa } from 'execa';
+export const DefaultGetContainerOptions = {
+    mustBeRunning: true,
+    mustBeUnique: true,
+};
+export class DockerComposeClient {
+    monorepo;
+    containers;
+    constructor(monorepo) {
+        this.monorepo = monorepo;
+    }
+    async init() {
+        await this.loadContainers();
+    }
+    async getContainer(serviceName, options = DefaultGetContainerOptions) {
+        const getOptions = { ...DefaultGetContainerOptions, ...options };
+        await this.loadContainers();
+        const service = this.containers?.get(serviceName);
+        if (!service) {
+            throw new Error(`No compose service found with name ${serviceName}`);
+        }
+        const containers = getOptions.mustBeRunning
+            ? service.containers.filter((c) => c.State === 'running')
+            : service.containers;
+        if (containers.length === 0) {
+            throw new Error(`No container found for service ${serviceName}`);
+        }
+        if (containers.length > 1 && getOptions.mustBeUnique) {
+            throw new Error(`Multiple containers found`);
+        }
+        return containers[0].ID;
+    }
+    async loadContainers(force = false) {
+        if (this.containers && !force) {
+            return;
+        }
+        const { stdout } = await execa({
+            cwd: this.monorepo.rootDir,
+        }) `docker compose ps -a --format json`;
+        this.containers = stdout
+            .split('\n')
+            .map((l) => JSON.parse(l))
+            .reduce((services, entry) => {
+            if (!services.has(entry.Service)) {
+                services.set(entry.Service, {
+                    name: entry.Service,
+                    containers: [],
+                });
+            }
+            const svc = services.get(entry.Service);
+            svc?.containers.push(entry);
+            return services;
+        }, new Map());
+    }
+}

package/dist/src/docker/compose/index.d.ts

@@ -1 +1,2 @@
+export * from './client.js';
 export * from './operations/index.js';

package/dist/src/docker/compose/index.js

@@ -1 +1,2 @@
+export * from './client.js';
 export * from './operations/index.js';

package/dist/src/docker/compose/operations/ComposeExecOperation.d.ts

@@ -3,6 +3,7 @@ import * as z from 'zod';
 import { AbstractOperation } from '../../../operations/index.js';
 declare const schema: z.ZodObject<{
     command: z.ZodString;
+    env: z.ZodOptional<z.ZodObject<{}, z.core.$catchall<z.ZodString>>>;
     service: z.ZodString;
 }, z.core.$strip>;
 export declare class ComposeExecOperation extends AbstractOperation<typeof schema, void> {

package/dist/src/docker/compose/operations/ComposeExecOperation.js

@@ -4,6 +4,11 @@ import { ComposeExecError } from '../../../errors.js';
 import { AbstractOperation } from '../../../operations/index.js';
 const schema = z.object({
     command: z.string().describe('The command to execute on the service'),
+    env: z
+        .object()
+        .catchall(z.string())
+        .describe('Environment variables to pass to the execution')
+        .optional(),
     service: z
         .string()
         .describe('The name of the compose service to exec a shell'),
@@ -17,7 +22,13 @@ export class ComposeExecOperation extends AbstractOperation {
     async _run(input) {
         const { monorepo } = this.context;
         const cmd = 'docker';
-        const args = ['compose', 'exec', input.service, input.command];
+        const args = ['compose', 'exec'];
+        // Add any env vars
+        Object.entries(input.env || {}).forEach(([key, value]) => {
+            args.push('-e', `${key.trim()}=${value.trim()}`);
+        });
+        // add component and script
+        args.push(input.service, input.command);
         const child = spawn(cmd, args, {
             stdio: 'pipe',
             shell: true,

package/dist/src/docker/compose/operations/ComposeRestartOperation.d.ts

@@ -0,0 +1,14 @@
+import * as z from 'zod';
+import { AbstractOperation } from '../../../operations/index.js';
+/**
+ * https://docs.docker.com/reference/cli/docker/compose/restart/
+ */
+declare const schema: z.ZodOptional<z.ZodObject<{
+    services: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    noDeps: z.ZodOptional<z.ZodBoolean>;
+}, z.core.$strip>>;
+export declare class ComposeRestartOperation extends AbstractOperation<typeof schema, void> {
+    constructor();
+    protected _run(input: z.input<typeof schema>): Promise<void>;
+}
+export {};

package/dist/src/docker/compose/operations/ComposeRestartOperation.js

@@ -0,0 +1,46 @@
+import { getContext } from '../../../index.js';
+import * as z from 'zod';
+import { ExecuteLocalCommandOperation, taskManagerFactory } from '../../../monorepo/index.js';
+import { AbstractOperation } from '../../../operations/index.js';
+/**
+ * https://docs.docker.com/reference/cli/docker/compose/restart/
+ */
+const schema = z
+    .object({
+    services: z
+        .array(z.string())
+        .optional()
+        .describe('The list of service to restart'),
+    noDeps: z.boolean().optional().describe("Don't restart dependent services"),
+})
+    .optional();
+export class ComposeRestartOperation extends AbstractOperation {
+    constructor() {
+        super(schema);
+    }
+    async _run(input) {
+        const { monorepo } = getContext();
+        const manager = taskManagerFactory();
+        const command = ['docker', 'compose', 'restart'];
+        if (input?.services) {
+            command.push(...input.services);
+        }
+        if (input?.noDeps) {
+            command.push('--no-deps');
+        }
+        manager.add([
+            {
+                async task(ctx, task) {
+                    return monorepo.run(new ExecuteLocalCommandOperation(task.stdout()), {
+                        script: command.join(' '),
+                        workingDir: monorepo.rootDir,
+                    });
+                },
+                title: input?.services
+                    ? `Restarting ${input.services.join(', ')}`
+                    : 'Restarting project',
+            },
+        ]);
+        await manager.runAll();
+    }
+}

package/dist/src/docker/compose/operations/index.d.ts

@@ -1,5 +1,6 @@
 export * from './ComposeDownOperation.js';
 export * from './ComposeExecOperation.js';
 export * from './ComposeExecShellOperation.js';
+export * from './ComposeRestartOperation.js';
 export * from './ComposeStopOperation.js';
 export * from './ComposeUpOperation.js';

package/dist/src/docker/compose/operations/index.js

@@ -1,5 +1,6 @@
 export * from './ComposeDownOperation.js';
 export * from './ComposeExecOperation.js';
 export * from './ComposeExecShellOperation.js';
+export * from './ComposeRestartOperation.js';
 export * from './ComposeStopOperation.js';
 export * from './ComposeUpOperation.js';

package/dist/src/docker/index.d.ts

@@ -1,6 +1,5 @@
 import './resources/index.js';
 export * from './compose/index.js';
-export * from './containers/index.js';
 export * from './images/index.js';
 export * from './operations/index.js';
 export * from './protobuf/index.js';

package/dist/src/docker/index.js

@@ -1,6 +1,5 @@
 import './resources/index.js';
 export * from './compose/index.js';
-export * from './containers/index.js';
 export * from './images/index.js';
 export * from './operations/index.js';
 export * from './protobuf/index.js';

package/dist/src/docker/operations/containers/ContainerExecOperation.d.ts

@@ -5,9 +5,6 @@ import { AbstractOperation } from '../../../operations/index.js';
  * https://docs.docker.com/reference/api/engine/version/v1.37/#tag/Exec/operation/ContainerExec
  */
 declare const schema: z.ZodObject<{
-    attachStderr: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
-    attachStdin: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
-    attachStdout: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
     container: z.ZodString;
     env: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
     script: z.ZodString;