feat: implement servie for SQL db

Author: cyber-eternal

.env.example

@@ -0,0 +1,14 @@
+NODE_ENV=
+APP_PORT=
+DBDUMP_GATEWAY_API_KEY=
+SWAGGER_HOST=
+TYPEORM_TYPE=
+TYPEORM_HOST=
+TYPEORM_USERNAME=
+TYPEORM_PASSWORD=
+TYPEORM_DATABASE=
+TYPEORM_PORT=
+TYPEORM_LOGGING=
+TYPEORM_AUTO_LOAD_ENTITIES=
+TYPEORM_MIGRATIONS_RUN=
+TYPEORM_SYNCHRONIZE=

.gitignore

@@ -4,10 +4,6 @@ logs
 npm-debug.log*
 yarn-debug.log*
 yarn-error.log*
-lerna-debug.log*
-
-# Diagnostic reports (https://nodejs.org/api/report.html)
-report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
 
 # Runtime data
 pids
@@ -20,12 +16,11 @@ lib-cov
 
 # Coverage directory used by tools like istanbul
 coverage
-*.lcov
 
 # nyc test coverage
 .nyc_output
 
-# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
 .grunt
 
 # Bower dependency directory (https://bower.io/)
@@ -44,21 +39,12 @@ jspm_packages/
 # TypeScript v1 declaration files
 typings/
 
-# TypeScript cache
-*.tsbuildinfo
-
 # Optional npm cache directory
 .npm
 
 # Optional eslint cache
 .eslintcache
 
-# Microbundle cache
-.rpt2_cache/
-.rts2_cache_cjs/
-.rts2_cache_es/
-.rts2_cache_umd/
-
 # Optional REPL history
 .node_repl_history
 
@@ -70,35 +56,10 @@ typings/
 
 # dotenv environment variables file
 .env
-.env.test
 
-# parcel-bundler cache (https://parceljs.org/)
-.cache
-
-# Next.js build output
+# next.js build output
 .next
 
-# Nuxt.js build / generate output
-.nuxt
-dist
-
-# Gatsby files
-.cache/
-# Comment in the public line in if your project uses Gatsby and *not* Next.js
-# https://nextjs.org/blog/next-9-1#public-directory-support
-# public
-
-# vuepress build output
-.vuepress/dist
-
-# Serverless directories
-.serverless/
-
-# FuseBox cache
-.fusebox/
-
-# DynamoDB Local files
-.dynamodb/
-
-# TernJS port file
-.tern-port
+dist/
+tmp/*
+.DS_Store

.prettierrc

@@ -0,0 +1,4 @@
+{
+  "singleQuote": true,
+  "trailingComma": "all"
+}

Dockerfile

@@ -0,0 +1,17 @@
+# This image caches dependencies for other containers
+# It allows to install them once and reuse later
+FROM node:14 AS node_base
+
+## Install deps
+FROM node_base as deps
+WORKDIR /usr/app
+COPY package.json ./
+RUN yarn install --frozen-lockfile && yarn cache clean
+
+## Run app for DEV env
+FROM node_base as build
+WORKDIR /usr/app
+COPY --from=deps /usr/app/node_modules /usr/app/node_modules
+COPY . .
+CMD yarn start
+EXPOSE 3000

README.md

@@ -1,2 +1,9 @@
-# db-dump-gdpr
-Module to get a dump of the database, but with GDPR-proof scrambled data
+# DB dump
+
+Run database `docker-compose up -d`
+
+Run - `yarn start:debug`
+
+Create migration - `yarn typeorm migration:create -n <name>`
+
+Service provides an API-KEY-protected endpoint to get a database dump of the needed service with GDPR-proof scrambled data.

config/app.ts

@@ -0,0 +1,6 @@
+export default {
+  nodeEnv: process.env.NODE_ENV || 'development',
+  port: process.env.APP_PORT || 3000,
+  gatewayApiKey: process.env.DBDUMP_GATEWAY_API_KEY || 'f06c88b8-bc58-11eb-8529-0242ac130003',
+  swaggerHost: process.env.SWAGGER_HOST || `http://localhost:3000/`
+};

config/database.ts

@@ -0,0 +1,18 @@
+export default {
+  name: 'default',
+  type: process.env.TYPEORM_TYPE || 'mysql',
+  host: process.env.TYPEORM_HOST || 'localhost',
+  username: process.env.TYPEORM_USERNAME || 'guest',
+  password: process.env.TYPEORM_PASSWORD || 'guest',
+  database: process.env.TYPEORM_DATABASE || 'dbdump',
+  port: parseInt(process.env.TYPEORM_PORT, 10) || 3306,
+  logging: process.env.TYPEORM_LOGGING === 'true',
+  entities: ['**/*.entity.ts'],
+  migrations: ['migrations/**/*.ts'],
+  migrationsRun: process.env.TYPEORM_MIGRATIONS_RUN === 'true',
+  synchronize: process.env.TYPEORM_SYNCHRONIZE === 'true',
+  cli: {
+    entitiesDir: 'src',
+    migrationsDir: 'migrations',
+  },
+};

docker-compose.yml

@@ -0,0 +1,17 @@
+version: "3.0"
+services:
+  mysql-db:
+    image: mariadb:10.4
+    restart: "no"
+    volumes:
+      - dbdump-mysql:/var/lib/mysql
+    ports:
+      - 3306:3306
+    environment:
+      MYSQL_RANDOM_ROOT_PASSWORD: "yes"
+      MYSQL_DATABASE: "dbdump"
+      MYSQL_USER: "guest"
+      MYSQL_PASSWORD: "guest"
+
+volumes:
+  dbdump-mysql:

jest.config.js

@@ -0,0 +1,18 @@
+module.exports = {
+  collectCoverageFrom: [
+    "**/*.ts",
+    "!**/*.entity.ts",
+  ],
+  coverageDirectory: "../coverage",
+  moduleFileExtensions: [
+    "js",
+    "json",
+    "ts",
+  ],
+  rootDir: "src",
+  testEnvironment: "node",
+  testRegex: ".spec.ts$",
+  transform: {
+    "^.+\\.(t|j)s$": "ts-jest",
+  },
+};

migrations/1621841206193-create-db-configs-table.ts

@@ -0,0 +1,26 @@
+import { MigrationInterface, QueryRunner } from 'typeorm';
+
+export class createDbConfigsTable1621841206193 implements MigrationInterface {
+  public async up(queryRunner: QueryRunner): Promise<void> {
+    await queryRunner.query(
+      `CREATE TABLE IF NOT EXISTS db_configs (
+        id int NOT NULL AUTO_INCREMENT,
+        service varchar(255) NOT NULL,
+        type varchar(255) NOT NULL,
+        host varchar(255) NOT NULL,
+        port int NOT NULL,
+        password varchar(255) NOT NULL,
+        username varchar(255) NOT NULL,
+        db varchar(255) NOT NULL,
+        createdAt timestamp(6) NOT NULL DEFAULT CURRENT_TIMESTAMP(6),
+        updatedAt timestamp(6) NOT NULL DEFAULT CURRENT_TIMESTAMP(6) ON UPDATE CURRENT_TIMESTAMP(6),
+        UNIQUE INDEX\`IDX_64c46ce79eee86ae821782a0ca\`(\`service\`),
+        PRIMARY KEY(\`id\`)
+      ) ENGINE=InnoDB DEFAULT CHARSET=utf8;
+    `);
+  }
+
+  public async down(queryRunner: QueryRunner): Promise<void> {
+    await queryRunner.query('DROP TABLE `db_configs`');
+  }
+}