Hackathon - log drain

.gitignore

@@ -49,3 +49,6 @@ apps/**/generated
 
 # bruno
 cloud.bru
+
+
+analyze

apps/avatax/package.json

@@ -52,6 +52,7 @@
     "@trpc/react-query": "10.43.1",
     "@trpc/server": "10.43.1",
     "@urql/exchange-auth": "^2.1.4",
+    "@vercel/functions": "1.0.2",
     "avatax": "^23.7.0",
     "dotenv": "^16.3.1",
     "graphql": "16.7.1",

apps/avatax/src/lib/app-config.test.ts

@@ -1,4 +1,4 @@
-import { describe, it, expect } from "vitest";
+import { describe, expect, it } from "vitest";
 import { AppConfig } from "./app-config";
 
 describe("AppConfig", () => {
@@ -50,6 +50,10 @@ describe("AppConfig", () => {
               isAutocommit: false,
               isDocumentRecordingEnabled: false,
               shippingTaxCode: "123",
+              logsSettings: {
+                otel: {},
+                json: {},
+              },
             },
           },
         ],
@@ -118,6 +122,10 @@ describe("AppConfig", () => {
               isAutocommit: false,
               isDocumentRecordingEnabled: false,
               shippingTaxCode: "123",
+              logsSettings: {
+                otel: {},
+                json: {},
+              },
             },
           },
         ],

apps/avatax/src/lib/app-configuration-logger.test.ts

@@ -1,7 +1,7 @@
-import { describe, it, expect, vi, beforeEach } from "vitest";
-import { AppConfigurationLogger } from "./app-configuration-logger";
-import { AppConfig } from "./app-config";
 import { ObservabilityAttributes } from "@saleor/apps-otel/src/lib/observability-attributes";
+import { beforeEach, describe, expect, it, vi } from "vitest";
+import { AppConfig } from "./app-config";
+import { AppConfigurationLogger } from "./app-configuration-logger";
 
 describe("AppConfigurationLogger", () => {
   const mockWarn = vi.fn();
@@ -72,6 +72,10 @@ describe("AppConfigurationLogger", () => {
               isAutocommit: false,
               isDocumentRecordingEnabled: false,
               shippingTaxCode: "123",
+              logsSettings: {
+                otel: {},
+                json: {},
+              },
             },
           },
         ],

apps/avatax/src/modules/app/get-app-config.test.ts

@@ -1,9 +1,9 @@
 import { encrypt } from "@saleor/app-sdk/settings-manager";
-import { getAppConfig } from "./get-app-config";
 import { describe, expect, it, vi } from "vitest";
-import { ProviderConnections } from "../provider-connections/provider-connections";
 import { MetadataItem } from "../../../generated/graphql";
 import { ChannelsConfig } from "../channel-configuration/channel-config";
+import { ProviderConnections } from "../provider-connections/provider-connections";
+import { getAppConfig } from "./get-app-config";
 
 const mockedSecretKey = "test_secret_key";
 const mockedProviders: ProviderConnections = [
@@ -28,6 +28,10 @@ const mockedProviders: ProviderConnections = [
         street: "123 Main St",
         zip: "10001",
       },
+      logsSettings: {
+        otel: {},
+        json: {},
+      },
     },
   },
 ];

apps/avatax/src/modules/avatax/avatax-config-mock-generator.ts

@@ -18,6 +18,10 @@ const defaultAvataxConfig: AvataxConfig = {
     password: "password",
     username: "username",
   },
+  logsSettings: {
+    otel: {},
+    json: {},
+  },
 };
 
 const testingScenariosMap = {

apps/avatax/src/modules/avatax/avatax-connection-schema.ts

@@ -29,6 +29,18 @@ export const avataxConfigSchema = z
     shippingTaxCode: z.string().optional(),
     isDocumentRecordingEnabled: z.boolean().default(true),
     address: addressSchema,
+    logsSettings: z.object({
+      otel: z.object({
+        enabled: z.boolean().optional(),
+        url: z.string().optional(),
+        headers: z.string().optional(),
+      }),
+      json: z.object({
+        enabled: z.boolean().optional(),
+        url: z.string().optional(),
+        headers: z.string().optional(),
+      }),
+    }),
   })
   .merge(baseAvataxConfigSchema);
 
