feat: bundle expect from @playwright/test library (#812)

* feat: bundle expect from pw/test library

* remove jest expect

* bundle expect library correctly

* fix build script

* fix lint

* add expect tests

* throw error for non supported assertions

* update

* test and improve err msg

---------

Co-authored-by: shahzad31 <[email protected]>

Author: vigneshshanmugam

__tests__/cli.test.ts

@@ -323,12 +323,27 @@ describe('CLI', () => {
     // flag turns on type checking
     process.env['TS_NODE_TYPE_CHECK'] = 'true';
     const cli = new CLIMock()
-      .args([join(FIXTURES_DIR, 'expect.journey.ts')])
+      .args([
+        join(FIXTURES_DIR, 'expect.journey.ts'),
+        '--match',
+        'expect extends',
+      ])
       .run();
     expect(await cli.exitCode).toBe(0);
     process.env['TS_NODE_TYPE_CHECK'] = 'false';
   });
 
+  it('error on unsupported expect assertions', async () => {
+    const cli = new CLIMock()
+      .args([
+        join(FIXTURES_DIR, 'expect.journey.ts'),
+        '--match',
+        'expect unsupported',
+      ])
+      .run();
+    expect(await cli.exitCode).toBe(1);
+  });
+
   describe('TLS site with self-signed cert', () => {
     let tlsServer: Server;
     let cliArgs: Array<string>;

__tests__/fixtures/expect.journey.ts

@@ -33,6 +33,16 @@ declare global {
   }
 }
 
+// Declare the global matcher in the PW namesapce to be used in tests
+// to satisfy the type checker and IDE
+declare global {
+  namespace PlaywrightTest {
+    interface Matchers<R> {
+      toBeWithinRange(a: number, b: number): R;
+    }
+  }
+}
+
 expect.extend({
   toBeWithinRange(received, floor, ceiling) {
     const pass = received >= floor && received <= ceiling;
@@ -52,7 +62,7 @@ expect.extend({
   },
 });
 
-journey('expect journey', ({}) => {
+journey('expect extends', ({ page }) => {
   step('exports work', () => {
     expect(100).toBe(100);
     expect([1, 2, 3]).toEqual(expect.arrayContaining([1, 2, 3]));
@@ -63,4 +73,15 @@ journey('expect journey', ({}) => {
     expect(100).toBeWithinRange(90, 120);
     expect(101).not.toBeWithinRange(0, 100);
   });
+
+  step('pw test methods work', async () => {
+    await expect(page).toHaveURL('about:blank');
+    await expect(page).toHaveTitle('', { timeout: 100 });
+  });
+});
+
+journey('expect unsupported', ({ page }) => {
+  step('throw unsupported', async () => {
+    await expect(page).toHaveScreenshot();
+  });
 });

bundles/build.js

@@ -0,0 +1,51 @@
+/**
+ * MIT License
+ *
+ * Copyright (c) 2020-present, Elastic NV
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ *
+ */
+
+/* eslint-disable @typescript-eslint/no-var-requires */
+const path = require('path');
+const esbuild = require('esbuild');
+const { ENTRY_POINTS } = require('./src');
+
+const outdir = path.join(__dirname, '..', 'dist', 'bundles');
+
+(async () => {
+  const ctx = await esbuild.context({
+    entryPoints: ENTRY_POINTS,
+    bundle: true,
+    external: ['playwright-core', '@playwright/test/lib/transform/esmLoader'],
+    outfile: path.join(outdir, 'lib', 'index.js'),
+    format: 'cjs',
+    platform: 'node',
+    target: `node${process.version.slice(1)}`,
+    minify: process.argv.includes('--minify'),
+    sourcemap: process.argv.includes('--sourcemap'),
+    sourcesContent: false,
+  });
+  await ctx.rebuild();
+  await ctx.dispose();
+})().catch(error => {
+  console.error(error);
+  process.exit(1);
+});

bundles/package-lock.json

@@ -0,0 +1,13 @@
+{
+  "name": "pkg-bundles",
+  "version": "0.0.0",
+  "private": true,
+  "description": "Package bundles that is required by Synthetics",
+  "scripts": {
+    "bundle": "node build.js",
+    "build": "npm run bundle -- --minify"
+  },
+  "dependencies": {
+    "@playwright/test": "=1.37.0"
+  }
+}

bundles/package.json

@@ -0,0 +1,31 @@
+/**
+ * MIT License
+ *
+ * Copyright (c) 2020-present, Elastic NV
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ *
+ */
+
+/* eslint-disable @typescript-eslint/no-var-requires */
+const path = require('path');
+
+module.exports.ENTRY_POINTS = [
+  path.resolve('node_modules/@playwright/test/lib/matchers/expect.js'),
+];