Merge branch 'master' into Add-polling-mode-for-result-viewer

CHANGELOG.md

@@ -13,6 +13,7 @@
 * [UIPQB-131](https://folio-org.atlassian.net/browse/UIPQB-131) Columns and empty area display in the list details page, when we refresh the page 1st time or duplicate the list
 * [UIPQB-132](https://folio-org.atlassian.net/browse/UIPQB-132) Save not empty previews results and show it in test query
 * [UIPQB-126](https://folio-org.atlassian.net/browse/UIPQB-126) Update date format in requests to UTC
+* [UIPQB-125](https://folio-org.atlassian.net/browse/UIPQB-125) Add support for FQM _version
 
 ## [1.1.4](https://github.com/folio-org/ui-plugin-query-builder/tree/v1.1.4) (2024-04-02)
 

package.json

@@ -14,7 +14,9 @@
     ],
     "pluginType": "query-builder",
     "displayName": "ui-plugin-query-builder.meta.title",
-    "okapiInterfaces": {},
+    "okapiInterfaces": {
+      "fqm-query": "2.0"
+    },
     "stripesDeps": [
       "@folio/stripes-acq-components"
     ]

src/QueryBuilder/QueryBuilder/QueryBuilderModal/QueryBuilderModal.js

@@ -18,8 +18,9 @@ import { useRunQuery } from '../../../hooks/useRunQuery';
 import { getSourceValue, useQuerySource } from '../../../hooks/useQuerySource';
 import { queryBuilderModalPropTypes } from '../../propTypes';
 import { QUERY_DETAILS_STATUSES, QUERY_KEYS } from '../../../constants/query';
-import { useEntityType } from '../../../hooks/useEntityType';
 import { useCancelQuery } from '../../../hooks/useCancelQuery';
+import { useEntityType } from '../../../hooks/useEntityType';
+import { useFqmVersion } from '../../../hooks/useFqmVersion';
 import { useTestQuery } from '../../../hooks/useTestQuery';
 import { getFieldOptions } from '../helpers/selectOptions';
 import upgradeInitialValues from '../helpers/upgradeInitialValues';
@@ -62,6 +63,8 @@ export const QueryBuilderModal = ({
     },
   });
 
+  const fqmVersion = useFqmVersion();
+
   const { cancelQuery } = useCancelQuery({ cancelQueryDataSource });
 
   const initialValues = useMemo(
@@ -160,7 +163,7 @@ export const QueryBuilderModal = ({
   const handleRun = async () => {
     await runQuery({
       queryId,
-      fqlQuery,
+      fqlQuery: { ...fqlQuery, _version: fqmVersion },
       userFriendlyQuery: queryStr,
     });
 

src/QueryBuilder/QueryBuilder/helpers/upgradeInitialValues.js

@@ -2,12 +2,25 @@
  * Upgrades initial values to indirectly reference id columns (e.g. vendor_code instead of vendor_id).
  * FQM used to previously require vendor_id, but this was changed in MODFQMMGR-151 to allow for better expression
  * and to allow for more flexibility in the future.
+ *
+ * As part of UIPQB-125, we're stripping out the _version key from the initial values, too. We will assume that any
+ * queries edited/created here are the latest version, as we only have the latest version of entity types available.
+ * In the future, it might be neat to send a request to /fqm/migrate if we see initialValues are out of date, but that's
+ * outside the scope of UIPQB-125 as we already upgrade queries in the background in mod-lists.
  */
 export default function upgradeInitialValues(initialValues, entityType) {
-  if (!initialValues || !entityType) {
+  if (!initialValues) {
     return initialValues;
   }
 
+  const withoutVersion = { ...initialValues };
+
+  delete withoutVersion._version;
+
+  if (!entityType) {
+    return withoutVersion;
+  }
+
   const idColumnMapping = {};
 
   entityType.columns.forEach((column) => {
@@ -18,10 +31,10 @@ export default function upgradeInitialValues(initialValues, entityType) {
 
   const upgradedInitialValues = {};
 
-  Object.keys(initialValues).forEach((key) => {
+  Object.keys(withoutVersion).forEach((key) => {
     const newKey = idColumnMapping[key] || key;
 
-    upgradedInitialValues[newKey] = initialValues[key];
+    upgradedInitialValues[newKey] = withoutVersion[key];
   });
 
   return upgradedInitialValues;

src/QueryBuilder/QueryBuilder/helpers/upgradeInitialValues.test.js

@@ -13,7 +13,7 @@ describe('initial values legacy conversion', () => {
     [{}, null],
     [{}, undefined],
   ])('ignores initialValues=%s and entityType=%s', (initialValues, entityType) => {
-    expect(upgradeInitialValues(initialValues, entityType)).toBe(initialValues);
+    expect(upgradeInitialValues(initialValues, entityType)).toStrictEqual(initialValues);
   });
 
   it.each([{}, { foo: '' }, { bar: '' }, { foo: '', bar: '' }])(
@@ -26,7 +26,8 @@ describe('initial values legacy conversion', () => {
   );
 
   it.each([
-    [{ idColumn: '' }, { foo: '' }],
+    [{ _version: '1', foo: '' }, { foo: '' }],
+    [{ _version: '1', idColumn: '' }, { foo: '' }],
     [
       { idColumn: '', bar: '' },
       { foo: '', bar: '' },

src/constants/query.js

@@ -5,6 +5,8 @@ export const QUERY_DETAILS_STATUSES = {
 };
 
 export const QUERY_KEYS = {
+  FQM_VERSION: 'FQM_VERSION',
+
   QUERY_PLUGIN_CONTENT_DATA: 'QUERY_PLUGIN_CONTENT_DATA',
   QUERY_PLUGIN_ENTITY_TYPE: 'QUERY_PLUGIN_ENTITY_TYPE',
   QUERY_PLUGIN_PREVIEW_ENTITY_TYPE: 'QUERY_PLUGIN_PREVIEW_ENTITY_TYPE',

src/hooks/useFqmVersion.js

@@ -0,0 +1,15 @@
+import { useNamespace, useOkapiKy } from '@folio/stripes/core';
+import { useQuery } from 'react-query';
+import { QUERY_KEYS } from '../constants/query';
+
+export function useFqmVersion() {
+  const ky = useOkapiKy();
+  const [queryKey] = useNamespace({ key: QUERY_KEYS.FQM_VERSION });
+
+  return (
+    useQuery({
+      queryKey: [queryKey],
+      queryFn: () => ky.get('fqm/version').text(),
+    }).data ?? '0'
+  );
+}