Merge pull request eclipse-thingweb#1397 from danielpeintner/scripting-SNAPSHOT.31

Add skeleton for query and cancel action

Author: relu91

package-lock.json

@@ -79,7 +79,7 @@
         "tslint": "5.12.1",
         "typescript": "^5.7.3",
         "typescript-standard": "^0.3.36",
-        "wot-typescript-definitions": "0.8.0-SNAPSHOT.30"
+        "wot-typescript-definitions": "0.8.0-SNAPSHOT.31"
     },
     "version": ""
 }

package.json

@@ -21,7 +21,7 @@
         "node-coap-client": "1.0.8",
         "rxjs": "5.5.11",
         "slugify": "^1.4.5",
-        "wot-typescript-definitions": "0.8.0-SNAPSHOT.30"
+        "wot-typescript-definitions": "0.8.0-SNAPSHOT.31"
     },
     "scripts": {
         "build": "tsc -b",

packages/binding-coap/package.json

@@ -20,7 +20,7 @@
         "@node-wot/core": "0.9.2",
         "modbus-serial": "8.0.17",
         "rxjs": "5.5.11",
-        "wot-typescript-definitions": "0.8.0-SNAPSHOT.30"
+        "wot-typescript-definitions": "0.8.0-SNAPSHOT.31"
     },
     "scripts": {
         "build": "tsc -b",

packages/binding-modbus/package.json

@@ -38,7 +38,7 @@ import ContentType from "content-type";
 import ContentManager from "./content-serdes";
 
 import UriTemplate = require("uritemplate");
-import { InteractionOutput } from "./interaction-output";
+import { InteractionOutput, ActionInteractionOutput } from "./interaction-output";
 import {
     ActionElement,
     EventElement,
@@ -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,13 +574,17 @@ 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);
+    }
+
+    // check if returned media type is the same as expected media type (from TD)
+    private checkMediaTypeOrThrow(content: Content, form: Form) {
         if (form.response != null) {
             const parsedMediaTypeContent = ContentType.parse(content.type);
             const parsedMediaTypeForm = ContentType.parse(form.response.contentType);
@@ -590,7 +594,19 @@ export default class ConsumedThing extends Thing implements IConsumedThing {
                 );
             }
         }
-        return new InteractionOutput(content, form, outputDataSchema, { ignoreValidation });
+    }
+
+    private handleActionInteractionOutput(
+        content: Content,
+        form: Form,
+        outputDataSchema: WoT.DataSchema | undefined,
+        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, synchronous);
     }
 
     async _readProperties(propertyNames: string[]): Promise<WoT.PropertyReadMap> {
@@ -680,7 +696,7 @@ export default class ConsumedThing extends Thing implements IConsumedThing {
         actionName: string,
         parameter?: InteractionInput,
         options?: WoT.InteractionOptions
-    ): Promise<WoT.InteractionOutput> {
+    ): Promise<WoT.ActionInteractionOutput> {
         const ta = this.actions[actionName];
         if (ta == null) {
             throw new Error(`ConsumedThing '${this.title}' does not have action ${actionName}`);
@@ -709,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.handleInteractionOutput(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}`);
@@ -753,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}`);
@@ -809,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/consumed-thing.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,4 +137,32 @@ 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
+    ): Promise<T> {
+        throw new Error("Not yet implemented");
+    }
+
+    async cancel(params?: WoT.InteractionInput, options?: WoT.InteractionOptions): Promise<void> {
+        throw new Error("Not yet implemented");
+    }
 }

packages/core/src/interaction-output.ts

@@ -18,7 +18,7 @@ import { suite, test } from "@testdeck/mocha";
 import promised from "chai-as-promised";
 import { expect, use } from "chai";
 import { Readable } from "stream";
-import { InteractionOutput } from "../src/interaction-output";
+import { InteractionOutput, ActionInteractionOutput } from "../src/interaction-output";
 import { Content } from "..";
 import { fail } from "assert";
 
@@ -121,12 +121,20 @@ class InteractionOutputTests {
         }
     }
 
-    @test async "should accept returning unexpected value with no validation"() {
-        // type boolean should not throw since we set ignoreValidation to true
+    @test async "should accept returning unexpected value with no validation (synchronous==false)"() {
         const stream = Readable.from(Buffer.from("not boolean", "utf-8"));
         const content = new Content("application/json", stream);
 
-        const out = new InteractionOutput(content, {}, { type: "boolean" }, { ignoreValidation: true });
+        const out = new ActionInteractionOutput(content, {}, { type: "boolean" }, false);
+        const result = await out.value();
+        expect(result).to.eql("not boolean");
+    }
+
+    @test async "should accept returning unexpected value with no validation (synchronous===undefined)"() {
+        const stream = Readable.from(Buffer.from("not boolean", "utf-8"));
+        const content = new Content("application/json", stream);
+
+        const out = new ActionInteractionOutput(content, {}, { type: "boolean" });
         const result = await out.value();
         expect(result).to.eql("not boolean");
     }

packages/core/test/InteractionOutputTest.ts

@@ -19,6 +19,6 @@
         "ts-node": "10.9.1",
         "typescript": "4.7.4",
         "typescript-standard": "^0.3.36",
-        "wot-typescript-definitions": "0.8.0-SNAPSHOT.30"
+        "wot-typescript-definitions": "0.8.0-SNAPSHOT.31"
     }
 }