@atlaskit/smart-user-picker 11.3.3 → 11.5.0

package/CHANGELOG.md

@@ -1,5 +1,25 @@
 # @atlassian/smart-user-picker
 
+## 11.5.0
+
+### Minor Changes
+
+- [`30c27895b9040`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/30c27895b9040) -
+  Behind the smart-user-picker-fetch-error-fix gate, a failed user lookup no longer clears the
+  suggestions or fails the UFO experience when the query has already moved on, so a slow or failing
+  request for an earlier keystroke cannot wipe the results of the current one.
+
+## 11.4.0
+
+### Minor Changes
+
+- [`83e8f4f813800`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/83e8f4f813800) -
+  Clean up a feature gate. The restrictTo prop is now always applied to user recommendations.
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 11.3.3
 
 ### Patch Changes

package/dist/cjs/analytics.js

@@ -12,7 +12,7 @@ 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) { (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; } // eslint-disable-next-line @typescript-eslint/consistent-type-imports
 // eslint-disable-next-line @atlaskit/platform/prefer-crypto-random-uuid -- Use crypto.randomUUID instead
 var packageName = "@atlaskit/smart-user-picker";
-var packageVersion = "11.3.2";
+var packageVersion = "11.4.0";
 var startSession = exports.startSession = function startSession() {
   return {
     // eslint-disable-next-line @atlaskit/platform/prefer-crypto-random-uuid -- Use crypto.randomUUID instead

package/dist/cjs/components/SmartUserPicker.js

@@ -163,7 +163,7 @@ var SmartUserPickerWithoutAnalytics = exports.SmartUserPickerWithoutAnalytics =
               		Further ref: https://developer.atlassian.com/platform/user-recommendations/guides/frequently-asked-questions/#filter-behavior
                */
               searchQueryFilter: isEmail && !searchQueryFilter ? '(NOT not_mentionable:true) AND (account_status:active) AND (NOT account_type:app)' : searchQueryFilter
-            }, restrictTo && (0, _platformFeatureFlags.fg)('smart-user-picker-restrict-to-gate') && {
+            }, restrictTo && {
               restrictTo: restrictTo
             }), isTeamSyncedToGroupDirectoryFilter === true && {
               isTeamSyncedToGroupDirectoryFilter: true
@@ -343,11 +343,24 @@ var SmartUserPickerWithoutAnalytics = exports.SmartUserPickerWithoutAnalytics =
                 loading: loading
               };
             });
-            _context.next = 23;
+            _context.next = 24;
             break;
           case 15:
             _context.prev = 15;
             _t6 = _context["catch"](1);
+            if (!(_this.state.query !== query && (0, _platformFeatureFlags.fg)('smart-user-picker-fetch-error-fix'))) {
+              _context.next = 16;
+              break;
+            }
+            // The query has moved on since this request was sent, so its results are not the ones
+            // on screen. Applying the failure here would clear the options and fail the UFO
+            // experience that belong to the newer query.
+            _this.fireEvent(_analytics.failedRequestUsersEvent, {
+              elapsedTimeMilli: window.performance.now() - startTime,
+              productAttributes: productAttributes
+            });
+            return _context.abrupt("return");
+          case 16:
             is5xxEvent = checkIf500Event(_t6.statusCode);
             if (!closed && !onError && is5xxEvent) {
               // If the user lookup fails while the menu is open, and the consumer is not providing a
@@ -359,35 +372,35 @@ var SmartUserPickerWithoutAnalytics = exports.SmartUserPickerWithoutAnalytics =
             });
             onErrorProducedError = false;
             defaultUsers = [];
-            _context.prev = 16;
+            _context.prev = 17;
             if (!onError) {
-              _context.next = 19;
+              _context.next = 20;
               break;
             }
-            _context.next = 17;
+            _context.next = 18;
             return onError(_t6, recommendationsRequest);
-          case 17:
+          case 18:
             _t8 = _context.sent;
             if (_t8) {
-              _context.next = 18;
+              _context.next = 19;
               break;
             }
             _t8 = [];
-          case 18:
+          case 19:
             _t7 = _t8;
-            _context.next = 20;
+            _context.next = 21;
             break;
-          case 19:
-            _t7 = [];
           case 20:
+            _t7 = [];
+          case 21:
             defaultUsers = _t7;
-            _context.next = 22;
+            _context.next = 23;
             break;
-          case 21:
-            _context.prev = 21;
-            _t9 = _context["catch"](16);
-            onErrorProducedError = true;
           case 22:
