@intuned/runtime-dev 0.1.0-test.11 → 0.1.0-test.13

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 (100) hide show
  1. package/.babelrc +0 -1
  2. package/dist/commands/api/run.js +156 -83
  3. package/dist/commands/api/run.ts +105 -0
  4. package/dist/commands/auth-sessions/load.js +20 -20
  5. package/dist/commands/auth-sessions/load.ts +30 -0
  6. package/dist/commands/auth-sessions/run-check.js +45 -39
  7. package/dist/commands/auth-sessions/run-check.ts +51 -0
  8. package/dist/commands/auth-sessions/run-create.js +84 -74
  9. package/dist/commands/auth-sessions/run-create.ts +91 -0
  10. package/dist/commands/browser/save-state.js +12 -7
  11. package/dist/commands/browser/save-state.ts +14 -0
  12. package/dist/commands/browser/start-browser.js +7 -4
  13. package/dist/commands/browser/start-browser.ts +11 -0
  14. package/dist/commands/build.js +97 -61
  15. package/dist/commands/build.ts +78 -0
  16. package/dist/commands/common/browserUtils.js +42 -31
  17. package/dist/commands/common/browserUtils.ts +45 -0
  18. package/dist/commands/common/getDefaultExportFromFile.js +11 -10
  19. package/dist/commands/common/getDefaultExportFromFile.ts +11 -0
  20. package/dist/commands/common/getFirstLineNumber.js +90 -83
  21. package/dist/commands/common/{getFirstLineNumber.test.js → getFirstLineNumber.test.ts} +2 -2
  22. package/dist/commands/common/getFirstLineNumber.ts +96 -0
  23. package/dist/commands/common/sendMessageToClient.js +4 -2
  24. package/dist/commands/common/sendMessageToClient.ts +3 -0
  25. package/dist/commands/common/utils/fileUtils.js +16 -16
  26. package/dist/commands/common/utils/fileUtils.ts +23 -0
  27. package/dist/commands/common/utils/settings.js +17 -19
  28. package/dist/commands/common/utils/settings.ts +22 -0
  29. package/dist/commands/common/utils/unixSocket.js +43 -36
  30. package/dist/commands/common/utils/unixSocket.ts +38 -0
  31. package/dist/commands/common/utils/webTemplate.js +25 -18
  32. package/dist/commands/common/utils/webTemplate.ts +22 -0
  33. package/dist/commands/interface/run.js +139 -133
  34. package/dist/commands/interface/run.ts +156 -0
  35. package/dist/commands/ts-check.js +45 -41
  36. package/dist/commands/ts-check.ts +50 -0
  37. package/dist/common/Logger/Logger/index.d.ts +1 -1
  38. package/dist/common/Logger/Logger/index.js +40 -46
  39. package/dist/common/Logger/Logger/index.ts +53 -0
  40. package/dist/common/Logger/Logger/types.js +1 -1
  41. package/dist/common/Logger/index.d.ts +1 -1
  42. package/dist/common/Logger/index.js +40 -46
  43. package/dist/common/Logger/index.ts +53 -0
  44. package/dist/common/Logger/types.js +1 -1
  45. package/dist/common/asyncLocalStorage/index.js +4 -4
  46. package/dist/common/asyncLocalStorage/index.ts +9 -0
  47. package/dist/common/cleanEnvironmentVariables.js +11 -9
  48. package/dist/common/cleanEnvironmentVariables.ts +10 -0
  49. package/dist/common/constants.js +1 -1
  50. package/dist/common/constants.ts +1 -0
  51. package/dist/common/contextStorageStateHelpers.js +36 -38
  52. package/dist/common/contextStorageStateHelpers.ts +43 -0
  53. package/dist/common/getPlaywrightConstructs.d.ts +1 -1
  54. package/dist/common/getPlaywrightConstructs.js +187 -157
  55. package/dist/common/getPlaywrightConstructs.ts +181 -0
  56. package/dist/common/jwtTokenManager.js +74 -61
  57. package/dist/common/jwtTokenManager.ts +71 -0
  58. package/dist/common/runApi/errors.d.ts +1 -1
  59. package/dist/common/runApi/errors.js +130 -121
  60. package/dist/common/runApi/errors.ts +154 -0
  61. package/dist/common/runApi/index.d.ts +4 -4
  62. package/dist/common/runApi/index.js +219 -233
  63. package/dist/common/runApi/index.ts +253 -0
  64. package/dist/common/runApi/types.d.ts +1 -1
  65. package/dist/common/runApi/types.js +55 -41
  66. package/dist/common/runApi/types.ts +43 -0
  67. package/dist/common/settingsSchema.js +9 -6
  68. package/dist/common/settingsSchema.ts +9 -0
  69. package/dist/common/telemetry.js +27 -16
  70. package/dist/common/telemetry.ts +23 -0
  71. package/dist/index.d.ts +4 -4
  72. package/dist/index.js +4 -4
  73. package/dist/index.ts +4 -0
  74. package/dist/runtime/RunError.d.ts +1 -1
  75. package/dist/runtime/RunError.js +10 -10
  76. package/dist/runtime/RunError.ts +12 -0
  77. package/dist/runtime/downloadDirectory.js +10 -10
  78. package/dist/runtime/downloadDirectory.ts +13 -0
  79. package/dist/runtime/enums.d.ts +1 -11
  80. package/dist/runtime/enums.js +12 -12
  81. package/dist/runtime/enums.ts +12 -0
  82. package/dist/runtime/{executionHelpers.test.js → executionHelpers.test.ts} +2 -2
  83. package/dist/runtime/export.d.ts +1 -202
  84. package/dist/runtime/extendPayload.d.ts +1 -1
  85. package/dist/runtime/extendPayload.js +13 -13
  86. package/dist/runtime/extendPayload.ts +15 -0
  87. package/dist/runtime/extendTimeout.js +19 -20
  88. package/dist/runtime/extendTimeout.ts +24 -0
  89. package/dist/runtime/index.d.ts +7 -7
  90. package/dist/runtime/index.js +6 -6
  91. package/dist/runtime/index.ts +6 -0
  92. package/dist/runtime/requestMoreInfo.js +14 -14
  93. package/dist/runtime/requestMoreInfo.ts +18 -0
  94. package/dist/runtime/runInfo.d.ts +1 -1
  95. package/dist/runtime/runInfo.js +12 -13
  96. package/dist/runtime/runInfo.ts +15 -0
  97. package/package.json +3 -2
  98. package/tsconfig.json +1 -1
  99. /package/dist/{runtime/enums.d.js → common/Logger/Logger/types.ts} +0 -0
  100. /package/dist/{runtime/export.d.js → common/Logger/types.ts} +0 -0
