@atlaskit/link-create 1.13.1 → 1.13.2

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # @atlaskit/link-create
 
+## 1.13.2
+
+### Patch Changes
+
+- [#64870](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/64870) [`0f1f6c106355`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/0f1f6c106355) - Adds analytics attribute to help exclude expected errors from SLIs, behind ff
+- Updated dependencies
+
 ## 1.13.1
 
 ### Patch Changes

package/analytics.spec.yaml

@@ -84,7 +84,6 @@ events:
         <<: *PackageMetaDataContext
         <<: *LinkCreateAnalyticContext
 
-
   - modalDialog opened (linkCreate):
       type: ui
       description: fired when a link create modal component is mounted
@@ -122,7 +121,7 @@ events:
 
   - object createFailed (linkCreate):
       type: track
-      description: "[DEPRECATED] prefer `operation failed (linkCreate)` — fired when the object creation fails"
+      description: '[DEPRECATED] prefer `operation failed (linkCreate)` — fired when the object creation fails'
       attributes:
         <<: *PackageMetaDataContext
         failureType:
@@ -158,3 +157,6 @@ events:
           type: string
           required: false
           description: The x-trace-id header associated with the network request if the failure is a Response
+        isSLOFailure:
+          type: boolean
+          description: Whether the failure should be considered for affecting SLO (should we ignore the failure)

package/dist/cjs/common/utils/analytics/analytics.codegen.js

@@ -11,7 +11,7 @@ var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/sli
  *
  * Generates Typescript types for analytics events from analytics.spec.yaml
  *
- * @codegen <<SignedSource::1c67626e82d39af8e93ced7a11389f4f>>
+ * @codegen <<SignedSource::7beb355391f6269c701cf87b0c222d69>>
  * @codegenCommand yarn workspace @atlaskit/link-create run codegen-analytics
  */
 

package/dist/cjs/controllers/experience-tracker/index.js

@@ -23,6 +23,27 @@ var ExperienceContext = /*#__PURE__*/(0, _react.createContext)({
   failure: function failure() {}
 });
 
+/**
+ * Error message matches to ignore
+ * These should not affect our SLOs as there's nothing we can do about them
+ */
+var IGNORE_ERROR_MESSAGES = [/failed to fetch/i];
+
+/**
+ * Returns false for errors that should not be considered failures of our SLO
+ * because they are failures only the user can handle.
+ */
+var isErrorSLOFailure = function isErrorSLOFailure(error) {
+  if (error instanceof Error) {
+    if (IGNORE_ERROR_MESSAGES.some(function (msg) {
+      return msg.test(error.message);
+    })) {
+      return false;
+    }
+  }
+  return true;
+};
+
 /**
  * Experience provider that simply keeps track of the state of the experience.
  * Fires an operational event when experience state changes to FAILED.
@@ -66,7 +87,11 @@ var Experience = exports.Experience = function Experience(_ref) {
            * Previous experience status indicates whether the experience
            * has just failed now, or has already failing
            */
-          previousExperienceStatus: experience.current
+          previousExperienceStatus: experience.current,
+          /**
+           * Whether the failure should be involved when considering SLI/SLO
+           */
+          isSLOFailure: (0, _platformFeatureFlags.getBooleanFF)('platform.linking-platform.link-create.slo-ignore-failed-fetch') ? isErrorSLOFailure(error) : true
         }, (0, _errors.getNetworkFields)(error)))).fire(_constants.ANALYTICS_CHANNEL);
         if (error instanceof Error) {
           if ((0, _platformFeatureFlags.getBooleanFF)('platform.linking-platform.link-create.enable-sentry-client')) {
@@ -74,8 +99,22 @@ var Experience = exports.Experience = function Experience(_ref) {
             (0, _sentry.captureException)(error, 'link-create');
           }
         }
-        if (experience.current !== experienceStatus) {
-          experience.current = experienceStatus;
+        if ((0, _platformFeatureFlags.getBooleanFF)('platform.linking-platform.link-create.slo-ignore-failed-fetch')) {
+          /**
+           * Only consider the experience truly failed if the
+           * failure is one we haven't correctly handled.
+           *
+           * In otherwords allow the experience to be "restarted" for the user to try again
+           */
+          if (isErrorSLOFailure(error)) {
+            if (experience.current !== experienceStatus) {
+              experience.current = experienceStatus;
+            }
+          }
+        } else {
+          if (experience.current !== experienceStatus) {
+            experience.current = experienceStatus;
+          }
         }
       }
     };

package/dist/cjs/ui/main.js

@@ -31,7 +31,7 @@ var LinkCreateWithAnalyticsContext = (0, _analytics.withLinkCreateAnalyticsConte
 }));
 var PACKAGE_DATA = exports.PACKAGE_DATA = {
   packageName: "@atlaskit/link-create" || '',
-  packageVersion: "1.13.1" || '',
+  packageVersion: "1.13.2" || '',
   component: _constants.COMPONENT_NAME,
   componentName: _constants.COMPONENT_NAME
 };

