breakaway 1.0.2-main.24 → 1.0.2-main.25

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "breakaway",
-  "version": "1.0.2-main.24",
+  "version": "1.0.2-main.25",
   "description": "The task board for you and your coding agents: a Cloudflare Worker, its web app, Taskwarrior sync, and the CLI (npx breakaway).",
   "license": "FSL-1.1-Apache-2.0",
   "type": "module",

package/scripts/install/init.js

@@ -92,8 +92,10 @@ export function writeInstall({ dir, templateDir, config, state }) {
     writeFileSync(target, text);
     written.push(path);
   };
-  // The Worker reads the channel from its config (BRK-10), so it starts the same as breakaway.json's.
-  put('breakaway.config.json', json({ ...config, channel: state.channel }));
+  // The Worker reads the channel from its config (BRK-10), so it starts the same as breakaway.json's. No aliases yet: an
+  // empty list is left out, so a release from before them (BRK-78) still reads the file.
+  const { aliases, ...named } = config;
+  put('breakaway.config.json', json({ ...named, ...(aliases?.length ? { aliases } : {}), channel: state.channel }));
   put('breakaway.json', json(state));
   for (const file of TEMPLATE_FILES) put(file, readFileSync(join(templateDir, file), 'utf8'));
   put('README.md', readmeFor(readFileSync(join(templateDir, 'README.md'), 'utf8'), config));

package/src/cli-version.js

@@ -4,5 +4,5 @@
  * and how to update it. scripts/tasks/version.test.js fails when the copied files change and this doesn't:
  * so it lives in the board's package (CLD-135) and the CLI imports it from here.
  */
-export const CLI_VERSION = 45;
-export const CLI_FINGERPRINT = '947c6296a0dd677e';
+export const CLI_VERSION = 46;
+export const CLI_FINGERPRINT = '0eaad403bcd23b2e';

package/src/install.js

@@ -13,6 +13,7 @@ export const DEFAULTS = Object.freeze({
   name: 'breakaway',
   worker: 'breakaway',
   url: null,
+  aliases: [],
   secretsPrefix: 'BREAKAWAY_',
   secretsStore: null,
   store: 'breakaway',
@@ -72,6 +73,26 @@ function origin(url) {
   }
 }
 
+/**
+ * The other addresses a board answers on beside its url, as https origins (BRK-78): while it moves to a new address,
+ * the old one stays an alias until nothing uses it. Each is a custom domain of the Worker, like the url.
+ */
+function aliasesOf(aliases, url) {
+  if (!Array.isArray(aliases))
+    throw new ConfigError('aliases is a list of https origins, like ["https://old.example.com"]');
+  if (aliases.length && url === null)
+    throw new ConfigError('aliases need a url: they are the other addresses the board answers on beside it');
+  const out = aliases.map((a) => {
+    const o = origin(a);
+    if (!o) throw new ConfigError(`aliases: ${a} isn't an https origin, like https://old.example.com`);
+    if (o === url) throw new ConfigError(`aliases: ${o} is already the url`);
+    return o;
+  });
+  const twice = out.find((o, i) => out.indexOf(o) !== i);
+  if (twice) throw new ConfigError(`aliases: ${twice} is there twice`);
+  return out;
+}
+
 /** A breakaway.config.json's contents, checked and with its defaults filled in. Throws ConfigError naming what's wrong. */
 export function parseInstall(raw) {
   if (!raw || typeof raw !== 'object' || Array.isArray(raw)) throw new ConfigError('the config is a JSON object');
@@ -88,6 +109,7 @@ export function parseInstall(raw) {
       'url is where the board answers, an https origin like https://tasks.example.com, or null for workers.dev',
     );
   c.url = c.url === null ? null : origin(c.url);
+  c.aliases = aliasesOf(c.aliases, c.url);
   if (!PREFIX.test(c.secretsPrefix))
     throw new ConfigError('secretsPrefix is uppercase and ends with _, like BREAKAWAY_');
   if (c.secretsStore !== null && !STORE_ID.test(c.secretsStore))
@@ -179,7 +201,9 @@ export function wranglerConfig(config, { local = false, root = '.' } = {}) {
     name: c.worker,
     main: at('src/worker.js'),
     compatibility_date: COMPATIBILITY_DATE,
-    ...(local || !c.url ? {} : { routes: [{ pattern: new URL(c.url).host, custom_domain: true }] }),
+    ...(local || !c.url
+      ? {}
+      : { routes: [c.url, ...c.aliases].map((u) => ({ pattern: new URL(u).host, custom_domain: true })) }),
     workers_dev: !local && !c.url,
     preview_urls: false,
     ...(local

package/template/README.md

@@ -55,3 +55,5 @@ With `wrangler deploy`:
 ## Change the install
 
 Edit `breakaway.config.json` and merge it: Deploy runs on every push to `main`.
+
+To move the board to a new address without a gap, add the new one under `aliases` first, so both answer; then swap `url` and the alias; and remove the alias once nothing uses the old address. breakaway's [docs/tasks.md](https://github.com/TheAnarchoX/breakaway/blob/main/docs/tasks.md#moving-to-a-new-address) has the whole list of what names the address.