@xenon-device-management/xenon 2.16.0 → 2.17.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 (135) hide show
  1. package/README.md +2 -2
  2. package/lib/package.json +2 -3
  3. package/lib/public/assets/{AnnotationOverlay-2W4JvEyZ.js → AnnotationOverlay-CB8njQvS.js} +1 -1
  4. package/lib/public/assets/{ApiKeyGate-GmckX_7r.js → ApiKeyGate-B-804QBS.js} +1 -1
  5. package/lib/public/assets/DeviceMosaicView-BsDvfjR1.js +2 -0
  6. package/lib/public/assets/{EmptyState-7hETKEWb.js → EmptyState-WzLw1cEV.js} +1 -1
  7. package/lib/public/assets/{FieldGroup-GOgssFEP.js → FieldGroup-CaQNXgcE.js} +1 -1
  8. package/lib/public/assets/{FilterMenu-Yvf6RGMd.js → FilterMenu-C9gAiypL.js} +1 -1
  9. package/lib/public/assets/{Menu-KrPnfdsf.js → Menu-CfTti3rw.js} +1 -1
  10. package/lib/public/assets/{Modal-C6WjZFeI.js → Modal-BcZUFhDm.js} +1 -1
  11. package/lib/public/assets/{RecordingPage-CSRIhZEh.js → RecordingPage-B_pbl3UE.js} +1 -1
  12. package/lib/public/assets/{RecordingsPage-CB8ST3nE.js → RecordingsPage-BkVhplE3.js} +1 -1
  13. package/lib/public/assets/{SegmentedControl-C9o90KId.js → SegmentedControl-CDLMLNl5.js} +1 -1
  14. package/lib/public/assets/{SettingCard-CPm3w9l2.js → SettingCard-Lyw5CB1F.js} +1 -1
  15. package/lib/public/assets/{Table-DwIgERRt.js → Table-CK414bOU.js} +1 -1
  16. package/lib/public/assets/{activity-DrLbHifn.js → activity-pEyAdE-M.js} +1 -1
  17. package/lib/public/assets/{ai-settings-DU_Ls06P.js → ai-settings-CIhS7MMq.js} +1 -1
  18. package/lib/public/assets/{api-keys-CWYdEzJ_.js → api-keys-D2J44Ebv.js} +1 -1
  19. package/lib/public/assets/{apps-BqNVdln7.js → apps-CCV3RZY8.js} +1 -1
  20. package/lib/public/assets/{arrow-left-BtB0_Jg_.js → arrow-left-DaEUmERk.js} +1 -1
  21. package/lib/public/assets/{arrow-right-C8NhdtyN.js → arrow-right-CnRXHXit.js} +1 -1
  22. package/lib/public/assets/{arrow-up-right-gMg0ffvv.js → arrow-up-right-BGCS7zhi.js} +1 -1
  23. package/lib/public/assets/{auth-shell-CiYZ3N4M.js → auth-shell-CpW1zsxD.js} +2 -2
  24. package/lib/public/assets/{builds-page-EaaqDmLN.js → builds-page-B-xdzjMx.js} +1 -1
  25. package/lib/public/assets/{button-DDau4Axv.js → button-B5QkOVa4.js} +1 -1
  26. package/lib/public/assets/{calendar-DQ83B1ed.js → calendar-gX_1EKue.js} +1 -1
  27. package/lib/public/assets/{check-K1ovTQam.js → check-MIM4THvH.js} +1 -1
  28. package/lib/public/assets/{chevron-right-Biq00pMt.js → chevron-right-BZIp3-9t.js} +1 -1
  29. package/lib/public/assets/{circle-check-CBv88cH7.js → circle-check-Crt-G_uy.js} +1 -1
  30. package/lib/public/assets/{circle-x-Bmltailn.js → circle-x-C8GvvXVt.js} +1 -1
  31. package/lib/public/assets/{clock-BPrld-3h.js → clock-MFKV4qGa.js} +1 -1
  32. package/lib/public/assets/{copy-t0QB14JI.js → copy-BU-Z7mBK.js} +1 -1
  33. package/lib/public/assets/device-explorer-D-78Twa0.js +282 -0
  34. package/lib/public/assets/{download-BroHxNOh.js → download-DIoLCCYv.js} +1 -1
  35. package/lib/public/assets/{forgot-password-Bjmf49i6.js → forgot-password-vNYlPnia.js} +1 -1
  36. package/lib/public/assets/{h264Stream-DeD__6wa.js → h264Stream-BLcSplMU.js} +1 -1
  37. package/lib/public/assets/{index-B0gQkEg0.js → index-BpqyclNY.js} +2 -2
  38. package/lib/public/assets/{index-B0JeuZbg.js → index-Hl1OL-k_.js} +1 -1
  39. package/lib/public/assets/{index-72oF89LJ.js → index-QbukVVrl.js} +1 -1
  40. package/lib/public/assets/{input-DIc4MSC7.js → input-DHH3fHer.js} +1 -1
  41. package/lib/public/assets/{line-chart-BcWm2vW8.js → line-chart-PdViEphw.js} +1 -1
  42. package/lib/public/assets/{list-checks-B06IJJad.js → list-checks-DI_heIg9.js} +1 -1
  43. package/lib/public/assets/{lock-pVLvnN30.js → lock-DVP_dL6J.js} +1 -1
  44. package/lib/public/assets/{login-CN77vy--.js → login-B8vtTDcr.js} +1 -1
  45. package/lib/public/assets/{maintenance-settings-CSdzQSkY.js → maintenance-settings-BMa5EfgI.js} +1 -1
  46. package/lib/public/assets/{monitor-BtrN5IkI.js → monitor-CtzX_RkD.js} +1 -1
  47. package/lib/public/assets/{mouse-pointer-2-CNsQfo6w.js → mouse-pointer-2-BA09sdS9.js} +1 -1
  48. package/lib/public/assets/{network-BSfA8ZxG.js → network-B_F9Nox-.js} +1 -1
  49. package/lib/public/assets/{overview-BfTebCK5.js → overview-kWCYMHMV.js} +1 -1
  50. package/lib/public/assets/{page-header-D8KUX6Qg.js → page-header-CAbH1O1a.js} +1 -1
  51. package/lib/public/assets/{play-Cvc8xzic.js → play-sg95hLqA.js} +1 -1
  52. package/lib/public/assets/{plus-C9Zj84UF.js → plus-BT9mk2gj.js} +1 -1
  53. package/lib/public/assets/{profile-page-Bi27STgs.js → profile-page-DZOz5Ypc.js} +1 -1
  54. package/lib/public/assets/{reset-password-CPsOuwSu.js → reset-password-CqeImlEO.js} +1 -1
  55. package/lib/public/assets/{runbook-page-DEQ-DBOX.js → runbook-page-U_8TSysj.js} +1 -1
  56. package/lib/public/assets/{select-BWpnhWXj.js → select-Cx4JDzsR.js} +1 -1
  57. package/lib/public/assets/{selector-detail-redirect-BefSCSpe.js → selector-detail-redirect-DiMRe7DW.js} +1 -1
  58. package/lib/public/assets/{selector-health-page-MSk96Zz7.js → selector-health-page-CKR5URll.js} +1 -1
  59. package/lib/public/assets/{session-detail-page-DPyBNef_.js → session-detail-page-DuIVzTW_.js} +1 -1
  60. package/lib/public/assets/{settings-V6x-cXwy.js → settings-B5fuvgTP.js} +1 -1
  61. package/lib/public/assets/{stat-tile-Duex-GZD.js → stat-tile-CtHX1dkh.js} +1 -1
  62. package/lib/public/assets/{tablet-BBcoqBmL.js → tablet-DCGD0GQt.js} +1 -1
  63. package/lib/public/assets/{teams-ts8p5rEh.js → teams-MzlELlw9.js} +1 -1
  64. package/lib/public/assets/{trash-2-CZ2ew6AZ.js → trash-2-BIRm2KVs.js} +1 -1
  65. package/lib/public/assets/{upload-Dv99y_le.js → upload-C-lgyswH.js} +1 -1
  66. package/lib/public/assets/{use-builds-data-DrYC8JCF.js → use-builds-data-IOydXA8d.js} +1 -1
  67. package/lib/public/assets/{use-password-reset-mode-C7QkBNkP.js → use-password-reset-mode-CIVXG7Me.js} +1 -1
  68. package/lib/public/assets/{users-gJ5Y01yo.js → users-hwK5XGIy.js} +1 -1
  69. package/lib/public/assets/{users-D7tKMESH.js → users-ivNCjeus.js} +1 -1
  70. package/lib/public/assets/{video-off-CqZVuZGs.js → video-off-DvcIEsdZ.js} +1 -1
  71. package/lib/public/assets/{webhook-settings-DI5DSW99.js → webhook-settings-DukgCe1u.js} +1 -1
  72. package/lib/public/assets/{zap-ClcHFxfo.js → zap-BE9gacFj.js} +1 -1
  73. package/lib/public/index.html +1 -1
  74. package/lib/schema.json +1 -1
  75. package/lib/src/app/index.js +2 -0
  76. package/lib/src/app/openapi/control.yaml +69 -4
  77. package/lib/src/app/openapi/grid.yaml +102 -0
  78. package/lib/src/app/routers/control.js +24 -5
  79. package/lib/src/dashboard/event-manager.js +5 -8
  80. package/lib/src/device-managers/ios/IOSStreamService.js +147 -18
  81. package/lib/src/device-utils.js +61 -24
  82. package/lib/src/gateway/internalCall.js +33 -5
  83. package/lib/src/gateway/nodeAsk.js +57 -0
  84. package/lib/src/gateway/nodeSessionDeviceLogs.js +35 -0
  85. package/lib/src/gateway/sessionGateway.js +9 -4
  86. package/lib/src/helpers/index.js +9 -6
  87. package/lib/src/interceptors/CommandInterceptor.js +10 -0
  88. package/lib/src/plugin.js +4 -1
  89. package/lib/src/scripts/initialize-database.js +0 -6
  90. package/lib/src/scripts/run-migrations.js +123 -880
  91. package/lib/src/services/ServerManager.js +25 -4
  92. package/lib/src/services/SessionLifecycleService.js +20 -5
  93. package/lib/src/services/UserService.js +8 -3
  94. package/lib/src/services/interceptor/CertManager.js +50 -16
  95. package/lib/src/services/logcat/NodeDeviceLogStore.js +99 -0
  96. package/lib/src/services/logcat/NodeDeviceLogsCollector.js +164 -0
  97. package/lib/src/services/logcat/SessionDeviceLogs.js +199 -44
  98. package/lib/src/services/logcat/nodeDeviceLogs.js +91 -0
  99. package/lib/src/services/metrics/nodeMetrics.js +20 -49
  100. package/lib/src/sessions/RemoteSession.js +11 -2
  101. package/lib/src/sessions/SessionManager.js +28 -1
  102. package/lib/src/sessions/appiumUmbrella.js +11 -0
  103. package/lib/src/sessions/sessionMemory.js +11 -2
  104. package/lib/test/helpers/fake-logcat.js +80 -0
  105. package/lib/test/helpers/hub-node-pair.js +227 -0
  106. package/lib/test/unit/UserService.test.js +8 -0
  107. package/lib/test/unit/boot-device-sync.spec.js +195 -0
  108. package/lib/test/unit/dashboard-events-device-logs.spec.js +15 -0
  109. package/lib/test/unit/hub-node-gateway-appium-server.spec.js +21 -0
  110. package/lib/test/unit/hub-node-iphone-readiness.spec.js +134 -0
  111. package/lib/test/unit/hub-node-session-device-logs.spec.js +194 -0
  112. package/lib/test/unit/hub-node-session-metrics.spec.js +24 -192
  113. package/lib/test/unit/hub-remote-session-heartbeat.spec.js +8 -1
  114. package/lib/test/unit/install-scripts.spec.js +98 -0
  115. package/lib/test/unit/interceptor/CertManager.spec.js +89 -0
  116. package/lib/test/unit/internal-call.spec.js +99 -0
  117. package/lib/test/unit/internal-calls-session-record.spec.js +312 -0
  118. package/lib/test/unit/ios-simulator-preview.spec.js +315 -0
  119. package/lib/test/unit/is-xenon-running.spec.js +10 -0
  120. package/lib/test/unit/node-device-log-store.spec.js +102 -0
  121. package/lib/test/unit/node-device-logs-collector.spec.js +343 -0
  122. package/lib/test/unit/node-gateway-create-appium-server.spec.js +8 -1
  123. package/lib/test/unit/node-hub-session-owner.spec.js +8 -1
  124. package/lib/test/unit/node-session-device-logs-route.spec.js +103 -0
  125. package/lib/test/unit/run-migrations-database.spec.js +57 -424
  126. package/lib/test/unit/run-migrations.test.js +74 -674
  127. package/lib/test/unit/session-device-logs-hub-node.spec.js +340 -0
  128. package/lib/test/unit/session-device-logs-lifecycle.spec.js +137 -0
  129. package/lib/test/unit/session-device-logs.spec.js +32 -94
  130. package/lib/test/unit/session-log-indexes.spec.js +15 -0
  131. package/lib/tsconfig.tsbuildinfo +1 -1
  132. package/package.json +2 -3
  133. package/schema.json +1 -1
  134. package/lib/public/assets/DeviceMosaicView-DqODzkyo.js +0 -2
  135. package/lib/public/assets/device-explorer-BgGZ8AvV.js +0 -282
