@atlaskit/editor-plugin-autocomplete 4.0.1 → 4.0.3

package/CHANGELOG.md

@@ -1,5 +1,24 @@
 # @atlaskit/editor-plugin-autocomplete
 
+## 4.0.3
+
+### Patch Changes
+
+- [`9869d944172b6`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/9869d944172b6) -
+  Instrument the local (LocalLLM) slow-lane client with the existing `slow-lane-fetch` UFO
+  experience, tagged with an `isLocalLLM` flag (matching `load-vectors`/`load-vocabulary`) so
+  on-device inference latency and success-rate feed the same FE Reliability SLO as the network
+  slow-lane fetch. The `isLocalLLM` flag is now also emitted on the abort path of both the local and
+  network clients.
+
+## 4.0.2
+
+### Patch Changes
+
+- [`56263a9d5bb6d`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/56263a9d5bb6d) -
+  Gate editor autocomplete to English locales so suggestions and model loading are disabled for
+  non-English users.
+
 ## 4.0.1
 
 ### Patch Changes

package/dist/cjs/analytics/ufo.js

@@ -7,7 +7,8 @@ Object.defineProperty(exports, "__esModule", {
 exports.succeedExp = exports.startExp = exports.failExp = exports.abortExp = exports.EXPERIENCE_NAME = void 0;
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
 var _ufo = require("@atlaskit/ufo");
-/**
+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; } /**
  * UFO experience tracking helpers for `@atlaskit/editor-plugin-autocomplete`.
  *
  * Pattern follows `packages/linking-platform/smart-card/src/state/analytics/ufoExperiences.ts`
@@ -19,7 +20,6 @@ var _ufo = require("@atlaskit/ufo");
  * they can power FE Reliability SLOs:
  * https://hello.atlassian.net/wiki/spaces/AA6/pages/3961393753
  */
-
 /**
  * Experience name strings are surfaced downstream by the UFO pipeline as
  * `platform.fe.<type>.<platform.component>.<name>` (e.g.
@@ -95,15 +95,21 @@ var failExp = exports.failExp = function failExp(name, id, metadata) {
     // UFO errors must never break the plugin
   }
 };
-var abortExp = exports.abortExp = function abortExp(name, id, reason) {
+var abortExp = exports.abortExp = function abortExp(name, id, reason, metadata) {
   if (!isUfoEnabled()) {
     return;
   }
   try {
-    experiences[name].getInstance(id).abort(reason ? {
-      metadata: {
-        reason: reason
-      }
+    // `reason` is the dedicated, canonical channel for the abort reason and
+    // intentionally takes precedence over a `reason` key in `metadata`. Callers
+    // must pass the reason via the param, not inside `metadata` (the `reason`
+    // key there is reserved and would be overwritten).
+    var merged = _objectSpread(_objectSpread({}, metadata), reason ? {
+      reason: reason
+    } : {});
+    var hasMetadata = Object.keys(merged).length > 0;
+    experiences[name].getInstance(id).abort(hasMetadata ? {
+      metadata: merged
     } : undefined);
   } catch (_unused4) {
     // UFO errors must never break the plugin

package/dist/cjs/pm-plugins/autocomplete-plugin.js

@@ -230,7 +230,16 @@ var getTypedLengthForPrediction = function getTypedLengthForPrediction(textBefor
   var trailingToken = (_textBefore$match$ = (_textBefore$match = textBefore.match(/([^\s.,;:!?]*)$/)) === null || _textBefore$match === void 0 ? void 0 : _textBefore$match[1]) !== null && _textBefore$match$ !== void 0 ? _textBefore$match$ : '';
   return trailingToken.length;
 };
+var isEnglishLocale = function isEnglishLocale(locale) {
+  if (!locale) {
+    return false;
+  }
+  return locale.toLowerCase().startsWith('en');
+};
 var createAutocompletePlugin = exports.createAutocompletePlugin = function createAutocompletePlugin(options, api) {
+  var _options$locale;
+  var locale = (_options$locale = options === null || options === void 0 ? void 0 : options.locale) !== null && _options$locale !== void 0 ? _options$locale : typeof navigator !== 'undefined' ? navigator.language : undefined;
+  var isAutocompleteEnabled = isEnglishLocale(locale);
   var debounceTimer = null;
   var hasIngestedPage = false;
   var resolvedContext;
@@ -620,6 +629,9 @@ var createAutocompletePlugin = exports.createAutocompletePlugin = function creat
       }),
       handleDOMEvents: {
         blur: function blur(view) {
+          if (!isAutocompleteEnabled) {
+            return false;
+          }
           var pluginState = autocompletePluginKey.getState(view.state);
           if (pluginState !== null && pluginState !== void 0 && pluginState.ghostText) {
             clearGhostText(view.state, view.dispatch);
@@ -629,6 +641,9 @@ var createAutocompletePlugin = exports.createAutocompletePlugin = function creat
         },
         focus: function focus() {
           var _options$useLocalMode, _options$useLocalMode2;
+          if (!isAutocompleteEnabled) {
+            return false;
+          }
           (0, _textPredictor.loadDefaultVocabulary)({
             isLocalLLM: (_options$useLocalMode = options === null || options === void 0 ? void 0 : options.useLocalModel) !== null && _options$useLocalMode !== void 0 ? _options$useLocalMode : false
           }).catch(function (error) {
@@ -658,6 +673,9 @@ var createAutocompletePlugin = exports.createAutocompletePlugin = function creat
     view: function view() {
       return {
         update: function update(view, prevState) {
+          if (!isAutocompleteEnabled) {
+            return;
+          }
           currentView = view;
           if (!prevState.doc.eq(view.state.doc)) {
             if (justAccepted) {

package/dist/cjs/pm-plugins/local-slow-lane-client.js

@@ -14,6 +14,7 @@ var _typeof2 = _interopRequireDefault(require("@babel/runtime/helpers/typeof"));
 var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
 var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+var _ufo = require("../analytics/ufo");
 var _debugMode = require("./debug-mode");
 var _slowLaneClient = require("./slow-lane-client");
 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; }
@@ -959,7 +960,7 @@ var createLocalSlowLaneClient = exports.createLocalSlowLaneClient = function cre
    */
   var runInference = /*#__PURE__*/function () {
     var _ref0 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee4(text, requestId) {
-      var lmText, semanticText, arcticInput, captureCompletionTime, _data, tStart, tLmDone, tEmbDone, _yield$Promise$all5, _yield$Promise$all6, embeddingResponse, rawLogits, payload, embedding, sumSq, i, topTokens, errorMsg, _t5;
+      var experienceId, lmText, semanticText, arcticInput, captureCompletionTime, _data, tStart, tLmDone, tEmbDone, _yield$Promise$all5, _yield$Promise$all6, embeddingResponse, rawLogits, payload, embedding, sumSq, i, topTokens, errorMsg, _t5;
       return _regenerator.default.wrap(function (_context4) {
         while (1) switch (_context4.prev = _context4.next) {
           case 0:
@@ -969,7 +970,7 @@ var createLocalSlowLaneClient = exports.createLocalSlowLaneClient = function cre
             }
             return _context4.abrupt("return");
           case 1:
-            // Clear the capture buffer so we read only this pass's logits. The engine
+            experienceId = String(requestId); // Clear the capture buffer so we read only this pass's logits. The engine
             // serialises per-model requests and updateContext is debounced, so the
             // latest request's decode step is the last to populate `captured` before
             // we read it below; stale requests bail on the latestRequestId guard.
@@ -995,6 +996,16 @@ var createLocalSlowLaneClient = exports.createLocalSlowLaneClient = function cre
               console.log("%c[LocalSlowLane] %c\uD83E\uDDE0 LM input (".concat(lmText.length, " chars, ").concat(splitOnWhitespace(lmText).length, " words): \"").concat(lmText.length > 100 ? "".concat(lmText.slice(0, 100), "\u2026") : lmText, "\""), 'color: #9c27b0; font-weight: bold;', 'color: #2196f3;');
             }
             _context4.prev = 2;
+            // Reuse the network slow-lane-fetch UFO experience (tagged isLocalLLM:true,
+            // matching LOAD_VECTORS/LOAD_VOCABULARY) so on-device inference
+            // latency/success-rate feeds the same FE Reliability SLO. Started inside
+            // the try — post engine-init (parity with the network fetch, which
+            // excludes the one-time model load) and so the catch below always
+            // terminates the experience, even on a synchronous throw.
+            (0, _ufo.startExp)(_ufo.EXPERIENCE_NAME.SLOW_LANE_FETCH, experienceId, {
+              textLength: text.length,
+              isLocalLLM: true
+            });
             tStart = performance.now();
             tLmDone = 0;
             tEmbDone = 0;
@@ -1027,6 +1038,9 @@ var createLocalSlowLaneClient = exports.createLocalSlowLaneClient = function cre
               _context4.next = 4;
               break;
             }
+            (0, _ufo.abortExp)(_ufo.EXPERIENCE_NAME.SLOW_LANE_FETCH, experienceId, destroyed ? 'destroyed' : 'superseded', {
+              isLocalLLM: true
+            });
             return _context4.abrupt("return");
           case 4:
             // ── LM logits: whole-word BE-parity payload ──────────────────
@@ -1078,6 +1092,12 @@ var createLocalSlowLaneClient = exports.createLocalSlowLaneClient = function cre
               // eslint-disable-next-line no-console
               console.groupEnd();
             }
+            (0, _ufo.succeedExp)(_ufo.EXPERIENCE_NAME.SLOW_LANE_FETCH, experienceId, {
+              textLength: text.length,
+              hasVector: storedContextVector !== null,
+              hasLmLogits: storedLmLogits !== null,
+              isLocalLLM: true
+            });
             onUpdate === null || onUpdate === void 0 || onUpdate({
               textLength: text.length,
               hasVector: storedContextVector !== null,
@@ -1092,10 +1112,17 @@ var createLocalSlowLaneClient = exports.createLocalSlowLaneClient = function cre
               _context4.next = 6;
               break;
             }
+            (0, _ufo.abortExp)(_ufo.EXPERIENCE_NAME.SLOW_LANE_FETCH, experienceId, destroyed ? 'destroyed' : 'superseded', {
+              isLocalLLM: true
+            });
             return _context4.abrupt("return");
           case 6:
             storedContextVector = null;
             storedLmLogits = null;
+            (0, _ufo.failExp)(_ufo.EXPERIENCE_NAME.SLOW_LANE_FETCH, experienceId, {
+              errorType: 'inference',
+              isLocalLLM: true
+            });
             onUpdate === null || onUpdate === void 0 || onUpdate({
               textLength: text.length,
               hasVector: false,

package/dist/cjs/pm-plugins/slow-lane-client.js

@@ -87,7 +87,8 @@ var createSlowLaneClient = exports.createSlowLaneClient = function createSlowLan
               session_id: sessionId
             };
             (0, _ufo.startExp)(_ufo.EXPERIENCE_NAME.SLOW_LANE_FETCH, requestId, {
-              textLength: text.length
+              textLength: text.length,
+              isLocalLLM: false
             });
             if ((0, _debugMode.isAutocompleteDebugEnabled)()) {
               // eslint-disable-next-line no-console
@@ -116,7 +117,8 @@ var createSlowLaneClient = exports.createSlowLaneClient = function createSlowLan
             storedLmLogits = null;
             (0, _ufo.failExp)(_ufo.EXPERIENCE_NAME.SLOW_LANE_FETCH, requestId, {
               status: res.status,
-              errorType: 'http_error'
+              errorType: 'http_error',
+              isLocalLLM: false
             });
             if ((0, _debugMode.isAutocompleteDebugEnabled)()) {
               // eslint-disable-next-line no-console
@@ -151,7 +153,8 @@ var createSlowLaneClient = exports.createSlowLaneClient = function createSlowLan
             (0, _ufo.succeedExp)(_ufo.EXPERIENCE_NAME.SLOW_LANE_FETCH, requestId, {
               textLength: text.length,
               hasVector: storedContextVector !== null,
-              hasLmLogits: storedLmLogits !== null
+              hasLmLogits: storedLmLogits !== null,
+              isLocalLLM: false
             });
             onUpdate === null || onUpdate === void 0 || onUpdate({
               textLength: text.length,
@@ -167,7 +170,8 @@ var createSlowLaneClient = exports.createSlowLaneClient = function createSlowLan
             storedContextVector = null;
             storedLmLogits = null;
             (0, _ufo.failExp)(_ufo.EXPERIENCE_NAME.SLOW_LANE_FETCH, requestId, {
-              errorType: 'network'
+              errorType: 'network',
+              isLocalLLM: false
             });
             if ((0, _debugMode.isAutocompleteDebugEnabled)()) {
               // eslint-disable-next-line no-console
@@ -197,7 +201,9 @@ var createSlowLaneClient = exports.createSlowLaneClient = function createSlowLan
     debounceTimer = setTimeout(function () {
       debounceTimer = null;
       if (inflightRequestId !== null) {
-        (0, _ufo.abortExp)(_ufo.EXPERIENCE_NAME.SLOW_LANE_FETCH, inflightRequestId, 'superseded');
+        (0, _ufo.abortExp)(_ufo.EXPERIENCE_NAME.SLOW_LANE_FETCH, inflightRequestId, 'superseded', {
+          isLocalLLM: false
+        });
       }
       var requestId = String(++requestSeq);
       inflightRequestId = requestId;

package/dist/es2019/analytics/ufo.js

@@ -94,15 +94,24 @@ export const failExp = (name, id, metadata) => {
     // UFO errors must never break the plugin
   }
 };
-export const abortExp = (name, id, reason) => {
+export const abortExp = (name, id, reason, metadata) => {
   if (!isUfoEnabled()) {
     return;
   }
   try {
-    experiences[name].getInstance(id).abort(reason ? {
-      metadata: {
+    // `reason` is the dedicated, canonical channel for the abort reason and
+    // intentionally takes precedence over a `reason` key in `metadata`. Callers
+    // must pass the reason via the param, not inside `metadata` (the `reason`
+    // key there is reserved and would be overwritten).
+    const merged = {
+      ...metadata,
+      ...(reason ? {
         reason
-      }
+      } : {})
+    };
+    const hasMetadata = Object.keys(merged).length > 0;
+    experiences[name].getInstance(id).abort(hasMetadata ? {
+      metadata: merged
     } : undefined);
   } catch {
     // UFO errors must never break the plugin

package/dist/es2019/pm-plugins/autocomplete-plugin.js

@@ -218,7 +218,16 @@ const getTypedLengthForPrediction = textBefore => {
   const trailingToken = (_textBefore$match$ = (_textBefore$match = textBefore.match(/([^\s.,;:!?]*)$/)) === null || _textBefore$match === void 0 ? void 0 : _textBefore$match[1]) !== null && _textBefore$match$ !== void 0 ? _textBefore$match$ : '';
   return trailingToken.length;
 };
+const isEnglishLocale = locale => {
+  if (!locale) {
+    return false;
+  }
+  return locale.toLowerCase().startsWith('en');
+};
 export const createAutocompletePlugin = (options, api) => {
+  var _options$locale;
+  const locale = (_options$locale = options === null || options === void 0 ? void 0 : options.locale) !== null && _options$locale !== void 0 ? _options$locale : typeof navigator !== 'undefined' ? navigator.language : undefined;
+  const isAutocompleteEnabled = isEnglishLocale(locale);
   let debounceTimer = null;
   let hasIngestedPage = false;
   let resolvedContext;
@@ -607,6 +616,9 @@ export const createAutocompletePlugin = (options, api) => {
       }),
       handleDOMEvents: {
         blur: view => {
+          if (!isAutocompleteEnabled) {
+            return false;
+          }
           const pluginState = autocompletePluginKey.getState(view.state);
           if (pluginState !== null && pluginState !== void 0 && pluginState.ghostText) {
             clearGhostText(view.state, view.dispatch);
@@ -616,6 +628,9 @@ export const createAutocompletePlugin = (options, api) => {
         },
         focus: () => {
           var _options$useLocalMode, _options$useLocalMode2;
+          if (!isAutocompleteEnabled) {
+            return false;
+          }
           loadDefaultVocabulary({
             isLocalLLM: (_options$useLocalMode = options === null || options === void 0 ? void 0 : options.useLocalModel) !== null && _options$useLocalMode !== void 0 ? _options$useLocalMode : false
           }).catch(error => {
@@ -644,6 +659,9 @@ export const createAutocompletePlugin = (options, api) => {
     },
     view: () => ({
       update: (view, prevState) => {
+        if (!isAutocompleteEnabled) {
+          return;
+        }
         currentView = view;
         if (!prevState.doc.eq(view.state.doc)) {
           if (justAccepted) {

package/dist/es2019/pm-plugins/local-slow-lane-client.js

@@ -36,6 +36,7 @@ import _defineProperty from "@babel/runtime/helpers/defineProperty";
  * asynchronously after each updateContext() call.
  */
 
+import { abortExp, EXPERIENCE_NAME, failExp, startExp, succeedExp } from '../analytics/ufo';
 import { isAutocompleteDebugEnabled } from './debug-mode';
 import { isWordBoundary } from './slow-lane-client';
 
@@ -748,6 +749,7 @@ export const createLocalSlowLaneClient = (config = {}) => {
     if (!engine || destroyed) {
       return;
     }
+    const experienceId = String(requestId);
 
     // Clear the capture buffer so we read only this pass's logits. The engine
     // serialises per-model requests and updateContext is debounced, so the
@@ -774,6 +776,16 @@ export const createLocalSlowLaneClient = (config = {}) => {
     }
     try {
       var _data, _data$;
+      // Reuse the network slow-lane-fetch UFO experience (tagged isLocalLLM:true,
+      // matching LOAD_VECTORS/LOAD_VOCABULARY) so on-device inference
+      // latency/success-rate feeds the same FE Reliability SLO. Started inside
+      // the try — post engine-init (parity with the network fetch, which
+      // excludes the one-time model load) and so the catch below always
+      // terminates the experience, even on a synchronous throw.
+      startExp(EXPERIENCE_NAME.SLOW_LANE_FETCH, experienceId, {
+        textLength: text.length,
+        isLocalLLM: true
+      });
       const tStart = performance.now();
       let tLmDone = 0;
       let tEmbDone = 0;
@@ -798,6 +810,9 @@ export const createLocalSlowLaneClient = (config = {}) => {
 
       // Discard stale results
       if (requestId < latestRequestId || destroyed) {
+        abortExp(EXPERIENCE_NAME.SLOW_LANE_FETCH, experienceId, destroyed ? 'destroyed' : 'superseded', {
+          isLocalLLM: true
+        });
         return;
       }
 
@@ -840,6 +855,12 @@ export const createLocalSlowLaneClient = (config = {}) => {
         // eslint-disable-next-line no-console
         console.groupEnd();
       }
+      succeedExp(EXPERIENCE_NAME.SLOW_LANE_FETCH, experienceId, {
+        textLength: text.length,
+        hasVector: storedContextVector !== null,
+        hasLmLogits: storedLmLogits !== null,
+        isLocalLLM: true
+      });
       onUpdate === null || onUpdate === void 0 ? void 0 : onUpdate({
         textLength: text.length,
         hasVector: storedContextVector !== null,
@@ -848,10 +869,17 @@ export const createLocalSlowLaneClient = (config = {}) => {
     } catch (err) {
       // Discard errors for stale requests or after teardown
       if (requestId < latestRequestId || destroyed) {
+        abortExp(EXPERIENCE_NAME.SLOW_LANE_FETCH, experienceId, destroyed ? 'destroyed' : 'superseded', {
+          isLocalLLM: true
+        });
         return;
       }
       storedContextVector = null;
       storedLmLogits = null;
+      failExp(EXPERIENCE_NAME.SLOW_LANE_FETCH, experienceId, {
+        errorType: 'inference',
+        isLocalLLM: true
+      });
       onUpdate === null || onUpdate === void 0 ? void 0 : onUpdate({
         textLength: text.length,
         hasVector: false,

package/dist/es2019/pm-plugins/slow-lane-client.js

@@ -69,7 +69,8 @@ export const createSlowLaneClient = config => {
       session_id: sessionId
     };
     startExp(EXPERIENCE_NAME.SLOW_LANE_FETCH, requestId, {
-      textLength: text.length
+      textLength: text.length,
+      isLocalLLM: false
     });
     if (isAutocompleteDebugEnabled()) {
       // eslint-disable-next-line no-console
@@ -92,7 +93,8 @@ export const createSlowLaneClient = config => {
         storedLmLogits = null;
         failExp(EXPERIENCE_NAME.SLOW_LANE_FETCH, requestId, {
           status: res.status,
-          errorType: 'http_error'
+          errorType: 'http_error',
+          isLocalLLM: false
         });
         if (isAutocompleteDebugEnabled()) {
           // eslint-disable-next-line no-console
@@ -124,7 +126,8 @@ export const createSlowLaneClient = config => {
       succeedExp(EXPERIENCE_NAME.SLOW_LANE_FETCH, requestId, {
         textLength: text.length,
         hasVector: storedContextVector !== null,
-        hasLmLogits: storedLmLogits !== null
+        hasLmLogits: storedLmLogits !== null,
+        isLocalLLM: false
       });
       onUpdate === null || onUpdate === void 0 ? void 0 : onUpdate({
         textLength: text.length,
@@ -136,7 +139,8 @@ export const createSlowLaneClient = config => {
       storedContextVector = null;
       storedLmLogits = null;
       failExp(EXPERIENCE_NAME.SLOW_LANE_FETCH, requestId, {
-        errorType: 'network'
+        errorType: 'network',
+        isLocalLLM: false
       });
       if (isAutocompleteDebugEnabled()) {
         // eslint-disable-next-line no-console
@@ -156,7 +160,9 @@ export const createSlowLaneClient = config => {
     debounceTimer = setTimeout(() => {
       debounceTimer = null;
       if (inflightRequestId !== null) {
-        abortExp(EXPERIENCE_NAME.SLOW_LANE_FETCH, inflightRequestId, 'superseded');
+        abortExp(EXPERIENCE_NAME.SLOW_LANE_FETCH, inflightRequestId, 'superseded', {
+          isLocalLLM: false
+        });
       }
       const requestId = String(++requestSeq);
       inflightRequestId = requestId;

package/dist/esm/analytics/ufo.js

@@ -1,4 +1,6 @@
 import _defineProperty from "@babel/runtime/helpers/defineProperty";
+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; }
 /**
  * UFO experience tracking helpers for `@atlaskit/editor-plugin-autocomplete`.
  *
@@ -89,15 +91,21 @@ export var failExp = function failExp(name, id, metadata) {
     // UFO errors must never break the plugin
   }
 };
-export var abortExp = function abortExp(name, id, reason) {
+export var abortExp = function abortExp(name, id, reason, metadata) {
   if (!isUfoEnabled()) {
     return;
   }
   try {
-    experiences[name].getInstance(id).abort(reason ? {
-      metadata: {
-        reason: reason
-      }
+    // `reason` is the dedicated, canonical channel for the abort reason and
+    // intentionally takes precedence over a `reason` key in `metadata`. Callers
+    // must pass the reason via the param, not inside `metadata` (the `reason`
+    // key there is reserved and would be overwritten).
+    var merged = _objectSpread(_objectSpread({}, metadata), reason ? {
+      reason: reason
+    } : {});
+    var hasMetadata = Object.keys(merged).length > 0;
+    experiences[name].getInstance(id).abort(hasMetadata ? {
+      metadata: merged
     } : undefined);
   } catch (_unused4) {
     // UFO errors must never break the plugin

package/dist/esm/pm-plugins/autocomplete-plugin.js

@@ -223,7 +223,16 @@ var getTypedLengthForPrediction = function getTypedLengthForPrediction(textBefor
   var trailingToken = (_textBefore$match$ = (_textBefore$match = textBefore.match(/([^\s.,;:!?]*)$/)) === null || _textBefore$match === void 0 ? void 0 : _textBefore$match[1]) !== null && _textBefore$match$ !== void 0 ? _textBefore$match$ : '';
   return trailingToken.length;
 };
+var isEnglishLocale = function isEnglishLocale(locale) {
+  if (!locale) {
+    return false;
+  }
+  return locale.toLowerCase().startsWith('en');
+};
 export var createAutocompletePlugin = function createAutocompletePlugin(options, api) {
+  var _options$locale;
+  var locale = (_options$locale = options === null || options === void 0 ? void 0 : options.locale) !== null && _options$locale !== void 0 ? _options$locale : typeof navigator !== 'undefined' ? navigator.language : undefined;
+  var isAutocompleteEnabled = isEnglishLocale(locale);
   var debounceTimer = null;
   var hasIngestedPage = false;
   var resolvedContext;
@@ -613,6 +622,9 @@ export var createAutocompletePlugin = function createAutocompletePlugin(options,
       }),
       handleDOMEvents: {
         blur: function blur(view) {
+          if (!isAutocompleteEnabled) {
+            return false;
+          }
           var pluginState = autocompletePluginKey.getState(view.state);
           if (pluginState !== null && pluginState !== void 0 && pluginState.ghostText) {
             clearGhostText(view.state, view.dispatch);
@@ -622,6 +634,9 @@ export var createAutocompletePlugin = function createAutocompletePlugin(options,
         },
         focus: function focus() {
           var _options$useLocalMode, _options$useLocalMode2;
+          if (!isAutocompleteEnabled) {
+            return false;
+          }
           loadDefaultVocabulary({
             isLocalLLM: (_options$useLocalMode = options === null || options === void 0 ? void 0 : options.useLocalModel) !== null && _options$useLocalMode !== void 0 ? _options$useLocalMode : false
           }).catch(function (error) {
@@ -651,6 +666,9 @@ export var createAutocompletePlugin = function createAutocompletePlugin(options,
     view: function view() {
       return {
         update: function update(view, prevState) {
+          if (!isAutocompleteEnabled) {
+            return;
+          }
           currentView = view;
           if (!prevState.doc.eq(view.state.doc)) {
             if (justAccepted) {

package/dist/esm/pm-plugins/local-slow-lane-client.js

@@ -48,6 +48,7 @@ function _arrayLikeToArray(r, a) { (null == a || a > r.length) && (a = r.length)
  * asynchronously after each updateContext() call.
  */
 
+import { abortExp, EXPERIENCE_NAME, failExp, startExp, succeedExp } from '../analytics/ufo';
 import { isAutocompleteDebugEnabled } from './debug-mode';
 import { isWordBoundary } from './slow-lane-client';
 
@@ -947,7 +948,7 @@ export var createLocalSlowLaneClient = function createLocalSlowLaneClient() {
    */
   var runInference = /*#__PURE__*/function () {
     var _ref0 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee4(text, requestId) {
-      var lmText, semanticText, arcticInput, captureCompletionTime, _data, tStart, tLmDone, tEmbDone, _yield$Promise$all5, _yield$Promise$all6, embeddingResponse, rawLogits, payload, embedding, sumSq, i, topTokens, errorMsg, _t5;
+      var experienceId, lmText, semanticText, arcticInput, captureCompletionTime, _data, tStart, tLmDone, tEmbDone, _yield$Promise$all5, _yield$Promise$all6, embeddingResponse, rawLogits, payload, embedding, sumSq, i, topTokens, errorMsg, _t5;
       return _regeneratorRuntime.wrap(function (_context4) {
         while (1) switch (_context4.prev = _context4.next) {
           case 0:
@@ -957,7 +958,7 @@ export var createLocalSlowLaneClient = function createLocalSlowLaneClient() {
             }
             return _context4.abrupt("return");
           case 1:
-            // Clear the capture buffer so we read only this pass's logits. The engine
+            experienceId = String(requestId); // Clear the capture buffer so we read only this pass's logits. The engine
             // serialises per-model requests and updateContext is debounced, so the
             // latest request's decode step is the last to populate `captured` before
             // we read it below; stale requests bail on the latestRequestId guard.
@@ -983,6 +984,16 @@ export var createLocalSlowLaneClient = function createLocalSlowLaneClient() {
               console.log("%c[LocalSlowLane] %c\uD83E\uDDE0 LM input (".concat(lmText.length, " chars, ").concat(splitOnWhitespace(lmText).length, " words): \"").concat(lmText.length > 100 ? "".concat(lmText.slice(0, 100), "\u2026") : lmText, "\""), 'color: #9c27b0; font-weight: bold;', 'color: #2196f3;');
             }
             _context4.prev = 2;
+            // Reuse the network slow-lane-fetch UFO experience (tagged isLocalLLM:true,
+            // matching LOAD_VECTORS/LOAD_VOCABULARY) so on-device inference
+            // latency/success-rate feeds the same FE Reliability SLO. Started inside
+            // the try — post engine-init (parity with the network fetch, which
+            // excludes the one-time model load) and so the catch below always
+            // terminates the experience, even on a synchronous throw.
+            startExp(EXPERIENCE_NAME.SLOW_LANE_FETCH, experienceId, {
+              textLength: text.length,
+              isLocalLLM: true
+            });
             tStart = performance.now();
             tLmDone = 0;
             tEmbDone = 0;
@@ -1015,6 +1026,9 @@ export var createLocalSlowLaneClient = function createLocalSlowLaneClient() {
               _context4.next = 4;
               break;
             }
+            abortExp(EXPERIENCE_NAME.SLOW_LANE_FETCH, experienceId, destroyed ? 'destroyed' : 'superseded', {
+              isLocalLLM: true
+            });
             return _context4.abrupt("return");
           case 4:
             // ── LM logits: whole-word BE-parity payload ──────────────────
@@ -1066,6 +1080,12 @@ export var createLocalSlowLaneClient = function createLocalSlowLaneClient() {
               // eslint-disable-next-line no-console
               console.groupEnd();
             }
+            succeedExp(EXPERIENCE_NAME.SLOW_LANE_FETCH, experienceId, {
+              textLength: text.length,
+              hasVector: storedContextVector !== null,
+              hasLmLogits: storedLmLogits !== null,
+              isLocalLLM: true
+            });
             onUpdate === null || onUpdate === void 0 || onUpdate({
               textLength: text.length,
               hasVector: storedContextVector !== null,
@@ -1080,10 +1100,17 @@ export var createLocalSlowLaneClient = function createLocalSlowLaneClient() {
               _context4.next = 6;
               break;
             }
+            abortExp(EXPERIENCE_NAME.SLOW_LANE_FETCH, experienceId, destroyed ? 'destroyed' : 'superseded', {
+              isLocalLLM: true
+            });
             return _context4.abrupt("return");
           case 6:
             storedContextVector = null;
             storedLmLogits = null;
+            failExp(EXPERIENCE_NAME.SLOW_LANE_FETCH, experienceId, {
+              errorType: 'inference',
+              isLocalLLM: true
+            });
             onUpdate === null || onUpdate === void 0 || onUpdate({
               textLength: text.length,
               hasVector: false,

package/dist/esm/pm-plugins/slow-lane-client.js

@@ -81,7 +81,8 @@ export var createSlowLaneClient = function createSlowLaneClient(config) {
               session_id: sessionId
             };
             startExp(EXPERIENCE_NAME.SLOW_LANE_FETCH, requestId, {
-              textLength: text.length
+              textLength: text.length,
+              isLocalLLM: false
             });
             if (isAutocompleteDebugEnabled()) {
               // eslint-disable-next-line no-console
@@ -110,7 +111,8 @@ export var createSlowLaneClient = function createSlowLaneClient(config) {
             storedLmLogits = null;
             failExp(EXPERIENCE_NAME.SLOW_LANE_FETCH, requestId, {
               status: res.status,
-              errorType: 'http_error'
+              errorType: 'http_error',
+              isLocalLLM: false
             });
             if (isAutocompleteDebugEnabled()) {
               // eslint-disable-next-line no-console
@@ -145,7 +147,8 @@ export var createSlowLaneClient = function createSlowLaneClient(config) {
             succeedExp(EXPERIENCE_NAME.SLOW_LANE_FETCH, requestId, {
               textLength: text.length,
               hasVector: storedContextVector !== null,
-              hasLmLogits: storedLmLogits !== null
+              hasLmLogits: storedLmLogits !== null,
+              isLocalLLM: false
             });
             onUpdate === null || onUpdate === void 0 || onUpdate({
               textLength: text.length,
@@ -161,7 +164,8 @@ export var createSlowLaneClient = function createSlowLaneClient(config) {
             storedContextVector = null;
             storedLmLogits = null;
             failExp(EXPERIENCE_NAME.SLOW_LANE_FETCH, requestId, {
-              errorType: 'network'
+              errorType: 'network',
+              isLocalLLM: false
             });
             if (isAutocompleteDebugEnabled()) {
               // eslint-disable-next-line no-console
@@ -191,7 +195,9 @@ export var createSlowLaneClient = function createSlowLaneClient(config) {
     debounceTimer = setTimeout(function () {
       debounceTimer = null;
       if (inflightRequestId !== null) {
-        abortExp(EXPERIENCE_NAME.SLOW_LANE_FETCH, inflightRequestId, 'superseded');
+        abortExp(EXPERIENCE_NAME.SLOW_LANE_FETCH, inflightRequestId, 'superseded', {
+          isLocalLLM: false
+        });
       }
       var requestId = String(++requestSeq);
       inflightRequestId = requestId;

package/dist/types/analytics/ufo.d.ts

@@ -35,4 +35,4 @@ export type AutocompleteExperienceName = (typeof EXPERIENCE_NAME)[keyof typeof E
 export declare const startExp: (name: AutocompleteExperienceName, id: string, metadata?: CustomData) => void;
 export declare const succeedExp: (name: AutocompleteExperienceName, id: string, metadata?: CustomData) => void;
 export declare const failExp: (name: AutocompleteExperienceName, id: string, metadata?: CustomData) => void;
-export declare const abortExp: (name: AutocompleteExperienceName, id: string, reason?: string) => void;
+export declare const abortExp: (name: AutocompleteExperienceName, id: string, reason?: string, metadata?: CustomData) => void;

package/dist/types/pm-plugins/autocomplete-plugin.d.ts

@@ -40,6 +40,11 @@ export interface AutocompletePluginOptions {
      * Use this to serve vectors from a CDN or media service in production.
      */
     getVectorsBinaryUrl?: () => Promise<string>;
+    /**
+     * User locale used to determine whether autocomplete should run.
+     * Defaults to browser locale when omitted.
+     */
+    locale?: string;
     /**
      * When true, uses on-device inference via WebGPU (MLC WebLLM) instead of
      * the network-based slow-lane backend. Defaults to false (network client).

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-autocomplete",
-	"version": "4.0.1",
+	"version": "4.0.3",
 	"description": "Client-side text autocomplete plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -27,7 +27,7 @@
 		"wink-nlp": "^2.4.0"
 	},
 	"peerDependencies": {
-		"@atlaskit/editor-common": "^116.4.0",
+		"@atlaskit/editor-common": "^116.6.0",
 		"@atlaskit/editor-plugin-analytics": "^12.0.0",
 		"react": "^18.2.0"
 	},

package/src/analytics/ufo.ts

@@ -120,12 +120,23 @@ export const failExp = (
 	}
 };
 
-export const abortExp = (name: AutocompleteExperienceName, id: string, reason?: string): void => {
+export const abortExp = (
+	name: AutocompleteExperienceName,
+	id: string,
+	reason?: string,
+	metadata?: CustomData,
+): void => {
 	if (!isUfoEnabled()) {
 		return;
 	}
 	try {
-		experiences[name].getInstance(id).abort(reason ? { metadata: { reason } } : undefined);
+		// `reason` is the dedicated, canonical channel for the abort reason and
+		// intentionally takes precedence over a `reason` key in `metadata`. Callers
+		// must pass the reason via the param, not inside `metadata` (the `reason`
+		// key there is reserved and would be overwritten).
+		const merged: CustomData = { ...metadata, ...(reason ? { reason } : {}) };
+		const hasMetadata = Object.keys(merged).length > 0;
+		experiences[name].getInstance(id).abort(hasMetadata ? { metadata: merged } : undefined);
 	} catch {
 		// UFO errors must never break the plugin
 	}

package/src/pm-plugins/autocomplete-plugin.ts

@@ -214,6 +214,11 @@ export interface AutocompletePluginOptions {
 	 * Use this to serve vectors from a CDN or media service in production.
 	 */
 	getVectorsBinaryUrl?: () => Promise<string>;
+	/**
+	 * User locale used to determine whether autocomplete should run.
+	 * Defaults to browser locale when omitted.
+	 */
+	locale?: string;
 	/**
 	 * When true, uses on-device inference via WebGPU (MLC WebLLM) instead of
 	 * the network-based slow-lane backend. Defaults to false (network client).
@@ -299,10 +304,22 @@ const getTypedLengthForPrediction = (textBefore: string): number => {
 	return trailingToken.length;
 };
 
+const isEnglishLocale = (locale?: string): boolean => {
+	if (!locale) {
+		return false;
+	}
+
+	return locale.toLowerCase().startsWith('en');
+};
+
 export const createAutocompletePlugin = (
 	options?: AutocompletePluginOptions,
 	api?: ExtractInjectionAPI<AutocompletePlugin>,
 ): SafePlugin<AutocompletePluginState> => {
+	const locale =
+		options?.locale ?? (typeof navigator !== 'undefined' ? navigator.language : undefined);
+	const isAutocompleteEnabled = isEnglishLocale(locale);
+
 	let debounceTimer: ReturnType<typeof setTimeout> | null = null;
 	let hasIngestedPage = false;
 	let resolvedContext: AutocompleteContext | undefined;
@@ -730,6 +747,10 @@ export const createAutocompletePlugin = (
 
 			handleDOMEvents: {
 				blur: (view: EditorView) => {
+					if (!isAutocompleteEnabled) {
+						return false;
+					}
+
 					const pluginState = autocompletePluginKey.getState(view.state) as
 						| AutocompletePluginState
 						| undefined;
@@ -740,6 +761,10 @@ export const createAutocompletePlugin = (
 					return false;
 				},
 				focus: () => {
+					if (!isAutocompleteEnabled) {
+						return false;
+					}
+
 					loadDefaultVocabulary({ isLocalLLM: options?.useLocalModel ?? false }).catch((error) => {
 						logException(error as Error, {
 							location: 'editor-plugin-autocomplete/loadDefaultVocabulary',
@@ -767,6 +792,10 @@ export const createAutocompletePlugin = (
 
 		view: () => ({
 			update: (view: EditorView, prevState: EditorState) => {
+				if (!isAutocompleteEnabled) {
+					return;
+				}
+
 				currentView = view;
 				if (!prevState.doc.eq(view.state.doc)) {
 					if (justAccepted) {

package/src/pm-plugins/local-slow-lane-client.ts

@@ -37,6 +37,8 @@
 
 import type { MLCEngine, InitProgressReport, AppConfig, LogitProcessor } from '@mlc-ai/web-llm';
 
+import { abortExp, EXPERIENCE_NAME, failExp, startExp, succeedExp } from '../analytics/ufo';
+
 import { isAutocompleteDebugEnabled } from './debug-mode';
 import { isWordBoundary } from './slow-lane-client';
 
@@ -987,6 +989,8 @@ export const createLocalSlowLaneClient = (
 			return;
 		}
 
+		const experienceId = String(requestId);
+
 		// Clear the capture buffer so we read only this pass's logits. The engine
 		// serialises per-model requests and updateContext is debounced, so the
 		// latest request's decode step is the last to populate `captured` before
@@ -1025,6 +1029,17 @@ export const createLocalSlowLaneClient = (
 		}
 
 		try {
+			// Reuse the network slow-lane-fetch UFO experience (tagged isLocalLLM:true,
+			// matching LOAD_VECTORS/LOAD_VOCABULARY) so on-device inference
+			// latency/success-rate feeds the same FE Reliability SLO. Started inside
+			// the try — post engine-init (parity with the network fetch, which
+			// excludes the one-time model load) and so the catch below always
+			// terminates the experience, even on a synchronous throw.
+			startExp(EXPERIENCE_NAME.SLOW_LANE_FETCH, experienceId, {
+				textLength: text.length,
+				isLocalLLM: true,
+			});
+
 			const tStart = performance.now();
 			let tLmDone = 0;
 			let tEmbDone = 0;
@@ -1064,6 +1079,12 @@ export const createLocalSlowLaneClient = (
 
 			// Discard stale results
 			if (requestId < latestRequestId || destroyed) {
+				abortExp(
+					EXPERIENCE_NAME.SLOW_LANE_FETCH,
+					experienceId,
+					destroyed ? 'destroyed' : 'superseded',
+					{ isLocalLLM: true },
+				);
 				return;
 			}
 
@@ -1126,6 +1147,13 @@ export const createLocalSlowLaneClient = (
 				console.groupEnd();
 			}
 
+			succeedExp(EXPERIENCE_NAME.SLOW_LANE_FETCH, experienceId, {
+				textLength: text.length,
+				hasVector: storedContextVector !== null,
+				hasLmLogits: storedLmLogits !== null,
+				isLocalLLM: true,
+			});
+
 			onUpdate?.({
 				textLength: text.length,
 				hasVector: storedContextVector !== null,
@@ -1134,11 +1162,21 @@ export const createLocalSlowLaneClient = (
 		} catch (err) {
 			// Discard errors for stale requests or after teardown
 			if (requestId < latestRequestId || destroyed) {
+				abortExp(
+					EXPERIENCE_NAME.SLOW_LANE_FETCH,
+					experienceId,
+					destroyed ? 'destroyed' : 'superseded',
+					{ isLocalLLM: true },
+				);
 				return;
 			}
 
 			storedContextVector = null;
 			storedLmLogits = null;
+			failExp(EXPERIENCE_NAME.SLOW_LANE_FETCH, experienceId, {
+				errorType: 'inference',
+				isLocalLLM: true,
+			});
 			onUpdate?.({ textLength: text.length, hasVector: false, hasLmLogits: false });
 
 			const errorMsg = err instanceof Error ? err.message : String(err);

package/src/pm-plugins/slow-lane-client.ts

@@ -101,7 +101,10 @@ export const createSlowLaneClient = (
 			session_id: sessionId,
 		};
 
-		startExp(EXPERIENCE_NAME.SLOW_LANE_FETCH, requestId, { textLength: text.length });
+		startExp(EXPERIENCE_NAME.SLOW_LANE_FETCH, requestId, {
+			textLength: text.length,
+			isLocalLLM: false,
+		});
 
 		if (isAutocompleteDebugEnabled()) {
 			// eslint-disable-next-line no-console
@@ -131,6 +134,7 @@ export const createSlowLaneClient = (
 				failExp(EXPERIENCE_NAME.SLOW_LANE_FETCH, requestId, {
 					status: res.status,
 					errorType: 'http_error',
+					isLocalLLM: false,
 				});
 				if (isAutocompleteDebugEnabled()) {
 					// eslint-disable-next-line no-console
@@ -184,6 +188,7 @@ export const createSlowLaneClient = (
 				textLength: text.length,
 				hasVector: storedContextVector !== null,
 				hasLmLogits: storedLmLogits !== null,
+				isLocalLLM: false,
 			});
 
 			onUpdate?.({
@@ -195,7 +200,10 @@ export const createSlowLaneClient = (
 		} catch (e) {
 			storedContextVector = null;
 			storedLmLogits = null;
-			failExp(EXPERIENCE_NAME.SLOW_LANE_FETCH, requestId, { errorType: 'network' });
+			failExp(EXPERIENCE_NAME.SLOW_LANE_FETCH, requestId, {
+				errorType: 'network',
+				isLocalLLM: false,
+			});
 			if (isAutocompleteDebugEnabled()) {
 				// eslint-disable-next-line no-console
 				console.log(
@@ -219,7 +227,9 @@ export const createSlowLaneClient = (
 		debounceTimer = setTimeout(() => {
 			debounceTimer = null;
 			if (inflightRequestId !== null) {
-				abortExp(EXPERIENCE_NAME.SLOW_LANE_FETCH, inflightRequestId, 'superseded');
+				abortExp(EXPERIENCE_NAME.SLOW_LANE_FETCH, inflightRequestId, 'superseded', {
+					isLocalLLM: false,
+				});
 			}
 			const requestId = String(++requestSeq);
 			inflightRequestId = requestId;