refactor: do validation for synchronous action

remove ignoreValidation for generic InteractionOutput

Author: danielpeintner

packages/core/src/consumed-thing.ts

@@ -564,7 +564,7 @@ export default class ConsumedThing extends Thing implements IConsumedThing {
 
         const content = await client.readResource(form);
         try {
-            return this.handleInteractionOutput(content, form, tp, false);
+            return this.handleInteractionOutput(content, form, tp);
         } catch (e) {
             const error = e instanceof Error ? e : new Error(JSON.stringify(e));
             throw new Error(`Error while processing property for ${tp.title}. ${error.message}`);
@@ -574,14 +574,13 @@ export default class ConsumedThing extends Thing implements IConsumedThing {
     private handleInteractionOutput(
         content: Content,
         form: Form,
-        outputDataSchema: WoT.DataSchema | undefined,
-        ignoreValidation: boolean
+        outputDataSchema: WoT.DataSchema | undefined
     ): InteractionOutput {
         // infer media type from form if not in response metadata
         content.type ??= form.contentType ?? "application/json";
         // check if returned media type is the same as expected media type (from TD)
         this.checkMediaTypeOrThrow(content, form);
-        return new InteractionOutput(content, form, outputDataSchema, { ignoreValidation });
+        return new InteractionOutput(content, form, outputDataSchema);
     }
 
     // check if returned media type is the same as expected media type (from TD)
@@ -601,13 +600,13 @@ export default class ConsumedThing extends Thing implements IConsumedThing {
         content: Content,
         form: Form,
         outputDataSchema: WoT.DataSchema | undefined,
-        ignoreValidation: boolean
+        synchronous?: boolean
     ): ActionInteractionOutput {
         // infer media type from form if not in response metadata
         content.type ??= form.contentType ?? "application/json";
         // check if returned media type is the same as expected media type (from TD)
         this.checkMediaTypeOrThrow(content, form);
-        return new ActionInteractionOutput(content, form, outputDataSchema, { ignoreValidation });
+        return new ActionInteractionOutput(content, form, outputDataSchema, synchronous);
     }
 
     async _readProperties(propertyNames: string[]): Promise<WoT.PropertyReadMap> {
@@ -726,8 +725,7 @@ export default class ConsumedThing extends Thing implements IConsumedThing {
 
         const content = await client.invokeResource(form, input);
         try {
-            const ignoreValidation = ta.synchronous === undefined ? true : !ta.synchronous;
-            return this.handleActionInteractionOutput(content, form, ta.output, ignoreValidation);
+            return this.handleActionInteractionOutput(content, form, ta.output, ta.synchronous);
         } catch (e) {
             const error = e instanceof Error ? e : new Error(JSON.stringify(e));
             throw new Error(`Error while processing action for ${ta.title}. ${error.message}`);
@@ -770,7 +768,7 @@ export default class ConsumedThing extends Thing implements IConsumedThing {
             // next
             (content) => {
                 try {
-                    listener(this.handleInteractionOutput(content, form, tp, false));
+                    listener(this.handleInteractionOutput(content, form, tp));
                 } catch (e) {
                     const error = e instanceof Error ? e : new Error(JSON.stringify(e));
                     warn(`Error while processing observe property for ${tp.title}. ${error.message}`);
@@ -826,7 +824,7 @@ export default class ConsumedThing extends Thing implements IConsumedThing {
             formWithoutURITemplates,
             (content) => {
                 try {
-                    listener(this.handleInteractionOutput(content, form, te.data, false));
+                    listener(this.handleInteractionOutput(content, form, te.data));
                 } catch (e) {
                     const error = e instanceof Error ? e : new Error(JSON.stringify(e));
                     warn(`Error while processing event for ${te.title}. ${error.message}`);

packages/core/src/interaction-output.ts

@@ -42,7 +42,6 @@ export class InteractionOutput implements WoT.InteractionOutput {
     dataUsed: boolean;
     form?: WoT.Form;
     schema?: WoT.DataSchema;
-    ignoreValidation: boolean; // by default set to false
 
     public get data(): ReadableStream {
         if (this.#stream) {
@@ -58,11 +57,10 @@ export class InteractionOutput implements WoT.InteractionOutput {
         return (this.#stream = ProtocolHelpers.toWoTStream(this.#content.body) as ReadableStream);
     }
 
-    constructor(content: Content, form?: WoT.Form, schema?: WoT.DataSchema, options = { ignoreValidation: false }) {
+    constructor(content: Content, form?: WoT.Form, schema?: WoT.DataSchema) {
         this.#content = content;
         this.form = form;
         this.schema = schema;
-        this.ignoreValidation = options.ignoreValidation ?? false;
         this.dataUsed = false;
     }
 
@@ -129,7 +127,7 @@ export class InteractionOutput implements WoT.InteractionOutput {
         // validate the schema
         const validate = ajv.compile<T>(this.schema);
 
-        if (!this.ignoreValidation && !validate(json)) {
+        if (!this.ignoreValidation() && !validate(json)) {
             debug(`schema = ${util.inspect(this.schema, { depth: 10, colors: true })}`);
             debug(`value: ${json}`);
             debug(`Error: ${validate.errors}`);
@@ -139,9 +137,24 @@ export class InteractionOutput implements WoT.InteractionOutput {
         this.#value = json;
         return json as T;
     }
+
+    protected ignoreValidation(): boolean {
+        return false; // by default set to false
+    }
 }
 
 export class ActionInteractionOutput extends InteractionOutput implements WoT.ActionInteractionOutput {
+    synchronous?: boolean;
+
+    constructor(content: Content, form?: WoT.Form, schema?: WoT.DataSchema, synchronous?: boolean) {
+        super(content, form, schema);
+        this.synchronous = synchronous;
+    }
+
+    protected ignoreValidation(): boolean {
+        return this.synchronous === undefined ? true : !this.synchronous; // validate data for synchronous action only
+    }
+
     async query<T extends WoT.InteractionOutput>(
         params?: WoT.InteractionInput,
         options?: WoT.InteractionOptions