package/dist/es2019/common/utils/analytics/analytics.codegen.js

@@ -3,7 +3,7 @@
  *
  * Generates Typescript types for analytics events from analytics.spec.yaml
  *
- * @codegen <<SignedSource::1c67626e82d39af8e93ced7a11389f4f>>
+ * @codegen <<SignedSource::7beb355391f6269c701cf87b0c222d69>>
  * @codegenCommand yarn workspace @atlaskit/link-create run codegen-analytics
  */
 

package/dist/es2019/controllers/experience-tracker/index.js

@@ -10,6 +10,25 @@ const ExperienceContext = /*#__PURE__*/createContext({
   failure: () => {}
 });
 
+/**
+ * Error message matches to ignore
+ * These should not affect our SLOs as there's nothing we can do about them
+ */
+const IGNORE_ERROR_MESSAGES = [/failed to fetch/i];
+
+/**
+ * Returns false for errors that should not be considered failures of our SLO
+ * because they are failures only the user can handle.
+ */
+const isErrorSLOFailure = error => {
+  if (error instanceof Error) {
+    if (IGNORE_ERROR_MESSAGES.some(msg => msg.test(error.message))) {
+      return false;
+    }
+  }
+  return true;
+};
+
 /**
  * Experience provider that simply keeps track of the state of the experience.
  * Fires an operational event when experience state changes to FAILED.
@@ -55,6 +74,10 @@ export const Experience = ({
          * has just failed now, or has already failing
          */
         previousExperienceStatus: experience.current,
+        /**
+         * Whether the failure should be involved when considering SLI/SLO
+         */
+        isSLOFailure: getBooleanFF('platform.linking-platform.link-create.slo-ignore-failed-fetch') ? isErrorSLOFailure(error) : true,
         /**
          * Fields related to `Response` object that can help with debugging
          * what has gone wrong
@@ -67,8 +90,22 @@ export const Experience = ({
           captureException(error, 'link-create');
         }
       }
-      if (experience.current !== experienceStatus) {
-        experience.current = experienceStatus;
+      if (getBooleanFF('platform.linking-platform.link-create.slo-ignore-failed-fetch')) {
+        /**
+         * Only consider the experience truly failed if the
+         * failure is one we haven't correctly handled.
+         *
+         * In otherwords allow the experience to be "restarted" for the user to try again
+         */
+        if (isErrorSLOFailure(error)) {
+          if (experience.current !== experienceStatus) {
+            experience.current = experienceStatus;
+          }
+        }
+      } else {
+        if (experience.current !== experienceStatus) {
+          experience.current = experienceStatus;
+        }
       }
     }
   }), [experience, createAnalyticsEvent]);

package/dist/es2019/ui/main.js

@@ -23,7 +23,7 @@ const LinkCreateWithAnalyticsContext = withLinkCreateAnalyticsContext( /*#__PURE
 }));
 export const PACKAGE_DATA = {
   packageName: "@atlaskit/link-create" || '',
-  packageVersion: "1.13.1" || '',
+  packageVersion: "1.13.2" || '',
   component: COMPONENT_NAME,
   componentName: COMPONENT_NAME
 };

package/dist/esm/common/utils/analytics/analytics.codegen.js

@@ -4,7 +4,7 @@ import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
  *
  * Generates Typescript types for analytics events from analytics.spec.yaml
  *
- * @codegen <<SignedSource::1c67626e82d39af8e93ced7a11389f4f>>
+ * @codegen <<SignedSource::7beb355391f6269c701cf87b0c222d69>>
  * @codegenCommand yarn workspace @atlaskit/link-create run codegen-analytics
  */
 

package/dist/esm/controllers/experience-tracker/index.js

@@ -13,6 +13,27 @@ var ExperienceContext = /*#__PURE__*/createContext({
   failure: function failure() {}
 });
 
+/**
+ * Error message matches to ignore
+ * These should not affect our SLOs as there's nothing we can do about them
+ */
+var IGNORE_ERROR_MESSAGES = [/failed to fetch/i];
+
+/**
+ * Returns false for errors that should not be considered failures of our SLO
+ * because they are failures only the user can handle.
+ */
+var isErrorSLOFailure = function isErrorSLOFailure(error) {
+  if (error instanceof Error) {
+    if (IGNORE_ERROR_MESSAGES.some(function (msg) {
+      return msg.test(error.message);
+    })) {
+      return false;
+    }
+  }
+  return true;
+};
+
 /**
  * Experience provider that simply keeps track of the state of the experience.
  * Fires an operational event when experience state changes to FAILED.
@@ -56,7 +77,11 @@ export var Experience = function Experience(_ref) {
            * Previous experience status indicates whether the experience
            * has just failed now, or has already failing
            */
-          previousExperienceStatus: experience.current
+          previousExperienceStatus: experience.current,
+          /**
+           * Whether the failure should be involved when considering SLI/SLO
+           */
+          isSLOFailure: getBooleanFF('platform.linking-platform.link-create.slo-ignore-failed-fetch') ? isErrorSLOFailure(error) : true
         }, getNetworkFields(error)))).fire(ANALYTICS_CHANNEL);
         if (error instanceof Error) {
           if (getBooleanFF('platform.linking-platform.link-create.enable-sentry-client')) {
@@ -64,8 +89,22 @@ export var Experience = function Experience(_ref) {
             captureException(error, 'link-create');
           }
         }
-        if (experience.current !== experienceStatus) {
-          experience.current = experienceStatus;
+        if (getBooleanFF('platform.linking-platform.link-create.slo-ignore-failed-fetch')) {
+          /**
+           * Only consider the experience truly failed if the
+           * failure is one we haven't correctly handled.
+           *
+           * In otherwords allow the experience to be "restarted" for the user to try again
+           */
+          if (isErrorSLOFailure(error)) {
+            if (experience.current !== experienceStatus) {
+              experience.current = experienceStatus;
+            }
+          }
+        } else {
+          if (experience.current !== experienceStatus) {
+            experience.current = experienceStatus;
+          }
         }
       }
     };

