@mbc-cqrs-serverless/cli 0.1.4-beta.0

package/templates/package.json

@@ -0,0 +1,118 @@
+{
+  "name": "cqrs-sls",
+  "version": "0.0.1",
+  "description": "",
+  "author": "",
+  "private": true,
+  "license": "UNLICENSED",
+  "main": "./dist/main.js",
+  "scripts": {
+    "postinstall": "prisma generate",
+    "build": "nest build --watch",
+    "build:prod": "nest build",
+    "format": "prettier --write \"src/**/*.ts\" \"test/**/*.ts\"",
+    "start:repl": "nest start --watch --entryFile repl",
+    "offline:docker:build": "cd infra-local && docker compose up --build --remove-orphans",
+    "offline:docker": "cd infra-local && mkdir -p docker-data/.cognito && cp -r cognito-local/db docker-data/.cognito && docker compose up --remove-orphans",
+    "offline:sls": "/bin/bash ./infra-local/scripts/trigger_ddb_stream.sh & ln -f .env $PWD/infra-local/.env && cd infra-local && NODE_ENV=development AWS_ACCESS_KEY_ID=DUMMYIDEXAMPLE AWS_SECRET_ACCESS_KEY=DUMMYEXAMPLEKEY SLS_DEBUG=* serverless offline start",
+    "lint": "eslint \"{src,apps,libs,test}/**/*.ts\" --fix",
+    "test": "jest",
+    "test:watch": "jest --watch",
+    "test:cov": "jest --coverage",
+    "test:debug": "node --inspect-brk -r tsconfig-paths/register -r ts-node/register node_modules/.bin/jest --runInBand",
+    "test:e2e": "jest --config ./test/jest-e2e.json",
+    "migrate:dev": "prisma migrate dev",
+    "migrate:rds": "prisma migrate deploy",
+    "migrate:ddb": "ts-node prisma/ddb.ts",
+    "migrate": "npm run migrate:rds && npm run migrate:ddb"
+  },
+  "dependencies": {
+    "@mbc-cqrs-sererless/core": "",
+    "@prisma/client": "^5.7.1"
+  },
+  "devDependencies": {
+    "@aws-sdk/client-dynamodb": "^3.478.0",
+    "@aws-sdk/client-s3": "^3.478.0",
+    "@aws-sdk/client-sesv2": "^3.478.0",
+    "@aws-sdk/client-sfn": "^3.478.0",
+    "@aws-sdk/client-sns": "^3.478.0",
+    "@aws-sdk/client-sqs": "^3.478.0",
+    "@aws-sdk/credential-provider-node": "^3.451.0",
+    "@aws-sdk/lib-storage": "^3.478.0",
+    "@aws-sdk/s3-request-presigner": "^3.478.0",
+    "@aws-sdk/signature-v4": "^3.374.0",
+    "@aws-sdk/util-create-request": "^3.468.0",
+    "@aws-sdk/util-dynamodb": "^3.360.0",
+    "@mbc-cqrs-sererless/cli": "",
+    "@nestjs/cli": "^10.2.1",
+    "@nestjs/common": "^10.3.0",
+    "@nestjs/core": "^10.3.0",
+    "@nestjs/schematics": "^10.0.3",
+    "@nestjs/swagger": "^7.1.17",
+    "@nestjs/testing": "^10.3.0",
+    "@types/aws-lambda": "^8.10.130",
+    "@types/express": "^4.17.21",
+    "@types/jest": "^29.5.11",
+    "@types/node": "^20.10.5",
+    "@types/node-fetch": "^2.6.9",
+    "@types/supertest": "^6.0.1",
+    "@typescript-eslint/eslint-plugin": "^6.15.0",
+    "@typescript-eslint/parser": "^6.15.0",
+    "class-transformer": "^0.5.1",
+    "class-validator": "^0.14.0",
+    "eslint": "^8.56.0",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-plugin-import": "^2.29.1",
+    "eslint-plugin-prettier": "^5.1.2",
+    "eslint-plugin-simple-import-sort": "^10.0.0",
+    "jest": "^29.7.0",
+    "nestjs-spelunker": "^1.3.0",
+    "prettier": "^3.1.1",
+    "prisma": "^5.7.1",
+    "serverless": "^3.38.0",
+    "serverless-dynamodb": "^0.2.47",
+    "serverless-localstack": "^1.1.2",
+    "serverless-offline": "^13.3.2",
+    "serverless-offline-aws-eventbridge": "^2.1.0",
+    "serverless-offline-dynamodb-streams": "^7.0.0",
+    "serverless-offline-lambda": "^1.0.6",
+    "serverless-offline-local-authorizers-plugin": "^1.2.0",
+    "serverless-offline-scheduler": "^0.5.0",
+    "serverless-offline-ses-v2": "^1.0.4",
+    "serverless-offline-sns": "^0.77.2",
+    "serverless-offline-sqs": "^8.0.0",
+    "serverless-offline-ssm": "^6.2.0",
+    "serverless-offline-watcher": "^1.1.0",
+    "serverless-plugin-offline-dynamodb-stream": "^1.0.20",
+    "serverless-s3-local": "^0.8.1",
+    "serverless-step-functions": "^3.18.0",
+    "serverless-step-functions-local": "^0.5.1",
+    "source-map-support": "^0.5.21",
+    "supertest": "^6.3.3",
+    "terser-webpack-plugin": "^5.3.9",
+    "ts-jest": "^29.1.1",
+    "ts-loader": "^9.5.1",
+    "ts-node": "^10.9.2",
+    "tsconfig-paths": "4.2.0",
+    "typescript": "^5.3.3",
+    "ulid": "^2.3.0",
+    "webpack": "^5.88.2"
+  },
+  "jest": {
+    "moduleFileExtensions": [
+      "js",
+      "json",
+      "ts"
+    ],
+    "rootDir": "src",
+    "testRegex": ".*\\.spec\\.ts$",
+    "transform": {
+      "^.+\\.(t|j)s$": "ts-jest"
+    },
+    "collectCoverageFrom": [
+      "**/*.(t|j)s"
+    ],
+    "coverageDirectory": "../coverage",
+    "testEnvironment": "node"
+  }
+}

