feat(studio): allow disabling file listeners for read-only deployments (

#242)

packages/studio-be/src/core/bpfs/cache-invalidators.ts

@@ -5,6 +5,7 @@ import { TYPES } from 'core/app/types'
 import { forceForwardSlashes } from 'core/misc/utils'
 import { inject, injectable, tagged } from 'inversify'
 import path from 'path'
+import yn from 'yn'
 
 export namespace CacheInvalidators {
   enum ChangeEventAction {
@@ -46,25 +47,30 @@ export namespace CacheInvalidators {
     install(objectCache: ObjectCache) {
       this.cache = objectCache
 
+      // Support for Read-only Deployments (ROD)
+      if (yn(process.env.CORE_DISABLE_FILE_LISTENERS)) {
+        return
+      }
+
       const foldersToWatch = [path.join(process.DATA_LOCATION, 'bots'), path.join(process.DATA_LOCATION, 'global')]
 
       const watcher = chokidar.watch(foldersToWatch, {
         ignoreInitial: true,
         ignorePermissionErrors: true,
-        ignored: (path) => path.includes('node_modules')
+        ignored: path => path.includes('node_modules')
       })
 
       watcher.on('add', this.handle)
       watcher.on('change', this.handle)
       watcher.on('unlink', this.handle)
-      watcher.on('error', (err) => this.logger.attachError(err).error('Watcher error'))
+      watcher.on('error', err => this.logger.attachError(err).error('Watcher error'))
     }
 
     async stop() {
       await this.watcher.stop()
     }
 
-    handle = async (file) => {
+    handle = async file => {
       if (!this.cache) {
         return
       }

packages/studio-be/src/typings/global.d.ts

@@ -208,6 +208,11 @@ declare interface BotpressEnvironmentVariables {
    */
   readonly BP_ENABLED_MODULES?: string
   readonly BP_DEBUG_SEGMENT?: boolean
+
+  /**
+   * Supports read-only deployments by allowing disabling file listeners
+   */
+  readonly CORE_DISABLE_FILE_LISTENERS?: boolean
 }
 
 interface IDebug {