change plugin session injection style

alexpineda · alexpineda · commit 65037d39bf22 · 2023-11-10T02:08:57.000-05:00
diff --git a/esbuild.plugin-host.ts b/esbuild.plugin-host.ts
@@ -16,6 +16,6 @@ rmSync(OUTDIR, { recursive: true, force: true });
         minify: false,
         format: "esm",
         bundle: true,
-        
+        packages: 'external',
     });
 })();
diff --git a/package.json b/package.json
@@ -20,15 +20,28 @@
         "runtime": "yarn build:runtime && yarn serve:runtime",
         "build": "vite build -c vite.config.web.ts && yarn build:runtime"
     },
+    "files": [
+        "./types",
+        "./host",
+        "./ui",
+        "./src",
+        "package.json",
+        "README.md"
+      ],
+      "types": "./types/index.d.ts",
+      "exports": {
+        "./host/*": "./dist/host/*",
+        "./ui/*": "./dist/ui/*"
+      },
     "repository": {
         "type": "git",
-        "url": "git+https://github.com/imbateam-gg/titan-reactor.git"
+        "url": "git+https://github.com/alexpineda/titan-reactor.git"
     },
     "author": "Alex Pineda <alexpineda@fastmail.com>",
     "bugs": {
-        "url": "https://github.com/imbateam-gg/titan-reactor/issues"
+        "url": "https://github.com/alexpineda/titan-reactor/issues"
     },
-    "homepage": "https://github.com/imbateam-gg/titan-reactor#readme",
+    "homepage": "https://www.blacksheepwall.tv",
     "debug": {
         "env": {
             "VITE_DEV_SERVER_HOSTNAME": "127.0.0.1",
diff --git a/src/common/types/plugin.ts b/src/common/types/plugin.ts
@@ -1,6 +1,3 @@
-import { SessionVariables } from "@core/world/settings-session-store";
-import { WorldEvents } from "@core/world/world-events";
-import { TypeEmitterProxy } from "@utils/type-emitter";
 import { FieldDefinition } from "./fields";
 
 export type PluginConfig = Record<string, FieldDefinition>;
@@ -45,21 +42,6 @@ export interface PluginMetaData extends PluginPackage {
     }
 }
 
-/**
- * These are the injectable services that are available to plugins during a world session.
- */
-export interface Injectables {
-    /**
-     * Reactive setting values that apply to the active session only.
-     */
-    settings: SessionVariables;
-
-    /**
-     * World events that can be listened to and emitted.
-     */
-    events: TypeEmitterProxy<WorldEvents>;
-}
-
 /**
  * A plugin that executes in the main process.
  */
diff --git a/src/core/world/api-session.ts b/src/core/world/api-session.ts
@@ -30,12 +30,19 @@ export class ApiSession {
         this.#janitor = new Janitor();
 
         this.#events = new WeakRef( events );
-        this.#plugins = this.#janitor.mop( await createPluginSession( openBW, events ) );
-
-        this.#macros = this.#janitor.mop( createMacrosComposer( settings ) );
         const eventsProxy = this.#janitor.mop( new TypeEmitterProxy( events ) );
         const customEvents = this.#janitor.mop( new TypeEmitter() );
 
+        this.#plugins = this.#janitor.mop( await createPluginSession( openBW, events, {
+            settings: settings.vars,
+            events: eventsProxy,
+            customEvents,
+            game: gameTimeApi
+        } ) );
+
+        this.#macros = this.#janitor.mop( createMacrosComposer( settings ) );
+        
+
         this.#macros.macros.targets.setHandler( ":plugin", {
             action: ( action ) =>
                 this.#plugins.store.operate( action, ( path ) => path.slice( 1 ) ),
@@ -58,28 +65,14 @@ export class ApiSession {
         // which is not allowed WITHIN plugins since they are 3rd party, but ok in user macros and sandbox
         this.#macros.setContainer(
             mix( {
-                api: gameTimeApi,
+                game: gameTimeApi,
                 plugins: borrow( this.#plugins.store.vars ),
                 settings: borrow( settings.vars ),
                 events: eventsProxy,
                 customEvents,
             } )
         );
 
-        this.#janitor.mop(
-            this.native.injectApi(
-                mix(
-                    {
-                        settings: settings.vars,
-                        events: eventsProxy,
-                        customEvents,
-                    },
-                    gameTimeApi
-                )
-            ),
-            "native.injectApi"
-        );
-
         this.native.useTryCatchOnHooks =
             useSettingsStore.getState().data.utilities.debugMode;
         this.#janitor.mop(
diff --git a/src/core/world/create-plugin-session.ts b/src/core/world/create-plugin-session.ts
@@ -15,12 +15,14 @@ import { WorldEvents } from "./world-events";
 import { TypeEmitter, TypeEmitterProxy } from "@utils/type-emitter";
 import { normalizePluginConfiguration } from "@utils/function-utils";
 import { pluginsStore } from "@stores/plugins-store";
