finish

.dockerignore

+# compiled output
+/dist
+/node_modules
+
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+
+# OS
+.DS_Store
+
+# Tests
+/coverage
+/.nyc_output
+
+# IDEs and editors
+/.idea
+.project
+.classpath
+.c9/
+*.launch
+.settings/
+*.sublime-workspace
+
+# IDE - VSCode
+.vscode/*
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json
+
+/data
+/output
+/config.yaml
+
+.git*
+Dockerfile
+.dockerignore

.eslintrc.js

+module.exports = {
+  parser: '@typescript-eslint/parser',
+  parserOptions: {
+    project: 'tsconfig.json',
+    sourceType: 'module',
+  },
+  plugins: ['@typescript-eslint/eslint-plugin'],
+  extends: [
+    'plugin:@typescript-eslint/recommended',
+    'plugin:prettier/recommended',
+  ],
+  root: true,
+  env: {
+    node: true,
+    jest: true,
+  },
+  ignorePatterns: ['.eslintrc.js'],
+  rules: {
+    '@typescript-eslint/interface-name-prefix': 'off',
+    '@typescript-eslint/explicit-function-return-type': 'off',
+    '@typescript-eslint/explicit-module-boundary-types': 'off',
+    '@typescript-eslint/no-explicit-any': 'off',
+  },
+};

.gitignore

+# compiled output
+/dist
+/node_modules
+
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+
+# OS
+.DS_Store
+
+# Tests
+/coverage
+/.nyc_output
+
+# IDEs and editors
+/.idea
+.project
+.classpath
+.c9/
+*.launch
+.settings/
+*.sublime-workspace
+
+# IDE - VSCode
+.vscode/*
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json
+
+/data
+/output
+/config.yaml
\ No newline at end of file

.gitlab-ci.yml

+stages:
+  - build
+  - combine
+  - deploy
+variables:
+  GIT_DEPTH: "1"
+  CONTAINER_TEST_IMAGE: $CI_REGISTRY_IMAGE:$CI_COMMIT_REF_SLUG
+  CONTAINER_TEST_ARM_IMAGE: $CI_REGISTRY_IMAGE:$CI_COMMIT_REF_SLUG-arm
+  CONTAINER_TEST_X86_IMAGE: $CI_REGISTRY_IMAGE:$CI_COMMIT_REF_SLUG-x86
+  CONTAINER_RELEASE_IMAGE: $CI_REGISTRY_IMAGE:latest
+before_script:
+  - docker login -u $CI_REGISTRY_USER -p $CI_REGISTRY_PASSWORD $CI_REGISTRY
+build-x86:
+  stage: build
+  tags:
+    - docker
+  script:
+    - TARGET_IMAGE=$CONTAINER_TEST_X86_IMAGE
+    - docker build --pull -t $TARGET_IMAGE .
+    - docker push $TARGET_IMAGE
+build-arm:
+  stage: build
+  tags:
+    - docker-arm
+  script:
+    - TARGET_IMAGE=$CONTAINER_TEST_ARM_IMAGE
+    - docker build --pull -t $TARGET_IMAGE .
+    - docker push $TARGET_IMAGE
+combine:
+  stage: combine
+  tags:
+    - docker
+  script:
+    - TARGET_IMAGE=$CONTAINER_TEST_IMAGE
+    - SOURCE_IMAGE_2=$CONTAINER_TEST_ARM_IMAGE
+    - SOURCE_IMAGE_1=$CONTAINER_TEST_X86_IMAGE
+    - docker pull $SOURCE_IMAGE_1
+    - docker pull $SOURCE_IMAGE_2
+    - docker manifest create $TARGET_IMAGE --amend $SOURCE_IMAGE_1 --amend
+      $SOURCE_IMAGE_2
+    - docker manifest push $TARGET_IMAGE
+deploy_latest:
+  stage: deploy
+  tags:
+    - docker
+  script:
+    - TARGET_IMAGE=$CONTAINER_RELEASE_IMAGE
+    - SOURCE_IMAGE=$CONTAINER_TEST_IMAGE
+    - docker pull $SOURCE_IMAGE
+    - docker tag $SOURCE_IMAGE $TARGET_IMAGE
+    - docker push $TARGET_IMAGE
+  only:
+    - master
+deploy_tag:
+  stage: deploy
+  tags:
+    - docker
+  script:
+    - TARGET_IMAGE=$CI_REGISTRY_IMAGE:$CI_COMMIT_TAG
+    - SOURCE_IMAGE=$CONTAINER_TEST_IMAGE
+    - docker pull $SOURCE_IMAGE
+    - docker tag $SOURCE_IMAGE $TARGET_IMAGE
+    - docker push $TARGET_IMAGE
+  only:
+    - tags

.npmignore

+/install-npm.sh
+.git*
+/data
+/output
+/config.yaml
+.idea
+.dockerignore
+Dockerfile
\ No newline at end of file

.prettierrc

+{
+  "singleQuote": true,
+  "trailingComma": "all"
+}
\ No newline at end of file

Dockerfile

+FROM node:bullseye-slim
+LABEL Author="Nanahira <nanahira@momobako.com>"
+
+RUN apt update && apt -y install python3 build-essential && rm -rf /var/lib/apt/lists/* /tmp/* /var/tmp/*
+WORKDIR /usr/src/app
+COPY ./package*.json ./
+RUN npm ci
+COPY . ./
+RUN npm run build
+
+CMD ["npm", "run", "start:prod"]

README.md

+# App name
+
+App description.
+
+## Installation
+
+```bash
+$ npm install
+```
+
+## Config
+
+Make a copy of `config.example.yaml` to `config.yaml`.
+
+## Running the app
+
+```bash
+# development
+$ npm run start
+
+# watch mode
+$ npm run start:dev
+
+# production mode
+$ npm run start:prod
+```
+
+## License
+
+AGPLv3

config.example.yaml

+host: '::'
+port: 3000
+rootPath: './data'
+workspaces:
+  default:
+    title: 'default'
+    encoding: 'utf8'
+    default: true
\ No newline at end of file

install-npm.sh

+#!/bin/bash
+npm install --save \
+	class-validator \
+	class-transformer \
+	@nestjs/swagger \
+	@nestjs/config \
+	swagger-ui-express \
+	yaml
+
+npm install --save-dev \
+	@types/express

nest-cli.json

+{
+  "collection": "@nestjs/schematics",
+  "sourceRoot": "src",
+  "compilerOptions": {
+    "plugins": ["@nestjs/swagger"]
+  }
+}

package.json

+{
+  "name": "ygopro-ad-tips",
+  "version": "0.0.1",
+  "description": "",
+  "author": "",
+  "private": true,
+  "license": "UNLICENSED",
+  "scripts": {
+    "prebuild": "rimraf dist",
+    "build": "nest build",
+    "format": "prettier --write \"src/**/*.ts\" \"test/**/*.ts\"",
+    "start": "nest start",
+    "start:dev": "nest start --watch",
+    "start:debug": "nest start --debug --watch",
+    "start:prod": "node dist/main",
+    "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"
+  },
+  "dependencies": {
+    "@nestjs/common": "^8.0.0",
+    "@nestjs/config": "^1.0.3",
+    "@nestjs/core": "^8.0.0",
+    "@nestjs/platform-express": "^8.0.0",
+    "@nestjs/swagger": "^5.1.4",
+    "class-transformer": "^0.4.0",
+    "class-validator": "^0.13.1",
+    "csv-parse": "^4.16.3",
+    "iconv-lite": "^0.6.3",
+    "lodash": "^4.17.21",
+    "reflect-metadata": "^0.1.13",
+    "rimraf": "^3.0.2",
+    "rxjs": "^7.2.0",
+    "swagger-ui-express": "^4.1.6",
+    "yaml": "^1.10.2"
+  },
+  "devDependencies": {
+    "@nestjs/cli": "^8.0.0",
+    "@nestjs/schematics": "^8.0.0",
+    "@nestjs/testing": "^8.0.0",
+    "@types/express": "^4.17.13",
+    "@types/jest": "^27.0.1",
+    "@types/lodash": "^4.14.176",
+    "@types/node": "^16.0.0",
+    "@types/supertest": "^2.0.11",
+    "@typescript-eslint/eslint-plugin": "^4.28.2",
+    "@typescript-eslint/parser": "^4.28.2",
+    "eslint": "^7.30.0",
+    "eslint-config-prettier": "^8.3.0",
+    "eslint-plugin-prettier": "^3.4.0",
+    "jest": "^27.0.6",
+    "prettier": "^2.3.2",
+    "supertest": "^6.1.3",
+    "ts-jest": "^27.0.3",
+    "ts-loader": "^9.2.3",
+    "ts-node": "^10.0.0",
+    "tsconfig-paths": "^3.10.1",
+    "typescript": "^4.3.5"
+  },
+  "jest": {
+    "moduleFileExtensions": [
+      "js",
+      "json",
+      "ts"
+    ],
+    "rootDir": "src",
+    "testRegex": ".*\\.spec\\.ts$",
+    "transform": {
+      "^.+\\.(t|j)s$": "ts-jest"
+    },
+    "collectCoverageFrom": [
+      "**/*.(t|j)s"
+    ],
+    "coverageDirectory": "../coverage",
+    "testEnvironment": "node"
+  }
+}

