first version

Author: krzysztofzuraw

apps/avatax/package.json

@@ -6,13 +6,15 @@
   "scripts": {
     "build": "next build",
     "check-types": "tsc --noEmit",
+    "cleanup-client-logs": "pnpm tsx --require dotenv/config ./scripts/cleanup-client-logs.ts",
     "deploy": "tsx --require dotenv/config ./scripts/deploy.ts",
     "dev": "NODE_OPTIONS='--inspect' next dev",
     "dev:debug": "APP_LOG_LEVEL=debug pnpm dev",
     "e2e": "vitest --project e2e --watch=false",
     "e2e:watch": "vitest --project e2e --watch",
     "fetch-schema": "curl https://raw.githubusercontent.com/saleor/saleor/${npm_package_saleor_schemaVersion}/saleor/graphql/schema.graphql > graphql/schema.graphql",
     "generate": "pnpm run generate:app && pnpm run generate:e2e",
+    "generate-fake-logs": "pnpm tsx --require dotenv/config ./scripts/generate-fake-logs.ts",
     "generate:app": "graphql-codegen --config .graphqlrc.ts",
     "generate:e2e": "graphql-codegen --config .graphqlrc.ts --project e2e",
     "lint": "eslint .",
@@ -55,7 +57,7 @@
     "avatax": "^23.7.0",
     "decimal.js-light": "2.5.1",
     "dotenv": "16.3.1",
-    "dynamodb-toolbox": "1.8.2",
+    "dynamodb-toolbox": "1.16.3",
     "graphql": "16.7.1",
     "graphql-tag": "2.12.6",
     "jotai": "^2.4.2",

apps/avatax/scripts/cleanup-client-logs.ts

@@ -0,0 +1,65 @@
+import { parseArgs } from "node:util";
+
+import { DeletePartitionCommand } from "dynamodb-toolbox/table/actions/deletePartition";
+import { saleorApp } from "saleor-app";
+
+import { env } from "@/env";
+import {
+  createLogsDocumentClient,
+  createLogsDynamoClient,
+} from "@/modules/client-logs/dynamo-client";
+import { ClientLogDynamoEntityFactory, LogsTable } from "@/modules/client-logs/dynamo-schema";
+
+const { values } = parseArgs({
+  options: {
+    "dry-run": { type: "boolean", short: "d" },
+  },
+});
+
+const startDate = new Date(2024, 1, 1);
+const endDate = new Date(2025, 2, 24); // 14 days from today
+
+const main = async () => {
+  const dynamoClient = createLogsDynamoClient();
+
+  const logsTable = LogsTable.create({
+    documentClient: createLogsDocumentClient(dynamoClient),
+    tableName: env.DYNAMODB_LOGS_TABLE_NAME,
+  });
+
+  const logsByCheckoutOrOrderId =
+    ClientLogDynamoEntityFactory.createLogByCheckoutOrOrderId(logsTable);
+  const logsByDateEntity = ClientLogDynamoEntityFactory.createLogByDate(logsTable);
+
+  const appInstallations = await saleorApp.apl.getAll().catch(() => {
+    console.error("Could not fetch instances from the APL");
+
+    process.exit(1);
+  });
+
+  for (const { saleorApiUrl, appId } of appInstallations) {
+    const command = logsTable
+      .build(DeletePartitionCommand)
+      .entities(logsByCheckoutOrOrderId, logsByDateEntity)
+      .query({
+        partition: LogsTable.getPrimaryKey({ saleorApiUrl, appId }),
+        range: {
+          between: [startDate.toISOString(), endDate.toISOString()],
+        },
+      });
+
+    try {
+      if (values["dry-run"]) {
+        console.log(`Would delete logs for ${saleorApiUrl}#${appId}`);
+        continue;
+      }
+      console.log(`Deleting logs for ${saleorApiUrl}#${appId}`);
+      await command.send();
+      console.log(`Logs for ${saleorApiUrl}#${appId} deleted`);
+    } catch (error) {
+      console.error(`Could not delete logs for ${saleorApiUrl}#${appId}`, error);
+    }
+  }
+};
+
+main();

apps/avatax/scripts/generate-fake-logs.ts

@@ -0,0 +1,61 @@
+import { faker } from "@faker-js/faker";
+import { saleorApp } from "saleor-app";
+
+import { env } from "@/env";
+import { ClientLogStoreRequest } from "@/modules/client-logs/client-log";
+import {
+  createLogsDocumentClient,
+  createLogsDynamoClient,
+} from "@/modules/client-logs/dynamo-client";
+import { ClientLogDynamoEntityFactory, LogsTable } from "@/modules/client-logs/dynamo-schema";
+import { LogsRepositoryDynamodb } from "@/modules/client-logs/logs-repository";
+
+const logCount = 1000;
+
+const main = async () => {
+  const dynamoClient = createLogsDynamoClient();
+
+  const logsTable = LogsTable.create({
+    documentClient: createLogsDocumentClient(dynamoClient),
+    tableName: env.DYNAMODB_LOGS_TABLE_NAME,
+  });
+
+  const appInstallations = await saleorApp.apl.getAll().catch(() => {
+    console.error("Could not fetch instances from the APL");
+
+    process.exit(1);
+  });
+
+  const repository = new LogsRepositoryDynamodb({
+    logsTable,
+    logByCheckoutOrOrderId: ClientLogDynamoEntityFactory.createLogByCheckoutOrOrderId(logsTable),
+    logByDateEntity: ClientLogDynamoEntityFactory.createLogByDate(logsTable),
+  });
+
+  for (const { saleorApiUrl, appId } of appInstallations) {
+    for (let i = 0; i < logCount; i++) {
+      const clientLog = ClientLogStoreRequest.create({
+        checkoutOrOrderId: faker.string.uuid(),
+        date: faker.date
+          .between({ from: new Date(2024, 1, 1), to: new Date(2025, 3, 24) })
+          .toISOString(),
+        message: faker.lorem.sentence(),
+        level: "info",
+        checkoutOrOrder: "checkout",
+      })._unsafeUnwrap();
+
+      try {
+        await repository.writeLog({
+          saleorApiUrl,
+          appId,
+          clientLogRequest: clientLog,
+        });
+        console.log(`Created log entry for ${saleorApiUrl}#${appId}`);
+      } catch (error) {
+        console.error(`Could not create log entry for ${saleorApiUrl}#${appId}`, error);
+      }
+    }
+  }
+};
+
+main();

apps/avatax/scripts/setup-dynamodb.sh

@@ -6,12 +6,12 @@ aws configure set aws_access_key_id test
 aws configure set aws_secret_access_key test
 aws configure set region localhost
 
-if ! aws dynamodb describe-table --table-name avatax-logs --endpoint-url http://dynamodb:8000 --region localhost >/dev/null 2>&1; then
+if ! aws dynamodb describe-table --table-name avatax-logs --endpoint-url http://localhost:8000 --region localhost >/dev/null 2>&1; then
 	aws dynamodb create-table --table-name avatax-logs \
 		--attribute-definitions AttributeName=PK,AttributeType=S AttributeName=SK,AttributeType=S \
 		--key-schema AttributeName=PK,KeyType=HASH AttributeName=SK,KeyType=RANGE \
 		--provisioned-throughput ReadCapacityUnits=5,WriteCapacityUnits=5 \
-		--endpoint-url http://dynamodb:8000 \
+		--endpoint-url http://localhost:8000 \
 		--region localhost
 else
 	echo "Table avatax-logs already exists - creation is skipped"

apps/avatax/src/logger.ts

@@ -1,10 +1,13 @@
 import { attachLoggerConsoleTransport, rootLogger } from "@saleor/apps-logger";
+import { createRequire } from "module";
 
 import packageJson from "../package.json";
 import { env } from "./env";
 
 rootLogger.settings.maskValuesOfKeys = ["metadata", "username", "password", "apiKey"];
 
+const require = createRequire(import.meta.url);
+
 if (env.NODE_ENV !== "production") {
   attachLoggerConsoleTransport(rootLogger);
 }