@@ -2,252 +2,238 @@ import { getDownloadDirectoryPath } from "../../runtime/downloadDirectory";
2
2
  import { getExecutionContext } from "../asyncLocalStorage";
3
3
  import * as fs from "fs-extra";
4
4
  import { backendFunctionsTokenManager } from "../jwtTokenManager";
5
- import { getContextStorageState, setContextStorageState } from "../contextStorageStateHelpers";
5
+ import { getContextStorageState, setContextStorageState, } from "../contextStorageStateHelpers";
6
6
  import { remove } from "fs-extra";
7
7
  import { ok, err } from "neverthrow";
8
- import { AbortedError, ApiNotFoundError, AutomationError, InvalidApiError, InvalidCheckError, MaxLevelsExceededError } from "./errors";
8
+ import { AbortedError, ApiNotFoundError, AutomationError, InvalidApiError, InvalidCheckError, MaxLevelsExceededError, } from "./errors.js";
9
9
  import { AUTH_SESSIONS_FOLDER_NAME } from "../constants";
10
- import { getPlaywrightConstructsForMode, getProductionPlaywrightConstructs } from "../getPlaywrightConstructs";
11
- import { runApiParametersSchema } from "./types";
12
- export * from "./types";
13
- export * from "./errors";
14
- export async function* runApiGenerator({
15
- retrieveSession = false,
16
- abortSignal,
17
- ...input
18
- }) {
19
- let traceStarted = false;
20
- const {
21
- automationFunction,
22
- runOptions,
23
- tracing,
24
- auth,
25
- functionsToken
26
- } = runApiParametersSchema.parse(input);
27
- backendFunctionsTokenManager.token = functionsToken;
28
- const downloadsPath = getDownloadDirectoryPath();
29
- let page;
30
- let context;
31
- if (runOptions.environment === "deployed") {
32
- const {
33
- headless,
34
- proxy
35
- } = runOptions;
36
- ({
37
- page,
38
- context
39
- } = await getProductionPlaywrightConstructs({
40
- headless,
41
- proxy,
42
- downloadsPath,
43
- storageState: auth === null || auth === void 0 ? void 0 : auth.session
44
- }));
45
- } else {
46
- const {
47
- mode,
48
- cdpAddress
49
- } = runOptions;
50
- ({
51
- page,
52
- context
53
- } = await getPlaywrightConstructsForMode(mode, cdpAddress, auth === null || auth === void 0 ? void 0 : auth.session));
54
- }
55
- const executionContext = getExecutionContext();
56
- if (!executionContext) {
57
- throw "";
58
- }
59
- async function saveTraceIfNeeded({
60
- errorMessage
61
- }) {
62
- if (!tracing.enabled || !traceStarted) {
63
- return;
10
+ import { getPlaywrightConstructsForMode, getProductionPlaywrightConstructs, } from "../getPlaywrightConstructs";
11
+ import { runApiParametersSchema, } from "./types.js";
12
+ export * from "./types.js";
13
+ export * from "./errors.js";
14
+ export async function* runApiGenerator({ retrieveSession = false, abortSignal, ...input }) {
15
+ let traceStarted = false;
16
+ const { automationFunction, runOptions, tracing, auth, functionsToken } = runApiParametersSchema.parse(input);
17
+ backendFunctionsTokenManager.token = functionsToken;
18
+ const downloadsPath = getDownloadDirectoryPath();
19
+ let page;
20
+ let context;
21
+ if (runOptions.environment === "deployed") {
22
+ const { headless, proxy } = runOptions;
23
+ ({ page, context } = await getProductionPlaywrightConstructs({
24
+ headless,
25
+ proxy,
26
+ downloadsPath,
27
+ storageState: auth?.session,
28
+ }));
64
29
  }
65
- try {
66
- await context.tracing.stop({
67
- path: tracing.filePath
68
- });
69
- } catch (error) {
70
- console.log(errorMessage, error === null || error === void 0 ? void 0 : error.message);
71
- await remove(tracing.filePath);
72
- }
73
- }
74
- if (tracing.enabled) {
75
- await context.tracing.start({
76
- screenshots: true,
77
- snapshots: true,
78
- sources: true
79
- });
80
- traceStarted = true;
81
- }
82
- const abortSymbol = Symbol("abort");
83
- const abortPromise = new Promise(resolve => {
84
- if (!abortSignal) return;
85
- abortSignal.addEventListener("abort", () => {
86
- resolve(abortSymbol);
87
- });
88
- });
89
- if (auth && auth.session.type === "state") {
90
- await setContextStorageState(context, auth.session.state);
91
- }
92
- async function* runAutomation() {
93
- var _getExecutionContext;
94
- if (auth !== null && auth !== void 0 && auth.runCheck) {
95
- if (!auth.session) {
96
- return err({
97
- code: "AuthRequiredError"
30
+ else {
31
+ const { mode, cdpAddress } = runOptions;
32
+ ({ page, context } = await getPlaywrightConstructsForMode(mode, cdpAddress, auth?.session));
33
+ }
34
+ const executionContext = getExecutionContext();
35
+ if (!executionContext) {
36
+ throw ""; // todo
37
+ }
38
+ async function saveTraceIfNeeded({ errorMessage }) {
39
+ if (!tracing.enabled || !traceStarted) {
40
+ return;
41
+ }
42
+ try {
43
+ await context.tracing.stop({ path: tracing.filePath });
44
+ }
45
+ catch (error) {
46
+ console.log(errorMessage, error?.message);
47
+ await remove(tracing.filePath);
48
+ }
49
+ }
50
+ if (tracing.enabled) {
51
+ await context.tracing.start({
52
+ screenshots: true,
53
+ snapshots: true,
54
+ sources: true,
55
+ });
56
+ traceStarted = true;
57
+ }
58
+ const abortSymbol = Symbol("abort");
59
+ const abortPromise = new Promise((resolve) => {
60
+ if (!abortSignal)
61
+ return;
62
+ abortSignal.addEventListener("abort", () => {
63
+ resolve(abortSymbol);
98
64
  });
99
- }
100
- console.log("Running auth check");
101
- const authCheckResult = await checkAuthSessionWithRetries(page, context, 2);
102
- if (authCheckResult.isErr()) {
103
- const error = authCheckResult.error;
104
- if (["APINotFoundError", "InvalidAPIError"].includes(error.code)) {
105
- return err(new InvalidCheckError(`Auth session check function failed`, error));
65
+ });
66
+ if (auth && auth.session.type === "state") {
67
+ await setContextStorageState(context, auth.session.state);
68
+ }
69
+ async function* runAutomation() {
70
+ if (auth?.runCheck) {
71
+ if (!auth.session) {
72
+ return err({ code: "AuthRequiredError" });
73
+ }
74
+ console.log("Running auth check");
75
+ const authCheckResult = await checkAuthSessionWithRetries(page, context, 2);
76
+ if (authCheckResult.isErr()) {
77
+ const error = authCheckResult.error;
78
+ if (["APINotFoundError", "InvalidAPIError"].includes(error.code)) {
79
+ return err(new InvalidCheckError(`Auth session check function failed`, error));
80
+ }
81
+ return authCheckResult;
82
+ }
83
+ if (!authCheckResult.value) {
84
+ return err({
85
+ code: "AuthCheckFailedError",
86
+ });
87
+ }
88
+ }
89
+ console.log("Running function", automationFunction.name);
90
+ const args = [
91
+ ...(automationFunction.params ? [automationFunction.params] : []),
92
+ page,
93
+ context,
94
+ ];
95
+ const importResult = await importFunction(automationFunction.name);
96
+ if (importResult.isErr()) {
97
+ return importResult;
98
+ }
99
+ let result;
100
+ if (importResult.value.type === "async-generator") {
101
+ const generator = importResult.value.generator(...args);
102
+ let next = undefined;
103
+ while (true) {
104
+ const generatorResult = await generator.next(...(next ? [next] : []));
105
+ if (!generatorResult.done) {
106
+ next = yield generatorResult.value;
107
+ continue;
108
+ }
109
+ result = generatorResult.value;
110
+ break;
111
+ }
106
112
  }
107
- return authCheckResult;
108
- }
109
- if (!authCheckResult.value) {
110
- return err({
111
- code: "AuthCheckFailedError"
113
+ else {
114
+ result = await importResult.value.func(...args);
115
+ }
116
+ return ok({
117
+ result,
118
+ extendedPayloads: getExecutionContext()?.extendedPayloads,
119
+ session: retrieveSession
120
+ ? await getContextStorageState(context)
121
+ : undefined,
112
122
  });
113
- }
114
123
  }
115
- console.log("Running function", automationFunction.name);
116
- const args = [...(automationFunction.params ? [automationFunction.params] : []), page, context];
117
- const importResult = await importFunction(automationFunction.name);
118
- if (importResult.isErr()) {
119
- return importResult;
120
- }
121
- let result;
122
- if (importResult.value.type === "async-generator") {
123
- const generator = importResult.value.generator(...args);
124
- let next = undefined;
125
- while (true) {
126
- const generatorResult = await generator.next(...(next ? [next] : []));
127
- if (!generatorResult.done) {
128
- next = yield generatorResult.value;
129
- continue;
124
+ try {
125
+ const generator = runAutomation();
126
+ let next = undefined;
127
+ while (true) {
128
+ const result = await Promise.race([
129
+ generator.next(await next),
130
+ abortPromise,
131
+ ]);
132
+ if (result === abortSymbol) {
133
+ return err(new AbortedError());
134
+ }
135
+ if (!result.done) {
136
+ next = yield result.value;
137
+ continue;
138
+ }
139
+ return result.value;
130
140
  }
131
- result = generatorResult.value;
132
- break;
133
- }
134
- } else {
135
- result = await importResult.value.func(...args);
136
- }
137
- return ok({
138
- result,
139
- extendedPayloads: (_getExecutionContext = getExecutionContext()) === null || _getExecutionContext === void 0 ? void 0 : _getExecutionContext.extendedPayloads,
140
- session: retrieveSession ? await getContextStorageState(context) : undefined
141
- });
142
- }
143
- try {
144
- const generator = runAutomation();
145
- let next = undefined;
146
- while (true) {
147
- const result = await Promise.race([generator.next(await next), abortPromise]);
148
- if (result === abortSymbol) {
149
- return err(new AbortedError());
150
- }
151
- if (!result.done) {
152
- next = yield result.value;
153
- continue;
154
- }
155
- return result.value;
156
- }
157
- } catch (error) {
158
- console.log("run errored", error);
159
- return err(new AutomationError(error));
160
- } finally {
161
- await saveTraceIfNeeded({
162
- errorMessage: "failed to save trace"
163
- });
164
- await context.close();
165
- await fs.remove(downloadsPath);
166
- }
141
+ }
142
+ catch (error) {
143
+ console.log("run errored", error);
144
+ return err(new AutomationError(error));
145
+ }
146
+ finally {
147
+ await saveTraceIfNeeded({ errorMessage: "failed to save trace" });
148
+ await context.close();
149
+ await fs.remove(downloadsPath);
150
+ }
167
151
  }
168
152
  export async function runApi(params) {
169
- const generator = runApiGenerator(params);
170
- const {
171
- value,
172
- done
173
- } = await generator.next();
174
- if (done) {
175
- return value;
176
- }
177
- return err(new InvalidApiError("Expected API to be async function, got async generator"));
153
+ const generator = runApiGenerator(params);
154
+ const { value, done } = await generator.next();
155
+ if (done) {
156
+ return value;
157
+ }
158
+ return err(new InvalidApiError("Expected API to be async function, got async generator"));
178
159
  }
179
160
  export async function checkAuthSessionWithRetries(page, context, retries = 3) {
180
- if (retries === 0) {
161
+ if (retries === 0) {
162
+ return ok(false);
163
+ }
164
+ let tryNumber = 0;
165
+ console.log("Checking auth session with retries", `${AUTH_SESSIONS_FOLDER_NAME}/check`);
166
+ const importResult = await importFunction(`${AUTH_SESSIONS_FOLDER_NAME}/check`);
167
+ if (importResult.isErr()) {
168
+ return err(importResult.error);
169
+ }
170
+ if (importResult.value.type !== "async") {
171
+ return err(new InvalidCheckError("Check function is not an async function"));
172
+ }
173
+ const check = importResult.value.func;
174
+ while (retries > tryNumber) {
175
+ const result = await check(page, context);
176
+ if (result)
177
+ return ok(true);
178
+ tryNumber++;
179
+ }
181
180
  return ok(false);
182
- }
183
- let tryNumber = 0;
184
- console.log("Checking auth session with retries", `${AUTH_SESSIONS_FOLDER_NAME}/check`);
185
- const importResult = await importFunction(`${AUTH_SESSIONS_FOLDER_NAME}/check`);
186
- if (importResult.isErr()) {
187
- return err(importResult.error);
188
- }
189
- if (importResult.value.type !== "async") {
190
- return err(new InvalidCheckError("Check function is not an async function"));
191
- }
192
- const check = importResult.value.func;
193
- while (retries > tryNumber) {
194
- const result = await check(page, context);
195
- if (result) return ok(true);
196
- tryNumber++;
197
- }
198
- return ok(false);
199
181
  }
200
182
  async function importFunction(path) {
201
- const functionNameParts = path.split("/");
202
- const functionNameDepth = functionNameParts.length;
203
- try {
204
- let imported = undefined;
205
- switch (functionNameDepth) {
206
- case 1:
207
- imported = await import(`../../../${functionNameParts[0]}.ts`);
208
- break;
209
- case 2:
210
- imported = await import(`../../../${functionNameParts[0]}/${functionNameParts[1]}.ts`);
211
- break;
212
- case 3:
213
- imported = await import(`../../../${functionNameParts[0]}/${functionNameParts[1]}/${functionNameParts[2]}.ts`);
214
- break;
215
- case 4:
216
- imported = await import(`../../../${functionNameParts[0]}/${functionNameParts[1]}/${functionNameParts[2]}/${functionNameParts[3]}.ts`);
217
- break;
218
- case 5:
219
- imported = await import(`../../../${functionNameParts[0]}/${functionNameParts[1]}/${functionNameParts[2]}/${functionNameParts[3]}/${functionNameParts[4]}.ts`);
220
- break;
221
- case 6:
222
- imported = await import(`../../../${functionNameParts[0]}/${functionNameParts[1]}/${functionNameParts[2]}/${functionNameParts[3]}/${functionNameParts[4]}/${functionNameParts[5]}.ts`);
223
- break;
224
- default:
225
- return err(new MaxLevelsExceededError(5));
226
- }
227
- if (!imported || !imported.default || !imported.default.constructor) {
228
- return err(new InvalidApiError("API file path does not have a default export"));
229
- }
230
- if (imported.default.constructor.name === "AsyncGeneratorFunction") {
231
- return ok({
232
- type: "async-generator",
233
- generator: imported.default
234
- });
235
- }
236
- if (imported.default.constructor.name === "AsyncFunction") {
237
- return ok({
238
- type: "async",
239
- func: imported.default
240
- });
241
- }
242
- return err(new InvalidApiError("API file path does not have a default async function/generator export"));
243
- } catch (error) {
244
- if (error.message.includes("Unknown variable dynamic import")) {
245
- return err(new ApiNotFoundError(path));
246
- }
247
- if ((error === null || error === void 0 ? void 0 : error.code) === "ERR_MODULE_NOT_FOUND") {
248
- console.log("API not found", error);
249
- return err(new ApiNotFoundError(path));
250
- }
251
- throw error;
252
- }
253
- }
183
+ const functionNameParts = path.split("/");
184
+ const functionNameDepth = functionNameParts.length;
185
+ // string literals should be inline
186
+ // currently we support only 5 levels of depth
187
+ // rollup dynamic import does not support multiple levels of dynamic imports so we need to specify the possible paths explicitly
188
+ try {
189
+ let imported = undefined;
190
+ switch (functionNameDepth) {
191
+ case 1:
192
+ imported = await import(`../../../${functionNameParts[0]}.ts`);
193
+ break;
194
+ case 2:
195
+ imported = await import(`../../../${functionNameParts[0]}/${functionNameParts[1]}.ts`);
196
+ break;
197
+ case 3:
198
+ imported = await import(`../../../${functionNameParts[0]}/${functionNameParts[1]}/${functionNameParts[2]}.ts`);
199
+ break;
200
+ case 4:
201
+ imported = await import(`../../../${functionNameParts[0]}/${functionNameParts[1]}/${functionNameParts[2]}/${functionNameParts[3]}.ts`);
202
+ break;
203
+ case 5:
204
+ imported = await import(`../../../${functionNameParts[0]}/${functionNameParts[1]}/${functionNameParts[2]}/${functionNameParts[3]}/${functionNameParts[4]}.ts`);
205
+ break;
206
+ case 6:
207
+ imported = await import(`../../../${functionNameParts[0]}/${functionNameParts[1]}/${functionNameParts[2]}/${functionNameParts[3]}/${functionNameParts[4]}/${functionNameParts[5]}.ts`);
208
+ break;
209
+ default:
210
+ return err(new MaxLevelsExceededError(5));
211
+ }
212
+ if (!imported || !imported.default || !imported.default.constructor) {
213
+ return err(new InvalidApiError("API file path does not have a default export"));
214
+ }
215
+ if (imported.default.constructor.name === "AsyncGeneratorFunction") {
216
+ return ok({
217
+ type: "async-generator",
218
+ generator: imported.default,
219
+ });
220
+ }
221
+ if (imported.default.constructor.name === "AsyncFunction") {
222
+ return ok({
223
+ type: "async",
224
+ func: imported.default,
225
+ });
226
+ }
227
+ return err(new InvalidApiError("API file path does not have a default async function/generator export"));
228
+ }
229
+ catch (error) {
230
+ if (error.message.includes("Unknown variable dynamic import")) {
231
+ return err(new ApiNotFoundError(path));
232
+ }
233
+ if (error?.code === "ERR_MODULE_NOT_FOUND") {
234
+ console.log("API not found", error);
235
+ return err(new ApiNotFoundError(path));
236
+ }
237
+ throw error;
238
+ }
239
+ }