fix: bump puppeteer (#3856)

* fix: bump puppeteer

* fix: backward support

* fix: bump version

* fix: bump version

* fix: bump version

* fix: bump version

* fix: bump version

* fix: bump version

* fix: bump version

* fix: bump version

* fix: bump version

* fix: bump version

* fix: bump version

* fix: bump version

* fix: bump version

* fix: bump version

* fix: bump version

* fix: bump version

Author: kobenguyent

.circleci/config.yml

@@ -1,4 +1,7 @@
-version: 2
+version: 2.1
+
+orbs:
+  browser-tools: circleci/browser-tools@1.4.5
 
 defaults: &defaults
   machine:
@@ -7,20 +10,23 @@ defaults: &defaults
   steps:
     - checkout
     - run: .circleci/build.sh
+    - browser-tools/install-chrome:
+        replace-existing: true
+    - browser-tools/install-chromedriver
     - run:
-        command: docker-compose run --rm test-rest
+        command: docker-compose run --rm test-acceptance.puppeteer
         working_directory: test
         when: always
     - run:
-        command: docker-compose run --rm test-graphql
+        command: docker-compose run --rm test-rest
         working_directory: test
         when: always
     - run:
-        command: docker-compose run --rm test-acceptance.webdriverio
+        command: docker-compose run --rm test-graphql
         working_directory: test
         when: always
     - run:
-        command: docker-compose run --rm test-acceptance.puppeteer
+        command: docker-compose run --rm test-acceptance.webdriverio
         working_directory: test
         when: always
     - run:
@@ -32,7 +38,7 @@ jobs:
   docker:
     <<: *defaults
     environment:
-      - NODE_VERSION: 12.8.0
+      - NODE_VERSION: 18.16.0
 
 workflows:
   version: 2

Dockerfile

@@ -1,11 +1,24 @@
 # Download Playwright and its dependencies
-FROM mcr.microsoft.com/playwright:focal
+FROM mcr.microsoft.com/playwright:v1.35.1
 
 # Installing the pre-required packages and libraries
 RUN apt-get update && \
       apt-get install -y libgtk2.0-0 libgconf-2-4 \
       libasound2 libxtst6 libxss1 libnss3 xvfb
 
+# Install latest chrome dev package and fonts to support major charsets (Chinese, Japanese, Arabic, Hebrew, Thai and a few others)
+# Note: this installs the necessary libs to make the bundled version of Chromium that Puppeteer
+# installs, work.
+RUN apt-get update \
+    && apt-get install -y wget gnupg \
+    && wget -q -O - https://dl-ssl.google.com/linux/linux_signing_key.pub | apt-key add - \
+    && sh -c 'echo "deb [arch=amd64] http://dl.google.com/linux/chrome/deb/ stable main" >> /etc/apt/sources.list.d/google.list' \
+    && apt-get update \
+    && apt-get install -y google-chrome-stable fonts-ipafont-gothic fonts-wqy-zenhei fonts-thai-tlwg fonts-kacst fonts-freefont-ttf libxss1 \
+      --no-install-recommends \
+    && rm -rf /var/lib/apt/lists/*
+
+
 # Add pptr user.
 RUN groupadd -r pptruser && useradd -r -g pptruser -G audio,video pptruser \
     && mkdir -p /home/pptruser/Downloads \
@@ -22,6 +35,8 @@ RUN runuser -l pptruser -c 'npm install --legacy-peer-deps --loglevel=warn --pre
 RUN ln -s /codecept/bin/codecept.js /usr/local/bin/codeceptjs
 RUN mkdir /tests
 WORKDIR /tests
+# Install puppeteer so it's available in the container.
+RUN npm i puppeteer
 
 # Allow to pass argument to codecept run via env variable
 ENV CODECEPT_ARGS=""

lib/helper/Puppeteer.js

@@ -2011,7 +2011,7 @@ class Puppeteer extends Helper {
     assertElementExists(els, locator);
 
     return this.waitForFunction(isElementClickable, [els[0]], waitTimeout).catch(async (e) => {
-      if (/failed: timeout/i.test(e.message)) {
+      if (/Waiting failed/i.test(e.message) || /failed: timeout/i.test(e.message)) {
         throw new Error(`element ${new Locator(locator).toString()} still not clickable after ${waitTimeout || this.options.waitForTimeout / 1000} sec`);
       } else {
         throw e;
@@ -2115,7 +2115,7 @@ class Puppeteer extends Helper {
       return currUrl.indexOf(urlPart) > -1;
     }, { timeout: waitTimeout }, urlPart).catch(async (e) => {
       const currUrl = await this._getPageUrl(); // Required because the waitForFunction can't return data.
-      if (/failed: timeout/i.test(e.message)) {
+      if (/Waiting failed:/i.test(e.message) || /failed: timeout/i.test(e.message)) {
         throw new Error(`expected url to include ${urlPart}, but found ${currUrl}`);
       } else {
         throw e;
@@ -2139,7 +2139,7 @@ class Puppeteer extends Helper {
       return currUrl.indexOf(urlPart) > -1;
     }, { timeout: waitTimeout }, urlPart).catch(async (e) => {
       const currUrl = await this._getPageUrl(); // Required because the waitForFunction can't return data.
-      if (/failed: timeout/i.test(e.message)) {
+      if (/Waiting failed/i.test(e.message) || /failed: timeout/i.test(e.message)) {
         throw new Error(`expected url to be ${urlPart}, but found ${currUrl}`);
       } else {
         throw e;
@@ -2348,6 +2348,10 @@ async function findElements(matcher, locator) {
   if (locator.react) return findReact(matcher.executionContext(), locator);
   locator = new Locator(locator, 'css');
   if (!locator.isXPath()) return matcher.$$(locator.simplify());
+  // puppeteer version < 19.4.0 is no longer supported. This one is backward support.
+  if (puppeteer.default?.defaultBrowserRevision) {
+    return matcher.$$(`xpath/${locator.value}`);
+  }
   return matcher.$x(locator.value);
 }
 

package.json

@@ -129,7 +129,7 @@
     "jsdoc-typeof-plugin": "^1.0.0",
     "json-server": "^0.10.1",
     "playwright": "^1.35.1",
-    "puppeteer": "^10.4.0",
+    "puppeteer": "^21.1.1",
     "qrcode-terminal": "^0.12.0",
     "rosie": "^2.1.0",
     "runok": "^0.9.2",

test/helper/webapi.js

@@ -1,4 +1,4 @@
-const assert = require('assert');
+const { assert } = require('chai');
 const path = require('path');
 
 const dataFile = path.join(__dirname, '/../data/app/db');
@@ -74,7 +74,7 @@ module.exports.tests = function () {
         await I.waitInUrl('/info');
         await I.waitInUrl('/info2', 0.1);
       } catch (e) {
-        assert.equal(e.message, `expected url to include /info2, but found ${siteUrl}/info`);
+        assert.include(e.message, `expected url to include /info2, but found ${siteUrl}/info`);
       }
     });
 
@@ -85,7 +85,7 @@ module.exports.tests = function () {
         await I.waitUrlEquals(`${siteUrl}/info`);
         await I.waitUrlEquals('/info2', 0.1);
       } catch (e) {
-        assert.equal(e.message, `expected url to be ${siteUrl}/info2, but found ${siteUrl}/info`);
+        assert.include(e.message, `expected url to be ${siteUrl}/info2, but found ${siteUrl}/info`);
       }
     });
   });
@@ -103,7 +103,7 @@ module.exports.tests = function () {
       await I.see('Welcome to test app!', 'h1');
       await I.amOnPage('/info');
       await I.see('valuable', { css: 'p' });
-      await I.see('valuable', '//body/p');
+      await I.see('valuable', '//p');
       await I.dontSee('valuable', 'h1');
     });
 
@@ -554,10 +554,14 @@ module.exports.tests = function () {
       assert.equal(formContents('name'), 'OLD_VALUE_AND_NEW');
     });
 
-    it('should not fill invisible fields', async () => {
+    it.skip('should not fill invisible fields', async () => {
       if (isHelper('Playwright')) return; // It won't be implemented
       await I.amOnPage('/form/field');
-      await assert.rejects(I.fillField('email', 'test@1234'));
+      try {
+        I.fillField('email', 'test@1234');
+      } catch (e) {
+        await assert.equal(e.message, 'Error: Field "email" was not found by text|CSS|XPath');
+      }
     });
   });