Notifications/separate db

src/app/core/database/database-resolver.service.ts

@@ -1,10 +1,11 @@
 import { Injectable } from "@angular/core";
 import { Database, DatabaseDocChange } from "./database";
 import { SessionInfo } from "../session/auth/session-info";
-import { environment } from "../../../environments/environment";
 import { DatabaseFactoryService } from "./database-factory.service";
 import { Entity } from "../entity/model/entity";
 import { Observable, Subject } from "rxjs";
+import { NotificationEvent } from "app/features/notification/model/notification-event";
+import { SyncedPouchDatabase } from "./pouchdb/synced-pouch-database";
 
 /**
  * Manages access to individual databases,
@@ -28,16 +29,6 @@ export class DatabaseResolverService {
 
   constructor(private databaseFactory: DatabaseFactoryService) {
     this._changesFeed = new Subject();
-    this.initDatabaseStubs();
-  }
-
-  /**
-   * Generate Database objects so that change subscriptions and other operations
-   * can already be performed during bootstrap.
-   * @private
-   */
-  private initDatabaseStubs() {
-    this.registerDatabase(Entity.DATABASE);
   }
 
   private registerDatabase(dbName: string) {
@@ -47,6 +38,10 @@ export class DatabaseResolverService {
   }
 
   getDatabase(dbName: string = Entity.DATABASE): Database {
+    if (!this.databases.has(dbName)) {
+      this.registerDatabase(dbName);
+    }
+
     let db = this.databases.get(dbName);
     return db;
   }
@@ -65,14 +60,25 @@ export class DatabaseResolverService {
 
   async initDatabasesForSession(session: SessionInfo) {
     this.initializeAppDatabaseForCurrentUser(session);
-    // ... in future initialize additional DBs here
+    this.initializeNotificationsDatabaseForCurrentUser(session);
   }
 
   private initializeAppDatabaseForCurrentUser(user: SessionInfo) {
-    const userDBName = `${user.name}-${environment.DB_NAME}`;
+    const userDBName = `${user.name}-${Entity.DATABASE}`;
     this.getDatabase(Entity.DATABASE).init(userDBName);
   }
 
+  private initializeNotificationsDatabaseForCurrentUser(user: SessionInfo) {
+    const db = this.getDatabase(NotificationEvent.DATABASE);
+    const serverDbName = `${NotificationEvent.DATABASE}_${user.id}`;
+    const browserDbName = serverDbName;
+    if (db instanceof SyncedPouchDatabase) {
+      db.init(browserDbName, serverDbName);
+    } else {
+      db.init(browserDbName);
+    }
+  }
+
   initDatabasesForAnonymous() {
     if (!this.getDatabase(Entity.DATABASE).isInitialized()) {
       this.getDatabase(Entity.DATABASE).init(null);

src/app/core/database/pouchdb/pouch-database.ts

@@ -40,7 +40,10 @@ export class PouchDatabase extends Database {
    * @param dbName the name for the database under which the IndexedDB entries will be created
    * @param options PouchDB options which are directly passed to the constructor
    */
-  init(dbName?: string, options?: PouchDB.Configuration.DatabaseConfiguration) {
+  init(
+    dbName?: string,
+    options?: PouchDB.Configuration.DatabaseConfiguration | any,
+  ) {
     this.pouchDB = new PouchDB(dbName ?? this.dbName, options);
     this.databaseInitialized.complete();
   }

src/app/core/database/pouchdb/synced-pouch-database.ts

@@ -36,14 +36,15 @@ export class SyncedPouchDatabase extends PouchDatabase {
   SYNC_INTERVAL = 30000;
 
   private remoteDatabase: RemotePouchDatabase;
+  private syncState: SyncStateSubject = new SyncStateSubject();
 
   /** trigger to unsubscribe any internal subscriptions */
   private destroy$ = new Subject<void>();
 
   constructor(
     dbName: string,
     authService: KeycloakAuthService,
-    private syncStateSubject: SyncStateSubject,
+    private globalSyncState: SyncStateSubject,
     private navigator: Navigator,
     private loginStateSubject: LoginStateSubject,
   ) {
@@ -52,7 +53,7 @@ export class SyncedPouchDatabase extends PouchDatabase {
     this.remoteDatabase = new RemotePouchDatabase(dbName, authService);
 
     this.logSyncContext();
-    this.syncStateSubject
+    this.syncState
       .pipe(
         takeUntil(this.destroy$),
         filter((state) => state === SyncState.COMPLETED),
@@ -63,6 +64,11 @@ export class SyncedPouchDatabase extends PouchDatabase {
         this.logSyncContext();
       });
 
+    // forward sync state to global sync state (combining state from all synced databases)
+    this.syncState
+      .pipe(takeUntil(this.destroy$))
+      .subscribe((state: SyncState) => this.globalSyncState.next(state));
+
     this.loginStateSubject
       .pipe(
         takeUntil(this.destroy$),
@@ -75,8 +81,9 @@ export class SyncedPouchDatabase extends PouchDatabase {
    * Initializes the PouchDB with local indexeddb as well as a remote server connection for syncing.
    * @param dbName local database name (for the current user);
    *                if explicitly passed as `null`, a remote-only, anonymous session is initialized
+   * @param remoteDbName (optional) remote database name (if different from local browser database name)
    */
-  override init(dbName?: string | null) {
+  override init(dbName?: string | null, remoteDbName?: string) {
     if (dbName === null) {
       this.remoteDatabase.init();
       // use the remote database as internal database driver
@@ -86,7 +93,7 @@ export class SyncedPouchDatabase extends PouchDatabase {
       super.init(dbName ?? this.dbName);
 
       // keep remote database on default name (e.g. "app" instead of "user_uuid-app")
-      this.remoteDatabase.init();
+      this.remoteDatabase.init(remoteDbName);
     }
   }
 
@@ -103,24 +110,26 @@ export class SyncedPouchDatabase extends PouchDatabase {
   sync(): Promise<SyncResult> {
     if (!this.navigator.onLine) {
       Logging.debug("Not syncing because offline");
-      this.syncStateSubject.next(SyncState.UNSYNCED);
+      this.syncState.next(SyncState.UNSYNCED);
       return Promise.resolve({});
     }
 
-    this.syncStateSubject.next(SyncState.STARTED);
+    this.syncState.next(SyncState.STARTED);
 
     return this.getPouchDB()
       .sync(this.remoteDatabase.getPouchDB(), {
         batch_size: this.POUCHDB_SYNC_BATCH_SIZE,
       })
       .then((res) => {
+        if (res) res["dbName"] = this.dbName;
         Logging.debug("sync completed", res);
-        this.syncStateSubject.next(SyncState.COMPLETED);
+
+        this.syncState.next(SyncState.COMPLETED);
         return res as SyncResult;
       })
       .catch((err) => {
         Logging.debug("sync error", err);
-        this.syncStateSubject.next(SyncState.FAILED);
+        this.syncState.next(SyncState.FAILED);
         throw err;
       });
   }
@@ -144,7 +153,7 @@ export class SyncedPouchDatabase extends PouchDatabase {
       .pipe(
         debounceTime(500),
         mergeMap(() => {
-          if (this.syncStateSubject.value == SyncState.STARTED) {
+          if (this.syncState.value == SyncState.STARTED) {
             return of();
           } else {
             return from(this.sync());

src/app/core/demo-data/demo-data-initializer.service.spec.ts

@@ -14,6 +14,7 @@ import { PouchDatabase } from "../database/pouchdb/pouch-database";
 import { LoginState } from "../session/session-states/login-state.enum";
 import { DatabaseResolverService } from "../database/database-resolver.service";
 import { MemoryPouchDatabase } from "../database/pouchdb/memory-pouch-database";
+import { Entity } from "../entity/model/entity";
 
 describe("DemoDataInitializerService", () => {
   const normalUser: SessionInfo = {
@@ -40,8 +41,8 @@ describe("DemoDataInitializerService", () => {
 
   beforeEach(() => {
     environment.session_type = SessionType.mock;
-    demoUserDBName = `${DemoUserGeneratorService.DEFAULT_USERNAME}-${environment.DB_NAME}`;
-    adminDBName = `${DemoUserGeneratorService.ADMIN_USERNAME}-${environment.DB_NAME}`;
+    demoUserDBName = `${DemoUserGeneratorService.DEFAULT_USERNAME}-${Entity.DATABASE}`;
+    adminDBName = `${DemoUserGeneratorService.ADMIN_USERNAME}-${Entity.DATABASE}`;
     mockDemoDataService = jasmine.createSpyObj(["publishDemoData"]);
     mockDemoDataService.publishDemoData.and.resolveTo();
     mockDialog = jasmine.createSpyObj(["open"]);

src/app/core/demo-data/demo-data-initializer.service.ts

@@ -13,6 +13,7 @@ import { LoginStateSubject, SessionType } from "../session/session-type";
 import memory from "pouchdb-adapter-memory";
 import PouchDB from "pouchdb-browser";
 import { DatabaseResolverService } from "../database/database-resolver.service";
+import { Entity } from "../entity/model/entity";
 
 /**
  * This service handles everything related to the demo-mode
@@ -79,7 +80,7 @@ export class DemoDataInitializerService {
   }
 
   private async syncWithDemoUserDB() {
-    const dbName = `${DemoUserGeneratorService.DEFAULT_USERNAME}-${environment.DB_NAME}`;
+    const dbName = `${DemoUserGeneratorService.DEFAULT_USERNAME}-${Entity.DATABASE}`;
     let demoUserDB: PouchDB.Database;
     if (environment.session_type === SessionType.mock) {
       PouchDB.plugin(memory);

src/app/core/session/session-service/session-manager.service.spec.ts

@@ -30,7 +30,7 @@ describe("SessionManagerService", () => {
   let mockKeycloak: jasmine.SpyObj<KeycloakAuthService>;
   let mockNavigator: { onLine: boolean };
   let dbUser: SessionInfo;
-  const userDBName = `${TEST_USER}-${environment.DB_NAME}`;
+  const userDBName = `${TEST_USER}-app`;
   let mockDatabaseResolver: jasmine.SpyObj<DatabaseResolverService>;
 
   beforeEach(waitForAsync(() => {

src/app/core/user/user-security/user-security.component.spec.ts

@@ -166,7 +166,7 @@ describe("UserSecurityComponent", () => {
     tick();
 
     expect(mockHttp.post).toHaveBeenCalledWith(
-      `${environment.DB_PROXY_PREFIX}/${environment.DB_NAME}/clear_local`,
+      `${environment.DB_PROXY_PREFIX}/${Entity.DATABASE}/clear_local`,
       undefined,
     );
     flush();

src/app/core/user/user-security/user-security.component.ts

@@ -215,9 +215,11 @@ export class UserSecurityComponent implements OnInit {
   }
 
   private triggerSyncReset() {
+    // TODO: does this need to be triggered for other CouchDBs as well?
+
     this.http
       .post(
-        `${environment.DB_PROXY_PREFIX}/${environment.DB_NAME}/clear_local`,
+        `${environment.DB_PROXY_PREFIX}/${Entity.DATABASE}/clear_local`,
         undefined,
       )
       .subscribe({

src/app/features/file/couchdb-file.service.spec.ts

@@ -44,7 +44,7 @@ describe("CouchdbFileService", () => {
   let mockSnackbar: jasmine.SpyObj<MatSnackBar>;
   let dismiss: jasmine.Spy;
   let updates: Subject<UpdatedEntity<Entity>>;
-  const attachmentUrlPrefix = `${environment.DB_PROXY_PREFIX}/${environment.DB_NAME}-attachments`;
+  const attachmentUrlPrefix = `${environment.DB_PROXY_PREFIX}/${Entity.DATABASE}-attachments`;
   let mockNavigator;
 
   beforeEach(() => {

src/app/features/file/couchdb-file.service.ts

@@ -31,7 +31,7 @@ import { SyncedPouchDatabase } from "app/core/database/pouchdb/synced-pouch-data
  */
 @Injectable()
 export class CouchdbFileService extends FileService {
-  private attachmentsUrl = `${environment.DB_PROXY_PREFIX}/${environment.DB_NAME}-attachments`;
+  private attachmentsUrl = `${environment.DB_PROXY_PREFIX}/${Entity.DATABASE}-attachments`;
   // TODO it seems like failed requests are executed again when a new one is done
   private requestQueue = new ObservableQueue();
   private cache: { [key: string]: Observable<string> } = {};

src/app/features/notification/model/notification-event.ts

@@ -10,6 +10,9 @@ import { EntityNotificationContext } from "./entity-notification-context";
  */
 @DatabaseEntity("NotificationEvent")
 export class NotificationEvent extends Entity {
+  // notification events are stored in a separate, user-specific database
+  static override DATABASE = "notifications";
+
   /*
    * The title of the notification.
    */

src/environments/environment.prod.ts

@@ -14,7 +14,6 @@ export const environment = {
   account_url: "https://keycloak.aam-digital.net",
   email: undefined,
   DB_PROXY_PREFIX: "/db",
-  DB_NAME: "app",
 
   enableNotificationModule: true,
 };

src/environments/environment.spec.ts

@@ -13,7 +13,6 @@ export const environment = {
   account_url: "https://accounts.aam-digital.net",
   email: undefined,
   DB_PROXY_PREFIX: "/db",
-  DB_NAME: "app",
 
   enableNotificationModule: false,
 };

src/environments/environment.ts

@@ -40,8 +40,5 @@ export const environment = {
   /** Path for the reverse proxy that forwards to the database - configured in `proxy.conf.json` and `default.conf` */
   DB_PROXY_PREFIX: "/db",
 
-  /** Name of the database that is used */
-  DB_NAME: "app",
-
   enableNotificationModule: true,
 };