Merge pull request #1227 from permaweb/jfrain99/dryrun-cache-config

fix(cu): add config vars for dryrun cache aprams

Author: jfrain99

servers/cu/README.md

@@ -145,6 +145,9 @@ There are a few environment variables that you can set. Besides
 - `DEFAULT_LOG_LEVEL`: the logging level to use (defaults to `debug`)
 - `LOG_CONFIG_PATH`: the path to the file used to dynamically set the logging level (see [here](#dynamically-change-the-log-level))
 - `HYDRATION_MODE_NONCE_LIMIT`: the maximum nonce difference for incoming dryruns vs their pending eval streams.
+- `DRY_RUN_DEFAULT_MAX_PROCESS_AGE`: the maximum age of process memory that is allowed
+to be retrieved from the dryrun cache.
+- `DRY_RUN_PROCESS_CACHE_TTL`: the TTL of the dryrun process memory cache.
   If a eval stream is more nonces behind than this limit, a 503 is returned.
 
 ## Tests

servers/cu/src/bootstrap.js

@@ -529,7 +529,9 @@ export const createApis = async (ctx) => {
           )
       ),
       logger: dryRunLogger
-    })
+    }),
+    DRY_RUN_DEFAULT_MAX_PROCESS_AGE: ctx.DRY_RUN_DEFAULT_MAX_PROCESS_AGE,
+    DRY_RUN_PROCESS_CACHE_TTL: ctx.DRY_RUN_PROCESS_CACHE_TTL
   })
 
   /**

servers/cu/src/config.js

@@ -179,7 +179,9 @@ const CONFIG_ENVS = {
     CHECKPONT_VALIDATION_THRESH: process.env.CHECKPONT_VALIDATION_THRESH || 0.75,
     CHECKPONT_VALIDATION_RETRIES: process.env.CHECKPONT_VALIDATION_RETRIES || 5,
     IGNORE_LOCAL_CHECKPOINTS: process.env.IGNORE_LOCAL_CHECKPOINTS === 'true',
-    HYDRATION_MODE_NONCE_LIMIT: process.env.HYDRATION_MODE_NONCE_LIMIT || 200
+    HYDRATION_MODE_NONCE_LIMIT: process.env.HYDRATION_MODE_NONCE_LIMIT || 200,
+    DRY_RUN_DEFAULT_MAX_PROCESS_AGE: process.env.DRY_RUN_DEFAULT_MAX_PROCESS_AGE || 100,
+    DRY_RUN_PROCESS_CACHE_TTL: process.env.DRY_RUN_PROCESS_CACHE_TTL || 2000
   },
   production: {
     MODE,
@@ -238,7 +240,9 @@ const CONFIG_ENVS = {
     CHECKPONT_VALIDATION_THRESH: process.env.CHECKPONT_VALIDATION_THRESH || 0.75,
     CHECKPONT_VALIDATION_RETRIES: process.env.CHECKPONT_VALIDATION_RETRIES || 5,
     IGNORE_LOCAL_CHECKPOINTS: process.env.IGNORE_LOCAL_CHECKPOINTS === 'true',
-    HYDRATION_MODE_NONCE_LIMIT: process.env.HYDRATION_MODE_NONCE_LIMIT || 200
+    HYDRATION_MODE_NONCE_LIMIT: process.env.HYDRATION_MODE_NONCE_LIMIT || 200,
+    DRY_RUN_DEFAULT_MAX_PROCESS_AGE: process.env.DRY_RUN_DEFAULT_MAX_PROCESS_AGE || 100,
+    DRY_RUN_PROCESS_CACHE_TTL: process.env.DRY_RUN_PROCESS_CACHE_TTL || 2000
   }
 }
 

servers/cu/src/domain/api/dryRun.js

@@ -9,7 +9,6 @@ import { loadModuleWith } from '../lib/loadModule.js'
 import { mapFrom } from '../utils.js'
 import { readStateWith } from './readState.js'
 
-const DEFAULT_MAX_PROCESS_AGE = 100
 /**
  * TODO: should this be an effect or shared util?
  * just keeping here for sake of locality for now
@@ -58,6 +57,8 @@ const TtlCache = ({ setTimeout, clearTimeout }) => {
  * @returns {ReadResult}
  */
 export function dryRunWith (env) {
+  const DRY_RUN_DEFAULT_MAX_PROCESS_AGE = env.DRY_RUN_DEFAULT_MAX_PROCESS_AGE
+  const DRY_RUN_PROCESS_CACHE_TTL = env.DRY_RUN_PROCESS_CACHE_TTL
   const logger = env.logger
   const loadMessageMeta = loadMessageMetaWith(env)
   const loadModule = loadModuleWith(env)
@@ -131,7 +132,7 @@ export function dryRunWith (env) {
            * the overhead of maintaining the map, timers, for the specified
            * age
            */
-          readStateCache.set(res.id, cached, 2000)
+          readStateCache.set(res.id, cached, DRY_RUN_PROCESS_CACHE_TTL)
           return res
         }),
         Resolved
@@ -157,7 +158,7 @@ export function dryRunWith (env) {
     return Resolved(ctx)
   }
 
-  return ({ processId, messageTxId, maxProcessAge = DEFAULT_MAX_PROCESS_AGE, dryRun }) => {
+  return ({ processId, messageTxId, maxProcessAge = DRY_RUN_DEFAULT_MAX_PROCESS_AGE, dryRun }) => {
     return of({ processId, messageTxId })
       .chain(loadMessageCtx)
       .chain(ensureProcessLoaded({ maxProcessAge }))

servers/cu/src/domain/model.js

@@ -253,7 +253,16 @@ export const domainConfigSchema = z.object({
    * will return a busy response.
    *
    */
-  HYDRATION_MODE_NONCE_LIMIT: positiveIntSchema
+  HYDRATION_MODE_NONCE_LIMIT: positiveIntSchema,
+  /**
+   * The default maximum age of a process that may be
+   * retrieved from the dry run cache.
+   */
+  DRY_RUN_DEFAULT_MAX_PROCESS_AGE: positiveIntSchema,
+  /**
+   * The TTL of the dry run process cache in milliseconds.
+   */
+  DRY_RUN_PROCESS_CACHE_TTL: positiveIntSchema
 })
 
 export const bufferSchema = z.any().refine(buffer => {