wip remote cache

factorialco · Dec 4, 2024 · 2ecdb6d · 2ecdb6d
1 parent d39eef7
commit 2ecdb6d
Show file tree

Hide file tree

Showing 6 changed files with 360 additions and 93 deletions.
diff --git a/shadowdog.json b/shadowdog.json
@@ -2,16 +2,10 @@
   "$schema": "./src/config/schema.json",
   "plugins": [
     {
-      "name": "shadowdog-rake"
-    },
-    {
-      "name": "shadowdog-local-cache",
+      "name": "shadowdog-remote-aws-s3-cache",
       "options": {
-        "boira": true
+        "bucketName": "workspaces.factorial.co"
       }
-    },
-    {
-      "name": "shadowdog-tag"
     }
   ],
   "cache": {
@@ -31,14 +25,6 @@
           "command": "npm run build-schema"
         }
       ]
-    },
-    {
-      "files": [],
-      "commands": [
-        {
-          "command": "echo 'hello shadowdog'"
-        }
-      ]
     }
   ]
 }
diff --git a/src/config/schema.json b/src/config/schema.json
@@ -26,7 +26,12 @@
         "properties": {
           "name": {
             "type": "string",
-            "enum": ["shadowdog-rake", "shadowdog-local-cache", "shadowdog-tag"]
+            "enum": [
+              "shadowdog-rake",
+              "shadowdog-local-cache",
+              "shadowdog-remote-aws-s3-cache",
+              "shadowdog-tag"
+            ]
           },
           "options": {}
         },

diff --git a/src/daemon.ts b/src/daemon.ts
@@ -106,8 +106,8 @@ const setupWatchers = (config: ConfigFile) => {
               watcherConfig.commands.map(async (commandConfig) => {
                 const taskRunner = new TaskRunner(watcherConfig, commandConfig)
 
-                filterMiddlewarePlugins(config.plugins).forEach((pluginFn) => {
-                  taskRunner.use(pluginFn.middleware)
+                filterMiddlewarePlugins(config.plugins).forEach(({ pluginFn, pluginOptions }) => {
+                  taskRunner.use(pluginFn.middleware, pluginOptions)
                 })
 
                 taskRunner.use(() => {
@@ -210,8 +210,6 @@ const watchFiles = async (configFilePath: string) => {
 
   fs.mkdirpSync(currentConfig.cache.path)
 
-  // const client = currentConfig.cache.enabled ? createClient() : null
-
   const configWatcher = chokidar.watch(configFilePath, {
     ignoreInitial: true,
   })

diff --git a/src/generate.ts b/src/generate.ts
@@ -49,12 +49,10 @@ const processLayer = async (watcherConfigs: WatcherConfig[], config: ConfigFile)
 
   return Promise.all(
     commandsToRun.map(async ({ watcherConfig, commandConfig }) => {
-      // TODO: refactor
       const taskRunner = new TaskRunner(watcherConfig, commandConfig)
 
-      // TODO: get options
-      filterMiddlewarePlugins(config.plugins).forEach((pluginFn) => {
-        taskRunner.use(pluginFn.middleware)
+      filterMiddlewarePlugins(config.plugins).forEach(({ pluginFn, pluginOptions }) => {
+        taskRunner.use(pluginFn.middleware, pluginOptions)
       })
 
       taskRunner.use(() => {
@@ -80,7 +78,7 @@ export const generate = async (configFilePath: string) => {
   for (const [i, watcherConfigs] of sortedWatchers.entries()) {
     logMessage(`🎛️ Running layer ${i + 1} of ${sortedWatchers.length}:`)
     const activeWatchers = plugins.reduce(
-      (watchers, plugin) => plugin.command(watchers),
+      (watchers, { pluginFn }) => pluginFn.command(watchers),
       watcherConfigs,
     )
     await processLayer(activeWatchers, config)

diff --git a/src/plugins/index.ts b/src/plugins/index.ts
@@ -3,6 +3,7 @@ import { CommandConfig, PluginsConfig, WatcherConfig } from '../config'
 import shadowdogLocalCache from './shadowdog-local-cache'
 import shadowdogRake from './shadowdog-rake'
 import shadowdogTag from './shadowdog-tag'
+import shadowdogRemoteAwsS3Cache from './shadowdog-remote-aws-s3-cache'
 
 export type Command = (activeWatchers: WatcherConfig[]) => WatcherConfig[]
 
@@ -18,13 +19,19 @@ export type Middleware<Options = any> = (control: {
 type MiddlewarePlugin = { middleware: Middleware }
 type CommandPlugin = { command: Command }
 
-export const PluginNameEnum = z.enum(['shadowdog-rake', 'shadowdog-local-cache', 'shadowdog-tag'])
+export const PluginNameEnum = z.enum([
+  'shadowdog-rake',
+  'shadowdog-local-cache',
+  'shadowdog-remote-aws-s3-cache',
+  'shadowdog-tag',
+])
 
 type PluginName = z.infer<typeof PluginNameEnum>
 
 const PLUGINS_MAP: Record<PluginName, MiddlewarePlugin | CommandPlugin> = {
   'shadowdog-rake': shadowdogRake,
   'shadowdog-local-cache': shadowdogLocalCache,
+  'shadowdog-remote-aws-s3-cache': shadowdogRemoteAwsS3Cache,
   'shadowdog-tag': shadowdogTag,
 } as const
 
@@ -35,15 +42,23 @@ const filterUsedPlugins = (pluginsConfig: PluginsConfig) =>
         .map((pluginSettings) => pluginSettings.name)
         .includes(pluginName as PluginName)
     })
-    .map(([, pluginFn]) => pluginFn)
+    .map(([pluginName, pluginFn]) => ({
+      pluginFn,
+      pluginOptions: pluginsConfig.find((plugin) => plugin.name === pluginName)?.options,
+    }))
 
-// TODO: return options
 export const filterMiddlewarePlugins = (pluginsConfig: PluginsConfig) => {
-  return filterUsedPlugins(pluginsConfig).filter((pluginFn) => 'middleware' in pluginFn)
+  return filterUsedPlugins(pluginsConfig).filter(
+    (pluginData): pluginData is { pluginFn: MiddlewarePlugin; pluginOptions: unknown } =>
+      'middleware' in pluginData.pluginFn,
+  )
 }
 
 export const filterCommandPlugins = (pluginsConfig: PluginsConfig) => {
-  return filterUsedPlugins(pluginsConfig).filter((pluginFn) => 'command' in pluginFn)
+  return filterUsedPlugins(pluginsConfig).filter(
+    (pluginData): pluginData is { pluginFn: CommandPlugin; pluginOptions: unknown } =>
+      'command' in pluginData.pluginFn,
+  )
 }
 
 export default PLUGINS_MAP