Merge pull request #78 from viqueen/issue/upgrade-deps-wdio

[noissue] fix up the visual regression tests
viqueen · Feb 3, 2024 · f3752e3 · f3752e3
2 parents 61441d2 + 37fed8d
commit f3752e3
Show file tree

Hide file tree

Showing 18 changed files with 2,194 additions and 1,324 deletions.
diff --git a/.github/workflows/build-and-test.yml b/.github/workflows/build-and-test.yml
@@ -12,7 +12,7 @@ jobs:
       - uses: actions/checkout@v3
       - uses: actions/setup-node@v3
         with:
-          node-version: 18
+          node-version: 20
           cache: "yarn"
       - run: yarn
       - run: yarn build

diff --git a/.github/workflows/create-release.yml b/.github/workflows/create-release.yml
@@ -11,7 +11,7 @@ jobs:
       - uses: actions/checkout@v3
       - uses: actions/setup-node@v3
         with:
-          node-version: 18
+          node-version: 20
           registry-url: https://registry.npmjs.org/
           cache: "yarn"
       - run: yarn

diff --git a/.nvmrc b/.nvmrc
@@ -1 +1 @@
-18
+20
diff --git a/.prettierrc.js b/.prettierrc.js
@@ -23,5 +23,11 @@ module.exports = {
                 trailingComma: 'none',
             },
         },
+        {
+            files: '*.json',
+            options: {
+                trailingComma: 'none',
+            },
+        },
     ],
 };
diff --git a/local/templates/public/index.html b/local/templates/public/index.html
@@ -1,4 +1,4 @@
-<!DOCTYPE html>
+<!doctype html>
 <html lang="en">
   <head>
     <meta charset="UTF-8" />

diff --git a/modules/cli/commands/extract/extract-space.ts b/modules/cli/commands/extract/extract-space.ts
@@ -55,12 +55,18 @@ export const extractSpace = async (
             title: identifier.title,
             createdYear
         }))