src/app.controller.spec.ts

+import { Test, TestingModule } from '@nestjs/testing';
+import { AppController } from './app.controller';
+import { AppService } from './app.service';
+
+describe('AppController', () => {
+  let appController: AppController;
+
+  beforeEach(async () => {
+    const app: TestingModule = await Test.createTestingModule({
+      controllers: [AppController],
+      providers: [AppService],
+    }).compile();
+
+    appController = app.get<AppController>(AppController);
+  });
+
+  describe('root', () => {
+    it('should be defined', () => {
+      expect(appController).toBeDefined();
+    });
+  });
+});

src/app.controller.ts

+import { Controller, Get, Param } from '@nestjs/common';
+import { AppService } from './app.service';
+import { ApiOkResponse, ApiOperation, ApiParam } from '@nestjs/swagger';
+
+@Controller()
+export class AppController {
+  constructor(private readonly appService: AppService) {}
+
+  @Get('ad/:name.json')
+  @ApiOperation({ summary: '获取指定表的广告' })
+  @ApiParam({ name: 'name' })
+  @ApiOkResponse({ type: [String] })
+  getAd(@Param('name') name: string) {
+    return this.appService.getAdArray(null, name);
+  }
+
+  @Get('workspace/:workspaceName/ad/:name.json')
+  @ApiOperation({ summary: '获取指定表的广告' })
+  @ApiParam({ name: 'name' })
+  @ApiParam({ name: 'workspaceName' })
+  @ApiOkResponse({ type: [String] })
+  getSpecificAd(
+    @Param('workspaceName') workspaceName: string,
+    @Param('name') name: string,
+  ) {
+    return this.appService.getAdArray('workspaceName', name);
+  }
+}

