@travetto/pack 3.2.4 → 3.2.6

package/README.md

@@ -134,6 +134,7 @@ Options:
   -dp, --docker-port <number>          Docker Image Port  (default: [])
   -dx, --docker-push                   Docker Push Tags  (default: false)
   -dr, --docker-registry <string>      Docker Registry
+  -du, --docker-runtime-user <string>  Docker Runtime user
   -m, --module <string>                Module to run for
   -h, --help                           display help for command
 ```
@@ -231,6 +232,9 @@ cd $ROOT
 echo "Generating Docker File $DIST/Dockerfile @travetto/pack/support/pack.dockerfile"
 
 echo "FROM node:20-alpine" > $DIST/Dockerfile
+echo "" >> $DIST/Dockerfile
+echo "RUN addgroup -g 2000 app && adduser -S -u 2000 app app" >> $DIST/Dockerfile
+echo "USER app" >> $DIST/Dockerfile
 echo "WORKDIR /app" >> $DIST/Dockerfile
 echo "COPY . ." >> $DIST/Dockerfile
 echo "" >> $DIST/Dockerfile

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@travetto/pack",
-  "version": "3.2.4",
+  "version": "3.2.6",
   "description": "Code packing utilities",
   "keywords": [
     "travetto",

package/support/bin/docker-operation.ts

@@ -1,12 +1,12 @@
 import fs from 'fs/promises';
 
 import { path, RootIndex } from '@travetto/manifest';
-import { ExecUtil } from '@travetto/base';
 import { cliTpl } from '@travetto/cli';
 
 import { ActiveShellCommand } from './shell';
 import { DockerPackConfig, DockerPackFactoryModule } from './types';
 import { PackOperation } from './operation';
+import { PackUtil } from './util';
 
 export class DockerPackOperation {
 
@@ -47,7 +47,7 @@ export class DockerPackOperation {
     if (cfg.ejectFile) {
       yield command;
     } else {
-      await ExecUtil.spawn(command[0], command.slice(1), {}).result;
+      await PackUtil.runCommand(command);
     }
   }
 
@@ -64,7 +64,7 @@ export class DockerPackOperation {
       yield cmd;
       yield ActiveShellCommand.chdir(path.cwd());
     } else {
-      await ExecUtil.spawn(cmd[0], cmd.slice(1), { cwd: cfg.workspace, stdio: [0, 'pipe', 2] }).result;
+      await PackUtil.runCommand(cmd, { cwd: cfg.workspace, stdio: [0, 'pipe', 2] });
     }
   }
 
@@ -86,7 +86,7 @@ export class DockerPackOperation {
       }
     } else {
       for (const tag of tags) {
-        await ExecUtil.spawn(cmd[0], [...cmd.slice(1), tag], { stdio: [0, 'pipe', 2] }).result;
+        await PackUtil.runCommand([...cmd, tag]);
       }
     }
   }

package/support/bin/operation.ts

@@ -1,7 +1,6 @@
 import fs from 'fs/promises';
 
 import { path, RootIndex } from '@travetto/manifest';
-import { ExecUtil } from '@travetto/base';
 import { cliTpl } from '@travetto/cli';
 
 import { CommonPackConfig } from './types';
@@ -88,7 +87,7 @@ export class PackOperation {
       yield bundleCommand;
       yield ActiveShellCommand.chdir(path.cwd());
     } else {
-      await ExecUtil.spawn(bundleCommand[0], bundleCommand.slice(1), { cwd, env, stdio: ['inherit', 'pipe', 'pipe'] }).result;
+      await PackUtil.runCommand(bundleCommand, { cwd, env });
     }
   }
 
@@ -211,7 +210,7 @@ export class PackOperation {
     if (cfg.ejectFile) {
       yield [...Object.entries(env).map(([k, v]) => `${k}=${v}`), ...cmd];
     } else {
-      await ExecUtil.spawn(cmd[0], cmd.slice(1), { env, stdio: ['inherit', 'ignore', 'inherit'] }).result;
+      await PackUtil.runCommand(cmd, { env });
     }
   }
 
@@ -229,8 +228,7 @@ export class PackOperation {
       yield ActiveShellCommand.chdir(path.cwd());
     } else {
       await fs.mkdir(path.dirname(cfg.output), { recursive: true });
-      const [cmd, ...args] = ActiveShellCommand.zip(cfg.output);
-      await ExecUtil.spawn(cmd, args, { cwd: cfg.workspace }).result;
+      await PackUtil.runCommand(ActiveShellCommand.zip(cfg.output), { cwd: cfg.workspace });
     }
   }
 }

package/support/bin/types.ts

@@ -25,6 +25,12 @@ export type DockerPackConfig = {
   dockerPort?: number[];
   dockerPush?: boolean;
   dockerRegistry?: string;
+  dockerRuntimeUser: {
+    user: string;
+    uid: number;
+    group: string;
+    gid: number;
+  };
 } & CommonPackConfig;
 
 

package/support/bin/util.ts

@@ -1,9 +1,10 @@
 import fs from 'fs/promises';
 
 import { path, RootIndex } from '@travetto/manifest';
-import { ExecUtil } from '@travetto/base';
+import { AppError, ExecUtil, ExecutionOptions } from '@travetto/base';
 
 import { ActiveShellCommand } from './shell';
+import { DockerPackConfig } from './types';
 
 export class PackUtil {
   /**
@@ -62,4 +63,37 @@ export class PackUtil {
 
     await stream?.close();
   }
+
+  /**
+   * Track result response
+   */
+  static async runCommand(cmd: string[], opts: ExecutionOptions = {}): Promise<void> {
+    const { valid, code, stderr, message } = await ExecUtil.spawn(cmd[0], cmd.slice(1), {
+      stdio: [0, 'pipe', 'pipe', 'ipc'],
+      ...opts,
+      catchAsResult: true
+    }).result;
+    if (!valid) {
+      process.exitCode = code;
+      throw new AppError(stderr || message || 'An unexpected error has occurred');
+    }
+  }
+
+  /**
+   * Generate a docker user creation command
+   */
+  static generateDockerUserCommand(cfg: DockerPackConfig): string {
+    const { user, group, uid, gid } = cfg.dockerRuntimeUser;
+    if (user !== 'root') {
+      return [
+        '',
+        `RUN which addgroup && \
+( addgroup -g ${gid} ${group} && adduser -S -u ${uid} ${user} ${group} ) || \
+( groupadd -g ${gid} ${group} && useradd -r -u ${uid} -g ${group} ${user} )`,
+        `USER ${user}`
+      ].join('\n');
+    } else {
+      return '';
+    }
+  }
 }

package/support/cli.pack_docker.ts

@@ -4,8 +4,11 @@ import { CliCommand, CliFlag, CliUtil, CliValidationError } from '@travetto/cli'
 import { DockerPackOperation } from './bin/docker-operation';
 import { BasePackCommand, PackOperationShape } from './pack.base';
 import { GlobalEnv } from '@travetto/base';
+import { Ignore } from '@travetto/schema';
 
 const NODE_MAJOR = GlobalEnv.nodeVersion.replace('v', '').split('.')[0];
+const DEFAULT_USER_ID = 2000;
+const DEFAULT_USER = 'app';
 
 /**
  * Standard docker support for pack
@@ -26,6 +29,16 @@ export class PackDockerCommand extends BasePackCommand {
   dockerPush = false;
   @CliFlag({ desc: 'Docker Registry ', short: 'dr', envVars: ['PACK_DOCKER_REGISTRY'] })
   dockerRegistry?: string;
+  @CliFlag({ desc: 'Docker Runtime user ', short: 'du', name: 'docker-runtime-user', envVars: ['PACK_DOCKER_RUNTIME_USER'] })
+  dockerRuntimeUserSrc?: string;
+
+  @Ignore()
+  dockerRuntimeUser: {
+    user: string;
+    uid: number;
+    group: string;
+    gid: number;
+  };
 
   async validate(...unknownArgs: string[]): Promise<CliValidationError[] | undefined> {
     const errs: CliValidationError[] = [];
@@ -47,6 +60,17 @@ export class PackDockerCommand extends BasePackCommand {
       this.dockerFactory = RootIndex.getFromSource(path.resolve(this.dockerFactory))?.import ?? this.dockerFactory;
     }
     this.dockerName = this.dockerName.replace('<module>', CliUtil.getSimpleModuleName(this.module ?? ''));
+
+    // Finalize user/group and ids
+    const [userOrUid, groupOrGid = userOrUid] = (this.dockerRuntimeUserSrc ?? '').split(':');
+    const groupIsNum = /^\d+$/.test(groupOrGid);
+    const userIsNum = /^\d+$/.test(userOrUid);
+
+    const uid = userIsNum ? +userOrUid : DEFAULT_USER_ID;
+    const gid = groupIsNum ? +groupOrGid : DEFAULT_USER_ID;
+    const group = (!groupIsNum ? groupOrGid : undefined) || DEFAULT_USER;
+    const user = (!userIsNum ? userOrUid : undefined) || DEFAULT_USER;
+    this.dockerRuntimeUser = { user, uid, group, gid };
   }
 
   getOperations(): PackOperationShape<this>[] {

package/support/pack.dockerfile.ts

@@ -1,7 +1,9 @@
 import { DockerPackFactory } from './bin/types';
+import { PackUtil } from './bin/util';
 
 export const factory: DockerPackFactory = cfg => `
 FROM ${cfg.dockerImage}
+${PackUtil.generateDockerUserCommand(cfg)}
 WORKDIR /app
 COPY . .
 ${cfg.dockerPort?.map(port => `EXPOSE ${port}`).join('\n') ?? ''}