Fix observation sync issues (#236)

* Convert httpClient calls to @esri/arcgis-rest-request with ArcGISIdentityManager for authentication

* Fix addFields and deleteFields

* Fixed outFields and returnGeometry for query generation

* [service] prepend form name to all event form fields for clarity and to avoid ESRI column name conflicts

* [service] Fix check to determine if an observation sync to ESRI is a create or update

* [service] OAuth refresh token flow in work

* [service] Add IdentityManager to ObservationSender construction

* [service] Remove httpClient

* [service] fix FeatureQuerier response from request

* [service] Refactor ArcGISIdentityManager management

* draft changes

* [service] ArcGIS field names are lowercase, account for this when adding/removing fields

* Undo revert of FeatureQuerier

* [service] Remove HttpClient.ts, no longer used

* [service] updateConfig inner async methods await before we query

* [server] Attribute sync fix upon adding feature server

* [web/service] API update to include feature service authentication status

* [service] fix regression in token, username/password validation req parameter parsing

* [service] Clean up TODO comments

* [service] form field mapping need to account for form name and field name to avoid conflicts

* Reduce response logging that may cause confusion

* [service] include event forms in detecting config changes

* Merge develop

* [service] sync configured events instead of checking changes of all events. Store event ids instead of names

* [server] Fix query syntax error

* fix failing errors for observations

* [service] fix event deletion and firstRun logic

* fix issues with updates

* fix deletion issue

* fix required field issue

* update arcgis read me

---------

Co-authored-by: Rick Saccoccia <[email protected]>
Co-authored-by: William Newman <[email protected]>
Co-authored-by: Clinton Werth <[email protected]>

Author: 4 people

plugins/arcgis/README.md

@@ -1,5 +1,6 @@
 # Build with arcgis plugin
 
+This plugin allows for MAGE observation data to be passed to an Arcgis feature service.
 Follow the instructions in the root README. After completing the web-app package install and build in the 'Building from source' section:
 
 Build arcgis plugin:

plugins/arcgis/service/src/AddLayersRequest.ts

@@ -21,7 +21,6 @@ export interface Field {
     alias: string
     sqlType: string
     length: number
-    nullable: boolean
     editable: boolean
     domain?: string
     defaultValue?: any

plugins/arcgis/service/src/ArcGISConfig.ts

@@ -1,3 +1,5 @@
+import { MageEventId } from "@ngageoint/mage.service/lib/entities/events/entities.events"
+
 /**
  * Contains an arc feature service url and layers.
  */
@@ -9,8 +11,8 @@ export interface FeatureServiceConfig {
     url: string
 
     /**
-     * Serialized ArcGISIdentityManager
-     */
+    * Serialized ArcGISIdentityManager
+    */
     identityManager: string
 
     /**
@@ -35,9 +37,9 @@ export interface FeatureLayerConfig {
     geometryType?: string
 
     /**
-     * The event ids or names that sync to this arc feature layer.
+     * The event ids that sync to this arc feature layer.
      */
-    events?: (number|string)[]
+    eventIds?: MageEventId[]
 }
 
 

plugins/arcgis/service/src/EventDeletionHandler.ts

@@ -34,6 +34,10 @@ export class EventDeletionHandler {
         this._config = config;
     }
 
+    public updateConfig(newConfig: ArcGISPluginConfig): void {
+        this._config = newConfig;
+    }
+
     /**
      * 
      * @param activeEvents The current set of active events.
@@ -83,7 +87,7 @@ export class EventDeletionHandler {
     }
 
     /**
-     * Called when the query is finished.  It goes through the results and gathers all even Ids currently stored
+     * Called when the query is finished.  It goes through the results and gathers all event Ids currently stored
      * in the arc layer.  It then will remove any events from the arc layer that do not exist.
      * @param layerProcessor The feature layer processor.
      * @param result The returned results.

plugins/arcgis/service/src/EventLayerProcessorOrganizer.ts

@@ -19,7 +19,7 @@ export class EventLayerProcessorOrganizer {
         for (const event of events) {
             let syncProcessors = new Array<FeatureLayerProcessor>();
             for (const layerProcessor of layerProcessors) {
-                if (layerProcessor.layerInfo.hasEvent(event.name)) {
+                if (layerProcessor.layerInfo.hasEvent(event.id)) {
                     syncProcessors.push(layerProcessor);
                 }
             }

plugins/arcgis/service/src/FeatureLayerProcessor.ts

@@ -45,7 +45,7 @@ export class FeatureLayerProcessor {
     constructor(layerInfo: LayerInfo, config: ArcGISPluginConfig, identityManager: ArcGISIdentityManager, console: Console) {
         this.layerInfo = layerInfo;
         this.lastTimeStamp = 0;
-        this.featureQuerier = new FeatureQuerier(layerInfo, config, identityManager,console);
+        this.featureQuerier = new FeatureQuerier(layerInfo, config, identityManager, console);
         this._binner = new ObservationBinner(layerInfo, this.featureQuerier, config);
         this.sender = new ObservationsSender(layerInfo, config, identityManager, console);
     }
@@ -85,7 +85,7 @@ export class FeatureLayerProcessor {
 
         for (const arcObservation of observations.deletions) {
             if (this.layerInfo.geometryType == arcObservation.esriGeometryType) {
-                this.sender.sendDelete(Number(arcObservation.id));
+                this.sender.sendDelete(arcObservation.id);
             }
         }
     }

plugins/arcgis/service/src/FeatureQuerier.ts

@@ -1,7 +1,8 @@
 import { ArcGISPluginConfig } from "./ArcGISPluginConfig";
 import { LayerInfo } from "./LayerInfo";
 import { QueryObjectResult } from "./QueryObjectResult";
-import { ArcGISIdentityManager, request } from "@esri/arcgis-rest-request";
+import { ArcGISIdentityManager } from "@esri/arcgis-rest-request";
+import { queryFeatures } from '@esri/arcgis-rest-feature-service';
 
 /**
  * Performs various queries on observations for a specific arc feature layer.
@@ -52,22 +53,17 @@ export class FeatureQuerier {
      * @param geometry query the geometry, default is true
      */
     async queryObservation(observationId: string, response: (result: QueryObjectResult) => void, fields?: string[], geometry?: boolean) {
-        const queryUrl = new URL(this._url)
-        if (this._config.eventIdField == null) {
-            queryUrl.searchParams.set('where', `${this._config.observationIdField} LIKE '${observationId}${this._config.idSeparator}%'`);
-        } else {
-            queryUrl.searchParams.set('where', `${this._config.observationIdField} = ${observationId}`);
-        }
-        queryUrl.searchParams.set('outFields', this.outFields(fields))
-        queryUrl.searchParams.set('returnGeometry', geometry === false ? 'false' : 'true')
-        this._console.info('ArcGIS query: ' + queryUrl)
-
-        const queryResponse = await request(queryUrl.toString(), {
+        const where = !this._config.eventIdField 
+            ? `${this._config.observationIdField} LIKE '${observationId}${this._config.idSeparator}%'`
+            : `${this._config.observationIdField} = '${observationId}'`;
+        this._console.info('ArcGIS query observation: ' + this._url.toString() + where);
+        await queryFeatures({
+            url: this._url.toString(),
             authentication: this._identityManager,
-            params: { f: 'json' }
-        });
-
-        response(queryResponse as QueryObjectResult);
+            where,
+            returnGeometry: geometry,
+            outFields: fields?.length ? fields : '*'
+        }).then((queryResponse) => response(queryResponse as QueryObjectResult)).catch((error) => this._console.error('Error in FeatureQuerier.queryObservation :: ' + error));
     }
 
     /**
@@ -77,19 +73,14 @@ export class FeatureQuerier {
      * @param geometry query the geometry, default is true
      */
     async queryObservations(response: (result: QueryObjectResult) => void, fields?: string[], geometry?: boolean) {
-        const queryUrl = new URL(this._url)
-        queryUrl.searchParams.set('where', `${this._config.observationIdField} IS NOT NULL`);
-        queryUrl.searchParams.set('outFields', this.outFields(fields));
-        queryUrl.searchParams.set('returnGeometry', geometry === false ? 'false' : 'true');
-        
-        this._console.info('ArcGIS query: ' + queryUrl)
-
-        const queryResponse = await request(queryUrl.toString(), {
+        this._console.info('ArcGIS query observation: ' + this._url.toString());
+        await queryFeatures({
+            url: this._url.toString(),
             authentication: this._identityManager,
-            params: { f: 'json' }
-        });
-
-        response(queryResponse as QueryObjectResult);
+            where: `${this._config.observationIdField} IS NOT NULL`,
+            returnGeometry: geometry,
+            outFields: fields?.length ? fields : '*'
+        }).then((queryResponse) => response(queryResponse as QueryObjectResult)).catch((error) => this._console.error('Error in FeatureQuerier.queryObservations :: ' + error));
     }
 
     /**
@@ -98,37 +89,14 @@ export class FeatureQuerier {
      * @param field field to query
      */
     async queryDistinct(response: (result: QueryObjectResult) => void, field: string) {
-        const queryUrl = new URL(this._url);
-        queryUrl.searchParams.set('where', `${field} IS NOT NULL`);
-        queryUrl.searchParams.set('returnDistinctValues', 'true');
-        queryUrl.searchParams.set('outFields', this.outFields([field]));
-        queryUrl.searchParams.set('returnGeometry', 'false');      
-        this._console.info('ArcGIS query: ' + queryUrl)
-
-        try {
-            const queryResponse = await request(queryUrl.toString(), {
-                authentication: this._identityManager,
-                params: { f: 'json' }
-
-            });  
-
-            response(queryResponse as QueryObjectResult);
-        } catch (err) {
-            console.error("could not query", err)
-        }
-    }
-
-    /**
-     * Build the out fields query parameter
-     * @param fields query fields
-     * @returns out fields
-     */
-    private outFields(fields?: string[]): string {
-        if (fields != null && fields.length > 0) {
-            return fields.join(',');
-        } else {
-            return '*';
-        }
+        this._console.info('ArcGIS query observation: ' + this._url.toString());
+        await queryFeatures({
+            url: this._url.toString(),
+            authentication: this._identityManager,
+            where: `${field} IS NOT NULL`,
+            returnGeometry: false,
+            outFields: field ? [field] : '*',
+            returnDistinctValues: true
+        }).then((queryResponse) => response(queryResponse as QueryObjectResult)).catch((error) => this._console.error('Error in FeatureQuerier.queryDistinct :: ' + error));
     }
-
 }