Skip to content

improve CoAP and IPv6 support #121

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Mar 15, 2021
Merged

improve CoAP and IPv6 support #121

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
5543a89
improve CoAP and IPv6 support
k-toumura Mar 3, 2021
6b492a0
use non-strict mode in Ajv
k-toumura Mar 3, 2021
040926b
suppress format validation error
k-toumura Mar 3, 2021
045cf71
fix typo
k-toumura Mar 3, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion lib/webofthings/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ const fs = require('fs');
const path = require('path');
const mustache = require('mustache');
const obfuscator = require('javascript-obfuscator');
const axios = require('axios').default;

const wotutils = require('./wotutils');

Expand All @@ -13,7 +14,8 @@ async function getSpec(src) {
let spec;
if (typeof src === "string") {
if (/^https?:/.test(src)) {
spec = JSON.parse(util.skipBom(await axios.get(src)));
const response = await axios.get(src);
spec = response.data;
} else {
spec = JSON.parse(util.skipBom(await fs.promises.readFile(src)));
}
Expand Down
9 changes: 6 additions & 3 deletions lib/webofthings/wotutils.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,9 +73,12 @@ function normalizeTd(td) {

function formconv(intr, f, affordance) {
if (f.hasOwnProperty("href")) {
f.href = url.resolve(baseUrl, f.href)
.replace(/%7B/gi,'{')
.replace(/%7D/gi,'}');
if (td.base) {
f.href = new URL(f.href, td.base).toString()
} else {
f.href = new URL(f.href).toString()
}
f.href = f.href.replace(/%7B/gi,'{').replace(/%7D/gi,'}');
}
if (f.hasOwnProperty("security") && typeof f.security === 'string') {
f.security = [f.security];
Expand Down
175 changes: 111 additions & 64 deletions templates/webofthings/node.js.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@ module.exports = function (RED) {
const HttpsProxyAgent = require('https-proxy-agent');
const WebSocket = require('ws');
const urltemplate = require('url-template');
const Ajv = require('ajv');
const Ajv = require('ajv').default;
const nodecoap = require('coap');

function extractTemplate(href, context={}) {
return urltemplate.parse(href).expand(context);
Expand Down Expand Up @@ -68,14 +69,33 @@ module.exports = function (RED) {
}
}

function createCoapReqOpts(resource, method, observe=false) {
let urlobj = new URL(resource);
let hostname = urlobj.hostname;
if (hostname.startsWith('[') && hostname.endsWith(']')) {
// remove square brackets from IPv6 address
hostname = hostname.slice(1,-1);
}
let query = urlobj.search;
if (query.startsWith('?')) {
query = query.slice(1);
}
return {
hostname: hostname,
port: urlobj.port,
method: method,
pathname: urlobj.pathname,
query: query,
observe: observe
};
}

function bindingCoap(node, send, done, form, options={}) { // options.psk
const coap = require("node-coap-client").CoapClient;
node.trace("bindingCoap called");
const msg = options.msg || {};
const resource = extractTemplate(form.href, options.urivars);
let payload = null;
let method = null;

if (options.interaction === "property-read") {
method = form.hasOwnProperty("cov:methodName") ?
coapMethodCodeToName(form['cov:methodName']) : 'get';
Expand All @@ -89,78 +109,105 @@ module.exports = function (RED) {
payload = options.reqbody;
}

node.trace(`CoAP request: resource=${resource}, method=${method}, payload=${payload}`);
coap.request(resource, method, payload)
.then(response => { // code, format, payload
node.trace(`CoAP response: code=${response.code.toString()}, format=${response.format}, payload=${response.payload}`);
if (response.format === 50) { // application/json; rfc7252 section 12.3, table 9
const coapreqopt = createCoapReqOpts(resource, method, false);

node.trace(`CoAP request: reqopt=${JSON.stringify(coapreqopt)},payload=${payload}`);
let outmsg = nodecoap.request(coapreqopt);
if (payload) {
outmsg.write(payload);
}
outmsg.on('response', response => {
const cf = response.options.find(e=>e.name === 'Content-Format');
if (cf && cf.value === 'application/json') {
try {
msg.payload = JSON.parse(response.payload);
msg.payload = JSON.parse(response.payload.toString());
if (options.outschema) {
const ajv = new Ajv({allErrors: true, strict: false, validateFormats: false});
if (!ajv.validate(options.outschema, msg.payload)) {
node.warn(`output schema validation error: ${ajv.errorsText()}`, msg);
}
}
} catch (e) {
msg.payload = response.payload;
}
} else if (cf && cf.value === 'text/plain') {
msg.payload = response.payload.toString();
} else {
msg.payload = response.payload;
}
if (options.outschema) {
const ajv = new Ajv({allErrors: true});
if (!ajv.validate(options.outschema, msg.payload)) {
node.warn(`output schema validation error: ${ajv.errorsText()}`, msg);
}
}
send(msg);
if (done) {
done();
}
})
.catch(err => {
node.log(`Error: ${err.toString()}`);
msg.payload = `${err.toString()}: ${resource}`;
response.on('end', () => { if (done) { done(); }});
});
const errorHandler = (err) => {
node.warn(`CoAP request error: ${err.message}`);
delete msg.payload;
msg.error = err;
send(msg);
if (done) {
done();
}
});
if (done) { done() };
};
outmsg.on('timeout', errorHandler);
outmsg.on('error', errorHandler);
outmsg.end();
}

function bindingCoapObserve(node, form, options={}) {
const coap = require("node-coap-client").CoapClient;
node.status({fill:"yellow",shape:"dot",text:"CoAP try to observe ..."});
const resource = extractTemplate(form.href,options.urivars);
const method = form.hasOwnProperty("cov:methodName") ?
coapMethodCodeToName(form['cov:methodName']) : 'get';
const payload = options.reqbody;
const callback = response => { // code, format, payload
const msg = {};
node.trace(`CoAP observe: code=${response.code.toString()}, format=${response.format}, payload=${response.payload}`);
if (response.format === 50) { // application/json; rfc7252 section 12.3, table 9
try {
msg.payload = JSON.parse(response.payload);
} catch (e) {
msg.payload = response.payload;
}
} else {
msg.payload = response.payload;
}
if (options.outschema) {
const ajv = new Ajv({allErrors: true});
if (!ajv.validate(options.outschema, msg.payload)) {
node.warn(`output schema validation error: ${ajv.errorsText()}`, msg);
let observingStream;

const coapreqopt = createCoapReqOpts(resource, method, true);
node.trace(`CoAP observe request: reqopt=${JSON.stringify(coapreqopt)},payload=${payload}`);

let outmsg = nodecoap.request(coapreqopt);
if (payload) {
outmsg.write(payload);
}
outmsg.on('response', response => {
observingStream = response;
const cf = response.options.find(e=>e.name === 'Content-Format');
response.on('end', () => {});
response.on('data', chunk => {
const msg = {};
if (cf && cf.value === 'application/json') {
try {
msg.payload = JSON.parse(chunk.toString());
if (options.outschema) {
const ajv = new Ajv({allErrors: true, strict: false, validateFormats: false});
if (!ajv.validate(options.outschema, msg.payload)) {
node.warn(`output schema validation error: ${ajv.errorsText()}`, msg);
}
}
} catch (e) {
msg.payload = chunk;
}
} else if (cf && cf.value === 'text/plain') {
msg.payload = chunk.toString();
} else {
msg.payload = chunk;
}
}
node.send(msg);
};
coap.observe(resource,method,callback,payload,options)
.then(() => {
node.status({fill:"green",shape:"dot",text:"CoAP Observing"});
})
.catch(err => {
node.status({fill:"red",shape:"dot",text:`CoAP Error: ${err}`});
node.log(`Error: ${err.toString()}`);
node.send(msg);
});
});
const errorHandler = (err) => {
node.warn(`CoAP request error: ${err.message}`);
node.status({fill:'red',shape:'dot',text:`CoAP Error: ${err}`});
delete msg.payload;
msg.error = err;
node.send(msg);
};
outmsg.on('timeout', errorHandler);
outmsg.on('error', errorHandler);
outmsg.end();
node.status({fill:'green',shape:'dot',text:'CoAP Observing'});
node.on('close', () => {
node.trace('Close node');
coap.stopObserving(resource);
if (observingStream) {
observingStream.close();
observingStream = null;
};
node.status({});
});
}
Expand Down Expand Up @@ -215,7 +262,7 @@ module.exports = function (RED) {
msg.payload = data;
}
if (options.outschema) {
const ajv = new Ajv({allErrors: true});
const ajv = new Ajv({allErrors: true, strict: false, validateFormats: false});
if (!ajv.validate(options.outschema, msg.payload)) {
node.warn(`output schema validation error: ${ajv.errorsText()}`, msg);
}
Expand Down Expand Up @@ -282,7 +329,7 @@ module.exports = function (RED) {
}
// TODO: validation of return value
if (options.outschema) {
const ajv = new Ajv();
const ajv = new Ajv({allErrors: true, strict: false, validateFormats: false});
if (!ajv.validate(options.outschema, msg.payload)) {
node.warn(`output schema validation error: ${ajv.errorsText()}`, msg);
}
Expand Down Expand Up @@ -370,7 +417,7 @@ module.exports = function (RED) {
}
// TODO: validation of return value
if (options.outschema) {
const ajv = new Ajv({allErrors: true});
const ajv = new Ajv({allErrors: true, strict: false, validateFormats: false});
if (!ajv.validate(options.outschema, msg.payload)) {
node.warn(`output schema validation error: ${ajv.errorsText()}`, msg);
}
Expand Down Expand Up @@ -430,15 +477,15 @@ module.exports = function (RED) {
const auth = makeauth(normTd, form, username, password, token);
const urivars = prop.hasOwnProperty("uriVariables") ? msg.payload : {};
if (prop.uriVariables) {
const ajv = new Ajv({allErrors: true});
const ajv = new Ajv({allErrors: true, strict: false, validateFormats: false});
if (!ajv.validate(prop.uriVariables, urivars)) {
node.warn(`input schema validation error: ${ajv.errorsText()}`, msg);
}
}
if (form.href.match(/^https?:/)) {
bindingHttp(node, send, done, form, {interaction:"property-read", auth, msg, urivars, outschema: prop});
} else if (form.href.match(/^coaps?:/)) {
bindingCoap(node, send, done, form, send, done, {interaction:"property-read", auth, msg, urivars, outschema: prop});
bindingCoap(node, send, done, form, {interaction:"property-read", auth, msg, urivars, outschema: prop});
}
});
} else if (node.proptype === "write") {
Expand All @@ -447,7 +494,7 @@ module.exports = function (RED) {
const prop = normTd.properties[node.propname];
const form = prop.forms[node.formindex];// formSelection("property-write", prop.forms);
const auth = makeauth(normTd, form, username, password, token);
const ajv = new Ajv({allErrors: true});
const ajv = new Ajv({allErrors: true, strict: false, validateFormats: false});
if (!ajv.validate(prop, msg.payload)) {
node.warn(`input schema validation error: ${ajv.errorsText()}`, msg);
}
Expand All @@ -464,7 +511,7 @@ module.exports = function (RED) {
const auth = makeauth(normTd, form, username, password, token);
const urivars = prop.hasOwnProperty("uriVariables") ? msg.payload : {};
if (prop.uriVariables) {
const ajv = new Ajv({allErrors: true});
const ajv = new Ajv({allErrors: true, strict: false, validateFormats: false});
if (!ajv.validate(prop.uriVariables, urivars)) {
node.warn(`input schema validation error: ${ajv.errorsText()}`, msg);
}
Expand All @@ -485,13 +532,13 @@ module.exports = function (RED) {
const auth = makeauth(normTd, form, username, password, token);
const urivars = act.hasOwnProperty("uriVariables") ? msg.payload : {};
if (act.uriVariables) {
const ajv = new Ajv({allErrors: true});
const ajv = new Ajv({allErrors: true, strict: false, validateFormats: false});
if (!ajv.validate(act.uriVariables, urivars)) {
node.warn(`input schema validation error: ${ajv.errorsText()}`, msg);
}
}
if (act.input) {
const ajv = new Ajv({allErrors: true});
const ajv = new Ajv({allErrors: true, strict: false, validateFormats: false});
if (!ajv.validate(act.input, msg.payload)) {
node.warn(`input schema validation error: ${ajv.errorsText()}`, msg);
}
Expand All @@ -508,7 +555,7 @@ module.exports = function (RED) {
const auth = makeauth(normTd, form, username, password, token);
const urivars = ev.hasOwnProperty("uriVariables") ? msg.payload : {};
if (ev.uriVariables) {
const ajv = new Ajv({allErrors: true});
const ajv = new Ajv({allErrors: true, strict: false, validateFormats: false});
if (!ajv.validate(ev.uriVariables, urivars)) {
node.warn(`input schema validation error: ${ajv.errorsText()}`, msg);
}
Expand Down
12 changes: 6 additions & 6 deletions templates/webofthings/package.json.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,16 +17,16 @@
{{/keywords}}
],
"dependencies": {
"https-proxy-agent": "^3.0.1",
"https-proxy-agent": "^5.0.0",
"request": "^2.88.2",
"ws": "^7.2.0",
"ws": "^7.4.3",
"url-template": "^2.0.8",
"ajv": "^6.10.2",
"node-coap-client": "^1.0.2"
"ajv": "^7.1.1",
"coap": "^0.24.0"
},
"devDependencies": {
"node-red": "^1.0.4",
"node-red-node-test-helper": "^0.2.3"
"node-red": "^1.2.9",
"node-red-node-test-helper": "^0.2.7"
},
"license": "{{&licenseName}}",
"wot": {
Expand Down