DOP-3903: API Changelog Support to omit entries

plugins/utils/openapi.js

@@ -5,7 +5,37 @@ const fetchChangelogData = async (runId, versions, s3Prefix) => {
   try {
     /* Using metadata runId, fetch OpenAPI Changelog full change list */
     const changelogResp = await fetch(`${s3Prefix}/${runId}/changelog.json`);
-    const changelog = await changelogResp.json();
+    const unfilteredChangelog = await changelogResp.json();
+
+    const hideChanges = (changelog) => {
+      const versionUpdate = (version) => {
+        const updatedVersion = { ...version };
+        if (version?.changes) {
+          updatedVersion.changes = version.changes.filter((change) => !change.hideFromChangelog);
+        }
+        return updatedVersion;
+      };
+
+      //pathUpdate takes the array of versions from the specific path passed in and takes each version and runs versionUpdate on it
+      const pathUpdate = (path) => {
+        const updatedPath = { ...path, versions: path.versions.map(versionUpdate) };
+        updatedPath.versions = updatedPath.versions.filter((version) => version.changes?.length);
+        return updatedPath;
+      };
+
+      //dateUpdate takes the array of paths from the specific date section passed in and takes each path and runs pathUpdate on it
+      const dateUpdate = (dateSection) => {
+        const updatedDateSection = { ...dateSection, paths: dateSection.paths.map(pathUpdate) };
+        updatedDateSection.paths = updatedDateSection.paths.filter((path) => path.versions?.length);
+        return updatedDateSection;
+      };
+
+      //changelog is the json file with everything in it. Map at this level takes each date section and runs dateUpdate on it
+      const updatedChangelog = changelog.map(dateUpdate);
+      return updatedChangelog.filter((dateSection) => dateSection.paths?.length);
+    };
+
+    const changelog = hideChanges(unfilteredChangelog);
 
     /* Aggregate all Resources in changelog for frontend filter */
     const resourcesListSet = new Set();
@@ -18,7 +48,23 @@ const fetchChangelogData = async (runId, versions, s3Prefix) => {
     const mostRecentResourceVersions = versions.slice(-2);
     const mostRecentDiffLabel = mostRecentResourceVersions.join('_');
     const mostRecentDiffResp = await fetch(`${s3Prefix}/${runId}/${mostRecentDiffLabel}.json`);
-    const mostRecentDiffData = await mostRecentDiffResp.json();
+    const mostRecentDiffDataUnfiltered = await mostRecentDiffResp.json();
+
+    //nested filtering of Diff changes with hideFromChangelog
+    const hideDiffChanges = (diffData) => {
+      const pathUpdate = (path) => {
+        const updatedPath = { ...path };
+        if (path?.changes) {
+          updatedPath.changes = path.changes.filter((change) => !change.hideFromChangelog);
+        }
+        return updatedPath;
+      };
+
+      const updatedDiffData = diffData.map(pathUpdate);
+      return updatedDiffData.filter((path) => path.changes?.length);
+    };
+
+    const mostRecentDiffData = hideDiffChanges(mostRecentDiffDataUnfiltered);
 
     return {
       changelog,

src/components/OpenAPIChangelog/OpenAPIChangelog.js

@@ -72,6 +72,7 @@ const StyledLoadingSkeleton = styled.div`
 const OpenAPIChangelog = () => {
   const { snootyEnv } = useSiteMetadata();
   const { index = {}, changelog = [], changelogResourcesList = [] } = useChangelogData();
+
   const resourceVersions = index.versions?.length ? index.versions.slice().reverse() : [];
   const downloadChangelogUrl = useMemo(() => getDownloadChangelogUrl(index.runId, snootyEnv), [index, snootyEnv]);
 

src/components/OpenAPIChangelog/utils/useFetchDiff.js

@@ -3,6 +3,20 @@ import { fetchOADiff } from '../../../utils/realm';
 import useChangelogData from '../../../utils/use-changelog-data';
 import { getDiffRequestFormat } from './getDiffRequestFormat';
 
+//nested filtering of Diff changes with hideFromChangelog
+const hideDiffChanges = (diffData) => {
+  const pathUpdate = (path) => {
+    const updatedPath = { ...path };
+    if (path?.changes) {
+      updatedPath.changes = path.changes.filter((change) => !change.hideFromChangelog);
+    }
+    return updatedPath;
+  };
+
+  const updatedDiffData = diffData.map(pathUpdate);
+  return updatedDiffData.filter((path) => path.changes?.length);
+};
+
 export const useFetchDiff = (resourceVersionOne, resourceVersionTwo, setIsLoading, setToastOpen, snootyEnv) => {
   const { index = {}, mostRecentDiff = {} } = useChangelogData();
   const [diff, setDiff] = useState([]);
@@ -20,7 +34,8 @@ export const useFetchDiff = (resourceVersionOne, resourceVersionTwo, setIsLoadin
       setIsLoading(true);
       fetchOADiff(index.runId, fromAndToDiffLabel, snootyEnv)
         .then((response) => {
-          setDiff(response);
+          const filteredDiff = hideDiffChanges(response);
+          setDiff(filteredDiff);
           setIsLoading(false);
         })
         .catch((err) => {

tests/unit/ChangeList.test.js

@@ -53,4 +53,38 @@ describe('OpenAPIChangelog ChangeList', () => {
       expect(queryByText(change.change)).toBeNull();
     });
   });
+
+  it('does not render all version changelog changes with "hideFromChangelog=true"', () => {
+    const hiddenChanges = mockChangelog.reduce((acc, date) => {
+      date.paths.forEach((path) =>
+        path.versions.forEach((version) =>
+          version.changes.forEach((change) => change.hideFromChangelog && acc.push(change))
+        )
+      );
+      return acc;
+    }, []);
+
+    const { queryByText } = render(<ChangeList changes={mockDiff} versionMode={COMPARE_VERSIONS} />);
+
+    expect(hiddenChanges).toHaveLength(2);
+
+    hiddenChanges.forEach((change) => {
+      expect(queryByText(change.change)).toBeNull();
+    });
+  });
+
+  it('does not render Diff changelog changes with "hideFromChangelog=true"', () => {
+    const hiddenChanges = mockDiff.reduce((acc, resource) => {
+      resource.changes.forEach((change) => change.hideFromChangelog && acc.push(change));
+      return acc;
+    }, []);
+
+    const { queryByText } = render(<ChangeList changes={mockDiff} versionMode={COMPARE_VERSIONS} />);
+
+    expect(hiddenChanges).toHaveLength(2);
+
+    hiddenChanges.forEach((change) => {
+      expect(queryByText(change.change)).toBeNull();
+    });
+  });
 });