@commercetools/checkout-payments-processor-sdk 0.0.6

package/src/fetch/fetch.test.ts

@@ -0,0 +1,57 @@
+import { HttpResponse, http } from 'msw';
+import { setupServer } from 'msw/node';
+import { RequestContextProvider } from '@/api/context/request-context.provider.js';
+import { BasicFetcher } from '@/fetch/decorators/base.decorator.js';
+import { MonitoringFetcherDecorator } from '@/fetch/decorators/monitoring.decorator.js';
+import type { Fetcher } from '@/fetch/types/fetch.type.js';
+
+describe('fetch', () => {
+  const requestContextProvider = new RequestContextProvider({
+    getContextFn: vi.fn(),
+    updateContextFn: vi.fn(),
+  });
+  const fetch: Fetcher = new MonitoringFetcherDecorator(
+    new BasicFetcher(),
+    requestContextProvider,
+  );
+  const customFetch = fetch.run.bind(fetch);
+
+  const mockServer = setupServer(
+    http.get('https://some-url.com', ({ request }) => {
+      return HttpResponse.json({
+        correlationId: request.headers.get('x-correlation-id'),
+        requestId: request.headers.get('x-request-id'),
+      });
+    }),
+  );
+
+  beforeAll(async () => {
+    mockServer.listen();
+  });
+
+  afterEach(() => {
+    mockServer.restoreHandlers();
+  });
+
+  afterAll(async () => {
+    mockServer.close();
+  });
+
+  test('it should inject the correlation id and request id', async () => {
+    // Given
+    vi.spyOn(requestContextProvider, 'getContextData').mockReturnValue({
+      correlationId: 'correlation-id',
+      requestId: 'request-id',
+    });
+
+    // When
+    const request = await customFetch('https://some-url.com');
+    const response = await request.json();
+
+    // Then
+    expect(response).toEqual({
+      requestId: 'request-id',
+      correlationId: 'correlation-id',
+    });
+  });
+});

package/src/fetch/index.ts

@@ -0,0 +1,3 @@
+// Decorators
+export * from '@/fetch/decorators/base.decorator.js';
+export * from '@/fetch/decorators/monitoring.decorator.js';

package/src/fetch/types/fetch.type.ts

@@ -0,0 +1,11 @@
+export interface Fetcher {
+  run(
+    input: string | URL | globalThis.Request,
+    init?: RequestInit,
+  ): Promise<Response>;
+}
+
+export type Fetch = (
+  input: string | URL | globalThis.Request,
+  init?: RequestInit,
+) => Promise<Response>;

package/src/fetch/types.ts

@@ -0,0 +1 @@
+export * from '@/fetch/types/fetch.type.js';

package/src/index.ts

@@ -0,0 +1,15 @@
+// Core modules
+export * from '@api';
+export * from '@api-types';
+export * from '@commercetools';
+export * from '@commercetools-types';
+export * from '@errorx';
+export * from '@errorx-types';
+export * from '@fetch';
+export * from '@fetch-types';
+export * from '@logger';
+export * from '@logger-types';
+export * from '@mocks';
+export * from '@security';
+export * from '@security-types';
+export * from './payment-processor.js';

package/src/logger/commercetools-logger.ts

@@ -0,0 +1,69 @@
+import { createApplicationLogger } from '@commercetools-backend/loggers';
+import cloneDeep from 'lodash/cloneDeep.js';
+import setIn from 'lodash/set.js';
+import { format } from 'logform';
+import type { RequestContextProvider } from '@/api/index.js';
+
+type DefaultFields = {
+  [key: string]:
+    | undefined
+    | string
+    | object
+    | (() => object | string | undefined);
+};
+
+export const defaultFieldsFormatter = (defaults: DefaultFields) => {
+  return format((info) => {
+    const clone = cloneDeep(info);
+
+    Object.entries(defaults).forEach(([key, value]) => {
+      if (value === undefined) {
+        // Do nothing
+      } else if (typeof value === 'object' || typeof value === 'string') {
+        setIn(clone, key, value);
+      } else if (typeof value === 'function') {
+        const evaluated = value();
+        if (evaluated !== undefined) {
+          setIn(clone, key, evaluated);
+        }
+      }
+    });
+
+    return clone;
+  })(defaults);
+};
+
+export class CommercetoolsLogger {
+  private logger;
+
+  constructor(opts: {
+    contextProvider: RequestContextProvider;
+    projectKey: string;
+  }) {
+    this.logger = createApplicationLogger({
+      formatters: [
+        defaultFieldsFormatter({
+          projectKey: opts.projectKey,
+          correlationId: () =>
+            opts.contextProvider.getContextData().correlationId,
+        }),
+      ],
+    });
+  }
+
+  debug(obj: object, message: string): void {
+    this.logger.debug(message, obj);
+  }
+
+  info(obj: object, message: string): void {
+    this.logger.info(message, obj);
+  }
+
+  warn(obj: object, message: string): void {
+    this.logger.warn(message, obj);
+  }
+
+  error(obj: object, message: string): void {
+    this.logger.error(message, obj);
+  }
+}

