Add a safe TaskNotes contract upgrade workflow

e2e/cloud-connection.spec.ts

@@ -1,5 +1,8 @@
 import type { JsonObject } from "@mdbase-dev/connect";
-import { buildTaskNotesMdbaseResources } from "@tasknotes/model/mdbase";
+import {
+  buildTaskNotesMdbaseResources,
+  TASKNOTES_CONTRACT_DIGEST,
+} from "@tasknotes/model/mdbase";
 import { TASKNOTES_SPEC_VERSION } from "@tasknotes/model/types";
 import { expect, test, type Route } from "@playwright/test";
 
@@ -685,7 +688,7 @@ function collectionDescription() {
         contract_type: "record" as const,
         id: "tasknotes.task",
         version: TASKNOTES_SPEC_VERSION,
-        digest: `sha256:${"0".repeat(64)}`,
+        digest: TASKNOTES_CONTRACT_DIGEST,
         schema: generated.taskSchema,
         binding_schema: generated.bindingSchema,
         implementations: [

package.json

@@ -52,9 +52,9 @@
     "@fullcalendar/list": "6.1.17",
     "@fullcalendar/react": "6.1.17",
     "@fullcalendar/timegrid": "6.1.17",
-    "@mdbase-dev/connect": "0.1.0-beta.23",
-    "@mdbase-dev/connect-protocol": "0.1.0-beta.23",
-    "@mdbase-dev/connect-sync": "0.1.0-beta.23",
+    "@mdbase-dev/connect": "file:vendor/mdbase-dev-connect-0.1.0-beta.27-33890fcd1346.tgz",
+    "@mdbase-dev/connect-protocol": "file:vendor/mdbase-dev-connect-protocol-0.1.0-beta.27-33890fcd1346.tgz",
+    "@mdbase-dev/connect-sync": "file:vendor/mdbase-dev-connect-sync-0.1.0-beta.27-33890fcd1346.tgz",
     "@tasknotes/model": "file:vendor/tasknotes-model-0.3.0-rc.9.tgz",
     "dexie": "4.4.4",
     "firebase": "12.16.0",
@@ -70,7 +70,7 @@
   },
   "devDependencies": {
     "@axe-core/playwright": "^4.12.1",
-    "@callumalpass/mdbase": "file:vendor/callumalpass-mdbase-0.3.0-rc.4.tgz",
+    "@callumalpass/mdbase": "file:vendor/callumalpass-mdbase-0.3.0-rc.4-4f28ea27a15a.tgz",
     "@capacitor/android": "8.4.2",
     "@capacitor/assets": "3.0.5",
     "@capacitor/cli": "8.4.2",
@@ -99,7 +99,9 @@
   },
   "pnpm": {
     "overrides": {
-      "@mdbase-dev/connect-protocol": "0.1.0-beta.23"
+      "@mdbase-dev/connect-protocol": "file:vendor/mdbase-dev-connect-protocol-0.1.0-beta.27-33890fcd1346.tgz",
+      "@mdbase-dev/connect": "file:vendor/mdbase-dev-connect-0.1.0-beta.27-33890fcd1346.tgz",
+      "@mdbase-dev/connect-sync": "file:vendor/mdbase-dev-connect-sync-0.1.0-beta.27-33890fcd1346.tgz"
     }
   }
 }

scripts/cloud-e2e.mjs

@@ -6,7 +6,11 @@ import { tmpdir } from "node:os";
 import { dirname, join, resolve } from "node:path";
 import { promisify } from "node:util";
 
-import { Collection, installTypePack } from "@callumalpass/mdbase";
+import {
+  Collection,
+  applyTypePack,
+  assessTypePack,
+} from "@callumalpass/mdbase";
 import { chromium, expect } from "@playwright/test";
 import { parse } from "yaml";
 
