@atlaskit/smart-card 16.1.1 → 16.2.0

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # @atlaskit/smart-card
 
+## 16.2.0
+
+### Minor Changes
+
+- [`0448db49f68`](https://bitbucket.org/atlassian/atlassian-frontend/commits/0448db49f68) - Implement UFO instrumentation events pattern
+
+### Patch Changes
+
+- [`df4e03438f2`](https://bitbucket.org/atlassian/atlassian-frontend/commits/df4e03438f2) - Add post render authentication experience using UFO
+- [`7d13155a61c`](https://bitbucket.org/atlassian/atlassian-frontend/commits/7d13155a61c) - Updated smart links to UFO with perf metrics
+- [`572581a2ae3`](https://bitbucket.org/atlassian/atlassian-frontend/commits/572581a2ae3) - Polaris (Jira Product Discovery) anonymous views unfurling embed by default.
+- Updated dependencies
+
 ## 16.1.1
 
 ### Patch Changes

package/dist/cjs/client/utils/environments.js

@@ -5,7 +5,7 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.default = exports.getResolverUrl = exports.getBaseUrl = exports.BaseUrls = void 0;
 var devBaseUrl = 'https://api-private.dev.atlassian.com';
-var stgBaseUrl = 'https://api-private.stg.atlassian.com';
+var stgBaseUrl = 'https://commerce-components-preview.dev.atlassian.com/gateway/api';
 var prodBaseUrl = 'https://api-private.atlassian.com';
 var BaseUrls = {
   dev: devBaseUrl,

package/dist/cjs/providers/editor/transformer.js

@@ -16,7 +16,7 @@ var isJiraRoadMap = function isJiraRoadMap(url) {
 };
 
 var isPolarisView = function isPolarisView(url) {
-  return url.match(/^https:\/\/.*?\/jira\/polaris\/projects\/[^\/]+?\/ideas\/view\/\d+$/);
+  return url.match(/^https:\/\/.*?\/jira\/polaris\/projects\/[^\/]+?\/ideas\/view\/\d+$|^https:\/\/.*?\/secure\/JiraProductDiscoveryAnonymous\.jspa\?hash=\w+|^https:\/\/.*?\/jira\/polaris\/share\/\w+/);
 };
 
 var isSlackMessage = function isSlackMessage(url) {

package/dist/cjs/state/actions/index.js

@@ -31,6 +31,8 @@ var _errors = require("../../client/errors");
 
 var _jsonld = require("../../utils/jsonld");
 
+var _analytics = require("../analytics");
+
 function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
 
 function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || _typeof(obj) !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
@@ -124,7 +126,7 @@ var useSmartCardActions = function useSmartCardActions(id, url, analytics) {
             isReloading = _args.length > 1 && _args[1] !== undefined ? _args[1] : false;
 
             if (!(isReloading || !hasData)) {
-              _context.next = 4;
+              _context.next = 6;
               break;
             }
 
@@ -134,13 +136,18 @@ var useSmartCardActions = function useSmartCardActions(id, url, analytics) {
               return handleResolvedLinkError(resourceUrl, error);
             }));
 
-          case 4:
+          case 6:
+            (0, _analytics.addMetadataToExperience)('smart-link-rendered', id, {
+              cached: true
+            });
+
+          case 7:
           case "end":
             return _context.stop();
         }
       }
     }, _callee);
-  })), [url, hasData, connections.client, handleResolvedLinkResponse, handleResolvedLinkError]);
+  })), [url, hasData, connections.client, handleResolvedLinkResponse, handleResolvedLinkError, id]);
   var register = (0, _react.useCallback)(function () {
     if (!details) {
       dispatch((0, _helpers.cardAction)(_constants.ACTION_PENDING, {
@@ -178,10 +185,10 @@ var useSmartCardActions = function useSmartCardActions(id, url, analytics) {
       analytics.screen.authPopupEvent(definitionId, extensionKey);
       (0, _outboundAuthFlowClient.auth)(services[0].url).then(function () {
         analytics.track.appAccountConnected(definitionId, extensionKey);
-        analytics.operational.connectSucceededEvent(definitionId, extensionKey);
+        analytics.operational.connectSucceededEvent(id, definitionId, extensionKey);
         reload();
       }, function (err) {
-        analytics.operational.connectFailedEvent(definitionId, extensionKey, err.type);
+        analytics.operational.connectFailedEvent(id, definitionId, extensionKey, err.type);
 
         if (err.type === 'auth_window_closed') {
           analytics.ui.closedAuthEvent(appearance, definitionId, extensionKey);
@@ -190,7 +197,7 @@ var useSmartCardActions = function useSmartCardActions(id, url, analytics) {
         reload();
       });
     }
-  }, [analytics.ui, analytics.screen, analytics.track, analytics.operational, reload, details, status]);
+  }, [analytics.ui, analytics.screen, analytics.track, analytics.operational, id, reload, details, status]);
   var invoke = (0, _react.useCallback)( /*#__PURE__*/function () {
     var _ref3 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee2(opts, appearance) {
       var key, action, source, markName, response;

package/dist/cjs/state/analytics/index.js

@@ -3,89 +3,37 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.useSmartLinkAnalytics = void 0;
-
-var _analytics = require("../../utils/analytics");
-
-var _react = require("react");
-
-var useSmartLinkAnalytics = function useSmartLinkAnalytics(dispatchAnalytics) {
-  var ui = (0, _react.useMemo)(function () {
-    return {
-      authEvent: function authEvent(display, definitionId, extensionKey) {
-        return dispatchAnalytics((0, _analytics.uiAuthEvent)(display, definitionId, extensionKey));
-      },
-      authAlternateAccountEvent: function authAlternateAccountEvent(display, definitionId, extensionKey) {
-        return dispatchAnalytics((0, _analytics.uiAuthAlternateAccountEvent)(display, definitionId, extensionKey));
-      },
-      cardClickedEvent: function cardClickedEvent(display, definitionId, extensionKey) {
-        return dispatchAnalytics((0, _analytics.uiCardClickedEvent)(display, definitionId, extensionKey));
-      },
-      actionClickedEvent: function actionClickedEvent(providerKey, actionType, display) {
-        return dispatchAnalytics((0, _analytics.uiActionClickedEvent)(providerKey, actionType, display));
-      },
-      closedAuthEvent: function closedAuthEvent(display, definitionId, extensionKey) {
-        return dispatchAnalytics((0, _analytics.uiClosedAuthEvent)(display, definitionId, extensionKey));
-      },
-      renderSuccessEvent: function renderSuccessEvent(display, definitionId, extensionKey) {
-        return dispatchAnalytics((0, _analytics.uiRenderSuccessEvent)(display, definitionId, extensionKey));
-      },
-      renderFailedEvent: function renderFailedEvent(display, error, errorInfo) {
-        return dispatchAnalytics((0, _analytics.uiRenderFailedEvent)(display, error, errorInfo));
-      }
-    };
-  }, [dispatchAnalytics]);
-  var operational = (0, _react.useMemo)(function () {
-    return {
-      resolvedEvent: function resolvedEvent(id, definitionId, extensionKey, resourceType) {
-        return dispatchAnalytics((0, _analytics.resolvedEvent)(id, definitionId, extensionKey, resourceType));
-      },
-      unresolvedEvent: function unresolvedEvent(id, status, definitionId, extensionKey, resourceType) {
-        return dispatchAnalytics((0, _analytics.unresolvedEvent)(id, status, definitionId, extensionKey, resourceType));
-      },
-      invokeSucceededEvent: function invokeSucceededEvent(id, providerKey, actionType, display) {
-        return dispatchAnalytics((0, _analytics.invokeSucceededEvent)(id, providerKey, actionType, display));
-      },
-      invokeFailedEvent: function invokeFailedEvent(id, providerKey, actionType, display, reason) {
-        return dispatchAnalytics((0, _analytics.invokeFailedEvent)(id, providerKey, actionType, display, reason));
-      },
-      connectSucceededEvent: function connectSucceededEvent(definitionId, extensionKey) {
-        return dispatchAnalytics((0, _analytics.connectSucceededEvent)(definitionId, extensionKey));
-      },
-      connectFailedEvent: function connectFailedEvent(definitionId, extensionKey, reason) {
-        return dispatchAnalytics((0, _analytics.connectFailedEvent)(definitionId, extensionKey, reason));
-      },
-      instrument: function instrument(id, status, definitionId, extensionKey, resourceType, error) {
-        var event = (0, _analytics.instrumentEvent)(id, status, definitionId, extensionKey, resourceType, error);
+Object.defineProperty(exports, "startUfoExperience", {
+  enumerable: true,
+  get: function get() {
+    return _ufoExperiences.startUfoExperience;
+  }
+});
+Object.defineProperty(exports, "succeedUfoExperience", {
+  enumerable: true,
+  get: function get() {
+    return _ufoExperiences.succeedUfoExperience;
+  }
+});
+Object.defineProperty(exports, "failUfoExperience", {
+  enumerable: true,
+  get: function get() {
+    return _ufoExperiences.failUfoExperience;
+  }
+});
+Object.defineProperty(exports, "addMetadataToExperience", {
+  enumerable: true,
+  get: function get() {
+    return _ufoExperiences.addMetadataToExperience;
+  }
+});
+Object.defineProperty(exports, "useSmartLinkAnalytics", {
+  enumerable: true,
+  get: function get() {
+    return _useSmartLinkAnalytics.useSmartLinkAnalytics;
+  }
+});
 
-        if (event) {
-          dispatchAnalytics(event);
-        }
-      }
-    };
-  }, [dispatchAnalytics]);
-  var track = (0, _react.useMemo)(function () {
-    return {
-      appAccountConnected: function appAccountConnected(definitionId, extensionKey) {
-        return dispatchAnalytics((0, _analytics.trackAppAccountConnected)(definitionId, extensionKey));
-      }
-    };
-  }, [dispatchAnalytics]);
-  var screen = (0, _react.useMemo)(function () {
-    return {
-      authPopupEvent: function authPopupEvent(definitionId, extensionKey) {
-        return dispatchAnalytics((0, _analytics.screenAuthPopupEvent)(definitionId, extensionKey));
-      }
-    };
-  }, [dispatchAnalytics]);
-  return (0, _react.useMemo)(function () {
-    return {
-      ui: ui,
-      operational: operational,
-      track: track,
-      screen: screen
-    };
-  }, [ui, operational, track, screen]);
-};
+var _ufoExperiences = require("./ufoExperiences");
 
-exports.useSmartLinkAnalytics = useSmartLinkAnalytics;
+var _useSmartLinkAnalytics = require("./useSmartLinkAnalytics");

package/dist/cjs/state/analytics/ufoExperiences.js

@@ -0,0 +1,60 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.addMetadataToExperience = exports.failUfoExperience = exports.succeedUfoExperience = exports.startUfoExperience = void 0;
+
+var _ufo = require("@atlaskit/ufo");
+
+var ufoExperiences = {
+  'smart-link-rendered': new _ufo.ConcurrentExperience('smart-link-rendered', {
+    type: _ufo.ExperienceTypes.Load,
+    performanceType: _ufo.ExperiencePerformanceTypes.PageSegmentLoad,
+    platform: {
+      component: 'smart-links'
+    }
+  }),
+  'smart-link-authenticated': new _ufo.ConcurrentExperience('smart-link-authenticated', {
+    type: _ufo.ExperienceTypes.Load,
+    performanceType: _ufo.ExperiencePerformanceTypes.PageSegmentLoad,
+    platform: {
+      component: 'smart-links'
+    }
+  })
+};
+
+var startUfoExperience = function startUfoExperience(experienceName, id, properties) {
+  var experience = ufoExperiences[experienceName].getInstance(id);
+  experience.start();
+
+  if (properties) {
+    experience.addMetadata(properties);
+  }
+};
+
+exports.startUfoExperience = startUfoExperience;
+
+var succeedUfoExperience = function succeedUfoExperience(experienceName, id, properties) {
+  var experience = ufoExperiences[experienceName].getInstance(id);
+  experience.success({
+    metadata: properties
+  });
+};
+
+exports.succeedUfoExperience = succeedUfoExperience;
+
+var failUfoExperience = function failUfoExperience(experienceName, id, properties) {
+  var experience = ufoExperiences[experienceName].getInstance(id);
+  experience.failure({
+    metadata: properties
+  });
+};
+
+exports.failUfoExperience = failUfoExperience;
+
+var addMetadataToExperience = function addMetadataToExperience(experienceName, id, properties) {
+  ufoExperiences[experienceName].getInstance(id).addMetadata(properties);
+};
+
+exports.addMetadataToExperience = addMetadataToExperience;

package/dist/cjs/state/analytics/useSmartLinkAnalytics.js

@@ -0,0 +1,106 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.useSmartLinkAnalytics = void 0;
+
+var _analytics = require("../../utils/analytics");
+
+var _react = require("react");
+
+var _ufoExperiences = require("./ufoExperiences");
+
+var useSmartLinkAnalytics = function useSmartLinkAnalytics(dispatchAnalytics) {
+  var ui = (0, _react.useMemo)(function () {
+    return {
+      authEvent: function authEvent(display, definitionId, extensionKey) {
+        return dispatchAnalytics((0, _analytics.uiAuthEvent)(display, definitionId, extensionKey));
+      },
+      authAlternateAccountEvent: function authAlternateAccountEvent(display, definitionId, extensionKey) {
+        return dispatchAnalytics((0, _analytics.uiAuthAlternateAccountEvent)(display, definitionId, extensionKey));
+      },
+      cardClickedEvent: function cardClickedEvent(display, definitionId, extensionKey) {
+        return dispatchAnalytics((0, _analytics.uiCardClickedEvent)(display, definitionId, extensionKey));
+      },
+      actionClickedEvent: function actionClickedEvent(providerKey, actionType, display) {
+        return dispatchAnalytics((0, _analytics.uiActionClickedEvent)(providerKey, actionType, display));
+      },
+      closedAuthEvent: function closedAuthEvent(display, definitionId, extensionKey) {
+        return dispatchAnalytics((0, _analytics.uiClosedAuthEvent)(display, definitionId, extensionKey));
+      },
+      renderSuccessEvent: function renderSuccessEvent(display, id, definitionId, extensionKey) {
+        (0, _ufoExperiences.succeedUfoExperience)('smart-link-rendered', id, {
+          extensionKey: extensionKey,
+          display: display
+        }); // UFO will disregard this if authentication experience has not yet been started
+
+        (0, _ufoExperiences.succeedUfoExperience)('smart-link-authenticated', id, {
+          display: display
+        });
+        dispatchAnalytics((0, _analytics.uiRenderSuccessEvent)(display, definitionId, extensionKey));
+      }
+    };
+  }, [dispatchAnalytics]);
+  var operational = (0, _react.useMemo)(function () {
+    return {
+      resolvedEvent: function resolvedEvent(id, definitionId, extensionKey, resourceType) {
+        return dispatchAnalytics((0, _analytics.resolvedEvent)(id, definitionId, extensionKey, resourceType));
+      },
+      unresolvedEvent: function unresolvedEvent(id, status, definitionId, extensionKey, resourceType) {
+        return dispatchAnalytics((0, _analytics.unresolvedEvent)(id, status, definitionId, extensionKey, resourceType));
+      },
+      invokeSucceededEvent: function invokeSucceededEvent(id, providerKey, actionType, display) {
+        return dispatchAnalytics((0, _analytics.invokeSucceededEvent)(id, providerKey, actionType, display));
+      },
+      invokeFailedEvent: function invokeFailedEvent(id, providerKey, actionType, display, reason) {
+        return dispatchAnalytics((0, _analytics.invokeFailedEvent)(id, providerKey, actionType, display, reason));
+      },
+      connectSucceededEvent: function connectSucceededEvent(id, definitionId, extensionKey) {
+        (0, _ufoExperiences.startUfoExperience)('smart-link-authenticated', id, {
+          extensionKey: extensionKey,
+          status: 'success'
+        });
+        dispatchAnalytics((0, _analytics.connectSucceededEvent)(definitionId, extensionKey));
+      },
+      connectFailedEvent: function connectFailedEvent(id, definitionId, extensionKey, status) {
+        (0, _ufoExperiences.startUfoExperience)('smart-link-authenticated', id, {
+          extensionKey: extensionKey,
+          status: status
+        });
+        dispatchAnalytics((0, _analytics.connectFailedEvent)(definitionId, extensionKey, status));
+      },
+      instrument: function instrument(id, status, definitionId, extensionKey, resourceType, error) {
+        var event = (0, _analytics.instrumentEvent)(id, status, definitionId, extensionKey, resourceType, error);
+
+        if (event) {
+          dispatchAnalytics(event);
+        }
+      }
+    };
+  }, [dispatchAnalytics]);
+  var track = (0, _react.useMemo)(function () {
+    return {
+      appAccountConnected: function appAccountConnected(definitionId, extensionKey) {
+        return dispatchAnalytics((0, _analytics.trackAppAccountConnected)(definitionId, extensionKey));
+      }
+    };
+  }, [dispatchAnalytics]);
+  var screen = (0, _react.useMemo)(function () {
+    return {
+      authPopupEvent: function authPopupEvent(definitionId, extensionKey) {
+        return dispatchAnalytics((0, _analytics.screenAuthPopupEvent)(definitionId, extensionKey));
+      }
+    };
+  }, [dispatchAnalytics]);
+  return (0, _react.useMemo)(function () {
+    return {
+      ui: ui,
+      operational: operational,
+      track: track,
+      screen: screen
+    };
+  }, [ui, operational, track, screen]);
+};
+
+exports.useSmartLinkAnalytics = useSmartLinkAnalytics;

package/dist/cjs/state/hooks/useSmartLink.js

@@ -28,16 +28,15 @@ function useSmartLink(id, url, dispatchAnalytics) {
   var config = (0, _config.useSmartLinkConfig)();
   var renderers = (0, _renderers.useSmartLinkRenderers)(); // NB: used to propagate errors from hooks to error boundaries.
 
-  var _useState = (0, _react.useState)(),
+  var _useState = (0, _react.useState)(null),
       _useState2 = (0, _slicedToArray2.default)(_useState, 2),
-      setState = _useState2[1]; // Register the current card.
+      error = _useState2[0],
+      setError = _useState2[1]; // Register the current card.
 
 
   var register = function register() {
     actions.register().catch(function (err) {
-      return setState(function () {
-        throw err;
-      });
+      return setError(err);
     });
   }; // AFP-2511 TODO: Fix automatic suppressions below
   // eslint-disable-next-line react-hooks/exhaustive-deps
@@ -50,6 +49,7 @@ function useSmartLink(id, url, dispatchAnalytics) {
     actions: actions,
     config: config,
     analytics: analytics,
-    renderers: renderers
+    renderers: renderers,
+    error: error
   };
 }

package/dist/cjs/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/smart-card",
-	"version": "16.1.1",
+	"version": "16.2.0",
 	"sideEffects": false
 }

package/dist/cjs/view/CardWithUrl/component-lazy/index.js

@@ -5,7 +5,7 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.LazyCardWithUrlContent = LazyCardWithUrlContent;
+exports.default = LazyCardWithUrlContent;
 
 var _react = _interopRequireDefault(require("react"));
 

package/dist/cjs/view/CardWithUrl/component.js

@@ -49,7 +49,8 @@ function CardWithUrlContent(_ref) {
       actions = _useSmartLink.actions,
       config = _useSmartLink.config,
       analytics = _useSmartLink.analytics,
-      renderers = _useSmartLink.renderers;
+      renderers = _useSmartLink.renderers,
+      error = _useSmartLink.error;
 
   var definitionId = (0, _helpers.getDefinitionId)(state.details);
   var extensionKey = (0, _helpers.getExtensionKey)(state.details);
@@ -92,9 +93,13 @@ function CardWithUrlContent(_ref) {
 
   (0, _react.useEffect)(function () {
     if ((0, _helpers.isFinalState)(state.status)) {
-      analytics.ui.renderSuccessEvent(appearance, definitionId, extensionKey);
+      analytics.ui.renderSuccessEvent(appearance, id, definitionId, extensionKey);
     }
-  }, [appearance, state.details, state.status, url, definitionId, extensionKey, analytics.ui]);
+  }, [appearance, state.details, state.status, url, definitionId, extensionKey, analytics.ui, id]); // We have to keep this last to prevent hook order from being violated
+
+  if (error) {
+    throw error;
+  }
 
   switch (appearance) {
     case 'inline':