package/src/logger/index.ts

@@ -0,0 +1 @@
+export * from '@/logger/commercetools-logger.js';

package/src/logger/types/logger.type.ts

@@ -0,0 +1,6 @@
+export interface Logger {
+  debug(obj: object, message: string): void;
+  info(obj: object, message: string): void;
+  warn(obj: object, message: string): void;
+  error(obj: object, message: string): void;
+}

package/src/logger/types.ts

@@ -0,0 +1 @@
+export * from '@/logger/types/logger.type.js';

package/src/mocks/auth.mock.ts

@@ -0,0 +1,6 @@
+export const authToken = {
+  access_token: 'token',
+  token_type: 'Bearer',
+  expires_in: 172800,
+  scope: 'manage_project:test-project',
+};

package/src/mocks/cart.mock.ts

@@ -0,0 +1,239 @@
+import type { Cart, TaxedItemPrice } from '@commercetools/platform-sdk';
+
+export const cartMock: Cart = {
+  id: 'cartId',
+  version: 1,
+  createdAt: '2023-10-17T07:08:44.338Z',
+  lastModifiedAt: '2023-10-17T07:19:25.365Z',
+  lastModifiedBy: {
+    clientId: 'clientId',
+  },
+  createdBy: {
+    clientId: 'clientId',
+  },
+  country: 'NL',
+  lineItems: [
+    {
+      id: 'lineItemId',
+      productId: 'productId',
+      name: {
+        en: 'Bag medium GUM black',
+      },
+      productType: {
+        typeId: 'product-type',
+        id: 'bc16228e-0196-44ab-b5aa-079c49e4bc08',
+      },
+      productSlug: {
+        en: 'gum-bag-medium-BS1900-black',
+      },
+      variant: {
+        id: 1,
+        sku: 'variantSku',
+        prices: [
+          {
+            id: '47159d65-69da-4def-bd5b-2346f2d06c2a',
+            value: {
+              type: 'centPrecision',
+              currencyCode: 'EUR',
+              centAmount: 11875,
+              fractionDigits: 2,
+            },
+            discounted: {
+              value: {
+                type: 'centPrecision',
+                currencyCode: 'EUR',
+                centAmount: 11637,
+                fractionDigits: 2,
+              },
+              discount: {
+                typeId: 'product-discount',
+                id: '9b61aeff-0848-4fab-aeb5-8c0bad74365c',
+              },
+            },
+          },
+        ],
+        images: [],
+        attributes: [],
+        assets: [],
+      },
+      price: {
+        id: '47159d65-69da-4def-bd5b-2346f2d06c2a',
+        value: {
+          type: 'centPrecision',
+          currencyCode: 'EUR',
+          centAmount: 11875,
+          fractionDigits: 2,
+        },
+        discounted: {
+          value: {
+            type: 'centPrecision',
+            currencyCode: 'EUR',
+            centAmount: 11637,
+            fractionDigits: 2,
+          },
+          discount: {
+            typeId: 'product-discount',
+            id: '9b61aeff-0848-4fab-aeb5-8c0bad74365c',
+          },
+        },
+      },
+      quantity: 1,
+      discountedPricePerQuantity: [],
+      taxRate: {
+        name: '19% incl.',
+        amount: 0.19,
+        includedInPrice: false,
+        country: 'DE',
+        id: 'X-75EvFb',
+        subRates: [],
+      },
+      perMethodTaxRate: [],
+      addedAt: '2023-10-17T07:15:06.819Z',
+      lastModifiedAt: '2023-10-17T07:15:06.819Z',
+      state: [
+        {
+          quantity: 1,
+          state: {
+            typeId: 'state',
+            id: 'd776bd88-2db7-421f-8372-393fb493c704',
+          },
+        },
+      ],
+      priceMode: 'Platform',
+      lineItemMode: 'Standard',
+      totalPrice: {
+        type: 'centPrecision',
+        currencyCode: 'EUR',
+        centAmount: 11637,
+        fractionDigits: 2,
+      },
+      taxedPrice: {
+        totalNet: {
+          type: 'centPrecision',
+          currencyCode: 'EUR',
+          centAmount: 11637,
+          fractionDigits: 2,
+        },
+        totalGross: {
+          type: 'centPrecision',
+          currencyCode: 'EUR',
+          centAmount: 13848,
+          fractionDigits: 2,
+        },
+        totalTax: {
+          type: 'centPrecision',
+          currencyCode: 'EUR',
+          centAmount: 2211,
+          fractionDigits: 2,
+        },
+      } as TaxedItemPrice,
+      taxedPricePortions: [],
+    },
+  ],
+  cartState: 'Active',
+  totalPrice: {
+    type: 'centPrecision',
+    currencyCode: 'EUR',
+    centAmount: 11637,
+    fractionDigits: 2,
+  },
+  taxedPrice: {
+    totalNet: {
+      type: 'centPrecision',
+      currencyCode: 'EUR',
+      centAmount: 11637,
+      fractionDigits: 2,
+    },
+    totalGross: {
+      type: 'centPrecision',
+      currencyCode: 'EUR',
+      centAmount: 13848,
+      fractionDigits: 2,
+    },
+    taxPortions: [
+      {
+        rate: 0.19,
+        amount: {
+          type: 'centPrecision',
+          currencyCode: 'EUR',
+          centAmount: 2211,
+          fractionDigits: 2,
+        },
+        name: '19% incl.',
+      },
+    ],
+    totalTax: {
+      type: 'centPrecision',
+      currencyCode: 'EUR',
+      centAmount: 2211,
+      fractionDigits: 2,
+    },
+  },
+  shippingMode: 'Single',
+  shippingAddress: {
+    title: 'My Address',
+    salutation: 'Mr.',
+    firstName: 'Example',
+    lastName: 'Person',
+    streetName: 'Example Street',
+    streetNumber: '4711',
+    additionalStreetInfo: 'Backhouse',
+    postalCode: '80933',
+    city: 'Exemplary City',
+    region: 'Exemplary Region',
+    state: 'Exemplary State',
+    country: 'DE',
+    company: 'My Company Name',
+    department: 'Sales',
+    building: 'Hightower 1',
+    apartment: '247',
+    pOBox: '2471',
+    phone: '+49 89 12345678',
+    mobile: '+49 171 2345678',
+    email: 'email@example.com',
+    fax: '+49 89 12345679',
+    additionalAddressInfo: 'no additional Info',
+    externalId: 'Information not needed',
+    key: 'exampleKey',
+  },
+  shipping: [],
+  customLineItems: [],
+  discountCodes: [],
+  directDiscounts: [],
+  inventoryMode: 'None',
+  taxMode: 'Platform',
+  taxRoundingMode: 'HalfEven',
+  taxCalculationMode: 'LineItemLevel',
+  deleteDaysAfterLastModification: 90,
+  refusedGifts: [],
+  origin: 'Customer',
+  billingAddress: {
+    title: 'My Address',
+    salutation: 'Mr.',
+    firstName: 'Example',
+    lastName: 'Person',
+    streetName: 'Example Street',
+    streetNumber: '4711',
+    additionalStreetInfo: 'Backhouse',
+    postalCode: '80933',
+    city: 'Exemplary City',
+    region: 'Exemplary Region',
+    state: 'Exemplary State',
+    country: 'DE',
+    company: 'My Company Name',
+    department: 'Sales',
+    building: 'Hightower 1',
+    apartment: '247',
+    pOBox: '2471',
+    phone: '+49 89 12345678',
+    mobile: '+49 171 2345678',
+    email: 'email@example.com',
+    fax: '+49 89 12345679',
+    additionalAddressInfo: 'no additional Info',
+    externalId: 'Information not needed',
+    key: 'exampleKey',
+  },
+  itemShippingAddresses: [],
+  totalLineItemQuantity: 1,
+  priceRoundingMode: 'HalfEven',
+};

