Fix arangosearch views constantly showing up as migrations

Author: Yogu

src/database/arangodb/schema-migration/arango-search-helpers.ts

@@ -106,6 +106,33 @@ export function calculateRequiredArangoSearchViewDropOperations(
     return viewsToDrop.map(value => new DropArangoSearchViewMigration({ viewName: value.name }));
 }
 
+/**
+ * Configures the inBackground flag
+ *
+ * We don'd to this initially because it won't be present in the actual view definition, and we would always see a
+ * pending change in the migration analyzer (because it would want to add inBackground).
+ */
+export function configureForBackgroundCreation(
+    definition: ArangoSearchViewPropertiesOptions
+): ArangoSearchViewPropertiesOptions {
+    return {
+        ...definition,
+        links: definition.links
+            ? Object.fromEntries(
+                  Object.entries(definition.links).map(([key, value]) => [
+                      key,
+                      {
+                          ...value,
+                          // missing in types, see https://github.com/arangodb/arangojs/issues/759
+                          // if this is not set, creating the view would acquire an exclusive lock on the collections
+                          inBackground: true
+                      }
+                  ])
+              )
+            : definition.links
+    };
+}
+
 function getPropertiesFromDefinition(
     definition: ArangoSearchDefinition,
     configuration?: ArangoSearchConfiguration
@@ -118,11 +145,7 @@ function getPropertiesFromDefinition(
                 includeAllFields: false,
                 storeValues: 'id',
                 trackListPositions: false,
-                fields: fieldDefinitionsFor(definition.rootEntityType.fields),
-
-                // missing in types, see https://github.com/arangodb/arangojs/issues/759
-                // if this is not set, creating the view would acquire an exclusive lock on the collections
-                inBackground: true
+                fields: fieldDefinitionsFor(definition.rootEntityType.fields)
             } as ArangoSearchViewLink
         },
         commitIntervalMsec: configuration?.commitIntervalMsec ? configuration.commitIntervalMsec : 1000,

src/database/arangodb/schema-migration/performer.ts

@@ -9,7 +9,7 @@ import {
     ERROR_BAD_PARAMETER,
     ERROR_FILE_EXISTS
 } from '../error-codes';
-import { isEqualProperties } from './arango-search-helpers';
+import { configureForBackgroundCreation, isEqualProperties } from './arango-search-helpers';
 import {
     CreateArangoSearchAnalyzerMigration,
     CreateArangoSearchViewMigration,
@@ -120,7 +120,7 @@ export class MigrationPerformer {
 
     private async createArangoSearchView(migration: CreateArangoSearchViewMigration) {
         try {
-            await this.db.createView(migration.viewName, migration.properties);
+            await this.db.createView(migration.viewName, configureForBackgroundCreation(migration.properties));
         } catch (e) {
             // maybe the collection has been created in the meantime
             if (e.errorNum === ERROR_ARANGO_DUPLICATE_NAME) {
@@ -135,7 +135,7 @@ export class MigrationPerformer {
     }
 
     private async updateArangoSearchView(migration: UpdateArangoSearchViewMigration) {
-        await this.db.view(migration.viewName).replaceProperties(migration.properties);
+        await this.db.view(migration.viewName).replaceProperties(configureForBackgroundCreation(migration.properties));
     }
 
     private async dropArangoSearchView(migration: DropArangoSearchViewMigration) {
@@ -161,7 +161,7 @@ export class MigrationPerformer {
         }
 
         try {
-            await this.db.createView(migration.viewName, migration.properties);
+            await this.db.createView(migration.viewName, configureForBackgroundCreation(migration.properties));
         } catch (e) {
             // maybe the collection has been created in the meantime
             if (e.errorNum === ERROR_ARANGO_DUPLICATE_NAME) {