1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
|
{
lib,
buildNpmPackage,
stdenv,
chromium,
ffmpeg,
jq,
nodejs,
fetchFromGitHub,
linkFarm,
callPackage,
makeFontsConf,
makeWrapper,
cacert,
}:
let
inherit (stdenv.hostPlatform) system;
throwSystem = throw "Unsupported system: ${system}";
browsersJSON = (lib.importJSON ./browsers.json).browsers;
version = "1.59.1";
src = fetchFromGitHub {
owner = "Microsoft";
repo = "playwright";
rev = "v${version}";
hash = "sha256-kiH1jDyt5xMWc5C2dytoDC9fi1b5tWXZG8S6KEpuotM=";
};
babel-bundle = buildNpmPackage {
pname = "babel-bundle";
inherit version src;
sourceRoot = "${src.name}/packages/playwright/bundles/babel";
npmDepsHash = "sha256-ByCy4go8PM0ksDg+2DcJPyoKG7Z0uIqKM647ZQwYwAE=";
dontNpmBuild = true;
installPhase = ''
cp -r . "$out"
'';
};
expect-bundle = buildNpmPackage {
pname = "expect-bundle";
inherit version src;
sourceRoot = "${src.name}/packages/playwright/bundles/expect";
npmDepsHash = "sha256-PbPCsMqRkfU2c/mCsLSagew84XTgeO6H5+isNZQl2ek=";
dontNpmBuild = true;
installPhase = ''
cp -r . "$out"
'';
};
utils-bundle = buildNpmPackage {
pname = "utils-bundle";
inherit version src;
sourceRoot = "${src.name}/packages/playwright/bundles/utils";
npmDepsHash = "sha256-BTaF1atpK+kG++ZJBUK4r3A7mbN2vv3xpDmb1NiNngE=";
dontNpmBuild = true;
installPhase = ''
cp -r . "$out"
'';
};
utils-bundle-core = buildNpmPackage {
pname = "utils-bundle-core";
inherit version src;
sourceRoot = "${src.name}/packages/playwright-core/bundles/utils";
npmDepsHash = "sha256-O8X80rTT10ht97towSocANnGwH4fH1f3nZMSl8TOc+Y=";
dontNpmBuild = true;
installPhase = ''
cp -r . "$out"
'';
};
zip-bundle = buildNpmPackage {
pname = "zip-bundle";
inherit version src;
sourceRoot = "${src.name}/packages/playwright-core/bundles/zip";
npmDepsHash = "sha256-5BHgCelIPh8ljIcdrO4AHafjqfLowDwJcpN+mD13Syw=";
dontNpmBuild = true;
installPhase = ''
cp -r . "$out"
'';
};
playwright = buildNpmPackage {
pname = "playwright";
inherit version src;
sourceRoot = "${src.name}"; # update.sh depends on sourceRoot presence
npmDepsHash = "sha256-H3kKFthmZH4fqFPQA34w7iw2rubpEKLlJ9jaW6mpuyo=";
nativeBuildInputs = [
cacert
jq
];
ELECTRON_SKIP_BINARY_DOWNLOAD = true;
postPatch = ''
sed -i '/\/\/ Update test runner./,/^\s*$/{d}' utils/build/build.js
sed -i '/^\/\/ Update bundles\./,/^[[:space:]]*}$/d' utils/build/build.js
sed -i '/execSync/d' ./utils/generate_third_party_notice.js
# The dlopen library check uses ldconfig which doesn't work under Nix.
# These libraries are already provided via rpath by autoPatchelfHook and wrapProgram.
substituteInPlace packages/playwright-core/src/server/registry/index.ts \
--replace-fail "['libGLESv2.so.2', 'libx264.so']" "[]"
chmod +w packages/playwright/bundles/babel
ln -s ${babel-bundle}/node_modules packages/playwright/bundles/babel/node_modules
chmod +w packages/playwright/bundles/expect
ln -s ${expect-bundle}/node_modules packages/playwright/bundles/expect/node_modules
chmod +w packages/playwright/bundles/utils
ln -s ${utils-bundle}/node_modules packages/playwright/bundles/utils/node_modules
chmod +w packages/playwright-core/bundles/utils
ln -s ${utils-bundle-core}/node_modules packages/playwright-core/bundles/utils/node_modules
chmod +w packages/playwright-core/bundles/zip
ln -s ${zip-bundle}/node_modules packages/playwright-core/bundles/zip/node_modules
'';
installPhase = ''
runHook preInstall
shopt -s extglob
mkdir -p "$out/lib/node_modules/playwright"
cp -r packages/playwright/!(bundles|src|node_modules|.*) "$out/lib/node_modules/playwright"
# for not supported platforms (such as NixOS) playwright assumes that it runs on ubuntu-20.04
# that forces it to use overridden webkit revision
# let's remove that override to make it use latest revision provided in Nixpkgs
# https://github.com/microsoft/playwright/blob/baeb065e9ea84502f347129a0b896a85d2a8dada/packages/playwright-core/src/server/utils/hostPlatform.ts#L111
jq '(.browsers[] | select(.name == "webkit") | .revisionOverrides) |= del(."ubuntu20.04-x64", ."ubuntu20.04-arm64")' \
packages/playwright-core/browsers.json > browser.json.tmp && mv browser.json.tmp packages/playwright-core/browsers.json
mkdir -p "$out/lib/node_modules/playwright-core"
cp -r packages/playwright-core/!(bundles|src|bin|.*) "$out/lib/node_modules/playwright-core"
mkdir -p "$out/lib/node_modules/@playwright/test"
cp -r packages/playwright-test/* "$out/lib/node_modules/@playwright/test"
runHook postInstall
'';
meta = {
description = "Framework for Web Testing and Automation";
homepage = "https://playwright.dev";
license = lib.licenses.asl20;
maintainers = with lib.maintainers; [
kalekseev
];
inherit (nodejs.meta) platforms;
};
};
playwright-core = stdenv.mkDerivation (finalAttrs: {
pname = "playwright-core";
inherit (playwright) version src meta;
installPhase = ''
runHook preInstall
cp -r ${playwright}/lib/node_modules/playwright-core "$out"
runHook postInstall
'';
passthru = {
inherit browsersJSON;
selectBrowsers = browsers;
browsers = browsers { };
browsers-chromium = browsers {
withFirefox = false;
withWebkit = false;
withChromiumHeadlessShell = false;
};
tests.browser-downloads = callPackage ./browser-downloads-test.nix {
playwright-core = finalAttrs.finalPackage;
};
inherit components;
updateScript = ./update.sh;
};
});
playwright-test = stdenv.mkDerivation (finalAttrs: {
pname = "playwright-test";
inherit (playwright) version src;
nativeBuildInputs = [ makeWrapper ];
installPhase = ''
runHook preInstall
shopt -s extglob
mkdir -p $out/bin
cp -r ${playwright}/* $out
makeWrapper "${nodejs}/bin/node" "$out/bin/playwright" \
--add-flags "$out/lib/node_modules/@playwright/test/cli.js" \
--prefix NODE_PATH : ${placeholder "out"}/lib/node_modules \
--set-default PLAYWRIGHT_BROWSERS_PATH "${playwright-core.passthru.browsers}"
runHook postInstall
'';
meta = playwright.meta // {
mainProgram = "playwright";
};
});
components = {
chromium = callPackage ./chromium.nix {
inherit system throwSystem;
inherit (browsersJSON.chromium) revision browserVersion;
fontconfig_file = makeFontsConf {
fontDirectories = [ ];
};
};
chromium-headless-shell = callPackage ./chromium-headless-shell.nix {
inherit system throwSystem;
inherit (browsersJSON."chromium-headless-shell") revision browserVersion;
};
firefox = callPackage ./firefox.nix {
inherit system throwSystem;
inherit (browsersJSON.firefox) revision;
};
webkit = callPackage ./webkit.nix {
inherit system throwSystem;
inherit (browsersJSON.webkit) revision;
};
ffmpeg = callPackage ./ffmpeg.nix {
inherit system throwSystem;
inherit (browsersJSON.ffmpeg) revision;
};
};
browsers = lib.makeOverridable (
{
withChromium ? true,
withFirefox ? true,
withWebkit ? true, # may require `export PLAYWRIGHT_HOST_PLATFORM_OVERRIDE="ubuntu-24.04"`
withFfmpeg ? true,
withChromiumHeadlessShell ? true,
fontconfig_file ? makeFontsConf {
fontDirectories = [ ];
},
}:
let
browsers =
lib.optionals withChromium [ "chromium" ]
++ lib.optionals withChromiumHeadlessShell [ "chromium-headless-shell" ]
++ lib.optionals withFirefox [ "firefox" ]
++ lib.optionals withWebkit [ "webkit" ]
++ lib.optionals withFfmpeg [ "ffmpeg" ];
in
linkFarm "playwright-browsers" (
lib.listToAttrs (
map (
name:
let
value = browsersJSON.${name};
in
lib.nameValuePair
# TODO check platform for revisionOverrides
"${lib.replaceStrings [ "-" ] [ "_" ] name}-${value.revision}"
components.${name}
) browsers
)
)
);
in
{
playwright-core = playwright-core;
playwright-test = playwright-test;
}
|
