test: add test cases

src/config/app.yaml

@@ -30,4 +30,4 @@ SENTRY:
   ENABLED: false
   INSTANCE_NAME: local-development # can be personalised in .env -> local-development-<your-name>
   ENVIRONMENT: local # local | development | production
-  DNS:
+  DNS: ''

src/couchdb/couch-db-client.interface.ts

@@ -0,0 +1,25 @@
+import { Observable } from 'rxjs';
+import { CouchDbChangesResponse } from './dtos';
+import { AxiosResponse } from 'axios';
+
+export interface ICouchDbClient {
+  changes(request: { config?: any }): Observable<CouchDbChangesResponse>;
+
+  headDatabaseDocument(request: {
+    documentId: string;
+    config?: any;
+  }): Observable<AxiosResponse<any, any>>;
+
+  getDatabaseDocument<T>(request: {
+    documentId: string;
+    config?: any;
+  }): Observable<T>;
+
+  find<T>(request: { query: object; config: any }): Observable<T>;
+
+  putDatabaseDocument<T>(request: {
+    documentId: string;
+    body: any;
+    config: any;
+  }): Observable<T>;
+}

src/couchdb/couch-db-client.service.ts

@@ -1,8 +1,9 @@
 import { Logger } from '@nestjs/common';
 import { catchError, map, Observable, of, switchMap } from 'rxjs';
 import { HttpService } from '@nestjs/axios';
-import { AxiosHeaders } from 'axios';
+import { AxiosHeaders, AxiosResponse } from 'axios';
 import { CouchDbChangesResponse } from './dtos';
+import { ICouchDbClient } from './couch-db-client.interface';
 
 export class CouchDbClientConfig {
   BASE_URL = '';
@@ -11,7 +12,7 @@ export class CouchDbClientConfig {
   BASIC_AUTH_PASSWORD = '';
 }
 
-export class CouchDbClient {
+export class CouchDbClient implements ICouchDbClient {
   private readonly logger = new Logger(CouchDbClient.name);
 
   constructor(private httpService: HttpService) {}
@@ -30,7 +31,10 @@ export class CouchDbClient {
       );
   }
 
-  headDatabaseDocument(request: { documentId: string; config?: any }) {
+  headDatabaseDocument(request: {
+    documentId: string;
+    config?: any;
+  }): Observable<AxiosResponse<any, any>> {
     return this.httpService.head(`${request.documentId}`, request.config).pipe(
       catchError((err) => {
         if (err.response.status !== 404) {

src/query/sqs/dtos.ts

@@ -1,15 +1,37 @@
+import * as crypto from 'crypto';
+
 export class SqsSchema {
+  readonly language: 'sqlite';
+  readonly configVersion: string;
+  readonly sql: {
+    tables: SqlTables;
+    // Optional SQL indices
+    indexes: string[];
+    // Further options
+    options: SqlOptions;
+  };
+
   constructor(
-    public sql: {
-      // SQL table definitions
-      tables: SqlTables;
-      // Optional SQL indices
-      indexes?: string[];
-      // Further options
-      options?: SqlOptions;
-    },
-    public language: 'sqlite' = 'sqlite',
-  ) {}
+    tables: SqlTables,
+    indexes: string[],
+    options: SqlOptions,
+    language: 'sqlite' = 'sqlite',
+  ) {
+    this.sql = {
+      tables: tables,
+      indexes: indexes,
+      options: options,
+    };
+    this.language = language;
+    this.configVersion = this.asHash();
+  }
+
+  private asHash(): string {
+    return crypto
+      .createHash('sha256')
+      .update(JSON.stringify(this.sql))
+      .digest('hex');
+  }
 }
 
 type SqlTables = {