-
Notifications
You must be signed in to change notification settings - Fork 214
/
JavaScriptMessageMapperRhino.java
252 lines (218 loc) · 11.1 KB
/
JavaScriptMessageMapperRhino.java
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
/*
* Copyright (c) 2017 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 2.0 which is available at
* http://www.eclipse.org/legal/epl-2.0
*
* SPDX-License-Identifier: EPL-2.0
*/
package org.eclipse.ditto.connectivity.service.mapping.javascript;
import java.io.IOException;
import java.io.InputStreamReader;
import java.io.Reader;
import java.net.URI;
import java.net.URISyntaxException;
import java.nio.file.Path;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import java.util.Optional;
import javax.annotation.Nullable;
import org.eclipse.ditto.base.model.headers.DittoHeaders;
import org.eclipse.ditto.connectivity.api.ExternalMessage;
import org.eclipse.ditto.connectivity.model.Connection;
import org.eclipse.ditto.connectivity.model.MessageMapperConfigurationFailedException;
import org.eclipse.ditto.connectivity.service.config.javascript.JavaScriptConfig;
import org.eclipse.ditto.connectivity.service.config.mapping.MappingConfig;
import org.eclipse.ditto.connectivity.service.mapping.AbstractMessageMapper;
import org.eclipse.ditto.connectivity.service.mapping.MessageMapper;
import org.eclipse.ditto.connectivity.service.mapping.MessageMapperConfiguration;
import org.eclipse.ditto.protocol.Adaptable;
import org.mozilla.javascript.Context;
import org.mozilla.javascript.ContextFactory;
import org.mozilla.javascript.RhinoException;
import org.mozilla.javascript.Scriptable;
import org.mozilla.javascript.commonjs.module.RequireBuilder;
import org.mozilla.javascript.commonjs.module.provider.SoftCachingModuleScriptProvider;
import org.mozilla.javascript.commonjs.module.provider.UrlModuleSourceProvider;
import com.typesafe.config.Config;
import org.apache.pekko.actor.ActorSystem;
/**
* This mapper executes its mapping methods on the <b>current thread</b>. The caller should be aware of that.
*/
final class JavaScriptMessageMapperRhino extends AbstractMessageMapper {
private static final String PAYLOAD_MAPPER_ALIAS = "JavaScript";
private static final String WEBJARS_PATH = "/META-INF/resources/webjars";
private static final String WEBJARS_BYTEBUFFER = WEBJARS_PATH + "/bytebuffer/5.0.1/dist/bytebuffer.js";
private static final String WEBJARS_LONG = WEBJARS_PATH + "/long/3.2.0/dist/long.min.js";
static final String DITTO_SCOPE_SCRIPT = "/javascript/ditto-scope.js";
static final String INCOMING_SCRIPT = "/javascript/incoming-mapping.js";
static final String OUTGOING_SCRIPT = "/javascript/outgoing-mapping.js";
@Nullable private ContextFactory contextFactory;
@Nullable private JavaScriptMessageMapperConfiguration configuration;
private MappingFunction<ExternalMessage, List<Adaptable>> incomingMapping = DefaultIncomingMapping.get();
private MappingFunction<Adaptable, List<ExternalMessage>> outgoingMapping = DefaultOutgoingMapping.get();
/**
* Constructs a new instance of JavaScriptMessageMapperRhino extension.
*
* @param actorSystem the actor system in which to load the extension.
* @param config the configuration for this extension.
*/
JavaScriptMessageMapperRhino(final ActorSystem actorSystem, final Config config) {
super(actorSystem, config);
}
private JavaScriptMessageMapperRhino(final JavaScriptMessageMapperRhino copyFromMapper) {
super(copyFromMapper);
this.contextFactory = copyFromMapper.contextFactory;
this.configuration = copyFromMapper.configuration;
this.incomingMapping = copyFromMapper.incomingMapping;
this.outgoingMapping = copyFromMapper.outgoingMapping;
}
@Override
public String getAlias() {
return PAYLOAD_MAPPER_ALIAS;
}
/**
* "incomingScript" and "outgoingScript" are mandatory.
*/
@Override
public boolean isConfigurationMandatory() {
return true;
}
@Override
public MessageMapper createNewMapperInstance() {
return new JavaScriptMessageMapperRhino(this);
}
@Override
public void doConfigure(final Connection connection, final MappingConfig mappingConfig, final MessageMapperConfiguration options) {
configuration =
new ImmutableJavaScriptMessageMapperConfiguration.Builder(options.getId(), options.getProperties(),
Collections.emptyMap(), Collections.emptyMap()).build();
final JavaScriptConfig javaScriptConfig = mappingConfig.getJavaScriptConfig();
final int maxScriptSizeBytes = javaScriptConfig.getMaxScriptSizeBytes();
final Integer incomingScriptSize = configuration.getIncomingScript().map(String::length).orElse(0);
final Integer outgoingScriptSize = configuration.getOutgoingScript().map(String::length).orElse(0);
if (incomingScriptSize > maxScriptSizeBytes || outgoingScriptSize > maxScriptSizeBytes) {
throw MessageMapperConfigurationFailedException
.newBuilder("The script size was bigger than the allowed <" + maxScriptSizeBytes + "> bytes: " +
"incoming script size was <" + incomingScriptSize + "> bytes, " +
"outgoing script size was <" + outgoingScriptSize + "> bytes")
.build();
}
contextFactory = new SandboxingContextFactory(javaScriptConfig.getMaxScriptExecutionTime(),
javaScriptConfig.getMaxScriptStackDepth());
try {
// create scope once and load the required libraries in order to get best performance:
contextFactory.call(cx -> {
final Scriptable scope;
if (javaScriptConfig.isAllowUnsafeStandardObjects()) {
scope = cx.initStandardObjects();
} else {
scope = cx.initSafeStandardObjects(); // that one disables "print, exit, quit", etc.
}
initLibraries(cx, scope, javaScriptConfig.getCommonJsModulesPath().orElse(null));
return scope;
});
} catch (final RhinoException e) {
final boolean sourceExists = e.lineSource() != null && !e.lineSource().isEmpty();
final String lineSource = sourceExists ? (", source:\n" + e.lineSource()) : "";
final boolean stackExists = e.getScriptStackTrace() != null && !e.getScriptStackTrace().isEmpty();
final String scriptStackTrace = stackExists ? (", stack:\n" + e.getScriptStackTrace()) : "";
throw MessageMapperConfigurationFailedException.newBuilder(e.getMessage() +
" - in line/column #" + e.lineNumber() + "/" + e.columnNumber() + lineSource + scriptStackTrace)
.cause(e)
.build();
}
}
@Override
public List<Adaptable> map(final ExternalMessage message) {
return incomingMapping.apply(message);
}
@Override
public DittoHeaders getAdditionalInboundHeaders(final ExternalMessage message) {
return DittoHeaders.empty();
}
@Override
public List<ExternalMessage> map(final Adaptable adaptable) {
return outgoingMapping.apply(adaptable);
}
private void initLibraries(final Context cx, final Scriptable scope, @Nullable final Path commonJsModulePath) {
if (getConfiguration().map(JavaScriptMessageMapperConfiguration::isLoadLongJS).orElse(false)) {
loadJavascriptLibrary(cx, scope, new InputStreamReader(getClass().getResourceAsStream(WEBJARS_LONG)),
WEBJARS_LONG);
}
if (getConfiguration().map(JavaScriptMessageMapperConfiguration::isLoadBytebufferJS).orElse(false)) {
loadJavascriptLibrary(cx, scope, new InputStreamReader(getClass().getResourceAsStream(WEBJARS_BYTEBUFFER)),
WEBJARS_BYTEBUFFER);
}
final List<URI> paths = new ArrayList<>();
try {
paths.add(getClass().getResource(WEBJARS_LONG).toURI());
paths.add(getClass().getResource(WEBJARS_BYTEBUFFER).toURI());
} catch (URISyntaxException e) {
throw new IllegalStateException("Could not webjars", e);
}
if (null != commonJsModulePath) {
paths.add(commonJsModulePath.toUri());
}
new RequireBuilder().setModuleScriptProvider(
new SoftCachingModuleScriptProvider(new UrlModuleSourceProvider(paths, null)))
.setSandboxed(true)
.createRequire(cx, scope)
.install(scope);
loadJavascriptLibrary(cx, scope, new InputStreamReader(getClass().getResourceAsStream(DITTO_SCOPE_SCRIPT)),
DITTO_SCOPE_SCRIPT);
loadJavascriptLibrary(cx, scope, new InputStreamReader(getClass().getResourceAsStream(INCOMING_SCRIPT)),
INCOMING_SCRIPT);
loadJavascriptLibrary(cx, scope, new InputStreamReader(getClass().getResourceAsStream(OUTGOING_SCRIPT)),
OUTGOING_SCRIPT);
final String userIncomingScript = getConfiguration()
.flatMap(JavaScriptMessageMapperConfiguration::getIncomingScript)
.orElse("");
if (userIncomingScript.isEmpty()) {
// shortcut: the user defined an empty incoming mapping script -> assume that the ExternalMessage is in DittoProtocol
incomingMapping = DefaultIncomingMapping.get();
} else {
incomingMapping = new ScriptedIncomingMapping(contextFactory, scope);
cx.evaluateString(scope, userIncomingScript,
JavaScriptMessageMapperConfigurationProperties.INCOMING_SCRIPT, 1, null);
}
final String userOutgoingScript = getConfiguration()
.flatMap(JavaScriptMessageMapperConfiguration::getOutgoingScript)
.orElse("");
if (userOutgoingScript.isEmpty()) {
// shortcut: the user defined an empty outgoing mapping script -> send the Adaptable as DittoProtocol JSON
outgoingMapping = DefaultOutgoingMapping.get();
} else {
outgoingMapping = new ScriptedOutgoingMapping(contextFactory, scope);
cx.evaluateString(scope, userOutgoingScript,
JavaScriptMessageMapperConfigurationProperties.OUTGOING_SCRIPT, 1, null);
}
}
private Optional<JavaScriptMessageMapperConfiguration> getConfiguration() {
return Optional.ofNullable(configuration);
}
static void loadJavascriptLibrary(final Context cx,
final Scriptable scope,
final Reader reader,
final String libraryName) {
try {
cx.evaluateReader(scope, reader, libraryName, 1, null);
} catch (final IOException e) {
throw new IllegalStateException("Could not load script <" + libraryName + ">", e);
}
}
@Override
public String toString() {
return getClass().getSimpleName() + " [" +
super.toString() +
", configuration=" + configuration +
", incomingMapping=" + incomingMapping +
", outgoingMapping=" + outgoingMapping +
"]";
}
}