@tomassabol/aws-services 1.8.0 → 1.8.2

package/CHANGELOG.md

@@ -1,96 +0,0 @@
-# Changelog
-
-All notable changes to this project will be documented in this file.
-
-The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
-and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
-
-## [1.8.0] - 2024-06-24
-
-### Changed
-
-- WMS-488 Improve sendEvent error handling
-
-## [1.7.1] - 2024-06-22
-
-### Changed
-
-- Bump @aws-lambda-powertools/logger
-
-### Security
-
-- Remove NPM token
-
-## [1.7.0] - 2023-11-18
-
-### Added
-
-- Add Jest mock for SSM
-
-## [1.6.1] - 2023-11-04
-
-### Added
-
-- Add getSecret method to Secrets Manager mock
-
-### Security
-
-- Fix vulnerabilities
-
-## [1.6.0] - 2023-08-18
-
-### Added
-
-- Add Jest mocks for DynamoDB, EventBridge, Secrets Manager and SQS
-
-## [1.5.0] - 2023-08-14
-
-### Changed
-
-- Improve S3 client
-
-## [1.4.0] - 2023-08-12
-
-### Changed
-
-- Improve EventBridge client
-
-## [1.3.0] - 2023-08-11
-
-### Added
-
-- Add format check step to Bitbucket pipeline
-- Add nvm configuration file
-
-### Changed
-
-- Improve SSM client
-- Improve SQS client
-- Improve Secrets Manager client
-- Improve DynamoDB client
-- Upgrade AWS CDK libs
-- Refactor NPM scripts
-- Update nvm configuration file
-- Improve Bitbucket pipeline
-
-### Removed
-
-- Remove npm-run-all package
-
-### Security
-
-- Fix vulnerabilities
-
-## [1.2.1] - 2023-06-08
-
-### Fixed
-
-- Fix importing without dist folder
-
-### Security
-
-- Fix vulnerabilities
-
-## [1.1.1]
-
-- Initial release

package/bitbucket-pipelines.yml

@@ -1,65 +0,0 @@
-image: node:18
-
-definitions:
-  steps:
-    - step: &build-step
-        name: Build
-        caches:
-          - node
-        script:
-          - npm ci
-    - step: &format-step
-        name: Format
-        caches:
-          - node
-        script:
-          - npm run format
-    - step: &lint-step
-        name: Lint
-        caches:
-          - node
-        script:
-          - npm run lint
-    - step: &test-step
-        name: Test
-        caches:
-          - node
-        script:
-          - npm test
-        artifacts:
-          - .coverage/lcov.info
-          - .sonar/test-report.xml
-    - step: &code-analysis-step
-        name: Code Analysis
-        caches:
-          - sonar
-        script:
-          - pipe: sonarsource/sonarqube-scan:2.0.1
-            variables:
-              SONAR_HOST_URL: ${SONAR_HOST_URL}
-              SONAR_TOKEN: ${SONAR_TOKEN}
-
-  caches:
-    sonar: /opt/sonar-scanner/.sonar
-
-clone:
-  depth: full
-
-pipelines:
-  branches:
-    "{main,test,prod}":
-      - step: *build-step
-      - parallel:
-          - step: *format-step
-          - step: *lint-step
-          - step: *test-step
-      - step: *code-analysis-step
-
-  pull-requests:
-    "**":
-      - step: *build-step
-      - parallel:
-          - step: *format-step
-          - step: *lint-step
-          - step: *test-step
-      - step: *code-analysis-step

package/jest.config.js

