first

.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',
+    tsconfigRootDir : __dirname, 
+    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
+  - deploy
+variables:
+  GIT_DEPTH: "1"
+
+before_script:
+  - docker login -u $CI_REGISTRY_USER -p $CI_REGISTRY_PASSWORD $CI_REGISTRY
+
+.build-image:
+  stage: build
+  script:
+    - docker build --pull -t $TARGET_IMAGE .
+    - docker push $TARGET_IMAGE
+
+build-x86:
+  extends: .build-image
+  tags:
+    - docker
+  variables:
+    TARGET_IMAGE: $CI_REGISTRY_IMAGE:$CI_COMMIT_REF_SLUG-x86
+
+build-arm:
+  extends: .build-image
+  tags:
+    - docker-arm
+  variables:
+    TARGET_IMAGE: $CI_REGISTRY_IMAGE:$CI_COMMIT_REF_SLUG-arm
+
+.deploy:
+  stage: deploy
+  tags:
+    - docker
+  script:
+    - docker pull $CI_REGISTRY_IMAGE:$CI_COMMIT_REF_SLUG-x86
+    - docker pull $CI_REGISTRY_IMAGE:$CI_COMMIT_REF_SLUG-arm
+    - docker manifest create $TARGET_IMAGE --amend $CI_REGISTRY_IMAGE:$CI_COMMIT_REF_SLUG-x86 --amend
+      $CI_REGISTRY_IMAGE:$CI_COMMIT_REF_SLUG-arm
+    - docker manifest push $TARGET_IMAGE
+
+deploy_latest:
+  extends: .deploy
+  variables:
+    TARGET_IMAGE: $CI_REGISTRY_IMAGE:latest
+  only:
+    - master
+
+deploy_branch:
+  extends: .deploy
+  variables:
+    TARGET_IMAGE: $CI_REGISTRY_IMAGE:$CI_COMMIT_REF_SLUG

.npmignore

+/install-npm.sh
+.git*
+/data
+/output
+/config.yaml
+.idea
+.dockerignore
+Dockerfile
+/src

.prettierrc

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

Dockerfile

