fix(authentication-service): fixed env defaults issues in migrations (#…

…185)
sourcefuse · May 6, 2021 · 6f1ef17 · 6f1ef17
1 parent dd7bea2
commit 6f1ef17
Show file tree

Hide file tree

Showing 21 changed files with 78 additions and 22 deletions.
diff --git a/services/audit-service/README.md b/services/audit-service/README.md
@@ -142,7 +142,7 @@ export class AuditDbDataSource extends juggler.DataSource
 
 ### Migrations
 
-The migrations required for this service are processed during the installation automatically if you set the `AUDIT_MIGRATION` or `SOURCELOOP_MIGRATION` env variable. Please note that if you are using some pre-existing migrations or database, they may be effected. In such scenario, it is advised that you copy the migration files in your project root, using the `AUDIT_MIGRATION_COPY` or `SOURCELOOP_MIGRATION_COPY` env variables. You can customize or cherry-pick the migrations in the copied files according to your specific requirements and then apply them to the DB.
+The migrations required for this service are processed during the installation automatically if you set the `AUDIT_MIGRATION` or `SOURCELOOP_MIGRATION` env variable. The migrations use (`db-migrate`)[https://www.npmjs.com/package/db-migrate] with (`db-migrate-pg`)[https://www.npmjs.com/package/db-migrate-pg] driver for migrations, so you will have to install these packages to use auto-migration. Please note that if you are using some pre-existing migrations or database, they may be effected. In such scenario, it is advised that you copy the migration files in your project root, using the `AUDIT_MIGRATION_COPY` or `SOURCELOOP_MIGRATION_COPY` env variables. You can customize or cherry-pick the migrations in the copied files according to your specific requirements and then apply them to the DB.
 
 ### API Documentation
 

diff --git a/services/audit-service/migration.js b/services/audit-service/migration.js
@@ -1,10 +1,14 @@
-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')});
+dotenvExt.load({
+  path: path.join(process.env.INIT_CWD, '.env'),
+  defaults: path.join(process.env.INIT_CWD, '.env.defaults'),
+  errorOnMissing: false,
+  includeProcessEnv: true,
+});
 const type = 'AUDIT';
 
 try {

diff --git a/services/audit-service/package.json b/services/audit-service/package.json
@@ -46,6 +46,10 @@
     "database.json",
     "!*/__tests__"
   ],
+  "peerDependencies": {
+    "db-migrate": "< 1.0.0 || ^1.0.0",
+    "db-migrate-pg": "^1.0.0"
+  },
   "dependencies": {
     "@loopback/boot": "^3.1.0",
     "@loopback/core": "^2.12.0",

diff --git a/services/authentication-service/README.md b/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 set the `AUTH_MIGRATION` or `SOURCELOOP_MIGRATION` env variable. Please note that if you are using some pre-existing migrations or database, they may be effected. In such scenario, it is advised that you copy the migration files in your project root, using the `AUTH_MIGRATION_COPY` or `SOURCELOOP_MIGRATION_COPY` env variables. You can customize or cherry-pick the migrations in the copied files according to your specific requirements and then apply them to the DB.
+The migrations required for this service are processed during the installation automatically if you set the `AUTH_MIGRATION` or `SOURCELOOP_MIGRATION` env variable. The migrations use (`db-migrate`)[https://www.npmjs.com/package/db-migrate] with (`db-migrate-pg`)[https://www.npmjs.com/package/db-migrate-pg] driver for migrations, so you will have to install these packages to use auto-migration. Please note that if you are using some pre-existing migrations or database, they may be effected. In such scenario, it is advised that you copy the migration files in your project root, using the `AUTH_MIGRATION_COPY` or `SOURCELOOP_MIGRATION_COPY` env variables. You can customize or cherry-pick the migrations in the copied files according to your specific requirements and then apply them to the DB.
 
 ### API Documentation
 

diff --git a/services/authentication-service/migration.js b/services/authentication-service/migration.js
@@ -1,10 +1,14 @@
-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')});
+dotenvExt.load({
+  path: path.join(process.env.INIT_CWD, '.env'),
+  defaults: path.join(process.env.INIT_CWD, '.env.defaults'),
+  errorOnMissing: false,
+  includeProcessEnv: true,
+});
 const type = 'AUTH';
 
 try {

diff --git a/services/authentication-service/package.json b/services/authentication-service/package.json
@@ -45,6 +45,10 @@
     "database.json",
     "!*/__tests__"
   ],
+  "peerDependencies": {
+    "db-migrate": "< 1.0.0 || ^1.0.0",
+    "db-migrate-pg": "^1.0.0"
+  },
   "dependencies": {
     "@loopback/boot": "^3.1.0",
     "@loopback/context": "^3.13.0",

diff --git a/services/bpmn-service/README.md b/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 set the `WORKFLOW_MIGRATION` or `SOURCELOOP_MIGRATION` env variable. Please note that if you are using some pre-existing migrations or database, they may be effected. In such scenario, it is advised that you copy the migration files in your project root, using the `WORKFLOW_MIGRATION_COPY` or `SOURCELOOP_MIGRATION_COPY` env variables. You can customize or cherry-pick the migrations in the copied files according to your specific requirements and then apply them to the DB.
+The migrations required for this service are processed during the installation automatically if you set the `WORKFLOW_MIGRATION` or `SOURCELOOP_MIGRATION` env variable. The migrations use (`db-migrate`)[https://www.npmjs.com/package/db-migrate] with (`db-migrate-pg`)[https://www.npmjs.com/package/db-migrate-pg] driver for migrations, so you will have to install these packages to use auto-migration. Please note that if you are using some pre-existing migrations or database, they may be effected. In such scenario, it is advised that you copy the migration files in your project root, using the `WORKFLOW_MIGRATION_COPY` or `SOURCELOOP_MIGRATION_COPY` env variables. You can customize or cherry-pick the migrations in the copied files according to your specific requirements and then apply them to the DB.
 
 This project includes no migrations to seed your BPMN engine. If you are using Camunda BPM Run, you can use either the `resources` folder to seed a model, or you can config it to use a custom DB where you can seed your data. The steps to config Platform Run are given [here](https://camunda.com/blog/2020/03/introducing-camunda-bpm-run/).
 

diff --git a/services/bpmn-service/migration.js b/services/bpmn-service/migration.js
@@ -1,10 +1,14 @@
-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')});
+dotenvExt.load({
+  path: path.join(process.env.INIT_CWD, '.env'),
+  defaults: path.join(process.env.INIT_CWD, '.env.defaults'),
+  errorOnMissing: false,
+  includeProcessEnv: true,
+});
 const type = 'WORKFLOW';
 
 try {

diff --git a/services/bpmn-service/package.json b/services/bpmn-service/package.json
@@ -45,6 +45,10 @@
     "database.json",
     "!*/__tests__"
   ],
+  "peerDependencies": {
+    "db-migrate": "< 1.0.0 || ^1.0.0",
+    "db-migrate-pg": "^1.0.0"
+  },
   "dependencies": {
     "@loopback/boot": "^3.1.0",
     "@loopback/context": "^3.13.0",

diff --git a/services/in-mail-service/README.md b/services/in-mail-service/README.md
@@ -17,7 +17,7 @@ any client application.
 
 ### Migration
 
-The migrations required for this service are processed during the installation automatically if you set the `INMAIL_MIGRATION` or `SOURCELOOP_MIGRATION` env variable. Please note that if you are using some pre-existing migrations or database, they may be effected. In such scenario, it is advised that you copy the migration files in your project root, using the `INMAIL_MIGRATION_COPY` or `SOURCELOOP_MIGRATION_COPY` env variables. You can customize or cherry-pick the migrations in the copied files according to your specific requirements and then apply them to the DB.
+The migrations required for this service are processed during the installation automatically if you set the `INMAIL_MIGRATION` or `SOURCELOOP_MIGRATION` env variable. The migrations use (`db-migrate`)[https://www.npmjs.com/package/db-migrate] with (`db-migrate-pg`)[https://www.npmjs.com/package/db-migrate-pg] driver for migrations, so you will have to install these packages to use auto-migration. Please note that if you are using some pre-existing migrations or database, they may be effected. In such scenario, it is advised that you copy the migration files in your project root, using the `INMAIL_MIGRATION_COPY` or `SOURCELOOP_MIGRATION_COPY` env variables. You can customize or cherry-pick the migrations in the copied files according to your specific requirements and then apply them to the DB.
 
 ### Implementation
 

diff --git a/services/in-mail-service/migration.js b/services/in-mail-service/migration.js
@@ -1,10 +1,14 @@
-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')});
+dotenvExt.load({
+  path: path.join(process.env.INIT_CWD, '.env'),
+  defaults: path.join(process.env.INIT_CWD, '.env.defaults'),
+  errorOnMissing: false,
+  includeProcessEnv: true,
+});
 const type = 'INMAIL';
 
 try {

diff --git a/services/in-mail-service/package.json b/services/in-mail-service/package.json
@@ -48,6 +48,10 @@
     "database.json",
     "!*/__tests__"
   ],
+  "peerDependencies": {
+    "db-migrate": "< 1.0.0 || ^1.0.0",
+    "db-migrate-pg": "^1.0.0"
+  },
   "dependencies": {
     "@loopback/boot": "^3.1.0",
     "@loopback/context": "^3.13.0",

diff --git a/services/notification-service/README.md b/services/notification-service/README.md
@@ -127,7 +127,7 @@ export class NotificationDbDataSource extends juggler.DataSource
 
 ### Migrations
 
-The migrations required for this service are processed during the installation automatically if you set the `NOTIF_MIGRATION` or `SOURCELOOP_MIGRATION` env variable. Please note that if you are using some pre-existing migrations or database, they may be effected. In such scenario, it is advised that you copy the migration files in your project root, using the `NOTIF_MIGRATION_COPY` or `SOURCELOOP_MIGRATION_COPY` env variables. You can customize or cherry-pick the migrations in the copied files according to your specific requirements and then apply them to the DB.
+The migrations required for this service are processed during the installation automatically if you set the `NOTIF_MIGRATION` or `SOURCELOOP_MIGRATION` env variable. The migrations use (`db-migrate`)[https://www.npmjs.com/package/db-migrate] with (`db-migrate-pg`)[https://www.npmjs.com/package/db-migrate-pg] driver for migrations, so you will have to install these packages to use auto-migration. Please note that if you are using some pre-existing migrations or database, they may be effected. In such scenario, it is advised that you copy the migration files in your project root, using the `NOTIF_MIGRATION_COPY` or `SOURCELOOP_MIGRATION_COPY` env variables. You can customize or cherry-pick the migrations in the copied files according to your specific requirements and then apply them to the DB.
 
 ### API Documentation
 

diff --git a/services/notification-service/migration.js b/services/notification-service/migration.js
@@ -1,10 +1,14 @@
-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')});
+dotenvExt.load({
+  path: path.join(process.env.INIT_CWD, '.env'),
+  defaults: path.join(process.env.INIT_CWD, '.env.defaults'),
+  errorOnMissing: false,
+  includeProcessEnv: true,
+});
 const type = 'NOTIF';
 
 try {

diff --git a/services/notification-service/package.json b/services/notification-service/package.json
@@ -45,6 +45,10 @@
     "database.json",
     "!*/__tests__"
   ],
+  "peerDependencies": {
+    "db-migrate": "< 1.0.0 || ^1.0.0",
+    "db-migrate-pg": "^1.0.0"
+  },
   "dependencies": {
     "@loopback/boot": "^3.1.0",
     "@loopback/context": "^3.13.0",

diff --git a/services/scheduler-service/README.md b/services/scheduler-service/README.md
@@ -59,7 +59,7 @@ export class SchedulerServiceApplication extends BootMixin(
 
 ## DB migrations
 
-The migrations required for this service are processed during the installation automatically if you set the `SCHEDULAR_MIGRATION` or `SOURCELOOP_MIGRATION` env variable. Please note that if you are using some pre-existing migrations or database, they may be effected. In such scenario, it is advised that you copy the migration files in your project root, using the `SCHEDULAR_MIGRATION_COPY` or `SOURCELOOP_MIGRATION_COPY` env variables. You can customize or cherry-pick the migrations in the copied files according to your specific requirements and then apply them to the DB.
+The migrations required for this service are processed during the installation automatically if you set the `SCHEDULER_MIGRATION` or `SOURCELOOP_MIGRATION` env variable. The migrations use (`db-migrate`)[https://www.npmjs.com/package/db-migrate] with (`db-migrate-pg`)[https://www.npmjs.com/package/db-migrate-pg] driver for migrations, so you will have to install these packages to use auto-migration. Please note that if you are using some pre-existing migrations or database, they may be effected. In such scenario, it is advised that you copy the migration files in your project root, using the `SCHEDULER_MIGRATION_COPY` or `SOURCELOOP_MIGRATION_COPY` env variables. You can customize or cherry-pick the migrations in the copied files according to your specific requirements and then apply them to the DB.
 
 #### Database Model
 

diff --git a/services/scheduler-service/migration.js b/services/scheduler-service/migration.js
@@ -1,11 +1,15 @@
-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')});
-const type = 'SCHEDULAR';
+dotenvExt.load({
+  path: path.join(process.env.INIT_CWD, '.env'),
+  defaults: path.join(process.env.INIT_CWD, '.env.defaults'),
+  errorOnMissing: false,
+  includeProcessEnv: true,
+});
+const type = 'SCHEDULER';
 
 try {
   if (fs.existsSync('.infolder')) {

diff --git a/services/scheduler-service/package.json b/services/scheduler-service/package.json
@@ -48,6 +48,10 @@
     "database.json",
     "!*/__tests__"
   ],
+  "peerDependencies": {
+    "db-migrate": "< 1.0.0 || ^1.0.0",
+    "db-migrate-pg": "^1.0.0"
+  },
   "dependencies": {
     "@loopback/boot": "^3.1.0",
     "@loopback/context": "^3.13.0",

diff --git a/services/video-conferencing-service/README.md b/services/video-conferencing-service/README.md
@@ -47,7 +47,7 @@ export class ClientComponent extends BootMixin(
 
 ## DB migrations
 
-The migrations required for this service are processed during the installation automatically if you set the `VIDEOCONF_MIGRATION` or `SOURCELOOP_MIGRATION` env variable. Please note that if you are using some pre-existing migrations or database, they may be effected. In such scenario, it is advised that you copy the migration files in your project root, using the `VIDEOCONF_MIGRATION_COPY` or `SOURCELOOP_MIGRATION_COPY` env variables. You can customize or cherry-pick the migrations in the copied files according to your specific requirements and then apply them to the DB.
+The migrations required for this service are processed during the installation automatically if you set the `VIDEOCONF_MIGRATION` or `SOURCELOOP_MIGRATION` env variable. The migrations use (`db-migrate`)[https://www.npmjs.com/package/db-migrate] with (`db-migrate-pg`)[https://www.npmjs.com/package/db-migrate-pg] driver for migrations, so you will have to install these packages to use auto-migration. Please note that if you are using some pre-existing migrations or database, they may be effected. In such scenario, it is advised that you copy the migration files in your project root, using the `VIDEOCONF_MIGRATION_COPY` or `SOURCELOOP_MIGRATION_COPY` env variables. You can customize or cherry-pick the migrations in the copied files according to your specific requirements and then apply them to the DB.
 
 ## Using config
 

diff --git a/services/video-conferencing-service/migration.js b/services/video-conferencing-service/migration.js
@@ -1,10 +1,14 @@
-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')});
+dotenvExt.load({
+  path: path.join(process.env.INIT_CWD, '.env'),
+  defaults: path.join(process.env.INIT_CWD, '.env.defaults'),
+  errorOnMissing: false,
+  includeProcessEnv: true,
+});
 const type = 'VIDEOCONF';
 
 try {

diff --git a/services/video-conferencing-service/package.json b/services/video-conferencing-service/package.json
@@ -47,6 +47,10 @@
     "database.json",
     "!*/__tests__"
   ],
+  "peerDependencies": {
+    "db-migrate": "< 1.0.0 || ^1.0.0",
+    "db-migrate-pg": "^1.0.0"
+  },
   "dependencies": {
     "@loopback/boot": "^3.1.0",
     "@loopback/context": "^3.13.0",