feat: enable context meta as field names + refactoring + docs

* improved naming * add docs to all new config properties
ahochsteger · May 4, 2024 · 17f9959 · 17f9959
1 parent 31d8c46
commit 17f9959
Show file tree

Hide file tree

Showing 12 changed files with 200 additions and 130 deletions.
diff --git a/src/examples/advanced/logSheetLogging.ts b/src/examples/advanced/logSheetLogging.ts
@@ -32,16 +32,19 @@ export const runConfig: Config = {
     logSheetLocation:
       "/GmailProcessor-Tests/logsheet-${date.now:date::yyyy-MM}",
 
-    richLogFields: [
+    logFields: [
       "log.timestamp",
+      "entity.date",
+      "entity.subject",
+      "entity.from",
+      "entity.url",
+      "attachment.name",
+      "attachment.size",
+      "attachment.contentType",
+      "stored.location",
+      "stored.url",
+      "stored.downloadUrl",
       "context.type",
-      "gmailUrl",
-      "date",
-      "subject",
-      "from",
-      "gdriveLocation",
-      "gdriveUrl",
-      "gdriveDownloadUrl",
       "log.message",
     ],
   },

diff --git a/src/gas/examples/advanced/logSheetLogging.js b/src/gas/examples/advanced/logSheetLogging.js
@@ -28,16 +28,19 @@ function logSheetLoggingTest() {
       logSheetLocation:
         "/GmailProcessor-Tests/logsheet-${date.now:date::yyyy-MM}",
 
-      richLogFields: [
+      logFields: [
         "log.timestamp",
+        "entity.date",
+        "entity.subject",
+        "entity.from",
+        "entity.url",
+        "attachment.name",
+        "attachment.size",
+        "attachment.contentType",
+        "stored.location",
+        "stored.url",
+        "stored.downloadUrl",
         "context.type",
-        "gmailUrl",
-        "date",
-        "subject",
-        "from",
-        "gdriveLocation",
-        "gdriveUrl",
-        "gdriveDownloadUrl",
         "log.message",
       ],
     },

diff --git a/src/lib/Context.ts b/src/lib/Context.ts
@@ -1,7 +1,7 @@
 import { ActionRegistry } from "./actions/ActionRegistry"
 import { GDriveAdapter } from "./adapter/GDriveAdapter"
 import { GmailAdapter } from "./adapter/GmailAdapter"
-import { RichLogAdapter } from "./adapter/RichLogAdapter"
+import { LogAdapter } from "./adapter/LogAdapter"
 import { SpreadsheetAdapter } from "./adapter/SpreadsheetAdapter"
 import { ActionConfig } from "./config/ActionConfig"
 import { RequiredAttachmentConfig } from "./config/AttachmentConfig"
@@ -92,7 +92,7 @@ export type ProcessingInfo = {
   config: RequiredConfig
   gdriveAdapter: GDriveAdapter
   gmailAdapter: GmailAdapter
-  logAdapter: RichLogAdapter
+  logAdapter: LogAdapter
   spreadsheetAdapter: SpreadsheetAdapter
   timer: Timer
 }

diff --git a/src/lib/actions/GlobalActions.spec.ts b/src/lib/actions/GlobalActions.spec.ts
@@ -4,7 +4,7 @@ import {
   Mocks,
   fakedSystemDateTimeString,
 } from "../../test/mocks/MockFactory"
-import { LOG_MESSAGE_KEY } from "../adapter/RichLogAdapter"
+import { LOG_MESSAGE_NAME } from "../adapter/LogAdapter"
 import { Config } from "../config/Config"
 import { LogLevel } from "../utils/Logger"
 import { ConfigMocks } from "./../../test/mocks/ConfigMocks"
@@ -20,10 +20,10 @@ beforeAll(() => {
     settings: {
       ...ConfigMocks.newDefaultSettingsConfigJson(),
       logSheetLocation: LOGSHEET_FILE_PATH,
-      richLogFields: ["log.timestamp", "field1", "field2", "log.message"],
-      richLogConfig: [
-        { key: "field1", title: "Field 1", value: "static value" },
-        { key: "field2", title: "Field 2", value: "${context.type}" },
+      logFields: ["log.timestamp", "field.1", "field.2", "log.message"],
+      logConfig: [
+        { name: "field.1", title: "Field 1", value: "static value" },
+        { name: "field.2", title: "Field 2", value: "${context.type}" },
       ],
     },
   }
@@ -68,7 +68,7 @@ it("should log with a certain log level to a logSheet", () => {
   })
   // TODO: Test should not depend on the action implementation
   const i = mocks.processingContext.proc.logAdapter
-    .getLogFieldKeys()
-    .indexOf(LOG_MESSAGE_KEY)
+    .getLogFieldNames()
+    .indexOf(LOG_MESSAGE_NAME)
   expect(mocks.logSheet.appendRow.mock.calls[0][0][i]).toEqual("Log message")
 })
diff --git a/src/lib/adapter/RichLogAdapter.spec.ts → src/lib/adapter/LogAdapter.spec.ts b/src/lib/adapter/RichLogAdapter.spec.ts → src/lib/adapter/LogAdapter.spec.ts
@@ -6,26 +6,27 @@ import {
 } from "../../test/mocks/MockFactory"
 import { Config } from "../config/Config"
 import { LogLevel } from "../utils/Logger"
-import { RichLogAdapter } from "./RichLogAdapter"
+import { LogAdapter } from "./LogAdapter"
 
-let richLogAdapter: RichLogAdapter
+let richLogAdapter: LogAdapter
 let mocks: Mocks
 let config: Config
 beforeEach(() => {
   config = {
     ...ConfigMocks.newDefaultConfigJson(),
     settings: {
       ...ConfigMocks.newDefaultSettingsConfigJson(),
-      richLogFields: [
+      logFields: [
         "log.timestamp",
         "log.level",
         "log.message",
-        "field1",
-        "field2",
+        "field.1",
+        "field.2",
+        "env.runMode",
       ],
-      richLogConfig: [
-        { key: "field1", title: "Field 1", value: "static value" },
-        { key: "field2", title: "Field 2", value: "${context.type}" },
+      logConfig: [
+        { name: "field.1", title: "Field 1", value: "static value" },
+        { name: "field.2", title: "Field 2", value: "${context.type}" },
       ],
     },
   }
@@ -43,7 +44,8 @@ it("should create a field config compliant log array", () => {
     LogLevel.INFO,
     "Log message",
     "static value",
-    "proc",
+    mocks.processingContext.type,
+    mocks.processingContext.env.runMode,
   ])
 })
 
@@ -53,7 +55,8 @@ it("should create a field config compliant JSON log object", () => {
     "log.timestamp": `${fakedSystemDateTimeString}.000`,
     "log.level": LogLevel.INFO,
     "log.message": "Log message",
-    field1: "static value",
-    field2: "proc",
+    "field.1": "static value",
+    "field.2": mocks.processingContext.type,
+    "env.runMode": mocks.processingContext.env.runMode,
   })
 })