+import { PluginSessionContext } from "@plugins/plugin-base";
 
 export type PluginSession = Awaited<ReturnType<typeof createPluginSession>>;
 
 export const createPluginSession = async (
     openBW: OpenBW,
-    _events: TypeEmitter<WorldEvents>
+    _events: TypeEmitter<WorldEvents>,
+    sessionContext: PluginSessionContext
 ) => {
     const janitor = new Janitor( "PluginSession" );
 
@@ -41,7 +43,7 @@ export const createPluginSession = async (
     } );
 
     const nativePlugins = janitor.mop(
-        new PluginSystemNative(),
+        new PluginSystemNative(sessionContext),
         "nativePlugins"
     );
 
diff --git a/src/core/world/plugin-session-store.test.ts b/src/core/world/plugin-session-store.test.ts
@@ -6,6 +6,7 @@ import { log } from "@ipc/log";
 import { PluginSystemNative } from "@plugins/plugin-system-native";
 import { PluginMetaData } from "common/types";
 import { PluginSystemUI } from "@plugins/plugin-system-ui";
+import { PluginSessionContext } from "@plugins/plugin-base";
 
 jest.mock( "@ipc/log" );
 jest.mock( "@core/global-events" );
@@ -44,6 +45,7 @@ const createBasePlugin = ( _package?: Partial<PluginMetaData> ) => {
     };
 
     const plugins = new PluginSystemNative(
+        {} as PluginSessionContext
         // [pluginPackage as unknown as PluginMetaData],
         // () => {},
         // () => {}
diff --git a/src/core/world/view-controller-composer.ts b/src/core/world/view-controller-composer.ts
@@ -5,7 +5,7 @@ import { DamageType, Explosion } from "common/enums";
 import { PerspectiveCamera, Vector3 } from "three";
 import { GameViewPort } from "../../camera/game-viewport";
 import { World } from "./world";
-import { SceneController } from "@plugins/scene-controller";
+import type { SceneController } from "@plugins/scene-controller";
 import { easeInCubic } from "@utils/function-utils";
 import range from "common/utils/range";
 import { mixer } from "@audio/main-mixer";
diff --git a/src/plugins/plugin-base.ts b/src/plugins/plugin-base.ts
@@ -1,39 +1,53 @@
 import type { GameTimeApi } from "@core/world/game-time-api";
 import type {
     FieldDefinition,
-    Injectables,
     NativePlugin,
     PluginConfig,
     PluginPackage,
 } from "common/types";
-
-import { log } from "@ipc/log";
 // import { savePluginsConfig } from "renderer/command-center/ipc/plugins";
 import { normalizePluginConfiguration } from "@utils/function-utils";
+import type { SessionVariables } from "@core/world/settings-session-store";
+import type { TypeEmitter, TypeEmitterProxy } from "@utils/type-emitter";
+import type { WorldEvents } from "@core/world/world-events";
 
 const structuredClone =
     // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
     globalThis.structuredClone ??
     ( ( x: any ) => JSON.parse( JSON.stringify( x ) ) as unknown );
 
-export interface PluginBase extends NativePlugin, GameTimeApi, Injectables {}
+export interface PluginBase extends NativePlugin, GameTimeApi {}
+
+export type PluginSessionContext = {
+    game: GameTimeApi;
+    settings: SessionVariables;
+    events: TypeEmitterProxy<WorldEvents>;
+    customEvents: TypeEmitter<unknown>;
+}
 
-export class PluginBase {
+export class PluginBase implements PluginBase {
     readonly id: string;
     readonly name: string;
     isSceneController = false;
     #config: PluginConfig = {};
 
+    game: GameTimeApi;
+    settings: SessionVariables;
+    events: TypeEmitterProxy<WorldEvents>;
+
     /**
      * @internal
      * Same as config but simplified to [key] = value
      */
     #normalizedConfig: Record<string, unknown> = {};
 
-    constructor( pluginPackage: PluginPackage ) {
+    constructor( pluginPackage: PluginPackage, opts: PluginSessionContext ) {
         this.id = pluginPackage.id;
         this.name = pluginPackage.name;
         this.rawConfig = structuredClone( pluginPackage.config ?? {} );
+        this.game = opts.game;
+        this.settings = opts.settings;
+        this.events = opts.events;
     }
 
     sendUIMessage: ( message: any ) => void = () => {};
@@ -48,7 +62,7 @@ export class PluginBase {
      */
     saveConfigProperty( key: string, value: unknown, persist = true ): void {
         if ( !( key in this.#config ) ) {
-            log.warn(
+            console.warn(
                 `Plugin ${this.id} tried to set config key ${key} but it was not found`
             );
             return undefined;
diff --git a/src/plugins/plugin-system-native.ts b/src/plugins/plugin-system-native.ts
@@ -7,11 +7,11 @@ import { withErrorMessage } from "common/utils/with-error-message";
 import { UI_SYSTEM_CUSTOM_MESSAGE } from "./events";
 import throttle from "lodash.throttle";
 import { Janitor } from "three-janitor";
-import { mix } from "@utils/object-utils";
 import { log } from "@ipc/log";
-import { PluginBase } from "./plugin-base";
+import { PluginBase, PluginSessionContext } from "./plugin-base";
 import { SceneController, VRSceneController } from "./scene-controller";
 import lSet from "lodash.set";
+import { mix } from "@utils/object-utils";
 
 type PluginsConfigSnapshot = Record<
     string,
@@ -28,6 +28,7 @@ export class PluginSystemNative {
 
     #sendCustomUIMessage!: (pluginId: string, message: any) => void;
     #compartments = new WeakMap<PluginBase, { globalThis: object }>();
+    #sessionContext: PluginSessionContext;
 
     /**
      * Error trapping is signficantly slower than not using it.
@@ -43,29 +44,36 @@ export class PluginSystemNative {
         return this.#plugins.reduce.bind(this.#plugins);
     }
 
+    constructor( sessionContext: PluginSessionContext ) {
+        this.#sessionContext = sessionContext;
+    }
+
     async activatePlugin(
         pluginPackage: PluginMetaData,
         createCompartment: (env: unknown) => {
             globalThis: {
                 Function: (...args: any[]) => () => object | PluginBase;
             };
-        }
+        },
+        sessionContext: PluginSessionContext
     ) {
 
+        //todo: remove this
         const compartment = createCompartment({
             PluginBase,
             SceneController,
             VRSceneController,
         });
 
         try {
-            const Plugin = await import(/* @vite-ignore */ pluginPackage.urls.host! );
+            const Plugin = await import(/* @vite-ignore */pluginPackage.urls.host! );
 
             if (!Plugin) {
                 throw new Error("Plugin constructor must extend PluginBase");
             }
 
-            const plugin = new Plugin.default(pluginPackage);
+            const plugin = new Plugin.default(pluginPackage, sessionContext);
+            mix(plugin, sessionContext.game);
 
             plugin.isSceneController = pluginPackage.isSceneController;
 
@@ -95,12 +103,12 @@ export class PluginSystemNative {
     async init(
         pluginPackages: PluginMetaData[],
         msg: (id: string, message: any) => void,
-        createCompartment: (env: any) => any
+        createCompartment: (env: any) => any,
     ) {
 
         log.debug(`@plugin-system-native: init`);
         for (const pkg of pluginPackages) {
-            const plugin = await this.activatePlugin(pkg, createCompartment);
+            const plugin = await this.activatePlugin(pkg, createCompartment, this.#sessionContext);
             if (plugin) {
                 this.#plugins.push(plugin);
             }
@@ -231,8 +239,9 @@ export class PluginSystemNative {
         pluginPackages: PluginMetaData[],
         createCompartment: (env: any) => any
     ) {
+        
         const additionalPlugins = pluginPackages
-            .map((p) => this.activatePlugin(p, createCompartment))
+            .map((p) => this.activatePlugin(p, createCompartment, this.#sessionContext))
             .filter(Boolean);
 
         this.#plugins = [...this.#plugins, ...additionalPlugins] as PluginBase[];
@@ -241,17 +250,16 @@ export class PluginSystemNative {
     /**
      * Temporarily inject an api into all active plugins.
      */
-    injectApi(object: object) {
-        mix(PluginBase.prototype, object);
-        const keys = Object.keys(object);
-
-        return () => {
-            keys.forEach((key) => {
-                // eslint-disable-next-line @typescript-eslint/no-dynamic-delete
-                delete PluginBase.prototype[key as keyof typeof PluginBase.prototype];
-            });
-        };
-    }
+    // injectApi(object: object) {
+    //     const keys = Object.keys(object);
+
+    //     return () => {
+    //         keys.forEach((key) => {
+    //             // eslint-disable-next-line @typescript-eslint/no-dynamic-delete
+    //             delete PluginBase.prototype[key as keyof typeof PluginBase.prototype];
+    //         });
+    //     };
+    // }
 
     getConfigSnapshot() {
         return this.#plugins.reduce((acc, plugin) => {
diff --git a/src/plugins/scene-controller.ts b/src/plugins/scene-controller.ts
diff --git a/src/utils/function-utils.ts b/src/utils/function-utils.ts
diff --git a/vite.config.web.ts b/vite.config.web.ts