src/app.module.ts

+import { Module } from '@nestjs/common';
+import { AppController } from './app.controller';
+import { AppService } from './app.service';
+import { ConfigModule } from '@nestjs/config';
+import { loadConfig } from './utility/config';
+import { CsvParseService } from './csv-parse/csv-parse.service';
+import { WorkspaceService } from './workspace/workspace.service';
+
+@Module({
+  imports: [
+    ConfigModule.forRoot({
+      ignoreEnvVars: true,
+      load: [loadConfig],
+    }),
+  ],
+  controllers: [AppController],
+  providers: [AppService, CsvParseService, WorkspaceService],
+})
+export class AppModule {}

src/app.service.ts

+import { Injectable, ConsoleLogger } from '@nestjs/common';
+import { ConfigService } from '@nestjs/config';
+import path from 'path';
+import { Workspace } from './utility/config';
+import * as fs from 'fs';
+import { BlankReturnMessageDto } from './dto/ReturnMessage.dto';
+import { CsvParseService } from './csv-parse/csv-parse.service';
+import { Advertisement } from './utility/struct';
+import { WorkspaceService } from './workspace/workspace.service';
+import _ from 'lodash';
+
+@Injectable()
+export class AppService extends ConsoleLogger {
+  private readonly rootPath: string;
+  constructor(
+    private readonly config: ConfigService,
+    private csv: CsvParseService,
+    private workspaceService: WorkspaceService,
+  ) {
+    super('app');
+    this.rootPath = path.resolve(process.cwd(), this.config.get('rootPath'));
+  }
+
+  private async getAd(workspace: Workspace, name: string) {
+    if (!name) {
+      throw new BlankReturnMessageDto(404, 'workspace not found').toException();
+    }
+    try {
+      const buf = await fs.promises.readFile(
+        path.join(this.rootPath, `${workspace.title} - ${name}.csv`),
+      );
+      const ads = await this.csv.parseCsv<Advertisement>(
+        buf,
+        workspace.encoding || 'utf8',
+        {
+          columns: true,
+          cast: true,
+        },
+      );
+      return ads;
+    } catch (e) {
+      throw new BlankReturnMessageDto(404, 'file not found').toException();
+    }
+  }
+
+  async getAdArray(workspaceName: string, name: string) {
+    const workspace = this.workspaceService.getWorkspace(workspaceName);
+    if (!workspace) {
+      throw new BlankReturnMessageDto(404, 'file not found').toException();
+    }
+    const ads = await this.getAd(workspace, name);
+    return _.flatten(
+      ads
+        .filter((ad) => ad.content)
+        .map((ad) => {
+          const replicaCount = ad.count || 1;
+          const content = ad.content.replace(/\\n/g, '\n');
+          return _.range(replicaCount).map(() => content);
+        }),
+    );
+  }
+}