+            _context.prev = 22;
+            _t9 = _context["catch"](17);
+            onErrorProducedError = true;
+          case 23:
             if (onErrorProducedError && is5xxEvent) {
               // Log error from fallback data source `onError` to UFO
               _this.optionsShownUfoExperienceInstance.failure(ufoEndStateConfig(_this.props.fieldId));
@@ -404,11 +417,11 @@ var SmartUserPickerWithoutAnalytics = exports.SmartUserPickerWithoutAnalytics =
               elapsedTimeMilli: _elapsedTimeMilli,
               productAttributes: productAttributes
             });
-          case 23:
+          case 24:
           case "end":
             return _context.stop();
         }
-      }, _callee, null, [[1, 15], [16, 21]]);
+      }, _callee, null, [[1, 15], [17, 22]]);
     })), (_this$props$debounceT = _this.props.debounceTime) !== null && _this$props$debounceT !== void 0 ? _this$props$debounceT : 0));
     (0, _defineProperty2.default)(_this, "onInputChange", function (newQuery, sessionId) {
       var query = newQuery || '';

package/dist/es2019/analytics.js

@@ -3,7 +3,7 @@ import { createAndFireEvent } from '@atlaskit/analytics-next';
 // eslint-disable-next-line @atlaskit/platform/prefer-crypto-random-uuid -- Use crypto.randomUUID instead
 import { v4 as uuid } from 'uuid';
 const packageName = "@atlaskit/smart-user-picker";
-const packageVersion = "11.3.2";
+const packageVersion = "11.4.0";
 export const startSession = () => ({
   // eslint-disable-next-line @atlaskit/platform/prefer-crypto-random-uuid -- Use crypto.randomUUID instead
   id: uuid(),

package/dist/es2019/components/SmartUserPicker.js

@@ -158,7 +158,7 @@ export class SmartUserPickerWithoutAnalytics extends React.Component {
         		Further ref: https://developer.atlassian.com/platform/user-recommendations/guides/frequently-asked-questions/#filter-behavior
          */
         searchQueryFilter: isEmail && !searchQueryFilter ? '(NOT not_mentionable:true) AND (account_status:active) AND (NOT account_type:app)' : searchQueryFilter,
-        ...(restrictTo && fg('smart-user-picker-restrict-to-gate') && {
+        ...(restrictTo && {
           restrictTo
         }),
         ...(isTeamSyncedToGroupDirectoryFilter === true && {
@@ -260,6 +260,16 @@ export class SmartUserPickerWithoutAnalytics extends React.Component {
           };
         });
       } catch (e) {
+        if (this.state.query !== query && fg('smart-user-picker-fetch-error-fix')) {
+          // The query has moved on since this request was sent, so its results are not the ones
+          // on screen. Applying the failure here would clear the options and fail the UFO
+          // experience that belong to the newer query.
+          this.fireEvent(failedRequestUsersEvent, {
+            elapsedTimeMilli: window.performance.now() - startTime,
+            productAttributes
+          });
+          return;
+        }
         const is5xxEvent = checkIf500Event(e.statusCode);
         if (!closed && !onError && is5xxEvent) {
           // If the user lookup fails while the menu is open, and the consumer is not providing a

package/dist/esm/analytics.js

@@ -6,7 +6,7 @@ import { createAndFireEvent } from '@atlaskit/analytics-next';
 // eslint-disable-next-line @atlaskit/platform/prefer-crypto-random-uuid -- Use crypto.randomUUID instead
 import { v4 as uuid } from 'uuid';
 var packageName = "@atlaskit/smart-user-picker";
-var packageVersion = "11.3.2";
+var packageVersion = "11.4.0";
 export var startSession = function startSession() {
   return {
     // eslint-disable-next-line @atlaskit/platform/prefer-crypto-random-uuid -- Use crypto.randomUUID instead

package/dist/esm/components/SmartUserPicker.js

@@ -155,7 +155,7 @@ export var SmartUserPickerWithoutAnalytics = /*#__PURE__*/function (_React$Compo
               		Further ref: https://developer.atlassian.com/platform/user-recommendations/guides/frequently-asked-questions/#filter-behavior
                */
               searchQueryFilter: isEmail && !searchQueryFilter ? '(NOT not_mentionable:true) AND (account_status:active) AND (NOT account_type:app)' : searchQueryFilter
-            }, restrictTo && fg('smart-user-picker-restrict-to-gate') && {
+            }, restrictTo && {
               restrictTo: restrictTo
             }), isTeamSyncedToGroupDirectoryFilter === true && {
               isTeamSyncedToGroupDirectoryFilter: true
@@ -335,11 +335,24 @@ export var SmartUserPickerWithoutAnalytics = /*#__PURE__*/function (_React$Compo
                 loading: loading
               };
             });
-            _context.next = 23;
+            _context.next = 24;
             break;
           case 15:
             _context.prev = 15;
             _t6 = _context["catch"](1);
+            if (!(_this.state.query !== query && fg('smart-user-picker-fetch-error-fix'))) {
+              _context.next = 16;
+              break;
+            }
+            // The query has moved on since this request was sent, so its results are not the ones
+            // on screen. Applying the failure here would clear the options and fail the UFO
+            // experience that belong to the newer query.
+            _this.fireEvent(failedRequestUsersEvent, {
+              elapsedTimeMilli: window.performance.now() - startTime,
+              productAttributes: productAttributes
+            });
+            return _context.abrupt("return");
+          case 16:
             is5xxEvent = checkIf500Event(_t6.statusCode);
             if (!closed && !onError && is5xxEvent) {
               // If the user lookup fails while the menu is open, and the consumer is not providing a
@@ -351,35 +364,35 @@ export var SmartUserPickerWithoutAnalytics = /*#__PURE__*/function (_React$Compo
             });
             onErrorProducedError = false;
             defaultUsers = [];
-            _context.prev = 16;
+            _context.prev = 17;
             if (!onError) {
-              _context.next = 19;
+              _context.next = 20;
               break;
             }
-            _context.next = 17;
+            _context.next = 18;
             return onError(_t6, recommendationsRequest);
-          case 17:
+          case 18:
             _t8 = _context.sent;
             if (_t8) {
-              _context.next = 18;
+              _context.next = 19;
               break;
             }
             _t8 = [];
-          case 18:
+          case 19:
             _t7 = _t8;
-            _context.next = 20;
+            _context.next = 21;
             break;
-          case 19:
-            _t7 = [];
           case 20:
+            _t7 = [];
+          case 21:
             defaultUsers = _t7;
-            _context.next = 22;
+            _context.next = 23;
             break;
-          case 21:
-            _context.prev = 21;
-            _t9 = _context["catch"](16);
-            onErrorProducedError = true;
           case 22:
+            _context.prev = 22;
+            _t9 = _context["catch"](17);
+            onErrorProducedError = true;
+          case 23:
             if (onErrorProducedError && is5xxEvent) {
               // Log error from fallback data source `onError` to UFO
               _this.optionsShownUfoExperienceInstance.failure(ufoEndStateConfig(_this.props.fieldId));
@@ -396,11 +409,11 @@ export var SmartUserPickerWithoutAnalytics = /*#__PURE__*/function (_React$Compo
               elapsedTimeMilli: _elapsedTimeMilli,
               productAttributes: productAttributes
             });
-          case 23:
+          case 24:
           case "end":
             return _context.stop();
         }
-      }, _callee, null, [[1, 15], [16, 21]]);
+      }, _callee, null, [[1, 15], [17, 22]]);
     })), (_this$props$debounceT = _this.props.debounceTime) !== null && _this$props$debounceT !== void 0 ? _this$props$debounceT : 0));
     _defineProperty(_this, "onInputChange", function (newQuery, sessionId) {
       var query = newQuery || '';

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/smart-user-picker",
-	"version": "11.3.3",
+	"version": "11.5.0",
 	"license": "Apache-2.0",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"
@@ -44,7 +44,7 @@
 	"devDependencies": {
 		"@atlaskit/select": "^22.6.0",
 		"@atlaskit/util-data-test": "^19.1.0",
-		"@atlassian/a11y-jest-testing": "^0.14.0",
+		"@atlassian/a11y-jest-testing": "^0.15.0",
 		"@atlassian/feature-flags-test-utils": "^1.2.0",
 		"@testing-library/dom": "^10.1.0",
 		"@testing-library/react": "^16.3.0",
@@ -61,10 +61,10 @@
 		"smart_user_picker_suggest_emails_for_domain": {
 			"type": "boolean"
 		},
-		"smart-user-picker-load-options-gate": {
+		"smart-user-picker-fetch-error-fix": {
 			"type": "boolean"
 		},
-		"smart-user-picker-restrict-to-gate": {
+		"smart-user-picker-load-options-gate": {
 			"type": "boolean"
 		},
 		"user_picker_guest_lozenges": {