@nakedev/go-scaffold 0.1.4 → 0.3.0

package/dist/commands/worker.js

@@ -11,65 +11,125 @@ const config_1 = require("../utils/config");
 const template_renderer_1 = require("../utils/template-renderer");
 const worker_manifest_1 = require("../templates/worker-manifest");
 const platform_patcher_1 = require("../utils/platform-patcher");
-// addWorker scaffolds the async task processing subsystem: Redis
-// (platform/cache), Asynq client/server (platform/queue), SMTP mail
-// (platform/mail, with an email:send task type as the one thing the fresh
+const gocheck_1 = require("../utils/gocheck");
+const gomod_patcher_1 = require("../utils/gomod-patcher");
+const auth_patcher_1 = require("../utils/auth-patcher");
+// addWorker scaffolds async job processing: the backend-neutral queue
+// contract (platform/queue), one adapter for the chosen backing store, SMTP
+// mail (platform/mail, with an email:send job as the one thing a fresh
 // worker actually handles), and cmd/worker itself. Opt-in — most projects
-// don't need a queue on day one, and an empty worker with no task types
-// registered is a stranger scaffold than just not having one.
-async function addWorker(projectDir = process.cwd()) {
+// don't need a queue on day one, and an empty worker with no job kinds
+// registered is a stranger scaffold than not having one.
+async function addWorker(backend, projectDir = process.cwd()) {
     const config = (0, config_1.readConfig)(projectDir);
     const queueDir = path_1.default.join(projectDir, "internal", "platform", "queue");
     if (fs_extra_1.default.existsSync(queueDir)) {
         throw new Error(`${queueDir} already exists — worker infrastructure looks like it's already been added`);
     }
-    await (0, template_renderer_1.applyTemplateEntries)(projectDir, worker_manifest_1.WORKER_FILES, { goModule: config.goModule });
-    (0, platform_patcher_1.patchConfigForWorker)(path_1.default.join(projectDir, "internal", "shared", "config", "config.go"));
-    (0, platform_patcher_1.patchMainGoForWorker)(path_1.default.join(projectDir, "cmd", "api", "main.go"), config.goModule);
-    patchEnvExample(path_1.default.join(projectDir, ".env.example"));
-    patchMakefile(path_1.default.join(projectDir, "Makefile"));
+    const parsedBefore = (0, gocheck_1.parseChecks)(projectDir);
+    const riverQueue = backend === "river";
+    await (0, template_renderer_1.applyTemplateEntries)(projectDir, (0, worker_manifest_1.workerFiles)(backend), { goModule: config.goModule, riverQueue });
+    (0, platform_patcher_1.patchConfigForWorker)(path_1.default.join(projectDir, "internal", "shared", "config", "config.go"), { redis: !riverQueue });
+    if (!riverQueue) {
+        (0, platform_patcher_1.patchMainGoForWorker)(path_1.default.join(projectDir, "cmd", "api", "wiring.go"), config.goModule);
+        (0, platform_patcher_1.patchComposeForRedis)(path_1.default.join(projectDir, "docker-compose.yml"));
+        (0, platform_patcher_1.patchCiForRedis)(path_1.default.join(projectDir, ".github", "workflows", "ci.yml"));
+    }
+    // pinned to what this scaffold was written against — see gomod-patcher
+    (0, gomod_patcher_1.patchGoModRequires)(path_1.default.join(projectDir, "go.mod"), riverQueue
+        ? ["github.com/riverqueue/river v0.43.0", "github.com/riverqueue/river/riverdriver/riverdatabasesql v0.43.0"]
+        : ["github.com/hibiken/asynq v0.26.0", "github.com/redis/go-redis/v9 v9.22.0"]);
+    // auth added before the worker wired a synchronous mailer — now that there
+    // is a queue, move it onto it
+    const mailerUpgraded = (0, auth_patcher_1.upgradeMailerToQueue)(path_1.default.join(projectDir, "cmd", "api", "wiring.go"), config.goModule, backend);
+    patchEnvExample(path_1.default.join(projectDir, ".env.example"), { redis: !riverQueue });
+    patchMakefile(path_1.default.join(projectDir, "Makefile"), { river: riverQueue });
     (0, template_renderer_1.gofmtTree)(projectDir);
-    (0, config_1.writeConfig)(projectDir, { ...config, features: { ...config.features, worker: true } });
-    console.log(picocolors_1.default.green("\nadded internal/platform/{cache,queue,mail}/ and cmd/worker/"));
-    console.log("wired Redis into cmd/api (readyz check) — cmd/api does not enqueue anything yet");
-    console.log(picocolors_1.default.dim("\nnext: make worker (separate terminal, or `make dev` runs both), then go build ./... to confirm"));
+    // parse-only: river/asynq aren't in go.mod until the user runs `go mod
+    // tidy`, so `go vet` can't be the gate here.
+    (0, gocheck_1.assertStillParses)(projectDir, parsedBefore, `added worker (${backend})`);
+    (0, config_1.writeConfig)(projectDir, { ...config, features: { ...config.features, worker: true, queue: backend } });
+    console.log(picocolors_1.default.green(`\nadded internal/platform/{queue,mail}/ and cmd/worker/ (queue backend: ${backend})`));
+    if (riverQueue) {
+        console.log("jobs are rows in your Postgres — no extra service, and an enqueue inside tx.Do commits with it");
+        console.log(picocolors_1.default.dim("\nnext: make river-migrate (creates River's tables), then make worker"));
+    }
+    else {
+        console.log(mailerUpgraded
+            ? "wired Redis into cmd/api (readyz check) — auth's mailer now enqueues onto it instead of blocking on SMTP"
+            : "wired Redis into cmd/api (readyz check) — cmd/api does not enqueue anything yet");
+        console.log(picocolors_1.default.yellow("note: a Redis enqueue cannot join a database transaction — see the warning on queue.Asynq"));
+        console.log(picocolors_1.default.dim("\nnext: make worker (separate terminal, or `make dev` runs both), then go build ./... to confirm"));
+    }
 }
-function patchEnvExample(envExamplePath) {
+// needsSmtp and needsRedis are checked independently: `add auth` run without
+// a worker already writes SMTP_HOST on its own (auth stands alone — see
+// addAuth), so by the time a Redis-backed worker arrives after it, the old
+// single `if (content.includes("SMTP_HOST")) return` guard fired on the SMTP
+// block alone and quietly skipped the Redis block right along with it —
+// REDIS_URL never made it into .env.example even though config.go now reads
+// it. Each block gets its own guard so one being done doesn't hide the other.
+function patchEnvExample(envExamplePath, opts) {
     if (!fs_extra_1.default.existsSync(envExamplePath))
         return;
     let content = fs_extra_1.default.readFileSync(envExamplePath, "utf8");
-    if (content.includes("REDIS_URL"))
-        return; // already added
-    content =
-        content.replace(/\n?$/, "\n") +
-            "\nREDIS_URL=redis://localhost:6379/0\n" +
+    const needsRedis = opts.redis && !content.includes("REDIS_URL");
+    const needsSmtp = !content.includes("SMTP_HOST");
+    if (!needsRedis && !needsSmtp)
+        return; // both already added
+    content = content.replace(/\n?$/, "\n");
+    if (needsRedis) {
+        content += "\nREDIS_URL=redis://localhost:6379/0\n";
+    }
+    if (needsSmtp) {
+        content +=
             "\n# leave SMTP_HOST unset to log emails instead of sending them (dev default)\n" +
-            "SMTP_HOST=\n" +
-            "SMTP_PORT=587\n" +
-            "SMTP_USERNAME=\n" +
-            "SMTP_PASSWORD=\n" +
-            "SMTP_FROM=no-reply@example.local\n";
+                "SMTP_HOST=\n" +
+                "SMTP_PORT=587\n" +
+                "SMTP_USERNAME=\n" +
+                "SMTP_PASSWORD=\n" +
+                "SMTP_FROM=no-reply@example.local\n";
+    }
     fs_extra_1.default.writeFileSync(envExamplePath, content);
 }
-function patchMakefile(makefilePath) {
+function patchMakefile(makefilePath, opts) {
     if (!fs_extra_1.default.existsSync(makefilePath))
         return;
     let content = fs_extra_1.default.readFileSync(makefilePath, "utf8");
     if (content.includes("\nworker:\n"))
         return; // already added
-    content = content.replace(/^\.PHONY: /m, ".PHONY: dev worker ");
+    content = content.replace(/^\.PHONY: /m, `.PHONY: dev worker${opts.river ? " river-migrate" : ""} `);
+    // River keeps its own tables, versioned by River itself rather than by this
+    // project's migrations/ directory — run its CLI once per database. Pinned
+    // by nothing on purpose: it is a one-shot setup command, not a build input.
+    const riverTarget = opts.river
+        ? "\n# create River's job tables (run once per database, and after upgrading River)\n" +
+            "river-migrate:\n" +
+            "\t@set -a; [ -f $(ENV_FILE) ] && . ./$(ENV_FILE); set +a; \\\n" +
+            '\tgo run github.com/riverqueue/river/cmd/river@latest migrate-up --line main --database-url "$$DB_DSN"\n'
+        : "";
+    // Both load config exactly the way Makefile.hbs says every target does:
+    // via $(ENV_FILE), and through the same sed that strips trailing comments.
+    // Without it, .env.example's own `APP_ENV=development  # prod: production`
+    // reaches `export` as a bare `#` and prints an error on every run.
+    const loadEnv = "@set -a; [ -f $(ENV_FILE) ] && . ./$(ENV_FILE); set +a;";
     const targets = "\n# run both API + worker in one terminal — Ctrl+C kills both\n" +
         "dev:\n" +
-        "\t@[ -f .env ] && export $$(grep -v '^#' .env | xargs); \\\n" +
+        `\t${loadEnv} \\\n` +
         "\t(trap 'kill 0' SIGINT SIGTERM; \\\n" +
         "\t go run ./cmd/api & \\\n" +
         "\t go run ./cmd/worker & \\\n" +
         "\t wait)\n" +
         "\n" +
-        "# background worker for async task processing (email, ...) — requires Redis.\n" +
+        `# background worker for async job processing (email, ...) — requires ${opts.river ? "Postgres (make river-migrate first)" : "Redis"}.\n` +
         "# Use `make dev` to run both in one terminal, or run this in a separate one.\n" +
         "worker:\n" +
-        "\t@[ -f .env ] && export $$(grep -v '^#' .env | xargs); go run ./cmd/worker\n";
-    content = content.replace(/\nbuild:/, `${targets}\nbuild:`);
+        `\t${loadEnv} go run ./cmd/worker\n` +
+        riverTarget;
+    // Function replacer: targets contains literal "$$" (Make's escape for a
+    // shell "$") which String.replace would otherwise collapse to a single "$"
+    // when the replacement is a plain string — turning "$$DB_DSN" into
+    // "$DB_DSN" and silently handing the wrong value to every command below.
+    content = content.replace(/\nbuild:/, () => `${targets}\nbuild:`);
     fs_extra_1.default.writeFileSync(makefilePath, content);
 }