ScuttleBot

scuttlebot / tests / e2e / node_modules / playwright / lib / common / fixtures.js
Blame History Raw 303 lines
1
"use strict";
2
var __create = Object.create;
3
var __defProp = Object.defineProperty;
4
var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
5
var __getOwnPropNames = Object.getOwnPropertyNames;
6
var __getProtoOf = Object.getPrototypeOf;
7
var __hasOwnProp = Object.prototype.hasOwnProperty;
8
var __export = (target, all) => {
9
for (var name in all)
10
__defProp(target, name, { get: all[name], enumerable: true });
11
};
12
var __copyProps = (to, from, except, desc) => {
13
if (from && typeof from === "object" || typeof from === "function") {
14
for (let key of __getOwnPropNames(from))
15
if (!__hasOwnProp.call(to, key) && key !== except)
16
__defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
17
}
18
return to;
19
};
20
var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
21
// If the importer is in node compatibility mode or this is not an ESM
22
// file that has been converted to a CommonJS file using a Babel-
23
// compatible transform (i.e. "__esModule" has not been set), then set
24
// "default" to the CommonJS "module.exports" for node compatibility.
25
isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
26
mod
27
));
28
var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
29
var fixtures_exports = {};
30
__export(fixtures_exports, {
31
FixturePool: () => FixturePool,
32
fixtureParameterNames: () => fixtureParameterNames,
33
formatPotentiallyInternalLocation: () => formatPotentiallyInternalLocation,
34
inheritFixtureNames: () => inheritFixtureNames
35
});
36
module.exports = __toCommonJS(fixtures_exports);
37
var import_crypto = __toESM(require("crypto"));
38
var import_util = require("../util");
39
const kScopeOrder = ["test", "worker"];
40
function isFixtureTuple(value) {
41
return Array.isArray(value) && typeof value[1] === "object";
42
}
43
function isFixtureOption(value) {
44
return isFixtureTuple(value) && !!value[1].option;
45
}
46
class FixturePool {
47
constructor(fixturesList, onLoadError, parentPool, disallowWorkerFixtures, optionOverrides) {
48
this._registrations = new Map(parentPool ? parentPool._registrations : []);
49
this._onLoadError = onLoadError;
50
const allOverrides = optionOverrides?.overrides ?? {};
51
const overrideKeys = new Set(Object.keys(allOverrides));
52
for (const list of fixturesList) {
53
this._appendFixtureList(list, !!disallowWorkerFixtures, false);
54
const selectedOverrides = {};
55
for (const [key, value] of Object.entries(list.fixtures)) {
56
if (isFixtureOption(value) && overrideKeys.has(key))
57
selectedOverrides[key] = [allOverrides[key], value[1]];
58
}
59
if (Object.entries(selectedOverrides).length)
60
this._appendFixtureList({ fixtures: selectedOverrides, location: optionOverrides.location }, !!disallowWorkerFixtures, true);
61
}
62
this.digest = this.validate();
63
}
64
_appendFixtureList(list, disallowWorkerFixtures, isOptionsOverride) {
65
const { fixtures, location } = list;
66
for (const entry of Object.entries(fixtures)) {
67
const name = entry[0];
68
let value = entry[1];
69
let options;
70
if (isFixtureTuple(value)) {
71
options = {
72
auto: value[1].auto ?? false,
73
scope: value[1].scope || "test",
74
option: !!value[1].option,
75
timeout: value[1].timeout,
76
customTitle: value[1].title,
77
box: value[1].box
78
};
79
value = value[0];
80
}
81
let fn = value;
82
const previous = this._registrations.get(name);
83
if (previous && options) {
84
if (previous.scope !== options.scope) {
85
this._addLoadError(`Fixture "${name}" has already been registered as a { scope: '${previous.scope}' } fixture defined in ${(0, import_util.formatLocation)(previous.location)}.`, location);
86
continue;
87
}
88
if (previous.auto !== options.auto) {
89
this._addLoadError(`Fixture "${name}" has already been registered as a { auto: '${previous.scope}' } fixture defined in ${(0, import_util.formatLocation)(previous.location)}.`, location);
90
continue;
91
}
92
} else if (previous) {
93
options = { auto: previous.auto, scope: previous.scope, option: previous.option, timeout: previous.timeout, customTitle: previous.customTitle };
94
} else if (!options) {
95
options = { auto: false, scope: "test", option: false, timeout: void 0 };
96
}
97
if (!kScopeOrder.includes(options.scope)) {
98
this._addLoadError(`Fixture "${name}" has unknown { scope: '${options.scope}' }.`, location);
99
continue;
100
}
101
if (options.scope === "worker" && disallowWorkerFixtures) {
102
this._addLoadError(`Cannot use({ ${name} }) in a describe group, because it forces a new worker.
103
Make it top-level in the test file or put in the configuration file.`, location);
104
continue;
105
}
106
if (fn === void 0 && options.option && previous) {
107
let original = previous;
108
while (!original.optionOverride && original.super)
109
original = original.super;
110
fn = original.fn;
111
}
112
const deps = fixtureParameterNames(fn, location, (e) => this._onLoadError(e));
113
const registration = { id: "", name, location, scope: options.scope, fn, auto: options.auto, option: options.option, timeout: options.timeout, customTitle: options.customTitle, box: options.box, deps, super: previous, optionOverride: isOptionsOverride };
114
registrationId(registration);
115
this._registrations.set(name, registration);
116
}
117
}
118
validate() {
119
const markers = /* @__PURE__ */ new Map();
120
const stack = [];
121
let hasDependencyErrors = false;
122
const addDependencyError = (message, location) => {
123
hasDependencyErrors = true;
124
this._addLoadError(message, location);
125
};
126
const visit = (registration, boxedOnly) => {
127
markers.set(registration, "visiting");
128
stack.push(registration);
129
for (const name of registration.deps) {
130
const dep = this.resolve(name, registration);
131
if (!dep) {
132
if (name === registration.name)
133
addDependencyError(`Fixture "${registration.name}" references itself, but does not have a base implementation.`, registration.location);
134
else
135
addDependencyError(`Fixture "${registration.name}" has unknown parameter "${name}".`, registration.location);
136
continue;
137
}
138
if (kScopeOrder.indexOf(registration.scope) > kScopeOrder.indexOf(dep.scope)) {
139
addDependencyError(`${registration.scope} fixture "${registration.name}" cannot depend on a ${dep.scope} fixture "${name}" defined in ${formatPotentiallyInternalLocation(dep.location)}.`, registration.location);
140
continue;
141
}
142
if (!markers.has(dep)) {
143
visit(dep, boxedOnly);
144
} else if (markers.get(dep) === "visiting") {
145
const index = stack.indexOf(dep);
146
const allRegs = stack.slice(index, stack.length);
147
const filteredRegs = allRegs.filter((r) => !r.box);
148
const regs = boxedOnly ? filteredRegs : allRegs;
149
const names2 = regs.map((r) => `"${r.name}"`);
150
addDependencyError(`Fixtures ${names2.join(" -> ")} -> "${dep.name}" form a dependency cycle: ${regs.map((r) => formatPotentiallyInternalLocation(r.location)).join(" -> ")} -> ${formatPotentiallyInternalLocation(dep.location)}`, dep.location);
151
continue;
152
}
153
}
154
markers.set(registration, "visited");
155
stack.pop();
156
};
157
const names = Array.from(this._registrations.keys()).sort();
158
for (const name of names) {
159
const registration = this._registrations.get(name);
160
if (!registration.box)
161
visit(registration, true);
162
}
163
if (!hasDependencyErrors) {
164
for (const name of names) {
165
const registration = this._registrations.get(name);
166
if (registration.box)
167
visit(registration, false);
168
}
169
}
170
const hash = import_crypto.default.createHash("sha1");
171
for (const name of names) {
172
const registration = this._registrations.get(name);
173
if (registration.scope === "worker")
174
hash.update(registration.id + ";");
175
}
176
return hash.digest("hex");
177
}
178
validateFunction(fn, prefix, location) {
179
for (const name of fixtureParameterNames(fn, location, (e) => this._onLoadError(e))) {
180
const registration = this._registrations.get(name);
181
if (!registration)
182
this._addLoadError(`${prefix} has unknown parameter "${name}".`, location);
183
}
184
}
185
resolve(name, forFixture) {
186
if (name === forFixture?.name)
187
return forFixture.super;
188
return this._registrations.get(name);
189
}
190
autoFixtures() {
191
return [...this._registrations.values()].filter((r) => r.auto !== false);
192
}
193
_addLoadError(message, location) {
194
this._onLoadError({ message, location });
195
}
196
}
197
const signatureSymbol = Symbol("signature");
198
function formatPotentiallyInternalLocation(location) {
199
const isUserFixture = location && (0, import_util.filterStackFile)(location.file);
200
return isUserFixture ? (0, import_util.formatLocation)(location) : "<builtin>";
201
}
202
function fixtureParameterNames(fn, location, onError) {
203
if (typeof fn !== "function")
204
return [];
205
if (!fn[signatureSymbol])
206
fn[signatureSymbol] = innerFixtureParameterNames(fn, location, onError);
207
return fn[signatureSymbol];
208
}
209
function inheritFixtureNames(from, to) {
210
to[signatureSymbol] = from[signatureSymbol];
211
}
212
function innerFixtureParameterNames(fn, location, onError) {
213
const text = filterOutComments(fn.toString());
214
const match = text.match(/(?:async)?(?:\s+function)?[^(]*\(([^)]*)/);
215
if (!match)
216
return [];
217
const trimmedParams = match[1].trim();
218
if (!trimmedParams)
219
return [];
220
const [firstParam] = splitByComma(trimmedParams);
221
if (firstParam[0] !== "{" || firstParam[firstParam.length - 1] !== "}") {
222
onError({ message: "First argument must use the object destructuring pattern: " + firstParam, location });
223
return [];
224
}
225
const props = splitByComma(firstParam.substring(1, firstParam.length - 1)).map((prop) => {
226
const colon = prop.indexOf(":");
227
return colon === -1 ? prop.trim() : prop.substring(0, colon).trim();
228
});
229
const restProperty = props.find((prop) => prop.startsWith("..."));
230
if (restProperty) {
231
onError({ message: `Rest property "${restProperty}" is not supported. List all used fixtures explicitly, separated by comma.`, location });
232
return [];
233
}
234
return props;
235
}
236
function filterOutComments(s) {
237
const result = [];
238
let commentState = "none";
239
for (let i = 0; i < s.length; ++i) {
240
if (commentState === "singleline") {
241
if (s[i] === "\n")
242
commentState = "none";
243
} else if (commentState === "multiline") {
244
if (s[i - 1] === "*" && s[i] === "/")
245
commentState = "none";
246
} else if (commentState === "none") {
247
if (s[i] === "/" && s[i + 1] === "/") {
248
commentState = "singleline";
249
} else if (s[i] === "/" && s[i + 1] === "*") {
250
commentState = "multiline";
251
i += 2;
252
} else {
253
result.push(s[i]);
254
}
255
}
256
}
257
return result.join("");
258
}
259
function splitByComma(s) {
260
const result = [];
261
const stack = [];
262
let start = 0;
263
for (let i = 0; i < s.length; i++) {
264
if (s[i] === "{" || s[i] === "[") {
265
stack.push(s[i] === "{" ? "}" : "]");
266
} else if (s[i] === stack[stack.length - 1]) {
267
stack.pop();
268
} else if (!stack.length && s[i] === ",") {
269
const token = s.substring(start, i).trim();
270
if (token)
271
result.push(token);
272
start = i + 1;
273
}
274
}
275
const lastToken = s.substring(start).trim();
276
if (lastToken)
277
result.push(lastToken);
278
return result;
279
}
280
const registrationIdMap = /* @__PURE__ */ new Map();
281
let lastId = 0;
282
function registrationId(registration) {
283
if (registration.id)
284
return registration.id;
285
const key = registration.name + "@@@" + (registration.super ? registrationId(registration.super) : "");
286
let map = registrationIdMap.get(key);
287
if (!map) {
288
map = /* @__PURE__ */ new Map();
289
registrationIdMap.set(key, map);
290
}
291
if (!map.has(registration.fn))
292
map.set(registration.fn, String(lastId++));
293
registration.id = map.get(registration.fn);
294
return registration.id;
295
}
296
// Annotate the CommonJS export names for ESM import in node:
297
0 && (module.exports = {
298
FixturePool,
299
fixtureParameterNames,
300
formatPotentiallyInternalLocation,
301
inheritFixtureNames
302
});
303

Keyboard Shortcuts

Open search /
Next entry (timeline) j
Previous entry (timeline) k
Open focused entry Enter
Show this help ?
Toggle theme Top nav button