package/templates/prisma/ddb.ts

@@ -0,0 +1,232 @@
+import {
+  CreateTableCommand,
+  CreateTableCommandInput,
+  DescribeContinuousBackupsCommand,
+  DescribeTableCommand,
+  DescribeTimeToLiveCommand,
+  DynamoDBClient,
+  ResourceNotFoundException,
+  UpdateContinuousBackupsCommand,
+  UpdateTimeToLiveCommand,
+} from '@aws-sdk/client-dynamodb'
+import dotenv from 'dotenv'
+import { appendFileSync, readFileSync, readdirSync, writeFileSync } from 'fs'
+import path from 'path'
+
+dotenv.config()
+
+const envFilePath = './.env'
+const tableDir = path.join(__dirname, 'dynamodbs')
+const cqrsModuleFname = 'cqrs.json'
+const cqrsTableDecsFname = 'cqrs_desc.json'
+
+const tablePrefix = `${process.env.NODE_ENV}-${process.env.APP_NAME}-`
+
+const client = new DynamoDBClient({
+  endpoint: process.env.DYNAMODB_ENDPOINT,
+  region: process.env.DYNAMODB_REGION,
+})
+
+main().catch((e) => {
+  console.error(e)
+  process.exit(1)
+})
+
+let cnt = 0
+
+async function main() {
+  // clear table stream arn in .env
+  clearTableStreamArnInEnv()
+  // create cqrs tables
+  await createCqrsTables()
+  // create other tables
+  await Promise.all(
+    readdirSync(tableDir)
+      .filter(
+        (fname) => fname !== cqrsModuleFname && fname !== cqrsTableDecsFname,
+      )
+      .map((fname) =>
+        createTable(
+          JSON.parse(readFileSync(path.join(tableDir, fname)).toString()),
+        ),
+      ),
+  )
+  if (cnt) {
+    console.log('\n' + cnt + ' tables were created successfully')
+  } else {
+    console.log('\nNo tables were created')
+  }
+}
+
+async function createCqrsTables() {
+  const cqrsModules: string[] =
+    JSON.parse(readFileSync(path.join(tableDir, cqrsModuleFname)).toString()) ||
+    []
+  const desc: CreateTableCommandInput = JSON.parse(
+    readFileSync(path.join(tableDir, cqrsTableDecsFname)).toString(),
+  )
+
+  for (const name of cqrsModules) {
+    const cmdDesc = { ...desc, TableName: name + '-command' }
+    const dataDecs = {
+      ...cmdDesc,
+      StreamSpecification: undefined,
+      TableName: name + '-data',
+    }
+    const historyDesc = { ...dataDecs, TableName: name + '-history' }
+    await Promise.all([cmdDesc, dataDecs, historyDesc].map(createTable))
+  }
+}
+
+async function createTable(config: CreateTableCommandInput) {
+  // random wait
+  if (process.env.NODE_ENV !== 'local') {
+    await new Promise((r) =>
+      setTimeout(r, 200 + Math.floor(Math.random() * 5000)),
+    )
+  }
+
+  const originName = config.TableName as string
+  console.log('\ncreating table:', originName)
+
+  // add table prefix
+  config.TableName = tablePrefix + config.TableName
+
+  // check table is already created
+  try {
+    const tableDesc = await client.send(
+      new DescribeTableCommand({ TableName: config.TableName }),
+    )
+    if (tableDesc.Table?.TableArn) {
+      console.log(
+        'table exists:',
+        tableDesc.Table.TableArn,
+        ' => stream:',
+        tableDesc.Table.LatestStreamArn,
+      )
+
+      await updateTable(config.TableName)
+
+      if (tableDesc.Table.LatestStreamArn) {
+        appendTableStreamArnToEnv(originName, tableDesc.Table.LatestStreamArn)
+      }
+
+      return tableDesc.Table.TableArn
+    }
+  } catch (error) {
+    if (!(error instanceof ResourceNotFoundException)) {
+      throw error
+    }
+  }
+
+  // create table
+  const table = await client.send(new CreateTableCommand(config))
+  if (table.TableDescription?.TableArn) {
+    console.log(
+      'table created with arn: `',
+      table.TableDescription?.TableArn,
+      '`, and stream arn:`',
+      table.TableDescription?.LatestStreamArn,
+      '`',
+    )
+    cnt++
+
+    if (table.TableDescription?.LatestStreamArn) {
+      appendTableStreamArnToEnv(
+        originName,
+        table.TableDescription?.LatestStreamArn,
+      )
+    }
+  }
+  return table.TableDescription?.TableArn
+}
+
+async function updateTable(TableName: string) {
+  try {
+    // Time to live
+    const ttlDesc = await client.send(
+      new DescribeTimeToLiveCommand({ TableName }),
+    )
+    if (ttlDesc.TimeToLiveDescription?.TimeToLiveStatus === 'DISABLED') {
+      console.log('enable time to live for table:', TableName)
+
+      await client.send(
+        new UpdateTimeToLiveCommand({
+          TableName,
+          TimeToLiveSpecification: {
+            Enabled: true,
+            AttributeName: 'ttl',
+          },
+        }),
+      )
+
+      // random wait
+      if (process.env.NODE_ENV !== 'local') {
+        await new Promise((r) =>
+          setTimeout(r, Math.floor(Math.random() * 5000)),
+        )
+      }
+    }
+
+    // Point-in-time recovery for production
+    if (process.env.NODE_ENV !== 'local') {
+      const pitDesc = await client.send(
+        new DescribeContinuousBackupsCommand({ TableName }),
+      )
+      if (
+        pitDesc.ContinuousBackupsDescription?.PointInTimeRecoveryDescription
+          ?.PointInTimeRecoveryStatus === 'DISABLED'
+      ) {
+        console.log('enable point-in-time recovery for table:', TableName)
+
+        await client.send(
+          new UpdateContinuousBackupsCommand({
+            TableName,
+            PointInTimeRecoverySpecification: {
+              PointInTimeRecoveryEnabled: true,
+            },
+          }),
+        )
+
+        // random wait
+        if (process.env.NODE_ENV !== 'local') {
+          await new Promise((r) =>
+            setTimeout(r, Math.floor(Math.random() * 5000)),
+          )
+        }
+      }
+    }
+  } catch (error) {
+    console.error(error)
+  }
+}
+
+function appendTableStreamArnToEnv(name: string, streamArn: string) {
+  if (process.env.NODE_ENV !== 'local') {
+    return
+  }
+
+  try {
+    appendFileSync(
+      envFilePath,
+      `\nLOCAL_DDB_${name
+        .replace('-command', '')
+        .toUpperCase()}_STREAM=${streamArn}`,
+    )
+  } catch (error) {
+    console.error('Write to .env error!', error)
+  }
+}
+
+function clearTableStreamArnInEnv() {
+  if (process.env.NODE_ENV !== 'local') {
+    return
+  }
+
+  console.log('Clear table stream arn in .env')
+  const lines = readFileSync(envFilePath, 'utf-8').split('\n')
+  const newLines = lines.filter(
+    (line) => !line.match(/^LOCAL_DDB_.*_STREAM.*$/),
+  )
+  writeFileSync(envFilePath, newLines.join('\n'))
+}

