[service] Refactor ArcGISIdentityManager management

Author: newmanw

plugins/arcgis/service/src/ArcGISConfig.ts

@@ -8,26 +8,11 @@ export interface FeatureServiceConfig {
      */
     url: string
 
-    /**
-     * Username and password for ArcGIS authentication
-     */
-    auth?: ArcGISAuthConfig
-
-    /**
-     * Create layers that don't exist
-     */
-    createLayers?: boolean
-
-    /**
-     * The administration url to the arc feature service.
-     */
-    adminUrl?: string
-
-    /**
-     * Administration access token
-     */
-    adminToken?: string
-
+		/**
+		 * Serialized ArcGISIdentityManager
+		 */
+		identityManager: string
+		
     /**
      * The feature layers.
      */
@@ -49,10 +34,6 @@ export interface FeatureLayerConfig {
      */
     geometryType?: string
 
-    /**
-     * Access token
-     */
-    token?: string // TODO - can this be removed? Will Layers have a token too?
     /**
      * The event ids or names that sync to this arc feature layer.
      */
@@ -67,86 +48,8 @@ export interface FeatureLayerConfig {
      * Delete editable layer fields missing from form fields
      */
     deleteFields?: boolean
-
-}
-
-export enum AuthType {
-    Token = 'token',
-    UsernamePassword = 'usernamePassword',
-    OAuth = 'oauth'
-  }
-  
-
-/**
- * Contains token-based authentication configuration.
- */
-export interface TokenAuthConfig {
-    type: AuthType.Token
-    token: string
-    authTokenExpires?: string
-}
-
-/**
- * Contains username and password for ArcGIS server authentication.
- */
-export interface UsernamePasswordAuthConfig {
-    type: AuthType.UsernamePassword
-    /**
-     * The username for authentication.
-     */
-    username: string
-
-    /**
-     * The password for authentication.
-     */
-    password: string
 }
 
-/**
- * Contains OAuth authentication configuration.
- */
-export interface OAuthAuthConfig {
-
-    type: AuthType.OAuth
-
-    /**
-     * The Client Id for OAuth
-     */
-    clientId: string
-
-    /**
-     * The redirectUri for OAuth
-     */
-    redirectUri?: string
-
-    /**
-     * The temporary auth token for OAuth
-     */
-    authToken?: string
-
-    /**
-     * The expiration date for the temporary token
-     */
-    authTokenExpires?: number
-
-    /**
-     * The Refresh token for OAuth
-     */
-    refreshToken?: string
-
-    /**
-     * The expiration date for the Refresh token
-     */
-    refreshTokenExpires?: number
-}
-
-/**
- * Union type for authentication configurations.
- */
-export type ArcGISAuthConfig = 
-    | TokenAuthConfig
-    | UsernamePasswordAuthConfig
-    | OAuthAuthConfig
 
 /**
  * Attribute configurations

plugins/arcgis/service/src/ArcGISIdentityManagerFactory.ts

@@ -145,7 +145,7 @@ export const defaultArcGISPluginConfig = Object.freeze<ArcGISPluginConfig>({
   textAreaFieldLength: 256,
   observationIdField: 'description',
   idSeparator: '-',
-  // eventIdField: 'event_id',
+  eventIdField: 'event_id',
   lastEditedDateField: 'last_edited_date',
   eventNameField: 'event_name',
   userIdField: 'user_id',

plugins/arcgis/service/src/ArcGISPluginConfig.ts

@@ -0,0 +1,57 @@
+import { ArcGISIdentityManager } from '@esri/arcgis-rest-request'
+import { FeatureServiceConfig } from './ArcGISConfig'
+import { PluginStateRepository } from '@ngageoint/mage.service/lib/plugins.api'
+
+export interface ArcGISIdentityService {
+  getIdentityManager(featureService: FeatureServiceConfig): Promise<ArcGISIdentityManager>
+  updateIndentityManagers(): Promise<void>
+}
+
+export function createArcGISIdentityService(
+  stateRepo: PluginStateRepository<any>
+): ArcGISIdentityService {
+  const identityManagerCache: Map<string, Promise<ArcGISIdentityManager>> = new Map()
+
+  return {
+    async getIdentityManager(featureService: FeatureServiceConfig): Promise<ArcGISIdentityManager> {
+      let cached = await identityManagerCache.get(featureService.url)
+      if (!cached) {
+        const identityManager = ArcGISIdentityManager.deserialize(featureService.identityManager)
+        const promise = identityManager.getUser().then(() => identityManager)
+        identityManagerCache.set(featureService.url, promise)
+        return promise
+      } else {
+        return cached
+      }
+    },
+    async updateIndentityManagers() {
+      const config = await stateRepo.get()
+      for (let [url, persistedIdentityManagerPromise] of identityManagerCache) {
+        const persistedIdentityManager = await persistedIdentityManagerPromise
+        const featureService: FeatureServiceConfig | undefined = config.featureServices.find((service: FeatureServiceConfig) => service.url === url)
+        if (featureService) {
+          const identityManager = ArcGISIdentityManager.deserialize(featureService.identityManager)
+          if (identityManager.token !== persistedIdentityManager.token || identityManager.refreshToken !== persistedIdentityManager.refreshToken) {
+            featureService.identityManager = persistedIdentityManager.serialize()
+            await stateRepo.put(config)
+          }
+        }
+      }
+    }
+  }
+}
+
+export function getPortalUrl(featureService: FeatureServiceConfig | string): string {
+	const url = getFeatureServiceUrl(featureService)
+  return `https://${url.hostname}/arcgis/sharing/rest`
+}
+
+export function getServerUrl(featureService: FeatureServiceConfig | string): string {
+	const url = getFeatureServiceUrl(featureService)
+  return `https://${url.hostname}/arcgis`
+}
+
+export function getFeatureServiceUrl(featureService: FeatureServiceConfig | string): URL {
+  const url = typeof featureService === 'string' ? featureService : featureService.url
+  return new URL(url)
+}

plugins/arcgis/service/src/ArcGISService.ts

@@ -106,15 +106,19 @@ export class FeatureQuerier {
         queryUrl.searchParams.set('outFields', this.outFields([field]));
         queryUrl.searchParams.set('returnGeometry', 'false');      
         this._console.info('ArcGIS query: ' + queryUrl)
- 
-        const queryResponse = await request(queryUrl.toString(), {
-            authentication: this._identityManager,
-            params: { f: 'json' }
 
-        });  
+        try {
+            const queryResponse = await request(queryUrl.toString(), {
+                authentication: this._identityManager,
+                params: { f: 'json' }
 
-        this._console.info('ArcGIS response for ' + queryUrl + ' ' + JSON.stringify(queryResponse, null, 2))
-        response(queryResponse as QueryObjectResult)
+            });  
+
+            this._console.info('ArcGIS response for ' + queryUrl + ' ' + JSON.stringify(queryResponse, null, 2))
+            response(queryResponse as QueryObjectResult)
+        } catch (err) {
+            console.error("could not query", err)
+        }
     }
 
     /**

plugins/arcgis/service/src/FeatureQuerier.ts

@@ -1,6 +1,3 @@
-import { LayerInfoResult } from "./LayerInfoResult";
-import { FeatureServiceResult } from "./FeatureServiceResult";
-import { getIdentityManager } from "./ArcGISIdentityManagerFactory"
 import { ArcGISIdentityManager, request } from "@esri/arcgis-rest-request"
 import { queryFeatures, applyEdits, IQueryFeaturesOptions } from "@esri/arcgis-rest-feature-service";
 import { FeatureServiceConfig } from "./ArcGISConfig";
@@ -10,30 +7,21 @@ import { FeatureServiceConfig } from "./ArcGISConfig";
  */
 export class FeatureService {
 
-	/**
-	 * Used to log messages.
-	 */
 	private _console: Console;
+  private _config: FeatureServiceConfig;
+  private _identityManager: ArcGISIdentityManager;
 
-    private _config: FeatureServiceConfig;
-    private _identityManager: ArcGISIdentityManager;
-
-	/**
-	 * Constructor.
-	 * @param console Used to log messages. 
-	 * @param token The access token.
-	 */
 	constructor(console: Console, config: FeatureServiceConfig, identityManager: ArcGISIdentityManager) {
-        this._config = config;
-        this._identityManager = identityManager;
+    this._config = config;
+    this._identityManager = identityManager;
 		this._console = console;
 	}
 
   // TODO this entire class is a Work in Progress and not used. Currently using @esri/arcgis-rest-request and not arcgis-rest-js.
   // By finishing this class, we can transition from low-level generic requests that leverage ArcGISIdentityManager for auth to higher-level strongly typed requests.
 
 
-    // Query features using arcgis-rest-js's queryFeatures
+  // Query features using arcgis-rest-js's queryFeatures
   async queryFeatureService(whereClause: string): Promise<any> {
     const queryParams = {
         url: this._config.url,