src/csv-parse/csv-parse.service.spec.ts

+import { Test, TestingModule } from '@nestjs/testing';
+import { CsvParseService } from './csv-parse.service';
+
+describe('CsvParseService', () => {
+  let service: CsvParseService;
+
+  beforeEach(async () => {
+    const module: TestingModule = await Test.createTestingModule({
+      providers: [CsvParseService],
+    }).compile();
+
+    service = module.get<CsvParseService>(CsvParseService);
+  });
+
+  it('should be defined', () => {
+    expect(service).toBeDefined();
+  });
+});

src/csv-parse/csv-parse.service.ts

+import { ConsoleLogger, Injectable, Logger } from '@nestjs/common';
+import util from 'util';
+import csv_parse_raw from 'csv-parse';
+import iconv from 'iconv-lite';
+
+export type CsvParseOptions = csv_parse_raw.Options;
+
+const parse_csv: (
+  input: Buffer | string,
+  options?: csv_parse_raw.Options,
+) => Promise<any> = util.promisify(csv_parse_raw);
+
+@Injectable()
+export class CsvParseService extends ConsoleLogger {
+  constructor() {
+    super('csv');
+  }
+  public async parseCsv<
+    T extends Record<string, string | number> | (string | number)[]
+  >(
+    buf: Buffer,
+    encoding = 'utf8',
+    options: CsvParseOptions = { columns: true, trim: true, cast: true },
+  ): Promise<T[]> {
+    try {
+      const fileContent = iconv.decode(buf, encoding);
+      const parsedData: T[] = await parse_csv(fileContent, {
+        columns: true,
+        trim: true,
+        cast: true,
+        ...options,
+      });
+      return parsedData;
+    } catch (e) {
+      this.error(`Failed to parse csv data: ${e.toString()}`);
+      return [];
+    }
+  }
+}

src/dto/ReturnMessage.dto.ts

+import { ApiProperty } from '@nestjs/swagger';
+import { HttpException } from '@nestjs/common';
+
+export interface BlankReturnMessage {
+  statusCode: number;
+  message: string;
+  success: boolean;
+}
+
+export interface ReturnMessage<T> extends BlankReturnMessage {
+  data?: T;
+}
+
+export class BlankReturnMessageDto implements BlankReturnMessage {
+  @ApiProperty({ description: '返回状态' })
+  statusCode: number;
+  @ApiProperty({ description: '返回信息' })
+  message: string;
+  @ApiProperty({ description: '是否成功' })
+  success: boolean;
+  constructor(statusCode: number, message?: string) {
+    this.statusCode = statusCode;
+    this.message = message || 'success';
+    this.success = statusCode < 400;
+  }
+
+  toException() {
+    return new HttpException(this, this.statusCode);
+  }
+}
+
+export class ReturnMessageDto<T>
+  extends BlankReturnMessageDto
+  implements ReturnMessage<T> {
+  @ApiProperty({ description: '返回内容' })
+  data?: T;
+  constructor(statusCode: number, message?: string, data?: T) {
+    super(statusCode, message);
+    this.data = data;
+  }
+}

src/main.ts

+import { NestFactory } from '@nestjs/core';
+import { SwaggerModule, DocumentBuilder } from '@nestjs/swagger';
+import { NestExpressApplication } from '@nestjs/platform-express';
+import { AppModule } from './app.module';
+import { ConfigService } from '@nestjs/config';
+
+async function bootstrap() {
+  const app = await NestFactory.create<NestExpressApplication>(AppModule);
+  app.enableCors();
+  app.set('trust proxy', ['172.16.0.0/12', 'loopback']);
+
+  const documentConfig = new DocumentBuilder()
+    .setTitle('app')
+    .setDescription('The app')
+    .setVersion('1.0')
+    .build();
+  
+  const document = SwaggerModule.createDocument(app, documentConfig);
+  SwaggerModule.setup('docs', app, document);
+
+  const config = app.get(ConfigService);
+  await app.listen(
+    config.get<number>('port') || 3000,
+    config.get<string>('host') || '::',
+  );
+}
+bootstrap();

