@squiz/optimization-utils 2.0.2 → 2.0.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@squiz/optimization-utils",
-  "version": "2.0.2",
+  "version": "2.0.3",
   "description": "",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -10,9 +10,9 @@
     "build:check": "tsc --noEmit"
   },
   "dependencies": {
-    "@squiz/optimization-http-client": "^1.0.0",
-    "@squiz/optimization-logger": "^1.0.1",
-    "@squiz/optimization-value-objects": "^1.0.0",
+    "@squiz/optimization-http-client": "^1.0.1",
+    "@squiz/optimization-logger": "^1.0.2",
+    "@squiz/optimization-value-objects": "^1.0.1",
     "node-fetch-commonjs": "^3.3.2",
     "dotenv": "^16.4.5",
     "@aws-sdk/client-dynamodb": "^3.614.0",

package/CHANGELOG.md

@@ -1,43 +0,0 @@
-# @squiz/optimization-utils
-
-## 2.0.2
-
-### Patch Changes
-
-- cf516f7: Cleaned up the optimization/utils
-
-## 2.0.1
-
-### Patch Changes
-
-- ca7d105: Removed createLogsLambdaHandler function
-
-## 2.0.0
-
-### Major Changes
-
-- abd0e0f: Added EntityId into the DomainEvent interface
-
-## 1.3.0
-
-### Minor Changes
-
-- 24aaeac: Added get property function
-
-## 1.2.0
-
-### Minor Changes
-
-- 0c347a0: Added remote function into the LogMessage, Updated FilterPattern
-
-## 1.1.1
-
-### Patch Changes
-
-- 2a5e0fe: Changed entry points
-
-## 1.1.0
-
-### Minor Changes
-
-- afea2f1: Added the logs lambda handler

package/src/cloudflare/CloudflareKVHttpService.ts

@@ -1,20 +0,0 @@
-import { injectable } from 'inversify';
-
-export type CloudflareKey = string;
-
-export type BatchValueData<T> = Array<{
-  key: CloudflareKey;
-  value: T;
-}>;
-
-// https://developers.cloudflare.com/api/operations/workers-kv-namespace-write-multiple-key-value-pairs
-export const MAX_BATCH_DATA_ITEMS = 10_000;
-
-@injectable()
-export abstract class CloudflareKVHttpService<TSchema> {
-  abstract getValues(key: CloudflareKey): Promise<TSchema>;
-
-  abstract putBulk(batchData: BatchValueData<TSchema>): Promise<void>;
-
-  abstract deleteBulk(keys: Array<CloudflareKey>): Promise<void>;
-}

package/src/cloudflare/ImplCloudflareKVHttpService.ts

@@ -1,129 +0,0 @@
-import { injectable } from 'inversify';
-import { inspect } from 'util';
-import {
-  BatchValueData,
-  CloudflareKey,
-  CloudflareKVHttpService,
-  MAX_BATCH_DATA_ITEMS,
-} from './CloudflareKVHttpService';
-import { ZodType } from 'zod';
-import {
-  HttpRequestBuilderFactory,
-  HttpMethod,
-} from '@squiz/optimization-http-client';
-import { createLog, Logger } from '@squiz/optimization-logger';
-
-export type CloudflareConfig = {
-  domain: string;
-  accountId: string;
-  namespace: string;
-  apiKey: string;
-};
-export type CloudflareConfigProvider = () => Promise<CloudflareConfig>;
-
-@injectable()
-export class ImplCloudflareKVHttpService<TSchema>
-  implements CloudflareKVHttpService<TSchema>
-{
-  constructor(
-    private readonly cloudflareConfigProvider: CloudflareConfigProvider,
-    private readonly httpRequestBuilderFactory: HttpRequestBuilderFactory,
-    private readonly logger: Logger,
-    private readonly schema: TSchema extends ZodType ? TSchema : never,
-  ) {}
-
-  async getValues(key: string): Promise<TSchema> {
-    const response = await this.callApi({
-      path: `/values/${key}`,
-      method: HttpMethod.GET,
-      handleNotFoundAsEmpty: true,
-    });
-
-    return this.schema.parse(
-      typeof response === 'string' ? JSON.parse(response) : {},
-    );
-  }
-
-  async putBulk(batchData: BatchValueData<TSchema>): Promise<void> {
-    if (!batchData.length) {
-      return;
-    }
-
-    if (batchData.length > MAX_BATCH_DATA_ITEMS) {
-      throw new Error(
-        `The max items count has been exceeded. The max items count is ${MAX_BATCH_DATA_ITEMS}`,
-      );
-    }
-
-    await this.callApi({
-      method: HttpMethod.PUT,
-      body: batchData.map((data) => ({
-        ...data,
-        value: JSON.stringify(data.value),
-      })),
-      path: `/bulk`,
-    });
-  }
-
-  async deleteBulk(keys: Array<CloudflareKey>): Promise<void> {
-    if (!keys.length) {
-      return;
-    }
-
-    await this.callApi({
-      method: HttpMethod.DELETE,
-      body: keys,
-      path: `/bulk`,
-    });
-  }
-
-  private async callApi({
-    path,
-    body,
-    method,
-    handleNotFoundAsEmpty = false,
-  }: {
-    path: '/bulk' | `/values/${string}`;
-    method: HttpMethod;
-    body?: Record<string, string> | Array<unknown>;
-    handleNotFoundAsEmpty?: boolean;
-  }): Promise<unknown | undefined> {
-    const config = await this.cloudflareConfigProvider();
-    const baseUrl =
-      `https://${config.domain}/client/v4/accounts/` +
-      `${config.accountId}/storage/kv/namespaces/` +
-      `${config.namespace}`;
-    const url = baseUrl + path;
-
-    const logMessage = createLog()
-      .attachMetadata({ path, method, url })
-      .create(this);
-
-    this.logger.debug(...logMessage('started calling http endpoint'));
-    this.logger.debug(
-      ...logMessage(`the request body: ${inspect(body, { depth: 4 })}`),
-    );
-    const httpBuilder = this.httpRequestBuilderFactory
-      .create()
-      .url(url)
-      .method(method)
-      .body(body)
-      .applicationJson()
-      .authorizationByBearer(config.apiKey);
-
-    handleNotFoundAsEmpty && httpBuilder.handleNotFound();
-
-    const response = await httpBuilder.sendRequest();
-
-    this.logger.debug(...logMessage('finished calling http endpoint'));
-    this.logger.debug(
-      ...logMessage(
-        `returned type: ${typeof response.body}, type: returned: ${inspect(
-          response.body,
-          { depth: 4 },
-        )}`,
-      ),
-    );
-    return response.body;
-  }
-}

package/src/cloudflare/__tests__/ImplCloudflareKVHttpService.spec.ts

@@ -1,178 +0,0 @@
-import {
-  CloudflareConfig,
-  ImplCloudflareKVHttpService,
-} from '../ImplCloudflareKVHttpService';
-import { Container } from 'inversify';
-import {
-  createHttpClientMock,
-  HttpRequestBuilderFactory,
-  HttpClient,
-  HttpMethod,
-  HttpRequestOptions,
-  HttpResponse,
-} from '@squiz/optimization-http-client';
-import { Logger, createLoggerMock } from '@squiz/optimization-logger';
-import { faker } from '@faker-js/faker';
-import { z } from 'zod';
-
-describe('CloudflareKVHttpService', () => {
-  const EXAMPLE_SCHEMA = z.object({
-    example: z.string(),
-  });
-
-  type ExampleSchemaType = z.infer<typeof EXAMPLE_SCHEMA>;
-
-  let service: ImplCloudflareKVHttpService<ExampleSchemaType>;
-  let httpClient: HttpClient;
-  const config: CloudflareConfig = {
-    domain: 'test-domain.com',
-    accountId: 'test-account-id',
-    namespace: 'test-namespace-id',
-    apiKey: 'test-api-key',
-  };
-  const expectedHeaders = {
-    'Content-Type': 'application/json',
-    Authorization: `Bearer ${config.apiKey}`,
-  };
-
-  beforeEach(() => {
-    const container = new Container({ defaultScope: 'Singleton' });
-
-    container
-      .bind(ImplCloudflareKVHttpService)
-      .toDynamicValue(({ container: c }) => {
-        return new ImplCloudflareKVHttpService(
-          () => Promise.resolve(config),
-          c.get(HttpRequestBuilderFactory),
-          c.get(Logger),
-          EXAMPLE_SCHEMA,
-        );
-      });
-    container.bind(HttpRequestBuilderFactory).toSelf();
-    container.bind(HttpClient).toConstantValue(createHttpClientMock());
-    container.bind(Logger).toConstantValue(createLoggerMock());
-
-    service = container.get(ImplCloudflareKVHttpService);
-    httpClient = container.get(HttpClient);
-  });
-
-  describe('getValues', () => {
-    const key = 'example-key';
-
-    it('should get values from Cloudflare KV', async () => {
-      const expectedResponse = { example: faker.string.uuid() };
-
-      const expectedURL =
-        'https://test-domain.com/client/v4/accounts' +
-        '/test-account-id/storage/kv/namespaces/test-namespace-id' +
-        `/values/${key}`;
-
-      jest.spyOn(httpClient, 'sendRequest').mockResolvedValueOnce(
-        new HttpResponse({
-          statusCode: 200,
-          body: JSON.stringify(expectedResponse),
-        }),
-      );
-
-      const result = await service.getValues(key);
-
-      expect(result).toEqual(expectedResponse);
-      expect(httpClient.sendRequest).toHaveBeenCalledWith({
-        url: expectedURL,
-        method: HttpMethod.GET,
-        headers: expectedHeaders,
-        handleHttpErrorStatusCodes: [404],
-      } as HttpRequestOptions);
-    });
-
-    it('should throw an error if fetch fails', async () => {
-      jest.spyOn(httpClient, 'sendRequest').mockRejectedValueOnce(new Error());
-
-      await expect(service.getValues(key)).rejects.toThrow();
-    });
-  });
-
-  describe('putBulk', () => {
-    it('should call the put bulk endpoint', async () => {
-      const value: ExampleSchemaType = { example: faker.string.uuid() };
-      const expectedURL =
-        'https://test-domain.com/client/v4/accounts' +
-        '/test-account-id/storage/kv/namespaces/test-namespace-id' +
-        `/bulk`;
-
-      jest
-        .spyOn(httpClient, 'sendRequest')
-        .mockResolvedValueOnce(
-          new HttpResponse({ statusCode: 200, body: undefined }),
-        );
-
-      await service.putBulk([
-        {
-          key: 'someKey',
-          value: value,
-        },
-      ]);
-
-      expect(httpClient.sendRequest).toHaveBeenCalledWith({
-        url: expectedURL,
-        method: HttpMethod.PUT,
-        headers: expectedHeaders,
-        body: [
-          {
-            key: 'someKey',
-            value: JSON.stringify(value),
-          },
-        ],
-      } as HttpRequestOptions);
-    });
-
-    it('should not call the put bulk endpoint if the batch data array is empty', async () => {
-      await service.putBulk([]);
-
-      expect(httpClient.sendRequest).toHaveBeenCalledTimes(0);
-    });
-
-    it('should throw exception if the items amount exceeds 10_000', async () => {
-      const batch = Array(10_001)
-        .fill('')
-        .map(() => ({
-          key: faker.string.uuid(),
-          value: { example: faker.string.uuid() },
-        }));
-
-      await expect(() => service.putBulk(batch)).rejects.toThrow(
-        'The max items count has been exceeded. The max items count is 10000',
-      );
-    });
-  });
-
-  describe('deleteBulk', () => {
-    it('should call the delete bulk endpoint', async () => {
-      const expectedURL =
-        'https://test-domain.com/client/v4/accounts' +
-        '/test-account-id/storage/kv/namespaces/test-namespace-id' +
-        `/bulk`;
-
-      jest
-        .spyOn(httpClient, 'sendRequest')
-        .mockResolvedValueOnce(
-          new HttpResponse({ statusCode: 200, body: undefined }),
-        );
-
-      await service.deleteBulk(['someKey']);
-
-      expect(httpClient.sendRequest).toHaveBeenCalledWith({
-        url: expectedURL,
-        method: HttpMethod.DELETE,
-        headers: expectedHeaders,
-        body: ['someKey'],
-      } as HttpRequestOptions);
-    });
-  });
-
-  it('should not call the delete bulk endpoint if passed empty keys array', async () => {
-    await service.deleteBulk([]);
-
-    expect(httpClient.sendRequest).toHaveBeenCalledTimes(0);
-  });
-});

package/src/config/ConfigurationLoader.ts

@@ -1,74 +0,0 @@
-import { config } from 'dotenv';
-import * as process from 'process';
-import * as path from 'path';
-import { injectable } from 'inversify';
-import { z, ZodType } from 'zod';
-import {
-  HttpMethod,
-  HttpRequestBuilderFactory,
-} from '@squiz/optimization-http-client';
-
-export abstract class ConfigurationLoader<TSchema extends ZodType> {
-  abstract load(): Promise<z.infer<TSchema>>;
-}
-
-@injectable()
-export class DotEnvConfigurationLoader<TSchema extends ZodType>
-  implements ConfigurationLoader<TSchema>
-{
-  constructor(private readonly schema: TSchema) {}
-
-  async load(): Promise<z.infer<TSchema>> {
-    const output = config({
-      path: path.join(__dirname, '../../../../env/.env'),
-    });
-
-    if (output.error) {
-      throw output.error;
-    }
-
-    return this.schema.parse(process.env);
-  }
-}
-
-export type LambdaLayerAppConfigConfigurationLoaderConfig = {
-  appConfigName: string;
-  env: string;
-  configurationName: string;
-};
-
-@injectable()
-export class LambdaLayerAppConfigConfigurationLoader<TSchema extends ZodType>
-  implements ConfigurationLoader<TSchema>
-{
-  constructor(
-    private readonly opts: LambdaLayerAppConfigConfigurationLoaderConfig,
-    private readonly httpRequestBuilderFactory: HttpRequestBuilderFactory,
-    private readonly schema: TSchema,
-  ) {}
-
-  async load(): Promise<z.infer<TSchema>> {
-    const configuration = await this.fetchFromApi();
-
-    return this.schema.parse(configuration);
-  }
-
-  private async fetchFromApi(): Promise<unknown> {
-    const application = this.opts.appConfigName;
-    const environment = this.opts.env;
-    const configuration = this.opts.configurationName;
-    // the http://localhost:2772 represents the URL to the AWS AppConfig Lambda layer
-    // the documentation: https://docs.aws.amazon.com/appconfig/latest/userguide/appconfig-integration-lambda-extensions.html
-    const url =
-      `http://localhost:2772` +
-      `/applications/${application}/environments/${environment}/configurations/${configuration}`;
-
-    const response = await this.httpRequestBuilderFactory
-      .create()
-      .url(url)
-      .method(HttpMethod.GET)
-      .sendRequest();
-
-    return response.body;
-  }
-}

package/src/config/__tests__/ConfigurationLoader.spec.ts

@@ -1,62 +0,0 @@
-import {
-  ConfigurationLoader,
-  LambdaLayerAppConfigConfigurationLoader,
-  LambdaLayerAppConfigConfigurationLoaderConfig,
-} from '../ConfigurationLoader';
-import {
-  HttpRequestBuilderFactory,
-  HttpClient,
-  HttpMethod,
-  HttpResponse,
-  createHttpClientMock,
-} from '@squiz/optimization-http-client';
-import { faker } from '@faker-js/faker';
-import { z } from 'zod';
-
-describe('LambdaLayerAppConfigConfigurationLoader', () => {
-  const opts: LambdaLayerAppConfigConfigurationLoaderConfig = {
-    env: 'local',
-    appConfigName: 'example-app',
-    configurationName: 'main',
-  };
-  const CONFIG_SCHEMA = z.object({
-    EXAMPLE_VALUE: z.string(),
-  });
-
-  type Config = z.infer<typeof CONFIG_SCHEMA>;
-
-  let configurationLoader: ConfigurationLoader<typeof CONFIG_SCHEMA>;
-  let httpClient: HttpClient;
-
-  beforeEach(() => {
-    httpClient = createHttpClientMock();
-    configurationLoader = new LambdaLayerAppConfigConfigurationLoader<
-      typeof CONFIG_SCHEMA
-    >(opts, new HttpRequestBuilderFactory(httpClient), CONFIG_SCHEMA);
-  });
-
-  it('should call AWS AppConfig Layer with passed arguments', async () => {
-    const expectedResult: Config = {
-      EXAMPLE_VALUE: faker.word.words(),
-    };
-
-    jest.spyOn(httpClient, 'sendRequest').mockResolvedValueOnce(
-      new HttpResponse({
-        body: expectedResult,
-        statusCode: 200,
-      }),
-    );
-
-    const result = await configurationLoader.load();
-
-    const expectedURL =
-      `http://localhost:2772` +
-      `/applications/example-app/environments/local/configurations/main`;
-
-    expect(result).toEqual(expectedResult);
-    expect(httpClient.sendRequest).toHaveBeenCalledWith({
-      url: expectedURL,
-      method: HttpMethod.GET,
-    });
-  });
-});

package/src/date/DateManipulator.ts

@@ -1,29 +0,0 @@
-export type DateManipulator = {
-  addDays(days: number): DateManipulator;
-  addMonths(months: number): DateManipulator;
-  valueOf(): Date;
-};
-
-export function DateManipulator(input: Date): DateManipulator {
-  const addDays = (days: number): DateManipulator => {
-    const copiedDate = new Date(input);
-
-    copiedDate.setDate(copiedDate.getDate() + days);
-
-    return DateManipulator(copiedDate);
-  };
-
-  const addMonths = (months: number): DateManipulator => {
-    const copiedDate = new Date(input);
-
-    copiedDate.setMonth(copiedDate.getMonth() + months);
-
-    return DateManipulator(copiedDate);
-  };
-
-  return {
-    addDays,
-    addMonths,
-    valueOf: () => new Date(input),
-  };
-}

package/src/date/__tests__/DateManipulator.spec.ts

@@ -1,64 +0,0 @@
-import { DateManipulator } from '../DateManipulator';
-
-describe('DateManipulator', () => {
-  describe('addDays', () => {
-    it('should add given days to date', () => {
-      const result = DateManipulator(new Date('2020-01-01T00:00:00.000Z'))
-        .addDays(32)
-        .valueOf();
-
-      expect(result).toEqual(new Date('2020-02-02T00:00:00.000Z'));
-    });
-
-    it('should not change the date if passed 0 days', () => {
-      const result = DateManipulator(new Date('2020-01-01T00:00:00.000Z'))
-        .addDays(0)
-        .valueOf();
-
-      expect(result).toEqual(new Date('2020-01-01T00:00:00.000Z'));
-    });
-
-    it('should not mutate the input date', () => {
-      const originalDate = new Date('2020-01-01T00:00:00.000Z');
-
-      const result = DateManipulator(originalDate).addDays(1).valueOf();
-
-      expect(result).not.toEqual(originalDate);
-    });
-  });
-
-  describe('addMonths', () => {
-    it('should add given days to date', () => {
-      const result = DateManipulator(new Date('2020-01-01T00:00:00.000Z'))
-        .addMonths(12)
-        .valueOf();
-
-      expect(result).toEqual(new Date('2021-01-01T00:00:00.000Z'));
-    });
-
-    it('should not change the date if passed 0 months', () => {
-      const result = DateManipulator(new Date('2020-01-01T00:00:00.000Z'))
-        .addMonths(0)
-        .valueOf();
-
-      expect(result).toEqual(new Date('2020-01-01T00:00:00.000Z'));
-    });
-
-    it('should not mutate the input date', () => {
-      const originalDate = new Date('2020-01-01T00:00:00.000Z');
-
-      const result = DateManipulator(originalDate).addMonths(1).valueOf();
-
-      expect(result).not.toEqual(originalDate);
-    });
-  });
-
-  it('should return combined result', () => {
-    const result = DateManipulator(new Date('2020-01-01T00:00:00.000Z'))
-      .addMonths(12)
-      .addDays(1)
-      .valueOf();
-
-    expect(result).toEqual(new Date('2021-01-02T00:00:00.000Z'));
-  });
-});

package/src/event/AggregateRoot.ts

@@ -1,5 +0,0 @@
-import { DomainEvent } from './DomainEvent';
-
-export interface AggregateRoot {
-  events(): Array<DomainEvent>;
-}

package/src/event/DomainEvent.ts

@@ -1,53 +0,0 @@
-import 'reflect-metadata';
-
-export interface DomainEvent<
-  TData extends Record<string, unknown> = Record<string, unknown>,
-> {
-  readonly eventId: string;
-  readonly name: string;
-  readonly detail: TData;
-  readonly time: Date;
-  readonly version: string;
-  readonly entityId: string;
-}
-
-const DOMAIN_EVENT_SYMBOL = Symbol();
-
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-export type DomainEventConstructor = new (...any: Array<any>) => DomainEvent;
-export type DomainEventName = string;
-
-export function getDomainEventType(
-  name: DomainEventName,
-): DomainEventConstructor | undefined {
-  const domainEvents = getDomainMetadata();
-
-  return domainEvents.find((d) => d.name === name);
-}
-
-export function getDomainMetadata(): Array<DomainEventConstructor> {
-  return Reflect.getMetadata(DOMAIN_EVENT_SYMBOL, Object) ?? [];
-}
-
-function setDomainMetadata(domainEvent: DomainEventConstructor): void {
-  const metadata = getDomainMetadata();
-  const isDomainEventExist = getDomainEventType(domainEvent.name);
-
-  if (isDomainEventExist) {
-    throw new Error(
-      `The DomainEvent Name has been used two times: "${domainEvent.name}". Each event name should be uniq`,
-    );
-  }
-
-  Reflect.defineMetadata(
-    DOMAIN_EVENT_SYMBOL,
-    [...metadata, domainEvent],
-    Object,
-  );
-}
-
-export function AsDomainEvent(): ClassDecorator {
-  return (target) => {
-    setDomainMetadata(target as unknown as DomainEventConstructor);
-  };
-}