@@ -52,6 +64,18 @@ export const defaultAvataxConfig: AvataxConfig = {
     street: "",
     zip: "",
   },
+  logsSettings: {
+    otel: {
+      enabled: false,
+      url: "",
+      headers: "",
+    },
+    json: {
+      enabled: false,
+      url: "",
+      headers: "",
+    },
+  },
 };
 
 export const avataxConnectionSchema = z.object({

apps/avatax/src/modules/avatax/configuration/avatax-connection.service.ts

@@ -78,6 +78,10 @@ export class AvataxConnectionService {
         ...prevConfig.address,
         ...nextConfigPartial.address,
       },
+      logsSettings: {
+        ...prevConfig.logsSettings,
+        ...nextConfigPartial.logsSettings,
+      },
     };
 
     await this.checkIfAuthorized(input);

apps/avatax/src/modules/avatax/ui/avatax-configuration-form.tsx

@@ -17,6 +17,7 @@ import { AvataxConfigurationCredentialsFragment } from "./avatax-configuration-c
 import { AvataxConfigurationSettingsFragment } from "./avatax-configuration-settings-fragment";
 import { useAvataxConfigurationStatus } from "./configuration-status";
 import { HelperText } from "./form-helper-text";
+import { LogsSettingsFragment } from "./logs-settings-fragment";
 
 type AvataxConfigurationFormProps = {
   submit: {
@@ -83,6 +84,8 @@ export const AvataxConfigurationForm = (props: AvataxConfigurationFormProps) =>
             isLoading={props.validateAddress.isLoading}
           />
           <Divider marginY={8} />
+          <LogsSettingsFragment />
+          <Divider marginY={8} />
 
           <Box display={"flex"} justifyContent={"space-between"} alignItems={"center"}>
             {props.leftButton}

apps/avatax/src/modules/avatax/ui/edit-avatax-configuration.tsx

@@ -4,8 +4,8 @@ import { useRouter } from "next/router";
 import React from "react";
 import { z } from "zod";
 import { trpcClient } from "../../trpc/trpc-client";
-import { AvataxObfuscator } from "../avatax-obfuscator";
 import { AvataxConfig, BaseAvataxConfig } from "../avatax-connection-schema";
+import { AvataxObfuscator } from "../avatax-obfuscator";
 import { AvataxConfigurationForm } from "./avatax-configuration-form";
 import { useAvataxConfigurationStatus } from "./configuration-status";
 
@@ -141,6 +141,8 @@ export const EditAvataxConfiguration = () => {
     );
   }
 
+  console.log("config", data.config);
+
   return (
     <AvataxConfigurationForm
       submit={submit}

apps/avatax/src/modules/avatax/ui/logs-settings-fragment.tsx

@@ -0,0 +1,91 @@
+import { Box, Text, Textarea } from "@saleor/macaw-ui";
+import { Input } from "@saleor/react-hook-form-macaw";
+import { Controller, useFormContext, useWatch } from "react-hook-form";
+import { AppToggle } from "../../ui/app-toggle";
+import { AvataxConfig } from "../avatax-connection-schema";
+import { HelperText } from "./form-helper-text";
+
+export const LogsSettingsFragment = () => {
+  const { control, formState } = useFormContext<AvataxConfig>();
+  const isOtelTogleEnabled = useWatch({
+    control,
+    name: "logsSettings.otel.enabled",
+  });
+  const isJSONTogleEnabled = useWatch({
+    control,
+    name: "logsSettings.json.enabled",
+  });
+
+  return (
+    <>
+      <Box>
+        <Text marginBottom={4} as="h3" variant="heading">
+          Logs settings
+        </Text>
+        <Box display="grid" gap={2}>
+          <HelperText>
+            Configure where AvaTax should emit logs. This is useful for debugging and
+            troubleshooting connection issues.
+          </HelperText>
+          <AppToggle
+            name="logsSettings.otel.enabled"
+            control={control}
+            label="OTEL transport"
+            helperText={<HelperText>Enable sending logs using OpenTelemetry protocol.</HelperText>}
+          />
+          <Box display="grid" gap={2}>
+            <Input
+              control={control}
+              name="logsSettings.otel.url"
+              label="URL to send logs to"
+              helperText={formState.errors.logsSettings?.otel?.url?.message}
+              disabled={!isOtelTogleEnabled}
+            />
+            <Controller
+              name="logsSettings.otel.headers"
+              control={control}
+              render={({ field, fieldState: { error } }) => (
+                <Textarea
+                  {...field}
+                  error={!!error}
+                  helperText={formState.errors.logsSettings?.otel?.headers?.message}
+                  label="Request headers in JSON format"
+                  disabled={!isOtelTogleEnabled}
+                />
+              )}
+            />
+          </Box>
+
+          <AppToggle
+            name="logsSettings.json.enabled"
+            control={control}
+            label="JSON transport"
+            helperText={<HelperText>Enable sending logs using json protocol.</HelperText>}
+          />
+          <Box display="grid" gap={2}>
+            <Input
+              control={control}
+              name="logsSettings.json.url"
+              label="URL to send logs to"
+              helperText={formState.errors.logsSettings?.json?.url?.message}
+              disabled={!isJSONTogleEnabled}
+            />
+            <Controller
+              name="logsSettings.json.headers"
+              control={control}
+              render={({ field, fieldState: { error } }) => (
+                <Textarea
+                  {...field}
+                  error={!!error}
+                  helperText={formState.errors.logsSettings?.json?.headers?.message}
+                  label="Request headers in JSON format"
+                  disabled={!isJSONTogleEnabled}
+                />
+              )}
+            />
+          </Box>
+        </Box>
+      </Box>
+    </>
+  );
+};

apps/avatax/src/modules/calculate-taxes/use-case/calculate-taxes.use-case.test.ts

@@ -4,6 +4,8 @@ import { beforeEach, describe, expect, it, vi } from "vitest";
 import { BaseError } from "../../../error";
 import { AppConfig } from "../../../lib/app-config";
 import { AppConfigExtractor, IAppConfigExtractor } from "../../../lib/app-config-extractor";
+import { PublicLog } from "../../public-log-drain/public-events";
+import { PublicLogDrainService } from "../../public-log-drain/public-log-drain.service";
 import { AvataxWebhookServiceFactory } from "../../taxes/avatax-webhook-service-factory";
 import { CalculateTaxesPayload } from "../../webhooks/payloads/calculate-taxes-payload";
 import { CalculateTaxesUseCase } from "./calculate-taxes.use-case";
@@ -113,6 +115,16 @@ const getMockedAppConfig = (): AppConfig => {
           isAutocommit: false,
           isDocumentRecordingEnabled: false,
           shippingTaxCode: "123",
+          logsSettings: {
+            otel: {
+              url: "https://otel.example.com",
+              headers: "Authorization",
+            },
+            json: {
+              url: "https://http.example.com",
+              headers: "Authorization",
+            },
+          },
         },
       },
     ],
@@ -127,6 +139,11 @@ describe("CalculateTaxesUseCase", () => {
 
     instance = new CalculateTaxesUseCase({
       configExtractor: MockConfigExtractor,
+      publicLogDrain: new PublicLogDrainService([
+        {
+          async emit(log: PublicLog): Promise<void> {},
+        },
+      ]),
     });
   });