rbxts-orchestra 0.1.0 → 0.1.2

package/dist/run.js

@@ -32,7 +32,7 @@ var import_yargs = __toESM(require("yargs"));
 // package.json
 var package_default = {
   name: "rbxts-orchestra",
-  version: "0.1.0",
+  version: "0.1.2",
   description: "A build orchestrator.",
   main: "src/index.ts",
   bin: {
@@ -44,7 +44,8 @@ var package_default = {
   },
   files: [
     "dist",
-    "bin/run"
+    "bin/run",
+    "src"
   ],
   scripts: {
     build: "tsup-node && tsc",
@@ -77,9 +78,10 @@ var package_default = {
   },
   dependencies: {
     consola: "^3.2.3",
+    jiti: "^2.6.1",
     picocolors: "^1.0.1",
-    yargs: "^17.7.2",
-    jiti: "^2.6.1"
+    "rbxts-orchestra": "^0.1.0",
+    yargs: "^17.7.2"
   }
 };
 
@@ -173,6 +175,7 @@ async function handler(argv2) {
   });
   await orchestra.runScripts(argv2.script, delimitedArgv).catch((code) => {
     logger.error(`Failed to run script: exit code ${code}`);
+    process2.exit(code);
   });
 }
 

package/dist/src/commands/runScript.js

@@ -32,6 +32,7 @@ export async function handler(argv) {
     });
     await orchestra.runScripts(argv.script, delimitedArgv).catch((code) => {
         logger.error(`Failed to run script: exit code ${code}`);
+        process.exit(code);
     });
 }
 //# sourceMappingURL=runScript.js.map

package/dist/src/commands/runScript.js.map