@@ -0,0 +1,315 @@
1
+ "use strict";
2
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
+ if (k2 === undefined) k2 = k;
4
+ var desc = Object.getOwnPropertyDescriptor(m, k);
5
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
+ desc = { enumerable: true, get: function() { return m[k]; } };
7
+ }
8
+ Object.defineProperty(o, k2, desc);
9
+ }) : (function(o, m, k, k2) {
10
+ if (k2 === undefined) k2 = k;
11
+ o[k2] = m[k];
12
+ }));
13
+ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
14
+ Object.defineProperty(o, "default", { enumerable: true, value: v });
15
+ }) : function(o, v) {
16
+ o["default"] = v;
17
+ });
18
+ var __importStar = (this && this.__importStar) || (function () {
19
+ var ownKeys = function(o) {
20
+ ownKeys = Object.getOwnPropertyNames || function (o) {
21
+ var ar = [];
22
+ for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
23
+ return ar;
24
+ };
25
+ return ownKeys(o);
26
+ };
27
+ return function (mod) {
28
+ if (mod && mod.__esModule) return mod;
29
+ var result = {};
30
+ if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
31
+ __setModuleDefault(result, mod);
32
+ return result;
33
+ };
34
+ })();
35
+ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
36
+ function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
37
+ return new (P || (P = Promise))(function (resolve, reject) {
38
+ function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
39
+ function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
40
+ function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
41
+ step((generator = generator.apply(thisArg, _arguments || [])).next());
42
+ });
43
+ };
44
+ var __importDefault = (this && this.__importDefault) || function (mod) {
45
+ return (mod && mod.__esModule) ? mod : { "default": mod };
46
+ };
47
+ Object.defineProperty(exports, "__esModule", { value: true });
48
+ require("reflect-metadata");
49
+ const chai_1 = require("chai");
50
+ const child_process_1 = __importDefault(require("child_process"));
51
+ const events_1 = require("events");
52
+ const express_1 = __importDefault(require("express"));
53
+ const sinon_1 = __importDefault(require("sinon"));
54
+ const typedi_1 = require("typedi");
55
+ const control_1 = __importDefault(require("../../src/app/routers/control"));
56
+ const device_store_1 = require("../../src/data-service/device-store");
57
+ const deviceService = __importStar(require("../../src/data-service/device-service"));
58
+ const IOSStreamService_1 = __importStar(require("../../src/device-managers/ios/IOSStreamService"));
59
+ const SessionOwnerResolver_1 = require("../../src/services/device-access/SessionOwnerResolver");
60
+ const IOSTunnels_1 = require("../../src/device-managers/ios/IOSTunnels");
61
+ const singleFlight_1 = require("../../src/helpers/singleFlight");
62
+ const PortAllocator_1 = require("../../src/services/PortAllocator");
63
+ const ProcessRegistry_1 = require("../../src/services/ProcessRegistry");
64
+ const recording_store_1 = require("../../src/services/recording/recording-store");
65
+ const appiumUmbrella_1 = require("../../src/sessions/appiumUmbrella");
66
+ const sessionMemory_1 = require("../../src/sessions/sessionMemory");
67
+ const container_registration_1 = require("../helpers/container-registration");
68
+ const loopbackRequest_1 = __importDefault(require("../helpers/loopbackRequest"));
69
+ const loopbackServer_1 = require("../helpers/loopbackServer");
70
+ const own_node_id_1 = require("../helpers/own-node-id");
71
+ /**
72
+ * The live preview of an iOS simulator.
73
+ *
74
+ * Every iOS preview went through the iPhone's stream: a go-ios tunnel, iproxy
75
+ * USB forwards and go-ios `runwda`, none of which reach a simulator. With no
76
+ * test running, the start failed (go-ios: "Device not found"), and its two
77
+ * forwards stayed on the ports it had leased to the simulator; a test started
78
+ * meanwhile was given those ports, and its WebDriverAgent couldn't open them
79
+ * ("Unable to start WebDriverAgent session"). With a test running, the start
80
+ * attached to the test's WebDriverAgent but read the picture through a new
81
+ * forward that carries nothing, so a Live devices tile stayed empty.
82
+ *
83
+ * A simulator's picture is its running test's: the XCUITest driver's
84
+ * WebDriverAgent serves it on this Mac at the session's mjpegServerPort.
85
+ * The preview reads it there, starts nothing and leases no port, and ends
86
+ * with the test. With no test running it is refused in plain words.
87
+ */
88
+ const SIMULATOR = '35429994-B029-4AF4-9634-880B89DAC782';
89
+ const IPHONE = '00008150-000E78612168C01C';
90
+ describe('iOS simulator live preview', () => {
91
+ (0, own_node_id_1.useOwnNodeId)();
92
+ const loopback = (0, loopbackServer_1.loopbackServers)();
93
+ let row;
94
+ let spawned;
95
+ let commands;
96
+ let allocator;
97
+ let tunnels;
98
+ let driverOptions;
99
+ let svc;
100
+ let restoreRegs;
101
+ let blockDevice;
102
+ function iosService() {
103
+ // Bypass the constructor: it starts watchdog intervals.
104
+ const s = Object.create(IOSStreamService_1.default.prototype);
105
+ s.sessions = new Map();
106
+ s.endedSimulatorSessions = new Set();
107
+ s.startFlight = new singleFlight_1.SingleFlight();
108
+ s.recoveryCooldowns = new Map();
109
+ s.RECOVERY_COOLDOWN_MS = 30000;
110
+ s.goIOSPath = '/nonexistent/go-ios';
111
+ return s;
112
+ }
113
+ const simulator = (over = {}) => (Object.assign({ udid: SIMULATOR, host: 'http://127.0.0.1:4723', nodeId: own_node_id_1.OWN_NODE_ID, platform: 'ios', realDevice: false, deviceType: 'simulator', busy: false, session_id: null, wdaLocalPort: 8101, mjpegServerPort: 9101, screenWidth: '402', screenHeight: '874' }, over));
114
+ const runningTest = (sessionId = 'sess-1') => ({ busy: true, session_id: sessionId });
115
+ beforeEach(() => {
116
+ restoreRegs = (0, container_registration_1.saveRegistrations)(IOSStreamService_1.default, recording_store_1.RecordingStore);
117
+ row = simulator();
118
+ spawned = [];
119
+ commands = [];
120
+ sinon_1.default.stub(process, 'kill');
121
+ sinon_1.default.stub(child_process_1.default, 'spawn').callsFake(((cmd, args) => {
122
+ spawned.push([cmd, ...(args !== null && args !== void 0 ? args : [])].join(' '));
123
+ const p = new events_1.EventEmitter();
124
+ p.stdout = new events_1.EventEmitter();
125
+ p.stderr = new events_1.EventEmitter();
126
+ p.kill = () => true;
127
+ return p;
128
+ }));
129
+ sinon_1.default.stub(child_process_1.default, 'execFile').callsFake(((cmd, _o, cb) => {
130
+ commands.push(cmd);
131
+ const done = typeof cb === 'function' ? cb : () => undefined;
132
+ process.nextTick(() => done(Object.assign(new Error('exit 1'), { code: 1 }), '', ''));
133
+ return new events_1.EventEmitter();
134
+ }));
135
+ allocator = {
136
+ claim: sinon_1.default.stub().resolves(true),
137
+ acquire: sinon_1.default.stub().resolves(8150),
138
+ tryAcquire: sinon_1.default.stub().resolves(8150),
139
+ release: sinon_1.default.stub().resolves(),
140
+ touch: sinon_1.default.stub().resolves(),
141
+ releasePurpose: sinon_1.default.stub().resolves(),
142
+ };
143
+ tunnels = {
144
+ ensure: sinon_1.default.stub().resolves(null),
145
+ envFor: sinon_1.default.stub().returns({}),
146
+ stop: sinon_1.default.stub().resolves(),
147
+ touch: sinon_1.default.stub().resolves(),
148
+ isOnDemand: sinon_1.default.stub().returns(false),
149
+ };
150
+ driverOptions = {};
151
+ svc = iosService();
152
+ typedi_1.Container.set(IOSStreamService_1.default, svc);
153
+ typedi_1.Container.set(recording_store_1.RecordingStore, { isRecording: () => __awaiter(void 0, void 0, void 0, function* () { return false; }) });
154
+ const real = typedi_1.Container.get.bind(typedi_1.Container);
155
+ sinon_1.default.stub(typedi_1.Container, 'get').callsFake((token) => {
156
+ if (token === PortAllocator_1.PortAllocator)
157
+ return allocator;
158
+ if (token === IOSTunnels_1.IOSTunnels)
159
+ return tunnels;
160
+ if (token === ProcessRegistry_1.ProcessRegistry)
161
+ return { track: () => undefined };
162
+ if (token === appiumUmbrella_1.AppiumUmbrella)
163
+ return { driverOptions: (id) => driverOptions[id] };
164
+ return real(token);
165
+ });
166
+ sinon_1.default.stub(device_store_1.DeviceStoreFactory, 'getStore').returns({
167
+ findDevice: () => __awaiter(void 0, void 0, void 0, function* () { return row; }),
168
+ updateDevice: () => __awaiter(void 0, void 0, void 0, function* () { return undefined; }),
169
+ });
170
+ blockDevice = sinon_1.default.stub(deviceService, 'blockDevice').resolves();
171
+ sinon_1.default.stub(deviceService, 'unblockDevice').resolves();
172
+ sinon_1.default.stub(SessionOwnerResolver_1.SessionOwnerResolver.prototype, 'ownerOf').resolves(null);
173
+ });
174
+ afterEach(() => __awaiter(void 0, void 0, void 0, function* () {
175
+ sinon_1.default.restore();
176
+ restoreRegs();
177
+ yield loopback.closeAll();
178
+ }));
179
+ /** Nothing of the iPhone's stream ran: no process, no go-ios, no port leased. */
180
+ const startedNothing = () => {
181
+ (0, chai_1.expect)(spawned, 'processes started').to.deep.equal([]);
182
+ (0, chai_1.expect)(commands, 'commands run').to.deep.equal([]);
183
+ (0, chai_1.expect)(tunnels.ensure.called, 'go-ios tunnel').to.equal(false);
184
+ (0, chai_1.expect)(allocator.acquire.called, 'port leased').to.equal(false);
185
+ (0, chai_1.expect)(allocator.claim.called, 'port claimed').to.equal(false);
186
+ };
187
+ describe('the stream service', () => {
188
+ it('refuses a simulator no test runs on, in plain words, and starts nothing', () => __awaiter(void 0, void 0, void 0, function* () {
189
+ const err = yield svc.startStream(SIMULATOR).then(() => null, (e) => e);
190
+ (0, chai_1.expect)(err === null || err === void 0 ? void 0 : err.message).to.equal(IOSStreamService_1.SIMULATOR_PREVIEW_NEEDS_TEST);
191
+ startedNothing();
192
+ (0, chai_1.expect)(svc.getStreamStatus(SIMULATOR)).to.equal(undefined);
193
+ }));
194
+ it('refuses it again at once: no cool-down after a refusal', () => __awaiter(void 0, void 0, void 0, function* () {
195
+ yield svc.startStream(SIMULATOR).catch(() => undefined);
196
+ const err = yield svc.startStream(SIMULATOR).catch((e) => e);
197
+ (0, chai_1.expect)(err.message).to.equal(IOSStreamService_1.SIMULATOR_PREVIEW_NEEDS_TEST);
198
+ }));
199
+ it("shows a running test's own picture, at the ports its driver runs WebDriverAgent on", () => __awaiter(void 0, void 0, void 0, function* () {
200
+ Object.assign(row, runningTest());
201
+ driverOptions['sess-1'] = { wdaLocalPort: 8100, mjpegServerPort: 9100 };
202
+ const ports = yield svc.startStream(SIMULATOR);
203
+ (0, chai_1.expect)(ports).to.deep.equal({ wdaPort: 8100, mjpegPort: 9100 });
204
+ startedNothing();
205
+ (0, chai_1.expect)(svc.getStreamStatus(SIMULATOR)).to.deep.include({
206
+ status: 'running',
207
+ wdaPort: 8100,
208
+ mjpegPort: 9100,
209
+ });
210
+ }));
211
+ it('refuses a test Appium no longer has: it is ending, and its row not yet released', () => __awaiter(void 0, void 0, void 0, function* () {
212
+ Object.assign(row, runningTest());
213
+ const err = yield svc.startStream(SIMULATOR).catch((e) => e);
214
+ (0, chai_1.expect)(err.message).to.equal(IOSStreamService_1.SIMULATOR_PREVIEW_NEEDS_TEST);
215
+ (0, chai_1.expect)(svc.getStreamStatus(SIMULATOR)).to.equal(undefined);
216
+ startedNothing();
217
+ }));
218
+ it('never shows a test that has ended, though a start lands while it is torn down', () => __awaiter(void 0, void 0, void 0, function* () {
219
+ Object.assign(row, runningTest('sess-1'));
220
+ driverOptions['sess-1'] = { wdaLocalPort: 8100, mjpegServerPort: 9100 };
221
+ yield svc.startStream(SIMULATOR);
222
+ // The test's end, before Appium drops the session and the phone is released.
223
+ yield svc.endSimulatorPreviews('sess-1');
224
+ const err = yield svc.startStream(SIMULATOR).catch((e) => e);
225
+ (0, chai_1.expect)(err.message).to.equal(IOSStreamService_1.SIMULATOR_PREVIEW_NEEDS_TEST);
226
+ (0, chai_1.expect)(svc.getStreamStatus(SIMULATOR)).to.equal(undefined);
227
+ }));
228
+ it('leaves an Android emulator alone: it is no simulator', () => {
229
+ const emulator = { platform: 'android', realDevice: false, busy: false, session_id: null };
230
+ (0, chai_1.expect)((0, IOSStreamService_1.simulatorPreviewRefusal)(emulator)).to.equal(undefined);
231
+ (0, chai_1.expect)((0, IOSStreamService_1.simulatorPreviewRefusal)(Object.assign(Object.assign({}, emulator), { platform: 'ios' }))).to.equal(IOSStreamService_1.SIMULATOR_PREVIEW_NEEDS_TEST);
232
+ (0, chai_1.expect)((0, IOSStreamService_1.simulatorPreviewRefusal)(Object.assign(Object.assign({}, emulator), { platform: 'tvos' }))).to.equal(IOSStreamService_1.SIMULATOR_PREVIEW_NEEDS_TEST);
233
+ });
234
+ it("follows a new test on the simulator, never an earlier test's picture", () => __awaiter(void 0, void 0, void 0, function* () {
235
+ Object.assign(row, runningTest('sess-1'));
236
+ driverOptions['sess-1'] = { wdaLocalPort: 8100, mjpegServerPort: 9100 };
237
+ yield svc.startStream(SIMULATOR);
238
+ Object.assign(row, runningTest('sess-2'));
239
+ driverOptions['sess-2'] = { wdaLocalPort: 8102, mjpegServerPort: 9102 };
240
+ (0, chai_1.expect)(yield svc.startStream(SIMULATOR)).to.deep.equal({ wdaPort: 8102, mjpegPort: 9102 });
241
+ }));
242
+ it('ends with its test, however the test ends, and gives back no port it never leased', () => __awaiter(void 0, void 0, void 0, function* () {
243
+ Object.assign(row, runningTest('sess-1'));
244
+ driverOptions['sess-1'] = { wdaLocalPort: 8100, mjpegServerPort: 9100 };
245
+ yield svc.startStream(SIMULATOR);
246
+ (0, sessionMemory_1.forgetSessionMemory)('another-session');
247
+ yield new Promise((r) => setImmediate(r));
248
+ (0, chai_1.expect)(svc.getStreamStatus(SIMULATOR), "another test's end").to.not.equal(undefined);
249
+ (0, sessionMemory_1.forgetSessionMemory)('sess-1');
250
+ yield new Promise((r) => setImmediate(r));
251
+ (0, chai_1.expect)(svc.getStreamStatus(SIMULATOR)).to.equal(undefined);
252
+ (0, chai_1.expect)(allocator.release.called, 'port released').to.equal(false);
253
+ (0, chai_1.expect)(commands, 'go-ios clean-up').to.deep.equal([]);
254
+ }));
255
+ it('still runs the iPhone stream for an iPhone', () => __awaiter(void 0, void 0, void 0, function* () {
256
+ row = Object.assign(Object.assign({}, simulator()), { udid: IPHONE, realDevice: true, deviceType: 'real' });
257
+ const err = yield svc.startStream(IPHONE).catch((e) => e);
258
+ (0, chai_1.expect)(err.message).to.not.equal(IOSStreamService_1.SIMULATOR_PREVIEW_NEEDS_TEST);
259
+ (0, chai_1.expect)(allocator.acquire.called, 'iPhone stream leases its ports').to.equal(true);
260
+ }));
261
+ });
262
+ describe('the dashboard routes', () => {
263
+ function app() {
264
+ const a = (0, express_1.default)();
265
+ a.use(express_1.default.json());
266
+ const api = express_1.default.Router();
267
+ api.use((req, _res, next) => {
268
+ req.auth = {
269
+ kind: 'user-session',
270
+ userId: 'usr_alice',
271
+ role: 'ADMIN',
272
+ scopes: 'admin,devices,sessions,read',
273
+ rateLimit: 100,
274
+ };
275
+ next();
276
+ });
277
+ control_1.default.register(api);
278
+ a.use('/xenon/api', api);
279
+ return a;
280
+ }
281
+ const client = () => __awaiter(void 0, void 0, void 0, function* () { return (0, loopbackRequest_1.default)(yield loopback.serve(app())); });
282
+ it('stream/start says why a simulator with no test shows nothing', () => __awaiter(void 0, void 0, void 0, function* () {
283
+ const res = yield (yield client())
284
+ .post(`/xenon/api/control/${SIMULATOR}/stream/start`)
285
+ .send({ player: 'mjpeg' });
286
+ (0, chai_1.expect)(res.status, JSON.stringify(res.body)).to.equal(409);
287
+ (0, chai_1.expect)(res.body).to.deep.include({
288
+ error: 'simulator_needs_test',
289
+ message: IOSStreamService_1.SIMULATOR_PREVIEW_NEEDS_TEST,
290
+ });
291
+ startedNothing();
292
+ }));
293
+ it('stream/status gives the reason, for the Live devices tile', () => __awaiter(void 0, void 0, void 0, function* () {
294
+ const res = yield (yield client()).get(`/xenon/api/control/${SIMULATOR}/stream/status`);
295
+ (0, chai_1.expect)(res.status).to.equal(200);
296
+ (0, chai_1.expect)(res.body).to.deep.include({
297
+ status: 'stopped',
298
+ lastError: IOSStreamService_1.SIMULATOR_PREVIEW_NEEDS_TEST,
299
+ reason: 'simulator_needs_test',
300
+ });
301
+ }));
302
+ it("stream/start answers with the running test's picture", () => __awaiter(void 0, void 0, void 0, function* () {
303
+ Object.assign(row, runningTest());
304
+ driverOptions['sess-1'] = { wdaLocalPort: 8100, mjpegServerPort: 9100 };
305
+ const res = yield (yield client())
306
+ .post(`/xenon/api/control/${SIMULATOR}/stream/start`)
307
+ .send({ player: 'mjpeg' });
308
+ (0, chai_1.expect)(res.status, JSON.stringify(res.body)).to.equal(200);
309
+ (0, chai_1.expect)(res.body).to.deep.include({ type: 'mjpeg', mjpegPort: 9100 });
310
+ startedNothing();
311
+ // The test holds the simulator; a preview hold could outlive it.
312
+ (0, chai_1.expect)(blockDevice.called, 'held the simulator').to.equal(false);
313
+ }));
314
+ });
315
+ });
@@ -58,6 +58,16 @@ describe('isXenonRunning', () => {
58
58
  yield new Promise((resolve) => gone.close(() => resolve()));
59
59
  (0, chai_1.expect)(yield (0, helpers_1.isXenonRunning)(`http://127.0.0.1:${port}`)).to.equal(false);
60
60
  }));