package/templates/prisma/dynamodbs/cqrs.json

@@ -0,0 +1 @@
+["master"]

package/templates/prisma/dynamodbs/cqrs_desc.json

@@ -0,0 +1,18 @@
+{
+  "TableName": "",
+  "AttributeDefinitions": [
+    { "AttributeName": "pk", "AttributeType": "S" },
+    { "AttributeName": "sk", "AttributeType": "S" }
+  ],
+  "KeySchema": [
+    { "AttributeName": "pk", "KeyType": "HASH" },
+    { "AttributeName": "sk", "KeyType": "RANGE" }
+  ],
+  "BillingMode": "PAY_PER_REQUEST",
+  "StreamSpecification": {
+    "StreamEnabled": true,
+    "StreamViewType": "NEW_IMAGE"
+  },
+  "TableClass": "STANDARD",
+  "DeletionProtectionEnabled": true
+}

package/templates/prisma/dynamodbs/sequences.json

@@ -0,0 +1,14 @@
+{
+  "TableName": "sequences",
+  "AttributeDefinitions": [
+    { "AttributeName": "pk", "AttributeType": "S" },
+    { "AttributeName": "sk", "AttributeType": "S" }
+  ],
+  "KeySchema": [
+    { "AttributeName": "pk", "KeyType": "HASH" },
+    { "AttributeName": "sk", "KeyType": "RANGE" }
+  ],
+  "BillingMode": "PAY_PER_REQUEST",
+  "TableClass": "STANDARD",
+  "DeletionProtectionEnabled": true
+}

