fix: Disable schema validation by default

* add `schemaValidation` flag to `IAgentOptions` to enable validation of inputs and outputs. * update config templates to set `schemaValidation` flag to false Closes #255 Closes #275
decentralized-identity · Nov 20, 2020 · 050e5f0 · 050e5f0
1 parent b97ff3b
commit 050e5f0
Show file tree

Hide file tree

Showing 7 changed files with 58 additions and 4 deletions.
diff --git a/docs/api/daf-core.iagentoptions.md b/docs/api/daf-core.iagentoptions.md
@@ -24,4 +24,5 @@ export interface IAgentOptions
 |  [context](./daf-core.iagentoptions.context.md) | Record&lt;string, any&gt; | The context object that will be available to the plugin methods |
 |  [overrides](./daf-core.iagentoptions.overrides.md) | [IPluginMethodMap](./daf-core.ipluginmethodmap.md) | The map of plugin methods. Can be used to override methods provided by plugins, or to add additional methods without writing a plugin |
 |  [plugins](./daf-core.iagentoptions.plugins.md) | [IAgentPlugin](./daf-core.iagentplugin.md)<!-- -->\[\] | The array of agent plugins |
+|  [schemaValidation](./daf-core.iagentoptions.schemavalidation.md) | boolean | Flag that enables schema validation for plugin methods. false |
 
diff --git a/docs/api/daf-core.iagentoptions.schemavalidation.md b/docs/api/daf-core.iagentoptions.schemavalidation.md
@@ -0,0 +1,15 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [daf-core](./daf-core.md) &gt; [IAgentOptions](./daf-core.iagentoptions.md) &gt; [schemaValidation](./daf-core.iagentoptions.schemavalidation.md)
+
+## IAgentOptions.schemaValidation property
+
+Flag that enables schema validation for plugin methods.
+
+ false
+
+<b>Signature:</b>
+
+```typescript
+schemaValidation?: boolean;
+```
diff --git a/packages/daf-cli/default/client.yml b/packages/daf-cli/default/client.yml
@@ -18,7 +18,8 @@ server:
 agent:
   $require: daf-core#Agent
   $args:
-    - plugins:
+    - schemaValidation: false
+      plugins:
         - $require: daf-rest#AgentRestClient
           $args:
             - url: http://localhost:3332

diff --git a/packages/daf-cli/default/default.yml b/packages/daf-cli/default/default.yml
@@ -46,7 +46,8 @@ messageHandler:
 agent:
   $require: daf-core#Agent
   $args:
-    - plugins:
+    - schemaValidation: true
+      plugins:
         - $require: daf-key-manager#KeyManager
           $args:
             - store:

diff --git a/packages/daf-core/api/daf-core.api.json b/packages/daf-core/api/daf-core.api.json
@@ -850,6 +850,31 @@
                 "startIndex": 1,
                 "endIndex": 3
               }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "daf-core!IAgentOptions#schemaValidation:member",
+              "docComment": "/**\n * Flag that enables schema validation for plugin methods.\n *\n * @default false\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "schemaValidation?: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "boolean"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "releaseTag": "Public",
+              "name": "schemaValidation",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
             }
           ],
           "extendsTokenRanges": []

diff --git a/packages/daf-core/api/daf-core.api.md b/packages/daf-core/api/daf-core.api.md
@@ -57,6 +57,7 @@ export interface IAgentOptions {
   context?: Record<string, any>
   overrides?: IPluginMethodMap
   plugins?: IAgentPlugin[]
+  schemaValidation?: boolean
 }
 
 // @public

diff --git a/packages/daf-core/src/agent.ts b/packages/daf-core/src/agent.ts
@@ -66,6 +66,13 @@ export interface IAgentOptions {
    * ```
    */
   context?: Record<string, any>
+
+  /**
+   * Flag that enables schema validation for plugin methods.
+   *
+   * @default false
+   */
+  schemaValidation?: boolean
 }
 
 /**
@@ -85,6 +92,7 @@ export class Agent implements IAgent {
   readonly methods: IPluginMethodMap = {}
 
   private schema: IAgentPluginSchema
+  private schemaValidation: boolean
   private context?: Record<string, any>
   private protectedMethods = ['execute', 'availableMethods', 'emit']
 
@@ -167,6 +175,8 @@ export class Agent implements IAgent {
         this[method] = async (args: any) => this.execute(method, args)
       }
     }
+
+    this.schemaValidation = options?.schemaValidation || false
   }
 
   /**
@@ -215,11 +225,11 @@ export class Agent implements IAgent {
     Debug('daf:agent:' + method)('%o', args)
     if (!this.methods[method]) throw Error('Method not available: ' + method)
     const _args = args || {}
-    if (this.schema.components.methods[method]) {
+    if (this.schemaValidation && this.schema.components.methods[method]) {
       validateArguments(method, _args, this.schema)
     }
     const result = await this.methods[method](_args, { ...this.context, agent: this })
-    if (this.schema.components.methods[method]) {
+    if (this.schemaValidation && this.schema.components.methods[method]) {
       validateReturnType(method, result, this.schema)
     }
     Debug('daf:agent:' + method + ':result')('%o', result)