feat(typeorm): add typeorm CLI and refactor typeorm config

Author: oceanlvr

ormconfig.ts

@@ -0,0 +1,31 @@
+import { join } from 'path'
+import fs from 'fs-extra'
+import Connections from './src/database/models/Connections'
+import getAppDataPath from 'appdata-path'
+
+const STORE_PATH = getAppDataPath('MQTTX')
+
+try {
+  if (!fs.pathExistsSync(STORE_PATH)) {
+    fs.mkdirpSync(STORE_PATH)
+  }
+} catch (err) {
+  console.error(err)
+}
+
+const config = {
+  type: 'sqlite',
+  name: 'MQTTX',
+  driver: 'sqlite',
+  synchronize: false,
+  entities: [Connections],
+  database: join(STORE_PATH, 'MQTTX.db'),
+  migrations: [join(__dirname, './src/database/migration/**/*{.ts,.js}')],
+  migrationsTableName: 'temp_migration_table',
+  cli: {
+    migrationsDir: join(__dirname, './src/database/migration'),
+    subscribersDir: join(__dirname, './src/database/subscriber'),
+    entitiesDir: join(__dirname, './src/database/models'),
+  },
+}
+export = config

package.json

@@ -4,6 +4,13 @@
   "description": "MQTT desktop client",
   "author": "EMQ X Team <[email protected]>",
   "scripts": {
+    "db:log": "TS_NODE_PROJECT=tsconfig.commonjs.json ts-node ./node_modules/.bin/typeorm schema:log -c MQTTX -f ormconfig.ts",
+    "db:migration:show": "TS_NODE_PROJECT=tsconfig.commonjs.json ts-node ./node_modules/.bin/typeorm migration:show -c MQTTX -f ormconfig.ts",
+    "db:migration:generate": "TS_NODE_PROJECT=tsconfig.commonjs.json ts-node ./node_modules/.bin/typeorm migration:generate -f ormconfig.ts -c MQTTX --pretty",
+    "db:migration:run": "TS_NODE_PROJECT=tsconfig.commonjs.json ts-node ./node_modules/.bin/typeorm migration:run -c MQTTX -f ormconfig.ts",
+    "db:migration:revert": "TS_NODE_PROJECT=tsconfig.commonjs.json ts-node ./node_modules/.bin/typeorm migration:revert -f ormconfig.ts -c MQTTX",
+    "db:migration:sync": "TS_NODE_PROJECT=tsconfig.commonjs.json ts-node ./node_modules/.bin/typeorm schema:sync -f ormconfig.ts -c MQTTX",
+    "db:diagram": "TS_NODE_PROJECT=tsconfig.commonjs.json ts-node ./node_modules/.bin/typeorm-uml ormconfig.ts -c MQTTX -d ./src/database/database.png",
     "version": "yarn run gen:version && git add -A .",
     "serve": "vue-cli-service serve",
     "build": "vue-cli-service build",
@@ -22,6 +29,7 @@
   },
   "main": "background.js",
   "dependencies": {
+    "appdata-path": "^1.0.0",
     "axios": "^0.21.1",
     "chart.js": "^2.9.4",
     "core-js": "^2.6.11",
@@ -82,6 +90,7 @@
     "prettier": "^2.0.5",
     "sass": "~1.32.13",
     "sass-loader": "^8.0.2",
+    "typeorm-uml": "^1.6.4",
     "typescript": "^3.7.4",
     "vue-cli-plugin-electron-builder": "^2.0.0",
     "vue-template-compiler": "^2.6.12"
@@ -102,4 +111,4 @@
   },
   "license": "Apache",
   "repository": "https://github.com/emqx/MQTTX"
-}
+}

src/database/README.md

@@ -0,0 +1,49 @@
+# Database Migration
+
+```shell
+# To Show Migration SQL queries
+# Check what sql queries db:sync is going to run use
+yarn run db:log
+
+# To show all migrations and whether they've been run or not
+yarn run db:migration:show
+
+# Automatic migration generation creates a new migration file and writes all sql queries that must be executed to update the database.
+yarn run db:migration:generate -n ${migration_name}
+
+# generate a ER database diagram
+yarn run db:diagram
+```
+
+dangerous CLI, do some effect in database.
+
+```shell
+# Dangerous, Development Only!
+# sync current models to database
+yarn run db:migration:sync
+
+# To execute all pending migrations | To revert the most recently executed migration
+yarn run db:migration:[run|revert]
+```
+
+If your table models is not stable, and there are development mode without any data. you could just use:
+
+1. `yarn run db:log` check CLI sync execute SQL queries
+2. `yarn run db:diagram` get a latest ER diagram
+3. `db:migration:sync` sync models to database
+
+Otherwise, Please follow bellow steps and make sure what you do. Or there is a high risk to lost data.
+
+1. `yarn run db:log` check CLI sync execute SQL queries
+2. `db:migration:generate -n {migration_name}` Automatic migration generate
+3. `db:migration:run` make pending migrations executed. NOTICE: you should execute this code before the APP open since the table model changed.
+4. `db:diagram` get a latest ER diagram.
+
+Please use `db:migration:revert` to revert changes.
+
+executing `db:migration:run`, `db:migration:sync` carefully.
+
+Reference:
+
+- [typeorm migrations](https://github.com/typeorm/typeorm/blob/master/docs/migrations.md#creating-a-new-migration)
+- [typeorm CLI](https://github.com/typeorm/typeorm/blob/master/docs/using-cli.md#installing-cli)

src/database/ormconfig.ts

@@ -1,7 +1,8 @@
-import { ConnectionOptions, createConnection, EntityTarget } from 'typeorm'
+import { createConnection, EntityTarget, getConnectionOptions } from 'typeorm'
 
-export default function useSqlite(config: ConnectionOptions) {
+export default function useSqlite() {
   const insert = async <T>(data: T, model: EntityTarget<T>): Promise<T> => {
+    const config = await getConnectionOptions('MQTTX')
     const db = await createConnection(config)
     const repository = db.getRepository(model)
     return repository.save(data)

src/database/useSqlite.ts

@@ -0,0 +1,6 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "module": "commonjs"
+  }
+}