package/src/mocks/ct-api-error.mock.ts

@@ -0,0 +1,23 @@
+export const ctAPIErrorMock = (
+  statusCode: number,
+  errorCode: string,
+  errorMessage: string,
+) => {
+  return {
+    code: statusCode,
+    statusCode,
+    status: statusCode,
+    message: errorMessage,
+    body: {
+      statusCode,
+      message: errorMessage,
+      errors: [
+        {
+          code: errorCode,
+          message: 'more specific error message',
+        },
+      ],
+    },
+    name: errorCode,
+  };
+};

package/src/mocks/index.ts

@@ -0,0 +1,4 @@
+export * from '@/mocks/auth.mock.js';
+export * from '@/mocks/cart.mock.js';
+export * from '@/mocks/ct-api-error.mock.js';
+export * from '@/mocks/payment.mock.js';

package/src/mocks/payment.mock.ts

@@ -0,0 +1,35 @@
+import type { Payment } from '@commercetools/platform-sdk';
+
+export const paymentMock = {
+  id: 'paymentId',
+  version: 1,
+  createdAt: '2023-10-19T15:02:03.337Z',
+  lastModifiedAt: '2023-10-19T15:02:03.860Z',
+  key: 'paymentKey',
+  amountPlanned: {
+    type: 'centPrecision',
+    currencyCode: 'EUR',
+    centAmount: 2000,
+    fractionDigits: 2,
+  },
+  paymentMethodInfo: {
+    paymentInterface: 'ct-adyen',
+    method: 'card',
+  },
+  paymentStatus: {},
+  transactions: [
+    {
+      id: '1',
+      timestamp: '2023-10-19T15:02:03.355Z',
+      type: 'Authorization',
+      amount: {
+        type: 'centPrecision',
+        currencyCode: 'EUR',
+        centAmount: 2000,
+        fractionDigits: 2,
+      },
+      state: 'Initial',
+    },
+  ],
+  interfaceInteractions: [],
+} as Payment;