Clean up extensions approach

src/worker/vm/extensions/google.ts

@@ -1,10 +1,10 @@
 import * as BigQuery from '@google-cloud/bigquery'
 
-type DummyCloud = {
+export interface DummyCloud {
     bigquery: typeof BigQuery
 }
 
-type DummyGoogle = {
+export interface DummyGoogle {
     cloud: DummyCloud
 }
 

src/worker/vm/extensions/index.ts

@@ -0,0 +1,29 @@
+import { CacheExtension, ConsoleExtension, StorageExtension } from '@posthog/plugin-scaffold'
+import fetch, { RequestInfo, RequestInit, Response } from 'node-fetch'
+
+import { PluginConfig, PluginsServer } from '../../../types'
+import { createCache } from './cache'
+import { createConsole } from './console'
+import { createGoogle, DummyGoogle } from './google'
+import { createPosthog, DummyPostHog } from './posthog'
+import { createStorage } from './storage'
+
+export interface Extensions {
+    fetch: (url: RequestInfo, init?: RequestInit) => Promise<Response>
+    cache: CacheExtension
+    console: ConsoleExtension
+    google: DummyGoogle
+    posthog: DummyPostHog
+    storage: StorageExtension
+}
+
+export function createExtensions(server: PluginsServer, pluginConfig: PluginConfig): Extensions {
+    return {
+        fetch: async (url, init) => await fetch(url, init),
+        cache: createCache(server, pluginConfig.plugin_id, pluginConfig.team_id),
+        console: createConsole(),
+        google: createGoogle(),
+        posthog: createPosthog(server, pluginConfig),
+        storage: createStorage(server, pluginConfig),
+    }
+}

src/worker/vm/vm.ts

@@ -3,6 +3,7 @@ import fetch from 'node-fetch'
 import { VM } from 'vm2'
 
 import { PluginConfig, PluginConfigVMReponse, PluginsServer } from '../../types'
+import { createExtensions } from './extensions'
 import { createCache } from './extensions/cache'
 import { createConsole } from './extensions/console'
 import { createGoogle } from './extensions/google'
@@ -23,13 +24,10 @@ export async function createPluginConfigVM(
         sandbox: {},
     })
 
-    // Add PostHog utilities to virtual machine
-    vm.freeze(createConsole(), 'console')
-    vm.freeze(createPosthog(server, pluginConfig), 'posthog')
-
-    // Add non-PostHog utilities to virtual machine
-    vm.freeze(fetch, 'fetch')
-    vm.freeze(createGoogle(), 'google')
+    const extensions = createExtensions(server, pluginConfig)
+    for (const [key, extension] of Object.entries(extensions)) {
+        vm.freeze(extension, key) // Inject extensions as globals
+    }
 
     if (process.env.NODE_ENV === 'test') {
         vm.freeze(setTimeout, '__jestSetTimeout')
@@ -57,10 +55,9 @@ export async function createPluginConfigVM(
 
     vm.freeze(
         {
-            cache: createCache(server, pluginConfig.plugin_id, pluginConfig.team_id),
             config: pluginConfig.config,
             attachments: pluginConfig.attachments,
-            storage: createStorage(server, pluginConfig),
+            ...extensions, // Inject extensions into meta
         },
         '__pluginHostMeta'
     )

tests/plugins.test.ts

@@ -118,7 +118,11 @@ test('plugin meta has what it should have', async () => {
         'attachments',
         'cache',
         'config',
+        'console',
+        'fetch',
         'global',
+        'google',
+        'posthog',
         'storage',
     ])
     expect(returnedEvent!.properties!['attachments']).toEqual({

tests/postgres/vm.test.ts

@@ -600,7 +600,7 @@ test('fetch', async () => {
     }
 
     await vm.methods.processEvent(event)
-    expect(fetch).toHaveBeenCalledWith('https://google.com/results.json?query=fetched')
+    expect(fetch).toHaveBeenCalledWith('https://google.com/results.json?query=fetched', undefined)
 
     expect(event.properties).toEqual({ count: 2, query: 'bla', results: [true, true] })
 })