Cleanup Segment app

.changeset/fair-moles-try.md

@@ -0,0 +1,5 @@
+---
+"segment": patch
+---
+
+Cleanup Segment app - rename of files or fix naming.

apps/segment/src/lib/dyanmodb-apl.test.ts

@@ -4,7 +4,7 @@ import { afterEach, describe, expect, it, vi } from "vitest";
 
 import { BaseError } from "@/errors";
 
-import { InMemoryAPLRepository } from "./__tests__/in-memory-apl-repository";
+import { MemoryAPLRepository } from "../modules/db/__tests__/memory-apl-repository";
 import { DynamoAPL } from "./dynamodb-apl";
 
 describe("DynamoAPL", () => {
@@ -20,7 +20,7 @@ describe("DynamoAPL", () => {
   });
 
   it("should get auth data if it exists", async () => {
-    const repository = new InMemoryAPLRepository();
+    const repository = new MemoryAPLRepository();
     const apl = new DynamoAPL({ repository });
 
     repository.setEntry({
@@ -33,7 +33,7 @@ describe("DynamoAPL", () => {
   });
 
   it("should return undefined if auth data does not exist", async () => {
-    const repository = new InMemoryAPLRepository();
+    const repository = new MemoryAPLRepository();
     const apl = new DynamoAPL({ repository });
 
     const result = await apl.get("saleorApiUrl");
@@ -42,7 +42,7 @@ describe("DynamoAPL", () => {
   });
 
   it("should throw an error if getting auth data fails", async () => {
-    const repository = new InMemoryAPLRepository();
+    const repository = new MemoryAPLRepository();
     const apl = new DynamoAPL({ repository });
 
     vi.spyOn(repository, "getEntry").mockReturnValue(
@@ -53,7 +53,7 @@ describe("DynamoAPL", () => {
   });
 
   it("should set auth data", async () => {
-    const repository = new InMemoryAPLRepository();
+    const repository = new MemoryAPLRepository();
     const apl = new DynamoAPL({ repository });
 
     const result = await apl.set(mockedAuthData);
@@ -68,7 +68,7 @@ describe("DynamoAPL", () => {
   });
 
   it("should throw an error if setting auth data fails", async () => {
-    const repository = new InMemoryAPLRepository();
+    const repository = new MemoryAPLRepository();
 
     vi.spyOn(repository, "setEntry").mockResolvedValue(err(new BaseError("Error setting data")));
 
@@ -78,7 +78,7 @@ describe("DynamoAPL", () => {
   });
 
   it("should update existing auth data", async () => {
-    const repository = new InMemoryAPLRepository();
+    const repository = new MemoryAPLRepository();
     const apl = new DynamoAPL({ repository });
 
     repository.setEntry({
@@ -103,7 +103,7 @@ describe("DynamoAPL", () => {
   });
 
   it("should delete auth data", async () => {
-    const repository = new InMemoryAPLRepository();
+    const repository = new MemoryAPLRepository();
     const apl = new DynamoAPL({ repository });
 
     repository.setEntry({
@@ -118,14 +118,14 @@ describe("DynamoAPL", () => {
   });
 
   it("should throw an error if deleting auth data fails", async () => {
-    const repository = new InMemoryAPLRepository();
+    const repository = new MemoryAPLRepository();
     const apl = new DynamoAPL({ repository });
 
     await expect(apl.delete("saleorApiUrl")).rejects.toThrowError(DynamoAPL.DeleteAuthDataError);
   });
 
   it("should get all auth data", async () => {
-    const repository = new InMemoryAPLRepository();
+    const repository = new MemoryAPLRepository();
     const secondEntry: AuthData = {
       saleorApiUrl: "saleorApiUrl2",
       token: "appToken2",
@@ -148,7 +148,7 @@ describe("DynamoAPL", () => {
   });
 
   it("should throw an error if getting all auth data fails", async () => {
-    const repository = new InMemoryAPLRepository();
+    const repository = new MemoryAPLRepository();
     const apl = new DynamoAPL({ repository });
 
     vi.spyOn(repository, "getAllEntries").mockResolvedValue(
@@ -159,7 +159,7 @@ describe("DynamoAPL", () => {
   });
 
   it("should return ready:true when APL related env variables are set", async () => {
-    const repository = new InMemoryAPLRepository();
+    const repository = new MemoryAPLRepository();
     const apl = new DynamoAPL({ repository });
 
     const result = await apl.isReady();
@@ -183,7 +183,7 @@ describe("DynamoAPL", () => {
       NODE_ENV: "test",
       ENV: "local",
     });
-    const repository = new InMemoryAPLRepository();
+    const repository = new MemoryAPLRepository();
     const apl = new DynamoAPL({ repository });
 
     const result = await apl.isReady();
@@ -195,7 +195,7 @@ describe("DynamoAPL", () => {
   });
 
   it("should return configured:true when APL related env variables are set", async () => {
-    const repository = new InMemoryAPLRepository();
+    const repository = new MemoryAPLRepository();
     const apl = new DynamoAPL({ repository });
 
     const result = await apl.isConfigured();
@@ -217,7 +217,7 @@ describe("DynamoAPL", () => {
       ENV: "local",
     });
 
-    const repository = new InMemoryAPLRepository();
+    const repository = new MemoryAPLRepository();
     const apl = new DynamoAPL({ repository });
 
     const result = await apl.isConfigured();

apps/segment/src/modules/configuration/webhooks-status/webhooks-status.tsx

@@ -16,8 +16,8 @@ export const WebhookStatus = () => {
         {config.areWebhooksActive ? (
           <>
             <Text size={2} color="default2">
-              Webhooks are active. For more information about webhooks check Manage app button in
-              header above.
+              App webhooks are active. For more information about webhooks check Manage app button
+              in header above.
             </Text>
             <SemanticChip marginLeft={"auto"} size="small" variant={"success"}>
               ACTIVE
@@ -26,7 +26,7 @@ export const WebhookStatus = () => {
         ) : (
           <>
             <Text size={2} color="default2">
-              Your webhooks were disabled. Most likely, your configuration is invalid. Check your
+              App webhooks were disabled. Most likely, your configuration is invalid. Check your
               credentials.
             </Text>
             <SemanticChip marginLeft={"auto"} size="small" variant={"error"}>

apps/segment/src/lib/__tests__/in-memory-apl-repository.ts → apps/segment/src/modules/db/__tests__/memory-apl-repository.ts

@@ -4,7 +4,7 @@ import { err, ok, Result } from "neverthrow";
 import { BaseError } from "@/errors";
 import { APLRepository } from "@/modules/db/types";
 
-export class InMemoryAPLRepository implements APLRepository {
+export class MemoryAPLRepository implements APLRepository {
   public entries: Record<string, AuthData> = {};
 
   async getEntry(args: {

apps/segment/src/modules/db/segment-apl-mapper.ts → apps/segment/src/modules/db/dynamo-apl-mapper.ts

@@ -3,8 +3,8 @@ import { FormattedItem, type PutItemInput } from "dynamodb-toolbox";
 
 import { SegmentAPLEntityType, SegmentMainTable } from "@/modules/db/segment-main-table";
 
-export class SegmentAPLMapper {
-  dynamoDBEntityToAuthData(entity: FormattedItem<SegmentAPLEntityType>): AuthData {
+export class DynamoAPLMapper {
+  dynamoEntityToAuthData(entity: FormattedItem<SegmentAPLEntityType>): AuthData {
     return {
       domain: entity.domain,
       token: entity.token,

apps/segment/src/modules/db/dynamo-apl-repository-factory.ts

@@ -0,0 +1,18 @@
+import { BaseError } from "@/errors";
+
+import { DynamoAPLRepository } from "./dynamo-apl-repository";
+
+export class DynamoAPLRepositoryFactory {
+  static RepositoryCreationError = BaseError.subclass("RepositoryCreationError");
+
+  static create(): DynamoAPLRepository {
+    try {
+      return new DynamoAPLRepository();
+    } catch (error) {
+      throw new DynamoAPLRepositoryFactory.RepositoryCreationError(
+        "Failed to create DynamoDB APL repository",
+        { cause: error },
+      );
+    }
+  }
+}

apps/segment/src/modules/db/segment-apl-repository.test.ts → apps/segment/src/modules/db/dynamo-apl-repository.test.ts

@@ -10,20 +10,12 @@ import { mockClient } from "aws-sdk-client-mock";
 import { SavedItem } from "dynamodb-toolbox";
 import { beforeEach, describe, expect, it } from "vitest";
 
-import { SegmentAPLRepository } from "./segment-apl-repository";
-import { SegmentMainTable, SegmentMainTableEntityFactory } from "./segment-main-table";
+import { DynamoAPLRepository } from "./dynamo-apl-repository";
+import { SegmentAPLEntityType } from "./segment-main-table";
 
-describe("SegmentAPLRepository", () => {
+describe("DynamoAPLRepository", () => {
   const mockDocumentClient = mockClient(DynamoDBDocumentClient);
 
-  const segmentMainTable = SegmentMainTable.create({
-    // @ts-expect-error https://github.com/m-radzikowski/aws-sdk-client-mock/issues/197
-    documentClient: mockDocumentClient,
-    tableName: "segment-test-table",
-  });
-
-  const segmentAPLEntity = SegmentMainTableEntityFactory.createAPLEntity(segmentMainTable);
-
   const mockedAuthData: AuthData = {
     appId: "appId",
     saleorApiUrl: "saleorApiUrl",
@@ -35,7 +27,7 @@ describe("SegmentAPLRepository", () => {
   });
 
   it("should successfully get AuthData entry from DynamoDB", async () => {
-    const mockedAPLEntry: SavedItem<typeof segmentAPLEntity> = {
+    const mockedAPLEntry: SavedItem<SegmentAPLEntityType> = {
       PK: "saleorApiUrl",
       SK: "APL",
       token: "appToken",
@@ -50,7 +42,7 @@ describe("SegmentAPLRepository", () => {
       Item: mockedAPLEntry,
     });
 
-    const repository = new SegmentAPLRepository({ segmentAPLEntity });
+    const repository = new DynamoAPLRepository();
 
     const result = await repository.getEntry({ saleorApiUrl: "saleorApiUrl" });
 
@@ -68,19 +60,19 @@ describe("SegmentAPLRepository", () => {
   it("should handle errors when getting AuthData from DynamoDB", async () => {
     mockDocumentClient.on(GetCommand, {}).rejectsOnce("Exception");
 
-    const repository = new SegmentAPLRepository({ segmentAPLEntity });
+    const repository = new DynamoAPLRepository();
 
     const result = await repository.getEntry({ saleorApiUrl: "saleorApiUrl" });
 
     expect(result.isErr()).toBe(true);
 
-    expect(result._unsafeUnwrapErr()).toBeInstanceOf(SegmentAPLRepository.ReadEntityError);
+    expect(result._unsafeUnwrapErr()).toBeInstanceOf(DynamoAPLRepository.ReadEntityError);
   });
 
   it("should return null if AuthData entry does not exist in DynamoDB", async () => {
     mockDocumentClient.on(GetCommand, {}).resolvesOnce({});
 
-    const repository = new SegmentAPLRepository({ segmentAPLEntity });
+    const repository = new DynamoAPLRepository();
 
     const result = await repository.getEntry({ saleorApiUrl: "saleorApiUrl" });
 
@@ -92,7 +84,7 @@ describe("SegmentAPLRepository", () => {
   it("should successfully set AuthData entry in DynamoDB", async () => {
     mockDocumentClient.on(PutCommand, {}).resolvesOnce({});
 
-    const repository = new SegmentAPLRepository({ segmentAPLEntity });
+    const repository = new DynamoAPLRepository();
 
     const result = await repository.setEntry({
       authData: mockedAuthData,
@@ -106,21 +98,21 @@ describe("SegmentAPLRepository", () => {
   it("should handle errors when setting AuthData entry DynamoDB", async () => {
     mockDocumentClient.on(PutCommand, {}).rejectsOnce("Exception");
 
-    const repository = new SegmentAPLRepository({ segmentAPLEntity });
+    const repository = new DynamoAPLRepository();
 
     const result = await repository.setEntry({
       authData: mockedAuthData,
     });
 
     expect(result.isErr()).toBe(true);
 
-    expect(result._unsafeUnwrapErr()).toBeInstanceOf(SegmentAPLRepository.WriteEntityError);
+    expect(result._unsafeUnwrapErr()).toBeInstanceOf(DynamoAPLRepository.WriteEntityError);
   });
 
   it("should successfully delete AuthData entry from DynamoDB", async () => {
     mockDocumentClient.on(DeleteCommand, {}).resolvesOnce({});
 
-    const repository = new SegmentAPLRepository({ segmentAPLEntity });
+    const repository = new DynamoAPLRepository();
 
     const result = await repository.deleteEntry({ saleorApiUrl: "saleorApiUrl" });
 
@@ -132,17 +124,17 @@ describe("SegmentAPLRepository", () => {
   it("should handle errors when deleting AuthData entry from DynamoDB", async () => {
     mockDocumentClient.on(DeleteCommand, {}).rejectsOnce("Exception");
 
-    const repository = new SegmentAPLRepository({ segmentAPLEntity });
+    const repository = new DynamoAPLRepository();
 
     const result = await repository.deleteEntry({ saleorApiUrl: "saleorApiUrl" });
 
     expect(result.isErr()).toBe(true);
 
-    expect(result._unsafeUnwrapErr()).toBeInstanceOf(SegmentAPLRepository.DeleteEntityError);
+    expect(result._unsafeUnwrapErr()).toBeInstanceOf(DynamoAPLRepository.DeleteEntityError);
   });
 
   it("should successfully get all AuthData entries from DynamoDB", async () => {
-    const mockedAPLEntries: SavedItem<typeof segmentAPLEntity>[] = [
+    const mockedAPLEntries: SavedItem<SegmentAPLEntityType>[] = [
       {
         PK: "saleorApiUrl",
         SK: "APL",
@@ -169,7 +161,7 @@ describe("SegmentAPLRepository", () => {
       Items: mockedAPLEntries,
     });
 
-    const repository = new SegmentAPLRepository({ segmentAPLEntity });
+    const repository = new DynamoAPLRepository();
 
     const result = await repository.getAllEntries();
 
@@ -198,7 +190,7 @@ describe("SegmentAPLRepository", () => {
       Items: [],
     });
 
-    const repository = new SegmentAPLRepository({ segmentAPLEntity });
+    const repository = new DynamoAPLRepository();
 
     const result = await repository.getAllEntries();
 
@@ -210,12 +202,12 @@ describe("SegmentAPLRepository", () => {
   it("should handle error when getting all AuthData entries from DynamoDB", async () => {
     mockDocumentClient.on(ScanCommand, {}).rejectsOnce("Exception");
 
-    const repository = new SegmentAPLRepository({ segmentAPLEntity });
+    const repository = new DynamoAPLRepository();
 
     const result = await repository.getAllEntries();
 
     expect(result.isErr()).toBe(true);
 
-    expect(result._unsafeUnwrapErr()).toBeInstanceOf(SegmentAPLRepository.ScanEntityError);
+    expect(result._unsafeUnwrapErr()).toBeInstanceOf(DynamoAPLRepository.ScanEntityError);
   });
 });