@@ -1 +1 @@
-{"version":3,"file":"runScript.js","sourceRoot":"","sources":["../../../src/commands/runScript.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAC7C,OAAO,KAAK,OAAO,MAAM,cAAc,CAAC;AAGxC,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAC;AACnC,OAAO,EAAE,SAAS,EAAE,yBAAyB,EAAE,MAAM,cAAc,CAAC;AAOpE,MAAM,CAAC,MAAM,OAAO,GAAG,cAAc,CAAC;AACtC,MAAM,CAAC,MAAM,QAAQ,GAAG,iDAAiD,CAAC;AAE1E,MAAM,UAAU,OAAO,CAAC,KAAoB;IAC3C,OAAO,KAAK;SACV,UAAU,CAAC,QAAQ,EAAE;QACrB,IAAI,EAAE,QAAQ;QACd,WAAW,EAAE,aAAa;KAC1B,CAAC;SACD,MAAM,CAAC,QAAQ,EAAE;QACjB,IAAI,EAAE,QAAQ;QACd,KAAK,EAAE,GAAG;QACV,WAAW,EAAE,mCAAmC;QAChD,OAAO,EAAE,GAAG,yBAAyB,EAAE;KACvC,CAAC;SACD,MAAM,CAAC,QAAQ,EAAE,CAAC,KAAa,EAAE,EAAE;QACnC,IAAI,UAAU,CAAC,KAAK,CAAC,EAAE,CAAC;YACvB,OAAO,KAAK,CAAC;QACd,CAAC;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,KAAK,CAAC,CAAC;IACnC,CAAC,CAAC,CAAC;AACL,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,OAAO,CAAC,IAAiC;IAC9D,MAAM,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,IAAI,IAAI,CAAC,CAAC;IACpE,MAAM,aAAa,GAAG,cAAc,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,cAAc,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IACjG,MAAM,SAAS,GAAG,MAAM,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,CAAC,GAAG,EAAE;QACxE,MAAM,CAAC,KAAK,CAAC,iCAAiC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;QAC7D,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IACjB,CAAC,CAAC,CAAC;IAEH,MAAM,SAAS,CAAC,UAAU,CAAC,IAAI,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,EAAE;QACrE,MAAM,CAAC,KAAK,CAAC,mCAAmC,IAAI,EAAE,CAAC,CAAC;IACzD,CAAC,CAAC,CAAC;AACJ,CAAC"}
+{"version":3,"file":"runScript.js","sourceRoot":"","sources":["../../../src/commands/runScript.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAC7C,OAAO,KAAK,OAAO,MAAM,cAAc,CAAC;AAGxC,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAC;AACnC,OAAO,EAAE,SAAS,EAAE,yBAAyB,EAAE,MAAM,cAAc,CAAC;AAOpE,MAAM,CAAC,MAAM,OAAO,GAAG,cAAc,CAAC;AACtC,MAAM,CAAC,MAAM,QAAQ,GAAG,iDAAiD,CAAC;AAE1E,MAAM,UAAU,OAAO,CAAC,KAAoB;IAC3C,OAAO,KAAK;SACV,UAAU,CAAC,QAAQ,EAAE;QACrB,IAAI,EAAE,QAAQ;QACd,WAAW,EAAE,aAAa;KAC1B,CAAC;SACD,MAAM,CAAC,QAAQ,EAAE;QACjB,IAAI,EAAE,QAAQ;QACd,KAAK,EAAE,GAAG;QACV,WAAW,EAAE,mCAAmC;QAChD,OAAO,EAAE,GAAG,yBAAyB,EAAE;KACvC,CAAC;SACD,MAAM,CAAC,QAAQ,EAAE,CAAC,KAAa,EAAE,EAAE;QACnC,IAAI,UAAU,CAAC,KAAK,CAAC,EAAE,CAAC;YACvB,OAAO,KAAK,CAAC;QACd,CAAC;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,KAAK,CAAC,CAAC;IACnC,CAAC,CAAC,CAAC;AACL,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,OAAO,CAAC,IAAiC;IAC9D,MAAM,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,IAAI,IAAI,CAAC,CAAC;IACpE,MAAM,aAAa,GAAG,cAAc,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,cAAc,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IACjG,MAAM,SAAS,GAAG,MAAM,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,CAAC,GAAG,EAAE;QACxE,MAAM,CAAC,KAAK,CAAC,iCAAiC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;QAC7D,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IACjB,CAAC,CAAC,CAAC;IAEH,MAAM,SAAS,CAAC,UAAU,CAAC,IAAI,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,EAAE;QACrE,MAAM,CAAC,KAAK,CAAC,mCAAmC,IAAI,EAAE,CAAC,CAAC;QACxD,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACpB,CAAC,CAAC,CAAC;AACJ,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "rbxts-orchestra",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "A build orchestrator.",
   "main": "src/index.ts",
   "bin": {
@@ -12,7 +12,8 @@
   },
   "files": [
     "dist",
-    "bin/run"
+    "bin/run",
+    "src"
   ],
   "scripts": {
     "build": "tsup-node && tsc",
@@ -45,8 +46,9 @@
   },
   "dependencies": {
     "consola": "^3.2.3",
+    "jiti": "^2.6.1",
     "picocolors": "^1.0.1",
-    "yargs": "^17.7.2",
-    "jiti": "^2.6.1"
+    "rbxts-orchestra": "^0.1.0",
+    "yargs": "^17.7.2"
   }
 }

package/src/commands/index.ts

@@ -0,0 +1,3 @@
+import * as run from "./runScript";
+
+export const commands = [run];

package/src/commands/runScript.ts

@@ -0,0 +1,48 @@
+import { isAbsolute, join } from "node:path";
+import * as process from "node:process";
+import { ArgumentsCamelCase, Argv } from "yargs";
+
+import { logger } from "../logger";
+import { Orchestra, ORCHESTRA_CONFIG_FILENAME } from "../orchestra";
+
+interface RunArgv {
+	script: string;
+	config: string;
+}
+
+export const command = "run <script>";
+export const describe = "Runs build scripts for all orchestrated places.";
+
+export function builder(yargs: Argv<RunArgv>): Argv {
+	return yargs
+		.positional("script", {
+			type: "string",
+			description: "script name",
+		})
+		.option("config", {
+			type: "string",
+			alias: "c",
+			description: "Path to the orchestra config file",
+			default: `${ORCHESTRA_CONFIG_FILENAME}`,
+		})
+		.coerce("config", (value: string) => {
+			if (isAbsolute(value)) {
+				return value;
+			}
+			return join(process.cwd(), value);
+		});
+}
+
+export async function handler(argv: ArgumentsCamelCase<RunArgv>) {
+	const delimiterIndex = process.argv.findIndex((arg) => arg == "--");
+	const delimitedArgv = delimiterIndex !== -1 ? process.argv.slice(delimiterIndex + 1) : undefined;
+	const orchestra = await Orchestra.fromFileConfig(argv.config).catch(() => {
+		logger.error(`Failed to find config file at ${argv.config}`);
+		process.exit(1);
+	});
+
+	await orchestra.runScripts(argv.script, delimitedArgv).catch((code) => {
+		logger.error(`Failed to run script: exit code ${code}`);
+		process.exit(code);
+	});
+}

package/src/helpers/release.ts

@@ -0,0 +1,45 @@
+import { execSync } from "child_process";
+import { Environments, Value } from "src/orchestra";
+
+export function semverString<E extends Environments>(
+	/**
+	 * The base semver string (e.g `1.0.0`)
+	 */
+	baseSemver: string,
+	/**
+	 * A list of environments in which to include the short hash of the
+	 * currently checked out commit in the semver string
+	 */
+	commitHashEnvironments?: (keyof E)[],
+	/**
+	 * A list of environments in which to include the name of the
+	 * local user in the semver string
+	 */
+	userEnvironments?: (keyof E)[],
+): Value<E, string> {
+	return (orchestra) => {
+		let shortCommitHash, localUsername;
+		try {
+			localUsername = execSync("whoami", {
+				stdio: "pipe",
+			})
+				.toString()
+				.trim();
+			shortCommitHash = execSync("git rev-parse --short HEAD", {
+				stdio: "pipe",
+			})
+				.toString()
+				.trim();
+		} catch {}
+		let semver = baseSemver;
+
+		if (localUsername && userEnvironments?.includes(orchestra.environment)) {
+			semver += `-${localUsername}`;
+		}
+		if (shortCommitHash && commitHashEnvironments?.includes(orchestra.environment)) {
+			semver += `+${shortCommitHash}`;
+		}
+
+		return semver;
+	};
+}

package/src/helpers/script.ts

@@ -0,0 +1,64 @@
+import { spawn } from "child_process";
+import { resolve } from "path";
+
+import { Environments, PlaceConfig, Script, val, Value } from "../orchestra/config";
+import { Orchestra } from "../orchestra/orchestra";
+
+interface SpawnConfig {
+	/**
+	 * Whether to wait until the process exits before continuing to the next script
+	 */
+	waitForExit: boolean;
+	/**
+	 * Whether to ignore a non-zero exit code
+	 */
+	ignoreNonZeroExitCode: boolean;
+}
+
+const DEFAULT_SPAWN_CONFIG: SpawnConfig = {
+	waitForExit: true,
+	ignoreNonZeroExitCode: false,
+};
+
+function generateEnv<E extends Environments>(
+	orchestra: Orchestra<E>,
+	place?: PlaceConfig<E>,
+): Record<string, string | undefined> {
+	return {
+		...process.env,
+		ORCHESTRA_DIR: resolve("."),
+		RELEASE_NUMBER: orchestra.resolveConfig(orchestra.config.releaseNumber),
+		RELEASE_NAME: orchestra.resolveConfig(orchestra.config.releaseName),
+		PLACE_ID: place && orchestra.resolveConfig(place.placeId)?.toString(),
+		EXPERIENCE_ID: place && orchestra.resolveConfig(place.experienceId)?.toString(),
+	};
+}
+
+export function sh<E extends Environments>(cmd: string, config: Partial<SpawnConfig> = {}): Value<E, Script<E>> {
+	const fullConfig = {
+		...DEFAULT_SPAWN_CONFIG,
+		...config,
+	};
+
+	return val((orchestra, place, argv = []) => {
+		return new Promise((resolvePromise, reject) => {
+			const child = spawn(`${cmd}`, argv, {
+				cwd: place ? resolve(orchestra.resolveConfig(place.rootDir)) : undefined,
+				stdio: "inherit",
+				env: generateEnv(orchestra, place),
+			});
+
+			if (fullConfig.waitForExit) {
+				child.on("exit", (code) => {
+					if (code !== 0 && !fullConfig.ignoreNonZeroExitCode) reject(code);
+					resolvePromise();
+				});
+			} else {
+				resolvePromise();
+			}
+		});
+	});
+}
+export function script<E extends Environments>(path: string, config: Partial<SpawnConfig> = {}): Value<E, Script<E>> {
+	return sh(`${resolve(path)}`, config);
+}

package/src/logger.ts

@@ -0,0 +1,3 @@
+import { createConsola } from "consola";
+
+export const logger = createConsola({});

package/src/orchestra/config.ts

@@ -0,0 +1,117 @@
+import { Orchestra } from "./orchestra";
+
+/**
+ * A value that is resolved using the Orchestra context
+ */
+export type Value<E extends Environments, T> = (orchestra: Orchestra<E>) => T;
+
+/**
+ * Allow either a raw value or a computed one
+ */
+export type MaybeValue<E extends Environments, T> = T | Value<E, T>;
+
+/**
+ * Resolve a MaybeValue at runtime
+ */
+export function resolveValue<E extends Environments, T>(value: MaybeValue<E, T>, orchestra: Orchestra<E>): T {
+	return typeof value === "function" ? (value as Value<E, T>)(orchestra) : value;
+}
+
+/**
+ * Helper to wrap static values
+ */
+export function val<E extends Environments, T>(value: T): Value<E, T> {
+	return () => value;
+}
+
+/**
+ * Environment-based value helper
+ */
+export function env<V extends Record<string, unknown>>(values: V) {
+	return <E extends { [K in keyof V]: EnvironmentConfig }>(orchestra: Orchestra<E>): V[keyof V] => {
+		return values[orchestra.environment as keyof V];
+	};
+}
+
+export type Script<E extends Environments> = (
+	orchestra: Orchestra<E>,
+	place?: PlaceConfig<E>,
+	argv?: string[],
+) => Promise<void> | void;
+
+/**
+ * A configuration for a place managed by an Orchestra
+ */
+export interface PlaceConfig<E extends Environments> {
+	rootDir: MaybeValue<E, string>;
+	placeId: MaybeValue<E, number>;
+	experienceId: MaybeValue<E, number>;
+
+	scripts: {
+		/**
+		 * A callback that runs when this place is built by the Orchestra
+		 */
+		[k: string]: MaybeValue<E, Script<E>>;
+	};
+}
+
+/**
+ * A configuration for a specific environment within an Orchestra
+ */
+export interface EnvironmentConfig {
+	/**
+	 * Whether to use this environment as the default if no other environments are chosen
+	 */
+	default?: boolean;
+
+	/**
+	 * The NODE_ENV value that will result in this environment being chosen
+	 */
+	nodeEnv?: string;
+}
+
+/**
+ * A list of environments available to an Orchestra
+ */
+export type Environments = {
+	[k: string]: EnvironmentConfig;
+};
+
+/**
+ * A configuration for an Orchestra
+ */
+export interface OrchestraConfig<E extends Environments> {
+	/**
+	 * Semantic version
+	 */
+	releaseNumber: string;
+
+	/**
+	 * Human-friendly release name
+	 */
+	releaseName: string;
+
+	/**
+	 * Available environments
+	 */
+	environments: E;
+
+	scripts?: {
+		/**
+		 * Callback that runs before any scripts are run
+		 */
+		prepare?: MaybeValue<E, Script<E>>;
+	} & Record<string, MaybeValue<E, Script<E>>>;
+
+	/**
+	 * Places in this experience
+	 */
+	places: [PlaceConfig<E>, ...PlaceConfig<E>[]];
+}
+
+/**
+ * Create an Orchestra config
+ */
+export function orchestraConfig<const E extends Environments>(experience: OrchestraConfig<E>) {
+	return experience;
+}

package/src/orchestra/index.ts

@@ -0,0 +1,2 @@
+export * from "./config";
+export * from "./orchestra";

package/src/orchestra/orchestra.ts

@@ -0,0 +1,52 @@
+import assert from "assert";
+import { createJiti } from "jiti";
+import { resolve } from "path";
+
+import { Environments, MaybeValue, OrchestraConfig, resolveValue } from "./config";
+
+const jiti = createJiti(__filename);
+
+export const ORCHESTRA_CONFIG_FILENAME = "orchestra.config.ts";
+
+export class Orchestra<E extends Environments> {
+	public static async fromDirectory(directoryPath: string): Promise<Orchestra<never>> {
+		return await Orchestra.fromFileConfig(resolve(directoryPath, ORCHESTRA_CONFIG_FILENAME));
+	}
+
+	public static async fromFileConfig(filePath: string): Promise<Orchestra<never>> {
+		const config = await jiti.import(resolve(filePath), {
+			default: true,
+		});
+
+		return new Orchestra(config as OrchestraConfig<never>);
+	}
+
+	public readonly environment: keyof E;
+
+	constructor(public readonly config: OrchestraConfig<E>) {
+		for (const [environmentName, environmentConfig] of Object.entries(config.environments)) {
+			if (this!.environment) continue;
+			const NODE_ENV = process.env.NODE_ENV ?? "unknown";
+			if (environmentConfig.default) {
+				this.environment = environmentName;
+			} else if (NODE_ENV == environmentConfig.nodeEnv) {
+				this.environment = environmentName;
+			}
+		}
+		assert(this!.environment, `Orchestra confiag is invalid, no default or otherwise valid environments provided`);
+	}
+
+	public async runScripts(scriptName: string, argv?: string[]) {
+		await this.resolveConfig(this.config.scripts?.prepare)?.(this, undefined, argv);
+
+		await this.resolveConfig(this.config.scripts?.[scriptName])?.(this, undefined, argv);
+
+		for (const place of this.config.places) {
+			await this.resolveConfig(place.scripts[scriptName])?.(this, place, argv);
+		}
+	}
+
+	public resolveConfig<T>(config: MaybeValue<E, T>): T {
+		return resolveValue(config, this);
+	}
+}