Merge pull request #1568 from qtomlinson/qt/refactor_recompute

Rename upgrade/ provider to recompute/ and align terminology

Author: qtomlinson

app.ts

@@ -115,7 +115,7 @@ function createApp(config: AppConfig): App {
   const harvestQueue = config.harvest.queue()
   initializers.push(async () => harvestQueue.initialize())
 
-  const recomputeHandler = config.upgrade.service({ queue: config.upgrade.queue })
+  const recomputeHandler = config.recompute.service({ queue: config.recompute.queue })
   initializers.push(async () => recomputeHandler.initialize())
 
   const definitionService = createDefinitionService(

bin/config.ts

@@ -86,7 +86,7 @@ export interface AppConfig {
   definition: {
     store: () => DefinitionStore & Initializable
   }
-  upgrade: {
+  recompute: {
     queue: RecomputeQueueFactories<IQueue & Initializable>
     service: (options: { queue: RecomputeQueueFactories<IQueue & Initializable> }) => RecomputeHandler & Initializable
   }
@@ -173,9 +173,15 @@ export default {
   definition: {
     store: loadFactory(config.get('DEFINITION_STORE_PROVIDER') || 'file', 'definition')
   },
-  upgrade: {
-    queue: loadFactory(config.get('DEFINITION_UPGRADE_QUEUE_PROVIDER') || 'memory', 'upgrade.queue'),
-    service: loadFactory(config.get('DEFINITION_UPGRADE_PROVIDER') || 'versionCheck', 'upgrade.service')
+  recompute: {
+    queue: loadFactory(
+      config.get('DEFINITION_RECOMPUTE_QUEUE_PROVIDER') || config.get('DEFINITION_UPGRADE_QUEUE_PROVIDER') || 'memory',
+      'recompute.queue'
+    ),
+    service: loadFactory(
+      config.get('DEFINITION_RECOMPUTE_PROVIDER') || config.get('DEFINITION_UPGRADE_PROVIDER') || 'onDemand',
+      'recompute.service'
+    )
   },
   attachment: {
     store: loadFactory(config.get('ATTACHMENT_STORE_PROVIDER') || 'file', 'attachment')

business/definitionService.ts

@@ -470,13 +470,14 @@ export class DefinitionService {
    * Invalidate the definition for the identified component. This flushes any caches and pre-computed
    * results. The definition will be recomputed on or before the next use.
    */
-  invalidate(coordinates: EntityCoordinates | EntityCoordinates[]): Promise<void[]> {
+  invalidate(coordinates: EntityCoordinates | EntityCoordinates[]): Promise<undefined[]> {
     const coordinateList = Array.isArray(coordinates) ? coordinates : [coordinates]
     return Promise.all(
       coordinateList.map(
         throat(10, async (coordinates: EntityCoordinates) => {
           await this.definitionStore.delete(coordinates)
           await this.cache.delete(this._getCacheKey(coordinates))
+          return undefined
         })
       )
     )

providers/index.ts

@@ -13,15 +13,15 @@ import crawlerConfig from '../providers/harvest/crawlerConfig.ts'
 import crawlerQueueConfig from '../providers/harvest/crawlerQueueConfig.ts'
 import winstonConfig from '../providers/logging/winstonConfig.ts'
 import memoryQueue from '../providers/queueing/memoryQueue.ts'
+import recomputeAzureQueueConfig from '../providers/recompute/azureQueueConfig.ts'
+import recomputeMemoryQueueConfig from '../providers/recompute/memoryQueueConfig.ts'
+import recomputeHandler from '../providers/recompute/recomputeHandler.ts'
 import azureSearchConfig from '../providers/search/azureConfig.ts'
 import memorySearch from '../providers/search/memory.ts'
 import azblobConfig from '../providers/stores/azblobConfig.ts'
 import dispatchConfig from '../providers/stores/dispatchConfig.ts'
 import fileConfig from '../providers/stores/fileConfig.ts'
 import mongoConfig from '../providers/stores/mongoConfig.ts'
-import upgradeAzureQueueConfig from '../providers/upgrade/azureQueueConfig.ts'
-import upgradeMemoryQueueConfig from '../providers/upgrade/memoryQueueConfig.ts'
-import * as recomputeHandler from '../providers/upgrade/recomputeHandler.ts'
 import type { ICache } from './caching/index.js'
 import listBasedFilterConfig from './harvest/throttling/listBasedFilterConfig.ts'
 import type { Logger } from './logging/index.js'
@@ -72,14 +72,14 @@ export interface RecomputeQueueFactories<T = any> {
   compute: ProviderFactory<T>
 }
 
-/** Provider configuration for upgrade queue */
-export interface UpgradeQueueProviders {
+/** Provider configuration for recompute queue */
+export interface RecomputeQueueProviders {
   azure: RecomputeQueueFactories
   memory: RecomputeQueueFactories
 }
 
-/** Provider configuration for upgrade service */
-export interface UpgradeServiceProviders {
+/** Provider configuration for recompute service */
+export interface RecomputeServiceProviders {
   onDemand: ProviderFactory
   /** @deprecated TODO: remove in favor of onDemand */
   versionCheck: ProviderFactory
@@ -88,10 +88,10 @@ export interface UpgradeServiceProviders {
   upgradeQueue: ProviderFactory
 }
 
-/** Provider configuration for upgrade */
-export interface UpgradeProviders {
-  queue: UpgradeQueueProviders
-  service: UpgradeServiceProviders
+/** Provider configuration for recompute */
+export interface RecomputeProviders {
+  queue: RecomputeQueueProviders
+  service: RecomputeServiceProviders
 }
 
 /** Provider configuration for curation queue */
@@ -152,7 +152,7 @@ export interface Providers {
   search: SearchProviders
   caching: CachingProviders
   auth: AuthProviders
-  upgrade: UpgradeProviders
+  recompute: RecomputeProviders
   curation: CurationProviders
   harvest: HarvestProviders
 }
@@ -183,10 +183,10 @@ const providers: Providers = {
   auth: {
     github: githubAuthConfig
   },
-  upgrade: {
+  recompute: {
     queue: {
-      azure: upgradeAzureQueueConfig,
-      memory: upgradeMemoryQueueConfig
+      azure: recomputeAzureQueueConfig,
+      memory: recomputeMemoryQueueConfig
     },
     service: {
       onDemand: recomputeHandler.defaultFactory,