feat(in-mail-service): added migration in all services (#179)

MIGRATION CHANGE:
migration-20210501132806- added migration for notif service

BREAKING CHANGE:
need to add env in existing projects to skip auto-migrations

gh-124

services/audit-service/README.md

@@ -142,7 +142,7 @@ export class AuditDbDataSource extends juggler.DataSource
 
 ### Migrations
 
-Refer to [Database Migrations | LoopBack Documentation](https://loopback.io/doc/en/lb4/Database-migrations.html) for instructions for handling migrations.
+The migrations required for this service are processed during the installation automatically, if you plan to use the [Loopback Database Migrations] (https://loopback.io/doc/en/lb4/Database-migrations.html) or your own custom migrations, you can disable the auto-migration script by setting the `AUDIT_MIGRATION_SKIP` or `SOURCELOOP_MIGRATION_SKIP` env variable to true before installing the package. If you need the migration files in your project root, use the `AUDIT_MIGRATION_COPY` or `SOURCELOOP_MIGRATION_COPY` env variable.
 
 ### API Documentation
 

services/audit-service/migrations/.env.schema

@@ -0,0 +1,6 @@
+DB_HOST=
+DB_PORT=
+DB_USER=
+DB_PASSWORD=
+DB_DATABASE=
+DB_SCHEMA=

services/audit-service/package.json

@@ -55,6 +55,8 @@
     "@sourceloop/core": "^1.0.0-alpha.27",
     "db-migrate": "^0.11.12",
     "db-migrate-pg": "^1.2.2",
+    "dotenv": "^8.2.0",
+    "dotenv-extended": "^2.9.0",
     "loopback4-authentication": "^4.1.0",
     "loopback4-authorization": "^3.2.0",
     "prom-client": "^13.1.0",

services/authentication-service/README.md

@@ -149,7 +149,7 @@ export class AuthenticationDbDataSource
 
 ### Migrations
 
-The migrations required for this service are processed during the installation automatically, if you plan to use the [Loopback Database Migrations] (https://loopback.io/doc/en/lb4/Database-migrations.html) or your own custom migrations, you can disable the auto-migration script by setting the `AUTH_MIGRATION_SKIP` to true before installing the package.
+The migrations required for this service are processed during the installation automatically, if you plan to use the [Loopback Database Migrations] (https://loopback.io/doc/en/lb4/Database-migrations.html) or your own custom migrations, you can disable the auto-migration script by setting the `AUTH_MIGRATION_SKIP` or `SOURCELOOP_MIGRATION_SKIP` env variable to true before installing the package. If you need the migration files in your project root, use the `AUTH_MIGRATION_COPY` or `SOURCELOOP_MIGRATION_COPY` env variable.
 
 ### API Documentation
 

services/authentication-service/migration.js

@@ -15,7 +15,7 @@ try {
 }
 if (
   isLocal ||
-  process.env.WORKFLOW_MIGRATION_SKIP ||
+  process.env.AUTH_MIGRATION_SKIP ||
   process.env.SOURCELOOP_MIGRATION_SKIP
 ) {
   console.info(`Skipping migrations`);
@@ -30,10 +30,7 @@ if (
   dbmigrate.up();
 }
 
-if (
-  process.env.SOURCELOOP_MIGRATION_COPY ||
-  process.env.WORKFLOW_MIGRATION_COPY
-) {
+if (process.env.SOURCELOOP_MIGRATION_COPY || process.env.AUTH_MIGRATION_COPY) {
   copyFileSync('./database.json', process.env.INIT_CWD);
   copyFolderRecursiveSync('./migrations', process.env.INIT_CWD);
 }

services/bpmn-service/README.md

@@ -187,7 +187,7 @@ Your workers are automatically initiated once a workflow is executed, to provide
 
 ### Migrations
 
-The migrations required for this service are processed during the installation automatically, if you plan to use the [Loopback Database Migrations] (https://loopback.io/doc/en/lb4/Database-migrations.html) or your own custom migrations, you can disable the auto-migration script by setting the `WORKFLOW_MIGRATION_SKIP` env variable to true before installing the package. If you need the migration files in your project root, use the `WORKFLOW_MIGRATION_COPY` env variable.
+The migrations required for this service are processed during the installation automatically, if you plan to use the [Loopback Database Migrations] (https://loopback.io/doc/en/lb4/Database-migrations.html) or your own custom migrations, you can disable the auto-migration script by setting the `WORKFLOW_MIGRATION_SKIP` or `SOURCELOOP_MIGRATION_SKIP` env variable to true before installing the package. If you need the migration files in your project root, use the `WORKFLOW_MIGRATION_COPY` or `SOURCELOOP_MIGRATION_COPY` env variable.
 
 ### API Documentation
 

services/bpmn-service/migrations/.env.schema

@@ -0,0 +1,6 @@
+DB_HOST=
+DB_PORT=
+DB_USER=
+DB_PASSWORD=
+DB_DATABASE=
+DB_SCHEMA=

services/in-mail-service/.eslintignore

@@ -3,4 +3,5 @@ dist/
 coverage/
 
 migrations/
+migration.js
 .eslintrc.js

services/in-mail-service/README.md

@@ -16,7 +16,8 @@ any client application.
 ## Implementation
 
 ### Migration
-The project ships with generated migrations for PostgreSQL in the [migrations](migrations) folder. For generating migrations and implementing other data sources, please refer to refer to [Database Migrations | LoopBack Documentation](https://loopback.io/doc/en/lb4/Database-migrations.html) for more information.
+
+The migrations required for this service are processed during the installation automatically, if you plan to use the [Loopback Database Migrations] (https://loopback.io/doc/en/lb4/Database-migrations.html) or your own custom migrations, you can disable the auto-migration script by setting the `INMAIL_MIGRATION_SKIP` or `SOURCELOOP_MIGRATION_SKIP` env variable to true before installing the package. If you need the migration files in your project root, use the `INMAIL_MIGRATION_COPY` or `SOURCELOOP_MIGRATION_COPY` env variable.
 
 ### Implementation
 

services/in-mail-service/migrations/database.json → services/in-mail-service/database.json

@@ -3,19 +3,19 @@
     "master": {
         "driver": "pg",
         "host": {
-            "ENV": "INMAIL_DB_HOST"
+            "ENV": "DB_HOST"
         },
         "port": {
-            "ENV": "INMAIL_DB_PORT"
+            "ENV": "DB_PORT"
         },
         "user": {
-            "ENV": "INMAIL_DB_USER"
+            "ENV": "DB_USER"
         },
         "password": {
-            "ENV": "INMAIL_DB_PASSWORD"
+            "ENV": "DB_PASSWORD"
         },
         "database": {
-            "ENV": "INMAIL_DB_DATABASE"
+            "ENV": "DB_DATABASE"
         }
     },
     "sql-file": true

services/in-mail-service/migration.js

@@ -0,0 +1,76 @@
+const dotenv = require('dotenv');
+const dotenvExt = require('dotenv-extended');
+const fs = require('fs');
+const DBMigrate = require('db-migrate');
+const path = require('path');
+let isLocal = false;
+dotenv.config({path: path.join(process.env.INIT_CWD, '.env')});
+
+try {
+  if (fs.existsSync('.infolder')) {
+    isLocal = true;
+  }
+} catch (err) {
+  console.info('\n');
+}
+
+if (
+  isLocal ||
+  process.env.INMAIL_MIGRATION_SKIP ||
+  process.env.SOURCELOOP_MIGRATION_SKIP
+) {
+  console.info(`Skipping migrations`);
+} else {
+  dotenvExt.load({
+    schema: path.join(`.`, `migrations`, `.env.schema`),
+    path: path.join(process.env.INIT_CWD, '.env'),
+    errorOnMissing: true,
+    includeProcessEnv: true,
+  });
+  const dbmigrate = DBMigrate.getInstance(true);
+  dbmigrate.up();
+}
+
+if (
+  process.env.SOURCELOOP_MIGRATION_COPY ||
+  process.env.INMAIL_MIGRATION_COPY
+) {
+  copyFileSync(path.join('.', 'database.json'), process.env.INIT_CWD);
+  copyFolderRecursiveSync(path.join('.', '/migrations'), process.env.INIT_CWD);
+}
+
+function copyFileSync(source, target) {
+  var targetFile = target;
+
+  // If target is a directory, a new file with the same name will be created
+  if (fs.existsSync(target)) {
+    if (fs.lstatSync(target).isDirectory()) {
+      targetFile = path.join(target, path.basename(source));
+    }
+  }
+
+  fs.writeFileSync(targetFile, fs.readFileSync(source));
+}
+
+function copyFolderRecursiveSync(source, target) {
+  var files = [];
+
+  // Check if folder needs to be created or integrated
+  var targetFolder = path.join(target, path.basename(source));
+  if (!fs.existsSync(targetFolder)) {
+    fs.mkdirSync(targetFolder);
+  }
+
+  // Copy
+  if (fs.lstatSync(source).isDirectory()) {
+    files = fs.readdirSync(source);
+    files.forEach(function (file) {
+      var curSource = path.join(source, file);
+      if (fs.lstatSync(curSource).isDirectory()) {
+        copyFolderRecursiveSync(curSource, targetFolder);
+      } else {
+        copyFileSync(curSource, targetFolder);
+      }
+    });
+  }
+}

services/in-mail-service/migrations/.env.schema

@@ -0,0 +1,6 @@
+DB_HOST=
+DB_PORT=
+DB_USER=
+DB_PASSWORD=
+DB_DATABASE=
+DB_SCHEMA=