@webos-tools/cli 3.2.0 → 3.2.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (152) hide show
  1. package/.eslintignore +1 -1
  2. package/.eslintrc.js +52 -52
  3. package/.vscode/c_cpp_properties.json +21 -0
  4. package/.vscode/launch.json +97 -0
  5. package/.vscode/settings.json +13 -0
  6. package/.vscode/tasks.json +32 -0
  7. package/APIs.js +79 -79
  8. package/CHANGELOG.md +11 -5
  9. package/LICENSE +201 -201
  10. package/bin/ares-config.js +1 -1
  11. package/bin/ares-device-info.js +30 -30
  12. package/bin/ares-generate.js +274 -274
  13. package/bin/ares-inspect.js +179 -179
  14. package/bin/ares-install.js +223 -223
  15. package/bin/ares-log.js +259 -259
  16. package/bin/ares-pull.js +156 -156
  17. package/bin/ares-push.js +155 -155
  18. package/bin/ares-server.js +174 -174
  19. package/bin/ares-setup-device.js +6 -10
  20. package/bin/ares-shell.js +132 -132
  21. package/bin/ares.js +166 -166
  22. package/files/conf/ares.json +1 -2
  23. package/files/conf/ipk.json +30 -30
  24. package/files/conf/novacom-devices.json +2 -2
  25. package/files/conf/query/query-app.json +14 -14
  26. package/files/conf/query/query-hosted.json +18 -18
  27. package/files/conf/query/query-package.json +10 -10
  28. package/files/conf/query/query-service.json +6 -6
  29. package/files/conf/webos_emul +27 -27
  30. package/files/conf-base/env/sdk-apollo.json +8 -8
  31. package/files/conf-base/env/sdk-ose.json +8 -8
  32. package/files/conf-base/env/sdk-tv.json +8 -8
  33. package/files/conf-base/profile/config-apollo.json +29 -29
  34. package/files/conf-base/profile/config-ose.json +29 -29
  35. package/files/conf-base/profile/config-tv.json +31 -31
  36. package/files/conf-base/query/query-app.json +14 -14
  37. package/files/conf-base/query/query-hosted.json +18 -18
  38. package/files/conf-base/query/query-package.json +10 -10
  39. package/files/conf-base/query/query-service.json +6 -6
  40. package/files/conf-base/query/signage/query-app.json +1 -1
  41. package/files/conf-base/query/signage/query-service.json +1 -1
  42. package/files/conf-base/template-conf/ose-templates.json +67 -67
  43. package/files/conf-base/template-conf/tv-sdk-templates.json +57 -57
  44. package/files/help/ares-device.help +109 -109
  45. package/files/help/ares-install.help +95 -95
  46. package/files/help/ares-launch.help +1 -1
  47. package/files/help/ares-log-pmlogd.help +84 -84
  48. package/files/help/ares-log.help +101 -101
  49. package/files/help/ares-novacom.help +68 -68
  50. package/files/help/ares-pull.help +38 -38
  51. package/files/help/ares-push.help +38 -38
  52. package/files/help/ares-server.help +44 -44
  53. package/files/help/ares-shell.help +42 -42
  54. package/files/help/ares.help +52 -52
  55. package/files/help/readme.help +23 -23
  56. package/files/schema/ApplicationDescription.schema +319 -319
  57. package/files/templates/apollo-sdk-templates/appinfo/appinfo.json +10 -10
  58. package/files/templates/apollo-sdk-templates/bootplate-web/index.html +88 -88
  59. package/files/templates/apollo-sdk-templates/hosted-webapp/index.html +13 -13
  60. package/files/templates/apollo-sdk-templates/js-service/helloclient.js +31 -31
  61. package/files/templates/apollo-sdk-templates/js-service/helloworld_webos_service.js +188 -188
  62. package/files/templates/apollo-sdk-templates/serviceinfo/package.json +11 -11
  63. package/files/templates/apollo-sdk-templates/serviceinfo/services.json +8 -8
  64. package/files/templates/ose-sdk-templates/appinfo/appinfo.json +10 -10
  65. package/files/templates/ose-sdk-templates/bootplate-web/index.html +88 -88
  66. package/files/templates/ose-sdk-templates/hosted-webapp/index.html +13 -13
  67. package/files/templates/ose-sdk-templates/js-service/helloclient.js +31 -31
  68. package/files/templates/ose-sdk-templates/js-service/helloworld_webos_service.js +188 -188
  69. package/files/templates/ose-sdk-templates/qml-app/main.qml +68 -68
  70. package/files/templates/ose-sdk-templates/qmlappinfo/appinfo.json +10 -10
  71. package/files/templates/ose-sdk-templates/serviceinfo/package.json +11 -11
  72. package/files/templates/ose-sdk-templates/serviceinfo/services.json +8 -8
  73. package/files/templates/signage-sdk-templates/Backlight_Scheduling/index.html +1 -1
  74. package/files/templates/signage-sdk-templates/Backlight_Scheduling/scheduler.js +2 -3
  75. package/files/templates/signage-sdk-templates/File_Explorer/index.html +1 -33
  76. package/files/templates/signage-sdk-templates/File_Explorer/js/Root.js +0 -9
  77. package/files/templates/tv-sdk-templates/appinfo/appinfo.json +10 -10
  78. package/files/templates/tv-sdk-templates/bootplate-web/index.html +58 -58
  79. package/files/templates/tv-sdk-templates/bootplate-web/webOSTVjs-1.2.10/LICENSE-2.0.txt +202 -202
  80. package/files/templates/tv-sdk-templates/hosted-webapp/index.html +14 -14
  81. package/files/templates/tv-sdk-templates/js-service/helloworld_service.js +39 -39
  82. package/files/templates/tv-sdk-templates/packageinfo/packageinfo.json +3 -3
  83. package/files/templates/tv-sdk-templates/serviceinfo/package.json +11 -11
  84. package/files/templates/tv-sdk-templates/serviceinfo/services.json +8 -8
  85. package/lib/base/ares.html +40 -40
  86. package/lib/base/cli-appdata.js +290 -289
  87. package/lib/base/cli-control.js +44 -44
  88. package/lib/base/common-tools.js +29 -29
  89. package/lib/base/error-handler.js +265 -265
  90. package/lib/base/file-watcher.js +155 -155
  91. package/lib/base/help-format.js +147 -147
  92. package/lib/base/luna.js +178 -178
  93. package/lib/base/novacom.js +4 -4
  94. package/lib/base/sdkenv.js +59 -59
  95. package/lib/base/server.js +137 -137
  96. package/lib/base/setup-device.js +2 -2
  97. package/lib/base/version-tools.js +79 -79
  98. package/lib/device.js +1419 -1419
  99. package/lib/generator.js +1 -1
  100. package/lib/inspect.js +493 -493
  101. package/lib/log.js +584 -584
  102. package/lib/package.js +61 -7
  103. package/lib/pull.js +231 -231
  104. package/lib/pusher.js +210 -210
  105. package/lib/session.js +74 -74
  106. package/lib/shell.js +193 -193
  107. package/lib/tar-filter-pack.js +62 -62
  108. package/lib/util/copy.js +31 -31
  109. package/lib/util/createFileName.js +40 -40
  110. package/lib/util/eof.js +30 -30
  111. package/lib/util/json.js +63 -63
  112. package/lib/util/merge.js +14 -14
  113. package/lib/util/objclone.js +40 -40
  114. package/lib/util/spinner.js +37 -37
  115. package/npm-shrinkwrap.json +2 -2
  116. package/package.json +1 -1
  117. package/scripts/postinstall.js +24 -24
  118. package/spec/helpers/reporter.js +65 -65
  119. package/spec/jsSpecs/apiTest/generator.spec.js +372 -372
  120. package/spec/jsSpecs/apiTest/inspector.spec.js +89 -89
  121. package/spec/jsSpecs/apiTest/installer.spec.js +67 -67
  122. package/spec/jsSpecs/apiTest/launcher.spec.js +150 -150
  123. package/spec/jsSpecs/apiTest/packager.spec.js +194 -194
  124. package/spec/jsSpecs/apiTest/puller.spec.js +101 -101
  125. package/spec/jsSpecs/apiTest/pusher.spec.js +103 -103
  126. package/spec/jsSpecs/apiTest/server.spec.js +115 -115
  127. package/spec/jsSpecs/apiTest/setupDevice.spec.js +93 -93
  128. package/spec/jsSpecs/apiTest/shell.spec.js +49 -49
  129. package/spec/jsSpecs/ares-config.spec.js +88 -88
  130. package/spec/jsSpecs/ares-device.spec.js +443 -443
  131. package/spec/jsSpecs/ares-generate.spec.js +397 -401
  132. package/spec/jsSpecs/ares-inspect.spec.js +252 -252
  133. package/spec/jsSpecs/ares-install.spec.js +150 -150
  134. package/spec/jsSpecs/ares-log.spec.js +824 -824
  135. package/spec/jsSpecs/ares-novacom.spec.js +149 -149
  136. package/spec/jsSpecs/ares-pull.spec.js +157 -157
  137. package/spec/jsSpecs/ares-push.spec.js +146 -146
  138. package/spec/jsSpecs/ares-setup-device.spec.js +1 -0
  139. package/spec/jsSpecs/ares-shell.spec.js +220 -220
  140. package/spec/jsSpecs/ares.spec.js +83 -83
  141. package/spec/support/jasmine.json +22 -22
  142. package/spec/tempFiles/nativeApp/auto/pkg_arm64/appinfo.json +9 -9
  143. package/spec/tempFiles/nativeApp/ose/pkg_arm/appinfo.json +8 -8
  144. package/spec/tempFiles/nativeApp/ose/pkg_arm/package.properties +2 -2
  145. package/spec/tempFiles/nativeApp/oseEmul/pkg_x86/appinfo.json +9 -9
  146. package/spec/tempFiles/nativeApp/rsi/pkg_x86/appinfo.json +9 -9
  147. package/spec/tempFiles/sign/sign.crt +32 -32
  148. package/spec/tempFiles/sign/signPriv.key +52 -52
  149. package/spec/test_data/ares-generate.json +58 -91
  150. package/spec/test_data/ares.json +50 -50
  151. package/webos-tools-cli-3.2.1.tgz +0 -0
  152. package/webos-tools-cli-3.2.0.tgz +0 -0