61
+ it('asks once and gives up at its own limit when told to, as a start does', () => __awaiter(void 0, void 0, void 0, function* () {
62
+ server.removeAllListeners('request');
63
+ server.on('request', (req) => {
64
+ hits.push(String(req.url)); // and never answers
65
+ });
66
+ const started = Date.now();
67
+ (0, chai_1.expect)(yield (0, helpers_1.isXenonRunning)(base, undefined, { timeoutMs: 200, retry: false })).to.equal(false);
68
+ (0, chai_1.expect)(Date.now() - started).to.be.lessThan(1500);
69
+ (0, chai_1.expect)(hits).to.deep.equal(['/xenon/api/health']);
70
+ }));
61
71
  it('calls a server whose health route fails not running', () => __awaiter(void 0, void 0, void 0, function* () {
62
72
  server.removeAllListeners('request');
63
73
  server.on('request', (_req, res) => {
@@ -0,0 +1,102 @@
1
+ "use strict";
2
+ var __importDefault = (this && this.__importDefault) || function (mod) {
3
+ return (mod && mod.__esModule) ? mod : { "default": mod };
4
+ };
5
+ Object.defineProperty(exports, "__esModule", { value: true });
6
+ require("reflect-metadata");
7
+ const chai_1 = require("chai");
8
+ const sinon_1 = __importDefault(require("sinon"));
9
+ const NodeDeviceLogStore_1 = require("../../src/services/logcat/NodeDeviceLogStore");
10
+ const nodeDeviceLogs_1 = require("../../src/services/logcat/nodeDeviceLogs");
11
+ const row = (n) => ({ message: `line ${n}`, timestamp: new Date(1000 + n) });
12
+ const rows = (from, to) => Array.from({ length: to - from + 1 }, (_, i) => row(from + i));
13
+ describe('NodeDeviceLogStore: a node holds a session’s device log lines for its hub', () => {
14
+ let now;
15
+ let store;
16
+ beforeEach(() => {
17
+ now = 1000000;
18
+ store = new NodeDeviceLogStore_1.NodeDeviceLogStore();
19
+ store.now = () => now;
20
+ });
21
+ it('numbers each line, and answers every one without `after`', () => {
22
+ store.begin('s1');
23
+ store.add('s1', [row(1), row(2)]);
24
+ store.add('s1', [row(3)]);
25
+ (0, chai_1.expect)(store.read('s1', null)).to.deep.equal({
26
+ state: 'recording',
27
+ more: false,
28
+ lines: [
29
+ { seq: 1, message: 'line 1', timestamp: 1001 },
30
+ { seq: 2, message: 'line 2', timestamp: 1002 },
31
+ { seq: 3, message: 'line 3', timestamp: 1003 },
32
+ ],
33
+ });
34
+ });
35
+ it('drops what the hub has: the lines at or before `after`', () => {
36
+ store.begin('s1');
37
+ store.add('s1', rows(1, 3));
38
+ (0, chai_1.expect)(store.read('s1', 2).lines.map((l) => l.seq)).to.deep.equal([3]);
39
+ // Gone for good, even to an ask that names none.
40
+ (0, chai_1.expect)(store.read('s1', null).lines.map((l) => l.seq)).to.deep.equal([3]);
41
+ store.add('s1', [row(4)]);
42
+ (0, chai_1.expect)(store.read('s1', 3).lines.map((l) => l.seq)).to.deep.equal([4]);
43
+ });
44
+ it(`answers at most ${nodeDeviceLogs_1.NODE_DEVICE_LOG_PAGE} lines at a time, and says there are more`, () => {
45
+ store.begin('s1');
46
+ store.add('s1', rows(1, nodeDeviceLogs_1.NODE_DEVICE_LOG_PAGE + 5));
47
+ const first = store.read('s1', null);
48
+ (0, chai_1.expect)(first.lines).to.have.length(nodeDeviceLogs_1.NODE_DEVICE_LOG_PAGE);
49
+ (0, chai_1.expect)(first.more).to.equal(true);
50
+ const second = store.read('s1', nodeDeviceLogs_1.NODE_DEVICE_LOG_PAGE);
51
+ (0, chai_1.expect)(second.lines.map((l) => l.seq)).to.deep.equal([1, 2, 3, 4, 5].map((n) => nodeDeviceLogs_1.NODE_DEVICE_LOG_PAGE + n));
52
+ (0, chai_1.expect)(second.more).to.equal(false);
53
+ });
54
+ it('says a session ended, and keeps it 10 minutes for the hub’s last ask', () => {
55
+ store.begin('s1');
56
+ store.add('s1', rows(1, 2));
57
+ store.end('s1');
58
+ (0, chai_1.expect)(store.read('s1', null).state).to.equal('ended');
59
+ now += nodeDeviceLogs_1.NODE_DEVICE_LOGS_KEEP_AFTER_END_MS - 1;
60
+ (0, chai_1.expect)(store.read('s1', 1).lines.map((l) => l.seq)).to.deep.equal([2]);
61
+ now += 1;
62
+ (0, chai_1.expect)(store.read('s1', null)).to.deep.equal({ state: 'off', lines: [], more: false });
63
+ });
64
+ it('forgets an ended session 10 minutes on, though nothing else happens', () => {
65
+ const clock = sinon_1.default.useFakeTimers({ now });
66
+ try {
67
+ const timed = new NodeDeviceLogStore_1.NodeDeviceLogStore();
68
+ timed.begin('s1');
69
+ timed.add('s1', rows(1, 3));
70
+ timed.end('s1');
71
+ clock.tick(nodeDeviceLogs_1.NODE_DEVICE_LOGS_KEEP_AFTER_END_MS);
72
+ (0, chai_1.expect)(timed.entries.has('s1')).to.equal(false);
73
+ }
74
+ finally {
75
+ clock.restore();
76
+ }
77
+ });
78
+ it('forgets an ended session nobody asks about, at the next session', () => {
79
+ store.begin('s1');
80
+ store.end('s1');
81
+ now += nodeDeviceLogs_1.NODE_DEVICE_LOGS_KEEP_AFTER_END_MS;
82
+ store.begin('s2');
83
+ (0, chai_1.expect)(store.entries.has('s1')).to.equal(false);
84
+ });
85
+ it('says off for a session it holds nothing for, and keeps nothing for it', () => {
86
+ store.add('nobody', rows(1, 2));
87
+ (0, chai_1.expect)(store.read('nobody', null)).to.deep.equal({ state: 'off', lines: [], more: false });
88
+ });
89
+ it('knows whether a hub has asked about a session', () => {
90
+ store.begin('s1');
91
+ (0, chai_1.expect)(store.claimed('s1')).to.equal(false);
92
+ store.read('s1', null);
93
+ (0, chai_1.expect)(store.claimed('s1')).to.equal(true);
94
+ (0, chai_1.expect)(store.claimed('unknown')).to.equal(false);
95
+ });
96
+ it('forgets a session it was told to', () => {
97
+ store.begin('s1');
98
+ store.add('s1', rows(1, 2));
99
+ store.forget('s1');
100
+ (0, chai_1.expect)(store.read('s1', null).state).to.equal('off');
101
+ });
102
+ });