package/templates/prisma/dynamodbs/tasks.json

@@ -0,0 +1,18 @@
+{
+  "TableName": "tasks",
+  "AttributeDefinitions": [
+    { "AttributeName": "pk", "AttributeType": "S" },
+    { "AttributeName": "sk", "AttributeType": "S" }
+  ],
+  "KeySchema": [
+    { "AttributeName": "pk", "KeyType": "HASH" },
+    { "AttributeName": "sk", "KeyType": "RANGE" }
+  ],
+  "BillingMode": "PAY_PER_REQUEST",
+  "StreamSpecification": {
+    "StreamEnabled": true,
+    "StreamViewType": "NEW_IMAGE"
+  },
+  "TableClass": "STANDARD",
+  "DeletionProtectionEnabled": true
+}

package/templates/prisma/schema.prisma

@@ -0,0 +1,45 @@
+// This is your Prisma schema file,
+// learn more about it in the docs: https://pris.ly/d/prisma-schema
+
+generator client {
+  provider      = "prisma-client-js"
+  binaryTargets = ["native", "linux-arm64-openssl-1.0.x"]
+  // binaryTargets = ["native", "rhel-openssl-1.0.x"]
+}
+
+datasource db {
+  provider     = "mysql"
+  url          = env("DATABASE_URL")
+  relationMode = "prisma"
+}
+
+model Master {
+  id             String   @id
+  cpk            String // コマンド用PK
+  csk            String // コマンド用SK
+  pk             String // データ用PK, MASTER#unigrab (テナントコード)
+  sk             String // データ用SK, マスタ種別コード#マスタコード
+  masterTypeCode String   @map("master_type_code") // マスタ種別コード, 【共通マスタ】 or 【テナント固有マスタ】
+  masterCode     String   @map("master_code") // マスタコード
+  tenantCode     String   @map("tenant_code") // テナントコード, 【テナントコードマスタ】
+  seq            Int      @default(0) // 並び順, 採番機能を使用する
+  code           String // レコードのコード, マスタ種別コード#マスタコード
+  name           String // レコード名, 名前
+  version        Int // バージョン
+  isDeleted      Boolean  @default(false) @map("is_deleted") // 削除フラグ
+  createdBy      String   @default("") @map("created_by") // 作成者
+  createdIp      String   @default("") @map("created_ip") // 作成IP, IPv6も考慮する
+  createdAt      DateTime @default(now()) @map("created_at") @db.Timestamp(0) // 作成日時
+  updatedBy      String   @default("") @map("updated_by") // 更新者
+  updatedIp      String   @default("") @map("updated_ip") // 更新IP, IPv6も考慮する
+  updatedAt      DateTime @updatedAt @map("updated_at") @db.Timestamp(0) // 更新日時
+
+  atttributesMaster Json? @map("atttributes_master")
+
+  @@unique([cpk, csk])
+  @@unique([pk, sk])
+  @@unique([tenantCode, code])
+  @@unique([tenantCode, masterTypeCode, masterCode])
+  @@index([tenantCode, name])
+  @@map("masters")
+}

