agmsg-cloud 0.1.0-rc.8 → 0.1.1

package/dist/src/vault-placement.js

@@ -0,0 +1,94 @@
+/**
+ * What happened to each entry the placement loop tried to place, and how that
+ * is reported.
+ *
+ * Kept as data and rendered separately for the same reason `vault-inventory.ts`
+ * is: the rule worth checking is about the REPORT, not about the spawning, and
+ * a test should be able to read the report without a process.
+ *
+ * The rule, from #342a and unchanged: **a partial result is never printed as a
+ * success.** Anything not placed is listed, with its id.
+ */
+/**
+ * @param inVault every entry the vault holds, NOT just the ones that were
+ * attempted. `placed 1 of 1` printed under `2 team backup(s) in it` is a
+ * partial result reading as a complete one — the denominator has to be the
+ * thing the person came here to get back.
+ */
+export function placementLines(results, inVault) {
+    if (results.length === 0)
+        return [];
+    const lines = [];
+    const placed = results.filter((r) => r.kind === 'placed');
+    const already = results.filter((r) => r.kind === 'already');
+    const done = placed.length + already.length;
+    lines.push(`placed ${done} of ${inVault} team backup(s) in the vault`);
+    if (results.length < inVault) {
+        // Said here as well as in the inventory above, because this line is the one
+        // a person reads as the outcome, and a denominator it cannot account for
+        // invites the reading that the rest simply worked.
+        lines.push(`  (${inVault - results.length} of those could not be attempted — see the list above)`);
+    }
+    for (const r of placed)
+        lines.push(`  ${r.team}  (${r.teamId})`);
+    for (const r of already) {
+        lines.push(`  ${r.team}  (${r.teamId})  — was already here, its key was re-imported`);
+    }
+    const stuck = results.filter((r) => r.kind === 'name-held' ||
+        r.kind === 'refused' ||
+        r.kind === 'locked' ||
+        r.kind === 'disconnected' ||
+        r.kind === 'wrong-instance' ||
+        r.kind === 'server-unknown');
+    if (stuck.length === 0)
+        return lines;
+    lines.push(`${stuck.length} could not be placed:`);
+    for (const r of stuck) {
+        if (r.kind === 'disconnected') {
+            lines.push(`  ${r.team}  (${r.teamId})`);
+            lines.push('    already on this machine, but its connection to the server was ended,');
+            lines.push('    so its key cannot be imported. Reconnect it, then run this again.');
+        }
+        else if (r.kind === 'server-unknown') {
+            lines.push(`  ${r.team}  (${r.teamId})`);
+            lines.push('    which server this machine reaches could not be established, so nothing');
+            lines.push('    was pulled — placing it without knowing would risk taking the wrong one:');
+            lines.push(`    ${r.why}`);
+        }
+        else if (r.kind === 'wrong-instance') {
+            lines.push(`  ${r.team}  (${r.teamId})`);
+            lines.push('    this backup is from a different server than the one this machine');
+            lines.push('    reaches, so nothing was pulled and nothing was written:');
+            lines.push(`      the backup's server:  ${r.wanted}`);
+            lines.push(`      the server reached:   ${r.got}`);
+            lines.push('    no local team was created, so the name is still free for the right one.');
+        }
+        else if (r.kind === 'name-held') {
+            // The facts, and no route. Both ids so the two teams can be told apart,
+            // and "nothing was changed" said outright: the worst reading of a bare
+            // refusal is that something was half-done.
+            lines.push(`  ${r.team}  (${r.teamId})`);
+            lines.push(`    a different team on this machine already holds the name '${r.team}'`);
+            // BOTH halves of both identities. The two can share a team id and differ
+            // only by server, and a report printing one uuid twice says "different
+            // team" while showing nothing that differs.
+            lines.push(`      the local one:  ${r.localTeamId}  on ${r.localInstance}`);
+            lines.push(`      the backup:     ${r.teamId}  on ${r.instance}`);
+            lines.push('    nothing local was changed. Placing it needs that name to be free.');
+        }
+        else if (r.kind === 'locked') {
+            lines.push(`  ${r.team}  (${r.teamId})`);
+            lines.push('    it is on this machine but still locked — its key did not import:');
+            for (const said of r.said.split('\n'))
+                if (said.trim() !== '')
+                    lines.push(`    ${said}`);
+        }
+        else {
+            lines.push(`  ${r.team}  (${r.teamId})`);
+            for (const said of r.said.split('\n'))
+                if (said.trim() !== '')
+                    lines.push(`    ${said}`);
+        }
+    }
+    return lines;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "agmsg-cloud",
-  "version": "0.1.0-rc.8",
+  "version": "0.1.1",
   "description": "Companion CLI for the agmsg cloud service: connect a team, join from another machine, and back up its keys.",
   "license": "UNLICENSED",
   "type": "module",
@@ -12,7 +12,8 @@
   },
   "files": [
     "dist/src",
-    "!dist/src/**/*.map"
+    "dist/scripts",
+    "!dist/**/*.map"
   ],
   "repository": {
     "type": "git",