@truedat/dd 8.8.7 → 8.9.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@truedat/dd",
-  "version": "8.8.7",
+  "version": "8.9.0",
   "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.8.7",
+    "@truedat/test": "8.9.0",
     "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": "ece3f2e166776ff7827198a134bad5a28b029dc7"
+  "gitHead": "beff9d7e01556d63d42e54c9f7b641503ee658b2"
 }

package/src/api/queries.js

@@ -487,7 +487,12 @@ export const LEGACY_DATA_STRUCTURE_VERSION_QUERY = gql`
 `;
 
 export const buildDSVQuery = (loadStructureMetadata) => gql`
-  query DataStructureVersion($dataStructureId: ID!, $version: String!) {
+  query DataStructureVersion(
+    $dataStructureId: ID!,
+    $version: String!,
+    $includeProfiledFields: Boolean = false
+    $skipProfiledFieldsExternalIds: [String!] = []
+  ) {
     dataStructureVersion(dataStructureId: $dataStructureId, version: $version) {
       id
       version
@@ -625,6 +630,9 @@ export const buildDSVQuery = (loadStructureMetadata) => gql`
         out
       }
       data_fields_count
+      has_profiled_data_fields(
+        skip_profiled_fields_external_ids: $skipProfiledFieldsExternalIds
+      ) @include(if: $includeProfiledFields)
       relations {
         parents {
           id
@@ -818,6 +826,7 @@ export const DATA_FIELDS_QUERY = gql`
     $before: Cursor
     $after: Cursor
     $filters: DataFieldsFilter
+    $includeProfile: Boolean = false
   ) {
     dataFields(
       dataStructureId: $dataStructureId
@@ -844,7 +853,7 @@ export const DATA_FIELDS_QUERY = gql`
         metadata
         name
         type
-        profile {
+        profile @include(if: $includeProfile) {
           max
           min
           most_frequent

package/src/components/StructureLoader.js

@@ -7,13 +7,35 @@ import { clearStructure, fetchStructure } from "../routines";
 
 export const StructureLoader = ({ fetchStructure, clearStructure }) => {
   const { id, version } = useParams();
+  const { profiledFields } = useWebContext();
 
   const { loadStructureMetadata } = useWebContext();
 
   useEffect(() => {
-    fetchStructure({ id, version, loadStructureMetadata });
+    fetchStructure({
+      id,
+      version,
+      loadStructureMetadata,
+      dataStructureVersionQueryVariables: {
+        includeProfiledFields: profiledFields?.enabled !== false,
+        skipProfiledFieldsExternalIds: Array.isArray(
+          profiledFields?.disabled_external_ids,
+        )
+          ? profiledFields.disabled_external_ids.filter(
+              (x) => typeof x === "string",
+            )
+          : [],
+      },
+    });
     return () => clearStructure();
-  }, [id, version, loadStructureMetadata, fetchStructure, clearStructure]);
+  }, [
+    id,
+    version,
+    loadStructureMetadata,
+    profiledFields,
+    fetchStructure,
+    clearStructure,
+  ]);
 
   return null;
 };

package/src/components/StructureNotesEdit.js

@@ -7,7 +7,6 @@ import { useIntl } from "react-intl";
 import { HistoryBackButton } from "@truedat/core/components";
 import { selectTemplate, selectDomains } from "@truedat/df/routines";
 import { applyTemplate, validateContent } from "@truedat/df/utils";
-import { apiJson } from "@truedat/core/services/api";
 import SuggestionsWidget from "@truedat/ai/components/suggestions/SuggestionsWidget";
 import { doStructureNoteAction } from "../routines";
 import { getLatestDfContent } from "../selectors/getSortedStructureNotes";
@@ -29,9 +28,6 @@ export const StructureNotesEdit = ({
   latestDfContent,
 }) => {
   const [content, setContent] = useState(latestDfContent);
-  const aiSuggestionsUrl = _.prop("_actions.ai_suggestions.href")(
-    structureNotes,
-  );
 
   const isModification = !_.isEmpty(latestDfContent);
 
@@ -76,22 +72,28 @@ export const StructureNotesEdit = ({
     setContent({ ...content, ...suggestions });
   };
 
-  const requestAiSuggestion = (callback) => {
-    const url = `${aiSuggestionsUrl}?language=${locale}`;
-    apiJson(url).then(callback);
+  const suggestionParams = {
+    resource_type: "data_structure",
+    resource_body: {
+      name: structure.name || "",
+      domain: _.get("domains[0].name")(structure) || "",
+      type: template?.name,
+    },
+    domain_ids: structure.domain_ids,
+    template_id: template?.id,
+    language: locale,
+    resource_id: structure.id ?? null,
   };
 
   return (
     <Segment attached="bottom">
       <TemplateLoader id="templateloader" />
-      {aiSuggestionsUrl ? (
-        <SuggestionsWidget
-          requestAiSuggestion={requestAiSuggestion}
-          template={template}
-          applySuggestions={applySuggestions}
-          isModification={isModification}
-        />
-      ) : null}
+      <SuggestionsWidget
+        suggestionParams={suggestionParams}
+        template={template}
+        applySuggestions={applySuggestions}
+        isModification={isModification}
+      />
       <Form>
         <DynamicForm
           onChange={setContent}

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

@@ -1,15 +1,15 @@
 import { render } from "@truedat/test/render";
+import { useWebContext } from "@truedat/core/webContext";
 import { StructureLoader } from "../StructureLoader";
 
-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");
+jest.mock("react-router", () => ({
+  ...jest.requireActual("react-router"),
+  useParams: () => ({ id: 1, version: 8 }),
+}));
 
 const props = {
   clearStructure: jest.fn(),
@@ -17,19 +17,28 @@ const props = {
 };
 
 describe("<StructureLoader />", () => {
-  it("matches the latest snapshot", () => {
+  beforeEach(() => {
+    useWebContext.mockReturnValue({});
+    props.clearStructure.mockClear();
+    props.fetchStructure.mockClear();
+  });
+
+  it("fetches structure without metadata", () => {
     useWebContext.mockReturnValue({ loadStructureMetadata: false });
-    const { container } = render(<StructureLoader {...props} />);
-    expect(container).toMatchSnapshot();
+    render(<StructureLoader {...props} />);
 
     expect(props.fetchStructure).toHaveBeenCalledWith({
       id: 1,
       version: 8,
       loadStructureMetadata: false,
+      dataStructureVersionQueryVariables: {
+        includeProfiledFields: true,
+        skipProfiledFieldsExternalIds: [],
+      },
     });
   });
 
-  it("matches the latest snapshot", () => {
+  it("fetches structure with metadata and profiled fields", () => {
     useWebContext.mockReturnValue({ loadStructureMetadata: true });
 
     render(<StructureLoader {...props} />);
@@ -38,6 +47,30 @@ describe("<StructureLoader />", () => {
       id: 1,
       version: 8,
       loadStructureMetadata: true,
+      dataStructureVersionQueryVariables: {
+        includeProfiledFields: true,
+        skipProfiledFieldsExternalIds: [],
+      },
+    });
+  });
+
+  it("passes profiled fields query variables from context", () => {
+    useWebContext.mockReturnValue({
+      profiledFields: {
+        enabled: false,
+        disabled_external_ids: ["ext_1", 4, null, "ext_2"],
+      },
+    });
+
+    render(<StructureLoader {...props} />);
+
+    expect(props.fetchStructure).toHaveBeenCalledWith({
+      id: 1,
+      version: 8,
+      dataStructureVersionQueryVariables: {
+        includeProfiledFields: false,
+        skipProfiledFieldsExternalIds: ["ext_1", "ext_2"],
+      },
     });
   });
 });

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

@@ -2,12 +2,22 @@ import userEvent from "@testing-library/user-event";
 import { waitFor } from "@testing-library/react";
 import { render, waitForLoad } from "@truedat/test/render";
 import { applyTemplate } from "@truedat/df/utils";
+import SuggestionsWidget from "@truedat/ai/components/suggestions/SuggestionsWidget";
 import { StructureNotesEdit } from "../StructureNotesEdit";
 
+jest.mock("@truedat/ai/components/suggestions/SuggestionsWidget", () => ({
+  __esModule: true,
+  default: jest.fn(() => null),
+}));
+
 describe("<StructureNotesEdit />", () => {
+  beforeEach(() => {
+    jest.clearAllMocks();
+  });
+
   it("matches the latest snapshot", async () => {
     const props = {
-      structure: { id: 1 },
+      structure: { id: 1, domain_ids: [1] },
       template: { id: 2 },
       doStructureNoteAction: () => {},
       selectTemplate: () => {},
@@ -24,17 +34,19 @@ describe("<StructureNotesEdit />", () => {
     expect(rendered.container).toMatchSnapshot();
   });
 
-  it("matches the latest snapshot with ai suggestion action", async () => {
+  it("passes data_structure suggestion params to the widget", async () => {
     const props = {
-      structure: { id: 1 },
-      template: { id: 2 },
+      structure: {
+        id: 7,
+        name: "my structure",
+        domain_ids: [3],
+        domains: [{ name: "my domain" }],
+      },
+      template: { id: 2, name: "my template" },
       doStructureNoteAction: () => {},
       selectTemplate: () => {},
       selectDomain: () => {},
       structureNotes: {
-        _actions: {
-          ai_suggestions: { href: "suggestion" },
-        },
         structureNotes: [],
       },
       latestDfContent: { foo: { value: "bar", origin: "user" } },
@@ -43,7 +55,19 @@ describe("<StructureNotesEdit />", () => {
     };
     const rendered = render(<StructureNotesEdit {...props} />);
     await waitForLoad(rendered);
-    expect(rendered.container).toMatchSnapshot();
+
+    await waitFor(() => expect(SuggestionsWidget).toHaveBeenCalled());
+    expect(SuggestionsWidget.mock.calls[0][0].suggestionParams).toMatchObject({
+      resource_type: "data_structure",
+      resource_id: 7,
+      template_id: 2,
+      domain_ids: [3],
+      resource_body: {
+        name: "my structure",
+        domain: "my domain",
+        type: "my template",
+      },
+    });
   });
 
   it("calls doStructureNoteAction when submit is clicked", async () => {

package/src/components/__tests__/__snapshots__/StructureNotesEdit.spec.js.snap

@@ -25,53 +25,3 @@ exports[`<StructureNotesEdit /> matches the latest snapshot 1`] = `
   </div>
 </div>
 `;
-
-exports[`<StructureNotesEdit /> matches the latest snapshot with ai suggestion action 1`] = `
-<div>
-  <div
-    class="ui bottom attached segment"
-  >
-    <div
-      class="ui segment"
-    >
-      <div
-        class="ui container"
-        style="display: flex; justify-content: space-between;"
-      >
-        <h4>
-          <i
-            aria-hidden="true"
-            class="lightbulb icon"
-          />
-          structure_note.ai_suggestion.header
-        </h4>
-        <div
-          class="ui hidden divider"
-        />
-        <button
-          class="ui button"
-        >
-          actions.ai_suggestion
-        </button>
-      </div>
-    </div>
-    <form
-      class="ui form"
-    >
-      <button
-        class="ui primary button"
-      >
-        actions.save
-      </button>
-      <a
-        class="ui secondary button td-icon-text-control"
-        data-discover="true"
-        href="/"
-        role="button"
-      >
-        actions.cancel
-      </a>
-    </form>
-  </div>
-</div>
-`;

package/src/reducers/structure.js

@@ -34,12 +34,14 @@ const structureVersionFields = _.pick([
   "group",
   "implementation_count",
   "data_fields_count",
+  "has_profiled_data_fields",
   "metadata",
   "name",
   "note",
   "parents",
   "children",
   "siblings",
+  "profile",
   "source",
   "system",
   "type",

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

@@ -119,6 +119,46 @@ describe("sagas: fetchStructureSaga", () => {
     }).not.toThrow();
   });
 
+  it("should forward extra query variables from payload", () => {
+    const payload = {
+      id,
+      dataStructureVersionQueryVariables: {
+        includeProfiledFields: false,
+        skipProfiledFieldsExternalIds: ["ext_1", 2, null, "ext_2"],
+      },
+    };
+    const meta = { version };
+    const variables = {
+      includeProfiledFields: false,
+      skipProfiledFieldsExternalIds: ["ext_1", 2, null, "ext_2"],
+      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(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 };

package/src/sagas/fetchStructure.js

@@ -16,13 +16,25 @@ export function* fetchStructureSaga({ payload }) {
 
     yield put(fetchStructure.request());
 
-    const { id, version = "latest", loadStructureMetadata } = payload;
+    const {
+      id,
+      version = "latest",
+      dataStructureVersionQueryVariables,
+      loadStructureMetadata,
+    } = payload;
+    const extra =
+      dataStructureVersionQueryVariables &&
+      typeof dataStructureVersionQueryVariables === "object"
+        ? dataStructureVersionQueryVariables
+        : {};
+
     const {
       data: { dataStructureVersion },
     } = yield call(client.query, {
       fetchPolicy: "network-only",
       query: buildDSVQuery(loadStructureMetadata),
       variables: {
+        ...extra,
         dataStructureId: id,
         version,
         note_fields,

package/src/selectors/__tests__/getTabVisibility.spec.js

@@ -77,7 +77,7 @@ describe("selectors: getTabVisibility", () => {
         structure: { profile: { foo: "foo" } },
         userPermissions,
       }),
-    ).toMatchObject({ profile: false });
+    ).toMatchObject({ profile: true });
     expect(
       getTabVisibility({
         structureProfile: { patterns: "foo" },
@@ -92,6 +92,33 @@ describe("selectors: getTabVisibility", () => {
     ).toMatchObject({ profile: true });
   });
 
+  it("should include profile when profiled descendants exist or own profile", () => {
+    const userPermissions = { view_profiling_permission: true };
+
+    expect(
+      getTabVisibility({
+        structure: { has_profiled_data_fields: true },
+        userPermissions,
+      }),
+    ).toMatchObject({ profile: true });
+
+    expect(
+      getTabVisibility({
+        structure: {
+          class: "database",
+          has_profiled_data_fields: false,
+        },
+        userPermissions,
+      }),
+    ).toMatchObject({ profile: false });
+
+    expect(
+      getTabVisibility({
+        structure: { has_profiled_data_fields: true },
+      }),
+    ).toMatchObject({ profile: false });
+  });
+
   it("should include links tab if user has create_link permission", () => {
     expect(
       getTabVisibility({ structureActions: { create_link: {} } }),
@@ -100,6 +127,14 @@ describe("selectors: getTabVisibility", () => {
     });
   });
 
+  it("should include links if structure has links", () => {
+    expect(
+      getTabVisibility({ structureActions: { create_link: {} } }),
+    ).toMatchObject({
+      links: true,
+    });
+  });
+
   it("should include links tab if structure has links_count > 0", () => {
     expect(getTabVisibility({ structure: { links_count: 2 } })).toMatchObject({
       links: true,

package/src/selectors/getTabVisibility.js

@@ -10,13 +10,26 @@ const fieldsTabVisible = (state) => state?.structure?.data_fields_count > 0;
 
 const profileTabVisible = ({
   userPermissions,
+  structure,
   structureFields,
   structureProfile,
-}) =>
-  _.anyPass([_.prop("view_profiling_permission")])(userPermissions) &&
-  (_.some(hasProfile)(structureFields) ||
+}) => {
+  const hasPermission = _.anyPass([_.prop("view_profiling_permission")])(
+    userPermissions,
+  );
+
+  if (!hasPermission) return false;
+
+  const hasProfiledDescendants = structure?.has_profiled_data_fields === true;
+
+  return (
+    hasProfiledDescendants ||
+    hasProfile(structure) ||
+    _.some(hasProfile)(structureFields) ||
     notEmpty(structureProfile?.most_frequent) ||
-    notEmpty(structureProfile?.patterns));
+    notEmpty(structureProfile?.patterns)
+  );
+};
 
 const linksTabVisible = (state) => {
   const hasPermission = _.has("create_link", state?.structureActions);

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

@@ -1,3 +0,0 @@
-// Jest Snapshot v1, https://goo.gl/fbAQLP
-
-exports[`<StructureLoader /> matches the latest snapshot 1`] = `<div />`;