package/templates/src/event-factory.ts

@@ -0,0 +1,7 @@
+import { DefaultEventFactory, EventFactory } from '@mbc-cqrs-sererless/core'
+import { Logger } from '@nestjs/common'
+
+@EventFactory()
+export class CustomEventFactory extends DefaultEventFactory {
+  private readonly logger = new Logger(CustomEventFactory.name)
+}

package/templates/src/helpers/get-order.ts

@@ -0,0 +1,19 @@
+import { Prisma } from '@prisma/client'
+
+export function getOrderBy(order: string) {
+  let orderValue: Prisma.SortOrder = Prisma.SortOrder.asc,
+    orderKey = order
+  if (order.startsWith('-')) {
+    orderValue = Prisma.SortOrder.desc
+    orderKey = order.slice(1)
+  }
+
+  return { [orderKey]: orderValue }
+}
+
+export function getOrderBys<T>(orders: string[]): T[] {
+  if (!orders) {
+    return undefined
+  }
+  return orders.map((order) => getOrderBy(order)) as T[]
+}

package/templates/src/helpers/index.ts

@@ -0,0 +1 @@
+export * from './get-order'

package/templates/src/main.module.ts

@@ -0,0 +1,26 @@
+import { Module } from '@nestjs/common'
+
+import { CustomEventFactory } from './event-factory'
+import { MasterModule } from './master/master.module'
+import { prismaLoggingMiddleware, PrismaModule } from './prisma'
+
+@Module({
+  imports: [
+    PrismaModule.forRoot({
+      isGlobal: true,
+      prismaServiceOptions: {
+        middlewares: [prismaLoggingMiddleware()],
+        prismaOptions: {
+          log:
+            process.env.NODE_ENV !== 'local'
+              ? ['error']
+              : ['info', 'error', 'warn', 'query'],
+        },
+        explicitConnect: false,
+      },
+    }),
+    MasterModule,
+  ],
+  providers: [CustomEventFactory],
+})
+export class MainModule {}

package/templates/src/main.ts

@@ -0,0 +1,7 @@
+import { createHandler } from '@mbc-cqrs-sererless/core'
+
+import { MainModule } from './main.module'
+
+export const handler = createHandler({
+  rootModule: MainModule,
+})

package/templates/src/master/dto/master-attributes.dto.ts

@@ -0,0 +1,6 @@
+import { IsObject } from 'class-validator'
+
+export class MasterAttributes {
+  @IsObject()
+  master: object
+}

package/templates/src/master/dto/master-command.dto.ts

