chore!: update Readmes, remove legacy env compat (#329)

ConduitPlatform · Sep 16, 2022 · de0556d · de0556d
1 parent 637470c
commit de0556d
Show file tree

Hide file tree

Showing 22 changed files with 27 additions and 32 deletions.
diff --git a/README.mdx b/README.mdx
@@ -70,13 +70,13 @@ Check out GraphQL on `/graphql`
 yarn
 npx lerna run build
 REDIS_HOST=localhost REDIS_PORT=6379 yarn --cwd ./packages/core start
-CONDUIT_SERVER=0.0.0.0:55152 SERVICE_IP=0.0.0.0:55165 DB_CONN_URI=mongodb://localhost:27017 yarn --cwd ./modules/database start
+CONDUIT_SERVER=0.0.0.0:55152 SERVICE_URL=0.0.0.0:55165 DB_CONN_URI=mongodb://localhost:27017 yarn --cwd ./modules/database start
 ```
 
 Then repeat the following step for every additional module you wish to bring online, specifying any additional env vars.
 
 ```sh
-CONDUIT_SERVER=0.0.0.0:55152 SERVICE_IP=0.0.0.0:PORT yarn --cwd ./modules/MODULE start
+CONDUIT_SERVER=0.0.0.0:55152 SERVICE_URL=0.0.0.0:PORT yarn --cwd ./modules/MODULE start
 ```
 
 ## Environment Variables 📃 <a name="env-vars"></a>
@@ -89,7 +89,7 @@ CONDUIT_SERVER=0.0.0.0:55152 SERVICE_IP=0.0.0.0:PORT yarn --cwd ./modules/MODULE
 |     `REDIS_PORT`    | Redis Port                                                 |   True   |    `6379`   |
 |  `ADMIN_HTTP_PORT`  | Port to be used by admin REST and GrahpQL APIs             |  False   |    `3030`   |
 | `ADMIN_SOCKET_PORT` | Port to be used by admin WebSockets API                    |  False   |    `3030`   |
-|   `SERVICE_PORT`    | Port to be used by the gRPC server                         |  False   |   `55152`   |
+|    `GRPC_PORT`      | Port to be used by the gRPC server                         |  False   |   `55152`   |
 |    `MASTER_KEY`     | Master Secret                                              |  False   | `M4ST3RK3Y` |
 |     `GRPC_KEY`      | Specifying a secret enables gRPC signed request protection |  False   | `someRandomSecret` |
 | `DEBUG__DISABLE_INACTIVE_MODULE_REMOVAL` | Prevent removal of inactive modules from Config  | False  | `true` |
@@ -118,6 +118,6 @@ Generic module env variables are also supported, with required ones being obliga
 |       Variable       | Description                                          | Required |      Example       |
 |:--------------------:|:-----------------------------------------------------| :------: |:------------------:|
 |   `CONDUIT_SERVER`   | Conduit Core's address and port                      |   True   |  `0.0.0.0:55152`   |
-|     `SERVICE_IP`     | Always 0.0.0.0 and a port numer                      |   True   |  `0.0.0.0:55190`   |
-|   `REGISTER_NAME`    | Set to `true` if running in Kubernetes               |   False  |       `true`       |
+|    `SERVICE_URL`     | This should be where this service listens on. If behind a LB it should point to the LB's IP/DNS  |   False   |  `0.0.0.0:55190`   |
+|    `GRPC_PORT`       | Port to be used by the gRPC server                   |  False   |  `55190`           |
 |     `GRPC_KEY`       | Specifying a secret enables gRPC signed request protection (**use across modules**) |   False  | `someRandomSecret` |
diff --git a/libraries/grpc-sdk/src/classes/ModuleManager.ts b/libraries/grpc-sdk/src/classes/ModuleManager.ts
@@ -26,6 +26,7 @@ export class ModuleManager<T> {
     this.servicePort = process.env.GRPC_PORT ?? '5000';
 
     this.serviceAddress =
+      // @compat (v0.15): SERVICE_IP -> SERVICE_IP
       process.env.SERVICE_URL || process.env.SERVICE_IP || '0.0.0.0:' + this.servicePort;
     try {
       this.grpcSdk = new ConduitGrpcSdk(

diff --git a/modules/authentication/Dockerfile b/modules/authentication/Dockerfile
@@ -14,7 +14,7 @@ WORKDIR /app/modules/authentication
 
 ENV CONDUIT_SERVER conduit_server
 
-ENV SERVICE_IP 0.0.0.0:5000
+ENV SERVICE_URL 0.0.0.0:5000
 ENV GRPC_PORT 5000
 
 EXPOSE 5000

diff --git a/modules/authentication/README.mdx b/modules/authentication/README.mdx
@@ -32,6 +32,6 @@ TwoFactor authentication is also provided.
 |       Variable       | Description                                          | Required |      Example       |
 |:--------------------:|:-----------------------------------------------------|:--------:|:------------------:|
 |   `CONDUIT_SERVER`   | Conduit Core's address and port                      |   True   |  `0.0.0.0:55152`   |
-|     `SERVICE_IP`     | This should be where this service listens on. If behind a LB it should point to the LB's IP/DNS  |   False   |  `0.0.0.0:55190`   |
+|     `SERVICE_URL`    | This should be where this service listens on. If behind a LB it should point to the LB's IP/DNS  |   False   |  `0.0.0.0:55190`   |
 |     `GRPC_PORT`      | The port number the gRPC server will listen to                      |  False   |  `55190`           |
 |     `GRPC_KEY`       | Specifying a secret enables gRPC signed request protection (**use across modules**) |  False   | `someRandomSecret` |
diff --git a/modules/chat/Dockerfile b/modules/chat/Dockerfile
@@ -10,7 +10,7 @@ WORKDIR /app/modules/chat
 
 ENV CONDUIT_SERVER conduit_server
 
-ENV SERVICE_IP 0.0.0.0:5000
+ENV SERVICE_URL 0.0.0.0:5000
 
 ENV GRPC_PORT 5000
 

diff --git a/modules/chat/README.mdx b/modules/chat/README.mdx
@@ -18,7 +18,7 @@ This module provides support for creating chat rooms, adding participants and se
 |       Variable       | Description                                          | Required |      Example       |
 |:--------------------:|:-----------------------------------------------------| :------: |:------------------:|
 |   `CONDUIT_SERVER`   | Conduit Core's address and port                      |   True   |  `0.0.0.0:55152`   |
-|     `SERVICE_IP`     | This should be where this service listens on. If behind a LB it should point to the LB's IP/DNS  |   False   |  `0.0.0.0:55190`   |
+|     `SERVICE_URL`    | This should be where this service listens on. If behind a LB it should point to the LB's IP/DNS  |   False   |  `0.0.0.0:55190`   |
 |     `GRPC_PORT`      | The port number the gRPC server will listen to                      |  False   |  `55190`           |
 |     `GRPC_KEY`       | Specifying a secret enables gRPC signed request protection (**use across modules**) |   False  | `someRandomSecret` |
 

diff --git a/modules/database/Dockerfile b/modules/database/Dockerfile
@@ -10,7 +10,7 @@ WORKDIR /app/modules/database
 
 ENV CONDUIT_SERVER conduit_server
 
-ENV SERVICE_IP 0.0.0.0:5000
+ENV SERVICE_URL 0.0.0.0:5000
 
 ENV GRPC_PORT 5000
 

diff --git a/modules/database/README.mdx b/modules/database/README.mdx
@@ -37,7 +37,7 @@ since the latter need to go through parsers that are otherwise unnecessary for M
 |       Variable       | Description                                          | Required |      Example       | Default  |
 |:--------------------:|:-----------------------------------------------------| :------: | :----------------: | :------: |
 |   `CONDUIT_SERVER`   | Conduit Core's address and port                      |   True   |  `0.0.0.0:55152`   |    -     |
-|     `SERVICE_IP`     | This should be where this service listens on. If behind a LB it should point to the LB's IP/DNS  |   False   |  `0.0.0.0:55190`   |
+|     `SERVICE_URL`    | This should be where this service listens on. If behind a LB it should point to the LB's IP/DNS  |   False   |  `0.0.0.0:55190`   |
 |     `GRPC_PORT`      | The port number the gRPC server will listen to                      |  False   |  `55190`           |
 |     `GRPC_KEY`       | Specifying a secret enables gRPC signed request protection (**use across modules**) |   False  | `someRandomSecret` | - |
 |   `DB_CONN_URI`      | DB Connection URI  |  False   | `postgres://conduit:pass@localhost:5432/conduit` | `mongodb://localhost:27017` |

diff --git a/modules/database/src/index.ts b/modules/database/src/index.ts
@@ -1,14 +1,8 @@
 import { ModuleManager } from '@conduitplatform/grpc-sdk';
 import DatabaseModule from './Database';
 
-const dbType =
-  process.env.DB_TYPE ??
-  process.env.databaseType ?? // Compat (<=0.12.2)
-  'mongodb';
-const dbUri =
-  process.env.DB_CONN_URI ??
-  process.env.databaseURL ?? // Compat (<=0.12.2)
-  'mongodb://localhost:27017';
+const dbType = process.env.DB_TYPE ?? 'mongodb';
+const dbUri = process.env.DB_CONN_URI ?? 'mongodb://localhost:27017';
 
 const database = new DatabaseModule(dbType, dbUri);
 const moduleManager = new ModuleManager<void>(database);

diff --git a/modules/email/Dockerfile b/modules/email/Dockerfile
@@ -10,7 +10,7 @@ WORKDIR /app/modules/email
 
 ENV CONDUIT_SERVER conduit_server
 
-ENV SERVICE_IP 0.0.0.0:5000
+ENV SERVICE_URL 0.0.0.0:5000
 
 ENV GRPC_PORT 5000
 

diff --git a/modules/email/README.mdx b/modules/email/README.mdx
@@ -20,6 +20,6 @@ The Email module serves this very purpose.
 |       Variable       | Description                                          | Required |      Example       |
 |:--------------------:|:-----------------------------------------------------| :------: |:------------------:|
 |   `CONDUIT_SERVER`   | Conduit Core's address and port                      |   True   |  `0.0.0.0:55152`   |
-|     `SERVICE_IP`     | This should be where this service listens on. If behind a LB it should point to the LB's IP/DNS  |   False   |  `0.0.0.0:55190`   |
+|     `SERVICE_URL`    | This should be where this service listens on. If behind a LB it should point to the LB's IP/DNS  |   False   |  `0.0.0.0:55190`   |
 |     `GRPC_PORT`      | The port number the gRPC server will listen to                      |  False   |  `55190`           |
 |     `GRPC_KEY`       | Specifying a secret enables gRPC signed request protection (**use across modules**) |   False  | `someRandomSecret` |
diff --git a/modules/forms/Dockerfile b/modules/forms/Dockerfile
@@ -10,7 +10,7 @@ WORKDIR /app/modules/forms
 
 ENV CONDUIT_SERVER conduit_server
 
-ENV SERVICE_IP 0.0.0.0:5000
+ENV SERVICE_URL 0.0.0.0:5000
 
 ENV GRPC_PORT 5000
 

diff --git a/modules/forms/README.mdx b/modules/forms/README.mdx
@@ -20,6 +20,6 @@ This module supports creating and submitting forms.
 |       Variable       | Description                                          | Required |      Example       |
 |:--------------------:|:-----------------------------------------------------| :------: |:------------------:|
 |   `CONDUIT_SERVER`   | Conduit Core's address and port                      |   True   |  `0.0.0.0:55152`   |
-|     `SERVICE_IP`     | This should be where this service listens on. If behind a LB it should point to the LB's IP/DNS  |   False   |  `0.0.0.0:55190`   |
+|     `SERVICE_URL`    | This should be where this service listens on. If behind a LB it should point to the LB's IP/DNS  |   False   |  `0.0.0.0:55190`   |
 |     `GRPC_PORT`      | The port number the gRPC server will listen to                      |  False   |  `55190`           |
 |     `GRPC_KEY`       | Specifying a secret enables gRPC signed request protection (**use across modules**) |   False  | `someRandomSecret` |
diff --git a/modules/push-notifications/Dockerfile b/modules/push-notifications/Dockerfile
@@ -10,7 +10,7 @@ WORKDIR /app/modules/push-notifications
 
 ENV CONDUIT_SERVER conduit_server
 
-ENV SERVICE_IP 0.0.0.0:5000
+ENV SERVICE_URL 0.0.0.0:5000
 
 ENV GRPC_PORT 5000
 

diff --git a/modules/push-notifications/README.mdx b/modules/push-notifications/README.mdx
@@ -17,6 +17,6 @@ Handles sending push notifications to users.
 |       Variable       | Description                                          | Required |      Example       |
 |:--------------------:|:-----------------------------------------------------| :------: |:------------------:|
 |   `CONDUIT_SERVER`   | Conduit Core's address and port                      |   True   |  `0.0.0.0:55152`   |
-|     `SERVICE_IP`     | This should be where this service listens on. If behind a LB it should point to the LB's IP/DNS  |   False   |  `0.0.0.0:55190`   |
+|     `SERVICE_URL`    | This should be where this service listens on. If behind a LB it should point to the LB's IP/DNS  |   False   |  `0.0.0.0:55190`   |
 |     `GRPC_PORT`      | The port number the gRPC server will listen to                      |  False   |  `55190`           |
 |     `GRPC_KEY`       | Specifying a secret enables gRPC signed request protection (**use across modules**) |   False  | `someRandomSecret` |
diff --git a/modules/router/Dockerfile b/modules/router/Dockerfile
@@ -15,7 +15,7 @@ WORKDIR /app/modules/router
 
 ENV CONDUIT_SERVER conduit_server
 
-ENV SERVICE_IP 0.0.0.0:5000
+ENV SERVICE_URL 0.0.0.0:5000
 
 ENV GRPC_PORT 5000
 

diff --git a/modules/router/README.mdx b/modules/router/README.mdx
@@ -18,7 +18,7 @@ provide a way for Conduit modules to register application routes.
 |       Variable       | Description                                          | Required |      Example       |
 |:--------------------:|:-----------------------------------------------------| :------: |:------------------:|
 |   `CONDUIT_SERVER`   | Conduit Core's address and port                      |   True   |  `0.0.0.0:55152`   |
-|     `SERVICE_IP`     | This should be where this service listens on. If behind a LB it should point to the LB's IP/DNS  |   False   |  `0.0.0.0:55190`   |
+|     `SERVICE_URL`    | This should be where this service listens on. If behind a LB it should point to the LB's IP/DNS  |   False   |  `0.0.0.0:55190`   |
 |     `GRPC_PORT`      | The port number the gRPC server will listen to                      |  False   |  `55190`           |
 |     `GRPC_KEY`       | Specifying a secret enables gRPC signed request protection (**use across modules**) |   False  | `someRandomSecret` |
 |  `CLIENT_HTTP_PORT`  | Port to be used by application REST and GrahpQL APIs |  False   |  `3000` |

diff --git a/modules/sms/Dockerfile b/modules/sms/Dockerfile
@@ -10,7 +10,7 @@ WORKDIR /app/modules/sms
 
 ENV CONDUIT_SERVER conduit_server
 
-ENV SERVICE_IP 0.0.0.0:5000
+ENV SERVICE_URL 0.0.0.0:5000
 
 ENV GRPC_PORT 5000
 

diff --git a/modules/sms/README.mdx b/modules/sms/README.mdx
@@ -17,6 +17,6 @@ Messages are delivered using third party providers.
 |       Variable       | Description                                          | Required |      Example       |
 |:--------------------:|:-----------------------------------------------------| :------: |:------------------:|
 |   `CONDUIT_SERVER`   | Conduit Core's address and port                      |   True   |  `0.0.0.0:55152`   |
-|     `SERVICE_IP`     | This should be where this service listens on. If behind a LB it should point to the LB's IP/DNS  |   False   |  `0.0.0.0:55190`   |
+|     `SERVICE_URL`    | This should be where this service listens on. If behind a LB it should point to the LB's IP/DNS  |   False   |  `0.0.0.0:55190`   |
 |     `GRPC_PORT`      | The port number the gRPC server will listen to                      |  False   |  `55190`           |
 |     `GRPC_KEY`       | Specifying a secret enables gRPC signed request protection (**use across modules**) |   False  | `someRandomSecret` |
diff --git a/modules/storage/Dockerfile b/modules/storage/Dockerfile
@@ -10,7 +10,7 @@ WORKDIR /app/modules/storage
 
 ENV CONDUIT_SERVER conduit_server
 
-ENV SERVICE_IP 0.0.0.0:5000
+ENV SERVICE_URL 0.0.0.0:5000
 
 ENV GRPC_PORT 5000
 

diff --git a/modules/storage/README.mdx b/modules/storage/README.mdx
@@ -20,6 +20,6 @@ Documents may have complex structures and subcollections and can be stored local
 |       Variable       | Description                                          | Required |      Example       |
 |:--------------------:|:-----------------------------------------------------| :------: |:------------------:|
 |   `CONDUIT_SERVER`   | Conduit Core's address and port                      |   True   |  `0.0.0.0:55152`   |
-|     `SERVICE_IP`     | This should be where this service listens on. If behind a LB it should point to the LB's IP/DNS  |   False   |  `0.0.0.0:55190`   |
+|     `SERVICE_URL`    | This should be where this service listens on. If behind a LB it should point to the LB's IP/DNS  |   False   |  `0.0.0.0:55190`   |
 |     `GRPC_PORT`      | The port number the gRPC server will listen to                      |  False   |  `55190`           |
 |     `GRPC_KEY`       | Specifying a secret enables gRPC signed request protection (**use across modules**) |   False  | `someRandomSecret` |
diff --git a/packages/admin/src/middleware/Admin.middleware.ts b/packages/admin/src/middleware/Admin.middleware.ts
@@ -32,7 +32,7 @@ export function getAdminMiddleware(conduit: ConduitCommons) {
         '!Security issue!: Master key not set, defaulting to insecure string',
       );
     }
-    const master = process.env.MASTER_KEY ?? process.env.masterkey ?? 'M4ST3RK3Y'; // Compat (<=0.12.2): masterkey
+    const master = process.env.MASTER_KEY ?? 'M4ST3RK3Y';
     if (isNil(masterKey) || masterKey !== master)
       return res.status(401).json({ error: 'Unauthorized' });
     next();