@jskit-ai/shell-web 0.1.89 → 0.1.90

package/package.descriptor.mjs

@@ -1,7 +1,7 @@
 export default Object.freeze({
   packageVersion: 1,
   packageId: "@jskit-ai/shell-web",
-  version: "0.1.89",
+  version: "0.1.90",
   kind: "runtime",
   description: "Web shell layout runtime with outlet-based placement contributions.",
   dependsOn: [],
@@ -300,7 +300,7 @@ export default Object.freeze({
     dependencies: {
       runtime: {
         "@mdi/js": "^7.4.47",
-        "@jskit-ai/kernel": "0.1.90"
+        "@jskit-ai/kernel": "0.1.91"
       },
       dev: {}
     },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jskit-ai/shell-web",
-  "version": "0.1.89",
+  "version": "0.1.90",
   "type": "module",
   "scripts": {
     "test": "node --test"
@@ -28,7 +28,7 @@
   },
   "dependencies": {
     "@mdi/js": "^7.4.47",
-    "@jskit-ai/kernel": "0.1.90"
+    "@jskit-ai/kernel": "0.1.91"
   },
   "peerDependencies": {
     "pinia": "^3.0.4",

package/src/client/requestRecovery/runtime.js

@@ -31,6 +31,11 @@ const CANCELED_REQUEST_ERROR_CODES = Object.freeze(new Set([
   "ERR_CANCELED"
 ]));
 
+const SAFE_REQUEST_RECOVERY_METHODS = Object.freeze(new Set([
+  "GET",
+  "HEAD"
+]));
+
 function normalizeText(value, fallback = "") {
   const normalized = String(value || "").trim();
   return normalized || String(fallback || "").trim();
@@ -142,6 +147,56 @@ function resolveQueryRecoveryLabel(query = null) {
   );
 }
 
+function resolveQueryRecoverySource(query = null) {
+  const meta = resolveQueryMeta(query);
+  const jskitMeta = isRecord(meta.jskit) ? meta.jskit : {};
+
+  return normalizeText(
+    jskitMeta.requestRecoverySource ||
+      meta.jskitRequestRecoverySource ||
+      meta.requestRecoverySource,
+    "shell-web.request-recovery.query"
+  );
+}
+
+function resolveQueryRecoveryDedupeKey(query = null, fallback = "") {
+  const meta = resolveQueryMeta(query);
+  const jskitMeta = isRecord(meta.jskit) ? meta.jskit : {};
+
+  return normalizeText(
+    jskitMeta.requestRecoveryDedupeKey ||
+      meta.jskitRequestRecoveryDedupeKey ||
+      meta.requestRecoveryDedupeKey,
+    fallback
+  );
+}
+
+function resolveQueryRecoveryDedupeWindowMs(query = null) {
+  const meta = resolveQueryMeta(query);
+  const jskitMeta = isRecord(meta.jskit) ? meta.jskit : {};
+  const value =
+    jskitMeta.requestRecoveryDedupeWindowMs ??
+      meta.jskitRequestRecoveryDedupeWindowMs ??
+      meta.requestRecoveryDedupeWindowMs;
+
+  return Number.isFinite(Number(value)) ? Math.max(0, Number(value)) : null;
+}
+
+function resolveQueryRecoveryMethod(query = null) {
+  const meta = resolveQueryMeta(query);
+  const jskitMeta = isRecord(meta.jskit) ? meta.jskit : {};
+
+  return normalizeText(
+    jskitMeta.requestRecoveryMethod ||
+      meta.jskitRequestRecoveryMethod ||
+      meta.requestRecoveryMethod
+  ).toUpperCase();
+}
+
+function isSafeQueryRecoveryMethod(query = null) {
+  return SAFE_REQUEST_RECOVERY_METHODS.has(resolveQueryRecoveryMethod(query));
+}
+
 function isActiveQuery(query = null) {
   if (typeof query?.isActive === "function") {
     return Boolean(query.isActive());
@@ -223,7 +278,12 @@ function installRecoverableQueryObserver({
   const reportedErrorUpdateByQueryHash = new Map();
 
   function inspectQuery(query = null) {
-    if (!query || isRequestRecoveryDisabled(query) || !isActiveQuery(query)) {
+    if (
+      !query ||
+      isRequestRecoveryDisabled(query) ||
+      !isSafeQueryRecoveryMethod(query) ||
+      !isActiveQuery(query)
+    ) {
       return;
     }
 
@@ -241,12 +301,19 @@ function installRecoverableQueryObserver({
     }
     reportedErrorUpdateByQueryHash.set(queryHash, reportKey);
 
+    const source = resolveQueryRecoverySource(query);
+    const dedupeKey = resolveQueryRecoveryDedupeKey(
+      query,
+      `shell-web.request-recovery.query.${queryHash}.${errorUpdateCount}`
+    );
+    const dedupeWindowMs = resolveQueryRecoveryDedupeWindowMs(query);
     runtime.report(error, {
       label: resolveQueryRecoveryLabel(query),
       retry: createQueryRetry(queryClient, query),
-      source: "shell-web.request-recovery.query",
+      source,
       stale: query?.state?.data !== undefined,
-      dedupeKey: `shell-web.request-recovery.query.${queryHash}.${errorUpdateCount}`
+      dedupeKey,
+      ...(dedupeWindowMs !== null ? { dedupeWindowMs } : {})
     });
   }
 

package/test/provider.test.js

@@ -371,13 +371,21 @@ test("shell request recovery reports active query transport failures with retry
     const provider = new ShellWebClientProvider();
     provider.register(app);
     await provider.boot(app);
+    const reportEvents = [];
+    app.make("runtime.web-error.client").subscribe((event = {}) => {
+      reportEvents.push(event);
+    });
 
     const failedQuery = {
       queryHash: "[\"project-access\"]",
       queryKey: ["project-access"],
       meta: {
         jskit: {
-          requestRecoveryLabel: "Project access"
+          requestRecoveryLabel: "Project access",
+          requestRecoverySource: "project-access.panel",
+          requestRecoveryDedupeKey: "project-access",
+          requestRecoveryMethod: "GET",
+          requestRecoveryDedupeWindowMs: 100
         }
       },
       state: {
@@ -403,6 +411,9 @@ test("shell request recovery reports active query transport failures with retry
       "Project access could not reach the server or network. Check the connection and try again."
     );
     assert.equal(state.channels.banner[0].action.label, "Retry");
+    assert.equal(state.channels.banner[0].dedupeKey, "project-access");
+    assert.equal(reportEvents[0]?.result?.event?.source, "project-access.panel");
+    assert.equal(reportEvents[0]?.result?.decision?.dedupeWindowMs, 100);
 
     await state.channels.banner[0].action.handler();
     assert.equal(refetchCalls.length, 1);
@@ -417,6 +428,55 @@ test("shell request recovery reports active query transport failures with retry
   });
 });
 
+test("shell request recovery ignores query transport failures without a safe read method", async () => {
+  await withFetchStub({ surfaceAccess: {} }, async () => {
+    const queryCache = createQueryCacheDouble();
+    const queryClient = {
+      getQueryCache() {
+        return queryCache;
+      },
+      async refetchQueries() {}
+    };
+    const app = createAppDouble({ queryClient });
+    const provider = new ShellWebClientProvider();
+    provider.register(app);
+    await provider.boot(app);
+
+    for (const [queryKey, meta] of [
+      [["unmarked"], {}],
+      [["unsafe"], {
+        jskit: {
+          requestRecoveryMethod: "POST"
+        }
+      }]
+    ]) {
+      queryCache.emit({
+        type: "updated",
+        query: {
+          queryHash: JSON.stringify(queryKey),
+          queryKey,
+          meta,
+          state: {
+            status: "error",
+            fetchStatus: "idle",
+            error: {
+              status: 0,
+              message: "Network request failed."
+            },
+            errorUpdateCount: 1
+          },
+          isActive() {
+            return true;
+          }
+        }
+      });
+    }
+
+    const errorStore = app.make("runtime.web-error.presentation-store.client");
+    assert.equal(errorStore.getState().channels.banner.length, 0);
+  });
+});
+
 test("shell request recovery ignores ordinary active query validation failures", async () => {
   await withFetchStub({ surfaceAccess: {} }, async () => {
     const queryCache = createQueryCacheDouble();
@@ -433,10 +493,15 @@ test("shell request recovery ignores ordinary active query validation failures",
 
     queryCache.emit({
       type: "updated",
-      query: {
-        queryHash: "[\"project-access\"]",
-        queryKey: ["project-access"],
-        state: {
+        query: {
+          queryHash: "[\"project-access\"]",
+          queryKey: ["project-access"],
+          meta: {
+            jskit: {
+              requestRecoveryMethod: "GET"
+            }
+          },
+          state: {
           status: "error",
           fetchStatus: "idle",
           error: {