drupal-mcp-connector 2.7.2 → 2.7.4

package/src/tools/moderation.js

@@ -20,6 +20,25 @@ import {
   resolveSecurityConfig, assertReadAllowed, assertWriteAllowed, assertPublishAllowed,
   redactCanonicalEntity,
 } from "../lib/security.js";
+import { collectEntities } from "../lib/reports-support.js";
+
+/** Cap for the client-side scan when JSON:API cannot filter the field. */
+const SAMPLE_CAP = 500;
+
+/**
+ * Drupal core JSON:API cannot filter on the computed `moderation_state`
+ * field. The error is a 500 whose detail is `'moderation_state' not found`
+ * (#162). jsonapi_extras (or a similar alias) can make the field filterable;
+ * those sites never hit this.
+ *
+ * @param {unknown} err
+ * @returns {boolean}
+ */
+export function isUnfilterableModerationState(err) {
+  const msg = String(err?.message || "");
+  if (!/moderation_state/i.test(msg)) return false;
+  return /not found/i.test(msg) || /not filterable/i.test(msg) || /invalid filter/i.test(msg);
+}
 
 /** Read a node's moderation_state from a canonical entity, tolerating shapes. */
 function moderationStateOf(entity) {
@@ -49,6 +68,12 @@ async function setModerationState({ site: siteName, type, id, state }) {
 
 /**
  * List nodes of a type in a given moderation state, paged + redacted.
+ *
+ * Stock JSON:API cannot filter on the computed `moderation_state` field
+ * (#162). When the site accepts the filter (jsonapi_extras or similar) the
+ * result is exact. Otherwise we scan a bounded recent set and filter
+ * client-side rather than surfacing Drupal's 500 as a transient error.
+ *
  * @param {object} args - { site?, type, state, limit?, offset? }.
  */
 async function contentByModerationState({ site: siteName, type, state, limit = 20, offset = 0 }) {
@@ -56,14 +81,68 @@ async function contentByModerationState({ site: siteName, type, state, limit = 2
   const sec = resolveSecurityConfig(site);
   assertReadAllowed(sec, "node", type);
   const backend = await resolveBackend(site);
-  const res = await backend.listEntities({
-    entityType: "node", bundle: type,
-    filters: [{ field: "moderation_state", op: "eq", value: state }],
-    sort: [{ field: "changed", dir: "desc" }],
-    page: { limit, offset },
-  });
-  const nodes = res.entities.map((e) => redactCanonicalEntity(e, sec, "node"));
-  return { type, state, total: res.page?.total ?? nodes.length, approximate: res.approximate ?? false, offset, nextOffset: offset + nodes.length, nodes };
+  const sort = [{ field: "changed", dir: "desc" }];
+  const canFilter = typeof backend.capabilities === "function"
+    ? Boolean(backend.capabilities()?.filter)
+    : true;
+
+  if (canFilter) {
+    try {
+      const res = await backend.listEntities({
+        entityType: "node", bundle: type,
+        filters: [{ field: "moderation_state", op: "eq", value: state }],
+        sort,
+        page: { limit, offset },
+      });
+      const nodes = res.entities.map((e) => redactCanonicalEntity(e, sec, "node"));
+      return {
+        type, state, source: "filter",
+        total: res.page?.total ?? nodes.length,
+        approximate: res.approximate ?? false,
+        offset, nextOffset: offset + nodes.length, nodes,
+      };
+    } catch (err) {
+      if (!isUnfilterableModerationState(err)) throw err;
+    }
+  }
+
+  const scanned = await collectEntities(
+    backend,
+    { entityType: "node", bundle: type, sort },
+    SAMPLE_CAP,
+  );
+  const wanted = String(state).toLowerCase();
+  const matches = [];
+  let sawState = false;
+  for (const entity of scanned) {
+    const got = moderationStateOf(entity);
+    if (got === null || got === undefined) continue;
+    sawState = true;
+    if (String(got).toLowerCase() === wanted) matches.push(entity);
+  }
+  if (!sawState && scanned.length > 0) {
+    return {
+      type, state, unavailable: true, source: "sampled", scanned: scanned.length,
+      reason:
+        "moderation_state is not filterable over JSON:API on this site (it is a " +
+        "computed field) and no sampled entity exposed the field. Enable " +
+        "content_moderation on the bundle, or expose a filterable alias " +
+        "(jsonapi_extras).",
+    };
+  }
+  const page = matches.slice(offset, offset + limit);
+  return {
+    type, state, source: "sampled",
+    approximate: scanned.length >= SAMPLE_CAP,
+    scanned: scanned.length,
+    total: matches.length,
+    offset, nextOffset: offset + page.length,
+    nodes: page.map((e) => redactCanonicalEntity(e, sec, "node")),
+    note:
+      "Stock JSON:API cannot filter on moderation_state (computed field). " +
+      "Results are a client-side sample of recent nodes, not a complete list. " +
+      "A filterable alias (jsonapi_extras) makes this exact.",
+  };
 }
 
 /**
@@ -101,7 +180,7 @@ export const definitions = [
   },
   {
     name: "drupal_content_by_moderation_state",
-    description: "List nodes of a content type currently in a given moderation state (e.g. what is in 'draft' or 'needs_review').",
+    description: "List nodes of a content type currently in a given moderation state (e.g. what is in 'draft' or 'needs_review'). Stock JSON:API cannot filter the computed moderation_state field; when the site rejects that filter the tool samples recent nodes client-side and marks the result approximate, instead of returning Drupal's 500.",
     inputSchema: {
       type: "object", required: ["type", "state"],
       properties: {