@@ -1,62 +0,0 @@
-/*
- * For a detailed explanation regarding each configuration property and type check, visit:
- * https://jestjs.io/docs/en/configuration.html
- */
-
-module.exports = {
-  /**
-   * Paths
-   */
-
-  // A list of paths to directories that Jest should use to search for files in
-  roots: ["./test"],
-
-  // The glob patterns Jest uses to detect test files
-  testMatch: ["<rootDir>/test/**/*.test.ts"],
-
-  // Transformers for files
-  transform: {
-    "^.+\\.tsx?$": [
-      "esbuild-jest",
-      {
-        sourcemap: true,
-      },
-    ],
-  },
-
-  /*
-   * Results processing
-   */
-
-  // Indicates whether the coverage information should be collected while executing the test
-  collectCoverage: true,
-
-  // An array of glob patterns indicating a set of files for which coverage information should be collected
-  collectCoverageFrom: ["src/**/*.ts"],
-
-  // An array of regexp pattern strings used to skip coverage for certain files
-  coveragePathIgnorePatterns: ["src/logger.ts"],
-
-  // The directory where Jest should output its coverage files
-  coverageDirectory: ".coverage",
-
-  // Export test results fo SonarQube scanner to process test results
-  testResultsProcessor: "jest-sonar-reporter",
-
-  /*
-   * Test environment
-   */
-
-  // The test environment that will be used for testing
-  testEnvironment: "node",
-
-  // Run for all tests
-  // setupFiles: ["<rootDir>/test/env.ts"],
-
-  /*
-   * Mocks
-   */
-
-  // Automatically clear mock calls and instances between every test
-  clearMocks: true,
-}

package/sonar-project.properties

@@ -1,8 +0,0 @@
-sonar.projectKey=tomassaboldev_aws-services_bb5f4f68-64f8-4726-bdd4-579ceadf172d
-sonar.sources=src
-sonar.tests=test
-sonar.exclusions=src/logger.ts
-sonar.scm.provider=git
-sonar.qualitygate.wait=true
-sonar.javascript.lcov.reportPaths=.coverage/lcov.info
-sonar.testExecutionReportPaths=.sonar/test-report.xml

package/src/appconfig.ts

@@ -1,20 +0,0 @@
-import {
-  AppConfigClient,
-  GetApplicationCommand,
-} from "@aws-sdk/client-appconfig"
-import { logger } from "./logger"
-
-export const appConfigClient = new AppConfigClient({})
-
-export const getApplication = async (applicationId: string) => {
-  try {
-    return await appConfigClient.send(
-      new GetApplicationCommand({
-        ApplicationId: applicationId,
-      })
-    )
-  } catch (error) {
-    logger.error("getApplication", { error, applicationId })
-    throw error
-  }
-}

package/src/dynamodb.mock.ts

@@ -1,10 +0,0 @@
-export const mockDynamodbService = {
-  client: {
-    send: jest.fn(),
-  },
-  documentClient: {
-    send: jest.fn(),
-  },
-}
-
-jest.mock("@tomassabol/aws-services/dynamodb", () => mockDynamodbService)

package/src/dynamodb.ts

@@ -1,7 +0,0 @@
-import { DynamoDBClient } from "@aws-sdk/client-dynamodb"
-import { DynamoDBDocumentClient } from "@aws-sdk/lib-dynamodb"
-
-export const client: DynamoDBClient = new DynamoDBClient({})
-
-export const documentClient: DynamoDBDocumentClient =
-  DynamoDBDocumentClient.from(client)

package/src/eventbridge.mock.ts

@@ -1,5 +0,0 @@
-export const mockEventbridgeService = {
-  sendEvent: jest.fn(),
-}
-
-jest.mock("@tomassabol/aws-services/eventbridge", () => mockEventbridgeService)

package/src/eventbridge.ts

