@webos-tools/cli 3.0.4 → 3.0.5

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 (159) hide show
  1. package/.eslintignore +1 -1
  2. package/.eslintrc.js +52 -52
  3. package/APIs.js +79 -79
  4. package/CHANGELOG.md +128 -128
  5. package/LICENSE +201 -201
  6. package/README.md +218 -218
  7. package/bin/ares-config.js +199 -199
  8. package/bin/ares-device-info.js +30 -30
  9. package/bin/ares-device.js +219 -219
  10. package/bin/ares-generate.js +270 -270
  11. package/bin/ares-inspect.js +179 -179
  12. package/bin/ares-install.js +223 -223
  13. package/bin/ares-launch.js +318 -318
  14. package/bin/ares-log.js +255 -255
  15. package/bin/ares-novacom.js +223 -223
  16. package/bin/ares-package.js +336 -336
  17. package/bin/ares-pull.js +156 -156
  18. package/bin/ares-push.js +155 -155
  19. package/bin/ares-server.js +174 -174
  20. package/bin/ares-setup-device.js +520 -520
  21. package/bin/ares-shell.js +132 -132
  22. package/bin/ares.js +166 -166
  23. package/files/conf/ares.json +49 -49
  24. package/files/conf/command-service.json +73 -73
  25. package/files/conf/config.json +22 -22
  26. package/files/conf/ipk.json +30 -30
  27. package/files/conf/novacom-devices.json +35 -35
  28. package/files/conf/query/query-app.json +14 -14
  29. package/files/conf/query/query-hosted.json +18 -18
  30. package/files/conf/query/query-package.json +10 -10
  31. package/files/conf/query/query-service.json +6 -6
  32. package/files/conf/sdk.json +8 -8
  33. package/files/conf/template.json +57 -57
  34. package/files/conf/webos_emul +27 -27
  35. package/files/conf-base/env/sdk-ose.json +8 -8
  36. package/files/conf-base/env/sdk-tv.json +8 -8
  37. package/files/conf-base/profile/config-ose.json +21 -21
  38. package/files/conf-base/profile/config-tv.json +22 -22
  39. package/files/conf-base/query/query-app.json +14 -14
  40. package/files/conf-base/query/query-hosted.json +18 -18
  41. package/files/conf-base/query/query-package.json +10 -10
  42. package/files/conf-base/query/query-service.json +6 -6
  43. package/files/conf-base/template-conf/ose-templates.json +67 -67
  44. package/files/conf-base/template-conf/tv-sdk-templates.json +57 -57
  45. package/files/help/ares-config.help +43 -43
  46. package/files/help/ares-device.help +94 -94
  47. package/files/help/ares-generate.help +65 -65
  48. package/files/help/ares-inspect.help +70 -70
  49. package/files/help/ares-install.help +90 -90
  50. package/files/help/ares-launch.help +100 -100
  51. package/files/help/ares-log-pmlogd.help +84 -84
  52. package/files/help/ares-log.help +101 -101
  53. package/files/help/ares-novacom.help +68 -68
  54. package/files/help/ares-package.help +101 -101
  55. package/files/help/ares-pull.help +38 -38
  56. package/files/help/ares-push.help +38 -38
  57. package/files/help/ares-server.help +39 -39
  58. package/files/help/ares-setup-device.help +75 -75
  59. package/files/help/ares-shell.help +42 -42
  60. package/files/help/ares.help +47 -47
  61. package/files/help/readme.help +23 -23
  62. package/files/schema/ApplicationDescription.schema +319 -319
  63. package/files/schema/NovacomDevices.schema +61 -61
  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/icon/icon.png +0 -0
  68. package/files/templates/ose-sdk-templates/js-service/helloclient.js +31 -31
  69. package/files/templates/ose-sdk-templates/js-service/helloworld_webos_service.js +188 -188
  70. package/files/templates/ose-sdk-templates/qml-app/main.qml +68 -68
  71. package/files/templates/ose-sdk-templates/qmlappinfo/appinfo.json +10 -10
  72. package/files/templates/ose-sdk-templates/serviceinfo/package.json +11 -11
  73. package/files/templates/ose-sdk-templates/serviceinfo/services.json +8 -8
  74. package/files/templates/tv-sdk-templates/appinfo/appinfo.json +10 -10
  75. package/files/templates/tv-sdk-templates/bootplate-web/index.html +58 -58
  76. package/files/templates/tv-sdk-templates/bootplate-web/webOSTVjs-1.2.10/LICENSE-2.0.txt +202 -202
  77. package/files/templates/tv-sdk-templates/hosted-webapp/index.html +14 -14
  78. package/files/templates/tv-sdk-templates/js-service/helloworld_service.js +39 -39
  79. package/files/templates/tv-sdk-templates/packageinfo/packageinfo.json +3 -3
  80. package/files/templates/tv-sdk-templates/serviceinfo/package.json +11 -11
  81. package/files/templates/tv-sdk-templates/serviceinfo/services.json +8 -8
  82. package/files/templates/tv-sdk-templates/webicon/icon.png +0 -0
  83. package/files/templates/tv-sdk-templates/webicon/largeIcon.png +0 -0
  84. package/lib/base/ares.html +40 -40
  85. package/lib/base/cli-appdata.js +290 -290
  86. package/lib/base/cli-control.js +44 -44
  87. package/lib/base/common-tools.js +29 -29
  88. package/lib/base/error-handler.js +265 -265
  89. package/lib/base/file-watcher.js +155 -155
  90. package/lib/base/help-format.js +147 -147
  91. package/lib/base/luna.js +178 -178
  92. package/lib/base/novacom.js +1191 -1191
  93. package/lib/base/sdkenv.js +59 -59
  94. package/lib/base/server.js +137 -137
  95. package/lib/base/setup-device.js +328 -328
  96. package/lib/base/version-tools.js +79 -79
  97. package/lib/device.js +1419 -1419
  98. package/lib/generator.js +377 -377
  99. package/lib/inspect.js +494 -494
  100. package/lib/install.js +463 -463
  101. package/lib/launch.js +605 -605
  102. package/lib/log.js +584 -584
  103. package/lib/package.js +2129 -2129
  104. package/lib/pull.js +231 -231
  105. package/lib/pusher.js +210 -210
  106. package/lib/session.js +74 -74
  107. package/lib/shell.js +193 -193
  108. package/lib/tar-filter-pack.js +62 -62
  109. package/lib/util/copy.js +31 -31
  110. package/lib/util/createFileName.js +40 -40
  111. package/lib/util/eof.js +30 -30
  112. package/lib/util/json.js +63 -63
  113. package/lib/util/merge.js +14 -14
  114. package/lib/util/objclone.js +40 -40
  115. package/lib/util/spinner.js +37 -37
  116. package/npm-shrinkwrap.json +9115 -9115
  117. package/package.json +100 -100
  118. package/scripts/postinstall.js +24 -24
  119. package/spec/helpers/reporter.js +65 -65
  120. package/spec/jsSpecs/apiTest/generator.spec.js +372 -372
  121. package/spec/jsSpecs/apiTest/inspector.spec.js +89 -89
  122. package/spec/jsSpecs/apiTest/installer.spec.js +67 -67
  123. package/spec/jsSpecs/apiTest/launcher.spec.js +150 -150
  124. package/spec/jsSpecs/apiTest/packager.spec.js +194 -194
  125. package/spec/jsSpecs/apiTest/puller.spec.js +101 -101
  126. package/spec/jsSpecs/apiTest/pusher.spec.js +103 -103
  127. package/spec/jsSpecs/apiTest/server.spec.js +115 -115
  128. package/spec/jsSpecs/apiTest/setupDevice.spec.js +93 -93
  129. package/spec/jsSpecs/apiTest/shell.spec.js +49 -49
  130. package/spec/jsSpecs/ares-config.spec.js +78 -78
  131. package/spec/jsSpecs/ares-device.spec.js +443 -443
  132. package/spec/jsSpecs/ares-generate.spec.js +397 -397
  133. package/spec/jsSpecs/ares-inspect.spec.js +252 -252
  134. package/spec/jsSpecs/ares-install.spec.js +150 -150
  135. package/spec/jsSpecs/ares-launch.spec.js +301 -301
  136. package/spec/jsSpecs/ares-log.spec.js +824 -824
  137. package/spec/jsSpecs/ares-novacom.spec.js +149 -149
  138. package/spec/jsSpecs/ares-package.spec.js +1211 -1211
  139. package/spec/jsSpecs/ares-pull.spec.js +157 -157
  140. package/spec/jsSpecs/ares-push.spec.js +146 -146
  141. package/spec/jsSpecs/ares-server.spec.js +160 -160
  142. package/spec/jsSpecs/ares-setup-device.spec.js +281 -281
  143. package/spec/jsSpecs/ares-shell.spec.js +220 -220
  144. package/spec/jsSpecs/ares.spec.js +83 -83
  145. package/spec/jsSpecs/common-spec.js +169 -169
  146. package/spec/support/jasmine.json +22 -22
  147. package/spec/tempFiles/nativeApp/auto/pkg_arm64/GLES2 +0 -0
  148. package/spec/tempFiles/nativeApp/auto/pkg_arm64/appinfo.json +9 -9
  149. package/spec/tempFiles/nativeApp/ose/pkg_arm/Hello +0 -0
  150. package/spec/tempFiles/nativeApp/ose/pkg_arm/appinfo.json +8 -8
  151. package/spec/tempFiles/nativeApp/ose/pkg_arm/package.properties +2 -2
  152. package/spec/tempFiles/nativeApp/oseEmul/pkg_x86/Hello +0 -0
  153. package/spec/tempFiles/nativeApp/oseEmul/pkg_x86/appinfo.json +9 -9
  154. package/spec/tempFiles/nativeApp/rsi/pkg_x86/GLES2 +0 -0
  155. package/spec/tempFiles/nativeApp/rsi/pkg_x86/appinfo.json +9 -9
  156. package/spec/tempFiles/sign/sign.crt +32 -32
  157. package/spec/tempFiles/sign/signPriv.key +52 -52
  158. package/spec/test_data/ares-generate.json +41 -41
  159. package/spec/test_data/ares.json +33 -33