+FROM node:lts-bullseye-slim as base
+LABEL Author="Nanahira <nanahira@momobako.com>"
+
+RUN apt update && apt -y install python3 build-essential git chromium libnss3 libfreetype6-dev libharfbuzz-bin libharfbuzz-dev ca-certificates fonts-freefont-otf fonts-freefont-ttf fonts-noto-cjk fonts-noto-cjk-extra fonts-wqy-microhei fonts-wqy-zenhei && rm -rf /var/lib/apt/lists/* /tmp/* /var/tmp/* /var/log/*
+WORKDIR /usr/src/app
+COPY ./package*.json ./
+
+FROM base as builder
+RUN npm ci && npm cache clean --force
+COPY . ./
+RUN npm run build
+
+FROM base
+ENV NODE_ENV production
+RUN npm ci && npm cache clean --force
+COPY --from=builder /usr/src/app/dist ./dist
+COPY ./config.example.yaml ./config.yaml
+
+EXPOSE 3000
+CMD [ "npm", "run", "start:prod" ]

README.md

+# sso-renderer
+
+Renders a single sign-on page for a given service.
+
+## 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
+```
+
+## Request
+
+- `GET http://localhost:3000/https://mycard.moe/arena/api`
+
+## License
+
+AGPLv3

config.example.yaml

+host: '::'
+port: 3000
+REDIS_URI: ''
\ No newline at end of file

install-npm.sh

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

nest-cli.json

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

package.json

+{
+  "name": "sso-renderer",
+  "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": "^9.0.0",
+    "@nestjs/config": "^2.3.1",
+    "@nestjs/core": "^9.0.0",
+    "@nestjs/platform-express": "^9.0.0",
+    "@nestjs/swagger": "^6.2.1",
+    "aragami": "^1.1.2",
+    "class-transformer": "^0.5.1",
+    "class-validator": "^0.14.0",
+    "nestjs-aragami": "^1.0.0",
+    "puppeteer-core": "^19.6.3",
+    "puppeteer-finder": "^1.0.3",
+    "reflect-metadata": "^0.1.13",
+    "rimraf": "^3.0.2",
+    "rxjs": "^7.2.0",
+    "yaml": "^2.2.1"
+  },
+  "devDependencies": {
+    "@nestjs/cli": "^9.0.0",
+    "@nestjs/schematics": "^9.0.0",
+    "@nestjs/testing": "^9.0.0",
+    "@types/express": "^4.17.17",
+    "@types/jest": "28.1.8",
+    "@types/node": "^16.0.0",
+    "@types/supertest": "^2.0.11",
+    "@typescript-eslint/eslint-plugin": "^5.0.0",
+    "@typescript-eslint/parser": "^5.0.0",
+    "eslint": "8.22.0",
+    "eslint-config-prettier": "^8.3.0",
+    "eslint-plugin-prettier": "^4.0.0",
+    "jest": "28.1.3",
+    "prettier": "^2.3.2",
+    "source-map-support": "^0.5.20",
+    "supertest": "^6.1.3",
+    "ts-jest": "28.0.8",
+    "ts-loader": "^9.2.3",
+    "ts-node": "^10.0.0",
+    "tsconfig-paths": "4.1.0",
+    "typescript": "^4.7.4"
+  },
+  "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, Req } from '@nestjs/common';
+import { AppService } from './app.service';
+import { Request } from 'express';
+
+@Controller()
+export class AppController {
+  constructor(private readonly appService: AppService) {}
+
+  @Get('*')
+  render(@Req() req: Request) {
+    return this.appService.render(req);
+  }
+}

src/app.module.ts

+import { Module } from '@nestjs/common';
+import { AppController } from './app.controller';
+import { AppService } from './app.service';
+import { ConfigModule, ConfigService } from '@nestjs/config';
+import { loadConfig } from './utility/config';
+import { AragamiModule } from 'nestjs-aragami';
+import { PuppeteerService } from './puppeteer/puppeteer.service';
+
+@Module({
+  imports: [
+    ConfigModule.forRoot({
+      load: [loadConfig],
+      isGlobal: true,
+      ignoreEnvVars: true,
+      ignoreEnvFile: true,
+    }),
+    AragamiModule.registerAsync({
+      inject: [ConfigService],
+      useFactory: (config: ConfigService) => {
+        const redisUrl = config.get<string>('REDIS_URL');
+        if (redisUrl) {
+          return {
+            redis: {
+              uri: redisUrl,
+            },
+          };
+        }
+        return {};
+      },
+    }),
+  ],
+  controllers: [AppController],
+  providers: [AppService, PuppeteerService],
+})
+export class AppModule {}

src/app.service.ts

+import { Injectable, ConsoleLogger } from '@nestjs/common';
+import { ConfigService } from '@nestjs/config';
+import { Request } from 'express';
+import { Aragami, CacheKey, CacheTTL } from 'aragami';
+import { InjectAragami } from 'nestjs-aragami';
+import { PuppeteerService } from './puppeteer/puppeteer.service';
+import { BlankReturnMessageDto } from './dto/ReturnMessage.dto';
+
+@CacheTTL(3600000)
+class SiteCache {
+  @CacheKey()
+  url: string;
+  html: string;
+}
+
+@Injectable()
+export class AppService extends ConsoleLogger {
+  constructor(
+    private readonly config: ConfigService,
+    @InjectAragami() private readonly aragami: Aragami,
+    private readonly puppeteerService: PuppeteerService,
+  ) {
+    super('app');
+  }
+
+  async render(req: Request) {
+    const url = req.originalUrl.startsWith('/')
+      ? req.originalUrl.slice(1)
+      : req.originalUrl;
+    const siteCache = await this.aragami.get(SiteCache, url);
+    if (siteCache) {
+      this.log(`Cache hit for ${url}`);
+      return siteCache.html;
+    }
+    this.log(`Rendering ${url}`);
+    try {
+      const html = await this.puppeteerService.render(url);
+      await this.aragami.set(SiteCache, { url, html });
+      return html;
+    } catch (e) {
+      this.error(`Error rendering ${url}`, e);
+      throw new BlankReturnMessageDto(
+        404,
+        `Page not found: ${url}`,
+      ).toException();
+    }
+  }
+}

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: 'Return code' })
+  statusCode: number;
+  @ApiProperty({ description: 'Return message' })
+  message: string;
+  @ApiProperty({ description: 'Whether success.' })
+  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);
+  }
+}
+
+type AnyClass = new (...args: any[]) => any;
+type ClassOrArray = AnyClass | [AnyClass];
+type TypeFromClass<T> = T extends new (...args: any[]) => infer U ? U : never;
+export type ParseType<T extends ClassOrArray> = T extends [infer U]
+  ? TypeFromClass<U>[]
+  : TypeFromClass<T>;
+
+function getClass(o: ClassOrArray) {
+  return o instanceof Array ? o[0] : o;
+}
+
+export function ReturnMessageDto<T extends ClassOrArray>(type: T) {
+  const cl = class SpecificReturnMessage extends BlankReturnMessageDto {
+    data?: ParseType<T>;
+    constructor(statusCode: number, message?: string, data?: ParseType<T>) {
+      super(statusCode, message);
+      this.data = data;
+    }
+  };
+  ApiProperty({ description: 'Return data.', type, required: false })(
+    cl.prototype,
+    'data',
+  );
+  Object.defineProperty(cl, 'name', {
+    value: `${getClass(type).name}ReturnMessageDto`,
+  });
+  return cl;
+}
+
+export class StringReturnMessageDto
+  extends BlankReturnMessageDto
+  implements ReturnMessage<string>
+{
+  @ApiProperty({ description: 'Return data.' })
+  data?: string;
+
+  constructor(statusCode: number, message?: string, data?: string) {
+    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('sso-renderer')
+    .setDescription('SSO 渲染器。')
+    .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/puppeteer/puppeteer.service.spec.ts

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

src/puppeteer/puppeteer.service.ts

+import {
+  ConsoleLogger,
+  Injectable,
+  OnModuleDestroy,
+  OnModuleInit,
+} from '@nestjs/common';
+import find from 'puppeteer-finder';
+import puppeteer, { Browser, Page } from 'puppeteer-core';
+@Injectable()
+export class PuppeteerService
+  extends ConsoleLogger
+  implements OnModuleInit, OnModuleDestroy
+{
+  private browser: Browser;
+  constructor() {
+    super('PuppeteerService');
+  }
+  async onModuleInit() {
+    const executablePath = find() as string;
+    this.log(`Found puppeteer executable at ${executablePath}`);
+    this.browser = await puppeteer.launch({
+      executablePath,
+      headless: true,
+      args: process.getuid?.() === 0 ? ['--no-sandbox'] : [],
+    });
+    this.log('Puppeteer launched');
+  }
+
+  async onModuleDestroy() {
+    await this.browser.close();
+  }
+
+  private async doPageAction<T>(
+    url: string,
+    action: (page: Page) => Promise<T>,
+  ) {
+    const page = await this.browser.newPage();
+    await page.goto(url, { waitUntil: 'networkidle0', timeout: 300000 });
+    const result = await action(page);
+    await page.close();
+    return result;
+  }
+
+  render(url: string) {
+    return this.doPageAction(url, (p) => p.content());
+  }
+}

src/utility/config.ts

+import yaml from 'yaml';
+import * as fs from 'fs';
+
+const defaultConfig = {
+  host: '::',
+  port: 3000,
+};
+
+export type Config = typeof defaultConfig;
+
+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,
+    ...process.env,
+  };
+}

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
+}