-
Notifications
You must be signed in to change notification settings - Fork 26
/
framework.js
577 lines (510 loc) · 18.4 KB
/
framework.js
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
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
import {parse as parseUrl} from "node:url";
import http from "node:http";
import https from "node:https";
import httpProxy from "http-proxy";
import {statSync, readFileSync} from "node:fs";
import path from "node:path";
import {fileURLToPath} from "node:url";
import yaml from "js-yaml";
import {Router} from "express";
import {ErrorMessage} from "./errors.js";
const __dirname = path.dirname(fileURLToPath(import.meta.url));
export default class Framework {
constructor() {
this.config = {};
}
createPluginFilesPattern(pattern) {
return {pattern, included: true, served: true, watched: false};
}
createProjectFilesPattern(pattern) {
return {pattern, included: false, served: true, watched: true};
}
/**
* Checks if a list of paths exists
*
* @private
* @param {Array} paths List of paths to check
*
* @returns {boolean[]} array if path exist
*/
pathsExist(paths) {
return paths.map((folderName) => this.exists(path.join(this.config.basePath, folderName)));
}
/**
* Checks if a file or path exists
*
* @private
* @param {string} filePath Path to check
* @returns {boolean} true if the file or path exists
*/
exists(filePath) {
try {
return statSync(filePath).isDirectory();
} catch (err) {
// "File or directory does not exist"
if (err.code === "ENOENT") {
return false;
} else {
throw err;
}
}
}
/**
* Mutates config and auto set type if not defined
*/
detectTypeFromFolder() {
const webappFolder = this.config.ui5.paths.webapp;
const srcFolder = this.config.ui5.paths.src;
const testFolder = this.config.ui5.paths.test;
const [hasWebapp, hasSrc, hasTest] = this.pathsExist([webappFolder, srcFolder, testFolder]);
if (hasWebapp) return "application";
if (hasSrc && hasTest) return "library";
}
replaceLast(path, replacement) {
return path.split("/").slice(0, -1).concat(replacement).join("/");
}
checkLegacy(config) {
if (config.openui5 || config.client.openui5) {
this.logger.log("error", ErrorMessage.migrateConfig());
throw new Error(ErrorMessage.failure());
}
}
initScriptMode(config) {
let url;
if (config.ui5.url) {
url = config.ui5.url + "/resources/sap-ui-core.js";
} else {
// Uses middleware if no url has been specified
// Need to use an absolute URL as the file doesn't exist physically but will be
// resolved via our middleware
url = `${config.protocol}//${config.hostname}:${config.port}/base/`;
if (config.ui5.type === "application") {
url += `${config.ui5.paths.webapp}/resources/sap-ui-core.js`;
} else if (config.ui5.type === "library") {
url += `${this.replaceLast(config.ui5.paths.src, "resources")}/sap-ui-core.js`;
}
}
config.client.ui5.config = config.ui5.config;
config.client.ui5.tests = config.ui5.tests;
if (config.ui5.tests) {
config.files.unshift(this.createPluginFilesPattern(`${__dirname}/client/autorun.js`));
}
config.files.unshift(this.createPluginFilesPattern(url));
config.files.unshift(this.createPluginFilesPattern(`${__dirname}/client/sap-ui-config.js`));
}
async init({config, logger}) {
this.config = config;
this.logger = logger.create("ui5.framework");
this.config.basePath = config.basePath || "";
this.config.client = config.client || {};
this.config.client.clearContext = false;
// Always override client ui5 config. It should not be used by consumers.
// Relevant options (e.g. testpage, config, tests) will be written to the client section.
this.config.client.ui5 = {};
this.config.client.ui5.useIframe = true; // for now only allow using iframes in HTML mode
this.config.ui5 = config.ui5 || {};
this.config.middleware = config.middleware || [];
this.config.files = config.files || [];
this.config.beforeMiddleware = config.beforeMiddleware || [];
this.config.reporters = this.config.reporters || [];
if (!this.config.ui5.mode) {
this.config.ui5.mode = "html";
}
if (typeof this.config.ui5.failOnEmptyTestPage === "undefined") {
// TODO 3.0: Enable by default
this.config.ui5.failOnEmptyTestPage = false;
}
this.checkLegacy(config);
if (this.config.ui5.mode && ["script", "html"].indexOf(this.config.ui5.mode) === -1) {
this.logger.log("error", ErrorMessage.invalidMode(this.config.ui5.mode));
throw new Error(ErrorMessage.failure());
}
const incompatibleFrameworks = ["qunit", "sinon"];
const hasIncompatibleFrameworks =
(frameworks) => frameworks.some((fwk) => incompatibleFrameworks.includes(fwk));
if (this.config.ui5.mode === "html" && hasIncompatibleFrameworks(this.config.frameworks || [])) {
this.logger.log("error", ErrorMessage.incompatibleFrameworks(this.config.frameworks) );
throw new Error(ErrorMessage.failure());
}
if (this.config.ui5.mode === "html" && this.config.files.length > 0) {
this.logger.log("error", ErrorMessage.containsFilesDefinition() );
throw new Error(ErrorMessage.failure());
}
if (this.config.ui5.paths && !this.config.ui5.type) {
this.logger.log("error", ErrorMessage.customPathWithoutType() );
throw new Error(ErrorMessage.failure());
}
if (this.config.ui5.mode !== "html" && this.config.ui5.urlParameters) {
this.logger.log("error", ErrorMessage.urlParametersConfigInNonHtmlMode(this.config.ui5.mode,
this.config.ui5.urlParameters));
throw new Error(ErrorMessage.failure());
}
if (this.config.ui5.urlParameters !== undefined && !Array.isArray(this.config.ui5.urlParameters)) {
this.logger.log("error", ErrorMessage.urlParametersNotAnArray(this.config.ui5.urlParameters));
throw new Error(ErrorMessage.failure());
}
if (this.config.ui5.urlParameters) {
this.config.ui5.urlParameters.forEach((urlParameter) => {
if (typeof urlParameter !== "object") {
this.logger.log("error", ErrorMessage.urlParameterNotObject(urlParameter));
throw new Error(ErrorMessage.failure());
}
if (urlParameter.key === undefined || urlParameter.value === undefined) {
this.logger.log("error", ErrorMessage.urlParameterMissingKeyOrValue(urlParameter));
throw new Error(ErrorMessage.failure());
}
});
}
if (this.config.ui5.urlParameters !== undefined && !Array.isArray(this.config.ui5.urlParameters)) {
this.logger.log("error", ErrorMessage.urlParametersNotAnArray(this.config.ui5.urlParameters));
throw new Error(ErrorMessage.failure());
}
if (typeof this.config.ui5.failOnEmptyTestPage !== "boolean") {
this.logger.log(
"error",
ErrorMessage.failOnEmptyTestPageNotTypeBoolean(this.config.ui5.failOnEmptyTestPage)
);
throw new Error(ErrorMessage.failure());
}
if (this.config.ui5.mode !== "html" && this.config.ui5.failOnEmptyTestPage === true) {
this.logger.log("error", ErrorMessage.failOnEmptyTestPageInNonHtmlMode(this.config.ui5.mode));
throw new Error(ErrorMessage.failure());
}
if (this.config.reporters.includes("ui5--fileExport")) {
this.logger.log("error", ErrorMessage.invalidFileExportReporterUsage());
throw new Error(ErrorMessage.failure());
}
if (this.config.ui5.fileExport === true || typeof this.config.ui5.fileExport === "object") {
this.config.reporters.push("ui5--fileExport");
if (this.config.ui5.fileExport === true) {
this.config.ui5.fileExport = {};
}
}
this.config.ui5.paths = this.config.ui5.paths || {
webapp: "webapp",
src: "src",
test: "test"
};
["webapp", "src", "test"].forEach((pathName) => {
let pathValue = this.config.ui5.paths[pathName];
if (!pathValue) {
return;
}
let absolutePathValue;
const absoluteBasePath = path.resolve(this.config.basePath);
// Make sure paths are relative to the basePath
if (path.isAbsolute(pathValue)) {
absolutePathValue = pathValue;
pathValue = path.relative(this.config.basePath, pathValue);
} else {
absolutePathValue = path.resolve(this.config.basePath, pathValue);
}
// Paths must be within basePath
if (!absolutePathValue.startsWith(absoluteBasePath)) {
this.logger.log("error", ErrorMessage.pathNotWithinBasePath({
pathName,
pathValue: this.config.ui5.paths[pathName], // use value given in config here
absolutePathValue,
basePath: absoluteBasePath
}));
throw new Error(ErrorMessage.failure());
}
this.config.ui5.paths[pathName] = pathValue;
});
this.autoDetectType();
if (this.config.ui5.mode === "script") {
this.initScriptMode(config);
} else {
// Add browser bundle including third-party dependencies
this.config.files.unshift(this.createPluginFilesPattern(__dirname + "/../dist/browser-bundle.js"));
}
// Make testpage url available to the client
this.config.client.ui5.testpage = this.config.ui5.testpage;
// Make failOnEmptyTestPage option available to the client
this.config.client.ui5.failOnEmptyTestPage = this.config.ui5.failOnEmptyTestPage;
// Pass configured urlParameters to client
this.config.client.ui5.urlParameters = this.config.ui5.urlParameters;
// Pass fileExport parameter to client
this.config.client.ui5.fileExport = this.config.reporters.includes("ui5--fileExport");
if (this.config.ui5.type === "application") {
const webappFolder = this.config.ui5.paths.webapp;
if (!this.exists(path.join(this.config.basePath, webappFolder))) {
this.logger.log("error", ErrorMessage.applicationFolderNotFound(webappFolder));
throw new Error(ErrorMessage.failure());
}
// Match all files (including dotfiles)
this.config.files.push(
this.createProjectFilesPattern(config.basePath + `/{${webappFolder}/**,${webappFolder}/**/.*}`)
);
} else if (config.ui5.type === "library") {
const srcFolder = this.config.ui5.paths.src;
const testFolder = this.config.ui5.paths.test;
const [hasSrc, hasTest] = this.pathsExist([srcFolder, testFolder]);
if (!hasSrc || !hasTest) {
this.logger.log("error", ErrorMessage.libraryFolderNotFound({
srcFolder, testFolder, hasSrc, hasTest
}));
throw new Error(ErrorMessage.failure());
}
this.config.files.push(
// Match all files (including dotfiles)
this.createProjectFilesPattern(`${config.basePath}/{${srcFolder}/**,${srcFolder}/**/.*}`),
this.createProjectFilesPattern(`${config.basePath}/{${testFolder}/**,${testFolder}/**/.*}`),
);
} else {
this.logger.log("error", ErrorMessage.invalidProjectType(config.ui5.type) );
throw new Error(ErrorMessage.failure());
}
// this.addPreprocessor();
await this.setupMiddleware();
return this;
}
autoDetectType() {
if (this.config.ui5.type) {
return;
}
const {ui5: {configPath}, basePath} = this.config;
const filePath = configPath ?
path.resolve(basePath, configPath) : path.join(basePath, "ui5.yaml");
let fileContent;
try {
fileContent = readFileSync(filePath);
} catch (err) {
if (err.code !== "ENOENT") {
throw err;
}
}
if (fileContent) {
let configs;
try {
configs = yaml.loadAll(fileContent, {
filename: filePath
});
} catch (err) {
if (err.name === "YAMLException") {
this.logger.log("error", ErrorMessage.invalidUI5Yaml({
filePath, yamlException: err
}));
throw Error(ErrorMessage.failure());
} else {
throw err;
}
}
if (!configs[0] || !configs[0].type) {
this.logger.log("error", ErrorMessage.missingTypeInYaml());
throw Error(ErrorMessage.failure());
}
this.config.ui5.type = configs[0].type;
} else {
this.config.ui5.type = this.detectTypeFromFolder();
}
if (!this.config.ui5.type) {
let errorText = "";
if (this.config.basePath.endsWith("/webapp")) {
errorText = ErrorMessage.invalidBasePath();
} else {
errorText = ErrorMessage.invalidFolderStructure();
}
this.logger.log("error", errorText);
throw new Error(ErrorMessage.failure());
}
}
// Adding coverage preprocessor is currently not supported
// /**
// * Adds preprocessors dynamically in case if no preprocessors have been defined in the config
// */
// addPreprocessor() {
// const type = this.config.ui5.type,
// cwd = process.cwd(),
// srcFolder = this.config.ui5.paths.src,
// webappFolder = this.config.ui5.paths.webapp;
// if (this.config.preprocessors && type && Object.keys(this.config.preprocessors).length === 0) {
// if (type === "library") {
// this.config.preprocessors[`${cwd}/${srcFolder}/**/*.js`] = ['coverage'];
// } else if (type === "application") {
// this.config.preprocessors[`${cwd}/{${webappFolder},${webappFolder}/!(test)}/*.js`] = ['coverage'];
// }
// }
// }
/**
* Rewrites the given url to use a virtual path that can be resolved
* by the UI5 Tooling middleware or to conform with the UI5 CDN.
*
* Example (application):
* /base/webapp/resources/sap-ui-core.js -> /resources/sap-ui-core.js
*
* Example (library):
* /base/src/resources/sap-ui-core.js -> /resources/sap-ui-core.js
* /base/test/test-resources/sap-ui-core.js -> /test-resources/sap-ui-core.js
*
* @param {string} url
* @returns {string}
*/
rewriteUrl(url) {
const type = this.config.ui5.type;
const webappFolder = this.config.ui5.paths.webapp;
const srcFolder = this.config.ui5.paths.src;
const testFolder = this.config.ui5.paths.test;
if (!type) {
// TODO: do we want no type to be allowed?
return url;
} else if (type === "application") {
const webappPattern = new RegExp(`^/base/${webappFolder}/`);
if (webappPattern.test(url)) {
return url.replace(webappPattern, "/");
}
} else if (type === "library") {
const srcPattern = new RegExp(`^/base/${srcFolder}/`);
const testPattern = new RegExp(`^/base/${testFolder}/`);
// const basePattern = /^\/base\//; // TODO: is this expected?
if (srcPattern.test(url)) {
return url.replace(srcPattern, "/resources/");
} else if (testPattern.test(url)) {
return url.replace(testPattern, "/test-resources/");
} /* else if (basePattern.test(url)) {
return url.replace(basePattern, "/");
}*/
} else {
this.logger.log("error", ErrorMessage.urlRewriteFailed(type));
return;
}
return url;
}
/**
* Rewrites the given url from a virtual path (resources / test-resources)
* to a filesystem path so that the request can be handled by the karma
* middleware that serves the project files.
*
* This is only relevant for type "library", as it has two separate folders (src / test).
*
* Example:
* /base/resources/sap-ui-core.js -> /base/src/sap-ui-core.js
* /base/test-resources/sap/ui/test/ -> /base/test/sap/ui/test/
*
* @param {string} url
* @returns {string}
*/
rewriteUrlBefore(url) {
const type = this.config.ui5.type;
if (type !== "library") {
// Only rewrite "before" for type library
return url;
}
const srcFolder = this.config.ui5.paths.src;
const testFolder = this.config.ui5.paths.test;
const resourcesSrcPattern = new RegExp(
`/base/${this.replaceLast(srcFolder, "resources")}/`
);
const resourcesTestPattern = new RegExp(
`/base/${this.replaceLast(testFolder, "resources")}/`
);
const testResourcesSrcPattern = new RegExp(
`/base/${this.replaceLast(srcFolder, "test-resources")}/`
);
const testResourcesTestPattern = new RegExp(
`/base/${this.replaceLast(testFolder, "test-resources")}/`
);
if (resourcesSrcPattern.test(url)) {
return url.replace(resourcesSrcPattern, `/base/${srcFolder}/`);
} else if (resourcesTestPattern.test(url)) {
return url.replace(resourcesTestPattern, `/base/${srcFolder}/`);
} else if (testResourcesSrcPattern.test(url)) {
return url.replace(testResourcesSrcPattern, `/base/${testFolder}/`);
} else if (testResourcesTestPattern.test(url)) {
return url.replace(testResourcesTestPattern, `/base/${testFolder}/`);
}
return url;
}
async applyUI5Middleware(router, {basePath, configPath}) {
const graphOptions = {
cwd: basePath
};
if (configPath) {
graphOptions.rootConfigPath = path.resolve(basePath, configPath);
}
const {graphFromPackageDependencies} = await import("@ui5/project/graph");
const {createReaderCollection} = await import("@ui5/fs/resourceFactory");
const ReaderCollectionPrioritized = (await import("@ui5/fs/ReaderCollectionPrioritized")).default;
const graph = await graphFromPackageDependencies(graphOptions);
const rootProject = graph.getRoot();
const readers = [];
await graph.traverseBreadthFirst(async function({project: dep}) {
if (dep.getName() === rootProject.getName()) {
// Ignore root project
return;
}
readers.push(dep.getReader({style: "runtime"}));
});
const dependencies = createReaderCollection({
name: `Dependency reader collection for project ${rootProject.getName()}`,
readers
});
const rootReader = rootProject.getReader({style: "runtime"});
const combo = new ReaderCollectionPrioritized({
name: "server - prioritize workspace over dependencies",
readers: [rootReader, dependencies]
});
const resources = {
rootProject: rootReader,
dependencies: dependencies,
all: combo
};
const MiddlewareManager = (await import("@ui5/server/internal/MiddlewareManager")).default;
const middlewareManager = new MiddlewareManager({
graph,
rootProject,
resources,
});
await middlewareManager.applyMiddleware(router);
}
async setupUI5Server({basePath, configPath}) {
const router = new Router();
await this.applyUI5Middleware(router, {basePath, configPath});
return router;
}
setupProxy({url}) {
const {protocol} = parseUrl(url);
const Agent = protocol === "https:" ? https.Agent : http.Agent;
const agent = new Agent({keepAlive: true});
const proxy = httpProxy.createProxyServer({
target: url,
changeOrigin: true,
agent
});
proxy.on("error", (err, req /* , res*/) => {
this.logger.warn(`Failed to proxy ${req.url} (${err.code}: ${err.message})`);
});
return (req, res) => proxy.web(req, res);
}
beforeMiddlewareRewriteUrl(req, res, next) {
req.url = this.rewriteUrlBefore(req.url);
next();
}
middlewareRewriteUrl(req, res, next) {
req.url = this.rewriteUrl(req.url);
next();
}
async setupMiddleware() {
const config = this.config;
if (config.ui5.type === "library") {
config.ui5._beforeMiddleware = new Router();
config.ui5._beforeMiddleware.use(this.beforeMiddlewareRewriteUrl.bind(this));
config.beforeMiddleware.push("ui5--beforeMiddleware");
}
let middleware;
if (config.ui5.url) {
middleware = this.setupProxy(config.ui5);
} else if (config.ui5.useMiddleware !== false) {
middleware = await this.setupUI5Server({
basePath: config.basePath,
configPath: config.ui5.configPath
});
}
if (middleware) {
config.ui5._middleware = new Router();
config.ui5._middleware.use(this.middlewareRewriteUrl.bind(this));
config.ui5._middleware.use(middleware);
config.middleware.push("ui5--middleware");
}
}
}