package/lib/inspect.js CHANGED
@@ -1,494 +1,494 @@
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
- next();
245
- }
246
-
247
- function _reqHandler(code, res) {
248
- if (code === "@@ARES_CLOSE@@") {
249
- res.status(200).send();
250
- killTimer = setTimeout(function() {
251
- process.exit(0);
252
- }, 2 * 1000);
253
- } else if (code === "@@GET_URL@@") {
254
- clearTimeout(killTimer);
255
- res.status(200).send(nodeInsptUrl);
256
- }
257
- }
258
-
259
- function _postAction(err, serverInfo) {
260
- if (err) {
261
- process.exit(1);
262
- } else if (serverInfo && serverInfo.msg && options.open) {
263
- server.openBrowser(serverInfo.openBrowserUrl, options.bundledBrowserPath);
264
- }
265
- guideText = "nodeInsptUrl: " + nodeInsptUrl;
266
- next();
267
- }
268
- });
269
- };
270
-
271
- async.waterfall([
272
- function findSvcFilePath(next) {
273
- log.info("inspect#inspect()#findSvcFilePath()");
274
- spinner.start();
275
- if (options.instPkgs) {
276
- options.instPkgs.every(function(pkg) {
277
- if (serviceId.indexOf(pkg.id) !== -1) {
278
- options.svcDbgInfo[serviceId].path = path.join(path.dirname(pkg.folderPath), '..', 'services', serviceId).replace(/\\/g, '/');
279
- return false;
280
- }
281
- return true;
282
- });
283
- }
284
- if (!options.svcDbgInfo[serviceId].path) {
285
- return next(errHndl.getErrMsg("FAILED_GET_SVCPATH", serviceId));
286
- }
287
- next();
288
- },
289
- function parserMeta(next) {
290
- const metaFilePath = path.join(options.svcDbgInfo[serviceId].path, "services.json").replace(/\\/g, '/'),
291
- cmdCatServiceInfo = "cat " + metaFilePath;
292
- let metaData;
293
-
294
- async.series([
295
- options.session.run.bind(options.session, cmdCatServiceInfo, process.stdin, _onData, process.stderr)
296
- ], function(err) {
297
- if (err) {
298
- return next(errHndl.getErrMsg("FAILED_FIND_SERVICE", serviceId));
299
- }
300
- });
301
-
302
- function _onData(data) {
303
- if (Buffer.isBuffer(data)) {
304
- metaData = data.toString().trim();
305
- } else {
306
- metaData = data.trim();
307
- }
308
- next(null, metaData);
309
- }
310
- },
311
- function checkServiceType(metaData, next) {
312
- try {
313
- const metaInfo = JSON.parse(metaData);
314
- if (metaInfo.engine === "native") {
315
- return next(errHndl.getErrMsg("USE_GDB", serviceId));
316
- }
317
- next();
318
- } catch (err) {
319
- next(err);
320
- }
321
- },
322
- function quitPrevService(next) {
323
- options.nReplies = 1;
324
- const param = {},
325
- addr = {
326
- "service": serviceId,
327
- "method": "quit"
328
- };
329
-
330
- luna.send(options, addr, param, function() {
331
- next();
332
- }, next);
333
- },
334
- function mkDirForDbgFile(next) {
335
- const cmdMkDir = "mkdir -p " + options.svcDbgInfo[serviceId].path + "/_ares";
336
- options.session.runNoHangup(cmdMkDir, next);
337
- },
338
- __findNewDebugPort.bind(this, dbgPort),
339
- function makeDbgFile(port, next) {
340
- dbgPort = port;
341
- const cmdWriteDbgPort = "echo " + dbgPort + " > " + options.svcDbgInfo[serviceId].path + "/_ares/debugger-port";
342
- options.session.runNoHangup(cmdWriteDbgPort, next);
343
- },
344
- function(next) {
345
- setTimeout(function() {
346
- next();
347
- },1000);
348
- },
349
- function runService(next) {
350
- log.info("inspect#inspect()#runService()", "serviceId :", serviceId);
351
- const param = {},
352
- addr = {
353
- "service": serviceId,
354
- "method": "info"
355
- };
356
- options.svcDbgInfo[serviceId].port = dbgPort;
357
- options.nReplies = 1;
358
-
359
- luna.send(options, addr, param, function() {
360
- next();
361
- }, next);
362
- },
363
- function(next) {
364
- setTimeout(function() {
365
- next();
366
- },1000);
367
- },
368
- __getNodeVersion.bind(this),
369
- function doPortForward(next) {
370
- log.info("inspect#inspect()#_doPortForward()", "platformNodeVersion: "+ platformNodeVersion + ", nodeBaseVersion: " + nodeBaseVersion);
371
- if (platformNodeVersion < nodeBaseVersion) {
372
- options.session.forward(defaultNodeInsptPort, options.hostPort || 0 /* random port */, serviceId, next);
373
- }
374
- else if (platformNodeVersion >= nodeBaseVersion) {
375
- options.session.forward(dbgPort, options.hostPort || 0 /* random port */, serviceId, next);
376
- }
377
- },
378
- function clearDbgFile(next) {
379
- const cmdRmDbgFile = "rm -rf " + options.svcDbgInfo[serviceId].path + "/_ares";
380
- options.session.runNoHangup(cmdRmDbgFile, next);
381
- },
382
- // FIXME: this code is need to improve.
383
- function printGuide(next) {
384
- spinner.stop();
385
- if (platformNodeVersion < nodeBaseVersion) {
386
- __launchServiceInspector(serviceId, next);
387
- }
388
- else if (platformNodeVersion >= nodeBaseVersion) {
389
- __printInspectGuide(serviceId, next);
390
- }
391
- }
392
- ], function(err, results) {
393
- log.silly("inspect#inspect()", "err:", err, ", results:", results);
394
- next(err, results);
395
- });
396
- }
397
- }
398
-
399
- function _runAppInspector(next) {
400
- let url, killTimer,
401
- listFiles = [
402
- { reqPath: "/pagelist.json", propName: "inspectorUrl" }, /* AFRO, BHV */
403
- { reqPath: "/json/list", propName: "devtoolsFrontendUrl" } /* DRD */
404
- ];
405
-
406
- function _getDisplayUrl(next) {
407
- const listFile = listFiles.pop();
408
- if (!listFile) {
409
- return next();
410
- }
411
-
412
- request.get(url + listFile.reqPath, function(error, response, body) {
413
- if (error || response.statusCode !== 200) {
414
- return next();
415
- }
416
- const pagelist = JSON.parse(body);
417
- for (const index in pagelist) {
418
- if (pagelist[index].url.indexOf(options.appId) !== -1 ||
419
- pagelist[index].url.indexOf(options.localIP) !== -1) {
420
- if (!pagelist[index][listFile.propName]) {
421
- return next(errHndl.getErrMsg("USING_WEBINSPECTOR"));
422
- }
423
- url += pagelist[index][listFile.propName];
424
- listFiles = [];
425
- break;
426
- }
427
- }
428
- next();
429
- });
430
- }
431
-
432
- function _reqHandler(code, res) {
433
- if (code === "@@ARES_CLOSE@@") {
434
- res.status(200).send();
435
- killTimer = setTimeout(function() {
436
- process.exit(0);
437
- }, 2 * 1000);
438
- } else if (code === "@@GET_URL@@") {
439
- clearTimeout(killTimer);
440
- res.status(200).send(url);
441
- }
442
- }
443
-
444
- function _postAction(err, serverInfo) {
445
- spinner.stop();
446
- if (err) {
447
- process.exit(1);
448
- } else if (serverInfo && serverInfo.msg && options.open) {
449
- server.openBrowser(serverInfo.openBrowserUrl, options.bundledBrowserPath);
450
- }
451
- next(null, url);
452
- }
453
-
454
- if (options.appId) {
455
- url = "http://localhost:" + options.session.getLocalPortByName(options.appId);
456
- if (options.session.target.noPortForwarding) {
457
- log.verbose("inspect#inspect()","noPortForwarding");
458
- const insptPort = options.sessionInsptPort || defaultAppInsptPort;
459
- url = "http://" + options.session.target.host + ":" + insptPort;
460
- }
461
-
462
- async.whilst(
463
- function() {
464
- return listFiles.length > 0;
465
- },
466
- _getDisplayUrl.bind(this),
467
- function(err) {
468
- if (err) {
469
- return next(err);
470
- }
471
- server.runServer(__dirname, 0, _reqHandler, _postAction);
472
- }
473
- );
474
- } else {
475
- next();
476
- }
477
- }
478
- },
479
-
480
- stop: function(session, next) {
481
- log.verbose("inspect#stop()", "session:", session);
482
- if (!session.end) {
483
- return next(errHndl.getErrMsg("NOT_EXIST_INSPECTOR"));
484
- }
485
-
486
- session.end();
487
- next(null, {msg: "This inspection has stopped"});
488
- }
489
- };
490
-
491
- if (typeof module !== 'undefined' && module.exports) {
492
- module.exports = inspector;
493
- }
494
- }());
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
+ next();
245
+ }
246
+
247
+ function _reqHandler(code, res) {
248
+ if (code === "@@ARES_CLOSE@@") {
249
+ res.status(200).send();
250
+ killTimer = setTimeout(function() {
251
+ process.exit(0);
252
+ }, 2 * 1000);
253
+ } else if (code === "@@GET_URL@@") {
254
+ clearTimeout(killTimer);
255
+ res.status(200).send(nodeInsptUrl);
256
+ }
257
+ }
258
+
259
+ function _postAction(err, serverInfo) {
260
+ if (err) {
261
+ process.exit(1);
262
+ } else if (serverInfo && serverInfo.msg && options.open) {
263
+ server.openBrowser(serverInfo.openBrowserUrl, options.bundledBrowserPath);
264
+ }
265
+ guideText = "nodeInsptUrl: " + nodeInsptUrl;
266
+ next();
267
+ }
268
+ });
269
+ };
270
+
271
+ async.waterfall([
272
+ function findSvcFilePath(next) {
273
+ log.info("inspect#inspect()#findSvcFilePath()");
274
+ spinner.start();
275
+ if (options.instPkgs) {
276
+ options.instPkgs.every(function(pkg) {
277
+ if (serviceId.indexOf(pkg.id) !== -1) {
278
+ options.svcDbgInfo[serviceId].path = path.join(path.dirname(pkg.folderPath), '..', 'services', serviceId).replace(/\\/g, '/');
279
+ return false;
280
+ }
281
+ return true;
282
+ });
283
+ }
284
+ if (!options.svcDbgInfo[serviceId].path) {
285
+ return next(errHndl.getErrMsg("FAILED_GET_SVCPATH", serviceId));
286
+ }
287
+ next();
288
+ },
289
+ function parserMeta(next) {
290
+ const metaFilePath = path.join(options.svcDbgInfo[serviceId].path, "services.json").replace(/\\/g, '/'),
291
+ cmdCatServiceInfo = "cat " + metaFilePath;
292
+ let metaData;
293
+
294
+ async.series([
295
+ options.session.run.bind(options.session, cmdCatServiceInfo, process.stdin, _onData, process.stderr)
296
+ ], function(err) {
297
+ if (err) {
298
+ return next(errHndl.getErrMsg("FAILED_FIND_SERVICE", serviceId));
299
+ }
300
+ });
301
+
302
+ function _onData(data) {
303
+ if (Buffer.isBuffer(data)) {
304
+ metaData = data.toString().trim();
305
+ } else {
306
+ metaData = data.trim();
307
+ }
308
+ next(null, metaData);
309
+ }
310
+ },
311
+ function checkServiceType(metaData, next) {
312
+ try {
313
+ const metaInfo = JSON.parse(metaData);
314
+ if (metaInfo.engine === "native") {
315
+ return next(errHndl.getErrMsg("USE_GDB", serviceId));
316
+ }
317
+ next();
318
+ } catch (err) {
319
+ next(err);
320
+ }
321
+ },
322
+ function quitPrevService(next) {
323
+ options.nReplies = 1;
324
+ const param = {},
325
+ addr = {
326
+ "service": serviceId,
327
+ "method": "quit"
328
+ };
329
+
330
+ luna.send(options, addr, param, function() {
331
+ next();
332
+ }, next);
333
+ },
334
+ function mkDirForDbgFile(next) {
335
+ const cmdMkDir = "mkdir -p " + options.svcDbgInfo[serviceId].path + "/_ares";
336
+ options.session.runNoHangup(cmdMkDir, next);
337
+ },
338
+ __findNewDebugPort.bind(this, dbgPort),
339
+ function makeDbgFile(port, next) {
340
+ dbgPort = port;
341
+ const cmdWriteDbgPort = "echo " + dbgPort + " > " + options.svcDbgInfo[serviceId].path + "/_ares/debugger-port";
342
+ options.session.runNoHangup(cmdWriteDbgPort, next);
343
+ },
344
+ function(next) {
345
+ setTimeout(function() {
346
+ next();
347
+ },1000);
348
+ },
349
+ function runService(next) {
350
+ log.info("inspect#inspect()#runService()", "serviceId :", serviceId);
351
+ const param = {},
352
+ addr = {
353
+ "service": serviceId,
354
+ "method": "info"
355
+ };
356
+ options.svcDbgInfo[serviceId].port = dbgPort;
357
+ options.nReplies = 1;
358
+
359
+ luna.send(options, addr, param, function() {
360
+ next();
361
+ }, next);
362
+ },
363
+ function(next) {
364
+ setTimeout(function() {
365
+ next();
366
+ },1000);
367
+ },
368
+ __getNodeVersion.bind(this),
369
+ function doPortForward(next) {
370
+ log.info("inspect#inspect()#_doPortForward()", "platformNodeVersion: "+ platformNodeVersion + ", nodeBaseVersion: " + nodeBaseVersion);
371
+ if (platformNodeVersion < nodeBaseVersion) {
372
+ options.session.forward(defaultNodeInsptPort, options.hostPort || 0 /* random port */, serviceId, next);
373
+ }
374
+ else if (platformNodeVersion >= nodeBaseVersion) {
375
+ options.session.forward(dbgPort, options.hostPort || 0 /* random port */, serviceId, next);
376
+ }
377
+ },
378
+ function clearDbgFile(next) {
379
+ const cmdRmDbgFile = "rm -rf " + options.svcDbgInfo[serviceId].path + "/_ares";
380
+ options.session.runNoHangup(cmdRmDbgFile, next);
381
+ },
382
+ // FIXME: this code is need to improve.
383
+ function printGuide(next) {
384
+ spinner.stop();
385
+ if (platformNodeVersion < nodeBaseVersion) {
386
+ __launchServiceInspector(serviceId, next);
387
+ }
388
+ else if (platformNodeVersion >= nodeBaseVersion) {
389
+ __printInspectGuide(serviceId, next);
390
+ }
391
+ }
392
+ ], function(err, results) {
393
+ log.silly("inspect#inspect()", "err:", err, ", results:", results);
394
+ next(err, results);
395
+ });
396
+ }
397
+ }
398
+
399
+ function _runAppInspector(next) {
400
+ let url, killTimer,
401
+ listFiles = [
402
+ { reqPath: "/pagelist.json", propName: "inspectorUrl" }, /* AFRO, BHV */
403
+ { reqPath: "/json/list", propName: "devtoolsFrontendUrl" } /* DRD */
404
+ ];
405
+
406
+ function _getDisplayUrl(next) {
407
+ const listFile = listFiles.pop();
408
+ if (!listFile) {
409
+ return next();
410
+ }
411
+
412
+ request.get(url + listFile.reqPath, function(error, response, body) {
413
+ if (error || response.statusCode !== 200) {
414
+ return next();
415
+ }
416
+ const pagelist = JSON.parse(body);
417
+ for (const index in pagelist) {
418
+ if (pagelist[index].url.indexOf(options.appId) !== -1 ||
419
+ pagelist[index].url.indexOf(options.localIP) !== -1) {
420
+ if (!pagelist[index][listFile.propName]) {
421
+ return next(errHndl.getErrMsg("USING_WEBINSPECTOR"));
422
+ }
423
+ url += pagelist[index][listFile.propName];
424
+ listFiles = [];
425
+ break;
426
+ }
427
+ }
428
+ next();
429
+ });
430
+ }
431
+
432
+ function _reqHandler(code, res) {
433
+ if (code === "@@ARES_CLOSE@@") {
434
+ res.status(200).send();
435
+ killTimer = setTimeout(function() {
436
+ process.exit(0);
437
+ }, 2 * 1000);
438
+ } else if (code === "@@GET_URL@@") {
439
+ clearTimeout(killTimer);
440
+ res.status(200).send(url);
441
+ }
442
+ }
443
+
444
+ function _postAction(err, serverInfo) {
445
+ spinner.stop();
446
+ if (err) {
447
+ process.exit(1);
448
+ } else if (serverInfo && serverInfo.msg && options.open) {
449
+ server.openBrowser(serverInfo.openBrowserUrl, options.bundledBrowserPath);
450
+ }
451
+ next(null, url);
452
+ }
453
+
454
+ if (options.appId) {
455
+ url = "http://localhost:" + options.session.getLocalPortByName(options.appId);
456
+ if (options.session.target.noPortForwarding) {
457
+ log.verbose("inspect#inspect()","noPortForwarding");
458
+ const insptPort = options.sessionInsptPort || defaultAppInsptPort;
459
+ url = "http://" + options.session.target.host + ":" + insptPort;
460
+ }
461
+
462
+ async.whilst(
463
+ function() {
464
+ return listFiles.length > 0;
465
+ },
466
+ _getDisplayUrl.bind(this),
467
+ function(err) {
468
+ if (err) {
469
+ return next(err);
470
+ }
471
+ server.runServer(__dirname, 0, _reqHandler, _postAction);
472
+ }
473
+ );
474
+ } else {
475
+ next();
476
+ }
477
+ }
478
+ },
479
+
480
+ stop: function(session, next) {
481
+ log.verbose("inspect#stop()", "session:", session);
482
+ if (!session.end) {
483
+ return next(errHndl.getErrMsg("NOT_EXIST_INSPECTOR"));
484
+ }
485
+
486
+ session.end();
487
+ next(null, {msg: "This inspection has stopped"});
488
+ }
489
+ };
490
+
491
+ if (typeof module !== 'undefined' && module.exports) {
492
+ module.exports = inspector;
493
+ }
494
+ }());