@vcmap/core 5.2.0 → 5.3.0

package/src/vcsApp.ts

@@ -50,6 +50,7 @@ import FlightInstance, {
   FlightInstanceOptions,
 } from './util/flight/flightInstance.js';
 import FlightCollection from './util/flight/flightCollection.js';
+import DisplayQuality from './util/displayQuality/displayQuality.js';
 
 function getLogger(): Logger {
   return getLoggerByName('init');
@@ -120,9 +121,19 @@ class VcsApp {
 
   private _categories: CategoryCollection;
 
+  private _displayQuality: DisplayQuality;
+
   private _destroyed: VcsEvent<void>;
 
-  private _moduleMutationPromise: Promise<void>;
+  private _moduleMutationChain: {
+    running: boolean;
+    items: Array<{
+      moduleId: string;
+      mutation: () => Promise<void>;
+      resolve: () => void;
+      reject: (reason?: any) => void;
+    }>;
+  };
 
   private _categoryItemClassRegistry: OverrideClassRegistry<Ctor<any>>;
 
@@ -215,8 +226,9 @@ class VcsApp {
       categoryClassRegistry,
     );
     this._categories = new CategoryCollection(this);
+    this._displayQuality = new DisplayQuality(this);
     this._destroyed = new VcsEvent();
-    this._moduleMutationPromise = Promise.resolve();
+    this._moduleMutationChain = { running: false, items: [] };
     this._categoryItemClassRegistry = new OverrideClassRegistry(
       new ClassRegistry(),
     );
@@ -295,6 +307,10 @@ class VcsApp {
     return this._flights;
   }
 
+  get displayQuality(): DisplayQuality {
+    return this._displayQuality;
+  }
+
   get destroyed(): VcsEvent<void> {
     return this._destroyed;
   }
@@ -402,12 +418,13 @@ class VcsApp {
         config.startingObliqueCollectionName,
       );
       if (startingObliqueCollection) {
-        [...this._maps]
-          .filter((m) => m instanceof ObliqueMap)
-          .forEach((m) => {
-            // eslint-disable-next-line no-void
-            void (m as ObliqueMap).setCollection(startingObliqueCollection);
-          });
+        await Promise.all(
+          [...this._maps]
+            .filter((m) => m instanceof ObliqueMap)
+            .map((m) => {
+              return (m as ObliqueMap).setCollection(startingObliqueCollection);
+            }),
+        );
       }
     }
 
@@ -427,20 +444,61 @@ class VcsApp {
     }
   }
 
-  addModule(module: VcsModule): Promise<void> {
+  /**
+   * When adding multiple modules, adding of previous modules are awaited.
+   * If an invalid module is added an error is thrown and already added items of invalid module are removed.
+   * @param module
+   */
+  async addModule(module: VcsModule): Promise<void> {
     check(module, VcsModule);
 
-    this._moduleMutationPromise = this._moduleMutationPromise.then(async () => {
-      if (this._modules.hasKey(module._id)) {
-        getLogger().info(`module with id ${module._id} already loaded`);
-        return;
-      }
+    const mutation = async (): Promise<void> => {
+      try {
+        if (this._modules.hasKey(module._id)) {
+          getLogger().info(`module with id ${module._id} already loaded`);
+          return;
+        }
 
-      await this._parseModule(module);
-      await this._setModuleState(module);
-      this._modules.add(module);
+        await this._parseModule(module);
+        await this._setModuleState(module);
+        this._modules.add(module);
+      } catch (err) {
+        await this._removeModule(module._id);
+        throw err;
+      }
+    };
+    return new Promise((resolve, reject) => {
+      this._moduleMutationChain.items.push({
+        moduleId: module._id,
+        mutation,
+        resolve,
+        reject,
+      });
+      this._startModuleMutationChain();
     });
-    return this._moduleMutationPromise;
+  }
+
+  _startModuleMutationChain(): void {
+    if (!this._moduleMutationChain.running) {
+      const item = this._moduleMutationChain.items.shift();
+      if (item) {
+        try {
+          this._moduleMutationChain.running = true;
+          item
+            .mutation()
+            .then(() => item.resolve())
+            .catch((err) => item.reject(err))
+            .finally(() => {
+              this._moduleMutationChain.running = false;
+              this._startModuleMutationChain();
+            });
+        } catch (err) {
+          item.reject(err);
+          this._moduleMutationChain.running = false;
+          this._startModuleMutationChain();
+        }
+      }
+    }
   }
 
   serializeModule(moduleId: string): VcsModuleConfig {
@@ -503,8 +561,8 @@ class VcsApp {
     ]);
   }
 
-  removeModule(moduleId: string): Promise<void> {
-    this._moduleMutationPromise = this._moduleMutationPromise.then(async () => {
+  async removeModule(moduleId: string): Promise<void> {
+    const mutation = async (): Promise<void> => {
       const module = this._modules.getByKey(moduleId);
       if (!module) {
         getLogger().info(`module with id ${moduleId} has already been removed`);
@@ -512,16 +570,25 @@ class VcsApp {
       }
       await this._removeModule(moduleId);
       this._modules.remove(module);
+    };
+    return new Promise((resolve, reject) => {
+      this._moduleMutationChain.items.push({
+        moduleId,
+        mutation,
+        resolve,
+        reject,
+      });
+      this._startModuleMutationChain();
     });
-
-    return this._moduleMutationPromise;
   }
 
   /**
    * Destroys the app and all its collections, their content and ui managers.
    */
   destroy(): void {
-    Object.defineProperty(this, '_moduleMutationPromise', {
+    this._moduleMutationChain.running = false;
+    this._moduleMutationChain.items.splice(0);
+    Object.defineProperty(this, '_moduleMutationChain', {
       get() {
         throw new Error('VcsApp was destroyed');
       },
@@ -542,6 +609,7 @@ class VcsApp {
     this._categoryItemClassRegistry.destroy();
     this._tileProviderClassRegistry.destroy();
     this._featureProviderClassRegistry.destroy();
+    this._displayQuality.destroy();
     this.destroyed.raiseEvent();
     this.destroyed.destroy();
     this.localeChanged.destroy();