feat: add migrations

Author: eranshmil

README.md

@@ -13,27 +13,28 @@ Deployed on Heroku
 Using postgres.
 Copy `.env.example` into `.env` and update the variables to match your environment, or define local variable named DATABASE_URL of the form `postgres://user:pass@localhost:5432/bots_db`
 
-Install locally by running:
+Install locally:
 
-```bash
-$ psql postgres
-CREATE ROLE bots WITH LOGIN PASSWORD 'yourpass';
-ALTER ROLE bots CREATEDB;
+1. Create Database and User:
 
-$ psql postgres -U bots
-CREATE DATABASE bots_db;
-GRANT ALL PRIVILEGES ON DATABASE bots_db TO bots;
-CREATE TYPE platform AS ENUM('TWITTER', 'FACEBOOK', 'INSTAGRAM');
-CREATE TYPE reason AS ENUM('BOT', 'VIOLENCE', 'FAKE');
-CREATE TYPE status AS ENUM('REPORTED', 'IN_PROCESS', 'BOT', 'NOT_BOT', 'DUPLICATE');
+   ```bash
+   $ psql postgres
+   CREATE ROLE bots WITH LOGIN PASSWORD 'yourpass';
+   ALTER ROLE bots CREATEDB;
 
-DROP TABLE IF EXISTS user_statuses;
-CREATE TABLE user_statuses (ID SERIAL PRIMARY KEY, platform platform NOT NULL, user_id VARCHAR(30) NOT NULL, post_id VARCHAR(30) NOT NULL, comment_id VARCHAR(30), reply_comment_id VARCHAR(30), reasons reason[] NOT NULL, status status NOT NULL, description VARCHAR(200), reporter_key VARCHAR(30) NOT NULL, unique (platform, user_id, post_id, comment_id, reply_comment_id));
+   $ psql postgres -U bots
+   CREATE DATABASE bots_db;
+   GRANT ALL PRIVILEGES ON DATABASE bots_db TO bots;
+   ```
 
-DROP TABLE IF EXISTS reporters;
-CREATE TABLE reporters (ID SERIAL PRIMARY KEY, platform platform, user_id VARCHAR(30), reporter_key VARCHAR(30) NOT NULL);
+2. Run migrations to create tables:
 
-```
+   ```bash
+   npm run migrate
+
+   # to revert the last migration
+   npm run migrate:revert
+   ```
 
 ### Run Example
 

package.json

