fix(addInitScript): tolerate trailing comments (#13275)

pavelfeldman · web-flow · commit b0103566c980 · 2022-04-03T18:47:12.000-07:00
diff --git a/packages/playwright-core/src/client/clientHelper.ts b/packages/playwright-core/src/client/clientHelper.ts
@@ -43,7 +43,7 @@ export async function evaluationScript(fun: Function | string | { path?: string,
   if (fun.path !== undefined) {
     let source = await fs.promises.readFile(fun.path, 'utf8');
     if (addSourceUrl)
-      source += '//# sourceURL=' + fun.path.replace(/\n/g, '');
+      source += '\n//# sourceURL=' + fun.path.replace(/\n/g, '');
     return source;
   }
   throw new Error('Either path or content property must be present');
diff --git a/packages/playwright-core/src/server/webkit/wkPage.ts b/packages/playwright-core/src/server/webkit/wkPage.ts
@@ -777,7 +777,7 @@ export class WKPage implements PageDelegate {
       scripts.push(this._bindingToScript(binding));
     scripts.push(...this._browserContext.initScripts);
     scripts.push(...this._page.initScripts);
-    return scripts.join(';');
+    return scripts.join(';\n');
   }
 
   async _updateBootstrapScript(): Promise<void> {
diff --git a/tests/page/page-add-init-script.spec.ts b/tests/page/page-add-init-script.spec.ts
@@ -43,6 +43,13 @@ it('should throw without path and content', async ({ page }) => {
   expect(error.message).toContain('Either path or content property must be present');
 });
 
+it('should work with trailing comments', async ({ page, asset }) => {
+  await page.addInitScript({ content: '// comment' });
+  await page.addInitScript({ content: 'window.secret = 42;' });
+  await page.goto('data:text/html,<html></html>');
+  expect(await page.evaluate('secret')).toBe(42);
+});
+
 it('should support multiple scripts', async ({ page, server }) => {
   await page.addInitScript(function() {
     window['script1'] = 1;

Original file line number	Diff line number	Diff line change
`@@ -43,7 +43,7 @@ export async function evaluationScript(fun: Function \| string \| { path?: string,`
`43`	`43`	`if (fun.path !== undefined) {`
`44`	`44`	`let source = await fs.promises.readFile(fun.path, 'utf8');`
`45`	`45`	`if (addSourceUrl)`
`46`		`- source += '//# sourceURL=' + fun.path.replace(/\n/g, '');`
	`46`	`+ source += '\n//# sourceURL=' + fun.path.replace(/\n/g, '');`
`47`	`47`	`return source;`
`48`	`48`	`}`
`49`	`49`	`throw new Error('Either path or content property must be present');`
Original file line number	Diff line number	Diff line change
`@@ -777,7 +777,7 @@ export class WKPage implements PageDelegate {`
`777`	`777`	`scripts.push(this._bindingToScript(binding));`
`778`	`778`	`scripts.push(...this._browserContext.initScripts);`
`779`	`779`	`scripts.push(...this._page.initScripts);`
`780`		`- return scripts.join(';');`
	`780`	`+ return scripts.join(';\n');`
`781`	`781`	`}`
`782`	`782`
`783`	`783`	`async _updateBootstrapScript(): Promise<void> {`