AG-43023 improve tests run

slvvko · slvvko · commit 03651fa8633e · 2025-06-09T20:35:03.000+03:00
Squashed commit of the following: commit 8227c24 Author: Slava Leleka <v.leleka@adguard.com> Date: Mon Jun 9 12:52:20 2025 -0400 fix changelog commit aaf8ab6 Author: Slava Leleka <v.leleka@adguard.com> Date: Mon Jun 9 12:42:38 2025 -0400 add MAX_CACHE_SIZE const commit 434f245 Author: Slava Leleka <v.leleka@adguard.com> Date: Thu Jun 5 00:41:07 2025 -0400 improve tests server commit bca62be Author: Slava Leleka <v.leleka@adguard.com> Date: Thu Jun 5 00:40:45 2025 -0400 improve runQunitTests commit 130f41f Author: Slava Leleka <v.leleka@adguard.com> Date: Thu Jun 5 00:04:54 2025 -0400 clean checkout for qunit tests commit 97b0364 Author: Slava Leleka <v.leleka@adguard.com> Date: Wed Jun 4 15:38:08 2025 -0400 test qunit first commit 5003a98 Author: Slava Leleka <v.leleka@adguard.com> Date: Wed Jun 4 15:36:19 2025 -0400 single job for lint commit be85368 Author: Slava Leleka <v.leleka@adguard.com> Date: Wed Jun 4 15:29:52 2025 -0400 single job for qunit tests commit 1776854 Author: Slava Leleka <v.leleka@adguard.com> Date: Wed Jun 4 15:25:42 2025 -0400 no clean checkout for qunit tests commit 6fa4ad0 Author: Slava Leleka <v.leleka@adguard.com> Date: Wed Jun 4 15:19:09 2025 -0400 split test and lint jobs to smaller ones commit cf195f6 Merge: c589ef6 c0c8be5 Author: Slava Leleka <v.leleka@adguard.com> Date: Wed Jun 4 15:12:39 2025 -0400 Merge branch 'master' into fix/AG-43023 commit c589ef6 Author: Slava Leleka <v.leleka@adguard.com> Date: Wed Jun 4 14:50:54 2025 -0400 clean up commit 186a233 Author: Slava Leleka <v.leleka@adguard.com> Date: Wed Jun 4 14:42:08 2025 -0400 fix typos commit 59bff8c Author: Slava Leleka <v.leleka@adguard.com> Date: Wed Jun 4 14:37:55 2025 -0400 split test specs into several jobs
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -10,7 +10,8 @@ The format is based on [Keep a Changelog], and this project adheres to [Semantic
 <!-- TODO: change `@added unknown` tag due to the actual version -->
 <!--       during new scriptlets or redirects releasing -->
 
-## [v2.2.6] - 2025-06-04
+<!-- v2.2.6 is the same as v2.2.7 -->
+## [v2.2.7] - 2025-06-04
 
 ### Changed
 
@@ -21,7 +22,7 @@ The format is based on [Keep a Changelog], and this project adheres to [Semantic
 - `json-prune` scriptlet to properly handle `null` values
   while checking specified key in object [#504].
 
-[v2.2.6]: https://github.com/AdguardTeam/Scriptlets/compare/v2.2.4...v2.2.6
+[v2.2.7]: https://github.com/AdguardTeam/Scriptlets/compare/v2.2.4...v2.2.7
 [#504]: https://github.com/AdguardTeam/Scriptlets/issues/504
 
 <!-- v2.2.5 is the same as v2.2.4 -->
diff --git a/bamboo-specs/test.yaml b/bamboo-specs/test.yaml
@@ -8,33 +8,47 @@ variables:
   dockerPuppeteer: adguard/puppeteer-runner:22.14--24.5--1
 
 stages:
-  - Build:
+  - Build: &stage
       manual: false
       final: false
       jobs:
-        - Build
+        - Build docs
+        - Build lib
+  - Lint and test:
+      <<: *stage
+      jobs:
+        - Test qunit
+        - Test vitest
+        - Test smoke
+        # lint should be run after building of docs and lib
+        - Lint
+  - Cleanup:
+      <<: *stage
+      final: true
+      jobs:
+        - Cleanup
 
-Build:
-  key: BUILD
-  docker:
+Build docs:
+  key: BUILDDOCS
+  docker: &docker
     image: "${bamboo.dockerPuppeteer}"
     volumes:
       ${system.PNPM_DIR}: "${bamboo.cachePnpm}"
   tasks:
     - checkout:
         force-clean-build: true
-    - script:
+    - script: &setup-script
         interpreter: SHELL
         scripts:
           - |-
             set -e
             set -x
 
+            ls -laht
+
             # Fix mixed logs
             exec 2>&1
 
-            ls -laht
-
             # Exclude '--ignore-scripts' from pnpm arguments
             # since it prevents postinstall scripts from running
             # so Chrome is not installed which is crucial for tests
@@ -43,17 +57,99 @@ Build:
 
             # Install common dependencies
             pnpm install ${modifiedPnpmArgs}
-
+    - script:
+        interpreter: SHELL
+        scripts:
+          - |-
             # build docs to lint them later
             # check compatibility table updates and build it and build wiki docs
             pnpm wiki
+  requirements: &requirements
+    - adg-docker: 'true'
+    - extension: 'true'
 
-            pnpm test
+Build lib:
+  key: BUILDLIB
+  docker: *docker
+  tasks:
+    - checkout:
+        force-clean-build: true
+    - script: *setup-script
+    - script:
+        interpreter: SHELL
+        scripts:
+          - |-
             pnpm build
+  artifacts:
+    - name: scriptlets.corelibs.json
+      location: dist
+      pattern: scriptlets.corelibs.json
+      required: true
+    - name: redirects.json
+      location: dist
+      pattern: redirects.json
+      required: true
+  requirements: *requirements
+
+Test qunit:
+  key: TESTQUNIT
+  docker: *docker
+  tasks:
+    - checkout:
+        force-clean-build: true
+    - script: *setup-script
+    - script:
+        interpreter: SHELL
+        scripts:
+          - |-
+            pnpm test:qunit
+  requirements: *requirements
+
+Test vitest:
+  key: TESTVITEST
+  docker: *docker
+  tasks:
+    - checkout
+    - script: *setup-script
+    - script:
+        interpreter: SHELL
+        scripts:
+          - |-
+            pnpm test:vitest
+  requirements: *requirements
+
+Test smoke:
+  key: TESTSMOKE
+  docker: *docker
+  tasks:
+    - checkout:
+        force-clean-build: true
+    - script: *setup-script
+    - script:
+        interpreter: SHELL
+        scripts:
+          - |-
+            pnpm test:smoke
+  requirements: *requirements
 
-            # lint code and docs. it should be run after `pnpm build`
+Lint:
+  key: LINT
+  docker: *docker
+  tasks:
+    - checkout
+    - script: *setup-script
+    - script:
+        interpreter: SHELL
+        scripts:
+          - |-
             pnpm lint
-  final-tasks:
+  requirements: *requirements
+
+Cleanup:
+  key: CLEAN
+  docker: *docker
+  tasks:
+    - checkout
     - script:
         interpreter: SHELL
         scripts:
@@ -69,17 +165,7 @@ Build:
             echo "Size before cleanup:" && du -h | tail -n 1
             rm -rf node_modules
             echo "Size after cleanup:" && du -h | tail -n 1
-  artifacts:
-    - name: scriptlets.corelibs.json
-      location: dist
-      pattern: scriptlets.corelibs.json
-      required: true
-    - name: redirects.json
-      location: dist
-      pattern: redirects.json
-      required: true
-  requirements:
-    - adg-docker: 'true'
+  requirements: *requirements
 
 branches:
   create: for-pull-request
diff --git a/tests/index.js b/tests/index.js
@@ -1,8 +1,9 @@
 /* eslint-disable no-console */
 import path from 'node:path';
 import fs from 'node:fs';
-import { runQunitPuppeteer, printFailedTests, printResultSummary } from 'node-qunit-puppeteer';
+import { runQunitWithBrowser, printFailedTests, printResultSummary } from 'node-qunit-puppeteer';
 import { fileURLToPath } from 'node:url';
+import puppeteer from 'puppeteer';
 
 import {
     server,
@@ -21,10 +22,12 @@ const TEST_FILE_NAME_MARKER = '.html';
 /**
  * Returns false if test failed and true if test passed
  *
- * @param {string} indexFile
- * @returns {Promise<boolean>}
+ * @param {string} indexFile Path to the test file.
+ * @param {puppeteer.Browser} browser Puppeteer browser instance to reuse.
+ *
+ * @returns {Promise<boolean>} Promise that resolves to true if test passed, false otherwise.
  */
-const runQunit = async (indexFile) => {
+const runQunit = async (indexFile, browser) => {
     const qunitArgs = {
         targetUrl: `http://localhost:${port}/${indexFile}?test`,
         timeout: TESTS_RUN_TIMEOUT,
@@ -33,7 +36,7 @@ const runQunit = async (indexFile) => {
         puppeteerArgs: ['--no-sandbox', '--allow-file-access-from-files'],
     };
 
-    const result = await runQunitPuppeteer(qunitArgs);
+    const result = await runQunitWithBrowser(browser, qunitArgs);
     printResultSummary(result, console);
     if (result.stats.failed > 0) {
         printFailedTests(result, console);
@@ -55,16 +58,44 @@ const runQunitTests = async () => {
     let testsPassed = true;
 
     try {
-        console.log('Running tests..');
+        console.log('Running tests sequentially with shared browser instance..');
+
+        // Create a single browser instance to be shared across all tests
+        const browser = await puppeteer.launch({
+            args: ['--no-sandbox', '--allow-file-access-from-files'],
+            // Using headless mode for better performance
+            headless: 'new',
+        });
 
-        // eslint-disable-next-line no-restricted-syntax
+        // Run tests one after another
+        const testResults = [];
         for (const fileName of testFiles) {
-            // \n is needed to divide logging
-            console.log(`\nTesting ${fileName}:`);
-            // eslint-disable-next-line no-await-in-loop
-            const testPassed = await runQunit(fileName);
-            testsPassed = testsPassed && testPassed;
+            console.log(`\nStarted test: ${fileName}`);
+            try {
+                const testPassed = await runQunit(fileName, browser);
+                console.log(`Completed test: ${fileName}`);
+                testResults.push({ fileName, passed: testPassed, error: null });
+            } catch (error) {
+                console.log(`Error in test ${fileName}:`, error);
+                testResults.push({ fileName, passed: false, error });
+            }
         }
+
+        // Close the shared browser instance
+        await browser.close();
+
+        // Process results after all tests complete
+        testResults.forEach(({ fileName, passed, error }) => {
+            if (error) {
+                console.log(`\n❌ Test ${fileName} failed with error:`, error);
+                errorOccurred = true;
+            } else if (!passed) {
+                console.log(`\n❌ Test ${fileName} did not pass`);
+                testsPassed = false;
+            } else {
+                console.log(`\n✅ Test ${fileName} passed`);
+            }
+        });
     } catch (e) {
         console.log(e);
         await stop(testServer);
diff --git a/tests/server.js b/tests/server.js
@@ -11,6 +11,16 @@ const TEST_QUERY_MARKER = '?test';
 
 const PORT = 54136;
 
+/**
+ * Maximum file size for caching — 5MB.
+ */
+const MAX_CACHE_SIZE = 5 * 1024 * 1024;
+
+/**
+ * File cache to improve performance.
+ */
+const fileCache = new Map();
+
 const mimeTypes = {
     '.html': 'text/html',
     '.js': 'application/javascript',
@@ -38,33 +48,54 @@ const server = {
             }
 
             const fullPath = path.join(__dirname, 'dist', filename);
+            const contentType = getContentType(fullPath);
 
-            fs.stat(fullPath, (err, stats) => {
-                if (err) {
-                    console.log(err.message);
-                    res.writeHead(404);
-                    res.end(JSON.stringify(err));
-                    return;
-                }
+            // Check if file is cached and not a dynamic resource
+            if (fileCache.has(fullPath) && !filename.includes('?')) {
+                // Serve from cache
+                console.log(`Serving ${filename} from cache`);
+                res.writeHead(200, {
+                    'Content-Type': contentType,
+                    'Cache-Control': 'max-age=3600',
+                });
+                res.end(fileCache.get(fullPath));
+                return;
+            }
+
+            // Fast-path synchronous file check to avoid async overhead if we know the file exists
+            if (!fs.existsSync(fullPath)) {
+                res.writeHead(404);
+                res.end('File not found');
+                return;
+            }
+
+            const stats = fs.statSync(fullPath);
+
+            if (stats.isFile()) {
+                // It's a file, serve it
+                try {
+                    const data = fs.readFileSync(fullPath);
+
+                    // Cache the file if not too large
+                    if (stats.size < MAX_CACHE_SIZE) {
+                        fileCache.set(fullPath, data);
+                    }
 
-                if (stats.isFile()) {
-                    // It's a file, serve it
-                    fs.readFile(fullPath, (err, data) => {
-                        if (err) {
-                            console.log(err.message);
-                            res.writeHead(500);
-                            res.end(JSON.stringify(err));
-                            return;
-                        }
-                        res.writeHead(200, { 'Content-Type': getContentType(fullPath) });
-                        res.end(data);
+                    res.writeHead(200, {
+                        'Content-Type': contentType,
+                        'Cache-Control': 'max-age=3600',
                     });
-                } else {
-                    // Neither a file nor a directory
-                    res.writeHead(404);
-                    res.end();
+                    res.end(data);
+                } catch (err) {
+                    console.log(err.message);
+                    res.writeHead(500);
+                    res.end(JSON.stringify(err));
                 }
-            });
+            } else {
+                // Neither a file nor a directory
+                res.writeHead(404);
+                res.end('Not a file');
+            }
         });
     },
 };