-        .reduce((prev, current) => {
-            const byYear = prev[current.createdYear] || [];
-            byYear.push(current);
-            prev[current.createdYear] = byYear;
-            return prev;
-        }, {} as Record<number, { href: string; title: string; createdYear: number }[]>);
+        .reduce(
+            (prev, current) => {
+                const byYear = prev[current.createdYear] || [];
+                byYear.push(current);
+                prev[current.createdYear] = byYear;
+                return prev;
+            },
+            {} as Record<
+                number,
+                { href: string; title: string; createdYear: number }[]
+            >
+        );
 
     const navigation = {
         notes,

diff --git a/modules/external/confluence-api/adf-processor.ts b/modules/external/confluence-api/adf-processor.ts
@@ -1,3 +1,4 @@
+/* eslint-disable */
 /**
  * Copyright 2023 Hasnae Rehioui
  *

diff --git a/modules/external/confluence-api/index.ts b/modules/external/confluence-api/index.ts
@@ -1,3 +1,4 @@
+/* eslint-disable */
 /**
  * Copyright 2023 Hasnae Rehioui
  *

diff --git a/modules/external/confluence-api/types.ts b/modules/external/confluence-api/types.ts
@@ -1,3 +1,4 @@
+/* eslint-disable */
 /**
  * Copyright 2023 Hasnae Rehioui
  *

diff --git a/modules/site/content/extension-handlers/confluence-macro-core/blog-posts-macro.tsx b/modules/site/content/extension-handlers/confluence-macro-core/blog-posts-macro.tsx
@@ -34,7 +34,7 @@ const unescapeExcerpt = (excerpt: string) => {
                 '&amp;': '&',
                 '&#39;': "'",
                 '&quot;': '"'
-            }[element] || element)
+            })[element] || element
     );
 };
 
@@ -92,6 +92,7 @@ const BlogPostItem = ({ content }: { content: Content }) => {
 
 export const BlogPostsMacro = () => {
     const [loading, setLoading] = useState(true);
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
     const [articles, setArticles]: any = useState({});
 
     useEffect(() => {

diff --git a/modules/site/content/media-viewer-provider/index.tsx b/modules/site/content/media-viewer-provider/index.tsx
@@ -2,6 +2,7 @@
 import React, { useCallback, useState } from 'react';
 
 import noop from 'lodash/noop';
+// eslint-disable-next-line import/no-named-as-default
 import Lightbox from 'yet-another-react-lightbox';
 import Fullscreen from 'yet-another-react-lightbox/plugins/fullscreen';
 import Zoom from 'yet-another-react-lightbox/plugins/zoom';

diff --git a/package.json b/package.json
@@ -12,7 +12,7 @@
     "lint": "eslint modules/ --ext .ts,.tsx,.js",
     "format:check": "prettier --check .",
     "format": "prettier --check --write .",
-    "wdio": "wdio run wdio.conf.ts"
+    "wdio": "TS_NODE_PROJECT=test/tsconfig.json wdio run wdio.conf.ts"
   },
   "repository": {
     "type": "git",
@@ -34,25 +34,24 @@
   },
   "homepage": "https://github.com/viqueen/confluence-static-site#readme",
   "devDependencies": {
-    "@types/lodash": "^4.14.194",
-    "@types/prompt": "^1.1.5",
+    "@types/lodash": "^4.14.202",
+    "@types/prompt": "^1.1.8",
     "@types/react": "^18.0.28",
     "@types/react-dom": "^18.0.11",
-    "@typescript-eslint/eslint-plugin": "^5.59.6",
-    "@typescript-eslint/parser": "^5.59.6",
-    "@wdio/cli": "^8.6.5",
-    "@wdio/local-runner": "^8.6.3",
-    "@wdio/mocha-framework": "^8.6.1",
-    "@wdio/selenium-standalone-service": "^8.6.2",
-    "@wdio/spec-reporter": "^8.4.0",
-    "eslint": "^8.40.0",
-    "eslint-plugin-import": "^2.27.5",
+    "@typescript-eslint/eslint-plugin": "^6.20.0",
+    "@typescript-eslint/parser": "^6.20.0",
+    "@wdio/cli": "^8.29.7",
+    "@wdio/local-runner": "^8.29.7",
+    "@wdio/mocha-framework": "^8.29.3",
+    "@wdio/spec-reporter": "^8.29.7",
+    "eslint": "^8.56.0",
+    "eslint-plugin-import": "^2.29.1",
     "eslint-plugin-license-notice": "^1.0.0",
-    "eslint-plugin-react": "^7.32.2",
-    "prettier": "^2.8.4",
-    "ts-loader": "^9.4.2",
-    "ts-node": "^10.9.1",
-    "typescript": "^5.0.2",
+    "eslint-plugin-react": "^7.33.2",
+    "prettier": "^3.2.4",
+    "ts-loader": "^9.5.1",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.3.3",
     "wdio-image-comparison-service": "^5.0.2"
   },
   "dependencies": {
@@ -65,12 +64,12 @@
     "@atlaskit/page-layout": "^1.3.10",
     "@atlaskit/renderer": "^107.0.0",
     "@labset/fs-directory": "^1.1.0",
-    "axios": "^1.3.4",
-    "copy-webpack-plugin": "^11.0.0",
+    "axios": "^1.6.7",
+    "copy-webpack-plugin": "^12.0.2",
     "crypto-browserify": "^3.12.0",
-    "css-loader": "^6.7.3",
-    "dotenv": "^16.0.3",
-    "html-webpack-plugin": "^5.5.0",
+    "css-loader": "^6.10.0",
+    "dotenv": "^16.4.1",
+    "html-webpack-plugin": "^5.6.0",
     "lodash": "^4.17.21",
     "os-browserify": "^0.3.0",
     "path-browserify": "^1.0.1",
@@ -79,10 +78,10 @@
     "react-dom": "^18.2.0",
     "sharp": "^0.32.1",
     "stream-browserify": "^3.0.0",
-    "style-loader": "^3.3.2",
-    "url": "^0.11.0",
+    "style-loader": "^3.3.4",
+    "url": "^0.11.3",
     "webpack": "^5.85.1",
-    "webpack-dev-server": "^4.13.1",
-    "yet-another-react-lightbox": "^2.6.2"
+    "webpack-dev-server": "^4.15.1",
+    "yet-another-react-lightbox": "^3.16.0"
   }
 }
diff --git a/test/baseline/desktop_chrome/home-page-ci-1600x1200.png b/test/baseline/desktop_chrome/home-page-ci-1600x1200.png
diff --git a/test/baseline/desktop_chrome/home-page-local-1600x1200.png b/test/baseline/desktop_chrome/home-page-local-1600x1200.png
diff --git a/test/specs/confluence-static-site.e2e.ts b/test/specs/confluence-static-site.e2e.ts
@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 describe('Confluence Static Site', () => {
-    beforeEach(async () => {
+    const setup = async () => {
         await browser.setWindowSize(1600, 1200);
         await browser.url('http://localhost:9000/');
         await browser.waitUntil(
@@ -24,13 +24,15 @@ describe('Confluence Static Site', () => {
                 timeoutMsg: 'expected title to be different after 5s'
             }
         );
-    });
+    };
 
     it('should save some screenshots', async () => {
+        await setup();
         await browser.saveScreen('home-page');
     });
 
     it('should compare successfully with a baseline', async () => {
+        await setup();
         const result = await browser.checkScreen('home-page');
         expect(result).toEqual(0);
     });

diff --git a/test/tsconfig.json b/test/tsconfig.json
@@ -1,13 +1,12 @@
 {
+  "extends": "../tsconfig.json",
   "compilerOptions": {
     "moduleResolution": "node",
-    "module": "ESNext",
     "types": [
       "node",
       "@wdio/globals/types",
       "expect-webdriverio",
       "@wdio/mocha-framework",
-      "@wdio/selenium-standalone-service",
       "wdio-image-comparison-service"
     ],
     "target": "es2022"

diff --git a/wdio.conf.ts b/wdio.conf.ts
@@ -1,3 +1,18 @@
+/**
+ * Copyright 2023 Hasnae Rehioui
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
 import { ChildProcess, spawn } from 'child_process';
 import * as path from 'path';
 
@@ -7,13 +22,9 @@ const testEnvironment = process.env.TEST_ENVIRONMENT ?? 'local';
 
 let testServerProcess: ChildProcess;
 
+// noinspection JSUnusedGlobalSymbols
 export const config: Options.Testrunner = {
     runner: 'local',
-    autoCompileOpts: {
-        tsNodeOpts: {
-            project: './test/tsconfig.json'
-        }
-    },
     specs: ['./test/specs/**/*.e2e.ts'],
     exclude: [],
     maxInstances: 10,
@@ -35,7 +46,6 @@ export const config: Options.Testrunner = {
     connectionRetryTimeout: 120000,
     connectionRetryCount: 3,
     services: [
-        'selenium-standalone',
         [
             'image-comparison',
             {
@@ -59,8 +69,8 @@ export const config: Options.Testrunner = {
     },
     /**
      * Gets executed once before all workers get launched.
-     * @param {Object} config wdio configuration object
-     * @param {Array.<Object>} capabilities list of capabilities details
+     * @param _config
+     * @param _capabilities
      */
     onPrepare: function (_config, _capabilities) {
         testServerProcess = spawn(
@@ -83,6 +93,7 @@ export const config: Options.Testrunner = {
         _exitCode: number,
         _config: Omit<Options.Testrunner, 'capabilities'>,
         _capabilities,
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
         _results: any
     ): unknown | Promise<unknown> {
         return testServerProcess.kill();