@atlaskit/rovo-triggers 10.36.0 → 10.38.0

package/CHANGELOG.md

@@ -1,5 +1,33 @@
 # @atlaskit/rovo-triggers
 
+## 10.38.0
+
+### Minor Changes
+
+- [`2124250692aba`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/2124250692aba) -
+  ASIMO-5048: report what the extension context bridge's inbound relay policy decided for each
+  payload a product publishes, so a refusal is observable instead of silent.
+
+  `ExtensionContextBridgeHost` takes a new optional `onRelayDecision` callback, with its contract on
+  a new `./extension-context-bridge/analytics` entrypoint, and the serializer now returns a
+  discriminated result so a refusal names its reason. `ChatOpenerSubscriber` wires the callback to
+  the analytics client it already holds, emitting a `rovoExtensionBridgePayload evaluated`
+  operational event into the host product's stream.
+
+  Product to extension direction only. Deduplicated to one report per distinct outcome per mount,
+  and only active while `rovo-ext_context_bridge` is on.
+
+### Patch Changes
+
+- Updated dependencies
+
+## 10.37.0
+
+### Minor Changes
+
+- [`8181d8d675df9`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/8181d8d675df9) -
+  Add chat entry points for the JSM RFS activation Test now flow.
+
 ## 10.36.0
 
 ### Minor Changes

package/dist/cjs/chat-entry-point.js

