chore: use common db for askar and exchanges api

- replace better-sqlite3 with sqlite - rename in-memory-db.ts to db-config.ts - TypeOrmSQLiteModule to accept inMemory boolean param; helps in db initialization for app and unit tests Signed-off-by: ShikharBhatt <[email protected]>
openwallet-foundation-labs · Oct 3, 2024 · 6cf5a3c · 6cf5a3c
1 parent ecf0990
commit 6cf5a3c
Show file tree

Hide file tree

Showing 10 changed files with 421 additions and 46 deletions.
diff --git a/apps/vc-api/package.json b/apps/vc-api/package.json
@@ -37,7 +37,6 @@
     "rimraf": "^4.0.0",
     "rxjs": "^7.8.1",
     "typeorm": "^0.3.17",
-    "better-sqlite3": "~8.4.0",
     "did-resolver": "~4.1.0",
     "class-validator": "~0.14.0",
     "class-transformer": "~0.5.1",
@@ -53,7 +52,8 @@
     "@credo-ts/core": "^0.5.3",
     "@credo-ts/node": "^0.5.3",
     "@hyperledger/aries-askar-nodejs": "^0.2.1",
-    "@hyperledger/aries-askar-shared": "^0.2.3"
+    "@hyperledger/aries-askar-shared": "^0.2.3",
+    "sqlite3": "~5.1.7"
   },
   "devDependencies": {
     "@nestjs/cli": "^10.1.0",

diff --git a/apps/vc-api/src/app.module.ts b/apps/vc-api/src/app.module.ts
@@ -8,7 +8,7 @@ import { ConfigModule } from '@nestjs/config';
 import { KeyModule } from './key/key.module';
 import { DidModule } from './did/did.module';
 import { VcApiModule } from './vc-api/vc-api.module';
-import { TypeOrmSQLiteModule } from './in-memory-db';
+import { TypeOrmSQLiteModule } from './db-config';
 import { ServeStaticModule } from '@nestjs/serve-static';
 import { join } from 'path';
 import { SeederModule } from './seeder/seeder.module';

diff --git a/apps/vc-api/src/config/env-vars-validation-schema.ts b/apps/vc-api/src/config/env-vars-validation-schema.ts
@@ -4,6 +4,7 @@
  */
 
 import * as Joi from 'joi';
+import { homedir } from 'os';
 
 export const envVarsValidationSchema = Joi.object({
   NODE_ENV: Joi.string().valid('development', 'production', 'test').default('development'),
@@ -12,5 +13,6 @@ export const envVarsValidationSchema = Joi.object({
   CREDO_LABEL: Joi.string().default('vc-api-agent'),
   CREDO_WALLET_ID: Joi.string().default('vc-api-wallet'),
   CREDO_WALLET_KEY: Joi.string().default('vc-api-wallet-key-0001'),
-  CREDO_WALLET_DB_TYPE: Joi.string().default('sqlite')
+  CREDO_WALLET_DB_TYPE: Joi.string().default('sqlite'),
+  DB_BASE_PATH: Joi.string().default(`${homedir}/.vc-api`)
 });
diff --git a/apps/vc-api/src/credo/credo.service.ts b/apps/vc-api/src/credo/credo.service.ts
@@ -17,7 +17,12 @@ export class CredoService implements OnModuleInit, OnModuleDestroy {
       id: this.configService.get<string>('CREDO_WALLET_ID'),
       key: this.configService.get<string>('CREDO_WALLET_KEY'),
       storage: {
-        type: this.configService.get<string>('CREDO_WALLET_DB_TYPE')
+        type: this.configService.get<string>('CREDO_WALLET_DB_TYPE'),
+        config: {
+          path: `${this.configService.get<string>('DB_BASE_PATH')}/${this.configService.get<string>(
+            'CREDO_WALLET_ID'
+          )}/sqlite.db`
+        }
       }
     };
 
@@ -84,7 +89,7 @@ export class CredoService implements OnModuleInit, OnModuleDestroy {
   private async cleanup() {
     if (this.agent.isInitialized) {
       // close askar agent connection
-      await this.agent.wallet.close();
+      await this.wallet.close();
       await this.agent.shutdown();
     }
   }

diff --git a/apps/vc-api/src/db-config.ts b/apps/vc-api/src/db-config.ts
@@ -0,0 +1,25 @@
+/*
+ * Copyright 2021 - 2023 Energy Web Foundation
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+import { TypeOrmModule } from '@nestjs/typeorm';
+import { ConfigModule, ConfigService } from '@nestjs/config';
+
+/**
+ * Inspired by https://dev.to/webeleon/unit-testing-nestjs-with-typeorm-in-memory-l6m
+ * @param inMemory // default set to false; set to true for unit testing
+ */
+export const TypeOrmSQLiteModule = (inMemory = false) =>
+  TypeOrmModule.forRootAsync({
+    imports: [ConfigModule],
+    useFactory: async (configService: ConfigService) => ({
+      type: 'sqlite',
+      database: !inMemory ? `${configService.get<string>('DB_BASE_PATH')}/exchanges.db` : ':memory:',
+      // dropSchema: true, // disabling this option to avoid dropping askar tables
+      autoLoadEntities: true, // https://docs.nestjs.com/techniques/database#auto-load-entities
+      synchronize: true,
+      keepConnectionAlive: true // https://github.com/nestjs/typeorm/issues/61
+    }),
+    inject: [ConfigService]
+  });
diff --git a/apps/vc-api/src/did/did.controller.spec.ts b/apps/vc-api/src/did/did.controller.spec.ts
@@ -5,7 +5,7 @@
 
 import { Test, TestingModule } from '@nestjs/testing';
 import { TypeOrmModule } from '@nestjs/typeorm';
-import { TypeOrmSQLiteModule } from '../in-memory-db';
+import { TypeOrmSQLiteModule } from '../db-config';
 import { KeyModule } from '../key/key.module';
 import { DIDController } from './did.controller';
 import { DIDService } from './did.service';
@@ -21,7 +21,7 @@ describe('DidController', () => {
       imports: [
         KeyModule,
         CredoModule,
-        TypeOrmSQLiteModule(),
+        TypeOrmSQLiteModule(true),
         TypeOrmModule.forFeature([DIDDocumentEntity, VerificationMethodEntity])
       ],
       controllers: [DIDController],

diff --git a/apps/vc-api/src/did/did.service.spec.ts b/apps/vc-api/src/did/did.service.spec.ts
@@ -6,7 +6,7 @@
 import { Test, TestingModule } from '@nestjs/testing';
 import { TypeOrmModule } from '@nestjs/typeorm';
 import { DIDKeyFactory } from '@energyweb/ssi-did';
-import { TypeOrmSQLiteModule } from '../in-memory-db';
+import { TypeOrmSQLiteModule } from '../db-config';
 import { KeyModule } from '../key/key.module';
 import { KeyService } from '../key/key.service';
 import { DIDService } from './did.service';
@@ -26,7 +26,7 @@ describe('DIDService', () => {
       imports: [
         KeyModule,
         CredoModule,
-        TypeOrmSQLiteModule(),
+        TypeOrmSQLiteModule(true),
         TypeOrmModule.forFeature([DIDDocumentEntity, VerificationMethodEntity])
       ],
       providers: [

diff --git a/apps/vc-api/src/in-memory-db.ts b/apps/vc-api/src/in-memory-db.ts
diff --git a/apps/vc-api/src/key/key.service.spec.ts b/apps/vc-api/src/key/key.service.spec.ts
@@ -6,7 +6,7 @@
 import { Test, TestingModule } from '@nestjs/testing';
 import { TypeOrmModule } from '@nestjs/typeorm';
 import { JWK } from 'jose';
-import { TypeOrmSQLiteModule } from '../in-memory-db';
+import { TypeOrmSQLiteModule } from '../db-config';
 import { KeyPair } from './key-pair.entity';
 import { KeyService } from './key.service';
 import { CredoModule } from '../credo/credo.module';
@@ -22,7 +22,7 @@ describe('KeyService', () => {
 
   beforeEach(async () => {
     const module: TestingModule = await Test.createTestingModule({
-      imports: [TypeOrmSQLiteModule(), TypeOrmModule.forFeature([KeyPair]), CredoModule],
+      imports: [TypeOrmSQLiteModule(true), TypeOrmModule.forFeature([KeyPair]), CredoModule],
       providers: [
         KeyService,
         {