package/lib/inspect.js CHANGED
@@ -1,493 +1,493 @@
1
- /*
2
- * Copyright (c) 2020-2024 LG Electronics Inc.
3
- *
4
- * SPDX-License-Identifier: Apache-2.0
5
- */
6
-
7
- const async = require('async'),
8
- npmlog = require('npmlog'),
9
- path = require('path'),
10
- request = require('request'),
11
- util = require('util'),
12
- installer = require('./install'),
13
- launcher = require('./launch'),
14
- errHndl = require('./base/error-handler'),
15
- luna = require('./base/luna'),
16
- novacom = require('./base/novacom'),
17
- sdkenv = require('./base/sdkenv'),
18
- server = require('./base/server'),
19
- spinner = require('./util/spinner');
20
-
21
- // The node service debugging ways has changed based on node version 8.
22
- const nodeBaseVersion = "8",
23
- defaultAppInsptPort = "9998",
24
- defaultNodeInsptPort = "8080",
25
- defaultServiceDebugPort = "5885";
26
- let platformNodeVersion = "0";
27
-
28
- (function() {
29
- const log = npmlog;
30
- log.heading = 'inspector';
31
- log.level = 'warn';
32
-
33
- const inspector = {
34
- /**
35
- * @property {Object} log an npm log instance
36
- */
37
- log: log,
38
-
39
- inspect: function(options, next) {
40
- if (typeof next !== 'function') {
41
- throw errHndl.getErrMsg("MISSING_CALLBACK", "next", util.inspect(next));
42
- }
43
-
44
- options.svcDbgInfo = {}; /* { id : { port : String , path : String } } */
45
- if (options && Object.prototype.hasOwnProperty.call(options, 'serviceId')) {
46
- if (options.serviceId instanceof Array) {
47
- options.serviceId.forEach(function(id) {
48
- options.svcDbgInfo[id] = {};
49
- });
50
- } else {
51
- options.svcDbgInfo[options.serviceId] = {};
52
- }
53
- }
54
-
55
- async.series([
56
- _findSdkEnv,
57
- _makeSession,
58
- _getPkgList,
59
- _runApp,
60
- _runAppPortForwardServer,
61
- _runAppInspector,
62
- _runServicePortForwardServer
63
- ], function(err, results) {
64
- log.silly("inspect#inspect()", "err:", err, ", results:", results);
65
- const returnObj = {session: options.session};
66
- returnObj.msg = options.serviceId ? results[6] : "Application Debugging - " + results[5];
67
- next(err, returnObj);
68
- });
69
-
70
- function _findSdkEnv(next) {
71
- const env = new sdkenv.Env();
72
- env.getEnvValue("BROWSER", function(err, browserPath) {
73
- options.bundledBrowserPath = browserPath;
74
- next();
75
- });
76
- }
77
-
78
- function _getPkgList(next) {
79
- if (!options.serviceId) {
80
- return next();
81
- }
82
-
83
- installer.list(options, function(err, pkgs) {
84
- if (pkgs instanceof Array) {
85
- options.instPkgs = pkgs;
86
- }
87
- next(err);
88
- });
89
- }
90
-
91
- function _makeSession(next) {
92
- options.nReplies = 1; // -n 1
93
- const printTarget = true;
94
- options.session = new novacom.Session(options.device, printTarget, next);
95
- }
96
-
97
- function _runApp(next) {
98
- log.verbose("inspect#inspect()#_runApp()");
99
- if (!options.appId || options.running) {
100
- return next();
101
- }
102
-
103
- launcher.listRunningApp(options, function(err, runningApps) {
104
- if (err) {
105
- return next(err);
106
- }
107
-
108
- runningApps = [].concat(runningApps);
109
- const runAppIds = runningApps.map(function(app) {
110
- return app.id;
111
- });
112
-
113
- log.info("inspect#inspect()#_runApp()", "runAppIds:", runAppIds.join(','));
114
- if (runAppIds.indexOf(options.appId) === -1) {
115
- log.verbose("inspect#inspect()#_runApp#launch", options.appId);
116
- launcher.launch(options, options.appId, {}, next);
117
- } else {
118
- next();
119
- }
120
- });
121
- }
122
-
123
- function _runAppPortForwardServer(next) {
124
- if (options.appId) {
125
- const insptPort = options.sessionInsptPort || defaultAppInsptPort;
126
- log.verbose("inspect#inspect()#_runAppPortForwardServer()", "insptPort : " + insptPort);
127
-
128
- options.session.forward(insptPort , options.hostPort || 0 /* random port */, options.appId, next);
129
- } else {
130
- next();
131
- }
132
- }
133
-
134
- function __findNewDebugPort(dbgPort, next) {
135
- const format = "netstat -ltn 2>/dev/null | grep :%s | wc -l",
136
- cmdPortInUsed = util.format(format, dbgPort);
137
-
138
- async.series([
139
- options.session.run.bind(options.session, cmdPortInUsed, process.stdin, _onData, process.stderr),
140
- ], function(err) {
141
- if (err) {
142
- next(err);
143
- }
144
- });
145
-
146
- function _onData(data) {
147
- let str;
148
- if (Buffer.isBuffer(data)) {
149
- str = data.toString().trim();
150
- } else {
151
- str = data.trim();
152
- }
153
-
154
- if (str === "0") {
155
- log.silly("inspect#inspect()#__findNewDebugPort()", "final dbgPort : " + dbgPort);
156
- next(null, dbgPort);
157
- } else if (str === "1") {
158
- dbgPort = Number(dbgPort) +1;
159
- __findNewDebugPort(dbgPort, next);
160
- } else {
161
- return next(errHndl.getErrMsg("FAILED_GET_PORT"));
162
- }
163
- }
164
- }
165
-
166
- function __getNodeVersion(next) {
167
- const format = "node -v";
168
- let count = 0;
169
-
170
- async.series([
171
- options.session.run.bind(options.session, format, process.stdin, _onData, process.stderr),
172
- ], function(err) {
173
- if (err) {
174
- next(err);
175
- }
176
- });
177
-
178
- function _onData(data) {
179
- if (++count > 1)
180
- return;
181
-
182
- if (Buffer.isBuffer(data)) {
183
- platformNodeVersion = data.toString().trim();
184
- } else {
185
- platformNodeVersion = data.trim();
186
- }
187
-
188
- const parsedVersion = platformNodeVersion.split(".");
189
- platformNodeVersion = Number(parsedVersion[0].substring(1, parsedVersion[0].length));
190
- next();
191
- }
192
- }
193
-
194
- function _runServicePortForwardServer(next) {
195
- let guideText = "";
196
- const svcIds = Object.keys(options.svcDbgInfo).filter(function(id) {
197
- return id !== 'undefined';
198
- });
199
- async.forEachSeries(svcIds, __eachServicePortForward, function(err) {
200
- next(err, guideText);
201
- }
202
- );
203
-
204
- function __eachServicePortForward(serviceId, next) {
205
- if (!serviceId) {
206
- return next();
207
- }
208
-
209
- // Only for Auto, add display+1 in prefix port
210
- const sessionPort = Number(options.display) +1;
211
- let dbgPort = defaultServiceDebugPort;
212
-
213
- if (options.sessionId && options.display !== undefined) {
214
- dbgPort = sessionPort + dbgPort;
215
- }
216
-
217
- log.info("inspect#inspect()#_eachServicePortForward()", "sessionId:" + options.sessionId + ", default dbgPort : " + dbgPort);
218
- const __printInspectGuide = function(svcId, next) {
219
- if (options.open) {
220
- guideText = "Cannot support \"--open option\" on platform node version 8 and later\n";
221
- }
222
- // From node v16.18.1 on platform, using 127.0.0.1 instead of localhost
223
- guideText += "To debug your service, set " + "\"127.0.0.1:" + options.session.getLocalPortByName(svcId) +
224
- "\" on Node's Inspector Client(Chrome DevTools, Visual Studio Code, etc.).";
225
- next();
226
- };
227
-
228
- const __launchServiceInspector = function(svcId, next) {
229
- if (!options.svcDbgInfo[svcId].port) {
230
- return next();
231
- }
232
- // open browser with the following url.
233
- // http://localhost:(host random port)/debug?port=(node debug port)
234
- const ip = 'localhost',
235
- nodeInsptPort = options.session.getLocalPortByName(svcId),
236
- nodeDebugPort = options.svcDbgInfo[svcId].port,
237
- urlFormat = "http://%s:%s/debug?port=%s",
238
- nodeInsptUrl = util.format(urlFormat, ip, nodeInsptPort, nodeDebugPort);
239
- let killTimer;
240
-
241
- request.get(nodeInsptUrl, function(error, response) {
242
- if (!error && response.statusCode === 200) {
243
- server.runServer(__dirname, 0, _reqHandler, _postAction);
244
- }
245
-
246
- function _reqHandler(code, res) {
247
- if (code === "@@ARES_CLOSE@@") {
248
- res.status(200).send();
249
- killTimer = setTimeout(function() {
250
- process.exit(0);
251
- }, 2 * 1000);
252
- } else if (code === "@@GET_URL@@") {
253
- clearTimeout(killTimer);
254
- res.status(200).send(nodeInsptUrl);
255
- }
256
- }
257
-
258
- function _postAction(err, serverInfo) {
259
- if (err) {
260
- process.exit(1);
261
- } else if (serverInfo && serverInfo.msg && options.open) {
262
- server.openBrowser(serverInfo.openBrowserUrl, options.bundledBrowserPath);
263
- }
264
- guideText = "nodeInsptUrl: " + nodeInsptUrl;
265
- next();
266
- }
267
- });
268
- };
269
-
270
- async.waterfall([
271
- function findSvcFilePath(next) {
272
- log.info("inspect#inspect()#findSvcFilePath()");
273
- spinner.start();
274
- if (options.instPkgs) {
275
- options.instPkgs.every(function(pkg) {
276
- if (serviceId.indexOf(pkg.id) !== -1) {
277
- options.svcDbgInfo[serviceId].path = path.join(path.dirname(pkg.folderPath), '..', 'services', serviceId).replace(/\\/g, '/');
278
- return false;
279
- }
280
- return true;
281
- });
282
- }
283
- if (!options.svcDbgInfo[serviceId].path) {
284
- return next(errHndl.getErrMsg("FAILED_GET_SVCPATH", serviceId));
285
- }
286
- next();
287
- },
288
- function parserMeta(next) {
289
- const metaFilePath = path.join(options.svcDbgInfo[serviceId].path, "services.json").replace(/\\/g, '/'),
290
- cmdCatServiceInfo = "cat " + metaFilePath;
291
- let metaData;
292
-
293
- async.series([
294
- options.session.run.bind(options.session, cmdCatServiceInfo, process.stdin, _onData, process.stderr)
295
- ], function(err) {
296
- if (err) {
297
- return next(errHndl.getErrMsg("FAILED_FIND_SERVICE", serviceId));
298
- }
299
- });
300
-
301
- function _onData(data) {
302
- if (Buffer.isBuffer(data)) {
303
- metaData = data.toString().trim();
304
- } else {
305
- metaData = data.trim();
306
- }
307
- next(null, metaData);
308
- }
309
- },
310
- function checkServiceType(metaData, next) {
311
- try {
312
- const metaInfo = JSON.parse(metaData);
313
- if (metaInfo.engine === "native") {
314
- return next(errHndl.getErrMsg("USE_GDB", serviceId));
315
- }
316
- next();
317
- } catch (err) {
318
- next(err);
319
- }
320
- },
321
- function quitPrevService(next) {
322
- options.nReplies = 1;
323
- const param = {},
324
- addr = {
325
- "service": serviceId,
326
- "method": "quit"
327
- };
328
-
329
- luna.send(options, addr, param, function() {
330
- next();
331
- }, next);
332
- },
333
- function mkDirForDbgFile(next) {
334
- const cmdMkDir = "mkdir -p " + options.svcDbgInfo[serviceId].path + "/_ares";
335
- options.session.runNoHangup(cmdMkDir, next);
336
- },
337
- __findNewDebugPort.bind(this, dbgPort),
338
- function makeDbgFile(port, next) {
339
- dbgPort = port;
340
- const cmdWriteDbgPort = "echo " + dbgPort + " > " + options.svcDbgInfo[serviceId].path + "/_ares/debugger-port";
341
- options.session.runNoHangup(cmdWriteDbgPort, next);
342
- },
343
- function(next) {
344
- setTimeout(function() {
345
- next();
346
- },1000);
347
- },
348
- function runService(next) {
349
- log.info("inspect#inspect()#runService()", "serviceId :", serviceId);
350
- const param = {},
351
- addr = {
352
- "service": serviceId,
353
- "method": "info"
354
- };
355
- options.svcDbgInfo[serviceId].port = dbgPort;
356
- options.nReplies = 1;
357
-
358
- luna.send(options, addr, param, function() {
359
- next();
360
- }, next);
361
- },
362
- function(next) {
363
- setTimeout(function() {
364
- next();
365
- },1000);
366
- },
367
- __getNodeVersion.bind(this),
368
- function doPortForward(next) {
369
- log.info("inspect#inspect()#_doPortForward()", "platformNodeVersion: "+ platformNodeVersion + ", nodeBaseVersion: " + nodeBaseVersion);
370
- if (platformNodeVersion < nodeBaseVersion) {
371
- options.session.forward(defaultNodeInsptPort, options.hostPort || 0 /* random port */, serviceId, next);
372
- }
373
- else if (platformNodeVersion >= nodeBaseVersion) {
374
- options.session.forward(dbgPort, options.hostPort || 0 /* random port */, serviceId, next);
375
- }
376
- },
377
- function clearDbgFile(next) {
378
- const cmdRmDbgFile = "rm -rf " + options.svcDbgInfo[serviceId].path + "/_ares";
379
- options.session.runNoHangup(cmdRmDbgFile, next);
380
- },
381
- // FIXME: this code is need to improve.
382
- function printGuide(next) {
383
- spinner.stop();
384
- if (platformNodeVersion < nodeBaseVersion) {
385
- __launchServiceInspector(serviceId, next);
386
- }
387
- else if (platformNodeVersion >= nodeBaseVersion) {
388
- __printInspectGuide(serviceId, next);
389
- }
390
- }
391
- ], function(err, results) {
392
- log.silly("inspect#inspect()", "err:", err, ", results:", results);
393
- next(err, results);
394
- });
395
- }
396
- }
397
-
398
- function _runAppInspector(next) {
399
- let url, killTimer,
400
- listFiles = [
401
- { reqPath: "/pagelist.json", propName: "inspectorUrl" }, /* AFRO, BHV */
402
- { reqPath: "/json/list", propName: "devtoolsFrontendUrl" } /* DRD */
403
- ];
404
-
405
- function _getDisplayUrl(next) {
406
- const listFile = listFiles.pop();
407
- if (!listFile) {
408
- return next();
409
- }
410
-
411
- request.get(url + listFile.reqPath, function(error, response, body) {
412
- if (error || response.statusCode !== 200) {
413
- return next();
414
- }
415
- const pagelist = JSON.parse(body);
416
- for (const index in pagelist) {
417
- if (pagelist[index].url.indexOf(options.appId) !== -1 ||
418
- pagelist[index].url.indexOf(options.localIP) !== -1) {
419
- if (!pagelist[index][listFile.propName]) {
420
- return next(errHndl.getErrMsg("USING_WEBINSPECTOR"));
421
- }
422
- url += pagelist[index][listFile.propName];
423
- listFiles = [];
424
- break;
425
- }
426
- }
427
- next(null, listFiles);
428
- });
429
- }
430
-
431
- function _reqHandler(code, res) {
432
- if (code === "@@ARES_CLOSE@@") {
433
- res.status(200).send();
434
- killTimer = setTimeout(function() {
435
- process.exit(0);
436
- }, 2 * 1000);
437
- } else if (code === "@@GET_URL@@") {
438
- clearTimeout(killTimer);
439
- res.status(200).send(url);
440
- }
441
- }
442
-
443
- function _postAction(err, serverInfo) {
444
- spinner.stop();
445
- if (err) {
446
- process.exit(1);
447
- } else if (serverInfo && serverInfo.msg && options.open) {
448
- server.openBrowser(serverInfo.openBrowserUrl, options.bundledBrowserPath);
449
- }
450
- next(null, url);
451
- }
452
-
453
- if (options.appId) {
454
- url = "http://localhost:" + options.session.getLocalPortByName(options.appId);
455
- if (options.session.target.noPortForwarding) {
456
- log.verbose("inspect#inspect()","noPortForwarding");
457
- const insptPort = options.sessionInsptPort || defaultAppInsptPort;
458
- url = "http://" + options.session.target.host + ":" + insptPort;
459
- }
460
-
461
- async.whilst(
462
- function(callBack) {
463
- callBack(null, listFiles && listFiles.length > 0);
464
- },
465
- _getDisplayUrl.bind(this),
466
- function(err) {
467
- if (err) {
468
- return next(err);
469
- }
470
- server.runServer(__dirname, 0, _reqHandler, _postAction);
471
- }
472
- );
473
- } else {
474
- next();
475
- }
476
- }
477
- },
478
-
479
- stop: function(session, next) {
480
- log.verbose("inspect#stop()", "session:", session);
481
- if (!session.end) {
482
- return next(errHndl.getErrMsg("NOT_EXIST_INSPECTOR"));
483
- }
484
-
485
- session.end();
486
- next(null, {msg: "This inspection has stopped"});
487
- }
488
- };
489
-
490
- if (typeof module !== 'undefined' && module.exports) {
491
- module.exports = inspector;
492
- }
493
- }());
1
+ /*
2
+ * Copyright (c) 2020-2024 LG Electronics Inc.
3
+ *
4
+ * SPDX-License-Identifier: Apache-2.0
5
+ */
6
+
7
+ const async = require('async'),
8
+ npmlog = require('npmlog'),
9
+ path = require('path'),
10
+ request = require('request'),
11
+ util = require('util'),
12
+ installer = require('./install'),
13
+ launcher = require('./launch'),
14
+ errHndl = require('./base/error-handler'),
15
+ luna = require('./base/luna'),
16
+ novacom = require('./base/novacom'),
17
+ sdkenv = require('./base/sdkenv'),
18
+ server = require('./base/server'),
19
+ spinner = require('./util/spinner');
20
+
21
+ // The node service debugging ways has changed based on node version 8.
22
+ const nodeBaseVersion = "8",
23
+ defaultAppInsptPort = "9998",
24
+ defaultNodeInsptPort = "8080",
25
+ defaultServiceDebugPort = "5885";
26
+ let platformNodeVersion = "0";
27
+
28
+ (function() {
29
+ const log = npmlog;
30
+ log.heading = 'inspector';
31
+ log.level = 'warn';
32
+
33
+ const inspector = {
34
+ /**
35
+ * @property {Object} log an npm log instance
36
+ */
37
+ log: log,
38
+
39
+ inspect: function(options, next) {
40
+ if (typeof next !== 'function') {
41
+ throw errHndl.getErrMsg("MISSING_CALLBACK", "next", util.inspect(next));
42
+ }
43
+
44
+ options.svcDbgInfo = {}; /* { id : { port : String , path : String } } */
45
+ if (options && Object.prototype.hasOwnProperty.call(options, 'serviceId')) {
46
+ if (options.serviceId instanceof Array) {
47
+ options.serviceId.forEach(function(id) {
48
+ options.svcDbgInfo[id] = {};
49
+ });
50
+ } else {
51
+ options.svcDbgInfo[options.serviceId] = {};
52
+ }
53
+ }
54
+
55
+ async.series([
56
+ _findSdkEnv,
57
+ _makeSession,
58
+ _getPkgList,
59
+ _runApp,
60
+ _runAppPortForwardServer,
61
+ _runAppInspector,
62
+ _runServicePortForwardServer
63
+ ], function(err, results) {
64
+ log.silly("inspect#inspect()", "err:", err, ", results:", results);
65
+ const returnObj = {session: options.session};
66
+ returnObj.msg = options.serviceId ? results[6] : "Application Debugging - " + results[5];
67
+ next(err, returnObj);
68
+ });
69
+
70
+ function _findSdkEnv(next) {
71
+ const env = new sdkenv.Env();
72
+ env.getEnvValue("BROWSER", function(err, browserPath) {
73
+ options.bundledBrowserPath = browserPath;
74
+ next();
75
+ });
76
+ }
77
+
78
+ function _getPkgList(next) {
79
+ if (!options.serviceId) {
80
+ return next();
81
+ }
82
+
83
+ installer.list(options, function(err, pkgs) {
84
+ if (pkgs instanceof Array) {
85
+ options.instPkgs = pkgs;
86
+ }
87
+ next(err);
88
+ });
89
+ }
90
+
91
+ function _makeSession(next) {
92
+ options.nReplies = 1; // -n 1
93
+ const printTarget = true;
94
+ options.session = new novacom.Session(options.device, printTarget, next);
95
+ }
96
+
97
+ function _runApp(next) {
98
+ log.verbose("inspect#inspect()#_runApp()");
99
+ if (!options.appId || options.running) {
100
+ return next();
101
+ }
102
+
103
+ launcher.listRunningApp(options, function(err, runningApps) {
104
+ if (err) {
105
+ return next(err);
106
+ }
107
+
108
+ runningApps = [].concat(runningApps);
109
+ const runAppIds = runningApps.map(function(app) {
110
+ return app.id;
111
+ });
112
+
113
+ log.info("inspect#inspect()#_runApp()", "runAppIds:", runAppIds.join(','));
114
+ if (runAppIds.indexOf(options.appId) === -1) {
115
+ log.verbose("inspect#inspect()#_runApp#launch", options.appId);
116
+ launcher.launch(options, options.appId, {}, next);
117
+ } else {
118
+ next();
119
+ }
120
+ });
121
+ }
122
+
123
+ function _runAppPortForwardServer(next) {
124
+ if (options.appId) {
125
+ const insptPort = options.sessionInsptPort || defaultAppInsptPort;
126
+ log.verbose("inspect#inspect()#_runAppPortForwardServer()", "insptPort : " + insptPort);
127
+
128
+ options.session.forward(insptPort , options.hostPort || 0 /* random port */, options.appId, next);
129
+ } else {
130
+ next();
131
+ }
132
+ }
133
+
134
+ function __findNewDebugPort(dbgPort, next) {
135
+ const format = "netstat -ltn 2>/dev/null | grep :%s | wc -l",
136
+ cmdPortInUsed = util.format(format, dbgPort);
137
+
138
+ async.series([
139
+ options.session.run.bind(options.session, cmdPortInUsed, process.stdin, _onData, process.stderr),
140
+ ], function(err) {
141
+ if (err) {
142
+ next(err);
143
+ }
144
+ });
145
+
146
+ function _onData(data) {
147
+ let str;
148
+ if (Buffer.isBuffer(data)) {
149
+ str = data.toString().trim();
150
+ } else {
151
+ str = data.trim();
152
+ }
153
+
154
+ if (str === "0") {
155
+ log.silly("inspect#inspect()#__findNewDebugPort()", "final dbgPort : " + dbgPort);
156
+ next(null, dbgPort);
157
+ } else if (str === "1") {
158
+ dbgPort = Number(dbgPort) +1;
159
+ __findNewDebugPort(dbgPort, next);
160
+ } else {
161
+ return next(errHndl.getErrMsg("FAILED_GET_PORT"));
162
+ }
163
+ }
164
+ }
165
+
166
+ function __getNodeVersion(next) {
167
+ const format = "node -v";
168
+ let count = 0;
169
+
170
+ async.series([
171
+ options.session.run.bind(options.session, format, process.stdin, _onData, process.stderr),
172
+ ], function(err) {
173
+ if (err) {
174
+ next(err);
175
+ }
176
+ });
177
+
178
+ function _onData(data) {
179
+ if (++count > 1)
180
+ return;
181
+
182
+ if (Buffer.isBuffer(data)) {
183
+ platformNodeVersion = data.toString().trim();
184
+ } else {
185
+ platformNodeVersion = data.trim();
186
+ }
187
+
188
+ const parsedVersion = platformNodeVersion.split(".");
189
+ platformNodeVersion = Number(parsedVersion[0].substring(1, parsedVersion[0].length));
190
+ next();
191
+ }
192
+ }
193
+
194
+ function _runServicePortForwardServer(next) {
195
+ let guideText = "";
196
+ const svcIds = Object.keys(options.svcDbgInfo).filter(function(id) {
197
+ return id !== 'undefined';
198
+ });
199
+ async.forEachSeries(svcIds, __eachServicePortForward, function(err) {
200
+ next(err, guideText);
201
+ }
202
+ );
203
+
204
+ function __eachServicePortForward(serviceId, next) {
205
+ if (!serviceId) {
206
+ return next();
207
+ }
208
+
209
+ // Only for Auto, add display+1 in prefix port
210
+ const sessionPort = Number(options.display) +1;
211
+ let dbgPort = defaultServiceDebugPort;
212
+
213
+ if (options.sessionId && options.display !== undefined) {
214
+ dbgPort = sessionPort + dbgPort;
215
+ }
216
+
217
+ log.info("inspect#inspect()#_eachServicePortForward()", "sessionId:" + options.sessionId + ", default dbgPort : " + dbgPort);
218
+ const __printInspectGuide = function(svcId, next) {
219
+ if (options.open) {
220
+ guideText = "Cannot support \"--open option\" on platform node version 8 and later\n";
221
+ }
222
+ // From node v16.18.1 on platform, using 127.0.0.1 instead of localhost
223
+ guideText += "To debug your service, set " + "\"127.0.0.1:" + options.session.getLocalPortByName(svcId) +
224
+ "\" on Node's Inspector Client(Chrome DevTools, Visual Studio Code, etc.).";
225
+ next();
226
+ };
227
+
228
+ const __launchServiceInspector = function(svcId, next) {
229
+ if (!options.svcDbgInfo[svcId].port) {
230
+ return next();
231
+ }
232
+ // open browser with the following url.
233
+ // http://localhost:(host random port)/debug?port=(node debug port)
234
+ const ip = 'localhost',
235
+ nodeInsptPort = options.session.getLocalPortByName(svcId),
236
+ nodeDebugPort = options.svcDbgInfo[svcId].port,
237
+ urlFormat = "http://%s:%s/debug?port=%s",
238
+ nodeInsptUrl = util.format(urlFormat, ip, nodeInsptPort, nodeDebugPort);
239
+ let killTimer;
240
+
241
+ request.get(nodeInsptUrl, function(error, response) {
242
+ if (!error && response.statusCode === 200) {
243
+ server.runServer(__dirname, 0, _reqHandler, _postAction);
244
+ }
245
+
246
+ function _reqHandler(code, res) {
247
+ if (code === "@@ARES_CLOSE@@") {
248
+ res.status(200).send();
249
+ killTimer = setTimeout(function() {
250
+ process.exit(0);
251
+ }, 2 * 1000);
252
+ } else if (code === "@@GET_URL@@") {
253
+ clearTimeout(killTimer);
254
+ res.status(200).send(nodeInsptUrl);
255
+ }
256
+ }
257
+
258
+ function _postAction(err, serverInfo) {
259
+ if (err) {
260
+ process.exit(1);
261
+ } else if (serverInfo && serverInfo.msg && options.open) {
262
+ server.openBrowser(serverInfo.openBrowserUrl, options.bundledBrowserPath);
263
+ }
264
+ guideText = "nodeInsptUrl: " + nodeInsptUrl;
265
+ next();
266
+ }
267
+ });
268
+ };
269
+
270
+ async.waterfall([
271
+ function findSvcFilePath(next) {
272
+ log.info("inspect#inspect()#findSvcFilePath()");
273
+ spinner.start();
274
+ if (options.instPkgs) {
275
+ options.instPkgs.every(function(pkg) {
276
+ if (serviceId.indexOf(pkg.id) !== -1) {
277
+ options.svcDbgInfo[serviceId].path = path.join(path.dirname(pkg.folderPath), '..', 'services', serviceId).replace(/\\/g, '/');
278
+ return false;
279
+ }
280
+ return true;
281
+ });
282
+ }
283
+ if (!options.svcDbgInfo[serviceId].path) {
284
+ return next(errHndl.getErrMsg("FAILED_GET_SVCPATH", serviceId));
285
+ }
286
+ next();
287
+ },
288
+ function parserMeta(next) {
289
+ const metaFilePath = path.join(options.svcDbgInfo[serviceId].path, "services.json").replace(/\\/g, '/'),
290
+ cmdCatServiceInfo = "cat " + metaFilePath;
291
+ let metaData;
292
+
293
+ async.series([
294
+ options.session.run.bind(options.session, cmdCatServiceInfo, process.stdin, _onData, process.stderr)
295
+ ], function(err) {
296
+ if (err) {
297
+ return next(errHndl.getErrMsg("FAILED_FIND_SERVICE", serviceId));
298
+ }
299
+ });
300
+
301
+ function _onData(data) {
302
+ if (Buffer.isBuffer(data)) {
303
+ metaData = data.toString().trim();
304
+ } else {
305
+ metaData = data.trim();
306
+ }
307
+ next(null, metaData);
308
+ }
309
+ },
310
+ function checkServiceType(metaData, next) {
311
+ try {
312
+ const metaInfo = JSON.parse(metaData);
313
+ if (metaInfo.engine === "native") {
314
+ return next(errHndl.getErrMsg("USE_GDB", serviceId));
315
+ }
316
+ next();
317
+ } catch (err) {
318
+ next(err);
319
+ }
320
+ },
321
+ function quitPrevService(next) {
322
+ options.nReplies = 1;
323
+ const param = {},
324
+ addr = {
325
+ "service": serviceId,
326
+ "method": "quit"
327
+ };
328
+
329
+ luna.send(options, addr, param, function() {
330
+ next();
331
+ }, next);
332
+ },
333
+ function mkDirForDbgFile(next) {
334
+ const cmdMkDir = "mkdir -p " + options.svcDbgInfo[serviceId].path + "/_ares";
335
+ options.session.runNoHangup(cmdMkDir, next);
336
+ },
337
+ __findNewDebugPort.bind(this, dbgPort),
338
+ function makeDbgFile(port, next) {
339
+ dbgPort = port;
340
+ const cmdWriteDbgPort = "echo " + dbgPort + " > " + options.svcDbgInfo[serviceId].path + "/_ares/debugger-port";
341
+ options.session.runNoHangup(cmdWriteDbgPort, next);
342
+ },
343
+ function(next) {
344
+ setTimeout(function() {
345
+ next();
346
+ },1000);
347
+ },
348
+ function runService(next) {
349
+ log.info("inspect#inspect()#runService()", "serviceId :", serviceId);
350
+ const param = {},
351
+ addr = {
352
+ "service": serviceId,
353
+ "method": "info"
354
+ };
355
+ options.svcDbgInfo[serviceId].port = dbgPort;
356
+ options.nReplies = 1;
357
+
358
+ luna.send(options, addr, param, function() {
359
+ next();
360
+ }, next);
361
+ },
362
+ function(next) {
363
+ setTimeout(function() {
364
+ next();
365
+ },1000);
366
+ },
367
+ __getNodeVersion.bind(this),
368
+ function doPortForward(next) {
369
+ log.info("inspect#inspect()#_doPortForward()", "platformNodeVersion: "+ platformNodeVersion + ", nodeBaseVersion: " + nodeBaseVersion);
370
+ if (platformNodeVersion < nodeBaseVersion) {
371
+ options.session.forward(defaultNodeInsptPort, options.hostPort || 0 /* random port */, serviceId, next);
372
+ }
373
+ else if (platformNodeVersion >= nodeBaseVersion) {
374
+ options.session.forward(dbgPort, options.hostPort || 0 /* random port */, serviceId, next);
375
+ }
376
+ },
377
+ function clearDbgFile(next) {
378
+ const cmdRmDbgFile = "rm -rf " + options.svcDbgInfo[serviceId].path + "/_ares";
379
+ options.session.runNoHangup(cmdRmDbgFile, next);
380
+ },
381
+ // FIXME: this code is need to improve.
382
+ function printGuide(next) {
383
+ spinner.stop();
384
+ if (platformNodeVersion < nodeBaseVersion) {
385
+ __launchServiceInspector(serviceId, next);
386
+ }
387
+ else if (platformNodeVersion >= nodeBaseVersion) {
388
+ __printInspectGuide(serviceId, next);
389
+ }
390
+ }
391
+ ], function(err, results) {
392
+ log.silly("inspect#inspect()", "err:", err, ", results:", results);
393
+ next(err, results);
394
+ });
395
+ }
396
+ }
397
+
398
+ function _runAppInspector(next) {
399
+ let url, killTimer,
400
+ listFiles = [
401
+ { reqPath: "/pagelist.json", propName: "inspectorUrl" }, /* AFRO, BHV */
402
+ { reqPath: "/json/list", propName: "devtoolsFrontendUrl" } /* DRD */
403
+ ];
404
+
405
+ function _getDisplayUrl(next) {
406
+ const listFile = listFiles.pop();
407
+ if (!listFile) {
408
+ return next();
409
+ }
410
+
411
+ request.get(url + listFile.reqPath, function(error, response, body) {
412
+ if (error || response.statusCode !== 200) {
413
+ return next();
414
+ }
415
+ const pagelist = JSON.parse(body);
416
+ for (const index in pagelist) {
417
+ if (pagelist[index].url.indexOf(options.appId) !== -1 ||
418
+ pagelist[index].url.indexOf(options.localIP) !== -1) {
419
+ if (!pagelist[index][listFile.propName]) {
420
+ return next(errHndl.getErrMsg("USING_WEBINSPECTOR"));
421
+ }
422
+ url += pagelist[index][listFile.propName];
423
+ listFiles = [];
424
+ break;
425
+ }
426
+ }
427
+ next(null, listFiles);
428
+ });
429
+ }
430
+
431
+ function _reqHandler(code, res) {
432
+ if (code === "@@ARES_CLOSE@@") {
433
+ res.status(200).send();
434
+ killTimer = setTimeout(function() {
435
+ process.exit(0);
436
+ }, 2 * 1000);
437
+ } else if (code === "@@GET_URL@@") {
438
+ clearTimeout(killTimer);
439
+ res.status(200).send(url);
440
+ }
441
+ }
442
+
443
+ function _postAction(err, serverInfo) {
444
+ spinner.stop();
445
+ if (err) {
446
+ process.exit(1);
447
+ } else if (serverInfo && serverInfo.msg && options.open) {
448
+ server.openBrowser(serverInfo.openBrowserUrl, options.bundledBrowserPath);
449
+ }
450
+ next(null, url);
451
+ }
452
+
453
+ if (options.appId) {
454
+ url = "http://localhost:" + options.session.getLocalPortByName(options.appId);
455
+ if (options.session.target.noPortForwarding) {
456
+ log.verbose("inspect#inspect()","noPortForwarding");
457
+ const insptPort = options.sessionInsptPort || defaultAppInsptPort;
458
+ url = "http://" + options.session.target.host + ":" + insptPort;
459
+ }
460
+
461
+ async.whilst(
462
+ function(callBack) {
463
+ callBack(null, listFiles && listFiles.length > 0);
464
+ },
465
+ _getDisplayUrl.bind(this),
466
+ function(err) {
467
+ if (err) {
468
+ return next(err);
469
+ }
470
+ server.runServer(__dirname, 0, _reqHandler, _postAction);
471
+ }
472
+ );
473
+ } else {
474
+ next();
475
+ }
476
+ }
477
+ },
478
+
479
+ stop: function(session, next) {
480
+ log.verbose("inspect#stop()", "session:", session);
481
+ if (!session.end) {
482
+ return next(errHndl.getErrMsg("NOT_EXIST_INSPECTOR"));
483
+ }
484
+
485
+ session.end();
486
+ next(null, {msg: "This inspection has stopped"});
487
+ }
488
+ };
489
+
490
+ if (typeof module !== 'undefined' && module.exports) {
491
+ module.exports = inspector;
492
+ }
493
+ }());