src/utility/config.ts

+import yaml from 'yaml';
+import * as fs from 'fs';
+
+export interface Workspace {
+  title: string;
+  encoding?: string;
+  default?: boolean;
+}
+
+export interface Config {
+  host: string;
+  port: number;
+  rootPath: string;
+  workspaces: Record<string, Workspace>;
+}
+
+const defaultConfig: Config = {
+  host: '::',
+  port: 3000,
+  rootPath: './data',
+  workspaces: {},
+};
+
+export async function loadConfig(): Promise<Config> {
+  let readConfig: Partial<Config> = {};
+  try {
+    const configText = await fs.promises.readFile('./config.yaml', 'utf-8');
+    readConfig = yaml.parse(configText);
+  } catch (e) {
+    console.error(`Failed to read config: ${e.toString()}`);
+  }
+  return {
+    ...defaultConfig,
+    ...readConfig,
+  };
+}

src/utility/struct.ts

+export interface Advertisement extends Record<string, string | number> {
+  QQ: number;
+  pay: number;
+  count?: number;
+  content: string;
+  comment?: string;
+}

src/workspace/workspace.service.spec.ts

+import { Test, TestingModule } from '@nestjs/testing';
+import { WorkspaceService } from './workspace.service';
+
+describe('WorkspaceService', () => {
+  let service: WorkspaceService;
+
+  beforeEach(async () => {
+    const module: TestingModule = await Test.createTestingModule({
+      providers: [WorkspaceService],
+    }).compile();
+
+    service = module.get<WorkspaceService>(WorkspaceService);
+  });
+
+  it('should be defined', () => {
+    expect(service).toBeDefined();
+  });
+});

src/workspace/workspace.service.ts

+import { ConsoleLogger, Injectable } from '@nestjs/common';
+import { ConfigService } from '@nestjs/config';
+import { Workspace } from '../utility/config';
+
+@Injectable()
+export class WorkspaceService extends ConsoleLogger {
+  private readonly workspaceMap: Map<string, Workspace>;
+  private readonly defaultWorkspace: Workspace;
+  constructor(private config: ConfigService) {
+    super('workspace');
+    const entries = Object.entries(
+      this.config.get<Workspace>('workspaces'),
+    ) as [string, Workspace][];
+    this.workspaceMap = new Map(entries);
+    const defaultEntry = entries.find((e) => e[1].default);
+    if (defaultEntry) {
+      this.defaultWorkspace = defaultEntry[1];
+    }
+  }
+
+  getWorkspace(name?: string) {
+    return name ? this.workspaceMap.get(name) : this.defaultWorkspace;
+  }
+}

test/app.e2e-spec.ts

+import { Test, TestingModule } from '@nestjs/testing';
+import { INestApplication } from '@nestjs/common';
+import * as request from 'supertest';
+import { AppModule } from './../src/app.module';
+
+describe('AppController (e2e)', () => {
+  let app: INestApplication;
+
+  beforeEach(async () => {
+    const moduleFixture: TestingModule = await Test.createTestingModule({
+      imports: [AppModule],
+    }).compile();
+
+    app = moduleFixture.createNestApplication();
+    await app.init();
+  });
+
+  /* it('/ (GET)', () => {
+    return request(app.getHttpServer())
+      .get('/')
+      .expect(200)
+      .expect('Hello World!');
+  }); */
+});

test/jest-e2e.json

+{
+  "moduleFileExtensions": ["js", "json", "ts"],
+  "rootDir": ".",
+  "testEnvironment": "node",
+  "testRegex": ".e2e-spec.ts$",
+  "transform": {
+    "^.+\\.(t|j)s$": "ts-jest"
+  }
+}

tsconfig.build.json

+{
+  "extends": "./tsconfig.json",
+  "exclude": ["node_modules", "test", "dist", "**/*spec.ts"]
+}

tsconfig.json

+{
+  "compilerOptions": {
+    "module": "commonjs",
+    "declaration": true,
+    "removeComments": true,
+    "emitDecoratorMetadata": true,
+    "experimentalDecorators": true,
+    "allowSyntheticDefaultImports": true,
+    "target": "es2021",
+    "sourceMap": true,
+    "outDir": "./dist",
+    "baseUrl": "./",
+    "incremental": true,
+    "esModuleInterop": true
+  },
+  "compileOnSave": true,
+  "allowJs": true
+}