@@ -5,6 +5,8 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.ChatEntryPoint = void 0;
 var ChatEntryPoint = exports.ChatEntryPoint = /*#__PURE__*/function (ChatEntryPoint) {
+  ChatEntryPoint["JSM_ROVO_SETTINGS_TEST_NOW"] = "jsmRovoSettingsTestNow";
+  ChatEntryPoint["JSM_PORTAL_SETTINGS_TEST_NOW"] = "jsmPortalSettingsTestNow";
   ChatEntryPoint["SEARCH_PAGE_AUTO_OPEN_CHAT"] = "searchPageAutoOpenChat";
   ChatEntryPoint["SEARCH_PAGE_SUMMARIZE_IN_CHAT"] = "searchPageSummarizeInChat";
   return ChatEntryPoint;

package/dist/cjs/common/utils/extension-context-bridge/ExtensionContextBridgeClient.js

@@ -161,12 +161,12 @@ var ExtensionContextBridgeClient = exports.ExtensionContextBridgeClient = functi
     if (!(0, _policy.shouldRelayToProduct)(payload.type)) {
       return;
     }
-    var serialized = (0, _registry.serializePayload)(payload);
-    if (!serialized) {
+    var result = (0, _registry.serializePayload)(payload);
+    if (!result.ok) {
       return;
     }
     try {
-      activeTransport.send((0, _defineProperty2.default)((0, _defineProperty2.default)((0, _defineProperty2.default)({}, _constants.BRIDGE_MESSAGE_MARKER, true), "direction", _constants.BRIDGE_TO_PRODUCT), "payload", serialized));
+      activeTransport.send((0, _defineProperty2.default)((0, _defineProperty2.default)((0, _defineProperty2.default)({}, _constants.BRIDGE_MESSAGE_MARKER, true), "direction", _constants.BRIDGE_TO_PRODUCT), "payload", result.payload));
     } catch (_unused3) {
       // Never let bridging break the chat iframe.
     }

package/dist/cjs/common/utils/extension-context-bridge/ExtensionContextBridgeHost.js

@@ -6,10 +6,10 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.ExtensionContextBridgeHost = void 0;
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
-var _typeof2 = _interopRequireDefault(require("@babel/runtime/helpers/typeof"));
 var _react = require("react");
 var _fg = require("@atlaskit/platform-feature-flags/fg");
 var _main = require("../../../main");
+var _analytics = require("./analytics");
 var _constants = require("./constants");
 var _policy = require("./policy");
 var _registry = require("./registry");
@@ -40,14 +40,8 @@ var stampProductContentId = function stampProductContentId(serialized, targetCon
  * else is keyed by payload type, of which there is one live instance at a time.
  */
 var getContextSlotKey = function getContextSlotKey(payload) {
-  if (payload.type === 'set-message-context') {
-    var data = payload.data;
-    var contextKey = (0, _typeof2.default)(data) === 'object' && data !== null && 'contextKey' in data ? data.contextKey : undefined;
-    if (typeof contextKey === 'string') {
-      return "".concat(payload.type, ":").concat(contextKey);
-    }
-  }
-  return payload.type;
+  var contextKey = (0, _analytics.getContextKey)(payload);
+  return contextKey === undefined ? payload.type : "".concat(payload.type, ":").concat(contextKey);
 };
 /**
  * Product-window half of the bridge. Observes the `ai-mate` bus and mirrors allowlisted context out
@@ -59,7 +53,8 @@ var getContextSlotKey = function getContextSlotKey(payload) {
 var ExtensionContextBridgeHost = exports.ExtensionContextBridgeHost = function ExtensionContextBridgeHost(_ref) {
   var transport = _ref.transport,
     getContentId = _ref.getContentId,
-    isAiEnabled = _ref.isAiEnabled;
+    isAiEnabled = _ref.isAiEnabled,
+    onRelayDecision = _ref.onRelayDecision;
   // Self-gated (not taken from the consumer) so this cannot mount by mistake wherever
   // `ChatOpenerSubscriber` renders. Matches `BRIDGE_FEATURE_GATE` in `./constants`.
   var active = (0, _fg.fg)('rovo-ext_context_bridge');
@@ -87,6 +82,9 @@ var ExtensionContextBridgeHost = exports.ExtensionContextBridgeHost = function E
    */
   var lastRelayedRef = (0, _react.useRef)(new Map());
 
+  /** Reported decisions, so a per-keystroke payload yields one event rather than thousands. */
+  var reportedDecisionsRef = (0, _react.useRef)(new Set());
+
   // Answers `request-context` from the chat, which cannot observe context published before it
   // mounted. Products such as Jira publish once per navigation, so without this a chat opened after
   // the page settled would describe the wrong view — or none at all.
@@ -124,17 +122,32 @@ var ExtensionContextBridgeHost = exports.ExtensionContextBridgeHost = function E
     if (isAiEnabled === false) {
       return;
     }
-    // Loop guard.
+    // Loop guard. Not reported: our own echo, not a decision about the product.
     if (payload.interactionSource === _constants.BRIDGE_SOURCE) {
       return;
     }
-    if ((0, _policy.getInboundDecision)(payload.type) !== 'allow') {
+    var report = function report(decision) {
+      (0, _analytics.reportRelayDecision)(reportedDecisionsRef.current, onRelayDecision, {
+        payloadType: payload.type,
+        contextKey: (0, _analytics.getContextKey)(payload),
+        relayed: decision === 'allow',
+        decision: decision,
+        publisherSource: payload.source,
+        payloadProduct: payload.product
+      });
+    };
+    var inboundDecision = (0, _policy.getInboundDecision)(payload.type);
+    if (inboundDecision !== 'allow') {
+      report(inboundDecision);
       return;
     }
-    var serialized = (0, _registry.serializePayload)(payload);
-    if (!serialized) {
+    var result = (0, _registry.serializePayload)(payload);
+    if (!result.ok) {
+      report(result.reason);
       return;
     }
+    report('allow');
+    var serialized = result.payload;
     stampProductContentId(serialized, getContentId === null || getContentId === void 0 ? void 0 : getContentId());
     var message = (0, _defineProperty2.default)((0, _defineProperty2.default)((0, _defineProperty2.default)({}, _constants.BRIDGE_MESSAGE_MARKER, true), "direction", _constants.BRIDGE_TO_EXTENSION), "payload", serialized);
     // Keyed by context slot, not by message, so a re-publish replaces rather than accumulates.

package/dist/cjs/common/utils/extension-context-bridge/analytics.js

@@ -0,0 +1,87 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.reportRelayDecision = exports.getContextKey = void 0;
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+var _typeof2 = _interopRequireDefault(require("@babel/runtime/helpers/typeof"));
+function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
+function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { (0, _defineProperty2.default)(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
+/**
+ * Inbound relay decision reporting: what the product asked the bridge to relay, and what the policy
+ * in `./policy` / `./registry` decided. Every refusal is otherwise silent, so the allowlist can only
+ * be widened from data with this.
+ *
+ * Product → extension only, hence no direction field. The outbound allowlist has one entry and is
+ * owned by the chat, so products cannot drift into it.
+ *
+ * Consumer-supplied callback rather than an event fired here, for the same reason as the Host's
+ * `getContentId`: this package has no analytics dependency.
+ */
+
+/**
+ * Why `./registry` refused to serialise a payload. Kept distinct because the fixes differ:
+ * `context-key-not-allowlisted` is a list we can widen, the rest are publisher-side shape problems.
+ */
+
+/** Every outcome the bridge can reach for a payload it was asked to relay. */
+
+/** A slot identifier by contract, capped in case a publisher ever interpolates an id into one. */
+var MAX_CONTEXT_KEY_LENGTH = 80;
+
+/**
+ * (payload types × decisions) is finite and far below this; the cap is for `contextKey`, which is
+ * not. A publisher generating keys would otherwise grow the dedupe set for the life of the page.
+ */
+var MAX_REPORTED_DECISIONS = 50;
+/**
+ * The context slot a `set-message-context` payload addresses. Shape-checked rather than cast: runs
+ * against the raw bus payload, the serialized form, and types carrying neither. The Host also keys
+ * its replay map on this.
+ */
+var getContextKey = exports.getContextKey = function getContextKey(payload) {
+  if (payload.type !== 'set-message-context') {
+    return undefined;
+  }
+  var data = payload.data;
+  var contextKey = (0, _typeof2.default)(data) === 'object' && data !== null && 'contextKey' in data ? data.contextKey : undefined;
+  return typeof contextKey === 'string' ? contextKey : undefined;
+};
+
+/** Identity of a decision for deduplication purposes. */
+var getDecisionKey = function getDecisionKey(_ref) {
+  var payloadType = _ref.payloadType,
+    contextKey = _ref.contextKey,
+    decision = _ref.decision;
+  return "".concat(payloadType, "|").concat(contextKey !== null && contextKey !== void 0 ? contextKey : '', "|").concat(decision);
+};
+
+/**
+ * Report a relay decision at most once per distinct outcome. Deduplicated because the bridge sees
+ * the whole product bus and `editor-context-payload` recurs on roughly every keystroke; which keys
+ * exist and how they were decided is the question, not how often each recurred.
+ *
+ * `seen` is caller-owned (a ref in the Host), so the window is one mount. Never throws.
+ */
+var reportRelayDecision = exports.reportRelayDecision = function reportRelayDecision(seen, onRelayDecision, decision) {
+  var _decision$contextKey;
+  if (!onRelayDecision) {
+    return;
+  }
+  var truncatedContextKey = (_decision$contextKey = decision.contextKey) === null || _decision$contextKey === void 0 ? void 0 : _decision$contextKey.slice(0, MAX_CONTEXT_KEY_LENGTH);
+  var reportable = _objectSpread(_objectSpread({}, decision), {}, {
+    contextKey: truncatedContextKey
+  });
+  var key = getDecisionKey(reportable);
+  if (seen.has(key) || seen.size >= MAX_REPORTED_DECISIONS) {
+    return;
+  }
+  seen.add(key);
+  try {
+    onRelayDecision(reportable);
+  } catch (_unused) {
+    // Reporting is observability, never a reason for the relay to fail.
+  }
+};

package/dist/cjs/common/utils/extension-context-bridge/registry.js

@@ -11,6 +11,18 @@ var _constants = require("./constants");
 var _policy = require("./policy");
 function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
 function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { (0, _defineProperty2.default)(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
+/**
+ * Outcome of serialising a payload for the wire. A bare `| null` would collapse five distinct
+ * refusals into one, notably a non-allowlisted context key versus a merge-style publisher, which
+ * need different fixes. `reason` is reported as analytics (see `./analytics`).
+ */
+
+var dropped = function dropped(reason) {
+  return {
+    ok: false,
+    reason: reason
+  };
+};
 var base = function base(payload) {
   return {
     type: payload.type,
@@ -50,33 +62,36 @@ var SHIMS = {
     serialize: function serialize(payload) {
       var data = payload.data;
       if (!data || typeof data.setContext !== 'function') {
-        return null;
+        return dropped('missing-set-context');
       }
       // Checked before `setContext` runs, so a non-allowlisted key never invokes product code.
       if (!(0, _policy.isRelayableContextKey)(data.contextKey)) {
-        return null;
+        return dropped('context-key-not-allowlisted');
       }
       var value;
       try {
         value = data.setContext((0, _defineProperty2.default)({}, MERGE_PROBE_KEY, true));
       } catch (_unused) {
-        return null;
+        return dropped('set-context-threw');
       }
       // Sentinel survived: merge-style, cannot be resolved to a standalone value.
       if ((0, _typeof2.default)(value) === 'object' && value !== null && MERGE_PROBE_KEY in value) {
-        return null;
+        return dropped('merge-style-publisher');
       }
       try {
         JSON.stringify(value);
       } catch (_unused2) {
-        return null;
+        return dropped('not-serializable');
       }
-      return _objectSpread(_objectSpread({}, base(payload)), {}, {
-        data: {
-          contextKey: data.contextKey,
-          value: value
-        }
-      });
+      return {
+        ok: true,
+        payload: _objectSpread(_objectSpread({}, base(payload)), {}, {
+          data: {
+            contextKey: data.contextKey,
+            value: value
+          }
+        })
+      };
     },
     deserialize: function deserialize(serialized) {
       var _serialized$source;
@@ -115,11 +130,14 @@ var serializePayload = exports.serializePayload = function serializePayload(payl
   try {
     data = rawData === undefined ? undefined : JSON.parse(JSON.stringify(rawData));
   } catch (_unused3) {
-    return null;
+    return dropped('not-serializable');
   }
-  return _objectSpread(_objectSpread({}, base(payload)), {}, {
-    data: data
-  });
+  return {
+    ok: true,
+    payload: _objectSpread(_objectSpread({}, base(payload)), {}, {
+      data: data
+    })
+  };
 };
 
 /** Reconstruct a payload from the wire, stamping the loop-guard sentinel. */

package/dist/es2019/chat-entry-point.js

@@ -1,4 +1,6 @@
 export let ChatEntryPoint = /*#__PURE__*/function (ChatEntryPoint) {
+  ChatEntryPoint["JSM_ROVO_SETTINGS_TEST_NOW"] = "jsmRovoSettingsTestNow";
+  ChatEntryPoint["JSM_PORTAL_SETTINGS_TEST_NOW"] = "jsmPortalSettingsTestNow";
   ChatEntryPoint["SEARCH_PAGE_AUTO_OPEN_CHAT"] = "searchPageAutoOpenChat";
   ChatEntryPoint["SEARCH_PAGE_SUMMARIZE_IN_CHAT"] = "searchPageSummarizeInChat";
   return ChatEntryPoint;

package/dist/es2019/common/utils/extension-context-bridge/ExtensionContextBridgeClient.js

@@ -159,15 +159,15 @@ export const ExtensionContextBridgeClient = ({
     if (!shouldRelayToProduct(payload.type)) {
       return;
     }
-    const serialized = serializePayload(payload);
-    if (!serialized) {
+    const result = serializePayload(payload);
+    if (!result.ok) {
       return;
     }
     try {
       activeTransport.send({
         [BRIDGE_MESSAGE_MARKER]: true,
         direction: BRIDGE_TO_PRODUCT,
-        payload: serialized
+        payload: result.payload
       });
     } catch {
       // Never let bridging break the chat iframe.

package/dist/es2019/common/utils/extension-context-bridge/ExtensionContextBridgeHost.js

@@ -1,6 +1,7 @@
 import { useEffect, useMemo, useRef } from 'react';
 import { fg } from '@atlaskit/platform-feature-flags/fg';
 import { useSubscribeAll } from '../../../main';
+import { getContextKey, reportRelayDecision } from './analytics';
 import { BRIDGE_CONTROL_REQUEST_CONTEXT, BRIDGE_MESSAGE_MARKER, BRIDGE_SOURCE, BRIDGE_TO_EXTENSION, BRIDGE_TO_PRODUCT } from './constants';
 import { getInboundDecision } from './policy';
 import { serializePayload } from './registry';
@@ -31,14 +32,8 @@ const stampProductContentId = (serialized, targetContentId) => {
  * else is keyed by payload type, of which there is one live instance at a time.
  */
 const getContextSlotKey = payload => {
-  if (payload.type === 'set-message-context') {
-    const data = payload.data;
-    const contextKey = typeof data === 'object' && data !== null && 'contextKey' in data ? data.contextKey : undefined;
-    if (typeof contextKey === 'string') {
-      return `${payload.type}:${contextKey}`;
-    }
-  }
-  return payload.type;
+  const contextKey = getContextKey(payload);
+  return contextKey === undefined ? payload.type : `${payload.type}:${contextKey}`;
 };
 /**
  * Product-window half of the bridge. Observes the `ai-mate` bus and mirrors allowlisted context out
@@ -50,7 +45,8 @@ const getContextSlotKey = payload => {
 export const ExtensionContextBridgeHost = ({
   transport,
   getContentId,
-  isAiEnabled
+  isAiEnabled,
+  onRelayDecision
 }) => {
   // Self-gated (not taken from the consumer) so this cannot mount by mistake wherever
   // `ChatOpenerSubscriber` renders. Matches `BRIDGE_FEATURE_GATE` in `./constants`.
@@ -79,6 +75,9 @@ export const ExtensionContextBridgeHost = ({
    */
   const lastRelayedRef = useRef(new Map());
 
+  /** Reported decisions, so a per-keystroke payload yields one event rather than thousands. */
+  const reportedDecisionsRef = useRef(new Set());
+
   // Answers `request-context` from the chat, which cannot observe context published before it
   // mounted. Products such as Jira publish once per navigation, so without this a chat opened after
   // the page settled would describe the wrong view — or none at all.
@@ -116,17 +115,32 @@ export const ExtensionContextBridgeHost = ({
     if (isAiEnabled === false) {
       return;
     }
-    // Loop guard.
+    // Loop guard. Not reported: our own echo, not a decision about the product.
     if (payload.interactionSource === BRIDGE_SOURCE) {
       return;
     }
-    if (getInboundDecision(payload.type) !== 'allow') {
+    const report = decision => {
+      reportRelayDecision(reportedDecisionsRef.current, onRelayDecision, {
+        payloadType: payload.type,
+        contextKey: getContextKey(payload),
+        relayed: decision === 'allow',
+        decision,
+        publisherSource: payload.source,
+        payloadProduct: payload.product
+      });
+    };
+    const inboundDecision = getInboundDecision(payload.type);
+    if (inboundDecision !== 'allow') {
+      report(inboundDecision);
       return;
     }
-    const serialized = serializePayload(payload);
-    if (!serialized) {
+    const result = serializePayload(payload);
+    if (!result.ok) {
+      report(result.reason);
       return;
     }
+    report('allow');
+    const serialized = result.payload;
     stampProductContentId(serialized, getContentId === null || getContentId === void 0 ? void 0 : getContentId());
     const message = {
       [BRIDGE_MESSAGE_MARKER]: true,

package/dist/es2019/common/utils/extension-context-bridge/analytics.js

@@ -0,0 +1,76 @@
+/**
+ * Inbound relay decision reporting: what the product asked the bridge to relay, and what the policy
+ * in `./policy` / `./registry` decided. Every refusal is otherwise silent, so the allowlist can only
+ * be widened from data with this.
+ *
+ * Product → extension only, hence no direction field. The outbound allowlist has one entry and is
+ * owned by the chat, so products cannot drift into it.
+ *
+ * Consumer-supplied callback rather than an event fired here, for the same reason as the Host's
+ * `getContentId`: this package has no analytics dependency.
+ */
+
+/**
+ * Why `./registry` refused to serialise a payload. Kept distinct because the fixes differ:
+ * `context-key-not-allowlisted` is a list we can widen, the rest are publisher-side shape problems.
+ */
+
+/** Every outcome the bridge can reach for a payload it was asked to relay. */
+
+/** A slot identifier by contract, capped in case a publisher ever interpolates an id into one. */
+const MAX_CONTEXT_KEY_LENGTH = 80;
+
+/**
+ * (payload types × decisions) is finite and far below this; the cap is for `contextKey`, which is
+ * not. A publisher generating keys would otherwise grow the dedupe set for the life of the page.
+ */
+const MAX_REPORTED_DECISIONS = 50;
+/**
+ * The context slot a `set-message-context` payload addresses. Shape-checked rather than cast: runs
+ * against the raw bus payload, the serialized form, and types carrying neither. The Host also keys
+ * its replay map on this.
+ */
+export const getContextKey = payload => {
+  if (payload.type !== 'set-message-context') {
+    return undefined;
+  }
+  const data = payload.data;
+  const contextKey = typeof data === 'object' && data !== null && 'contextKey' in data ? data.contextKey : undefined;
+  return typeof contextKey === 'string' ? contextKey : undefined;
+};
+
+/** Identity of a decision for deduplication purposes. */
+const getDecisionKey = ({
+  payloadType,
+  contextKey,
+  decision
+}) => `${payloadType}|${contextKey !== null && contextKey !== void 0 ? contextKey : ''}|${decision}`;
+
+/**
+ * Report a relay decision at most once per distinct outcome. Deduplicated because the bridge sees
+ * the whole product bus and `editor-context-payload` recurs on roughly every keystroke; which keys
+ * exist and how they were decided is the question, not how often each recurred.
+ *
+ * `seen` is caller-owned (a ref in the Host), so the window is one mount. Never throws.
+ */
+export const reportRelayDecision = (seen, onRelayDecision, decision) => {
+  var _decision$contextKey;
+  if (!onRelayDecision) {
+    return;
+  }
+  const truncatedContextKey = (_decision$contextKey = decision.contextKey) === null || _decision$contextKey === void 0 ? void 0 : _decision$contextKey.slice(0, MAX_CONTEXT_KEY_LENGTH);
+  const reportable = {
+    ...decision,
+    contextKey: truncatedContextKey
+  };
+  const key = getDecisionKey(reportable);
+  if (seen.has(key) || seen.size >= MAX_REPORTED_DECISIONS) {
+    return;
+  }
+  seen.add(key);
+  try {
+    onRelayDecision(reportable);
+  } catch {
+    // Reporting is observability, never a reason for the relay to fail.
+  }
+};

package/dist/es2019/common/utils/extension-context-bridge/registry.js

@@ -1,5 +1,16 @@
 import { BRIDGE_SOURCE } from './constants';
 import { isRelayableContextKey } from './policy';
+
+/**
+ * Outcome of serialising a payload for the wire. A bare `| null` would collapse five distinct
+ * refusals into one, notably a non-allowlisted context key versus a merge-style publisher, which
+ * need different fixes. `reason` is reported as analytics (see `./analytics`).
+ */
+
+const dropped = reason => ({
+  ok: false,
+  reason
+});
 const base = payload => ({
   type: payload.type,
   source: payload.source,
@@ -36,11 +47,11 @@ const SHIMS = {
     serialize: payload => {
       const data = payload.data;
       if (!data || typeof data.setContext !== 'function') {
-        return null;
+        return dropped('missing-set-context');
       }
       // Checked before `setContext` runs, so a non-allowlisted key never invokes product code.
       if (!isRelayableContextKey(data.contextKey)) {
-        return null;
+        return dropped('context-key-not-allowlisted');
       }
       let value;
       try {
@@ -48,22 +59,25 @@ const SHIMS = {
           [MERGE_PROBE_KEY]: true
         });
       } catch {
-        return null;
+        return dropped('set-context-threw');
       }
       // Sentinel survived: merge-style, cannot be resolved to a standalone value.
       if (typeof value === 'object' && value !== null && MERGE_PROBE_KEY in value) {
-        return null;
+        return dropped('merge-style-publisher');
       }
       try {
         JSON.stringify(value);
       } catch {
-        return null;
+        return dropped('not-serializable');
       }
       return {
-        ...base(payload),
-        data: {
-          contextKey: data.contextKey,
-          value
+        ok: true,
+        payload: {
+          ...base(payload),
+          data: {
+            contextKey: data.contextKey,
+            value
+          }
         }
       };
     },
@@ -100,11 +114,14 @@ export const serializePayload = payload => {
   try {
     data = rawData === undefined ? undefined : JSON.parse(JSON.stringify(rawData));
   } catch {
-    return null;
+    return dropped('not-serializable');
   }
   return {
-    ...base(payload),
-    data
+    ok: true,
+    payload: {
+      ...base(payload),
+      data
+    }
   };
 };
 

package/dist/esm/chat-entry-point.js

@@ -1,4 +1,6 @@
 export var ChatEntryPoint = /*#__PURE__*/function (ChatEntryPoint) {
+  ChatEntryPoint["JSM_ROVO_SETTINGS_TEST_NOW"] = "jsmRovoSettingsTestNow";
+  ChatEntryPoint["JSM_PORTAL_SETTINGS_TEST_NOW"] = "jsmPortalSettingsTestNow";
   ChatEntryPoint["SEARCH_PAGE_AUTO_OPEN_CHAT"] = "searchPageAutoOpenChat";
   ChatEntryPoint["SEARCH_PAGE_SUMMARIZE_IN_CHAT"] = "searchPageSummarizeInChat";
   return ChatEntryPoint;

package/dist/esm/common/utils/extension-context-bridge/ExtensionContextBridgeClient.js

@@ -155,12 +155,12 @@ export var ExtensionContextBridgeClient = function ExtensionContextBridgeClient(
     if (!shouldRelayToProduct(payload.type)) {
       return;
     }
-    var serialized = serializePayload(payload);
-    if (!serialized) {
+    var result = serializePayload(payload);
+    if (!result.ok) {
       return;
     }
     try {
-      activeTransport.send(_defineProperty(_defineProperty(_defineProperty({}, BRIDGE_MESSAGE_MARKER, true), "direction", BRIDGE_TO_PRODUCT), "payload", serialized));
+      activeTransport.send(_defineProperty(_defineProperty(_defineProperty({}, BRIDGE_MESSAGE_MARKER, true), "direction", BRIDGE_TO_PRODUCT), "payload", result.payload));
     } catch (_unused3) {
       // Never let bridging break the chat iframe.
     }

package/dist/esm/common/utils/extension-context-bridge/ExtensionContextBridgeHost.js

@@ -1,8 +1,8 @@
 import _defineProperty from "@babel/runtime/helpers/defineProperty";
-import _typeof from "@babel/runtime/helpers/typeof";
 import { useEffect, useMemo, useRef } from 'react';
 import { fg } from '@atlaskit/platform-feature-flags/fg';
 import { useSubscribeAll } from '../../../main';
+import { getContextKey, reportRelayDecision } from './analytics';
 import { BRIDGE_CONTROL_REQUEST_CONTEXT, BRIDGE_MESSAGE_MARKER, BRIDGE_SOURCE, BRIDGE_TO_EXTENSION, BRIDGE_TO_PRODUCT } from './constants';
 import { getInboundDecision } from './policy';
 import { serializePayload } from './registry';
@@ -33,14 +33,8 @@ var stampProductContentId = function stampProductContentId(serialized, targetCon
  * else is keyed by payload type, of which there is one live instance at a time.
  */
 var getContextSlotKey = function getContextSlotKey(payload) {
-  if (payload.type === 'set-message-context') {
-    var data = payload.data;
-    var contextKey = _typeof(data) === 'object' && data !== null && 'contextKey' in data ? data.contextKey : undefined;
-    if (typeof contextKey === 'string') {
-      return "".concat(payload.type, ":").concat(contextKey);
-    }
-  }
-  return payload.type;
+  var contextKey = getContextKey(payload);
+  return contextKey === undefined ? payload.type : "".concat(payload.type, ":").concat(contextKey);
 };
 /**
  * Product-window half of the bridge. Observes the `ai-mate` bus and mirrors allowlisted context out
@@ -52,7 +46,8 @@ var getContextSlotKey = function getContextSlotKey(payload) {
 export var ExtensionContextBridgeHost = function ExtensionContextBridgeHost(_ref) {
   var transport = _ref.transport,
     getContentId = _ref.getContentId,
-    isAiEnabled = _ref.isAiEnabled;
+    isAiEnabled = _ref.isAiEnabled,
+    onRelayDecision = _ref.onRelayDecision;
   // Self-gated (not taken from the consumer) so this cannot mount by mistake wherever
   // `ChatOpenerSubscriber` renders. Matches `BRIDGE_FEATURE_GATE` in `./constants`.
   var active = fg('rovo-ext_context_bridge');
@@ -80,6 +75,9 @@ export var ExtensionContextBridgeHost = function ExtensionContextBridgeHost(_ref
    */
   var lastRelayedRef = useRef(new Map());
 
+  /** Reported decisions, so a per-keystroke payload yields one event rather than thousands. */
+  var reportedDecisionsRef = useRef(new Set());
+
   // Answers `request-context` from the chat, which cannot observe context published before it
   // mounted. Products such as Jira publish once per navigation, so without this a chat opened after
   // the page settled would describe the wrong view — or none at all.
@@ -117,17 +115,32 @@ export var ExtensionContextBridgeHost = function ExtensionContextBridgeHost(_ref
     if (isAiEnabled === false) {
       return;
     }
-    // Loop guard.
+    // Loop guard. Not reported: our own echo, not a decision about the product.
     if (payload.interactionSource === BRIDGE_SOURCE) {
       return;
     }
-    if (getInboundDecision(payload.type) !== 'allow') {
+    var report = function report(decision) {
+      reportRelayDecision(reportedDecisionsRef.current, onRelayDecision, {
+        payloadType: payload.type,
+        contextKey: getContextKey(payload),
+        relayed: decision === 'allow',
+        decision: decision,
+        publisherSource: payload.source,
+        payloadProduct: payload.product
+      });
+    };
+    var inboundDecision = getInboundDecision(payload.type);
+    if (inboundDecision !== 'allow') {
+      report(inboundDecision);
       return;
     }
-    var serialized = serializePayload(payload);
-    if (!serialized) {
+    var result = serializePayload(payload);
+    if (!result.ok) {
+      report(result.reason);
       return;
     }
+    report('allow');
+    var serialized = result.payload;
     stampProductContentId(serialized, getContentId === null || getContentId === void 0 ? void 0 : getContentId());
     var message = _defineProperty(_defineProperty(_defineProperty({}, BRIDGE_MESSAGE_MARKER, true), "direction", BRIDGE_TO_EXTENSION), "payload", serialized);
     // Keyed by context slot, not by message, so a re-publish replaces rather than accumulates.

package/dist/esm/common/utils/extension-context-bridge/analytics.js

@@ -0,0 +1,80 @@
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
+import _typeof from "@babel/runtime/helpers/typeof";
+function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
+function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
+/**
+ * Inbound relay decision reporting: what the product asked the bridge to relay, and what the policy
+ * in `./policy` / `./registry` decided. Every refusal is otherwise silent, so the allowlist can only
+ * be widened from data with this.
+ *
+ * Product → extension only, hence no direction field. The outbound allowlist has one entry and is
+ * owned by the chat, so products cannot drift into it.
+ *
+ * Consumer-supplied callback rather than an event fired here, for the same reason as the Host's
+ * `getContentId`: this package has no analytics dependency.
+ */
+
+/**
+ * Why `./registry` refused to serialise a payload. Kept distinct because the fixes differ:
+ * `context-key-not-allowlisted` is a list we can widen, the rest are publisher-side shape problems.
+ */
+
+/** Every outcome the bridge can reach for a payload it was asked to relay. */
+
+/** A slot identifier by contract, capped in case a publisher ever interpolates an id into one. */
+var MAX_CONTEXT_KEY_LENGTH = 80;
+
+/**
+ * (payload types × decisions) is finite and far below this; the cap is for `contextKey`, which is
+ * not. A publisher generating keys would otherwise grow the dedupe set for the life of the page.
+ */
+var MAX_REPORTED_DECISIONS = 50;
+/**
+ * The context slot a `set-message-context` payload addresses. Shape-checked rather than cast: runs
+ * against the raw bus payload, the serialized form, and types carrying neither. The Host also keys
+ * its replay map on this.
+ */
+export var getContextKey = function getContextKey(payload) {
+  if (payload.type !== 'set-message-context') {
+    return undefined;
+  }
+  var data = payload.data;
+  var contextKey = _typeof(data) === 'object' && data !== null && 'contextKey' in data ? data.contextKey : undefined;
+  return typeof contextKey === 'string' ? contextKey : undefined;
+};
+
+/** Identity of a decision for deduplication purposes. */
+var getDecisionKey = function getDecisionKey(_ref) {
+  var payloadType = _ref.payloadType,
+    contextKey = _ref.contextKey,
+    decision = _ref.decision;
+  return "".concat(payloadType, "|").concat(contextKey !== null && contextKey !== void 0 ? contextKey : '', "|").concat(decision);
+};
+
+/**
+ * Report a relay decision at most once per distinct outcome. Deduplicated because the bridge sees
+ * the whole product bus and `editor-context-payload` recurs on roughly every keystroke; which keys
+ * exist and how they were decided is the question, not how often each recurred.
+ *
+ * `seen` is caller-owned (a ref in the Host), so the window is one mount. Never throws.
+ */
+export var reportRelayDecision = function reportRelayDecision(seen, onRelayDecision, decision) {
+  var _decision$contextKey;
+  if (!onRelayDecision) {
+    return;
+  }
+  var truncatedContextKey = (_decision$contextKey = decision.contextKey) === null || _decision$contextKey === void 0 ? void 0 : _decision$contextKey.slice(0, MAX_CONTEXT_KEY_LENGTH);
+  var reportable = _objectSpread(_objectSpread({}, decision), {}, {
+    contextKey: truncatedContextKey
+  });
+  var key = getDecisionKey(reportable);
+  if (seen.has(key) || seen.size >= MAX_REPORTED_DECISIONS) {
+    return;
+  }
+  seen.add(key);
+  try {
+    onRelayDecision(reportable);
+  } catch (_unused) {
+    // Reporting is observability, never a reason for the relay to fail.
+  }
+};

package/dist/esm/common/utils/extension-context-bridge/registry.js

@@ -4,6 +4,19 @@ function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbol
 function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
 import { BRIDGE_SOURCE } from './constants';
 import { isRelayableContextKey } from './policy';
+
+/**
+ * Outcome of serialising a payload for the wire. A bare `| null` would collapse five distinct
+ * refusals into one, notably a non-allowlisted context key versus a merge-style publisher, which
+ * need different fixes. `reason` is reported as analytics (see `./analytics`).
+ */
+
+var dropped = function dropped(reason) {
+  return {
+    ok: false,
+    reason: reason
+  };
+};
 var base = function base(payload) {
   return {
     type: payload.type,
@@ -43,33 +56,36 @@ var SHIMS = {
     serialize: function serialize(payload) {
       var data = payload.data;
       if (!data || typeof data.setContext !== 'function') {
-        return null;
+        return dropped('missing-set-context');
       }
       // Checked before `setContext` runs, so a non-allowlisted key never invokes product code.
       if (!isRelayableContextKey(data.contextKey)) {
-        return null;
+        return dropped('context-key-not-allowlisted');
       }
       var value;
       try {
         value = data.setContext(_defineProperty({}, MERGE_PROBE_KEY, true));
       } catch (_unused) {
-        return null;
+        return dropped('set-context-threw');
       }
       // Sentinel survived: merge-style, cannot be resolved to a standalone value.
       if (_typeof(value) === 'object' && value !== null && MERGE_PROBE_KEY in value) {
-        return null;
+        return dropped('merge-style-publisher');
       }
       try {
         JSON.stringify(value);
       } catch (_unused2) {
-        return null;
+        return dropped('not-serializable');
       }
-      return _objectSpread(_objectSpread({}, base(payload)), {}, {
-        data: {
-          contextKey: data.contextKey,
-          value: value
-        }
-      });
+      return {
+        ok: true,
+        payload: _objectSpread(_objectSpread({}, base(payload)), {}, {
+          data: {
+            contextKey: data.contextKey,
+            value: value
+          }
+        })
+      };
     },
     deserialize: function deserialize(serialized) {
       var _serialized$source;
@@ -108,11 +124,14 @@ export var serializePayload = function serializePayload(payload) {
   try {
     data = rawData === undefined ? undefined : JSON.parse(JSON.stringify(rawData));
   } catch (_unused3) {
-    return null;
+    return dropped('not-serializable');
   }
-  return _objectSpread(_objectSpread({}, base(payload)), {}, {
-    data: data
-  });
+  return {
+    ok: true,
+    payload: _objectSpread(_objectSpread({}, base(payload)), {}, {
+      data: data
+    })
+  };
 };
 
 /** Reconstruct a payload from the wire, stamping the loop-guard sentinel. */

package/dist/types/chat-entry-point.d.ts

@@ -1,4 +1,6 @@
 export declare enum ChatEntryPoint {
+    JSM_ROVO_SETTINGS_TEST_NOW = "jsmRovoSettingsTestNow",
+    JSM_PORTAL_SETTINGS_TEST_NOW = "jsmPortalSettingsTestNow",
     SEARCH_PAGE_AUTO_OPEN_CHAT = "searchPageAutoOpenChat",
     SEARCH_PAGE_SUMMARIZE_IN_CHAT = "searchPageSummarizeInChat"
 }

package/dist/types/common/utils/extension-context-bridge/ExtensionContextBridgeHost.d.ts

@@ -1,3 +1,4 @@
+import { type OnBridgeRelayDecision } from './analytics';
 import { type Transport } from './transport';
 type Props = {
     /** Override the transport (tests). Defaults to same-window `postMessage`. */
@@ -14,6 +15,12 @@ type Props = {
      * mount passes it explicitly, so that only covers bespoke embeddings.
      */
     isAiEnabled?: boolean;
+    /**
+     * Called with what the relay policy decided for each payload this product published, at most once
+     * per distinct outcome per mount. Consumer-supplied because the analytics client lives outside
+     * this package. Omitted, nothing is reported. See `./analytics`.
+     */
+    onRelayDecision?: OnBridgeRelayDecision;
 };
 /**
  * Product-window half of the bridge. Observes the `ai-mate` bus and mirrors allowlisted context out
@@ -22,5 +29,5 @@ type Props = {
  * The reverse direction is handled by the sibling `RovoPostMessagePubsubListener` in
  * `ChatOpenerSubscriber`, not here. Headless; mounts at product root via `ChatOpenerSubscriber`.
  */
-export declare const ExtensionContextBridgeHost: ({ transport, getContentId, isAiEnabled, }: Props) => null;
+export declare const ExtensionContextBridgeHost: ({ transport, getContentId, isAiEnabled, onRelayDecision, }: Props) => null;
 export {};

package/dist/types/common/utils/extension-context-bridge/analytics.d.ts

@@ -0,0 +1,55 @@
+/**
+ * Inbound relay decision reporting: what the product asked the bridge to relay, and what the policy
+ * in `./policy` / `./registry` decided. Every refusal is otherwise silent, so the allowlist can only
+ * be widened from data with this.
+ *
+ * Product → extension only, hence no direction field. The outbound allowlist has one entry and is
+ * owned by the chat, so products cannot drift into it.
+ *
+ * Consumer-supplied callback rather than an event fired here, for the same reason as the Host's
+ * `getContentId`: this package has no analytics dependency.
+ */
+import { type Payload } from '../../../types';
+import { type InboundDecision } from './policy';
+/**
+ * Why `./registry` refused to serialise a payload. Kept distinct because the fixes differ:
+ * `context-key-not-allowlisted` is a list we can widen, the rest are publisher-side shape problems.
+ */
+export type SerializationDropReason = 'missing-set-context' | 'context-key-not-allowlisted' | 'set-context-threw' | 'merge-style-publisher' | 'not-serializable';
+/** Every outcome the bridge can reach for a payload it was asked to relay. */
+export type RelayDecision = InboundDecision | SerializationDropReason;
+export type BridgeRelayDecision = {
+    /** The bus payload type, e.g. `editor-context-payload`. */
+    payloadType: Payload['type'];
+    /** Context slot for `set-message-context`; undefined for every other type. */
+    contextKey?: string;
+    /**
+     * Whether the policy admitted it. Reported before the `postMessage`, so a throwing transport
+     * reads as a broken channel elsewhere rather than a policy refusal here.
+     */
+    relayed: boolean;
+    /** Why, in the policy's own vocabulary. */
+    decision: RelayDecision;
+    /** The surface that published it, i.e. the payload's own `source`. */
+    publisherSource?: string;
+    /** The product the publisher stamped on the payload. */
+    payloadProduct?: string;
+};
+export type OnBridgeRelayDecision = (decision: BridgeRelayDecision) => void;
+/**
+ * The context slot a `set-message-context` payload addresses. Shape-checked rather than cast: runs
+ * against the raw bus payload, the serialized form, and types carrying neither. The Host also keys
+ * its replay map on this.
+ */
+export declare const getContextKey: (payload: {
+    type: string;
+    data?: unknown;
+}) => string | undefined;
+/**
+ * Report a relay decision at most once per distinct outcome. Deduplicated because the bridge sees
+ * the whole product bus and `editor-context-payload` recurs on roughly every keystroke; which keys
+ * exist and how they were decided is the question, not how often each recurred.
+ *
+ * `seen` is caller-owned (a ref in the Host), so the window is one mount. Never throws.
+ */
+export declare const reportRelayDecision: (seen: Set<string>, onRelayDecision: OnBridgeRelayDecision | undefined, decision: BridgeRelayDecision) => void;

package/dist/types/common/utils/extension-context-bridge/policy.d.ts

@@ -2,9 +2,8 @@ import { type Payload } from '../../../types';
 /** True if a `set-message-context` payload carrying this `contextKey` may cross to the extension. */
 export declare const isRelayableContextKey: (contextKey: string) => boolean;
 /** Why a product-bus payload was or was not relayed. */
-type InboundDecision = 'allow' | 'not-allowlisted' | 'denylisted';
+export type InboundDecision = 'allow' | 'not-allowlisted' | 'denylisted';
 /** Classify a product-bus payload. Relay iff `allow`. */
 export declare const getInboundDecision: (type: Payload['type']) => InboundDecision;
 /** True if a chat-bus payload of this type may be relayed back to the product. */
 export declare const shouldRelayToProduct: (type: Payload['type']) => boolean;
-export {};

package/dist/types/common/utils/extension-context-bridge/registry.d.ts

@@ -1,6 +1,19 @@
 import { type Payload } from '../../../types';
+import { type SerializationDropReason } from './analytics';
 import { type SerializedPayload } from './transport';
+/**
+ * Outcome of serialising a payload for the wire. A bare `| null` would collapse five distinct
+ * refusals into one, notably a non-allowlisted context key versus a merge-style publisher, which
+ * need different fixes. `reason` is reported as analytics (see `./analytics`).
+ */
+export type SerializationResult = {
+    ok: true;
+    payload: SerializedPayload;
+} | {
+    ok: false;
+    reason: SerializationDropReason;
+};
 /** Serialise a payload for the wire, using a shim if one exists, else a generic JSON round-trip. */
-export declare const serializePayload: (payload: Payload) => SerializedPayload | null;
+export declare const serializePayload: (payload: Payload) => SerializationResult;
 /** Reconstruct a payload from the wire, stamping the loop-guard sentinel. */
 export declare const deserializePayload: (serialized: SerializedPayload) => Payload | null;

package/extension-context-bridge/analytics/package.json

@@ -0,0 +1,10 @@
+{
+  "name": "@atlaskit/rovo-triggers/extension-context-bridge/analytics",
+  "main": "../../dist/cjs/common/utils/extension-context-bridge/analytics.js",
+  "module": "../../dist/esm/common/utils/extension-context-bridge/analytics.js",
+  "module:es2019": "../../dist/es2019/common/utils/extension-context-bridge/analytics.js",
+  "sideEffects": [
+    "*.compiled.css"
+  ],
+  "types": "../../dist/types/common/utils/extension-context-bridge/analytics.d.ts"
+}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/rovo-triggers",
-	"version": "10.36.0",
+	"version": "10.38.0",
 	"description": "Provides various trigger events to drive Rovo Chat functionality, such as a publish-subscribe and URL parameter hooks",
 	"author": "Atlassian Pty Ltd",
 	"publishConfig": {
@@ -44,7 +44,7 @@
 		"@atlaskit/primitives": "^22.5.0",
 		"@atlaskit/ssr": "workspace:^",
 		"@atlassian/a11y-jest-testing": "^0.17.0",
-		"@atlassian/conversation-assistant-service-api": "^17.12.0",
+		"@atlassian/conversation-assistant-service-api": "^17.13.0",
 		"@atlassian/feature-flags-test-utils": "^1.3.0",
 		"@atlassian/testing-library": "^0.11.0",
 		"@atlassian/workbench": "workspace:*",