laracrew 0.1.1 → 0.2.0

package/dist/index.js

@@ -1,6 +1,9 @@
 #!/usr/bin/env node
 
 // src/cli/program.ts
+import { readFileSync as readFileSync4 } from "fs";
+import path11 from "path";
+import { fileURLToPath as fileURLToPath2 } from "url";
 import { Command } from "commander";
 
 // src/core/config/errors.ts
@@ -137,8 +140,15 @@ var backoffSchema = z.object({
   /** Stay up this long and the attempt counter resets, so a slow leak can't exhaust it. */
   resetAfterMs: z.number().int().positive().default(6e4)
 }).strict();
+var commandSchema = z.union([z.string().min(1), z.array(z.string().min(1)).min(1)]);
 var stopPolicySchema = z.object({
-  /** Laravel-native graceful shutdown, e.g. "queue:restart" or "horizon:terminate". */
+  /**
+   * Step 1 of the stop ladder: any command that asks the process to finish what it is
+   * holding and exit by itself — `celery control shutdown`, `docker compose stop`, a
+   * drain script. Runs in the service's cwd; laracrew waits `graceMs` for the exit.
+   */
+  exec: commandSchema.optional(),
+  /** Sugar for `exec` on a Laravel project: runs `<php> artisan <this>` from its root. */
   artisan: z.string().optional(),
   signal: z.string().default("SIGTERM"),
   graceMs: z.number().int().positive().default(1e4)
@@ -153,7 +163,6 @@ var metricsSchema = z.object({
   queues: z.array(z.string()).default([]),
   streams: z.array(z.object({ key: z.string(), group: z.string() }).strict()).default([])
 }).strict();
-var commandSchema = z.union([z.string().min(1), z.array(z.string().min(1)).min(1)]);
 var serviceSchema = z.object({
   name: z.string().min(1),
   project: z.string().optional(),
@@ -719,10 +728,35 @@ var mergeService = (raw, stack, projects, ports, processEnv, colorIndex) => {
     throw error;
   }
   const cwd = service.cwd ? path4.resolve(project?.path ?? stack.dir, service.cwd) : project?.path ?? stack.dir;
+  const inheritedStop = { ...defaults.stop };
+  const ownStop = service.stop ?? {};
+  if (ownStop.exec !== void 0) delete inheritedStop.artisan;
+  if (ownStop.artisan !== void 0) delete inheritedStop.exec;
+  const stop = stopPolicySchema.parse({ ...inheritedStop, ...ownStop });
+  if (stop.exec !== void 0 && stop.artisan !== void 0) {
+    throw new ConfigError(
+      `service "${service.name}" declares both \`stop.exec\` and \`stop.artisan\``,
+      { file: stack.file, details: ["keep one \u2014 `artisan` is only shorthand for an `exec` that runs artisan"] }
+    );
+  }
+  if (stop.artisan !== void 0 && !project) {
+    throw new ConfigError(
+      `service "${service.name}" declares \`stop.artisan\` but belongs to no project`,
+      {
+        file: stack.file,
+        details: ["`artisan` runs `<project php> artisan ...`, so it needs a project", "for any other command use `stop.exec`"]
+      }
+    );
+  }
+  const graceful = stop.exec ? { command: toCommand(stop.exec), cwd } : stop.artisan && project ? (
+    // artisan must run from the Laravel root even when the service sets its own cwd.
+    { command: { kind: "argv", file: project.php, args: ["artisan", ...stop.artisan.split(/\s+/)] }, cwd: project.path }
+  ) : void 0;
   return {
     name: service.name,
     ...project ? { project } : {},
     ...service.cmd ? { command: toCommand(service.cmd) } : {},
+    ...graceful ? { graceful } : {},
     cwd,
     env: { ...service.env },
     groups: service.groups,
@@ -730,7 +764,7 @@ var mergeService = (raw, stack, projects, ports, processEnv, colorIndex) => {
     ...service.ready ? { ready: service.ready } : {},
     restart: service.restart ?? defaults.restart,
     backoff: backoffSchema.parse({ ...defaults.backoff, ...service.backoff ?? {} }),
-    stop: stopPolicySchema.parse({ ...defaults.stop, ...service.stop ?? {} }),
+    stop,
     ...service.watch ? { watch: service.watch } : {},
     ...service.metrics ? { metrics: service.metrics } : {},
     ...service.url ? { url: service.url } : {},
@@ -1385,15 +1419,17 @@ var ManagedProcess = class {
     }, delayMs);
     this.#backoffTimer.unref?.();
   }
-  /** The Laravel-native graceful shutdown, when the service declares one. */
+  /**
+   * Step 1 of the stop ladder: ask the process to finish what it is holding and exit by
+   * itself. What that command is — `queue:restart`, `celery control shutdown`, a drain
+   * script — was decided in `resolve.ts`; this only runs it.
+   */
   #graceful() {
-    const artisan = this.service.stop.artisan;
-    const project = this.service.project;
-    if (!artisan || !project) return void 0;
+    const graceful = this.service.graceful;
+    if (!graceful) return void 0;
     return async () => {
-      const command = { kind: "argv", file: project.php, args: ["artisan", ...artisan.split(/\s+/)] };
-      this.#log(`stop: ${describeCommand(command)}`);
-      await runOnce(command, { cwd: project.path, env: this.#env, timeoutMs: 15e3 });
+      this.#log(`stop: ${describeCommand(graceful.command)}`);
+      await runOnce(graceful.command, { cwd: graceful.cwd, env: this.#env, timeoutMs: 15e3 });
     };
   }
   async stop() {
@@ -2496,36 +2532,88 @@ var waitUntilIdle = (supervisor, stopRequested) => new Promise((resolve) => {
 
 // src/cli/commands/doctor.ts
 var PORT_IN_COMMAND = /--port[= ](\d{2,5})/g;
+var commandLine = (service) => {
+  if (!service.command) return "";
+  return service.command.kind === "shell" ? service.command.line : [service.command.file, ...service.command.args].join(" ");
+};
+var PHP_BINARY = /(^|[\\/\s"'])php[\d.]*(\.exe)?(\s|$)/i;
+var phpProjects = (stack) => {
+  const keys = /* @__PURE__ */ new Set();
+  for (const service of stack.services) {
+    const key = service.project?.key;
+    if (!key) continue;
+    const line = commandLine(service);
+    const php = stack.projects[key]?.php;
+    if (service.stop.artisan || PHP_BINARY.test(line) || php !== void 0 && line.startsWith(php)) {
+      keys.add(key);
+    }
+  }
+  return keys;
+};
+var REDIS_DRIVER_KEYS = [
+  "QUEUE_CONNECTION",
+  "CACHE_STORE",
+  "CACHE_DRIVER",
+  "SESSION_DRIVER",
+  "BROADCAST_CONNECTION",
+  "BROADCAST_DRIVER"
+];
+var redisProjects = (stack) => {
+  const keys = /* @__PURE__ */ new Set();
+  for (const [key, project] of Object.entries(stack.projects)) {
+    const declared = Object.keys(project.env).some((name) => name.startsWith("REDIS_"));
+    const driver = REDIS_DRIVER_KEYS.some((name) => project.env[name]?.toLowerCase() === "redis");
+    if (declared || driver) keys.add(key);
+  }
+  for (const service of stack.services) {
+    const key = service.project?.key;
+    if (!key) continue;
+    if (service.metrics || /\b(redis|horizon)\b/i.test(commandLine(service))) keys.add(key);
+  }
+  return keys;
+};
 var declaredPorts = (stack) => {
   const ports = new Set(stack.ports);
   for (const service of stack.services) {
-    const line = service.command?.kind === "shell" ? service.command.line : service.command ? [service.command.file, ...service.command.args].join(" ") : "";
-    for (const match of line.matchAll(PORT_IN_COMMAND)) {
+    for (const match of commandLine(service).matchAll(PORT_IN_COMMAND)) {
       const port = Number(match[1]);
       if (Number.isInteger(port)) ports.add(port);
     }
   }
   return [...ports].sort((a, b) => a - b);
 };
-var redisTargetOf = (project) => `${project.env.REDIS_HOST ?? "127.0.0.1"}:${project.env.REDIS_PORT ?? "6379"}`;
+var parseRedisUrl = (url) => {
+  try {
+    const parsed = new URL(url);
+    return parsed.hostname ? { host: parsed.hostname, port: parsed.port || "6379" } : void 0;
+  } catch {
+    return void 0;
+  }
+};
+var redisTargetOf = (project) => {
+  const url = project.env.REDIS_URL ? parseRedisUrl(project.env.REDIS_URL) : void 0;
+  const host = project.env.REDIS_HOST ?? url?.host ?? "127.0.0.1";
+  const port = project.env.REDIS_PORT ?? url?.port ?? "6379";
+  return `${host}:${port}`;
+};
 var slug = (value) => value.toLowerCase().replace(/[^a-z0-9]+/g, "_").replace(/^_+|_+$/g, "");
 var redisPrefixOf = (project) => project.env.REDIS_PREFIX ?? `${slug(project.env.APP_NAME ?? "laravel")}_database_`;
 var redisNamespaceOf = (project) => `${redisTargetOf(project)}/${project.env.REDIS_DB ?? "0"}#${redisPrefixOf(project)}`;
-var checkProjects = (stack) => {
+var checkProjects = (stack, php, redis) => {
   const findings = [];
   for (const project of Object.values(stack.projects)) {
     if (!existsSync4(project.path)) {
       findings.push({ level: "error", message: `project "${project.key}": path does not exist \u2014 ${project.path}` });
       continue;
     }
-    if (!existsSync4(path7.join(project.path, "artisan"))) {
+    if (php.has(project.key) && !existsSync4(path7.join(project.path, "artisan"))) {
       findings.push({
         level: "warn",
         message: `project "${project.key}": no \`artisan\` file in ${project.path}`,
         hint: "laracrew will still run the commands, but this does not look like a Laravel root"
       });
     }
-    if (Object.keys(project.env).length === 0) {
+    if (Object.keys(project.env).length === 0 && (php.has(project.key) || redis.has(project.key))) {
       findings.push({
         level: "warn",
         message: `project "${project.key}": ${project.envFile} is missing or empty`,
@@ -2535,9 +2623,9 @@ var checkProjects = (stack) => {
   }
   return findings;
 };
-var checkRedisCollisions = (stack) => {
+var checkRedisCollisions = (stack, redis) => {
   const findings = [];
-  const projects = Object.values(stack.projects);
+  const projects = Object.values(stack.projects).filter((project) => redis.has(project.key));
   const byNamespace = /* @__PURE__ */ new Map();
   for (const project of projects) {
     const namespace = redisNamespaceOf(project);
@@ -2611,8 +2699,7 @@ var checkQueueConnections = (stack) => {
   const workerProjects = new Set(
     stack.services.filter((service) => {
       if (!service.autostart) return false;
-      const line = service.command?.kind === "shell" ? service.command.line : service.command ? [service.command.file, ...service.command.args].join(" ") : "";
-      return /\b(queue:work|queue:listen|horizon)\b/.test(line);
+      return /\b(queue:work|queue:listen|horizon)\b/.test(commandLine(service));
     }).map((service) => service.project?.key).filter((key) => Boolean(key))
   );
   for (const key of workerProjects) {
@@ -2630,8 +2717,10 @@ var checkQueueConnections = (stack) => {
   }
   return findings;
 };
-var checkPhp = async (stack) => {
-  const binaries = new Set(Object.values(stack.projects).map((project) => project.php));
+var checkPhp = async (stack, php) => {
+  const binaries = new Set(
+    Object.values(stack.projects).filter((project) => php.has(project.key)).map((project) => project.php)
+  );
   const findings = [];
   for (const binary of binaries) {
     try {
@@ -2669,8 +2758,29 @@ var checkPorts = async (stack) => {
   }
   return findings;
 };
-var checkRedisReachable = async (stack) => {
-  const targets = new Set(Object.values(stack.projects).map(redisTargetOf));
+var checkExternalServices = async (stack) => {
+  const external = stack.services.filter((service) => service.external && (service.ready?.tcp ?? service.ready?.http));
+  return Promise.all(
+    external.map(async (service) => {
+      const probe = service.ready;
+      const label = describeProbe(probe);
+      const result = probe.http ? await httpProbe(probe.http, 2e3) : await tcpProbe(probe.tcp, 2e3);
+      return result.ok ? { level: "ok", message: `${service.name} is reachable \u2014 ${label}` } : {
+        level: "warn",
+        message: `${service.name} is not reachable \u2014 ${label}${result.detail ? ` (${result.detail})` : ""}`,
+        hint: "laracrew never starts an external service; anything that needs it will wait at its gate"
+      };
+    })
+  );
+};
+var externalTcpTargets = (stack) => new Set(
+  stack.services.filter((service) => service.external && service.ready?.tcp).map((service) => service.ready.tcp)
+);
+var checkRedisReachable = async (stack, redis) => {
+  const covered = externalTcpTargets(stack);
+  const targets = new Set(
+    Object.values(stack.projects).filter((project) => redis.has(project.key)).map(redisTargetOf).filter((target) => !covered.has(target))
+  );
   const findings = [];
   for (const target of targets) {
     const result = await tcpProbe(target, 2e3);
@@ -2688,13 +2798,20 @@ var runDoctor = async (stackName, env = process.env) => {
     if (error instanceof ConfigError) return [{ level: "error", message: error.format() }];
     throw error;
   }
+  const php = phpProjects(stack);
+  const redis = redisProjects(stack);
   const findings = [
     { level: "ok", message: `stack "${stack.name}" is valid \u2014 ${stack.services.length} services` },
-    ...checkProjects(stack),
+    ...checkProjects(stack, php, redis),
     ...checkQueueConnections(stack),
-    ...checkRedisCollisions(stack)
+    ...checkRedisCollisions(stack, redis)
   ];
-  const async = await Promise.all([checkPhp(stack), checkPorts(stack), checkRedisReachable(stack)]);
+  const async = await Promise.all([
+    checkPhp(stack, php),
+    checkPorts(stack),
+    checkExternalServices(stack),
+    checkRedisReachable(stack, redis)
+  ]);
   return [...findings, ...async.flat()];
 };
 var doctorCommand = async (stackName, env = process.env) => {
@@ -2728,8 +2845,11 @@ metricsIntervalMs: 2000
 # The stack \`laracrew up\` boots when you don't name one.
 # defaultStack: dual
 `;
-var PROJECTS_YAML = `# Your Laravel projects, referenced by key from any stack.
+var PROJECTS_YAML = `# Your projects, referenced by key from any stack. A project is just a root directory
+# plus the defaults its services inherit \u2014 cwd, .env and colour. Any language.
 # Paths may use forward slashes on Windows.
+#
+# Declaring projects here is optional: a service can carry its own \`cwd\` instead.
 projects: {}
 
 # Example \u2014 delete the \`{}\` above and uncomment:
@@ -2737,12 +2857,11 @@ projects: {}
 # projects:
 #   api:
 #     path: D:/work/api
-#     php: php            # or an absolute path to a specific PHP build
-#     envFile: .env       # read for QUEUE_CONNECTION, REDIS_*, APP_URL, DB_*
+#     php: php            # only used by \`stop: { artisan: ... }\`; ignore it for non-PHP projects
+#     envFile: .env       # read for \${project.env:KEY} tokens, and by \`doctor\`
 #     color: cyan
-#   portal:
-#     path: D:/work/portal
-#     php: php
+#   web:
+#     path: D:/work/web
 #     envFile: .env
 #     color: magenta
 `;
@@ -3436,7 +3555,7 @@ ${paint("bold", "TASKS")}`);
 };
 
 // src/cli/program.ts
-var VERSION = "0.1.0";
+var VERSION = true ? "0.2.0" : versionFromPackageJson();
 var resolveStackName = (explicit, env = process.env) => {
   if (explicit) return explicit;
   const configured = loadGlobalConfig(env).defaultStack;
@@ -3454,7 +3573,7 @@ var resolveStackName = (explicit, env = process.env) => {
 var collect = (value, previous) => [...previous, value];
 var buildProgram = () => {
   const program = new Command();
-  program.name("laracrew").description("Boot and supervise all the long-running processes of your Laravel projects with one command.").version(VERSION, "-v, --version").showHelpAfterError();
+  program.name("laracrew").description("Boot and supervise all the long-running processes of your projects with one command.").version(VERSION, "-v, --version").showHelpAfterError();
   program.command("init").description("create ~/.laracrew").option("--examples", "also write a runnable demo stack and a two-project template").action((options) => {
     initCommand({ examples: options.examples ?? false });
   });