@@ -1,47 +0,0 @@
-/* eslint-disable @typescript-eslint/no-explicit-any */
-import {
-  EventBridgeClient,
-  PutEventsCommand,
-} from "@aws-sdk/client-eventbridge"
-import { logger } from "./logger"
-
-export const client = new EventBridgeClient({})
-
-export async function sendEvent(params: {
-  source: string
-  eventBusName: string
-  eventType: string
-  event: any
-}) {
-  const { eventBusName, eventType, event, source } = params
-
-  const input = {
-    Entries: [
-      {
-        EventBusName: eventBusName,
-        Source: source,
-        DetailType: eventType,
-        Detail: JSON.stringify(event),
-      },
-    ],
-  }
-
-  const command = new PutEventsCommand(input)
-
-  try {
-    const result = await client.send(command)
-
-    /* Check if there are any failed events */
-    if (result.FailedEntryCount) {
-      const errorDetail = result.Entries?.length
-        ? `${result.Entries[0].ErrorCode}: ${result.Entries[0].ErrorMessage}}`
-        : "unknown"
-      throw new Error(`PutEventsCommand error ${errorDetail}`)
-    }
-
-    logger.debug("sendEvent success", { input, result })
-  } catch (error) {
-    logger.error("sendEvent error", { input, error })
-    throw error
-  }
-}

package/src/logger.ts

@@ -1,14 +0,0 @@
-import { Logger } from "@aws-lambda-powertools/logger"
-
-const noLogger = {
-  log: () => undefined,
-  debug: () => undefined,
-  info: () => undefined,
-  error: () => undefined,
-  warn: () => undefined,
-} as typeof console
-
-export const logger =
-  process.env.JEST_WORKER_ID === undefined || process.env.TEST_LOGGER
-    ? new Logger({ logLevel: "DEBUG" })
-    : noLogger

package/src/s3.ts

@@ -1,56 +0,0 @@
-import { S3, PutObjectCommandOutput } from "@aws-sdk/client-s3"
-import { logger } from "./logger"
-
-export const client = new S3({})
-
-export async function putObjectToS3(params: {
-  bucket: string
-  key: string
-  body: string | Uint8Array | Buffer
-  contentEncoding: string
-  contentType: string
-}): Promise<PutObjectCommandOutput> {
-  const { bucket, key, body, contentEncoding, contentType } = params
-
-  try {
-    return await client.putObject({
-      Bucket: bucket,
-      Key: key,
-      Body: body,
-      ContentEncoding: contentEncoding,
-      ContentType: contentType,
-    })
-  } catch (error) {
-    logger.error("putObjectToS3", {
-      error,
-      params: { bucket, key, contentEncoding, contentType },
-    })
-    throw error
-  }
-}
-
-export async function getObjectFromS3(params: {
-  bucket: string
-  key: string
-}): Promise<Uint8Array> {
-  try {
-    const { bucket, key } = params
-
-    const result = await client.getObject({
-      Bucket: bucket,
-      Key: key,
-    })
-
-    const body = result.Body
-
-    if (body === undefined) {
-      logger.error("Body not found", { params })
-      throw new Error("Body not found")
-    }
-
-    return await body.transformToByteArray()
-  } catch (error) {
-    logger.error("getObjectFromS3", { error, params })
-    throw error
-  }
-}

package/src/secrets-manager.mock.ts

@@ -1,9 +0,0 @@
-export const mockSecretsManagerService = {
-  getSecret: jest.fn(),
-  getSecretAsObject: jest.fn(),
-}
-
-jest.mock(
-  "@tomassabol/aws-services/secrets-manager",
-  () => mockSecretsManagerService
-)

package/src/secrets-manager.ts

@@ -1,37 +0,0 @@
-import {
-  SecretsManagerClient,
-  GetSecretValueCommand,
-} from "@aws-sdk/client-secrets-manager"
-import assert from "assert"
-import { logger } from "./logger"
-
-export const client = new SecretsManagerClient({})
-
-export async function getSecret(secretName: string): Promise<string> {
-  try {
-    const response = await client.send(
-      new GetSecretValueCommand({
-        SecretId: secretName,
-      })
-    )
-    const value = response.SecretString
-    assert(value, "SecretString value not found")
-    return value
-  } catch (error) {
-    logger.error("getSecret", { error, secretName })
-    // For a list of exceptions thrown, see
-    // https://docs.aws.amazon.com/secretsmanager/latest/apireference/API_GetSecretValue.html
-    throw error
-  }
-}
-
-export async function getSecretAsObject<T = unknown>(
-  secretName: string
-): Promise<T> {
-  const value = await getSecret(secretName)
-  try {
-    return JSON.parse(value)
-  } catch (error) {
-    throw Error(`Cannot parse secret ${secretName}. Expected JSON.`)
-  }
-}

