fix: fail if config.json not loaded

sleidig · sleidig · commit 8d8834b8ea8d · 2024-07-27T21:59:48.000+02:00
and clean up bootstrap process and only use environment, removing duplicate AppSettings class closes #2474
diff --git a/build/default.conf b/build/default.conf
@@ -39,7 +39,7 @@ server {
         root   /usr/share/nginx/html;
     }
 
-    # The proxy path should be the same as in AppSettings.DB_PROXY_PREFIX
+    # The proxy path should be the same as in environment.DB_PROXY_PREFIX
     location ^~ /db {
         rewrite /db/(.*) /$1 break;
         proxy_pass ${COUCHDB_URL};
diff --git a/doc/compodoc_sources/how-to-guides/generate-demo-data.md b/doc/compodoc_sources/how-to-guides/generate-demo-data.md
@@ -15,7 +15,7 @@ This Guide walks you through the steps to add data to this demo mode for your ow
    In the AppModule (or wherever you import the DemoDataModule) add your service provider:
    _ e.g. `DemoDataModule.forRoot([{ provide: DemoUserGeneratorService, useClass: DemoUserGeneratorService }])`
    _ When the DemoDataModule is loaded your generator is then also triggered.
-1. Change your `config.json` and set `database.useTemporaryDatabase: true` to start the app with in demo mode
+1. Change your `config.json` and set `demo_mode: true` to start the app with in demo mode
    and get your data generated on startup.
 
 ## Creating realistic, random data
diff --git a/src/app/core/analytics/analytics.service.ts b/src/app/core/analytics/analytics.service.ts
@@ -11,7 +11,7 @@ import md5 from "md5";
 /**
  * Track usage analytics data and report it to a backend server like Matomo.
  *
- * This is automatically disabled if the config.json does not specify "usage_analytics" settings.
+ * This is automatically disabled if the config doc does not specify "usage_analytics" settings.
  */
 @Injectable({
   providedIn: "root",
diff --git a/src/app/core/app-settings.ts b/src/app/core/app-settings.ts
diff --git a/src/app/core/database/pouch-database.ts b/src/app/core/database/pouch-database.ts
@@ -23,8 +23,8 @@ import { PerformanceAnalysisLogging } from "../../utils/performance-analysis-log
 import { Injectable } from "@angular/core";
 import { firstValueFrom, Observable, Subject } from "rxjs";
 import { filter } from "rxjs/operators";
-import { AppSettings } from "../app-settings";
 import { HttpStatusCode } from "@angular/common/http";
+import { environment } from "../../../environments/environment";
 
 /**
  * Wrapper for a PouchDB instance to decouple the code from
@@ -104,7 +104,7 @@ export class PouchDatabase extends Database {
    * @param fetch a overwrite for the default fetch handler
    */
   initRemoteDB(
-    dbName = `${AppSettings.DB_PROXY_PREFIX}/${AppSettings.DB_NAME}`,
+    dbName = `${environment.DB_PROXY_PREFIX}/${environment.DB_NAME}`,
     fetch = this.defaultFetch,
   ): PouchDatabase {
     const options = {
@@ -123,7 +123,7 @@ export class PouchDatabase extends Database {
     }
 
     const remoteUrl =
-      AppSettings.DB_PROXY_PREFIX + url.split(AppSettings.DB_PROXY_PREFIX)[1];
+      environment.DB_PROXY_PREFIX + url.split(environment.DB_PROXY_PREFIX)[1];
     return PouchDB.fetch(remoteUrl, opts);
   }
 
diff --git a/src/app/core/database/sync.service.ts b/src/app/core/database/sync.service.ts
@@ -2,7 +2,6 @@ import { Injectable } from "@angular/core";
 import { Database } from "./database";
 import { PouchDatabase } from "./pouch-database";
 import { Logging } from "../logging/logging.service";
-import { AppSettings } from "../app-settings";
 import { HttpStatusCode } from "@angular/common/http";
 import PouchDB from "pouchdb-browser";
 import { SyncState } from "../session/session-states/sync-state.enum";
@@ -12,6 +11,7 @@ import { KeycloakAuthService } from "../session/auth/keycloak/keycloak-auth.serv
 import { Config } from "../config/config";
 import { Entity } from "../entity/model/entity";
 import { from, of } from "rxjs";
+import { environment } from "../../../environments/environment";
 
 /**
  * This service initializes the remote DB and manages the sync between the local and remote DB.
@@ -71,7 +71,7 @@ export class SyncService {
    */
   private initDatabases() {
     this.remoteDatabase.initRemoteDB(
-      `${AppSettings.DB_PROXY_PREFIX}/${AppSettings.DB_NAME}`,
+      `${environment.DB_PROXY_PREFIX}/${environment.DB_NAME}`,
       this.fetch.bind(this),
     );
     this.remoteDB = this.remoteDatabase.getPouchDB();
@@ -88,7 +88,7 @@ export class SyncService {
     }
 
     const remoteUrl =
-      AppSettings.DB_PROXY_PREFIX + url.split(AppSettings.DB_PROXY_PREFIX)[1];
+      environment.DB_PROXY_PREFIX + url.split(environment.DB_PROXY_PREFIX)[1];
     const initialRes = await this.sendRequest(remoteUrl, opts);
 
     // retry login if request failed with unauthorized
diff --git a/src/app/core/demo-data/demo-data-initializer.service.spec.ts b/src/app/core/demo-data/demo-data-initializer.service.spec.ts
@@ -11,7 +11,6 @@ import { SessionInfo, SessionSubject } from "../session/auth/session-info";
 import { LocalAuthService } from "../session/auth/local/local-auth.service";
 import { SessionManagerService } from "../session/session-service/session-manager.service";
 import { PouchDatabase } from "../database/pouch-database";
-import { AppSettings } from "../app-settings";
 import { Database } from "../database/database";
 import { LoginState } from "../session/session-states/login-state.enum";
 
@@ -36,8 +35,8 @@ describe("DemoDataInitializerService", () => {
 
   beforeEach(() => {
     environment.session_type = SessionType.mock;
-    demoUserDBName = `${DemoUserGeneratorService.DEFAULT_USERNAME}-${AppSettings.DB_NAME}`;
-    adminDBName = `${DemoUserGeneratorService.ADMIN_USERNAME}-${AppSettings.DB_NAME}`;
+    demoUserDBName = `${DemoUserGeneratorService.DEFAULT_USERNAME}-${environment.DB_NAME}`;
+    adminDBName = `${DemoUserGeneratorService.ADMIN_USERNAME}-${environment.DB_NAME}`;
     mockDemoDataService = jasmine.createSpyObj(["publishDemoData"]);
     mockDemoDataService.publishDemoData.and.resolveTo();
     mockDialog = jasmine.createSpyObj(["open"]);
diff --git a/src/app/core/demo-data/demo-data-initializer.service.ts b/src/app/core/demo-data/demo-data-initializer.service.ts
@@ -11,7 +11,6 @@ import { Database } from "../database/database";
 import { PouchDatabase } from "../database/pouch-database";
 import { environment } from "../../../environments/environment";
 import { LoginState } from "../session/session-states/login-state.enum";
-import { AppSettings } from "../app-settings";
 import { LoginStateSubject, SessionType } from "../session/session-type";
 import memory from "pouchdb-adapter-memory";
 import PouchDB from "pouchdb-browser";
@@ -87,7 +86,7 @@ export class DemoDataInitializerService {
   }
 
   private async syncWithDemoUserDB() {
-    const dbName = `${DemoUserGeneratorService.DEFAULT_USERNAME}-${AppSettings.DB_NAME}`;
+    const dbName = `${DemoUserGeneratorService.DEFAULT_USERNAME}-${environment.DB_NAME}`;
     let demoUserDB: PouchDB.Database;
     if (environment.session_type === SessionType.mock) {
       PouchDB.plugin(memory);
diff --git a/src/app/core/session/session-service/session-manager.service.spec.ts b/src/app/core/session/session-service/session-manager.service.spec.ts
@@ -31,7 +31,6 @@ import { SyncService } from "../../database/sync.service";
 import { KeycloakAuthService } from "../auth/keycloak/keycloak-auth.service";
 import { Database } from "../../database/database";
 import { Router } from "@angular/router";
-import { AppSettings } from "../../app-settings";
 import { NAVIGATOR_TOKEN } from "../../../utils/di-tokens";
 import { CurrentUserSubject } from "../current-user-subject";
 import { EntityMapperService } from "../../entity/entity-mapper/entity-mapper.service";
@@ -48,8 +47,8 @@ describe("SessionManagerService", () => {
   let mockKeycloak: jasmine.SpyObj<KeycloakAuthService>;
   let mockNavigator: { onLine: boolean };
   let dbUser: SessionInfo;
-  const userDBName = `${TEST_USER}-${AppSettings.DB_NAME}`;
-  const deprecatedDBName = AppSettings.DB_NAME;
+  const userDBName = `${TEST_USER}-${environment.DB_NAME}`;
+  const deprecatedDBName = environment.DB_NAME;
   let initInMemorySpy: jasmine.Spy;
   let initIndexedSpy: jasmine.Spy;
 
@@ -242,11 +241,11 @@ describe("SessionManagerService", () => {
     await service.remoteLogin();
 
     expect(initInMemorySpy).toHaveBeenCalledWith(
-      TEST_USER + "-" + AppSettings.DB_NAME,
+      TEST_USER + "-" + environment.DB_NAME,
     );
   });
 
-  it("should create the database according to the session type in the AppSettings", async () => {
+  it("should create the database according to the session type in the environment", async () => {
     async function testDatabaseCreation(
       sessionType: SessionType,
       expectedDB: "inMemory" | "indexed",
diff --git a/src/app/core/session/session-service/session-manager.service.ts b/src/app/core/session/session-service/session-manager.service.ts
@@ -24,7 +24,6 @@ import { LoginState } from "../session-states/login-state.enum";
 import { Router } from "@angular/router";
 import { KeycloakAuthService } from "../auth/keycloak/keycloak-auth.service";
 import { LocalAuthService } from "../auth/local/local-auth.service";
-import { AppSettings } from "../../app-settings";
 import { PouchDatabase } from "../../database/pouch-database";
 import { environment } from "../../../../environments/environment";
 import { Database } from "../../database/database";
@@ -174,7 +173,7 @@ export class SessionManagerService {
   }
 
   private async initializeDatabaseForCurrentUser(user: SessionInfo) {
-    const userDBName = `${user.name}-${AppSettings.DB_NAME}`;
+    const userDBName = `${user.name}-${environment.DB_NAME}`;
     // Work on a temporary database before initializing the real one
     const tmpDB = new PouchDatabase();
     this.initDatabase(userDBName, tmpDB);
@@ -184,13 +183,13 @@ export class SessionManagerService {
       return;
     }
 
-    this.initDatabase(AppSettings.DB_NAME, tmpDB);
+    this.initDatabase(environment.DB_NAME, tmpDB);
     const dbFallback = window.localStorage.getItem(this.DEPRECATED_DB_KEY);
     const dbAvailable = !dbFallback || dbFallback === user.name;
     if (dbAvailable && !(await tmpDB.isEmpty())) {
       // Old database is available and can be used by the current user
       window.localStorage.setItem(this.DEPRECATED_DB_KEY, user.name);
-      this.initDatabase(AppSettings.DB_NAME);
+      this.initDatabase(environment.DB_NAME);
       return;
     }
 
diff --git a/src/app/core/session/session.module.ts b/src/app/core/session/session.module.ts
@@ -24,7 +24,7 @@ import { KeycloakAngularModule } from "keycloak-angular";
 /**
  * The core session logic handling user login as well as connection and synchronization with the remote database.
  * To access the currently active session inject the `SessionService` into your component/service.
- * What session you get varies depending on the `session_type` setting in the `config.json`.
+ * What session you get varies depending on the `session_type` setting in the environment.ts / `config.json`.
  *
  * A detailed discussion about the Session concept is available separately:
  * [Session Handling, Authentication & Synchronisation]{@link /additional-documentation/concepts/session-and-authentication-system.html}
diff --git a/src/app/core/user/user-security/user-security.component.spec.ts b/src/app/core/user/user-security/user-security.component.spec.ts
@@ -16,8 +16,8 @@ import {
 } from "../../session/auth/keycloak/keycloak-auth.service";
 import { BehaviorSubject, of, throwError } from "rxjs";
 import { User } from "../user";
-import { AppSettings } from "../../app-settings";
 import { SessionSubject } from "../../session/auth/session-info";
+import { environment } from "../../../../environments/environment";
 
 describe("UserSecurityComponent", () => {
   let component: UserSecurityComponent;
@@ -163,7 +163,7 @@ describe("UserSecurityComponent", () => {
     tick();
 
     expect(mockHttp.post).toHaveBeenCalledWith(
-      `${AppSettings.DB_PROXY_PREFIX}/${AppSettings.DB_NAME}/clear_local`,
+      `${environment.DB_PROXY_PREFIX}/${environment.DB_NAME}/clear_local`,
       undefined,
     );
     flush();
diff --git a/src/app/core/user/user-security/user-security.component.ts b/src/app/core/user/user-security/user-security.component.ts
@@ -13,7 +13,6 @@ import {
 } from "../../session/auth/keycloak/keycloak-auth.service";
 import { AlertService } from "../../alerts/alert.service";
 import { HttpClient } from "@angular/common/http";
-import { AppSettings } from "../../app-settings";
 import { NgForOf, NgIf } from "@angular/common";
 import { MatButtonModule } from "@angular/material/button";
 import { MatTooltipModule } from "@angular/material/tooltip";
@@ -24,6 +23,7 @@ import { UntilDestroy, untilDestroyed } from "@ngneat/until-destroy";
 import { SessionSubject } from "../../session/auth/session-info";
 import { Entity } from "../../entity/model/entity";
 import { catchError } from "rxjs/operators";
+import { environment } from "../../../../environments/environment";
 
 @UntilDestroy()
 @DynamicComponent("UserSecurity")
@@ -211,7 +211,7 @@ export class UserSecurityComponent implements OnInit {
   private triggerSyncReset() {
     this.http
       .post(
-        `${AppSettings.DB_PROXY_PREFIX}/${AppSettings.DB_NAME}/clear_local`,
+        `${environment.DB_PROXY_PREFIX}/${environment.DB_NAME}/clear_local`,
         undefined,
       )
       .subscribe({
diff --git a/src/app/features/file/couchdb-file.service.spec.ts b/src/app/features/file/couchdb-file.service.spec.ts
@@ -26,13 +26,13 @@ import {
   entityRegistry,
   EntityRegistry,
 } from "../../core/entity/database-entity.decorator";
-import { AppSettings } from "../../core/app-settings";
 import { FileDatatype } from "./file.datatype";
 import { SyncState } from "../../core/session/session-states/sync-state.enum";
 import { SyncStateSubject } from "../../core/session/session-type";
 import { map } from "rxjs/operators";
 import { DomSanitizer, SafeUrl } from "@angular/platform-browser";
 import { SyncService } from "../../core/database/sync.service";
+import { environment } from "../../../environments/environment";
 
 describe("CouchdbFileService", () => {
   let service: CouchdbFileService;
@@ -42,7 +42,7 @@ describe("CouchdbFileService", () => {
   let mockSyncService: jasmine.SpyObj<SyncService>;
   let dismiss: jasmine.Spy;
   let updates: Subject<UpdatedEntity<Entity>>;
-  const attachmentUrlPrefix = `${AppSettings.DB_PROXY_PREFIX}/${AppSettings.DB_NAME}-attachments`;
+  const attachmentUrlPrefix = `${environment.DB_PROXY_PREFIX}/${environment.DB_NAME}-attachments`;
 
   beforeEach(() => {
     mockHttp = jasmine.createSpyObj(["get", "put", "delete"]);
diff --git a/src/app/features/file/couchdb-file.service.ts b/src/app/features/file/couchdb-file.service.ts
@@ -7,7 +7,6 @@ import {
   HttpResponse,
   HttpStatusCode,
 } from "@angular/common/http";
-import { AppSettings } from "../../core/app-settings";
 import {
   catchError,
   concatMap,
@@ -32,6 +31,7 @@ import { DomSanitizer, SafeUrl } from "@angular/platform-browser";
 import { SyncStateSubject } from "../../core/session/session-type";
 import { SyncService } from "../../core/database/sync.service";
 import { SyncState } from "../../core/session/session-states/sync-state.enum";
+import { environment } from "../../../environments/environment";
 
 /**
  * Stores the files in the CouchDB.
@@ -40,7 +40,7 @@ import { SyncState } from "../../core/session/session-states/sync-state.enum";
  */
 @Injectable()
 export class CouchdbFileService extends FileService {
-  private attachmentsUrl = `${AppSettings.DB_PROXY_PREFIX}/${AppSettings.DB_NAME}-attachments`;
+  private attachmentsUrl = `${environment.DB_PROXY_PREFIX}/${environment.DB_NAME}-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> } = {};
diff --git a/src/bootstrap-environment.ts b/src/bootstrap-environment.ts
@@ -0,0 +1,31 @@
+import { environment } from "./environments/environment";
+import { Logging } from "./app/core/logging/logging.service";
+
+/**
+ * Overwrite environment settings with the settings from the `config.json` if present.
+ * If no file is found, the environment settings are kept.
+ **/
+export async function initEnvironmentConfig() {
+  const CONFIG_FILE = "assets/config.json";
+
+  let config: Object;
+  try {
+    const configResponse = await fetch(CONFIG_FILE);
+    config = await configResponse.json();
+    if (typeof config !== "object") {
+      throw new Error("config.json must be an object");
+    }
+  } catch (err) {
+    // if offline, the config.json should be served by the service worker
+    // if we cannot get a valid config.json, we won't be able to switch to session_type "synced" and load client data
+
+    Logging.error(err, "failed to load config.json");
+
+    alert(
+      "We couldn't load the configuration for your system. Trying to reload the app for you. If this problem persists, please contact your tech support.",
+    );
+    window.location.reload();
+  }
+
+  Object.assign(environment, config);
+}
diff --git a/src/bootstrap-i18n.ts b/src/bootstrap-i18n.ts
diff --git a/src/environments/environment.prod.ts b/src/environments/environment.prod.ts
diff --git a/src/environments/environment.spec.ts b/src/environments/environment.spec.ts
diff --git a/src/environments/environment.ts b/src/environments/environment.ts
diff --git a/src/main.ts b/src/main.ts

Original file line number	Diff line number	Diff line change
`@@ -39,7 +39,7 @@ server {`
`39`	`39`	`root /usr/share/nginx/html;`
`40`	`40`	`}`
`41`	`41`
`42`		`- # The proxy path should be the same as in AppSettings.DB_PROXY_PREFIX`
	`42`	`+ # The proxy path should be the same as in environment.DB_PROXY_PREFIX`
`43`	`43`	`location ^~ /db {`
`44`	`44`	`rewrite /db/(.*) /$1 break;`
`45`	`45`	`proxy_pass ${COUCHDB_URL};`
Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,7 @@ import md5 from "md5";`
`11`	`11`	`/**`
`12`	`12`	`* Track usage analytics data and report it to a backend server like Matomo.`
`13`	`13`	`*`
`14`		`- * This is automatically disabled if the config.json does not specify "usage_analytics" settings.`
	`14`	`+ * This is automatically disabled if the config doc does not specify "usage_analytics" settings.`
`15`	`15`	`*/`
`16`	`16`	`@Injectable({`
`17`	`17`	`providedIn: "root",`