Add the option for preventing the generation of new IDs if the number of non-indexed objects exceeds a defined value

Author: tkleinke

README.md

@@ -25,6 +25,8 @@ All plugin configuration takes place in base configuration.
         * *ID field name*: The name of the ID field to be filled out by the plugin. This has to be a numeric field. The field will only be updated if it is empty, if the parent field has been newly created and if all base fields have been filled out by the user.
         * *Base field names*: The names of the base fields to consider when setting the ID. These can be text fields or fields of the [custom data type DANTE](https://github.com/programmfabrik/fylr-plugin-custom-data-type-dante).
         * *IDs of pools to consider*: If not empty, IDs are only updated for resources in the specified pools (and their child pools). Also, resources in other pools are not considered during ID generation.
+    * *Maximum number of non-indexed objects*: If not empty, the plugin will check if the indexer is still working by looking at the number of non-indexed objects. If the number is higher than the value specified here and an ID would have to be created, the object will not be saved and an error message will appear instead. This setting can be used to prevent the generation of incorrect IDs in the case of an overloaded indexer.
+    * *Text of indexer error message*: This text is shown as the error message that appears if the maximum number of non-indexed objects is exceeded and the object is not saved.
 
 ## Example
 

l10n/numeric-id-auto-incrementer.csv

@@ -7,3 +7,6 @@ server.config.parameter.system.numericIdAutoIncrementer.object_types.nested_fiel
 server.config.parameter.system.numericIdAutoIncrementer.object_types.nested_fields.id_field_name.label,Name des ID-Feldes,ID field name
 server.config.parameter.system.numericIdAutoIncrementer.object_types.nested_fields.base_fields.label,Namen der Basisfelder,Base field names
 server.config.parameter.system.numericIdAutoIncrementer.object_types.nested_fields.pool_ids.label,IDs der berücksichtigten Pools,IDs of pools to consider
+server.config.parameter.system.numericIdAutoIncrementer.max_not_indexed.label,Maximale Anzahl nicht indizierter Objekte,Maximum number of non-indexed objects
+server.config.parameter.system.numericIdAutoIncrementer.indexer_error_message.label,Text der Indexer-Fehlermeldung,Text of indexer error message
+base.error.realm.objectNotSaved,Speichern nicht möglich,Saving not possible

manifest.master.yml

@@ -44,6 +44,12 @@ base_config:
               position: 3
           position: 1
         position: 0
+      max_not_indexed:
+        type: int
+        position: 1
+      indexer_error_message:
+        type: text
+        position: 2
 
 callbacks:
   db_pre_save:

src/server/setIds.js

@@ -36,11 +36,15 @@ function getPluginConfiguration(data) {
 
 async function processObject(object, configuration, addedIds) {
     const nestedFieldsConfiguration = getNestedFieldsConfiguration(configuration, object._objecttype);
+    const indexerSettings = {
+        maxNotIndexed: configuration.max_not_indexed,
+        errorMessage: configuration.indexer_error_message
+    };
     let changed = false;
 
     for (let nestedFieldConfiguration of nestedFieldsConfiguration) {
         if (!isInConfiguredPool(object, nestedFieldConfiguration)) continue;
-        if (await processNestedFields(object, nestedFieldConfiguration, addedIds)) changed = true;
+        if (await processNestedFields(object, nestedFieldConfiguration, indexerSettings, addedIds)) changed = true;
     }
 
     return changed;
@@ -62,7 +66,7 @@ function isInConfiguredPool(object, nestedFieldConfiguration) {
     return false;
 }
 
-async function processNestedFields(object, nestedFieldConfiguration, addedIds) {
+async function processNestedFields(object, nestedFieldConfiguration, indexerSettings, addedIds) {
     const nestedFields = getFieldValues(
         object[object._objecttype],
         nestedFieldConfiguration.field_path
@@ -78,6 +82,7 @@ async function processNestedFields(object, nestedFieldConfiguration, addedIds) {
             nestedFieldConfiguration.id_field_name,
             nestedFieldConfiguration.base_fields?.map(field => field.field_name),
             nestedFieldConfiguration.pool_ids?.map(pool => pool.pool_id),
+            indexerSettings,
             addedIds
         )) changed = true;
     }
@@ -103,15 +108,15 @@ function getFieldValues(object, fieldPath) {
     }
 }
 
-async function addId(objectType, nestedFields, nestedField, nestedFieldPath, idFieldName, baseFieldNames, poolIds, addedIds) {
+async function addId(objectType, nestedFields, nestedField, nestedFieldPath, idFieldName, baseFieldNames, poolIds, indexerSettings, addedIds) {
     if (!idFieldName?.length
         || !baseFieldNames
         || baseFieldNames.find(baseFieldName => !nestedField[baseFieldName])
         || nestedField[idFieldName]
         || nestedField._uuid) return false;
 
     const newId = await getIdValue(
-        objectType, nestedFields, nestedField, nestedFieldPath, idFieldName, baseFieldNames, poolIds, addedIds
+        objectType, nestedFields, nestedField, nestedFieldPath, idFieldName, baseFieldNames, poolIds, indexerSettings, addedIds
     );
 
     nestedField[idFieldName] = newId;
@@ -121,7 +126,8 @@ async function addId(objectType, nestedFields, nestedField, nestedFieldPath, idF
     return true;
 }
 
-async function getIdValue(objectType, nestedFields, nestedField, nestedFieldPath, idFieldName, baseFieldNames, poolIds, addedIds) {
+async function getIdValue(objectType, nestedFields, nestedField, nestedFieldPath, idFieldName, baseFieldNames, poolIds, indexerSettings, addedIds) {
+    await assertIndexerIsFree(indexerSettings);
     const existingIdValues = await findExistingIdValues(
         objectType, nestedFields, nestedField, nestedFieldPath, idFieldName, baseFieldNames, poolIds, addedIds
     );
@@ -211,7 +217,7 @@ async function findOtherObjects(objectType, nestedField, nestedFieldPath, idFiel
                 )
             ) : result.objects;
     } catch (err) {
-        throwErrorToFrontend('Search request failed', JSON.stringify(err));
+        throwErrorToFrontend('Suchanfrage fehlgeschlagen', JSON.stringify(err));
     }
 }
 
@@ -236,12 +242,37 @@ function isDanteConcept(fieldValue) {
         && fieldValue.conceptURI !== undefined;
 }
 
-function throwErrorToFrontend(error, description) {
+async function assertIndexerIsFree(indexerSettings) {
+    if (!indexerSettings.maxNotIndexed) return;
+
+    const systemStatusData = await getSystemStatusData();
+    const totalNotIndexed = systemStatusData.Stats.total_not_indexed;
+    
+    if (totalNotIndexed > indexerSettings.maxNotIndexed) {
+        throwErrorToFrontend(indexerSettings.errorMessage, undefined, 'objectNotSaved');
+    }
+}
+
+async function getSystemStatusData() {
+    try {
+        const response = await fetch('http://fylr.localhost:8082/inspect/system/status/', {
+            method: 'GET',
+            headers: {
+                'Accept': 'application/json'
+            }
+        });
+        return await response.json();
+    } catch (err) {
+        throwErrorToFrontend('Systemstatus konnte nicht abgerufen werden', JSON.stringify(err));
+    }
+}
+
+function throwErrorToFrontend(error, description, realm) {
     console.log(JSON.stringify({
         error: {
             code: 'error.numericIdAutoIncrementer',
             statuscode: 400,
-            realm: 'api',
+            realm: realm ?? 'api',
             error,
             parameters: {},
             description