package/src/sns.ts

@@ -1,24 +0,0 @@
-import { SNSClient, PublishCommand } from "@aws-sdk/client-sns"
-import { logger } from "./logger"
-
-export const snsClient = new SNSClient({})
-
-export const publishMessageToSNS = async (params: {
-  topicArn: string
-  message: string
-  options?: object
-}) => {
-  try {
-    const { topicArn, message, options } = params
-    return await snsClient.send(
-      new PublishCommand({
-        TopicArn: topicArn,
-        Message: message,
-        ...options,
-      })
-    )
-  } catch (error) {
-    logger.error("publishMessageToSNS", { error, params })
-    throw error
-  }
-}

package/src/sqs.mock.ts

@@ -1,5 +0,0 @@
-export const mockSqsService = {
-  sendSqsMessage: jest.fn(),
-}
-
-jest.mock("@tomassabol/aws-services/sqs", () => mockSqsService)

package/src/sqs.ts

@@ -1,32 +0,0 @@
-import {
-  SQSClient,
-  SendMessageCommand,
-  SendMessageCommandInput,
-} from "@aws-sdk/client-sqs"
-import { logger } from "./logger"
-
-export const client = new SQSClient({})
-
-export async function sendSqsMessage(params: {
-  queueUrl: string
-  message: string | object
-}): Promise<string | undefined> {
-  const { queueUrl, message } = params
-
-  try {
-    const body = typeof message === "object" ? JSON.stringify(message) : message
-
-    const input: SendMessageCommandInput = {
-      QueueUrl: queueUrl,
-      MessageBody: body,
-    }
-
-    const command = new SendMessageCommand(input)
-
-    const response = await client.send(command)
-    return response.MessageId
-  } catch (error) {
-    logger.error("sendSqsMessage", { error, params })
-    throw error
-  }
-}

package/src/ssm.mock.ts

@@ -1,5 +0,0 @@
-export const mockSsmService = {
-  getSsmParameters: jest.fn(),
-}
-
-jest.mock("@tomassabol/aws-services/ssm", () => mockSsmService)

package/src/ssm.ts

@@ -1,70 +0,0 @@
-import { SSMClient, GetParametersCommand } from "@aws-sdk/client-ssm"
-import assert = require("assert")
-
-export const client = new SSMClient({})
-
-export type SSMParameters = {
-  [name: string]: string
-}
-
-/**
- * Get a list of parameters from SSM Parameter Store
- *
- * @example
- * ```typescript
- * const params = await getSsmParameters({
- *   first: "/my-params/first",
- *   second: "/my-params/second",
- * })
- *
- * // params = { first: "value1", second: "value2" }
- * ```
- */
-
-export async function getSsmParameters<T extends SSMParameters>(
-  parameters: T
-): Promise<T> {
-  /*
-   * Fetch parameters from SSM
-   */
-
-  const command = new GetParametersCommand({
-    Names: Object.values(parameters),
-  })
-
-  const output = await client.send(command)
-
-  /*
-   * Map returned parameters to result object
-   */
-
-  const result: Record<string, string> = {}
-  output.Parameters?.forEach((outputParam) => {
-    assert(
-      typeof outputParam.Value === "string",
-      `Received invalid value of SSM parameter ${outputParam.Name}`
-    )
-    const entry = Object.entries(parameters).find(
-      ([_key, value]) => value === outputParam.Name
-    )
-    assert(entry, `Received invalid SSM parameter ${outputParam.Name}`)
-    const [key] = entry
-    result[key] = outputParam.Value
-  })
-
-  /*
-   * Check that all parameters were received
-   */
-
-  const notFoundParams = Object.keys(parameters).filter(
-    (key) => false === Object.hasOwn(result, key)
-  )
-
-  if (notFoundParams.length > 0) {
-    throw new Error(
-      `Cannot obtain SSM parameters: ${notFoundParams.join(", ")}`
-    )
-  }
-
-  return result as T
-}

