@atlaskit/link-datasource 1.18.0 → 1.18.1

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # @atlaskit/link-datasource
 
+## 1.18.1
+
+### Patch Changes
+
+- [#43497](https://bitbucket.org/atlassian/atlassian-frontend/pull-requests/43497) [`049969f8eb1`](https://bitbucket.org/atlassian/atlassian-frontend/commits/049969f8eb1) - Added error logging to the datasource try catches.
+- Updated dependencies
+
 ## 1.18.0
 
 ### Minor Changes

package/dist/cjs/analytics/constants.js

@@ -7,5 +7,5 @@ exports.packageMetaData = exports.EVENT_CHANNEL = void 0;
 var EVENT_CHANNEL = exports.EVENT_CHANNEL = 'media';
 var packageMetaData = exports.packageMetaData = {
   packageName: "@atlaskit/link-datasource",
-  packageVersion: "1.18.0"
+  packageVersion: "1.18.1"
 };

package/dist/cjs/hooks/useDatasourceTableState.js

@@ -13,6 +13,7 @@ var _react = require("react");
 var _isEqual = _interopRequireDefault(require("lodash/isEqual"));
 var _linkClientExtension = require("@atlaskit/link-client-extension");
 var _analytics = require("../analytics");
+var _useErrorLogger2 = _interopRequireDefault(require("./useErrorLogger"));
 var useDatasourceTableState = exports.useDatasourceTableState = function useDatasourceTableState(_ref) {
   var datasourceId = _ref.datasourceId,
     parameters = _ref.parameters,
@@ -20,6 +21,8 @@ var useDatasourceTableState = exports.useDatasourceTableState = function useData
     fieldKeys = _ref$fieldKeys === void 0 ? [] : _ref$fieldKeys;
   var _useDatasourceAnalyti = (0, _analytics.useDatasourceAnalyticsEvents)(),
     fireEvent = _useDatasourceAnalyti.fireEvent;
+  var _useErrorLogger = (0, _useErrorLogger2.default)(),
+    captureError = _useErrorLogger.captureError;
   var idFieldCount = 1;
   var keyFieldCount = 1;
   var _useState = (0, _react.useState)([]),
@@ -110,25 +113,26 @@ var useDatasourceTableState = exports.useDatasourceTableState = function useData
           allColumns = schema.properties;
           newColumns = allColumns.filter(isColumnNotPresentInCurrentColumnsList);
           newColumns.length > 0 && setColumns([].concat((0, _toConsumableArray2.default)(columns), (0, _toConsumableArray2.default)(newColumns)));
-          _context.next = 23;
+          _context.next = 24;
           break;
         case 17:
           _context.prev = 17;
           _context.t0 = _context["catch"](2);
+          captureError('loadDatasourceDetails', _context.t0);
           if (!(_context.t0 instanceof Response && (_context.t0.status === 401 || _context.t0.status === 403))) {
-            _context.next = 22;
+            _context.next = 23;
             break;
           }
           setStatus('unauthorized');
           return _context.abrupt("return");
-        case 22:
-          setStatus('rejected');
         case 23:
+          setStatus('rejected');
+        case 24:
         case "end":
           return _context.stop();
       }
     }, _callee, null, [[2, 17]]);
-  })), [columns, datasourceId, getDatasourceDetails, parameters]);
+  })), [captureError, columns, datasourceId, getDatasourceDetails, parameters]);
   var applySchemaProperties = (0, _react.useCallback)(function (schema, fieldKeys) {
     var properties = schema.properties,
       _schema$defaultProper = schema.defaultProperties,
@@ -256,25 +260,26 @@ var useDatasourceTableState = exports.useDatasourceTableState = function useData
             });
           }
           setStatus('resolved');
-          _context2.next = 42;
+          _context2.next = 43;
           break;
         case 36:
           _context2.prev = 36;
           _context2.t0 = _context2["catch"](7);
+          captureError('onNextPage', _context2.t0);
           if (!(_context2.t0 instanceof Response && (_context2.t0.status === 401 || _context2.t0.status === 403))) {
-            _context2.next = 41;
+            _context2.next = 42;
             break;
           }
           setStatus('unauthorized');
           return _context2.abrupt("return");
-        case 41:
-          setStatus('rejected');
         case 42:
+          setStatus('rejected');
+        case 43:
         case "end":
           return _context2.stop();
       }
     }, _callee2, null, [[7, 36]]);
