@truedat/dd 8.5.1 → 8.5.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@truedat/dd",
-  "version": "8.5.1",
+  "version": "8.5.3",
   "description": "Truedat Web Data Dictionary",
   "sideEffects": false,
   "module": "src/index.js",
@@ -51,7 +51,7 @@
     "@testing-library/jest-dom": "^6.6.3",
     "@testing-library/react": "^16.3.0",
     "@testing-library/user-event": "^14.6.1",
-    "@truedat/test": "8.5.1",
+    "@truedat/test": "8.5.3",
     "identity-obj-proxy": "^3.0.0",
     "jest": "^29.7.0",
     "redux-saga-test-plan": "^4.0.6"
@@ -86,5 +86,5 @@
     "svg-pan-zoom": "^3.6.2",
     "swr": "^2.3.3"
   },
-  "gitHead": "d29d6cba24bb1c464650348851cfaf1911bbedfd"
+  "gitHead": "9d67766fe0910fe519b6f1f2042b4a5dcc28fad5"
 }

package/src/api/queries.js

@@ -485,7 +485,7 @@ export const LEGACY_DATA_STRUCTURE_VERSION_QUERY = gql`
   }
 `;
 
-export const DATA_STRUCTURE_VERSION_QUERY = gql`
+export const buildDSVQuery = (loadStructureMetadata) => gql`
   query DataStructureVersion($dataStructureId: ID!, $version: String!) {
     dataStructureVersion(dataStructureId: $dataStructureId, version: $version) {
       id
@@ -496,6 +496,7 @@ export const DATA_STRUCTURE_VERSION_QUERY = gql`
       type
       group
       deleted_at
+      ${loadStructureMetadata ? `metadata` : ""}
       data_structure {
         alias
         confidential

package/src/components/StructureLoader.js

@@ -4,13 +4,17 @@ import { connect } from "react-redux";
 import { useParams } from "react-router";
 import { clearStructure, fetchStructure } from "../routines";
 
+import { useWebContext } from "@truedat/core/webContext";
+
 export const StructureLoader = ({ fetchStructure, clearStructure }) => {
   const { id, version } = useParams();
 
+  const { loadStructureMetadata } = useWebContext();
+
   useEffect(() => {
-    fetchStructure({ id, version });
+    fetchStructure({ id, version, loadStructureMetadata });
     return () => clearStructure();
-  }, [id, version]);
+  }, [id, version, loadStructureMetadata, fetchStructure, clearStructure]);
 
   return null;
 };
@@ -21,5 +25,5 @@ StructureLoader.propTypes = {
 };
 
 export default connect(null, { fetchStructure, clearStructure })(
-  StructureLoader
+  StructureLoader,
 );

package/src/components/__tests__/StructureLoader.spec.js

@@ -5,6 +5,11 @@ jest.mock("react-router", () => ({
   ...jest.requireActual("react-router"),
   useParams: () => ({ id: 1, version: 8 }),
 }));
+jest.mock("@truedat/core/webContext", () => ({
+  useWebContext: jest.fn(),
+}));
+
+const { useWebContext } = require("@truedat/core/webContext");
 
 const props = {
   clearStructure: jest.fn(),
@@ -13,9 +18,26 @@ const props = {
 
 describe("<StructureLoader />", () => {
   it("matches the latest snapshot", () => {
+    useWebContext.mockReturnValue({ loadStructureMetadata: false });
     const { container } = render(<StructureLoader {...props} />);
     expect(container).toMatchSnapshot();
 
-    expect(props.fetchStructure).toHaveBeenCalledWith({ id: 1, version: 8 });
+    expect(props.fetchStructure).toHaveBeenCalledWith({
+      id: 1,
+      version: 8,
+      loadStructureMetadata: false,
+    });
+  });
+
+  it("matches the latest snapshot", () => {
+    useWebContext.mockReturnValue({ loadStructureMetadata: true });
+
+    render(<StructureLoader {...props} />);
+
+    expect(props.fetchStructure).toHaveBeenCalledWith({
+      id: 1,
+      version: 8,
+      loadStructureMetadata: true,
+    });
   });
 });

package/src/sagas/__tests__/fetchStructure.spec.js

@@ -5,7 +5,7 @@ import {
 } from "../fetchStructure";
 
 import { fetchStructure } from "../../routines";
-import { DATA_STRUCTURE_VERSION_QUERY } from "../../api/queries";
+import { buildDSVQuery } from "../../api/queries";
 import { getStructureFieldColumns } from "../../selectors";
 
 describe("sagas: fetchStructureRequestSaga", () => {
@@ -60,7 +60,7 @@ describe("sagas: fetchStructureSaga", () => {
 
   it("should put a success action when a response is returned", () => {
     const meta = { version };
-
+    const payload = { id };
     expect(() => {
       testSaga(fetchStructureSaga, { payload })
         .next()
@@ -73,7 +73,7 @@ describe("sagas: fetchStructureSaga", () => {
 
         .call(client.query, {
           fetchPolicy: "network-only",
-          query: DATA_STRUCTURE_VERSION_QUERY,
+          query: buildDSVQuery(false),
           variables,
         })
         .next({ data: { dataStructureVersion } })
@@ -107,7 +107,96 @@ describe("sagas: fetchStructureSaga", () => {
         .next()
         .call(client.query, {
           fetchPolicy: "network-only",
-          query: DATA_STRUCTURE_VERSION_QUERY,
+          query: buildDSVQuery(false),
+          variables,
+        })
+        .next({ data: { dataStructureVersion } })
+        .put({ meta, ...fetchStructure.success(data) })
+        .next()
+        .put(fetchStructure.fulfill())
+        .next()
+        .isDone();
+    }).not.toThrow();
+  });
+
+  it("should put a failure action when the call returns an error", () => {
+    const message = "Request failed";
+    const error = { message };
+    const payload = { id };
+    expect(() => {
+      testSaga(fetchStructureSaga, { payload })
+        .next()
+        .select(getStructureFieldColumns)
+        .next(structureFieldColumns)
+        .getContext("client")
+        .next(client)
+        .put(fetchStructure.request())
+        .next()
+        .call(client.query, {
+          fetchPolicy: "network-only",
+          query: buildDSVQuery(false),
+          variables,
+        })
+        .throw(error)
+        .put(fetchStructure.failure(message))
+        .next()
+        .put(fetchStructure.fulfill())
+        .next()
+        .isDone();
+    }).not.toThrow();
+  });
+
+  it("should put a success action when a response is returned", () => {
+    const meta = { version };
+    const payload = { id, loadStructureMetadata: true };
+
+    expect(() => {
+      testSaga(fetchStructureSaga, { payload })
+        .next()
+        .select(getStructureFieldColumns)
+        .next(structureFieldColumns)
+        .getContext("client")
+        .next(client)
+        .put(fetchStructure.request())
+        .next()
+
+        .call(client.query, {
+          fetchPolicy: "network-only",
+          query: buildDSVQuery(true),
+          variables,
+        })
+        .next({ data: { dataStructureVersion } })
+        .put({ meta, ...fetchStructure.success(data) })
+        .next()
+        .put(fetchStructure.fulfill())
+        .next()
+        .isDone();
+    }).not.toThrow();
+  });
+
+  it("should put a success action when a response is returned - with version", () => {
+    const version = 23;
+    const payload = { id, version, loadStructureMetadata: true };
+    const meta = { version };
+
+    const variables = {
+      dataStructureId: id,
+      version,
+      note_fields: ["note_field"],
+    };
+
+    expect(() => {
+      testSaga(fetchStructureSaga, { payload })
+        .next()
+        .select(getStructureFieldColumns)
+        .next(structureFieldColumns)
+        .getContext("client")
+        .next(client)
+        .put(fetchStructure.request())
+        .next()
+        .call(client.query, {
+          fetchPolicy: "network-only",
+          query: buildDSVQuery(true),
           variables,
         })
         .next({ data: { dataStructureVersion } })
@@ -122,6 +211,7 @@ describe("sagas: fetchStructureSaga", () => {
   it("should put a failure action when the call returns an error", () => {
     const message = "Request failed";
     const error = { message };
+    const payload = { id, loadStructureMetadata: true };
 
     expect(() => {
       testSaga(fetchStructureSaga, { payload })
@@ -134,7 +224,7 @@ describe("sagas: fetchStructureSaga", () => {
         .next()
         .call(client.query, {
           fetchPolicy: "network-only",
-          query: DATA_STRUCTURE_VERSION_QUERY,
+          query: buildDSVQuery(true),
           variables,
         })
         .throw(error)

package/src/sagas/fetchStructure.js

@@ -1,7 +1,7 @@
 import _ from "lodash/fp";
 import { call, put, takeLatest, select, getContext } from "redux-saga/effects";
 import { fetchStructure } from "../routines";
-import { DATA_STRUCTURE_VERSION_QUERY } from "../api/queries";
+import { buildDSVQuery } from "../api/queries";
 import { getStructureFieldColumns } from "../selectors";
 
 export function* fetchStructureSaga({ payload }) {
@@ -9,19 +9,19 @@ export function* fetchStructureSaga({ payload }) {
     const structureFieldColumns = yield select(getStructureFieldColumns);
     const note_fields = _.flow(
       _.filter(({ name }) => name.startsWith("note.")),
-      _.map(({ name }) => name.split(".")[1])
+      _.map(({ name }) => name.split(".")[1]),
     )(structureFieldColumns);
 
     const client = yield getContext("client");
 
     yield put(fetchStructure.request());
 
-    const { id, version = "latest" } = payload;
+    const { id, version = "latest", loadStructureMetadata } = payload;
     const {
       data: { dataStructureVersion },
     } = yield call(client.query, {
       fetchPolicy: "network-only",
-      query: DATA_STRUCTURE_VERSION_QUERY,
+      query: buildDSVQuery(loadStructureMetadata),
       variables: {
         dataStructureId: id,
         version,