package/test/appconfig.test.ts

@@ -1,45 +0,0 @@
-import { GetApplicationCommand } from "@aws-sdk/client-appconfig"
-import { getApplication, appConfigClient } from "../src/appconfig"
-
-jest.mock("@aws-sdk/client-appconfig", () => {
-  return {
-    AppConfigClient: jest.fn().mockImplementation(() => {
-      return { send: jest.fn() }
-    }),
-    GetApplicationCommand: jest.fn(),
-  }
-})
-
-describe("AppConfig", () => {
-  let getApplicationCommandMock: jest.Mock
-
-  beforeEach(() => {
-    getApplicationCommandMock = GetApplicationCommand as unknown as jest.Mock
-  })
-
-  afterEach(() => {
-    jest.clearAllMocks()
-  })
-
-  it("should call AppConfig.getApplication with correct parameters", async () => {
-    const applicationId = "test-app"
-
-    await getApplication(applicationId)
-
-    expect(appConfigClient.send).toHaveBeenCalledWith(
-      expect.any(getApplicationCommandMock)
-    )
-    expect(getApplicationCommandMock).toHaveBeenCalledWith({
-      ApplicationId: applicationId,
-    })
-  })
-
-  it("should throw an error if getting application from AppConfig fails", async () => {
-    const applicationId = "test-app"
-    const error = new Error("Get application failed")
-
-    ;(appConfigClient.send as jest.Mock).mockRejectedValueOnce(error)
-
-    await expect(getApplication(applicationId)).rejects.toThrow(error)
-  })
-})

package/test/dynamodb.test.ts

@@ -1,13 +0,0 @@
-import { client, documentClient } from "../src/dynamodb"
-import { DynamoDBClient } from "@aws-sdk/client-dynamodb"
-import { DynamoDBDocumentClient } from "@aws-sdk/lib-dynamodb"
-
-describe("dynamodb", () => {
-  it("should be instance of DynamoDBClient", () => {
-    expect(client).toBeInstanceOf(DynamoDBClient)
-  })
-
-  it("should be instance of DynamoDBDocumentClient", () => {
-    expect(documentClient).toBeInstanceOf(DynamoDBDocumentClient)
-  })
-})

package/test/eventbridge.test.ts

@@ -1,35 +0,0 @@
-import { mockClient } from "aws-sdk-client-mock"
-import { PutEventsCommand } from "@aws-sdk/client-eventbridge"
-import { client, sendEvent } from "../src/eventbridge"
-
-const eventBridgeMock = mockClient(client)
-
-describe("eventbridge", () => {
-  describe("sendEvent", () => {
-    test("should send event to event bus", async () => {
-      eventBridgeMock.on(PutEventsCommand).resolves({})
-
-      const params = {
-        source: "source",
-        eventBusName: "event-bus-name",
-        eventType: "event-type",
-        event: { foo: "bar" },
-      }
-
-      await expect(sendEvent(params)).resolves.toBe(undefined)
-    })
-
-    test("should fail", async () => {
-      eventBridgeMock.on(PutEventsCommand).rejects(new Error("fail"))
-
-      const params = {
-        source: "source",
-        eventBusName: "event-bus-name",
-        eventType: "event-type",
-        event: { foo: "bar" },
-      }
-
-      await expect(sendEvent(params)).rejects.toThrowError("fail")
-    })
-  })
-})