feat(api-headless-cms-ddb-es): entry values modifier

jest.config.base.setup.js

@@ -3,4 +3,7 @@
 
 // Runs failed tests five times until they pass or until the max number of retries is exhausted.
 // https://jestjs.io/docs/jest-object#jestretrytimesnumretries-options
-jest.retryTimes(3);
+jest.retryTimes(0);
+if (process.env.CI === "true") {
+    jest.retryTimes(3);
+}

packages/api-aco/package.json

@@ -22,7 +22,7 @@
     "directory": "dist"
   },
   "dependencies": {
-    "@ungap/structured-clone": "1.2.0",
+    "@ungap/structured-clone": "^1.2.0",
     "@webiny/api": "0.0.0",
     "@webiny/api-headless-cms": "0.0.0",
     "@webiny/api-i18n": "0.0.0",

packages/api-elasticsearch/src/compression.ts

@@ -13,7 +13,7 @@ const getCompressionPlugins = (plugins: PluginsContainer): CompressionPlugin[] =
 export const compress = async (
     pluginsContainer: PluginsContainer,
     data: Record<string, any>
-): Promise<Record<string, any>> => {
+): Promise<Record<string, any> | string> => {
     const plugins = getCompressionPlugins(pluginsContainer);
     if (plugins.length === 0) {
         console.log("No compression plugins");
@@ -34,7 +34,7 @@ export const compress = async (
 export const decompress = async (
     pluginsContainer: PluginsContainer,
     data: Record<string, any>
-): Promise<Record<string, any>> => {
+): Promise<Record<string, any> | string> => {
     const plugins = getCompressionPlugins(pluginsContainer);
     if (plugins.length === 0) {
         return data;

packages/api-headless-cms-ddb-es/__tests__/plugins/CmsEntryElasticsearchValuesModifier.test.ts

@@ -0,0 +1,155 @@
+import structuredClone from "@ungap/structured-clone";
+import { createCmsEntryElasticsearchValuesModifier } from "~/plugins";
+import { CmsEntry, CmsIdentity, CmsModel } from "@webiny/api-headless-cms/types";
+
+interface MockCmsEntryValues {
+    title: string;
+    age: number;
+}
+
+const mockModel: CmsModel = {
+    locale: "en-US",
+    tenant: "root",
+    modelId: "abcdefghijklmn",
+    name: "Test model",
+    description: "",
+    layout: [],
+    fields: [],
+    singularApiName: "TestModel",
+    pluralApiName: "TestModels",
+    titleFieldId: "id",
+    group: {
+        id: "group",
+        name: "group"
+    },
+    webinyVersion: "0.0.0"
+};
+const createdBy: CmsIdentity = {
+    id: "a",
+    displayName: "a",
+    type: "a"
+};
+
+const mockEntry: CmsEntry<MockCmsEntryValues> = {
+    id: "abcdefg#0001",
+    entryId: "abcdefg",
+    location: {
+        folderId: "root"
+    },
+    values: {
+        title: "Initial title",
+        age: 55
+    },
+    status: "draft",
+    locked: false,
+    locale: "en-US",
+    tenant: "root",
+    webinyVersion: "0.0.0",
+    createdBy,
+    ownedBy: createdBy,
+    meta: {},
+    createdOn: new Date().toISOString(),
+    savedOn: new Date().toISOString(),
+    modelId: mockModel.modelId,
+    version: 1
+};
+
+const getMockData = () => {
+    return {
+        model: structuredClone<CmsModel>(mockModel),
+        entry: structuredClone<CmsEntry<MockCmsEntryValues>>(mockEntry),
+        values: structuredClone<MockCmsEntryValues>(mockEntry.values)
+    };
+};
+
+describe("entry values modifier", () => {
+    it("should modify the original values with a single plugin", async () => {
+        const { model, values: initialValues, entry } = getMockData();
+        let values = structuredClone(initialValues);
+
+        const modifier = createCmsEntryElasticsearchValuesModifier<MockCmsEntryValues>(
+            async ({ setValues }) => {
+                setValues(() => {
+                    return {
+                        title: "Test title"
+                    };
+                });
+            }
+        );
+
+        values = await modifier.modify({
+            entry,
+            model,
+            values
+        });
+
+        expect(values).toEqual({
+            title: "Test title"
+        });
+        expect(values.age).toBeUndefined();
+    });
+
+    it("should modify the original values with multiple plugins", async () => {
+        const { model, values: initialValues, entry } = getMockData();
+        let values = structuredClone(initialValues);
+        const titleModifier = createCmsEntryElasticsearchValuesModifier<MockCmsEntryValues>(
+            async ({ setValues }) => {
+                setValues(() => {
+                    return {
+                        title: "Test title"
+                    };
+                });
+            }
+        );
+
+        values = await titleModifier.modify({
+            entry,
+            model,
+            values
+        });
+
+        expect(values).toEqual({
+            title: "Test title"
+        });
+        expect(values.age).toBeUndefined();
+
+        const ageModifier = createCmsEntryElasticsearchValuesModifier<MockCmsEntryValues>(
+            async ({ setValues }) => {
+                setValues(prev => {
+                    return {
+                        ...prev,
+                        age: 2
+                    };
+                });
+            }
+        );
+
+        values = await ageModifier.modify({
+            entry,
+            model,
+            values
+        });
+        expect(values).toEqual({
+            title: "Test title",
+            age: 2
+        });
+    });
+
+    it("should not modify anything because model is not supported", async () => {
+        const { model } = getMockData();
+        const nothingWillGetModified =
+            createCmsEntryElasticsearchValuesModifier<MockCmsEntryValues>({
+                models: ["nonExisting"],
+                modifier: async ({ setValues }) => {
+                    setValues(() => {
+                        return {
+                            title: "Test title"
+                        };
+                    });
+                }
+            });
+
+        const result = nothingWillGetModified.canModify(model.modelId);
+        expect(result).toEqual(false);
+    });
+});

packages/api-headless-cms-ddb-es/package.json

@@ -43,6 +43,7 @@
     "@babel/preset-env": "^7.22.7",
     "@elastic/elasticsearch": "7.12.0",
     "@types/jsonpack": "^1.1.0",
+    "@ungap/structured-clone": "^1.2.0",
     "@webiny/api-dynamodb-to-elasticsearch": "0.0.0",
     "@webiny/api-i18n": "0.0.0",
     "@webiny/api-security": "0.0.0",