package/dist/esm/ui/main.js

@@ -23,7 +23,7 @@ var LinkCreateWithAnalyticsContext = withLinkCreateAnalyticsContext( /*#__PURE__
 }));
 export var PACKAGE_DATA = {
   packageName: "@atlaskit/link-create" || '',
-  packageVersion: "1.13.1" || '',
+  packageVersion: "1.13.2" || '',
   component: COMPONENT_NAME,
   componentName: COMPONENT_NAME
 };

package/dist/types/common/utils/analytics/analytics.codegen.d.ts

@@ -3,7 +3,7 @@
  *
  * Generates Typescript types for analytics events from analytics.spec.yaml
  *
- * @codegen <<SignedSource::1c67626e82d39af8e93ced7a11389f4f>>
+ * @codegen <<SignedSource::7beb355391f6269c701cf87b0c222d69>>
  * @codegenCommand yarn workspace @atlaskit/link-create run codegen-analytics
  */
 export type PackageMetaDataType = {
@@ -46,6 +46,7 @@ export type LinkCreateExperienceFailedAttributesType = {
     path: string | null;
     status: number | null;
     traceId: string | null;
+    isSLOFailure: boolean;
 };
 export type AnalyticsEventAttributes = {
     'screen.linkCreateScreen.viewed': LinkCreateScreenViewedAttributesType;

package/dist/types-ts4.5/common/utils/analytics/analytics.codegen.d.ts

@@ -3,7 +3,7 @@
  *
  * Generates Typescript types for analytics events from analytics.spec.yaml
  *
- * @codegen <<SignedSource::1c67626e82d39af8e93ced7a11389f4f>>
+ * @codegen <<SignedSource::7beb355391f6269c701cf87b0c222d69>>
  * @codegenCommand yarn workspace @atlaskit/link-create run codegen-analytics
  */
 export type PackageMetaDataType = {
@@ -46,6 +46,7 @@ export type LinkCreateExperienceFailedAttributesType = {
     path: string | null;
     status: number | null;
     traceId: string | null;
+    isSLOFailure: boolean;
 };
 export type AnalyticsEventAttributes = {
     'screen.linkCreateScreen.viewed': LinkCreateScreenViewedAttributesType;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/link-create",
-  "version": "1.13.1",
+  "version": "1.13.2",
   "description": "The driver component of meta creation flow",
   "author": "Atlassian Pty Ltd",
   "license": "Apache-2.0",
@@ -43,14 +43,14 @@
     "@atlaskit/form": "^9.0.3",
     "@atlaskit/icon": "^22.0.0",
     "@atlaskit/intl-messages-provider": "^1.0.2",
-    "@atlaskit/linking-common": "^5.1.0",
+    "@atlaskit/linking-common": "^5.3.0",
     "@atlaskit/modal-dialog": "^12.10.0",
     "@atlaskit/platform-feature-flags": "^0.2.1",
-    "@atlaskit/primitives": "^1.15.0",
+    "@atlaskit/primitives": "^1.16.0",
     "@atlaskit/select": "^17.0.3",
     "@atlaskit/spinner": "^16.0.0",
     "@atlaskit/textfield": "^6.0.0",
-    "@atlaskit/tokens": "^1.32.0",
+    "@atlaskit/tokens": "^1.33.0",
     "@babel/runtime": "^7.0.0",
     "@emotion/react": "^11.7.1",
     "debounce-promise": "^3.1.2",
@@ -128,6 +128,9 @@
     },
     "platform.linking-platform.link-create.tmp-fix-translations": {
       "type": "boolean"
+    },
+    "platform.linking-platform.link-create.slo-ignore-failed-fetch": {
+      "type": "boolean"
     }
   }
 }