fix(api-audit-logs): compression (#4617)

Author: brunozoric

packages/api-aco/src/record/record.so.ts

@@ -46,7 +46,9 @@ export const createSearchRecordOperations = (
                 }
             });
 
-            return [entries.map(pickEntryFieldValues<SearchRecord<any>>), meta];
+            const items = entries.map(pickEntryFieldValues<SearchRecord<any>>);
+
+            return [items, meta];
         },
         async listTags(model, params) {
             const { where } = params;

packages/api-audit-logs/__tests__/createAuditLog.test.ts

@@ -3,9 +3,12 @@ import { AuditAction } from "~/types";
 import { useHandler } from "./helpers/useHandler";
 import { ActionType } from "~/config";
 import { AUDIT_LOGS_TYPE } from "~/app/contants";
-import { compressor } from "~/utils/compressor";
+import { getDocumentClient } from "@webiny/project-utils/testing/dynamodb/index.js";
+import { parseIdentifier } from "@webiny/utils/parseIdentifier.js";
 
 describe("create audit log", () => {
+    const client = getDocumentClient();
+
     const audit: AuditAction = {
         app: {
             app: "cms",
@@ -37,6 +40,8 @@ describe("create audit log", () => {
     };
 
     it("should create a new audit log", async () => {
+        expect.assertions(3);
+
         const createAuditLog = getAuditConfig(audit);
 
         const { handler } = useHandler();
@@ -66,17 +71,40 @@ describe("create audit log", () => {
                 timestamp: expect.any(Date),
                 entityId,
                 message,
-                data: await compressor.compress(JSON.stringify(data))
+                data: JSON.stringify(data)
             },
             location: {
                 folderId: "root"
             },
             tags: [],
             type: "AuditLogs"
         });
+
+        // @ts-expect-error
+        const partitionKey = `#CME#wby-aco-${result!.id}`;
+
+        const scanned = await client.scan({
+            TableName: process.env.DB_TABLE
+        });
+
+        for (const item of scanned.Items || []) {
+            if (item.PK.includes(partitionKey) === false) {
+                continue;
+            }
+            expect(item).toMatchObject({
+                PK: expect.stringContaining(partitionKey),
+                values: {
+                    "object@data": {
+                        "text@data": expect.stringMatching(`{"compression":"gzip","value":`)
+                    }
+                }
+            });
+        }
     });
 
     it("should list created logs", async () => {
+        expect.assertions(3);
+
         const createAuditLog = getAuditConfig(audit);
 
         const { handler } = useHandler();
@@ -117,5 +145,25 @@ describe("create audit log", () => {
             tags: [],
             type: "AuditLogs"
         });
+
+        const { id: partitionKey } = parseIdentifier(`${result!.id}`);
+
+        const scanned = await client.scan({
+            TableName: process.env.DB_TABLE
+        });
+
+        for (const item of scanned.Items || []) {
+            if (item.PK.includes(partitionKey) === false) {
+                continue;
+            }
+            expect(item).toMatchObject({
+                PK: expect.stringContaining(partitionKey),
+                values: {
+                    "object@data": {
+                        "text@data": expect.stringMatching(`{"compression":"gzip","value":`)
+                    }
+                }
+            });
+        }
     });
 });

packages/api-audit-logs/src/app/app.ts

@@ -14,7 +14,7 @@ const toDate = (value: string | Date) => {
     }
 };
 
-const decompressData = (entry: SearchRecord<any>): SearchRecord<any> => {
+const decompressData = async (entry: SearchRecord<any>): Promise<SearchRecord<any>> => {
     if (!entry.data?.data) {
         return entry;
     }
@@ -23,7 +23,7 @@ const decompressData = (entry: SearchRecord<any>): SearchRecord<any> => {
         data: {
             ...entry.data,
             timestamp: toDate(entry.data.timestamp),
-            data: compressor.decompress(entry.data.data)
+            data: await compressor.decompress(entry.data.data)
         }
     };
 };
@@ -104,8 +104,8 @@ export const createApp = (): IAcoAppRegisterParams => {
             return decompressData(entry);
         },
         onEntryList: async entries => {
-            return Promise.all(
-                entries.map(entry => {
+            return await Promise.all(
+                entries.map(async entry => {
                     return decompressData(entry);
                 })
             );

packages/api-audit-logs/src/utils/compressor.ts

@@ -28,11 +28,11 @@ class GzipCompression implements Compressor {
         try {
             const result = JSON.parse(data);
             if (!result?.compression) {
-                return false;
+                return true;
             }
             compression = result.compression;
         } catch {
-            return false;
+            return true;
         }
         /**
          * If already compressed, skip this.