-  })), [parameters, fieldKeys, nextCursor, getDatasourceData, datasourceId, responseItems === null || responseItems === void 0 ? void 0 : responseItems.length, applySchemaProperties, fireEvent, fullSchema]);
+  })), [captureError, parameters, fieldKeys, nextCursor, getDatasourceData, datasourceId, responseItems === null || responseItems === void 0 ? void 0 : responseItems.length, applySchemaProperties, fireEvent, fullSchema]);
   var reset = (0, _react.useCallback)(function (options) {
     setStatus('empty');
     setResponseItems([]);

package/dist/cjs/hooks/useErrorLogger.js

@@ -0,0 +1,48 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _react = require("react");
+var _sentry = require("@atlaskit/linking-common/sentry");
+var _utils = require("@atlaskit/linking-common/utils");
+var _platformFeatureFlags = require("@atlaskit/platform-feature-flags");
+var _analytics = require("../analytics");
+var getNetworkFields = function getNetworkFields(error) {
+  return error instanceof Response ? {
+    traceId: (0, _utils.getTraceId)(error),
+    status: error.status
+  } : {
+    traceId: null,
+    status: null
+  };
+};
+var useErrorLogger = function useErrorLogger() {
+  var _useDatasourceAnalyti = (0, _analytics.useDatasourceAnalyticsEvents)(),
+    fireEvent = _useDatasourceAnalyti.fireEvent;
+
+  /**
+   * Sentry is good because it can retrieve name, message, stacktrace of an Error. That's why we will send to Sentry only
+   * if an error is instance of `Error`. Sentry is also capable of some PII scrubbing of these risky fields.
+   *
+   * We will send to Splunk every single time, though, but we won't send PII risky fields.
+   */
+  var captureError = (0, _react.useCallback)(function (errorLocation, error) {
+    var _getNetworkFields = getNetworkFields(error),
+      traceId = _getNetworkFields.traceId,
+      status = _getNetworkFields.status;
+    fireEvent('operational.datasource.operationFailed', {
+      errorLocation: errorLocation,
+      traceId: traceId,
+      status: status
+    });
+    if ((0, _platformFeatureFlags.getBooleanFF)('platform.linking-platform.datasources.enable-sentry-client') && error instanceof Error) {
+      (0, _sentry.captureException)(error, 'link-datasource');
+    }
+  }, [fireEvent]);
+  return {
+    captureError: captureError
+  };
+};
+var _default = exports.default = useErrorLogger;

package/dist/es2019/analytics/constants.js

@@ -1,5 +1,5 @@
 export const EVENT_CHANNEL = 'media';
 export const packageMetaData = {
   packageName: "@atlaskit/link-datasource",
-  packageVersion: "1.18.0"
+  packageVersion: "1.18.1"
 };

package/dist/es2019/hooks/useDatasourceTableState.js

@@ -2,6 +2,7 @@ import { useCallback, useEffect, useState } from 'react';
 import isEqual from 'lodash/isEqual';
 import { DEFAULT_GET_DATASOURCE_DATA_PAGE_SIZE, useDatasourceClientExtension } from '@atlaskit/link-client-extension';
 import { useDatasourceAnalyticsEvents } from '../analytics';
+import useErrorLogger from './useErrorLogger';
 export const useDatasourceTableState = ({
   datasourceId,
   parameters,
@@ -10,6 +11,9 @@ export const useDatasourceTableState = ({
   const {
     fireEvent
   } = useDatasourceAnalyticsEvents();
+  const {
+    captureError
+  } = useErrorLogger();
   const idFieldCount = 1;
   const keyFieldCount = 1;
   const [defaultVisibleColumnKeys, setDefaultVisibleColumnKeys] = useState([]);
@@ -54,13 +58,14 @@ export const useDatasourceTableState = ({
       const newColumns = allColumns.filter(isColumnNotPresentInCurrentColumnsList);
       newColumns.length > 0 && setColumns([...columns, ...newColumns]);
     } catch (e) {
+      captureError('loadDatasourceDetails', e);
       if (e instanceof Response && (e.status === 401 || e.status === 403)) {
         setStatus('unauthorized');
         return;
       }
       setStatus('rejected');
     }
-  }, [columns, datasourceId, getDatasourceDetails, parameters]);
+  }, [captureError, columns, datasourceId, getDatasourceDetails, parameters]);
   const applySchemaProperties = useCallback((schema, fieldKeys) => {
     let {
       properties,
@@ -160,13 +165,14 @@ export const useDatasourceTableState = ({
       }
       setStatus('resolved');
     } catch (e) {
+      captureError('onNextPage', e);
       if (e instanceof Response && (e.status === 401 || e.status === 403)) {
         setStatus('unauthorized');
         return;
       }
       setStatus('rejected');
     }
-  }, [parameters, fieldKeys, nextCursor, getDatasourceData, datasourceId, responseItems === null || responseItems === void 0 ? void 0 : responseItems.length, applySchemaProperties, fireEvent, fullSchema]);
+  }, [captureError, parameters, fieldKeys, nextCursor, getDatasourceData, datasourceId, responseItems === null || responseItems === void 0 ? void 0 : responseItems.length, applySchemaProperties, fireEvent, fullSchema]);
   const reset = useCallback(options => {
     setStatus('empty');
     setResponseItems([]);

package/dist/es2019/hooks/useErrorLogger.js

@@ -0,0 +1,44 @@
+import { useCallback } from 'react';
+import { captureException } from '@atlaskit/linking-common/sentry';
+import { getTraceId } from '@atlaskit/linking-common/utils';
+import { getBooleanFF } from '@atlaskit/platform-feature-flags';
+import { useDatasourceAnalyticsEvents } from '../analytics';
+const getNetworkFields = error => {
+  return error instanceof Response ? {
+    traceId: getTraceId(error),
+    status: error.status
+  } : {
+    traceId: null,
+    status: null
+  };
+};
+const useErrorLogger = () => {
+  const {
+    fireEvent
+  } = useDatasourceAnalyticsEvents();
+
+  /**
+   * Sentry is good because it can retrieve name, message, stacktrace of an Error. That's why we will send to Sentry only
+   * if an error is instance of `Error`. Sentry is also capable of some PII scrubbing of these risky fields.
+   *
+   * We will send to Splunk every single time, though, but we won't send PII risky fields.
+   */
+  const captureError = useCallback((errorLocation, error) => {
+    const {
+      traceId,
+      status
+    } = getNetworkFields(error);
+    fireEvent('operational.datasource.operationFailed', {
+      errorLocation,
+      traceId,
+      status
+    });
+    if (getBooleanFF('platform.linking-platform.datasources.enable-sentry-client') && error instanceof Error) {
+      captureException(error, 'link-datasource');
+    }
+  }, [fireEvent]);
+  return {
+    captureError
+  };
+};
+export default useErrorLogger;

package/dist/esm/analytics/constants.js

@@ -1,5 +1,5 @@
 export var EVENT_CHANNEL = 'media';
 export var packageMetaData = {
   packageName: "@atlaskit/link-datasource",
-  packageVersion: "1.18.0"
+  packageVersion: "1.18.1"
 };

package/dist/esm/hooks/useDatasourceTableState.js

@@ -6,6 +6,7 @@ import { useCallback, useEffect, useState } from 'react';
 import isEqual from 'lodash/isEqual';
 import { DEFAULT_GET_DATASOURCE_DATA_PAGE_SIZE, useDatasourceClientExtension } from '@atlaskit/link-client-extension';
 import { useDatasourceAnalyticsEvents } from '../analytics';
+import useErrorLogger from './useErrorLogger';
 export var useDatasourceTableState = function useDatasourceTableState(_ref) {
   var datasourceId = _ref.datasourceId,
     parameters = _ref.parameters,
@@ -13,6 +14,8 @@ export var useDatasourceTableState = function useDatasourceTableState(_ref) {
     fieldKeys = _ref$fieldKeys === void 0 ? [] : _ref$fieldKeys;
   var _useDatasourceAnalyti = useDatasourceAnalyticsEvents(),
     fireEvent = _useDatasourceAnalyti.fireEvent;
+  var _useErrorLogger = useErrorLogger(),
+    captureError = _useErrorLogger.captureError;
   var idFieldCount = 1;
   var keyFieldCount = 1;
   var _useState = useState([]),
@@ -103,25 +106,26 @@ export var useDatasourceTableState = function useDatasourceTableState(_ref) {
           allColumns = schema.properties;
           newColumns = allColumns.filter(isColumnNotPresentInCurrentColumnsList);
           newColumns.length > 0 && setColumns([].concat(_toConsumableArray(columns), _toConsumableArray(newColumns)));
-          _context.next = 23;
+          _context.next = 24;
           break;
         case 17:
           _context.prev = 17;
           _context.t0 = _context["catch"](2);
+          captureError('loadDatasourceDetails', _context.t0);
           if (!(_context.t0 instanceof Response && (_context.t0.status === 401 || _context.t0.status === 403))) {
-            _context.next = 22;
+            _context.next = 23;
             break;
           }
           setStatus('unauthorized');
           return _context.abrupt("return");
-        case 22:
-          setStatus('rejected');
         case 23:
+          setStatus('rejected');
+        case 24:
         case "end":
           return _context.stop();
       }
     }, _callee, null, [[2, 17]]);
-  })), [columns, datasourceId, getDatasourceDetails, parameters]);
+  })), [captureError, columns, datasourceId, getDatasourceDetails, parameters]);
   var applySchemaProperties = useCallback(function (schema, fieldKeys) {
     var properties = schema.properties,
       _schema$defaultProper = schema.defaultProperties,
@@ -249,25 +253,26 @@ export var useDatasourceTableState = function useDatasourceTableState(_ref) {
             });
           }
           setStatus('resolved');
