Merge pull request #1614 from polywrap/nk/refactor-env-plugin-ts

refactor(plugin-js): move env to plugin method params
polywrap · Mar 15, 2023 · 7833bcd · 7833bcd
2 parents 7f433da + 7d200b0
commit 7833bcd
Show file tree

Hide file tree

Showing 30 changed files with 187 additions and 124 deletions.
diff --git a/packages/cli/src/__tests__/e2e/build.plugin.spec.ts b/packages/cli/src/__tests__/e2e/build.plugin.spec.ts
@@ -38,7 +38,6 @@ describe("e2e tests for build command - plugin project", () => {
         }, {
           cwd: testCaseDir,
         });
-
         testCliOutput(testCaseDir, code, output, error);
         testBuildOutput(testCaseDir, buildDir);
       });

diff --git a/packages/js/client-config-builder/README.md b/packages/js/client-config-builder/README.md
@@ -484,7 +484,7 @@ export const uriResolverExts: UriResolverExtBootloader = [
 
 interface IDefaultPlugin {
   uri: Uri;
-  plugin: PluginPackage<unknown>;
+  plugin: IWrapPackage;
   implements: Uri[];
 }
 

diff --git a/packages/js/client-config-builder/package.json b/packages/js/client-config-builder/package.json
@@ -29,7 +29,6 @@
     "@polywrap/file-system-plugin-js": "~0.10.0-pre",
     "@polywrap/http-plugin-js": "~0.10.0-pre",
     "@polywrap/logger-plugin-js": "0.10.0-pre.10",
-    "@polywrap/plugin-js": "0.10.0-pre.12",
     "@polywrap/uri-resolver-extensions-js": "0.10.0-pre.12",
     "@polywrap/uri-resolvers-js": "0.10.0-pre.12",
     "@polywrap/wasm-js": "0.10.0-pre.12",

diff --git a/packages/js/client-config-builder/src/bundles/default.ts b/packages/js/client-config-builder/src/bundles/default.ts
@@ -4,7 +4,6 @@ import * as ipfsHttpClient from "./embeds/ipfs-http-client/wrap";
 import * as ipfsResolver from "./embeds/async-ipfs-resolver/wrap";
 
 import { IWrapPackage, Uri } from "@polywrap/core-js";
-import { PluginPackage } from "@polywrap/plugin-js";
 import {
   ethereumProviderPlugin,
   Connection,
@@ -64,7 +63,7 @@ export const uriResolverExts: UriResolverExtBootloader = [
 
 interface IDefaultPlugin {
   uri: Uri;
-  plugin: PluginPackage<unknown>;
+  plugin: IWrapPackage;
   implements: Uri[];
 }
 

diff --git a/packages/js/client/src/__tests__/core/wrap-features/env-case.ts b/packages/js/client/src/__tests__/core/wrap-features/env-case.ts
@@ -205,9 +205,9 @@ export const envTestCases = (implementation: string) => {
         resolver: RecursiveResolver.from([
           {
             uri: implementationUri,
-            package: PluginPackage.from<MockEnv>((module) => ({
-              mockEnv: (): MockEnv => {
-                return module.env;
+            package: PluginPackage.from<MockEnv>(() => ({
+              mockEnv: (_, __, env: MockEnv): MockEnv => {
+                return env;
               },
             })),
           },

diff --git a/packages/js/client/src/__tests__/helpers.ts b/packages/js/client/src/__tests__/helpers.ts
@@ -46,8 +46,8 @@ export const mockPluginRegistration = (uri: string | Uri) => {
       methodThatThrows: (_: unknown): string => {
         throw Error("I'm throwing!");
       },
-      mockEnv(): { a: number } & Record<string, unknown> {
-        return this.env;
+      mockEnv(_, __, env): { a: number } & Record<string, unknown> {
+        return env as unknown as { a: number } & Record<string, unknown>;
       },
     })),
   };

diff --git a/packages/js/plugin/package.json b/packages/js/plugin/package.json
@@ -25,6 +25,9 @@
     "@polywrap/tracing-js": "0.10.0-pre.12",
     "@polywrap/wrap-manifest-types-js": "0.10.0-pre.12"
   },
+  "peerDependencies": {
+    "@polywrap/core-js": "0.10.x"
+  },
   "devDependencies": {
     "@types/jest": "26.0.8",
     "jest": "26.6.3",

diff --git a/packages/js/plugin/src/PluginMethod.ts b/packages/js/plugin/src/PluginMethod.ts
@@ -11,5 +11,6 @@ import { CoreClient, MaybeAsync } from "@polywrap/core-js";
  */
 export type PluginMethod<
   TArgs extends Record<string, unknown> = Record<string, unknown>,
-  TResult = unknown
-> = (args: TArgs, client: CoreClient) => MaybeAsync<TResult>;
+  TResult = unknown,
+  TEnv extends Record<string, unknown> = Record<string, unknown>
+> = (args: TArgs, client: CoreClient, env: TEnv) => MaybeAsync<TResult>;
diff --git a/packages/js/plugin/src/PluginModule.ts b/packages/js/plugin/src/PluginModule.ts
@@ -8,34 +8,26 @@ export abstract class PluginModule<
   TConfig,
   TEnv extends Record<string, unknown> = Record<string, unknown>
 > {
-  private _env: TEnv;
   private _config: TConfig;
 
   constructor(config: TConfig) {
     this._config = config;
   }
 
-  public get env(): TEnv {
-    return this._env;
-  }
-
   public get config(): TConfig {
     return this._config;
   }
 
-  public setEnv(env: TEnv): void {
-    this._env = env;
-  }
-
   public async _wrap_invoke<
     TArgs extends Record<string, unknown> = Record<string, unknown>,
     TResult = unknown
   >(
     method: string,
     args: TArgs,
-    client: CoreClient
+    client: CoreClient,
+    env: TEnv
   ): Promise<Result<TResult, Error>> {
-    const fn = this.getMethod<TArgs, TResult>(method);
+    const fn = this.getMethod<TArgs, TResult, TEnv>(method);
 
     if (!fn) {
       return ResultErr(Error(`Plugin missing method "${method}"`));
@@ -48,7 +40,7 @@ export abstract class PluginModule<
     }
 
     try {
-      const data = await fn(args, client);
+      const data = await fn(args, client, env);
       return ResultOk(data);
     } catch (e) {
       e.code = WrapErrorCode.WRAPPER_INVOKE_ABORTED;
@@ -58,13 +50,14 @@ export abstract class PluginModule<
 
   public getMethod<
     TArgs extends Record<string, unknown> = Record<string, unknown>,
-    TResult = unknown
+    TResult = unknown,
+    TEnv extends Record<string, unknown> = Record<string, unknown>
   >(method: string): PluginMethod<TArgs, TResult> | undefined {
     const fn:
-      | PluginMethod<TArgs, TResult>
+      | PluginMethod<TArgs, TResult, TEnv>
       | undefined = ((this as unknown) as Record<
       string,
-      PluginMethod<TArgs, TResult>
+      PluginMethod<TArgs, TResult, TEnv>
     >)[method];
 
     return fn?.bind(this);

diff --git a/packages/js/plugin/src/PluginPackage.ts b/packages/js/plugin/src/PluginPackage.ts
@@ -19,7 +19,7 @@ export class PluginPackage<
     TConfig,
     TEnv extends Record<string, unknown> = Record<string, unknown>
   >(
-    pluginModule: PluginModule<TConfig>,
+    pluginModule: PluginModule<TConfig, TEnv>,
     manifest?: WrapManifest
   ): PluginPackage<TConfig, TEnv>;
   static from<TEnv extends Record<string, unknown> = Record<string, unknown>>(
@@ -31,15 +31,15 @@ export class PluginPackage<
     TEnv extends Record<string, unknown> = Record<string, unknown>
   >(
     pluginModuleOrGetPluginFuncs:
-      | PluginModule<TConfig>
+      | PluginModule<TConfig, TEnv>
       | GetPluginMethodsFunc<TEnv>,
     manifest?: WrapManifest
   ): PluginPackage<TConfig, TEnv> {
     if (typeof pluginModuleOrGetPluginFuncs === "function") {
-      const getPluginFuncs = pluginModuleOrGetPluginFuncs as GetPluginMethodsFunc<TEnv>;
+      const getPluginFuncs = pluginModuleOrGetPluginFuncs as GetPluginMethodsFunc;
 
       return new PluginPackage<TConfig, TEnv>(
-        new PluginModuleWithMethods<TEnv>(getPluginFuncs),
+        new PluginModuleWithMethods(getPluginFuncs),
         manifest || ({} as WrapManifest)
       ) as PluginPackage<TConfig, TEnv>;
     } else {

diff --git a/packages/js/plugin/src/PluginWrapper.ts b/packages/js/plugin/src/PluginWrapper.ts
@@ -49,8 +49,12 @@ export class PluginWrapper implements Wrapper {
       return ResultErr(error);
     }
 
-    // Set the module's environment
-    this._module.setEnv(options.env || {});
+    // NOTE: this is used just in case the module instance
+    //       we're interacting with is from versions < 0.10
+    const genericModule = (this._module as unknown) as Record<string, unknown>;
+    if (genericModule.setEnv) {
+      (genericModule.setEnv as (env: unknown) => void)(options.env || {});
+    }
 
     let jsArgs: Record<string, unknown>;
 
@@ -77,7 +81,12 @@ export class PluginWrapper implements Wrapper {
     }
 
     // Invoke the function
-    const result = await this._module._wrap_invoke(method, jsArgs, client);
+    const result = await this._module._wrap_invoke(
+      method,
+      jsArgs,
+      client,
+      options.env || {}
+    );
 
     if (result.ok) {
       const data = result.value;

diff --git a/packages/js/plugin/src/utils/GetPluginMethodsFunc.ts b/packages/js/plugin/src/utils/GetPluginMethodsFunc.ts
@@ -4,4 +4,7 @@ export type GetPluginMethodsFunc<
   TEnv extends Record<string, unknown> = Record<string, unknown>
 > = (
   module: PluginModule<never, TEnv>
-) => Record<string, PluginMethod<Record<string, unknown>, unknown>>;
+) => Record<
+  string,
+  PluginMethod<Record<string, unknown>, unknown, Record<string, unknown>>
+>;
diff --git a/packages/js/plugin/src/utils/PluginModuleWithMethods.ts b/packages/js/plugin/src/utils/PluginModuleWithMethods.ts
@@ -20,7 +20,8 @@ export class PluginModuleWithMethods<
   >(
     method: string,
     args: TArgs,
-    client: CoreClient
+    client: CoreClient,
+    env: TEnv
   ): Promise<Result<TResult, Error>> {
     const fn = this.getMethod<TArgs, TResult>(method);
 
@@ -35,7 +36,7 @@ export class PluginModuleWithMethods<
     }
 
     try {
-      const data = await fn(args, client);
+      const data = await fn(args, client, env);
       return ResultOk(data);
     } catch (e) {
       e.code = WrapErrorCode.WRAPPER_INVOKE_ABORTED;
@@ -47,9 +48,13 @@ export class PluginModuleWithMethods<
     TArgs extends Record<string, unknown> = Record<string, unknown>,
     TResult = unknown
   >(method: string): PluginMethod<TArgs, TResult> | undefined {
-    const fn: PluginMethod<TArgs, TResult> | undefined = this._getPluginMethods(
-      this
-    )[method] as PluginMethod<TArgs, TResult>;
+    const fn:
+      | PluginMethod<TArgs, TResult, TEnv>
+      | undefined = this._getPluginMethods(this)[method] as PluginMethod<
+      TArgs,
+      TResult,
+      TEnv
+    >;
 
     return fn?.bind(this);
   }

diff --git a/packages/js/wasm/package.json b/packages/js/wasm/package.json
@@ -26,6 +26,9 @@
     "@polywrap/tracing-js": "0.10.0-pre.12",
     "@polywrap/wrap-manifest-types-js": "0.10.0-pre.12"
   },
+  "peerDependencies": {
+    "@polywrap/core-js": "0.10.x"
+  },
   "devDependencies": {
     "@polywrap/cli-js": "0.10.0-pre.12",
     "@types/jest": "26.0.8",

diff --git a/packages/schema/bind/src/bindings/typescript/plugin/templates/module-ts.mustache b/packages/schema/bind/src/bindings/typescript/plugin/templates/module-ts.mustache
@@ -23,7 +23,8 @@ export abstract class Module<TConfig> extends PluginModule<TConfig{{#envType}},
   {{#methods}}
   abstract {{name}}(
     args: Args_{{name}},
-    client: CoreClient
+    client: CoreClient,
+    {{^env}}env?: null{{/env}}{{#env}}env{{^required}}?{{/required}}: Types.Env{{^required}} | null{{/required}}{{/env}}
   ): MaybeAsync<{{#return}}{{#toTypescript}}{{toGraphQLType}}{{/toTypescript}}{{/return}}>;
   {{^last}}
 

diff --git a/packages/test-cases/cases/bind/sanity/output/plugin-ts/module.ts b/packages/test-cases/cases/bind/sanity/output/plugin-ts/module.ts
@@ -43,21 +43,25 @@ export interface Args_if {
 export abstract class Module<TConfig> extends PluginModule<TConfig, Types.Env> {
   abstract moduleMethod(
     args: Args_moduleMethod,
-    client: CoreClient
+    client: CoreClient,
+    env?: null
   ): MaybeAsync<Types.Int>;
 
   abstract objectMethod(
     args: Args_objectMethod,
-    client: CoreClient
+    client: CoreClient,
+    env: Types.Env
   ): MaybeAsync<Types.AnotherType | null>;
 
   abstract optionalEnvMethod(
     args: Args_optionalEnvMethod,
-    client: CoreClient
+    client: CoreClient,
+    env?: Types.Env | null
   ): MaybeAsync<Types.AnotherType | null>;
 
   abstract if(
     args: Args_if,
-    client: CoreClient
+    client: CoreClient,
+    env?: null
   ): MaybeAsync<Types._else>;
 }
diff --git a/packages/test-cases/cases/cli/plugin/codegen/001-sanity/expected/wrap/module.ts b/packages/test-cases/cases/cli/plugin/codegen/001-sanity/expected/wrap/module.ts
@@ -20,11 +20,13 @@ export interface Args_methodTwo {
 export abstract class Module<TConfig> extends PluginModule<TConfig, Types.Env> {
   abstract methodOne(
     args: Args_methodOne,
-    client: CoreClient
+    client: CoreClient,
+    env?: null
   ): MaybeAsync<Types.Object>;
 
   abstract methodTwo(
     args: Args_methodTwo,
-    client: CoreClient
+    client: CoreClient,
+    env?: null
   ): MaybeAsync<Types.String>;
 }
diff --git a/packages/test-cases/cases/cli/plugin/codegen/002-single-module/expected/wrap/module.ts b/packages/test-cases/cases/cli/plugin/codegen/002-single-module/expected/wrap/module.ts
@@ -16,6 +16,7 @@ export interface Args_method {
 export abstract class Module<TConfig> extends PluginModule<TConfig, Types.Env> {
   abstract method(
     args: Args_method,
-    client: CoreClient
+    client: CoreClient,
+    env?: null
   ): MaybeAsync<Types.Object>;
 }
diff --git a/packages/test-cases/cases/cli/plugin/codegen/003-env/expected/wrap/module.ts b/packages/test-cases/cases/cli/plugin/codegen/003-env/expected/wrap/module.ts
@@ -15,6 +15,7 @@ export interface Args_method {
 export abstract class Module<TConfig> extends PluginModule<TConfig, Types.Env> {
   abstract method(
     args: Args_method,
-    client: CoreClient
+    client: CoreClient,
+    env: Types.Env
   ): MaybeAsync<Types.String>;
 }
diff --git a/packages/test-cases/cases/cli/plugin/codegen/003-env/expected/wrap/wrap.info.ts b/packages/test-cases/cases/cli/plugin/codegen/003-env/expected/wrap/wrap.info.ts
@@ -43,6 +43,9 @@ export const manifest: WrapManifest = {
             "type": "String"
           }
         ],
+        "env": {
+          "required": true
+        },
         "kind": 64,
         "name": "method",
         "required": true,

diff --git a/packages/test-cases/cases/cli/plugin/codegen/003-env/schema.graphql b/packages/test-cases/cases/cli/plugin/codegen/003-env/schema.graphql
@@ -5,5 +5,5 @@ type Env {
 type Module {
   method(
     str: String!
-  ): String!
+  ): String! @env(required: true)
 }
diff --git a/packages/test-cases/cases/cli/plugin/codegen/004-env-sanitization/expected/wrap/module.ts b/packages/test-cases/cases/cli/plugin/codegen/004-env-sanitization/expected/wrap/module.ts
@@ -15,6 +15,7 @@ export interface Args_method {
 export abstract class Module<TConfig> extends PluginModule<TConfig, Types.Env> {
   abstract method(
     args: Args_method,
-    client: CoreClient
+    client: CoreClient,
+    env?: Types.Env | null
   ): MaybeAsync<Types.String>;
 }
diff --git a/packages/test-cases/cases/cli/plugin/codegen/004-env-sanitization/expected/wrap/wrap.info.ts b/packages/test-cases/cases/cli/plugin/codegen/004-env-sanitization/expected/wrap/wrap.info.ts
@@ -43,6 +43,9 @@ export const manifest: WrapManifest = {
             "type": "String"
           }
         ],
+        "env": {
+          "required": false
+        },
         "kind": 64,
         "name": "method",
         "required": true,

diff --git a/packages/test-cases/cases/cli/plugin/codegen/004-env-sanitization/schema.graphql b/packages/test-cases/cases/cli/plugin/codegen/004-env-sanitization/schema.graphql
@@ -5,5 +5,5 @@ type Env {
 type Module {
   method(
     str: String!
-  ): String!
+  ): String! @env(required: false)
 }
diff --git a/packages/test-cases/cases/cli/plugin/codegen/005-custom-config/expected/wrap/module.ts b/packages/test-cases/cases/cli/plugin/codegen/005-custom-config/expected/wrap/module.ts
@@ -20,11 +20,13 @@ export interface Args_methodTwo {
 export abstract class Module<TConfig> extends PluginModule<TConfig, Types.Env> {
   abstract methodOne(
     args: Args_methodOne,
-    client: CoreClient
+    client: CoreClient,
+    env?: null
   ): MaybeAsync<Types.Object>;
 
   abstract methodTwo(
     args: Args_methodTwo,
-    client: CoreClient
+    client: CoreClient,
+    env?: null
   ): MaybeAsync<Types.String>;
 }