@@ -5,6 +5,9 @@
   "license": "MIT",
   "main": "dist/index.js",
   "scripts": {
+    "typeorm": "ts-node ./node_modules/typeorm/cli.js",
+    "migrate": "npm run typeorm -- migration:run",
+    "migrate:revert": "npm run typeorm -- migration:revert",
     "jscopy": "copyfiles -u 1 src/**/*.js dist",
     "build": "tsoa routes && tsc && npm run jscopy",
     "start": "node dist/index.js",

src/core/index.ts

@@ -1,3 +1,4 @@
 export * from './symbols';
 export * from './cache';
 export * from './logger';
+export * from './migrations';

src/core/migrations.ts

@@ -0,0 +1,28 @@
+/**
+ * Get the name of an enum, postfixed with '_enum'.
+ *
+ * @param name
+ */
+export function getEnumName(name: string): string {
+  return `${name}_enum`;
+}
+
+/**
+ * Generate a query to create an enum type in the db.
+ *
+ * @param name Name of the enum, in lowercase
+ * @param enumObject The enum type itself
+ */
+export function generateEnumQuery(
+  op: 'drop' | 'create',
+  name: string,
+  values?: string[]
+): string {
+  const enumName = getEnumName(name);
+
+  if (op === 'drop') {
+    return `DROP TYPE IF EXISTS ${enumName}`;
+  }
+
+  return `CREATE TYPE ${enumName} AS ENUM ('${values.join("', '")}');`;
+}

src/migrations/1552670893473-create_reporters_table.ts

@@ -0,0 +1,156 @@
+import { MigrationInterface, QueryRunner, Table } from 'typeorm';
+
+import { generateEnumQuery, getEnumName } from '../core';
+
+export class CreateReportersTable1552670893473 implements MigrationInterface {
+  public async up(queryRunner: QueryRunner): Promise<any> {
+    await this._createEnums(queryRunner);
+    await this._createTables(queryRunner);
+  }
+
+  public async down(queryRunner: QueryRunner): Promise<any> {
+    await queryRunner.dropTable('user_statuses', true, true);
+    await queryRunner.dropTable('reporters', true, true);
+    await queryRunner.query(generateEnumQuery('drop', 'platform'));
+    await queryRunner.query(generateEnumQuery('drop', 'status'));
+    await queryRunner.query(generateEnumQuery('drop', 'reason'));
+  }
+
+  private async _createEnums(queryRunner: QueryRunner) {
+    await queryRunner.query(
+      generateEnumQuery('create', 'platform', ['TWITTER', 'FACEBOOK', 'INSTAGRAM'])
+    );
+    await queryRunner.query(
+      generateEnumQuery('create', 'status', [
+        'REPORTED',
+        'IN_PROCESS',
+        'BOT',
+        'NOT_BOT',
+        'DUPLICATE'
+      ])
+    );
+    await queryRunner.query(
+      generateEnumQuery('create', 'reason', ['BOT', 'VIOLENCE', 'FAKE'])
+    );
+  }
+
+  private async _createTables(queryRunner: QueryRunner) {
+    await queryRunner.createTable(
+      new Table({
+        name: 'reporters',
+        columns: [
+          {
+            name: 'id',
+            type: 'int',
+            isPrimary: true,
+            isGenerated: true,
+            generationStrategy: 'increment'
+          },
+          {
+            name: 'platform',
+            type: getEnumName('platform'),
+            isNullable: false
+          },
+          {
+            name: 'user_id',
+            type: 'varchar',
+            length: '30',
+            isNullable: false
+          },
+          {
+            name: 'reporter_key',
+            type: 'varchar',
+            length: '30',
+            isNullable: false,
+            isUnique: true
+          }
+        ],
+        uniques: [{ columnNames: ['platform', 'user_id'] }]
+      }),
+      true
+    );
+
+    await queryRunner.createTable(
+      new Table({
+        name: 'user_statuses',
+        columns: [
+          {
+            name: 'id',
+            type: 'int',
+            isPrimary: true,
+            isGenerated: true,
+            generationStrategy: 'increment'
+          },
+          {
+            name: 'platform',
+            type: getEnumName('platform'),
+            isNullable: false
+          },
+          {
+            name: 'user_id',
+            type: 'varchar',
+            length: '30',
+            isNullable: false
+          },
+          {
+            name: 'post_id',
+            type: 'varchar',
+            length: '30',
+            isNullable: false
+          },
+          {
+            name: 'comment_id',
+            type: 'varchar',
+            length: '30',
+            isNullable: true
+          },
+          {
+            name: 'reply_comment_id',
+            type: 'varchar',
+            length: '30',
+            isNullable: true
+          },
+          {
+            name: 'reasons',
+            type: getEnumName('reason'),
+            isArray: true,
+            isNullable: false
+          },
+          {
+            name: 'status',
+            type: getEnumName('status'),
+            default: `'REPORTED'`,
+            isNullable: false
+          },
+          {
+            name: 'description',
+            type: 'varchar',
+            length: '200',
+            isNullable: true
+          },
+          {
+            name: 'reporter_key',
+            type: 'varchar',
+            length: '30',
+            isNullable: false
+          }
+        ],
+        uniques: [
+          {
+            columnNames: ['platform', 'user_id', 'post_id', 'comment_id', 'reply_comment_id']
+          }
+        ],
+        foreignKeys: [
+          {
+            columnNames: ['reporter_key'],
+            referencedColumnNames: ['reporter_key'],
+            referencedTableName: 'reporters',
+            onDelete: 'CASCADE'
+          }
+        ]
+      }),
+      true,
+      true
+    );
+  }
+}

tsconfig.json

@@ -1,5 +1,6 @@
 {
   "compilerOptions": {
+    "baseUrl": ".",
     "target": "es2018",
     "module": "commonjs",
     "outDir": "dist",