@@ -1482,11 +1486,19 @@ async function provisionedResources(resources, provisions) {
       await writeFile(target, document.document);
     }
     for (const provision of provisions) {
-      const installed = await installTypePack(
-        root,
-        provision.manifest,
-        provision.resources,
-      );
+      const installedBy = "dev.tasknotes.app.cloud-e2e";
+      const assessment = await assessTypePack(root, provision, { installedBy });
+      if (!assessment.valid) {
+        throw new Error(
+          assessment.diagnostics
+            .map((diagnostic) => diagnostic.message)
+            .join("; "),
+        );
+      }
+      const installed = await applyTypePack(root, provision, {
+        installedBy,
+        expectedAssessmentDigest: assessment.result.assessment_digest,
+      });
       if (!installed.valid) {
         throw new Error(
           installed.diagnostics

scripts/tasknotes-manifest.mjs

@@ -1,5 +1,5 @@
 import { buildTaskNotesMdbaseTypePack } from "@tasknotes/model/mdbase";
-import { TASKNOTES_SPEC_VERSION } from "@tasknotes/model/types";
+import { MDBASE_TIMER_FIRED_CONTRACT } from "@mdbase-dev/connect-protocol";
 
 export async function buildTaskNotesManifest({
   appUrl,
@@ -8,6 +8,11 @@ export async function buildTaskNotesManifest({
   resources,
 }) {
   const typePack = await buildTaskNotesMdbaseTypePack(resources);
+  const taskContract = typePack.provides.find(
+    (contract) => contract.id === "tasknotes.task",
+  );
+  if (!taskContract)
+    throw new Error("TaskNotes pack provides no task contract.");
   return {
     manifest_version: 1,
     id: "dev.tasknotes.app",
@@ -19,7 +24,7 @@ export async function buildTaskNotesManifest({
       ...(!webOnly ? ["dev.tasknotes.app://auth/mdbase/callback"] : []),
     ],
     requirements: {
-      contracts: [{ id: "tasknotes.task", version: TASKNOTES_SPEC_VERSION }],
+      contracts: [taskContract],
       access: "full_collection",
       files: {
         actions: ["list", "read", "add", "replace", "move", "delete"],
@@ -33,7 +38,7 @@ export async function buildTaskNotesManifest({
       criteria: [
         {
           id: "task.reminder",
-          event: { id: "mdbase.runtime.timer.fired", version: "1.0.0" },
+          event: MDBASE_TIMER_FIRED_CONTRACT,
           presentation: {
             title: "Task reminder",
             body: "Open TaskNotes to view your task.",

scripts/tasknotes-manifest.test.mjs

@@ -17,7 +17,12 @@ describe("TaskNotes mdbase manifest", () => {
     expect(manifest.notifications.criteria).toEqual([
       {
         id: "task.reminder",
-        event: { id: "mdbase.runtime.timer.fired", version: "1.0.0" },
+        event: {
+          id: "mdbase.runtime.timer.fired",
+          version: "1.0.0",
+          digest:
+            "sha256:41105be7a7abf33b31ced47e1e1965242236e40ccaea286b959b0a8c591f5642",
+        },
         presentation: {
           title: "Task reminder",
           body: "Open TaskNotes to view your task.",
@@ -28,7 +33,11 @@ describe("TaskNotes mdbase manifest", () => {
     expect(manifest.notifications.native_delivery).toBeUndefined();
     expect(JSON.stringify(manifest.notifications)).not.toContain("path");
     expect(manifest.requirements.contracts).toEqual([
-      { id: "tasknotes.task", version: "0.3.0-rc.3" },
+      expect.objectContaining({
+        id: "tasknotes.task",
+        version: "0.3.0-rc.3",
+        digest: expect.stringMatching(/^sha256:[0-9a-f]{64}$/),
+      }),
     ]);
     expect(manifest.requirements.files).toEqual({
       actions: ["list", "read", "add", "replace", "move", "delete"],

scripts/write-manifest.mjs

@@ -1,5 +1,6 @@
 import { mkdir, writeFile } from "node:fs/promises";
 import { resolve } from "node:path";
+import { format } from "prettier";
 
 import { buildTaskNotesManifest } from "./tasknotes-manifest.mjs";
 import { buildAppTaskNotesResources } from "./tasknotes-resources.mjs";
@@ -31,7 +32,7 @@ const manifest = await buildTaskNotesManifest({
   resources,
 });
 
-const serialized = `${JSON.stringify(manifest, null, 2)}\n`;
+const serialized = await format(JSON.stringify(manifest), { parser: "json" });
 await Promise.all(
   targets.map(async (target) => {
     await mkdir(resolve(target, ".."), { recursive: true });

src/app/definition-review-dialog.test.tsx

@@ -0,0 +1,60 @@
+import { fireEvent, render, screen } from "@testing-library/react";
+
+import { DefinitionReviewDialog } from "./definition-review-dialog";
+
+describe("DefinitionReviewDialog", () => {
+  it("names the managed files and explains the portable receipt before adoption", () => {
+    const decide = vi.fn();
+    render(
+      <DefinitionReviewDialog
+        decide={decide}
+        review={{
+          kind: "adoption",
+          request: {
+            packId: "tasknotes.task",
+            desiredVersion: "0.3.0-rc.9",
+            message: "TaskNotes found older unmanaged contract definitions.",
+            resources: [
+              {
+                path: "_contracts/tasknotes.task.md",
+                currentDigest: `sha256:${"1".repeat(64)}`,
+                desiredDigest: `sha256:${"2".repeat(64)}`,
+              },
+            ],
+          },
+        }}
+      />,
+    );
+
+    expect(
+      screen.getByRole("alertdialog", {
+        name: "Let TaskNotes manage these definitions?",
+      }),
+    ).toBeVisible();
+    expect(screen.getByText("_contracts/tasknotes.task.md")).toBeVisible();
+    fireEvent.click(screen.getByText("What “manage” means"));
+    expect(screen.getByText(/mdbase\.lock\.yaml/)).toBeVisible();
+    fireEvent.click(screen.getByRole("button", { name: "Adopt and update" }));
+    expect(decide).toHaveBeenCalledWith(true);
+  });
+
+  it("keeps cancellation focused by default and supports Escape", () => {
+    const decide = vi.fn();
+    render(
+      <DefinitionReviewDialog
+        decide={decide}
+        review={{
+          kind: "managed-upgrade",
+          request: {
+            typePath: "_types/task.md",
+            message: "The generated task definition can be updated.",
+          },
+        }}
+      />,
+    );
+
+    expect(screen.getByRole("button", { name: "Not now" })).toHaveFocus();
+    fireEvent.keyDown(document, { key: "Escape" });
+    expect(decide).toHaveBeenCalledWith(false);
+  });
+});