@canner-ca/cli 0.5.5 → 0.5.7

package/README.md

@@ -69,12 +69,17 @@ canner deploy --follow
 | `canner token create <name>` | Mint a new token. The secret is printed once — copy it immediately. |
 | `canner token revoke <id\|name>` | Revoke a token. |
 | `canner env [list] [--reveal] [--slug X]` | List a project's environment variables. Values marked sensitive are redacted (`••••••`, or `null` in `--json`) unless `--reveal` is passed. |
-| `canner env set KEY=VALUE [--env production\|preview] [--sensitive] [--slug X]` | Add an environment variable. |
+| `canner env set KEY=VALUE [KEY=VALUE ...] [--env production\|preview] [--sensitive] [--slug X]` | Add one or more environment variables. |
 | `canner env rm <KEY\|id> [--env ...] [--slug X]` | Delete an environment variable. |
 | `canner domains [list] [--slug X]` | List a project's custom domains. |
 | `canner domains add <hostname> [--slug X]` | Attach a custom domain (starts `pending`). |
 | `canner domains verify <hostname\|id> [--slug X]` | Re-check DNS and provision TLS. |
 | `canner domains rm <hostname\|id> [--slug X]` | Detach a custom domain. |
+| `canner jobs [list] [--slug X]` | List scheduled jobs, with the header names each sends (never a value). |
+| `canner jobs create <name> (--path /api/cron [--branch BRANCH] \| --url URL) --schedule "CRON" [--header name=value] [--header-env name=VARIABLE] [--bearer-env VARIABLE] [--slug X]` | Create a job. `--path` calls a path in the project itself (in Git Bash on Windows write `--path //api/cron`, or Git Bash rewrites the leading slash) (its address is built from the project's own host each time, in production or, with `--branch`, on that preview); `--url` is for anything else. `--header-env x-cron-key=CRON_KEY` sends the project variable's value, read each time the job runs, so the secret is never copied. `--bearer-env CRON_SECRET` sends `Authorization: Bearer …`. With a `CRON_SECRET` variable and no Authorization header, Canner sends it automatically. |
+| `canner jobs edit <id> [--name N] [--schedule "CRON"] [--description D] [--pause \| --resume] [--path /p [--branch B \| --production] \| --url U] [--header-env name=VARIABLE] [--bearer-env VARIABLE] [--header name=value] [--remove-header name] [--clear-headers]` | Change a job in place; only the options you give change, and its run history stays. A header given by name replaces the one with that name and the others are kept. |
+| `canner jobs run <id>` / `canner jobs runs <id>` | Run a job now and show the result, or list recent runs with what to check on a failure. |
+| `canner jobs delete <id> --yes` | Delete a job and its run history. |
 
 ### Databases
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@canner-ca/cli",
-  "version": "0.5.5",
+  "version": "0.5.7",
   "description": "Canner deploy CLI — git push from any terminal, no GitHub required",
   "type": "module",
   "bin": {

package/src/cli.mjs

@@ -28,7 +28,7 @@ import { randomUUID } from 'node:crypto';
 import { stdin as input, stdout as output } from 'node:process';
 import { create as tarCreate } from 'tar';
 
-const VERSION = '0.5.5';
+const VERSION = '0.5.7';
 const DEFAULT_API_BASE = 'https://api.canner.ca';
 const CONFIG_DIR = join(homedir(), '.canner');
 const CREDENTIALS_PATH = join(CONFIG_DIR, 'credentials');
@@ -726,23 +726,31 @@ async function cmdEnv(args) {
   }
 
   if (sub === 'set') {
-    const kv = args._[1];
-    if (!kv || !kv.includes('=')) die('usage: canner env set KEY=VALUE', 2);
-    const eq = kv.indexOf('=');
-    const key = kv.slice(0, eq);
-    const value = kv.slice(eq + 1);
+    const pairs = args._.slice(1);
+    if (pairs.length === 0 || pairs.some((kv) => !kv.includes('='))) die('usage: canner env set KEY=VALUE [KEY=VALUE ...]', 2);
     const environment = normalizeEnvScope(args.env);
     const isSensitive = args.sensitive === true;
-    const result = await apiJSON(creds, 'POST', base, {
-      key, value, environment, is_sensitive: isSensitive,
-    });
-    if (JSON_MODE) return emitJSON(result);
-    if ((result?.created ?? []).length > 0) {
-      info(`${green('set')} ${bold(key)}${environment ? dim(` (${environment})`) : ''}`);
-    } else {
-      // A duplicate (same key+scope) is skipped, not overwritten — surface that
-      // so the user isn't surprised the value didn't change.
-      die(`${key} already exists for that environment. Delete it first (canner env rm ${key}), then set again.`);
+    const results = [];
+    const skipped = [];
+    for (const kv of pairs) {
+      const eq = kv.indexOf('=');
+      const key = kv.slice(0, eq);
+      const value = kv.slice(eq + 1);
+      const result = await apiJSON(creds, 'POST', base, {
+        key, value, environment, is_sensitive: isSensitive,
+      });
+      results.push(result);
+      if ((result?.created ?? []).length > 0) {
+        if (!JSON_MODE) info(`${green('set')} ${bold(key)}${environment ? dim(` (${environment})`) : ''}`);
+      } else {
+        // A duplicate (same key+scope) is skipped, not overwritten — surface that
+        // so the user isn't surprised the value didn't change.
+        skipped.push(key);
+      }
+    }
+    if (JSON_MODE) return emitJSON(results.length === 1 ? results[0] : results);
+    if (skipped.length > 0) {
+      die(`${skipped.join(', ')} already exist${skipped.length === 1 ? 's' : ''} for that environment. Delete ${skipped.length === 1 ? 'it' : 'them'} first (canner env rm ${skipped[0]}), then set again.`);
     }
     return;
   }
@@ -1121,6 +1129,7 @@ const BOOLEAN_FLAGS = new Set([
   'json', 'reveal', 'sensitive', 'follow', 'dashboard', 'version', 'help',
   'replace', 'yes', 'no-wait', 'enable', 'disable', 'restore', 'download', 'rm', 'delete', 'instance', 'pitr',
   'read-only', 'read-write', 'replication', 'group', 'login', 'adopt', 'strict', 'dedicated',
+  'pause', 'resume', 'production', 'clear-headers',
 ]);
 
 const splitList = (v) => String(v).split(',').map((x) => x.trim()).filter(Boolean);
@@ -1354,6 +1363,204 @@ async function cmdBilling(args) {
   die('usage: canner billing addons | preview <addon> <quantity>', 2);
 }
 
+// ---------------------------------------------------------------------------
+// canner jobs ...                                        - scheduled jobs (webhook cron)
+//
+//   canner jobs [list] [--slug X]                        the jobs (all of them, or one project's)
+//   canner jobs create <name> (--path /api/cron [--branch B] | --url U) --schedule "*/15 * * * *" [--slug X] [--description D]
+//         [--header "name=value" ...] [--header-env name=VARIABLE ...] [--bearer-env VARIABLE]
+//   (--path calls a path in the project itself: its address is built from the project's own host each time, in
+//    production or, with --branch, on that preview; --url is for anything else)
+//   canner jobs edit <id> [--name N] [--schedule "CRON"] [--description D] [--pause | --resume]
+//         [--path /p [--branch B | --production] | --url U]
+//         [--header-env name=VARIABLE ...] [--bearer-env VARIABLE] [--header name=value ...]
+//         [--remove-header name ...] [--clear-headers]
+//   (edit changes only what is given. A header given by name replaces the one with that name; the others stay.)
+//   canner jobs run <id>                                 run it now and show what came back
+//   canner jobs runs <id>                                recent runs, with what to check on a failure
+//   canner jobs delete <id> --yes
+//
+// A header's value can read a project environment variable when the job fires, so the secret is never
+// copied: --header-env x-cron-key=CRON_KEY sends x-cron-key with the value of CRON_KEY; --bearer-env
+// CRON_SECRET sends Authorization: Bearer <CRON_SECRET>. (Same as --header 'x-cron-key=${CRON_KEY}', without
+// the shell-quoting.) With a CRON_SECRET variable and no Authorization header, Canner sends it automatically.
+// ---------------------------------------------------------------------------
+const asList = (v) => (v === undefined || v === true ? [] : Array.isArray(v) ? v : [v]);
+
+// A path argument, as the API wants it (leading slash). Git Bash on Windows rewrites an argument that starts with
+// "/" into a Windows path (C:/Program Files/Git/api/cron) before any program sees it; say so instead of sending that.
+function pathArg(raw) {
+  const p = String(raw);
+  if (/^[A-Za-z]:[\\/]/.test(p)) {
+    die(`"${p}" is not a path in your project. Git Bash on Windows rewrites arguments that start with "/": write it with a doubled slash (--path //api/cron), or run the command with MSYS_NO_PATHCONV=1.`, 2);
+  }
+  return p.startsWith('//') && !p.startsWith('///') ? p.slice(1) : p.startsWith('/') ? p : `/${p}`;
+}
+
+function jobHeadersFromArgs(args) {
+  const headers = {};
+  const put = (name, value) => {
+    if (!name || value === undefined || value === '') die(`bad header: "${name}" needs a name and a value.`, 2);
+    headers[name] = value;
+  };
+  for (const h of asList(args.header)) {
+    const eq = String(h).indexOf('=');
+    if (eq < 1) die(`bad --header "${h}": use name=value.`, 2);
+    put(String(h).slice(0, eq), String(h).slice(eq + 1));
+  }
+  for (const h of asList(args['header-env'])) {
+    const eq = String(h).indexOf('=');
+    if (eq < 1) die(`bad --header-env "${h}": use header-name=VARIABLE.`, 2);
+    put(String(h).slice(0, eq), `\${${String(h).slice(eq + 1)}}`);
+  }
+  for (const v of asList(args['bearer-env'])) put('Authorization', `Bearer \${${v}}`);
+  return headers;
+}
+
+const describeJobHeaders = (headers) => {
+  const entries = Object.entries(headers ?? {});
+  if (entries.length === 0) return dim('none');
+  return entries.map(([n, v]) => (/\$\{/.test(v) ? `${n} ${dim(`(${v})`)}` : `${n} ${dim('(hidden)')}`)).join(', ');
+};
+
+async function findJob(creds, ref) {
+  const body = await apiJSON(creds, 'GET', '/jobs');
+  const hits = (body?.jobs ?? []).filter((j) => j.id === ref || j.id.startsWith(ref));
+  if (hits.length === 0) die(`no job with id "${ref}". List them with: canner jobs`);
+  if (hits.length > 1) die(`"${ref}" matches more than one job; use more of the id.`);
+  return hits[0];
+}
+
+function printRun(r) {
+  const color = r.status === 'succeeded' ? green : r.status === 'running' ? yellow : red;
+  info(`  ${pad(r.started_at.replace('T', ' ').slice(0, 19), 21)}${pad(color(r.status), 20)}${pad(String(r.http_status ?? '-'), 6)}${r.duration_ms != null ? `${r.duration_ms} ms` : ''}`);
+  if (r.error_message) info(`    ${dim(String(r.error_message).slice(0, 200))}`);
+  if (r.hint) info(`    ${yellow('check')} ${r.hint}`);
+}
+
+async function cmdJobs(args) {
+  const creds = await loadCredentials();
+  if (!creds.token) die("not signed in. Run `canner login`.");
+  const sub = args._[0] ?? 'list';
+
+  if (sub === 'list' || sub === 'ls') {
+    const body = await apiJSON(creds, 'GET', args.slug ? `/projects/${encodeURIComponent(args.slug)}/jobs` : '/jobs');
+    if (JSON_MODE) return emitJSON(body);
+    const jobs = body?.jobs ?? [];
+    if (jobs.length === 0) { muted('no scheduled jobs. Create one with `canner jobs create`.'); return; }
+    info(`${pad(bold('ID'), 10)}${pad(bold('NAME'), 26)}${pad(bold('PROJECT'), 20)}${pad(bold('SCHEDULE'), 16)}${bold('HEADERS')}`);
+    for (const j of jobs) {
+      info(`${pad(dim(j.id.slice(0, 8)), 10)}${pad(j.is_active ? j.name : `${j.name} ${dim('(paused)')}`, 26)}${pad(j.project_slug, 20)}${pad(j.schedule, 16)}${describeJobHeaders(j.headers)}`);
+    }
+    return;
+  }
+
+  if (sub === 'create' || sub === 'add') {
+    const name = args._[1];
+    if (!name || !args.schedule || Boolean(args.url) === Boolean(args.path)) {
+      die('usage: canner jobs create <name> (--path /api/cron [--branch BRANCH] | --url URL) --schedule "CRON" [--header name=value] [--header-env name=VARIABLE] [--bearer-env VARIABLE]', 2);
+    }
+    if (args.branch && !args.path) die('--branch goes with --path.', 2);
+    const slug = await resolveSlug(args);
+    const headers = jobHeadersFromArgs(args);
+    const body = await apiJSON(creds, 'POST', `/projects/${encodeURIComponent(slug)}/jobs`, {
+      name, schedule: String(args.schedule),
+      ...(args.path ? { path: pathArg(args.path), ...(args.branch ? { branch: String(args.branch) } : {}) } : { url: String(args.url) }),
+      ...(args.description ? { description: String(args.description) } : {}),
+      ...(Object.keys(headers).length > 0 ? { headers } : {}),
+    });
+    if (JSON_MODE) return emitJSON(body);
+    info(`${green('created')} ${bold(name)} ${dim(body.job.id)}`);
+    for (const w of body.warnings ?? []) info(`${yellow('warning')} ${w.message}`);
+    return;
+  }
+
+  if (sub === 'run' || sub === 'trigger') {
+    if (!args._[1]) die('usage: canner jobs run <id>', 2);
+    const job = await findJob(creds, args._[1]);
+    await apiJSON(creds, 'POST', `/projects/${encodeURIComponent(job.project_slug)}/jobs/${job.id}/trigger`);
+    let run = null;
+    for (let i = 0; i < 20; i++) {
+      await new Promise((r) => setTimeout(r, 750));
+      const body = await apiJSON(creds, 'GET', `/projects/${encodeURIComponent(job.project_slug)}/jobs/${job.id}/runs?limit=1`);
+      run = body?.runs?.[0] ?? null;
+      if (run && run.status !== 'running') break;
+    }
+    if (JSON_MODE) return emitJSON(run);
+    if (!run) { muted('started; check `canner jobs runs ' + job.id.slice(0, 8) + '` in a moment.'); return; }
+    info(`${bold(job.name)}`);
+    printRun(run);
+    if (run.status !== 'succeeded' && run.response_body) info(`    ${dim(String(run.response_body).slice(0, 300))}`);
+    if (run.status !== 'succeeded') process.exitCode = 1;
+    return;
+  }
+
+  if (sub === 'runs' || sub === 'history') {
+    if (!args._[1]) die('usage: canner jobs runs <id>', 2);
+    const job = await findJob(creds, args._[1]);
+    const body = await apiJSON(creds, 'GET', `/projects/${encodeURIComponent(job.project_slug)}/jobs/${job.id}/runs?limit=10`);
+    if (JSON_MODE) return emitJSON(body);
+    info(`${bold(job.name)} ${dim(`${job.project_slug} · ${job.schedule}`)}  headers: ${describeJobHeaders(job.headers)}`);
+    if ((body?.runs ?? []).length === 0) { muted('no runs yet.'); return; }
+    for (const r of body.runs) printRun(r);
+    return;
+  }
+
+  if (sub === 'edit' || sub === 'update') {
+    if (!args._[1]) die('usage: canner jobs edit <id> [--schedule "CRON"] [--path /p [--branch B | --production] | --url U] [--header-env name=VARIABLE] [--bearer-env VARIABLE] [--remove-header name] [--clear-headers] [--pause | --resume]', 2);
+    if (args.url && args.path) die('give either --url or --path, not both.', 2);
+    if (args.branch && args.production) die('give either --branch or --production, not both.', 2);
+    if (args.pause && args.resume) die('give either --pause or --resume, not both.', 2);
+    if ((args.branch || args.production) && args.url) die('--branch / --production go with --path.', 2);
+    const job = await findJob(creds, args._[1]);
+
+    const patchBody = {};
+    if (args.name) patchBody.name = String(args.name);
+    if (args.schedule) patchBody.schedule = String(args.schedule);
+    if (args.description !== undefined && args.description !== true) patchBody.description = String(args.description);
+    if (args.pause) patchBody.is_active = false;
+    if (args.resume) patchBody.is_active = true;
+    if (args.path) patchBody.path = pathArg(args.path);
+    if (args.url) patchBody.url = String(args.url);
+    if (args.branch) patchBody.branch = String(args.branch);
+    if (args.production) patchBody.branch = null;
+
+    // Headers: start from what the job has (references as written, literal values hidden — the server keeps
+    // a hidden value as is), drop what was asked to go, and let a header given by name replace its namesake.
+    const added = jobHeadersFromArgs(args);
+    const removed = asList(args['remove-header']).map((n) => String(n).toLowerCase());
+    if (Object.keys(added).length > 0 || removed.length > 0 || args['clear-headers']) {
+      const lower = (n) => n.toLowerCase();
+      const replaced = new Set(Object.keys(added).map(lower));
+      const kept = args['clear-headers']
+        ? {}
+        : Object.fromEntries(Object.entries(job.headers ?? {}).filter(([n]) => !replaced.has(lower(n)) && !removed.includes(lower(n))));
+      patchBody.headers = { ...kept, ...added };
+    }
+    if (Object.keys(patchBody).length === 0) die('nothing to change. Give at least one option (canner jobs edit <id> --help-style usage above).', 2);
+
+    const body = await apiJSON(creds, 'PATCH', `/projects/${encodeURIComponent(job.project_slug)}/jobs/${job.id}`, patchBody);
+    if (JSON_MODE) return emitJSON(body);
+    info(`${green('updated')} ${bold(body.job?.name ?? job.name)}`);
+    info(`  calls    ${body.job?.url ?? job.url}`);
+    info(`  headers  ${describeJobHeaders(body.job?.headers)}`);
+    for (const w of body.warnings ?? []) info(`${yellow('warning')} ${w.message}`);
+    return;
+  }
+
+  if (sub === 'delete' || sub === 'rm') {
+    if (!args._[1]) die('usage: canner jobs delete <id> --yes', 2);
+    const job = await findJob(creds, args._[1]);
+    requireYes(args, `This deletes the job "${job.name}" and its run history.`);
+    await apiJSON(creds, 'DELETE', `/projects/${encodeURIComponent(job.project_slug)}/jobs/${job.id}`);
+    if (JSON_MODE) return emitJSON({ ok: true });
+    info(`${green('deleted')} ${bold(job.name)}`);
+    return;
+  }
+
+  die('usage: canner jobs [list] | create <name> ... | edit <id> ... | run <id> | runs <id> | delete <id> --yes', 2);
+}
+
 async function cmdDb(args) {
   const creds = await loadCredentials();
   if (!creds.token) die("not signed in. Run `canner login`.");
@@ -2672,6 +2879,13 @@ ${bold('Databases:')}
                        Create the primary on its own dedicated instance with
                        point-in-time recovery. If the project has no unit, this
                        buys one: it shows the price and needs --yes.
+  ${bold('jobs')} [list] | create <name> (--path /p [--branch B] | --url U) --schedule "CRON" | edit <id> | run <id> | runs <id> | delete <id> --yes
+                       Scheduled jobs. --path calls a path in the project itself
+                       (production, or a preview with --branch). A header can read a
+                       project variable: --header-env x-cron-key=CRON_KEY or
+                       --bearer-env CRON_SECRET. "jobs edit <id>" changes only the
+                       options you give (--schedule, --path, --header-env,
+                       --remove-header, --pause / --resume ...).
   ${bold('billing')} addons | preview <addon> <quantity>
                        See the add-ons you own and where they are assigned, and
                        preview a quantity change. Read-only; nothing is charged.
@@ -2855,6 +3069,8 @@ const dispatch = {
   env: cmdEnv,
   domains: cmdDomains,
   billing: cmdBilling,
+  jobs: cmdJobs,
+  job: cmdJobs,
   db: cmdDb,
   database: cmdDb,
   databases: cmdDb,