Fix/make database name prefix optional (#152)

* chore: update readme * fix: make dbNamePrefix optional * chore: version bump
nmshd · May 7, 2024 · 96d5daf · 96d5daf
1 parent c519129
commit 96d5daf
Show file tree

Hide file tree

Showing 10 changed files with 26 additions and 73 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,9 @@
 # Changelog
 
+## 3.10.1
+
+-   the prefix `acc-` that is appended to the configured dbName in the config is now configurable via the key `database:dbNamePrefix`
+
 ## 3.10.0
 
 -> SDK 4.2.0

diff --git a/README.md b/README.md
@@ -6,7 +6,7 @@ This monorepo consolidates the following packages / applications:
 | Component | Version(s) |
 | -- | -- |
 | [The Connector docker images](./) | [see ghcr.io](https://github.com/nmshd/connector/pkgs/container/connector) |
-| [The Connector helm charts](./) | [see ghcr.io](https://github.com/nmshd/connector/pkgs/container/connector-helm-chart) and [![Artifact Hub](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/enmeshed-connector)](https://artifacthub.io/packages/search?repo=enmeshed-connector) |
+| [The Connector helm charts](./helmChart) | [see ghcr.io](https://github.com/nmshd/connector/pkgs/container/connector-helm-chart) and [![Artifact Hub](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/enmeshed-connector)](https://artifacthub.io/packages/search?repo=enmeshed-connector) |
 | [TypeScript Connector SDK](packages/sdk/) | [![npm version](https://badge.fury.io/js/@nmshd%2fconnector-sdk.svg)](https://www.npmjs.com/package/@nmshd/connector-sdk) |
 
 ## Documentation

diff --git a/config.schema.json b/config.schema.json
@@ -32,6 +32,10 @@
                     "type": "string",
                     "default": "default",
                     "minLength": 1
+                },
+                "dbNamePrefix": {
+                    "type": "string",
+                    "default": "acc-"
                 }
             },
             "required": ["connectionString"],

diff --git a/config/default.json b/config/default.json
@@ -5,7 +5,8 @@
     },
     "database": {
         "driver": "mongodb",
-        "dbName": "default"
+        "dbName": "default",
+        "dbNamePrefix": "acc-"
     },
     "logging": {
         "appenders": {

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
     "name": "@nmshd/connector",
-    "version": "3.10.0",
+    "version": "3.10.1",
     "private": true,
     "description": "The Enmeshed Connector",
     "homepage": "https://enmeshed.eu/integrate",

diff --git a/src/ConnectorRuntime.ts b/src/ConnectorRuntime.ts
@@ -142,7 +142,7 @@ export class ConnectorRuntime extends Runtime<ConnectorRuntimeConfig> {
     }
 
     protected async initAccount(): Promise<void> {
-        const db = await this.transport.createDatabase(`acc-${this.runtimeConfig.database.dbName}`);
+        const db = await this.transport.createDatabase(`${this.runtimeConfig.database.dbNamePrefix}${this.runtimeConfig.database.dbName}`);
 
         this.accountController = await new AccountController(this.transport, db, this.transport.config).init().catch((e) => {
             if (e instanceof ApplicationError && e.code === "error.transport.general.platformClientInvalid") {

diff --git a/src/ConnectorRuntimeConfig.ts b/src/ConnectorRuntimeConfig.ts
@@ -15,7 +15,7 @@ export interface LokiJSSettings {
 export interface ConnectorRuntimeConfig extends RuntimeConfig {
     debug: boolean;
 
-    database: (MongoDBSettings | LokiJSSettings) & { dbName: string };
+    database: (MongoDBSettings | LokiJSSettings) & { dbName: string; dbNamePrefix: string };
 
     logging: log4js.Configuration;
 

diff --git a/src/jsonSchemas/connectorConfig.json b/src/jsonSchemas/connectorConfig.json
@@ -13,12 +13,15 @@
                         "dbName": {
                             "type": "string"
                         },
+                        "dbNamePrefix": {
+                            "type": "string"
+                        },
                         "driver": {
                             "const": "mongodb",
                             "type": "string"
                         }
                     },
-                    "required": ["connectionString", "dbName", "driver"],
+                    "required": ["connectionString", "dbName", "dbNamePrefix", "driver"],
                     "type": "object"
                 },
                 {
@@ -27,6 +30,9 @@
                         "dbName": {
                             "type": "string"
                         },
+                        "dbNamePrefix": {
+                            "type": "string"
+                        },
                         "driver": {
                             "const": "lokijs",
                             "type": "string"
@@ -35,7 +41,7 @@
                             "type": "string"
                         }
                     },
-                    "required": ["dbName", "driver", "folder"],
+                    "required": ["dbName", "dbNamePrefix", "driver", "folder"],
                     "type": "object"
                 }
             ]

diff --git a/src/jsonSchemas/connectorConfig.ts b/src/jsonSchemas/connectorConfig.ts
@@ -15,7 +15,7 @@ export interface LokiJSSettings {
 export interface ConnectorConfig {
     debug: boolean;
 
-    database: (MongoDBSettings | LokiJSSettings) & { dbName: string };
+    database: (MongoDBSettings | LokiJSSettings) & { dbName: string; dbNamePrefix: string };
 
     transportLibrary: IConfigOverwrite;