Fix app store upgrade release note confirmation

Author: ruibaby

src/commands/plugin/__test__/plugin-entry.spec.ts

@@ -1,5 +1,13 @@
 import { afterEach, expect, test, vi } from "vitest";
 
+vi.mock("@inquirer/prompts", () => ({
+  checkbox: vi.fn(),
+  confirm: vi.fn(),
+  input: vi.fn(),
+}));
+
+import { confirm, input } from "@inquirer/prompts";
+
 import { tryRunPluginCommand } from "../index.js";
 
 afterEach(() => {
@@ -10,6 +18,17 @@ function silenceStdout() {
   return vi.spyOn(process.stdout, "write").mockImplementation(() => true);
 }
 
+function setInteractiveTerminal() {
+  Object.defineProperty(process.stdin, "isTTY", {
+    value: true,
+    configurable: true,
+  });
+  Object.defineProperty(process.stdout, "isTTY", {
+    value: true,
+    configurable: true,
+  });
+}
+
 function createPluginRuntimeMock(clients: Record<string, unknown>) {
   return {
     getClientsForOptions: vi.fn().mockResolvedValue({
@@ -318,7 +337,10 @@ test("tryRunPluginCommand dispatches install subcommands from files", async () =
 });
 
 test("tryRunPluginCommand dispatches online upgrade commands", async () => {
-  silenceStdout();
+  const stdoutSpy = silenceStdout();
+  setInteractiveTerminal();
+  vi.mocked(confirm).mockResolvedValue(true);
+  vi.mocked(input).mockResolvedValue("y");
 
   const getPlugin = vi.fn().mockResolvedValue({
     data: {
@@ -424,6 +446,9 @@ test("tryRunPluginCommand dispatches online upgrade commands", async () => {
 
   expect(axiosCreateSpy).toHaveBeenCalledOnce();
   expect(getPlugin).toHaveBeenCalledWith({ name: "demo-plugin" });
+  expect(stdoutSpy).toHaveBeenCalledWith(
+    "- demo-plugin: https://www.halo.run/store/apps/demo-plugin-app/releases/release-1\n",
+  );
   expect(upgradePluginFromUri).toHaveBeenCalledWith({
     name: "demo-plugin",
     upgradeFromUriRequest: {
@@ -432,6 +457,117 @@ test("tryRunPluginCommand dispatches online upgrade commands", async () => {
   });
 });
 
+test("tryRunPluginCommand skips release note confirmation with --yes", async () => {
+  vi.clearAllMocks();
+  silenceStdout();
+
+  const getPlugin = vi.fn().mockResolvedValue({
+    data: {
+      metadata: {
+        name: "demo-plugin",
+        annotations: {
+          "store.halo.run/app-id": "demo-plugin-app",
+        },
+      },
+    },
+  });
+  const upgradePluginFromUri = vi.fn().mockResolvedValue({
+    data: {
+      metadata: {
+        name: "demo-plugin",
+      },
+    },
+  });
+  const runtimeMock = createPluginRuntimeMock({
+    core: {
+      plugin: {
+        plugin: {
+          getPlugin,
+        },
+      },
+      secret: {
+        getSecret: vi.fn().mockResolvedValue({
+          data: {
+            stringData: {},
+          },
+        }),
+      },
+    },
+    console: {
+      plugin: {
+        plugin: {
+          upgradePluginFromUri,
+        },
+      },
+    },
+    axios: {
+      get: vi.fn().mockImplementation((url: string) => {
+        if (url === "/actuator/info") {
+          return Promise.resolve({
+            data: {
+              build: {
+                name: "halo",
+                version: "2.20.0",
+              },
+            },
+          });
+        }
+
+        return Promise.reject(new Error(`Unexpected axios.get call: ${url}`));
+      }),
+    },
+  });
+
+  vi.spyOn((await import("axios")).default, "create").mockReturnValue({
+    get: vi.fn().mockImplementation((url: string) => {
+      if (url === "/apis/api.store.halo.run/v1alpha1/applications/demo-plugin-app") {
+        return Promise.resolve({
+          data: {
+            latestRelease: {
+              release: {
+                metadata: {
+                  name: "release-1",
+                },
+              },
+              assets: [
+                {
+                  metadata: {
+                    name: "plugin.jar",
+                  },
+                },
+              ],
+            },
+          },
+        });
+      }
+
+      if (
+        url ===
+        "/apis/api.store.halo.run/v1alpha1/applications/demo-plugin-app/releases/release-1/download/plugin.jar"
+      ) {
+        return Promise.resolve({
+          data: {
+            url: "https://downloads.example.com/demo-plugin.jar",
+          },
+        });
+      }
+
+      return Promise.reject(new Error(`Unexpected app store get call: ${url}`));
+    }),
+  } as never);
+
+  await expect(
+    tryRunPluginCommand(
+      ["plugin", "upgrade", "demo-plugin", "--online", "--yes", "--json"],
+      runtimeMock as never,
+    ),
+  ).resolves.toBe(true);
+
+  expect(confirm).not.toHaveBeenCalled();
+  expect(input).not.toHaveBeenCalled();
+  expect(upgradePluginFromUri).toHaveBeenCalledOnce();
+});
+
 test("tryRunPluginCommand rejects unknown install flags during parsing", async () => {
   silenceStdout();
 
@@ -496,7 +632,9 @@ test("tryRunPluginCommand prints empty batch upgrade results in json mode", asyn
 });
 
 test("tryRunPluginCommand upgrades batch plugin candidates in json mode", async () => {
-  silenceStdout();
+  const stdoutSpy = silenceStdout();
+  setInteractiveTerminal();
+  vi.mocked(confirm).mockResolvedValue(true);
 
   const listPlugins = vi.fn().mockResolvedValue({
     data: {
@@ -644,4 +782,7 @@ test("tryRunPluginCommand upgrades batch plugin candidates in json mode", async
       uri: "https://downloads.example.com/demo-plugin.jar",
     },
   });
+  expect(stdoutSpy).toHaveBeenCalledWith(
+    "- Demo Plugin: https://www.halo.run/store/apps/demo-plugin-app/releases/release-1\n",
+  );
 });

src/commands/plugin/index.ts

@@ -8,8 +8,9 @@ import cac, { type CAC } from "cac";
 import ora, { type Ora } from "ora";
 
 import {
+  confirmAppStoreReleaseReview,
   createAppStoreClient,
-  resolveLatestAppStoreDownloadUrl,
+  resolveLatestAppStoreRelease,
   resolvePluginAppStoreAppId,
   resolvePluginUpdates,
   resolvePluginUpgradeSource,
@@ -41,6 +42,7 @@ interface PluginMutationOptions extends PluginCommandOptions {
 }
 
 interface BatchUpgradeResult {
+  cancelled?: boolean;
   upgraded: Array<{ name: string; fromVersion?: string; toVersion: string }>;
   skipped: Array<{
     name: string;
@@ -51,6 +53,13 @@ interface BatchUpgradeResult {
   failed: Array<{ name: string; error: string }>;
 }
 
+interface PreparedPluginUpgradeCandidate {
+  plugin: Plugin;
+  update: { latestVersion: string; compatible: boolean };
+  releaseUrl: string;
+  downloadUrl: string;
+}
+
 interface BatchUpgradeProgressEvent {
   type:
     | "checking"
@@ -350,9 +359,56 @@ async function upgradeAllPlugins(
     });
   }
 
-  onProgress?.({ type: "queued", count: selectedCandidates.length });
-
+  const preparedCandidates: PreparedPluginUpgradeCandidate[] = [];
   for (const item of selectedCandidates) {
+    try {
+      const appId = resolvePluginAppStoreAppId(item.plugin);
+      const release = await resolveLatestAppStoreRelease(appStoreClient, appId);
+      preparedCandidates.push({
+        ...item,
+        releaseUrl: release.releaseUrl,
+        downloadUrl: release.downloadUrl,
+      });
+    } catch (error) {
+      result.failed.push({
+        name: item.plugin.metadata.name,
+        error: error instanceof Error ? error.message : "Unknown upgrade error.",
+      });
+
+      onProgress?.({
+        type: "failed",
+        name: item.plugin.metadata.name,
+        fromVersion: item.plugin.spec.version,
+        toVersion: item.update.latestVersion,
+        error: error instanceof Error ? error.message : "Unknown upgrade error.",
+      });
+    }
+  }
+
+  if (preparedCandidates.length === 0) {
+    return result;
+  }
+
+  const confirmed = await confirmAppStoreReleaseReview(
+    {
+      commandPath: "halo plugin upgrade --all",
+      actionLabel: "upgrading App Store plugins",
+      items: preparedCandidates.map((item) => ({
+        name: item.plugin.spec.displayName ?? item.plugin.metadata.name,
+        releaseUrl: item.releaseUrl,
+      })),
+    },
+    options,
+  );
+
+  if (!confirmed) {
+    result.cancelled = true;
+    return result;
+  }
+
+  onProgress?.({ type: "queued", count: preparedCandidates.length });
+
+  for (const item of preparedCandidates) {
     const { plugin, update } = item;
 
     if (!update.compatible) {
@@ -380,11 +436,9 @@ async function upgradeAllPlugins(
         toVersion: update.latestVersion,
       });
 
-      const appId = resolvePluginAppStoreAppId(plugin);
-      const downloadUrl = await resolveLatestAppStoreDownloadUrl(appStoreClient, appId);
       await clients.console.plugin.plugin.upgradePluginFromUri({
         name: plugin.metadata.name,
-        upgradeFromUriRequest: { uri: downloadUrl },
+        upgradeFromUriRequest: { uri: item.downloadUrl },
       });
 
       onProgress?.({
@@ -475,6 +529,13 @@ function reportBatchUpgradeProgress(
 }
 
 function printBatchUpgradeResult(result: BatchUpgradeResult, json = false): void {
+  if (result.cancelled) {
+    if (!json) {
+      process.stdout.write("Cancelled upgrading App Store plugins.\n");
+    }
+    return;
+  }
+
   if (json) {
     printJson(result);
     return;
@@ -644,7 +705,6 @@ function buildPluginCli(runtime: RuntimeContext): CAC {
     .option("-y, --yes", "Skip selection and upgrade all compatible plugins")
     .action(async (name: string | undefined, options: PluginCommandOptions) => {
       const spinner = createSpinnerReporter(options.json);
-      const { clients } = await runtime.getClientsForOptions(options);
       const target = resolvePluginUpgradeTarget(name, options);
 
       if (target.mode === "all") {
@@ -661,6 +721,7 @@ function buildPluginCli(runtime: RuntimeContext): CAC {
         return;
       }
 
+      const { clients } = await runtime.getClientsForOptions(options);
       const source = resolvePluginUpgradeSource(options);
 
       let response;
@@ -685,12 +746,32 @@ function buildPluginCli(runtime: RuntimeContext): CAC {
           const pluginResponse = await clients.core.plugin.plugin.getPlugin({ name: target.name });
           const appId = resolvePluginAppStoreAppId(pluginResponse.data);
           const appStoreClient = await createAppStoreClient(clients);
-          const downloadUrl = await resolveLatestAppStoreDownloadUrl(appStoreClient, appId);
+          const release = await resolveLatestAppStoreRelease(appStoreClient, appId);
 
-          spinner.update(`Upgrading plugin ${target.name} from Halo App Store...`);
+          spinner.stop();
+          const confirmed = await confirmAppStoreReleaseReview(
+            {
+              commandPath: "halo plugin upgrade",
+              actionLabel: `upgrading plugin ${target.name}`,
+              items: [
+                {
+                  name: pluginResponse.data.spec?.displayName ?? target.name,
+                  releaseUrl: release.releaseUrl,
+                },
+              ],
+              requireTypedYes: true,
+            },
+            options,
+          );
+
+          if (!confirmed) {
+            return;
+          }
+
+          spinner.start(`Upgrading plugin ${target.name} from Halo App Store...`);
           response = await clients.console.plugin.plugin.upgradePluginFromUri({
             name: target.name,
-            upgradeFromUriRequest: { uri: downloadUrl },
+            upgradeFromUriRequest: { uri: release.downloadUrl },
           });
           spinner.succeed(`Upgraded plugin ${target.name}.`);
         }