-
Notifications
You must be signed in to change notification settings - Fork 78
/
servient.ts
282 lines (238 loc) · 10.2 KB
/
servient.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
/********************************************************************************
* Copyright (c) 2018 - 2020 Contributors to the Eclipse Foundation
*
* See the NOTICE file(s) distributed with this work for additional
* information regarding copyright ownership.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v. 2.0 which is available at
* http://www.eclipse.org/legal/epl-2.0, or the W3C Software Notice and
* Document License (2015-05-13) which is available at
* https://www.w3.org/Consortium/Legal/2015/copyright-software-and-document.
*
* SPDX-License-Identifier: EPL-2.0 OR W3C-20150513
********************************************************************************/
import {NodeVM, CompilerFunction} from "vm2";
import * as WoT from "wot-typescript-definitions";
import WoTImpl from "./wot-impl";
import Helpers from "./helpers";
import ExposedThing from "./exposed-thing";
import { ProtocolClientFactory, ProtocolServer, ProtocolClient } from "./protocol-interfaces"
import { default as ContentManager, ContentCodec } from "./content-serdes";
export default class Servient {
private servers: Array<ProtocolServer> = [];
private clientFactories: Map<string, ProtocolClientFactory> = new Map<string, ProtocolClientFactory>();
private things: Map<string, ExposedThing> = new Map<string, ExposedThing>();
private credentialStore: Map<string, Array<any>> = new Map<string, Array<any>>();
private uncaughtListeners:Array<(...args:any)=>void> = []
/** runs the script in a new sandbox */
public runScript(code: string, filename = 'script') {
let context = {
"WoT": new WoTImpl(this),
"WoTHelpers": new Helpers(this)
};
const vm = new NodeVM({
sandbox: context
})
let listener = (err:Error) => {
this.logScriptError(`Asynchronous script error '${filename}'`, err)
//TODO: clean up script resources
process.exit(1)
}
process.prependListener('uncaughtException',listener)
this.uncaughtListeners.push(listener)
try {
return vm.run(code, filename)
} catch (err) {
this.logScriptError(`Servient found error in privileged script '${filename}'`, err)
}
}
/** runs the script in privileged context (dangerous) - means here: scripts can require */
public runPrivilegedScript(code: string, filename = 'script',options:ScriptOptions={}) {
let context = {
"WoT": new WoTImpl(this),
"WoTHelpers": new Helpers(this)
};
const vm = new NodeVM({
sandbox:context,
require: {
external: true,
builtin: ["*"]
},
argv: options.argv,
compiler: options.compiler,
env: options.env
})
let listener = (err: Error) => {
this.logScriptError(`Asynchronous script error '${filename}'`, err)
//TODO: clean up script resources
process.exit(1)
}
process.prependListener('uncaughtException', listener)
this.uncaughtListeners.push(listener)
try {
return vm.run(code,filename)
} catch (err) {
this.logScriptError(`Servient found error in privileged script '${filename}'`,err)
}
}
private logScriptError(description: string, error: any): void {
let message: string;
if (typeof error==="object" && error.stack) {
let match = error.stack.match(/evalmachine\.<anonymous>\:([0-9]+\:[0-9]+)/);
if (Array.isArray(match)) {
message = `and halted at line ${match[1]}\n ${error}`;
} else {
message = `and halted with ${error.stack}`;
}
} else {
message = `that threw ${typeof error} instead of Error\n ${error}`;
}
console.error("[core/servient]",`Servient caught ${description} ${message}`);
}
/** add a new codec to support a mediatype; offered mediatypes are listed in TDs */
public addMediaType(codec: ContentCodec, offered: boolean = false) {
ContentManager.addCodec(codec, offered);
}
public expose(thing: ExposedThing): Promise<void> {
if (this.servers.length === 0) {
console.warn("[core/servient]",`Servient has no servers to expose Things`);
return new Promise<void>((resolve) => { resolve(); });
}
console.debug("[core/servient]",`Servient exposing '${thing.title}'`);
// What is a good way to to convey forms information like contentType et cetera for interactions
let tdTemplate: WoT.ThingDescription = JSON.parse(JSON.stringify(thing));
// initializing forms fields
thing.forms = [];
for (let name in thing.properties) {
thing.properties[name].forms = [];
}
for (let name in thing.actions) {
thing.actions[name].forms = [];
}
for (let name in thing.events) {
thing.events[name].forms = [];
}
let serverPromises: Promise<void>[] = [];
this.servers.forEach( (server) => { serverPromises.push(server.expose(thing, tdTemplate)); });
return new Promise<void>((resolve, reject) => {
Promise.all(serverPromises).then( () => resolve() ).catch( (err) => reject(err) );
});
}
public addThing(thing: ExposedThing): boolean {
if (thing.id === undefined) {
thing.id = "urn:uuid:" + require("uuid").v4();
console.warn("[core/servient]",`Servient generating ID for '${thing.title}': '${thing.id}'`);
}
if (!this.things.has(thing.id)) {
this.things.set(thing.id, thing);
console.debug("[core/servient]",`Servient reset ID '${thing.id}' with '${thing.title}'`);
return true;
} else {
return false;
}
}
public getThing(id: string): ExposedThing {
if (this.things.has(id)) {
return this.things.get(id);
} else return null;
}
// FIXME should be getThingDescriptions (breaking change)
public getThings(): object {
console.debug("[core/servient]",`Servient getThings size == '${this.things.size}'`);
let ts : { [key: string]: object } = {};
this.things.forEach((thing, id) => {
ts[id] = thing.getThingDescription();
});
return ts;
}
public addServer(server: ProtocolServer): boolean {
// add all exposed Things to new server
this.things.forEach((thing, id) => server.expose(thing));
this.servers.push(server);
return true;
}
public getServers(): Array<ProtocolServer> {
// return a copy -- FIXME: not a deep copy
return this.servers.slice(0);
}
public addClientFactory(clientFactory: ProtocolClientFactory): void {
this.clientFactories.set(clientFactory.scheme, clientFactory);
}
public hasClientFor(scheme: string): boolean {
console.debug("[core/servient]",`Servient checking for '${scheme}' scheme in ${this.clientFactories.size} ClientFactories`);
return this.clientFactories.has(scheme);
}
public getClientFor(scheme: string): ProtocolClient {
if (this.clientFactories.has(scheme)) {
console.debug("[core/servient]",`Servient creating client for scheme '${scheme}'`);
return this.clientFactories.get(scheme).getClient();
} else {
// FIXME returning null was bad - Error or Promise?
// h0ru5: caller cannot react gracefully - I'd throw Error
throw new Error(`Servient has no ClientFactory for scheme '${scheme}'`);
}
}
public getClientSchemes(): string[] {
return Array.from(this.clientFactories.keys());
}
public addCredentials(credentials: any) {
if (typeof credentials === "object") {
for (let i in credentials) {
console.debug("[core/servient]",`Servient storing credentials for '${i}'`);
let currentCredentials : Array<any> = this.credentialStore.get(i);
if(!currentCredentials) {
currentCredentials = [];
this.credentialStore.set(i, currentCredentials);
}
currentCredentials.push(credentials[i]);
}
}
}
/**
* @deprecated use retrieveCredentials() instead which may return multiple credentials
*
* @param identifier id
*/
public getCredentials(identifier: string): any {
console.debug("[core/servient]", `Servient looking up credentials for '${identifier}' (@deprecated)`);
let currentCredentials: Array<any> = this.credentialStore.get(identifier);
if (currentCredentials && currentCredentials.length > 0) {
// return first
return currentCredentials[0];
} else {
return undefined;
}
}
public retrieveCredentials(identifier: string): Array<any> {
console.debug("[core/servient]", `Servient looking up credentials for '${identifier}'`);
return this.credentialStore.get(identifier);
}
// will return WoT object
public start(): Promise<WoT.WoT> {
let serverStatus: Array<Promise<void>> = [];
this.servers.forEach((server) => serverStatus.push(server.start(this)));
this.clientFactories.forEach((clientFactory) => clientFactory.init());
return new Promise<WoT.WoT>((resolve, reject) => {
Promise.all(serverStatus)
.then(() => {
resolve(new WoTImpl(this));
})
.catch(err => {
reject(err);
});
});
}
public shutdown(): void {
this.clientFactories.forEach((clientFactory) => clientFactory.destroy());
this.servers.forEach((server) => server.stop());
this.uncaughtListeners.forEach(listener =>{
process.removeListener("uncaughtException",listener);
})
}
}
export interface ScriptOptions {
argv?:Array<string>;
compiler?: CompilerFunction;
env?:Object;
}