@atlaskit/link-datasource 6.14.1 → 6.14.2

package/CHANGELOG.md

@@ -1,5 +1,15 @@
 # @atlaskit/link-datasource
 
+## 6.14.2
+
+### Patch Changes
+
+- [`3f172371c9b66`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/3f172371c9b66) -
+  Preserve the selected Assets columns when only the AQL query changes, and persist datasource
+  updates that only change parameters. Both behind feature gate
+  `platform_lp_sllv_preserve_assets_columns`.
+- Updated dependencies
+
 ## 6.14.1
 
 ### Patch Changes

package/dist/cjs/ui/assets-modal/modal/index.js

@@ -23,6 +23,7 @@ var _modalFooter = _interopRequireDefault(require("@atlaskit/modal-dialog/modal-
 var _modalHeader = _interopRequireDefault(require("@atlaskit/modal-dialog/modal-header"));
 var _modalTitle = _interopRequireDefault(require("@atlaskit/modal-dialog/modal-title"));
 var _modalTransition = _interopRequireDefault(require("@atlaskit/modal-dialog/modal-transition"));
+var _fg = require("@atlaskit/platform-feature-flags/fg");
 var _constants = require("../../../analytics/constants");
 var _index = require("../../../analytics/index");
 var _types = require("../../../analytics/types");
@@ -77,10 +78,15 @@ var PlainAssetsConfigModal = function PlainAssetsConfigModal(props) {
     _useState8 = (0, _slicedToArray2.default)(_useState7, 2),
     isNewSearch = _useState8[0],
     setIsNewSearch = _useState8[1];
-  var _useState9 = (0, _react.useState)(),
+  // State rather than a ref because the reconciliation below reads it during render
+  var _useState9 = (0, _react.useState)(false),
     _useState0 = (0, _slicedToArray2.default)(_useState9, 2),
-    errorState = _useState0[0],
-    setErrorState = _useState0[1];
+    hasPreservedColumns = _useState0[0],
+    setHasPreservedColumns = _useState0[1];
+  var _useState1 = (0, _react.useState)(),
+    _useState10 = (0, _slicedToArray2.default)(_useState1, 2),
+    errorState = _useState10[0],
+    setErrorState = _useState10[1];
   var _useDatasourceAnalyti = (0, _index.useDatasourceAnalyticsEvents)(),
     fireEvent = _useDatasourceAnalyti.fireEvent;
   var experienceId = (0, _useDatasourceExperienceId.useDatasourceExperienceId)();
@@ -151,6 +157,26 @@ var PlainAssetsConfigModal = function PlainAssetsConfigModal(props) {
     destinationObjectTypes = _useDatasourceTableSt.destinationObjectTypes,
     totalCount = _useDatasourceTableSt.totalCount;
 
+  // A preserved selection must drop whatever the edited query stopped reporting. This is adjusted
+  // during render, not in an effect: the table hook is called before this component's own effects
+  // are registered, so its effects run first and would read the columns still awaiting removal as
+  // newly selected ones - refetching for them, and throwing away the results just received. The
+  // re-render this schedules is discarded before commit, so the hook only ever sees the reconciled
+  // selection.
+  if ((0, _fg.fg)('platform_lp_sllv_preserve_assets_columns') && hasPreservedColumns && status === 'resolved' && columns.length > 0) {
+    var availableKeys = new Set(columns.map(function (_ref) {
+      var key = _ref.key;
+      return key;
+    }));
+    var selectedKeys = visibleColumnKeys !== null && visibleColumnKeys !== void 0 ? visibleColumnKeys : [];
+    var retainedKeys = selectedKeys.filter(function (key) {
+      return availableKeys.has(key);
+    });
+    if (retainedKeys.length !== selectedKeys.length) {
+      setVisibleColumnKeys(retainedKeys.length > 0 ? retainedKeys : defaultVisibleColumnKeys);
+    }
+  }
+
   /* ------------------------------ OBSERVABILITY ------------------------------ */
   var searchCount = (0, _react.useRef)(0);
   var userInteractions = (0, _useUserInteractions.useUserInteractions)();
@@ -212,9 +238,28 @@ var PlainAssetsConfigModal = function PlainAssetsConfigModal(props) {
     setIsNewSearch(false);
   }, []);
   (0, _react.useEffect)(function () {
+    // A preserved selection owns the columns, so restoring the saved or default ones would undo it
+    if ((0, _fg.fg)('platform_lp_sllv_preserve_assets_columns') && hasPreservedColumns) {
+      return;
+    }
     var newVisibleColumnKeys = initialVisibleColumnKeys && initialVisibleColumnKeys.length > 0 && apiVersion === VERSION_TWO ? initialVisibleColumnKeys : defaultVisibleColumnKeys;
     setVisibleColumnKeys(newVisibleColumnKeys);
-  }, [initialVisibleColumnKeys, defaultVisibleColumnKeys, apiVersion]);
+  }, [initialVisibleColumnKeys, defaultVisibleColumnKeys, apiVersion, hasPreservedColumns]);
+  (0, _react.useEffect)(function () {
+    // The response described none of the requested fields, so there is nothing valid to keep and
+    // no reported defaults to fall back to. Give up preserving and re-request the schema's own
+    // defaults. This one has to stay an effect because it issues a request.
+    if (!(0, _fg.fg)('platform_lp_sllv_preserve_assets_columns') || !hasPreservedColumns || status !== 'resolved' || columns.length > 0) {
+      return;
+    }
+    setHasPreservedColumns(false);
+    setVisibleColumnKeys([]);
+    setIsNewSearch(true);
+    reset({
+      shouldForceRequest: true,
+      shouldResetColumns: true
+    });
+  }, [columns, hasPreservedColumns, reset, status]);
   (0, _react.useEffect)(function () {
     if (isNewSearch) {
       setVisibleColumnKeys(defaultVisibleColumnKeys);
@@ -290,16 +335,22 @@ var PlainAssetsConfigModal = function PlainAssetsConfigModal(props) {
       if (aql !== searchAql) {
         userInteractions.add(_types.DatasourceAction.QUERY_UPDATED);
       }
+      // An empty selection has nothing worth preserving, and keeping it would stop the
+      // response's defaults from being adopted
+      var shouldPreserveColumns = (0, _fg.fg)('platform_lp_sllv_preserve_assets_columns') && schemaId === searchSchemaId && (visibleColumnKeys !== null && visibleColumnKeys !== void 0 ? visibleColumnKeys : []).length > 0;
+      setHasPreservedColumns(shouldPreserveColumns);
       setAql(searchAql);
       setSchemaId(searchSchemaId);
-      setVisibleColumnKeys([]);
-      setIsNewSearch(true);
+      if (!shouldPreserveColumns) {
+        setVisibleColumnKeys([]);
+      }
+      setIsNewSearch(!shouldPreserveColumns);
       reset({
         shouldForceRequest: true,
-        shouldResetColumns: true
+        shouldResetColumns: !shouldPreserveColumns
       });
     }
-  }, [aql, reset, schemaId, status, userInteractions]);
+  }, [aql, reset, schemaId, status, userInteractions, visibleColumnKeys]);
   var renderErrorState = (0, _react.useCallback)(function () {
     if (errorState) {
       switch (errorState) {

package/dist/es2019/ui/assets-modal/modal/index.js

@@ -13,6 +13,7 @@ import ModalFooter from '@atlaskit/modal-dialog/modal-footer';
 import ModalHeader from '@atlaskit/modal-dialog/modal-header';
 import ModalTitle from '@atlaskit/modal-dialog/modal-title';
 import ModalTransition from '@atlaskit/modal-dialog/modal-transition';
+import { fg } from '@atlaskit/platform-feature-flags/fg';
 import { EVENT_CHANNEL } from '../../../analytics/constants';
 import { componentMetadata } from '../../../analytics/constants';
 import { useDatasourceAnalyticsEvents } from '../../../analytics/index';
@@ -55,6 +56,8 @@ const PlainAssetsConfigModal = props => {
   const apiVersion = initialParameters === null || initialParameters === void 0 ? void 0 : initialParameters.version;
   const [visibleColumnKeys, setVisibleColumnKeys] = useState(apiVersion !== VERSION_TWO ? [] : initialVisibleColumnKeys);
   const [isNewSearch, setIsNewSearch] = useState(false);
+  // State rather than a ref because the reconciliation below reads it during render
+  const [hasPreservedColumns, setHasPreservedColumns] = useState(false);
   const [errorState, setErrorState] = useState();
   const {
     fireEvent
@@ -126,6 +129,23 @@ const PlainAssetsConfigModal = props => {
     fieldKeys: isNewSearch ? [] : visibleColumnKeys
   });
 
+  // A preserved selection must drop whatever the edited query stopped reporting. This is adjusted
+  // during render, not in an effect: the table hook is called before this component's own effects
+  // are registered, so its effects run first and would read the columns still awaiting removal as
+  // newly selected ones - refetching for them, and throwing away the results just received. The
+  // re-render this schedules is discarded before commit, so the hook only ever sees the reconciled
+  // selection.
+  if (fg('platform_lp_sllv_preserve_assets_columns') && hasPreservedColumns && status === 'resolved' && columns.length > 0) {
+    const availableKeys = new Set(columns.map(({
+      key
+    }) => key));
+    const selectedKeys = visibleColumnKeys !== null && visibleColumnKeys !== void 0 ? visibleColumnKeys : [];
+    const retainedKeys = selectedKeys.filter(key => availableKeys.has(key));
+    if (retainedKeys.length !== selectedKeys.length) {
+      setVisibleColumnKeys(retainedKeys.length > 0 ? retainedKeys : defaultVisibleColumnKeys);
+    }
+  }
+
   /* ------------------------------ OBSERVABILITY ------------------------------ */
   const searchCount = useRef(0);
   const userInteractions = useUserInteractions();
@@ -188,9 +208,28 @@ const PlainAssetsConfigModal = props => {
     setIsNewSearch(false);
   }, []);
   useEffect(() => {
+    // A preserved selection owns the columns, so restoring the saved or default ones would undo it
+    if (fg('platform_lp_sllv_preserve_assets_columns') && hasPreservedColumns) {
+      return;
+    }
     const newVisibleColumnKeys = initialVisibleColumnKeys && initialVisibleColumnKeys.length > 0 && apiVersion === VERSION_TWO ? initialVisibleColumnKeys : defaultVisibleColumnKeys;
     setVisibleColumnKeys(newVisibleColumnKeys);
-  }, [initialVisibleColumnKeys, defaultVisibleColumnKeys, apiVersion]);
+  }, [initialVisibleColumnKeys, defaultVisibleColumnKeys, apiVersion, hasPreservedColumns]);
+  useEffect(() => {
+    // The response described none of the requested fields, so there is nothing valid to keep and
+    // no reported defaults to fall back to. Give up preserving and re-request the schema's own
+    // defaults. This one has to stay an effect because it issues a request.
+    if (!fg('platform_lp_sllv_preserve_assets_columns') || !hasPreservedColumns || status !== 'resolved' || columns.length > 0) {
+      return;
+    }
+    setHasPreservedColumns(false);
+    setVisibleColumnKeys([]);
+    setIsNewSearch(true);
+    reset({
+      shouldForceRequest: true,
+      shouldResetColumns: true
+    });
+  }, [columns, hasPreservedColumns, reset, status]);
   useEffect(() => {
     if (isNewSearch) {
       setVisibleColumnKeys(defaultVisibleColumnKeys);
@@ -264,16 +303,22 @@ const PlainAssetsConfigModal = props => {
       if (aql !== searchAql) {
         userInteractions.add(DatasourceAction.QUERY_UPDATED);
       }
+      // An empty selection has nothing worth preserving, and keeping it would stop the
+      // response's defaults from being adopted
+      const shouldPreserveColumns = fg('platform_lp_sllv_preserve_assets_columns') && schemaId === searchSchemaId && (visibleColumnKeys !== null && visibleColumnKeys !== void 0 ? visibleColumnKeys : []).length > 0;
+      setHasPreservedColumns(shouldPreserveColumns);
       setAql(searchAql);
       setSchemaId(searchSchemaId);
-      setVisibleColumnKeys([]);
-      setIsNewSearch(true);
+      if (!shouldPreserveColumns) {
+        setVisibleColumnKeys([]);
+      }
+      setIsNewSearch(!shouldPreserveColumns);
       reset({
         shouldForceRequest: true,
-        shouldResetColumns: true
+        shouldResetColumns: !shouldPreserveColumns
       });
     }
-  }, [aql, reset, schemaId, status, userInteractions]);
+  }, [aql, reset, schemaId, status, userInteractions, visibleColumnKeys]);
   const renderErrorState = useCallback(() => {
     if (errorState) {
       switch (errorState) {

package/dist/esm/ui/assets-modal/modal/index.js

@@ -17,6 +17,7 @@ import ModalFooter from '@atlaskit/modal-dialog/modal-footer';
 import ModalHeader from '@atlaskit/modal-dialog/modal-header';
 import ModalTitle from '@atlaskit/modal-dialog/modal-title';
 import ModalTransition from '@atlaskit/modal-dialog/modal-transition';
+import { fg } from '@atlaskit/platform-feature-flags/fg';
 import { EVENT_CHANNEL } from '../../../analytics/constants';
 import { componentMetadata } from '../../../analytics/constants';
 import { useDatasourceAnalyticsEvents } from '../../../analytics/index';
@@ -69,10 +70,15 @@ var PlainAssetsConfigModal = function PlainAssetsConfigModal(props) {
     _useState8 = _slicedToArray(_useState7, 2),
     isNewSearch = _useState8[0],
     setIsNewSearch = _useState8[1];
-  var _useState9 = useState(),
+  // State rather than a ref because the reconciliation below reads it during render
+  var _useState9 = useState(false),
     _useState0 = _slicedToArray(_useState9, 2),
-    errorState = _useState0[0],
-    setErrorState = _useState0[1];
+    hasPreservedColumns = _useState0[0],
+    setHasPreservedColumns = _useState0[1];
+  var _useState1 = useState(),
+    _useState10 = _slicedToArray(_useState1, 2),
+    errorState = _useState10[0],
+    setErrorState = _useState10[1];
   var _useDatasourceAnalyti = useDatasourceAnalyticsEvents(),
     fireEvent = _useDatasourceAnalyti.fireEvent;
   var experienceId = useDatasourceExperienceId();
@@ -143,6 +149,26 @@ var PlainAssetsConfigModal = function PlainAssetsConfigModal(props) {
     destinationObjectTypes = _useDatasourceTableSt.destinationObjectTypes,
     totalCount = _useDatasourceTableSt.totalCount;
 
+  // A preserved selection must drop whatever the edited query stopped reporting. This is adjusted
+  // during render, not in an effect: the table hook is called before this component's own effects
+  // are registered, so its effects run first and would read the columns still awaiting removal as
+  // newly selected ones - refetching for them, and throwing away the results just received. The
+  // re-render this schedules is discarded before commit, so the hook only ever sees the reconciled
+  // selection.
+  if (fg('platform_lp_sllv_preserve_assets_columns') && hasPreservedColumns && status === 'resolved' && columns.length > 0) {
+    var availableKeys = new Set(columns.map(function (_ref) {
+      var key = _ref.key;
+      return key;
+    }));
+    var selectedKeys = visibleColumnKeys !== null && visibleColumnKeys !== void 0 ? visibleColumnKeys : [];
+    var retainedKeys = selectedKeys.filter(function (key) {
+      return availableKeys.has(key);
+    });
+    if (retainedKeys.length !== selectedKeys.length) {
+      setVisibleColumnKeys(retainedKeys.length > 0 ? retainedKeys : defaultVisibleColumnKeys);
+    }
+  }
+
   /* ------------------------------ OBSERVABILITY ------------------------------ */
   var searchCount = useRef(0);
   var userInteractions = useUserInteractions();
@@ -204,9 +230,28 @@ var PlainAssetsConfigModal = function PlainAssetsConfigModal(props) {
     setIsNewSearch(false);
   }, []);
   useEffect(function () {
+    // A preserved selection owns the columns, so restoring the saved or default ones would undo it
+    if (fg('platform_lp_sllv_preserve_assets_columns') && hasPreservedColumns) {
+      return;
+    }
     var newVisibleColumnKeys = initialVisibleColumnKeys && initialVisibleColumnKeys.length > 0 && apiVersion === VERSION_TWO ? initialVisibleColumnKeys : defaultVisibleColumnKeys;
     setVisibleColumnKeys(newVisibleColumnKeys);
-  }, [initialVisibleColumnKeys, defaultVisibleColumnKeys, apiVersion]);
+  }, [initialVisibleColumnKeys, defaultVisibleColumnKeys, apiVersion, hasPreservedColumns]);
+  useEffect(function () {
+    // The response described none of the requested fields, so there is nothing valid to keep and
+    // no reported defaults to fall back to. Give up preserving and re-request the schema's own
+    // defaults. This one has to stay an effect because it issues a request.
+    if (!fg('platform_lp_sllv_preserve_assets_columns') || !hasPreservedColumns || status !== 'resolved' || columns.length > 0) {
+      return;
+    }
+    setHasPreservedColumns(false);
+    setVisibleColumnKeys([]);
+    setIsNewSearch(true);
+    reset({
+      shouldForceRequest: true,
+      shouldResetColumns: true
+    });
+  }, [columns, hasPreservedColumns, reset, status]);
   useEffect(function () {
     if (isNewSearch) {
       setVisibleColumnKeys(defaultVisibleColumnKeys);
@@ -282,16 +327,22 @@ var PlainAssetsConfigModal = function PlainAssetsConfigModal(props) {
       if (aql !== searchAql) {
         userInteractions.add(DatasourceAction.QUERY_UPDATED);
       }
+      // An empty selection has nothing worth preserving, and keeping it would stop the
+      // response's defaults from being adopted
+      var shouldPreserveColumns = fg('platform_lp_sllv_preserve_assets_columns') && schemaId === searchSchemaId && (visibleColumnKeys !== null && visibleColumnKeys !== void 0 ? visibleColumnKeys : []).length > 0;
+      setHasPreservedColumns(shouldPreserveColumns);
       setAql(searchAql);
       setSchemaId(searchSchemaId);
-      setVisibleColumnKeys([]);
-      setIsNewSearch(true);
+      if (!shouldPreserveColumns) {
+        setVisibleColumnKeys([]);
+      }
+      setIsNewSearch(!shouldPreserveColumns);
       reset({
         shouldForceRequest: true,
-        shouldResetColumns: true
+        shouldResetColumns: !shouldPreserveColumns
       });
     }
-  }, [aql, reset, schemaId, status, userInteractions]);
+  }, [aql, reset, schemaId, status, userInteractions, visibleColumnKeys]);
   var renderErrorState = useCallback(function () {
     if (errorState) {
       switch (errorState) {

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/link-datasource",
-	"version": "6.14.1",
+	"version": "6.14.2",
 	"description": "UI Components to support linking platform dataset feature",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -183,6 +183,9 @@
 		"platform_lp_sllv_ux_improvements": {
 			"type": "boolean"
 		},
+		"platform_lp_sllv_preserve_assets_columns": {
+			"type": "boolean"
+		},
 		"platform_lp_sllv_table_settings_menu": {
 			"type": "boolean"
 		},