-          _context2.next = 42;
+          _context2.next = 43;
           break;
         case 36:
           _context2.prev = 36;
           _context2.t0 = _context2["catch"](7);
+          captureError('onNextPage', _context2.t0);
           if (!(_context2.t0 instanceof Response && (_context2.t0.status === 401 || _context2.t0.status === 403))) {
-            _context2.next = 41;
+            _context2.next = 42;
             break;
           }
           setStatus('unauthorized');
           return _context2.abrupt("return");
-        case 41:
-          setStatus('rejected');
         case 42:
+          setStatus('rejected');
+        case 43:
         case "end":
           return _context2.stop();
       }
     }, _callee2, null, [[7, 36]]);
-  })), [parameters, fieldKeys, nextCursor, getDatasourceData, datasourceId, responseItems === null || responseItems === void 0 ? void 0 : responseItems.length, applySchemaProperties, fireEvent, fullSchema]);
+  })), [captureError, parameters, fieldKeys, nextCursor, getDatasourceData, datasourceId, responseItems === null || responseItems === void 0 ? void 0 : responseItems.length, applySchemaProperties, fireEvent, fullSchema]);
   var reset = useCallback(function (options) {
     setStatus('empty');
     setResponseItems([]);

package/dist/esm/hooks/useErrorLogger.js

@@ -0,0 +1,42 @@
+import { useCallback } from 'react';
+import { captureException } from '@atlaskit/linking-common/sentry';
+import { getTraceId } from '@atlaskit/linking-common/utils';
+import { getBooleanFF } from '@atlaskit/platform-feature-flags';
+import { useDatasourceAnalyticsEvents } from '../analytics';
+var getNetworkFields = function getNetworkFields(error) {
+  return error instanceof Response ? {
+    traceId: getTraceId(error),
+    status: error.status
+  } : {
+    traceId: null,
+    status: null
+  };
+};
+var useErrorLogger = function useErrorLogger() {
+  var _useDatasourceAnalyti = useDatasourceAnalyticsEvents(),
+    fireEvent = _useDatasourceAnalyti.fireEvent;
+
+  /**
+   * Sentry is good because it can retrieve name, message, stacktrace of an Error. That's why we will send to Sentry only
+   * if an error is instance of `Error`. Sentry is also capable of some PII scrubbing of these risky fields.
+   *
+   * We will send to Splunk every single time, though, but we won't send PII risky fields.
+   */
+  var captureError = useCallback(function (errorLocation, error) {
+    var _getNetworkFields = getNetworkFields(error),
+      traceId = _getNetworkFields.traceId,
+      status = _getNetworkFields.status;
+    fireEvent('operational.datasource.operationFailed', {
+      errorLocation: errorLocation,
+      traceId: traceId,
+      status: status
+    });
+    if (getBooleanFF('platform.linking-platform.datasources.enable-sentry-client') && error instanceof Error) {
+      captureException(error, 'link-datasource');
+    }
+  }, [fireEvent]);
+  return {
+    captureError: captureError
+  };
+};
+export default useErrorLogger;

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

@@ -3,7 +3,7 @@
  *
  * Generates Typescript types for analytics events from analytics.spec.yaml
  *
- * @codegen <<SignedSource::ccda345ed2d15f3bbe167f871f676090>>
+ * @codegen <<SignedSource::4e6414d2c19c29a67f20beee73d4b788>>
  * @codegenCommand yarn workspace @atlassian/analytics-tooling run analytics:codegen link-datasource
  */
 export type PackageMetaDataType = {
@@ -59,6 +59,11 @@ export type DatasourceRenderSuccessAttributesType = {
     display: 'table';
 };
 export type DatasourceRenderFailureAttributesType = {};
+export type DatasourceOperationFailedAttributesType = {
+    errorLocation: string | null;
+    traceId: string | null;
+    status: number | null;
+};
 export type NextItemLoadedAttributesType = {
     destinationObjectTypes: unknown[];
     extensionKey: string | null;
@@ -155,6 +160,9 @@ export type AnalyticsEventAttributes = {
     /**
      * Fired when an inserted datasource fails to render */
     'operational.datasource.renderFailure': DatasourceRenderFailureAttributesType;
+    /**
+     * Fired when a generic operation failed */
+    'operational.datasource.operationFailed': DatasourceOperationFailedAttributesType;
     /**
      * Fired when user scrolls to the next page/list of the objects */
     'track.nextItem.loaded': NextItemLoadedAttributesType;

package/dist/types/hooks/useErrorLogger.d.ts

@@ -0,0 +1,4 @@
+declare const useErrorLogger: () => {
+    captureError: (errorLocation: string, error: unknown) => void;
+};
+export default useErrorLogger;

package/dist/types-ts4.5/analytics/generated/analytics.types.d.ts

@@ -3,7 +3,7 @@
  *
  * Generates Typescript types for analytics events from analytics.spec.yaml
  *
- * @codegen <<SignedSource::ccda345ed2d15f3bbe167f871f676090>>
+ * @codegen <<SignedSource::4e6414d2c19c29a67f20beee73d4b788>>
  * @codegenCommand yarn workspace @atlassian/analytics-tooling run analytics:codegen link-datasource
  */
 export type PackageMetaDataType = {
@@ -59,6 +59,11 @@ export type DatasourceRenderSuccessAttributesType = {
     display: 'table';
 };
 export type DatasourceRenderFailureAttributesType = {};
+export type DatasourceOperationFailedAttributesType = {
+    errorLocation: string | null;
+    traceId: string | null;
+    status: number | null;
+};
 export type NextItemLoadedAttributesType = {
     destinationObjectTypes: unknown[];
     extensionKey: string | null;
@@ -155,6 +160,9 @@ export type AnalyticsEventAttributes = {
     /**
      * Fired when an inserted datasource fails to render */
     'operational.datasource.renderFailure': DatasourceRenderFailureAttributesType;
+    /**
+     * Fired when a generic operation failed */
+    'operational.datasource.operationFailed': DatasourceOperationFailedAttributesType;
     /**
      * Fired when user scrolls to the next page/list of the objects */
     'track.nextItem.loaded': NextItemLoadedAttributesType;

package/dist/types-ts4.5/hooks/useErrorLogger.d.ts

@@ -0,0 +1,4 @@
+declare const useErrorLogger: () => {
+    captureError: (errorLocation: string, error: unknown) => void;
+};
+export default useErrorLogger;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/link-datasource",
-  "version": "1.18.0",
+  "version": "1.18.1",
   "description": "UI Components to support linking platform dataset feature",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -46,7 +46,7 @@
     "@atlaskit/jql-ast": "^3.0.0",
     "@atlaskit/jql-editor-autocomplete-rest": "^2.0.0",
     "@atlaskit/link-client-extension": "^1.8.0",
-    "@atlaskit/linking-common": "^4.18.0",
+    "@atlaskit/linking-common": "^4.19.0",
     "@atlaskit/linking-types": "^8.5.0",
     "@atlaskit/lozenge": "^11.4.0",
     "@atlaskit/modal-dialog": "^12.8.0",
@@ -138,6 +138,9 @@
   "platform-feature-flags": {
     "platform.linking-platform.datasource.show-jlol-basic-filters": {
       "type": "boolean"
+    },
+    "platform.linking-platform.datasources.enable-sentry-client": {
+      "type": "boolean"
     }
   }
 }