@e2e-dev/limrun 0.0.0-stage → 0.2.0
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.
- package/LICENSE +202 -0
- package/NOTICE +5 -0
- package/README.md +17 -2
- package/dist/.build.json +1 -0
- package/dist/daemon.d.ts +5 -0
- package/dist/daemon.js +64 -0
- package/dist/driver.d.ts +15 -0
- package/dist/driver.js +29 -0
- package/dist/heartbeat.d.ts +3 -0
- package/dist/heartbeat.js +30 -0
- package/dist/index.d.ts +2 -0
- package/dist/index.js +1 -0
- package/dist/provider.d.ts +16 -0
- package/dist/provider.js +141 -0
- package/package.json +65 -3
package/LICENSE
ADDED
|
@@ -0,0 +1,202 @@
|
|
|
1
|
+
|
|
2
|
+
Apache License
|
|
3
|
+
Version 2.0, January 2004
|
|
4
|
+
http://www.apache.org/licenses/
|
|
5
|
+
|
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
7
|
+
|
|
8
|
+
1. Definitions.
|
|
9
|
+
|
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
12
|
+
|
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
14
|
+
the copyright owner that is granting the License.
|
|
15
|
+
|
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
17
|
+
other entities that control, are controlled by, or are under common
|
|
18
|
+
control with that entity. For the purposes of this definition,
|
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
20
|
+
direction or management of such entity, whether by contract or
|
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
23
|
+
|
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
25
|
+
exercising permissions granted by this License.
|
|
26
|
+
|
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
28
|
+
including but not limited to software source code, documentation
|
|
29
|
+
source, and configuration files.
|
|
30
|
+
|
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
|
32
|
+
transformation or translation of a Source form, including but
|
|
33
|
+
not limited to compiled object code, generated documentation,
|
|
34
|
+
and conversions to other media types.
|
|
35
|
+
|
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
37
|
+
Object form, made available under the License, as indicated by a
|
|
38
|
+
copyright notice that is included in or attached to the work
|
|
39
|
+
(an example is provided in the Appendix below).
|
|
40
|
+
|
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
47
|
+
the Work and Derivative Works thereof.
|
|
48
|
+
|
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
|
50
|
+
the original version of the Work and any modifications or additions
|
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
62
|
+
|
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
65
|
+
subsequently incorporated within the Work.
|
|
66
|
+
|
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
|
73
|
+
|
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
79
|
+
where such license applies only to those patent claims licensable
|
|
80
|
+
by such Contributor that are necessarily infringed by their
|
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
83
|
+
institute patent litigation against any entity (including a
|
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
86
|
+
or contributory patent infringement, then any patent licenses
|
|
87
|
+
granted to You under this License for that Work shall terminate
|
|
88
|
+
as of the date such litigation is filed.
|
|
89
|
+
|
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
92
|
+
modifications, and in Source or Object form, provided that You
|
|
93
|
+
meet the following conditions:
|
|
94
|
+
|
|
95
|
+
(a) You must give any other recipients of the Work or
|
|
96
|
+
Derivative Works a copy of this License; and
|
|
97
|
+
|
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
|
99
|
+
stating that You changed the files; and
|
|
100
|
+
|
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
|
103
|
+
attribution notices from the Source form of the Work,
|
|
104
|
+
excluding those notices that do not pertain to any part of
|
|
105
|
+
the Derivative Works; and
|
|
106
|
+
|
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
|
109
|
+
include a readable copy of the attribution notices contained
|
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
|
112
|
+
of the following places: within a NOTICE text file distributed
|
|
113
|
+
as part of the Derivative Works; within the Source form or
|
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
|
115
|
+
within a display generated by the Derivative Works, if and
|
|
116
|
+
wherever such third-party notices normally appear. The contents
|
|
117
|
+
of the NOTICE file are for informational purposes only and
|
|
118
|
+
do not modify the License. You may add Your own attribution
|
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
121
|
+
that such additional attribution notices cannot be construed
|
|
122
|
+
as modifying the License.
|
|
123
|
+
|
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
|
125
|
+
may provide additional or different license terms and conditions
|
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
129
|
+
the conditions stated in this License.
|
|
130
|
+
|
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
134
|
+
this License, without any additional terms or conditions.
|
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
136
|
+
the terms of any separate license agreement you may have executed
|
|
137
|
+
with Licensor regarding such Contributions.
|
|
138
|
+
|
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
141
|
+
except as required for reasonable and customary use in describing the
|
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
143
|
+
|
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
|
153
|
+
|
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
|
159
|
+
incidental, or consequential damages of any character arising as a
|
|
160
|
+
result of this License or out of the use or inability to use the
|
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
163
|
+
other commercial damages or losses), even if such Contributor
|
|
164
|
+
has been advised of the possibility of such damages.
|
|
165
|
+
|
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
169
|
+
or other liability obligations and/or rights consistent with this
|
|
170
|
+
License. However, in accepting such obligations, You may act only
|
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
175
|
+
of your accepting any such warranty or additional liability.
|
|
176
|
+
|
|
177
|
+
END OF TERMS AND CONDITIONS
|
|
178
|
+
|
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
180
|
+
|
|
181
|
+
To apply the Apache License to your work, attach the following
|
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
183
|
+
replaced with your own identifying information. (Don't include
|
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
185
|
+
comment syntax for the file format. We also recommend that a
|
|
186
|
+
file or class name and description of purpose be included on the
|
|
187
|
+
same "printed page" as the copyright notice for easier
|
|
188
|
+
identification within third-party archives.
|
|
189
|
+
|
|
190
|
+
Copyright [yyyy] [name of copyright owner]
|
|
191
|
+
|
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
193
|
+
you may not use this file except in compliance with the License.
|
|
194
|
+
You may obtain a copy of the License at
|
|
195
|
+
|
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
197
|
+
|
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
201
|
+
See the License for the specific language governing permissions and
|
|
202
|
+
limitations under the License.
|
package/NOTICE
ADDED
package/README.md
CHANGED
|
@@ -1,3 +1,18 @@
|
|
|
1
|
-
#
|
|
1
|
+
# @e2e-dev/limrun
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Run `@e2e-dev/mobile` tests on Limrun iOS simulators and Android emulators.
|
|
4
|
+
Each worker gets a device, its build installed, and automatic cleanup.
|
|
5
|
+
|
|
6
|
+
```ts
|
|
7
|
+
import { mobile } from '@e2e-dev/mobile';
|
|
8
|
+
import { limrun } from '@e2e-dev/limrun';
|
|
9
|
+
|
|
10
|
+
const engine = mobile({ platform: 'ios', device: limrun() });
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Set `LIMRUN_API_KEY` in the run environment and install `@limrun/api`.
|
|
14
|
+
Android also requires `adb` on `PATH` for the driver's tunnel.
|
|
15
|
+
|
|
16
|
+
See the [integration guide](https://e2e.tester.army/docs/integrations/limrun)
|
|
17
|
+
and the [app-flow example](../../examples/with-limrun) for setup and tests
|
|
18
|
+
that run unchanged on both platforms.
|
package/dist/.build.json
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":"0.2.0"}
|
package/dist/daemon.d.ts
ADDED
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
import type { DriverBinding, DriverRequest } from './driver.ts';
|
|
2
|
+
export declare function assertDriverVersion(expected: string): void;
|
|
3
|
+
export declare function assertAndroidTools(env: NodeJS.ProcessEnv, signal: AbortSignal): Promise<void>;
|
|
4
|
+
export declare function startDriver(request: DriverRequest, env: NodeJS.ProcessEnv, signal: AbortSignal): Promise<DriverBinding>;
|
|
5
|
+
export declare function stopDriver(stateDir: string, env: NodeJS.ProcessEnv, signal: AbortSignal): Promise<void>;
|
package/dist/daemon.js
ADDED
|
@@ -0,0 +1,64 @@
|
|
|
1
|
+
import { execFile, fork } from 'node:child_process';
|
|
2
|
+
import { readFileSync } from 'node:fs';
|
|
3
|
+
import { fileURLToPath } from 'node:url';
|
|
4
|
+
import path from 'node:path';
|
|
5
|
+
import { promisify } from 'node:util';
|
|
6
|
+
const exec = promisify(execFile);
|
|
7
|
+
/** Resolve the package's declared CLI, without importing its private daemon entry. */
|
|
8
|
+
function installation() {
|
|
9
|
+
let directory = path.dirname(fileURLToPath(import.meta.resolve('agent-device')));
|
|
10
|
+
while (true) {
|
|
11
|
+
try {
|
|
12
|
+
const manifest = JSON.parse(readFileSync(path.join(directory, 'package.json'), 'utf8'));
|
|
13
|
+
if (manifest.name === 'agent-device')
|
|
14
|
+
return { version: manifest.version, bin: path.join(directory, manifest.bin['agent-device']) };
|
|
15
|
+
}
|
|
16
|
+
catch { /* The entry may be several directories below its package. */ }
|
|
17
|
+
const parent = path.dirname(directory);
|
|
18
|
+
if (parent === directory)
|
|
19
|
+
throw new Error('Cannot find the installed agent-device CLI');
|
|
20
|
+
directory = parent;
|
|
21
|
+
}
|
|
22
|
+
}
|
|
23
|
+
export function assertDriverVersion(expected) {
|
|
24
|
+
const actual = installation().version;
|
|
25
|
+
if (actual !== expected)
|
|
26
|
+
throw new Error(`@e2e-dev/limrun uses agent-device ${actual}, but @e2e-dev/mobile uses ${expected}. Install matching versions.`);
|
|
27
|
+
}
|
|
28
|
+
export async function assertAndroidTools(env, signal) {
|
|
29
|
+
try {
|
|
30
|
+
await exec('adb', ['version'], { env, signal });
|
|
31
|
+
}
|
|
32
|
+
catch (cause) {
|
|
33
|
+
if (signal.aborted)
|
|
34
|
+
throw signal.reason;
|
|
35
|
+
throw new Error('Limrun Android requires the Android SDK Platform-Tools adb executable on PATH. The device still runs in Limrun.', { cause });
|
|
36
|
+
}
|
|
37
|
+
}
|
|
38
|
+
export async function startDriver(request, env, signal) {
|
|
39
|
+
signal.throwIfAborted();
|
|
40
|
+
const entry = new URL(import.meta.url.endsWith('.ts') ? './driver.ts' : './driver.js', import.meta.url);
|
|
41
|
+
return new Promise((resolve, reject) => {
|
|
42
|
+
const child = fork(entry, [], { env, execArgv: [], stdio: ['ignore', 'ignore', 'ignore', 'ipc'] });
|
|
43
|
+
const abort = () => child.kill();
|
|
44
|
+
signal.addEventListener('abort', abort, { once: true });
|
|
45
|
+
let answered = false;
|
|
46
|
+
child.once('error', reject);
|
|
47
|
+
child.once('message', (reply) => {
|
|
48
|
+
answered = true;
|
|
49
|
+
if (reply.binding)
|
|
50
|
+
resolve(reply.binding);
|
|
51
|
+
else
|
|
52
|
+
reject(new Error(reply.error ?? 'Limrun driver returned no binding'));
|
|
53
|
+
});
|
|
54
|
+
child.once('exit', () => {
|
|
55
|
+
signal.removeEventListener('abort', abort);
|
|
56
|
+
if (!answered)
|
|
57
|
+
reject(signal.aborted ? signal.reason : new Error('Limrun driver exited before allocation finished'));
|
|
58
|
+
});
|
|
59
|
+
child.send(request);
|
|
60
|
+
});
|
|
61
|
+
}
|
|
62
|
+
export async function stopDriver(stateDir, env, signal) {
|
|
63
|
+
await exec(process.execPath, [installation().bin, 'daemon', 'stop', '--state-dir', stateDir, '--clean', '--json'], { env, signal });
|
|
64
|
+
}
|
package/dist/driver.d.ts
ADDED
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
import { type AgentDeviceClientConfig } from 'agent-device';
|
|
2
|
+
/** A separate process gives each daemon its own credentials without changing the runner's environment. */
|
|
3
|
+
export interface DriverRequest {
|
|
4
|
+
stateDir: string;
|
|
5
|
+
runId: string;
|
|
6
|
+
slot: number;
|
|
7
|
+
platform: 'ios' | 'android';
|
|
8
|
+
app?: string | undefined;
|
|
9
|
+
appPath?: string | undefined;
|
|
10
|
+
}
|
|
11
|
+
export interface DriverBinding {
|
|
12
|
+
client: AgentDeviceClientConfig;
|
|
13
|
+
deviceId: string;
|
|
14
|
+
installedApp?: string;
|
|
15
|
+
}
|
package/dist/driver.js
ADDED
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
import { createAgentDeviceClient } from 'agent-device';
|
|
2
|
+
process.once('message', (request) => {
|
|
3
|
+
void attach(request).then((binding) => process.send?.({ binding }, () => process.disconnect?.()), (cause) => process.send?.({ error: cause instanceof Error ? cause.message : String(cause) }, () => process.disconnect?.()));
|
|
4
|
+
});
|
|
5
|
+
async function attach(request) {
|
|
6
|
+
const { stateDir, runId, slot, platform, app, appPath } = request;
|
|
7
|
+
const allocator = createAgentDeviceClient({ stateDir });
|
|
8
|
+
const lease = await allocator.leases.allocate({
|
|
9
|
+
tenant: 'e2e', runId, clientId: `worker-${slot}`, leaseBackend: `${platform}-instance`, leaseProvider: 'limrun', retainOnClose: true,
|
|
10
|
+
});
|
|
11
|
+
if (!lease.retainOnClose)
|
|
12
|
+
throw new Error('agent-device did not retain the Limrun lease across session close');
|
|
13
|
+
const client = {
|
|
14
|
+
stateDir, tenant: lease.tenantId, runId: lease.runId, leaseId: lease.leaseId,
|
|
15
|
+
leaseBackend: lease.backend, leaseProvider: 'limrun',
|
|
16
|
+
...(lease.deviceKey === undefined ? {} : { deviceKey: lease.deviceKey }),
|
|
17
|
+
...(lease.clientId === undefined ? {} : { clientId: lease.clientId }),
|
|
18
|
+
};
|
|
19
|
+
const binding = { client, deviceId: `limrun:${platform}:${lease.leaseId}` };
|
|
20
|
+
if (appPath !== undefined) {
|
|
21
|
+
const device = createAgentDeviceClient(client);
|
|
22
|
+
const installed = await device.apps.install({ appPath, ...(platform === 'ios' ? { udid: binding.deviceId } : { serial: binding.deviceId }), ...(app === undefined ? {} : { app }), platform });
|
|
23
|
+
const id = installed.appId ?? installed.bundleId ?? installed.package ?? app;
|
|
24
|
+
if (!id)
|
|
25
|
+
throw new Error('Limrun installed the build but agent-device returned no app identifier');
|
|
26
|
+
binding.installedApp = id;
|
|
27
|
+
}
|
|
28
|
+
return binding;
|
|
29
|
+
}
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
import { createAgentDeviceClient } from 'agent-device';
|
|
2
|
+
/** Renew idle leases while other targets run; session retention alone does not prevent expiry. */
|
|
3
|
+
export async function startHeartbeat(binding, log) {
|
|
4
|
+
// An explicit empty URL selects the local stateDir instead of an ambient remote daemon.
|
|
5
|
+
const client = createAgentDeviceClient({ ...binding.client, daemonBaseUrl: '', daemonAuthToken: '', daemonTransport: 'auto' });
|
|
6
|
+
const leaseId = binding.client.leaseId;
|
|
7
|
+
if (!leaseId)
|
|
8
|
+
throw new Error('Limrun driver returned no agent-device lease id');
|
|
9
|
+
const controller = new AbortController();
|
|
10
|
+
const beat = () => client.leases.heartbeat({ leaseId, ttlMs: 60_000, signal: AbortSignal.any([controller.signal, AbortSignal.timeout(10_000)]) });
|
|
11
|
+
await beat();
|
|
12
|
+
let pending = Promise.resolve();
|
|
13
|
+
let timer;
|
|
14
|
+
const schedule = () => {
|
|
15
|
+
timer = setTimeout(() => {
|
|
16
|
+
pending = beat().then(() => { }, (error) => {
|
|
17
|
+
if (!controller.signal.aborted)
|
|
18
|
+
log(`driver lease renewal failed: ${error instanceof Error ? error.message : String(error)}`);
|
|
19
|
+
}).finally(() => { if (!controller.signal.aborted)
|
|
20
|
+
schedule(); });
|
|
21
|
+
}, 20_000);
|
|
22
|
+
timer.unref();
|
|
23
|
+
};
|
|
24
|
+
schedule();
|
|
25
|
+
return async () => {
|
|
26
|
+
controller.abort();
|
|
27
|
+
clearTimeout(timer);
|
|
28
|
+
await pending;
|
|
29
|
+
};
|
|
30
|
+
}
|
package/dist/index.d.ts
ADDED
package/dist/index.js
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export { limrun } from './provider.js';
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
import type { DeviceProvider } from '@e2e-dev/mobile';
|
|
2
|
+
export interface LimrunOptions {
|
|
3
|
+
/** Region preference, such as `eu` or `us-east1`. Limrun may overflow to another region. */
|
|
4
|
+
readonly region?: string;
|
|
5
|
+
/** Maximum device lifetime. Defaults to `1h`, including abandoned runs. */
|
|
6
|
+
readonly hardTimeout?: string;
|
|
7
|
+
readonly ios?: {
|
|
8
|
+
readonly model?: 'iphone' | 'ipad';
|
|
9
|
+
};
|
|
10
|
+
readonly android?: {
|
|
11
|
+
readonly model?: 'phone' | 'tablet';
|
|
12
|
+
readonly osVersion?: string;
|
|
13
|
+
};
|
|
14
|
+
}
|
|
15
|
+
/** One Limrun instance and isolated agent-device daemon per worker slot. */
|
|
16
|
+
export declare function limrun(options?: LimrunOptions): DeviceProvider;
|
package/dist/provider.js
ADDED
|
@@ -0,0 +1,141 @@
|
|
|
1
|
+
import { mkdtemp, rm } from 'node:fs/promises';
|
|
2
|
+
import { tmpdir } from 'node:os';
|
|
3
|
+
import path from 'node:path';
|
|
4
|
+
import { setTimeout as sleep } from 'node:timers/promises';
|
|
5
|
+
import Limrun from '@limrun/api';
|
|
6
|
+
import { ConfigurationError, rejectUnknownKeys } from 'e2e/engine';
|
|
7
|
+
import { startHeartbeat } from './heartbeat.js';
|
|
8
|
+
import { assertAndroidTools, assertDriverVersion, startDriver, stopDriver } from './daemon.js';
|
|
9
|
+
function api(env) {
|
|
10
|
+
const apiKey = env.LIMRUN_API_KEY?.trim();
|
|
11
|
+
if (!apiKey)
|
|
12
|
+
throw new ConfigurationError('INVALID_CONFIG', '@e2e-dev/limrun requires LIMRUN_API_KEY in the run environment');
|
|
13
|
+
// Retrying a create after an ambiguous response could allocate a second device.
|
|
14
|
+
return new Limrun({ apiKey, baseURL: env.LIMRUN_BASE_URL?.trim() || 'https://api.limrun.com', maxRetries: 0, timeout: 60_000, defaultHeaders: { 'X-Limrun-Client': 'e2e' } });
|
|
15
|
+
}
|
|
16
|
+
function access(instance) {
|
|
17
|
+
const { apiUrl, token } = instance.status;
|
|
18
|
+
if (!apiUrl || !token)
|
|
19
|
+
throw new Error(`Limrun instance ${instance.metadata.id} has no control endpoint or token. Use an API key with full control.`);
|
|
20
|
+
return { apiUrl, token };
|
|
21
|
+
}
|
|
22
|
+
async function ready(client, platform, instance, signal) {
|
|
23
|
+
let current = instance;
|
|
24
|
+
while (true) {
|
|
25
|
+
signal.throwIfAborted();
|
|
26
|
+
if (current.status.state === 'ready')
|
|
27
|
+
return current;
|
|
28
|
+
if (current.status.state === 'terminated')
|
|
29
|
+
throw new Error(`Limrun instance ${instance.metadata.id} terminated before readiness: ${current.status.errorMessage ?? current.status.terminationReason ?? 'unknown'}`);
|
|
30
|
+
await sleep(500, undefined, { signal });
|
|
31
|
+
try {
|
|
32
|
+
current = await (platform === 'ios' ? client.iosInstances : client.androidInstances).get(instance.metadata.id, { signal });
|
|
33
|
+
}
|
|
34
|
+
catch (cause) {
|
|
35
|
+
// The regional create can precede the backend read model. The caller's budget bounds readiness.
|
|
36
|
+
if (!(cause instanceof Limrun.NotFoundError))
|
|
37
|
+
throw cause;
|
|
38
|
+
}
|
|
39
|
+
}
|
|
40
|
+
}
|
|
41
|
+
async function deleteInstance(client, platform, id, signal) {
|
|
42
|
+
try {
|
|
43
|
+
await (platform === 'ios' ? client.iosInstances : client.androidInstances).delete(id, { signal });
|
|
44
|
+
}
|
|
45
|
+
catch (cause) {
|
|
46
|
+
// An expired or already deleted instance needs no further cleanup.
|
|
47
|
+
if (!(cause instanceof Limrun.NotFoundError))
|
|
48
|
+
throw cause;
|
|
49
|
+
}
|
|
50
|
+
}
|
|
51
|
+
function driverEnv(env, instance, platform) {
|
|
52
|
+
const result = { ...env };
|
|
53
|
+
// A user's attached instance and daemon settings must not select a different device.
|
|
54
|
+
for (const key of Object.keys(result)) {
|
|
55
|
+
// Keep the user's security policy on both the daemon and its clients.
|
|
56
|
+
if (key === 'AGENT_DEVICE_DAEMON_POLICY')
|
|
57
|
+
continue;
|
|
58
|
+
if (key.startsWith('LIM_IOS_INSTANCE_') || key.startsWith('LIM_ANDROID_INSTANCE_') || key.startsWith('AGENT_DEVICE_'))
|
|
59
|
+
delete result[key];
|
|
60
|
+
}
|
|
61
|
+
const { apiUrl, token } = access(instance);
|
|
62
|
+
const prefix = platform === 'ios' ? 'LIM_IOS_INSTANCE' : 'LIM_ANDROID_INSTANCE';
|
|
63
|
+
result[`${prefix}_URL`] = apiUrl;
|
|
64
|
+
result[`${prefix}_TOKEN`] = token;
|
|
65
|
+
if (platform === 'android') {
|
|
66
|
+
const adbUrl = instance.status.adbWebSocketUrl;
|
|
67
|
+
if (!adbUrl)
|
|
68
|
+
throw new Error(`Limrun instance ${instance.metadata.id} has no ADB endpoint`);
|
|
69
|
+
result.LIM_ANDROID_INSTANCE_ADB_URL = adbUrl;
|
|
70
|
+
}
|
|
71
|
+
result.LIMRUN_KEEP_ALIVE = 'true';
|
|
72
|
+
return result;
|
|
73
|
+
}
|
|
74
|
+
/** One Limrun instance and isolated agent-device daemon per worker slot. */
|
|
75
|
+
export function limrun(options = {}) {
|
|
76
|
+
rejectUnknownKeys('limrun()', options, ['region', 'hardTimeout', 'ios', 'android']);
|
|
77
|
+
if (options.ios)
|
|
78
|
+
rejectUnknownKeys('limrun().ios', options.ios, ['model']);
|
|
79
|
+
if (options.android)
|
|
80
|
+
rejectUnknownKeys('limrun().android', options.android, ['model', 'osVersion']);
|
|
81
|
+
const held = new Map();
|
|
82
|
+
async function release(id, resource, signal) {
|
|
83
|
+
await resource.stopHeartbeat?.();
|
|
84
|
+
const results = await Promise.allSettled([
|
|
85
|
+
stopDriver(resource.stateDir, resource.env, signal).then(() => rm(resource.stateDir, { recursive: true, force: true })),
|
|
86
|
+
deleteInstance(resource.client, resource.platform, id, signal),
|
|
87
|
+
]);
|
|
88
|
+
const errors = results.flatMap((result) => result.status === 'rejected' ? [result.reason] : []);
|
|
89
|
+
if (errors.length)
|
|
90
|
+
throw new AggregateError(errors, `Could not fully release Limrun instance ${id}: ${errors.map((error) => error instanceof Error ? error.message : String(error)).join('; ')}`);
|
|
91
|
+
held.delete(id);
|
|
92
|
+
}
|
|
93
|
+
return {
|
|
94
|
+
name: 'Limrun',
|
|
95
|
+
async acquire(request) {
|
|
96
|
+
assertDriverVersion(request.agentDeviceVersion);
|
|
97
|
+
request.signal.throwIfAborted();
|
|
98
|
+
const client = api(request.env);
|
|
99
|
+
if (request.platform === 'android')
|
|
100
|
+
await assertAndroidTools({ ...request.env }, request.signal);
|
|
101
|
+
const spec = { hardTimeout: options.hardTimeout ?? '1h', ...(options.region === undefined ? {} : { region: options.region }) };
|
|
102
|
+
const metadata = { displayName: `e2e ${request.targetName} worker ${request.slot + 1}`, labels: { source: 'e2e', run: request.runId, target: request.targetName, slot: String(request.slot) } };
|
|
103
|
+
// Receive the id even if the run is interrupted during create, so cleanup can delete it.
|
|
104
|
+
const created = request.platform === 'ios'
|
|
105
|
+
? await client.iosInstances.create({ metadata, spec: { ...spec, ...options.ios } })
|
|
106
|
+
: await client.androidInstances.create({ metadata, spec: { ...spec, ...(options.android?.model === undefined ? {} : { model: options.android.model }), clues: [{ kind: 'OSVersion', osVersion: options.android?.osVersion ?? '15' }] } });
|
|
107
|
+
const id = created.metadata.id;
|
|
108
|
+
let resource;
|
|
109
|
+
try {
|
|
110
|
+
const stateDir = await mkdtemp(path.join(tmpdir(), 'e2e-limrun-'));
|
|
111
|
+
resource = { stateDir, env: { ...request.env }, client, platform: request.platform };
|
|
112
|
+
held.set(id, resource);
|
|
113
|
+
request.log(`created ${id}`);
|
|
114
|
+
const signal = AbortSignal.any([request.signal, AbortSignal.timeout(300_000)]);
|
|
115
|
+
const instance = await ready(client, request.platform, created, signal);
|
|
116
|
+
resource.env = driverEnv(request.env, instance, request.platform);
|
|
117
|
+
const binding = await startDriver({ stateDir, runId: request.runId, slot: request.slot, platform: request.platform, app: request.app, appPath: request.appPath }, resource.env, signal);
|
|
118
|
+
resource.stopHeartbeat = await startHeartbeat(binding, request.log);
|
|
119
|
+
return { id, ...binding };
|
|
120
|
+
}
|
|
121
|
+
catch (cause) {
|
|
122
|
+
const signal = AbortSignal.timeout(30_000);
|
|
123
|
+
try {
|
|
124
|
+
if (resource)
|
|
125
|
+
await release(id, resource, signal);
|
|
126
|
+
else
|
|
127
|
+
await deleteInstance(client, request.platform, id, signal);
|
|
128
|
+
}
|
|
129
|
+
catch (cleanup) {
|
|
130
|
+
throw new AggregateError([cause, cleanup], `Limrun acquisition failed; cleanup also failed for ${id}`, { cause: cleanup });
|
|
131
|
+
}
|
|
132
|
+
throw cause;
|
|
133
|
+
}
|
|
134
|
+
},
|
|
135
|
+
async release(lease, context) {
|
|
136
|
+
const resource = held.get(lease.id);
|
|
137
|
+
if (resource)
|
|
138
|
+
await release(lease.id, resource, context.signal);
|
|
139
|
+
},
|
|
140
|
+
};
|
|
141
|
+
}
|
package/package.json
CHANGED
|
@@ -1,6 +1,68 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@e2e-dev/limrun",
|
|
3
|
-
"version": "0.
|
|
4
|
-
"
|
|
5
|
-
"
|
|
3
|
+
"version": "0.2.0",
|
|
4
|
+
"description": "Limrun hosted iOS simulators and Android emulators for e2e mobile tests",
|
|
5
|
+
"keywords": [
|
|
6
|
+
"e2e",
|
|
7
|
+
"testing",
|
|
8
|
+
"limrun",
|
|
9
|
+
"ios-simulator",
|
|
10
|
+
"android-emulator",
|
|
11
|
+
"ci"
|
|
12
|
+
],
|
|
13
|
+
"license": "Apache-2.0",
|
|
14
|
+
"contributors": [
|
|
15
|
+
"Mehmet Enes Onus <enes@limrun.com>"
|
|
16
|
+
],
|
|
17
|
+
"repository": {
|
|
18
|
+
"type": "git",
|
|
19
|
+
"url": "git+https://github.com/tester-army/e2e.git",
|
|
20
|
+
"directory": "packages/limrun"
|
|
21
|
+
},
|
|
22
|
+
"bugs": {
|
|
23
|
+
"url": "https://github.com/tester-army/e2e/issues"
|
|
24
|
+
},
|
|
25
|
+
"homepage": "https://github.com/tester-army/e2e/tree/main/packages/limrun#readme",
|
|
26
|
+
"publishConfig": {
|
|
27
|
+
"registry": "https://registry.npmjs.org/",
|
|
28
|
+
"access": "public",
|
|
29
|
+
"tag": "latest"
|
|
30
|
+
},
|
|
31
|
+
"type": "module",
|
|
32
|
+
"exports": {
|
|
33
|
+
".": {
|
|
34
|
+
"types": "./dist/index.d.ts",
|
|
35
|
+
"default": "./dist/index.js"
|
|
36
|
+
}
|
|
37
|
+
},
|
|
38
|
+
"files": [
|
|
39
|
+
"dist",
|
|
40
|
+
"NOTICE"
|
|
41
|
+
],
|
|
42
|
+
"peerDependencies": {
|
|
43
|
+
"@e2e-dev/mobile": ">=0.11.1 <1",
|
|
44
|
+
"e2e": ">=0.15.0 <1",
|
|
45
|
+
"@limrun/api": ">=0.59.0 <1"
|
|
46
|
+
},
|
|
47
|
+
"devDependencies": {
|
|
48
|
+
"@e2e-dev/mobile": "0.12.0",
|
|
49
|
+
"@types/node": "26.6.2",
|
|
50
|
+
"e2e": "0.20.0",
|
|
51
|
+
"typescript": "7.0.2",
|
|
52
|
+
"vitest": "5.0.1",
|
|
53
|
+
"@limrun/api": "0.59.0"
|
|
54
|
+
},
|
|
55
|
+
"engines": {
|
|
56
|
+
"node": "^22.22.3 || >=24.8.0"
|
|
57
|
+
},
|
|
58
|
+
"dependencies": {
|
|
59
|
+
"agent-device": "0.21.25"
|
|
60
|
+
},
|
|
61
|
+
"scripts": {
|
|
62
|
+
"build": "node -e \"require('node:fs').rmSync('dist',{recursive:true,force:true})\" && tsc --project tsconfig.build.json && node ../../scripts/stamp-dist.ts",
|
|
63
|
+
"typecheck": "tsc --noEmit",
|
|
64
|
+
"test": "vitest run",
|
|
65
|
+
"test:watch": "vitest",
|
|
66
|
+
"test:unit": "vitest run tests/unit"
|
|
67
|
+
}
|
|
6
68
|
}
|