@@ -0,0 +1,12 @@
+import { CommandDto } from '@mbc-cqrs-sererless/core'
+import { Type } from 'class-transformer'
+import { IsOptional, ValidateNested } from 'class-validator'
+
+import { MasterAttributes } from './master-attributes.dto'
+
+export class MasterCommandDto extends CommandDto {
+  @Type(() => MasterAttributes)
+  @ValidateNested()
+  @IsOptional()
+  attributes: MasterAttributes
+}

package/templates/src/master/entity/master-command.entity.ts

@@ -0,0 +1,13 @@
+import { CommandEntity } from '@mbc-cqrs-sererless/core'
+
+import { MasterAttributes } from '../dto/master-attributes.dto'
+
+export class MasterCommandEntity extends CommandEntity {
+  attributes: MasterAttributes
+
+  constructor(partial: Partial<MasterCommandEntity>) {
+    super()
+
+    Object.assign(this, partial)
+  }
+}

package/templates/src/master/entity/master-data-list.entity.ts

@@ -0,0 +1,13 @@
+import { DataListEntity } from '@mbc-cqrs-sererless/core'
+
+import { MasterDataEntity } from './master-data.entity'
+
+export class MasterDataListEntity extends DataListEntity {
+  items: MasterDataEntity[]
+
+  constructor(partial: Partial<MasterDataListEntity>) {
+    super(partial)
+
+    Object.assign(this, partial)
+  }
+}

package/templates/src/master/entity/master-data.entity.ts

@@ -0,0 +1,13 @@
+import { DataEntity } from '@mbc-cqrs-sererless/core'
+
+import { MasterAttributes } from '../dto/master-attributes.dto'
+
+export class MasterDataEntity extends DataEntity {
+  attributes: MasterAttributes
+
+  constructor(partial: Partial<MasterDataEntity>) {
+    super(partial)
+
+    Object.assign(this, partial)
+  }
+}

package/templates/src/master/handler/master-rds.handler.ts

@@ -0,0 +1,59 @@
+import {
+  CommandModel,
+  IDataSyncHandler,
+  removeSortKeyVersion,
+} from '@mbc-cqrs-sererless/core'
+import { Injectable, Logger } from '@nestjs/common'
+import { PrismaService } from 'src/prisma'
+
+@Injectable()
+export class MasterDataSyncRdsHandler implements IDataSyncHandler {
+  private readonly logger = new Logger(MasterDataSyncRdsHandler.name)
+
+  constructor(private readonly prismaService: PrismaService) {}
+
+  async up(cmd: CommandModel): Promise<any> {
+    this.logger.debug(cmd)
+    const sk = removeSortKeyVersion(cmd.sk)
+    await this.prismaService.master.upsert({
+      where: {
+        id: cmd.id,
+      },
+      update: {
+        csk: cmd.sk,
+        name: cmd.name,
+        version: cmd.version,
+        seq: cmd.seq,
+        atttributesMaster: cmd.attributes?.master,
+        isDeleted: cmd.isDeleted || false,
+        updatedAt: cmd.updatedAt,
+        updatedBy: cmd.updatedBy,
+        updatedIp: cmd.updatedIp,
+      },
+      create: {
+        id: cmd.id,
+        cpk: cmd.pk,
+        csk: cmd.sk,
+        pk: cmd.pk,
+        sk,
+        masterTypeCode: sk.substring(0, sk.indexOf('#')),
+        masterCode: sk.substring(sk.indexOf('#') + 1),
+        code: sk,
+        name: cmd.name,
+        version: cmd.version,
+        tenantCode: cmd.tenantCode,
+        seq: cmd.seq,
+        atttributesMaster: cmd.attributes?.master,
+        createdAt: cmd.createdAt,
+        createdBy: cmd.createdBy,
+        createdIp: cmd.createdIp,
+        updatedAt: cmd.updatedAt,
+        updatedBy: cmd.updatedBy,
+        updatedIp: cmd.updatedIp,
+      },
+    })
+  }
+  async down(cmd: CommandModel): Promise<any> {
+    this.logger.debug(cmd)
+  }
+}