fix: scroll test not working in github actions in windows

Author: abose

src-node/utils.js

@@ -150,11 +150,16 @@ async function ESLintFile({text, fullFilePath, projectFullPath}) {
     return lintFile(text, fullFilePath, projectFullPath);
 }
 
+async function getEnvironmentVariable(varName) {
+    return process.env[varName];
+}
+
 exports.getURLContent = getURLContent;
 exports.setLocaleStrings = setLocaleStrings;
 exports.getPhoenixBinaryVersion = getPhoenixBinaryVersion;
 exports.getLinuxOSFlavorName = getLinuxOSFlavorName;
 exports.openUrlInBrowser = openUrlInBrowser;
+exports.getEnvironmentVariable = getEnvironmentVariable;
 exports.ESLintFile = ESLintFile;
 exports._loadNodeExtensionModule = _loadNodeExtensionModule;
 exports._npmInstallInFolder = _npmInstallInFolder;

src/utils/NodeUtils.js

@@ -92,6 +92,13 @@ define(function (require, exports, module) {
         return utilsConnector.execPeer("_npmInstallInFolder", {moduleNativeDir});
     }
 
+    async function getEnvironmentVariable(varName) {
+        if(!Phoenix.isNativeApp) {
+            throw new Error("getEnvironmentVariable not available in browser");
+        }
+        return utilsConnector.execPeer("getEnvironmentVariable", varName);
+    }
+
     async function ESLintFile(text, fullFilePath, projectFullPath) {
         if(!Phoenix.isNativeApp) {
             throw new Error("ESLintFile not available in browser");
@@ -109,6 +116,25 @@ define(function (require, exports, module) {
         _updateNodeLocaleStrings();
     }
 
+    try {
+        if(Phoenix.isTestWindow) {
+            if(Phoenix.isNativeApp) {
+                async function _setIsTestWindowGitHubActions() {
+                    const actionsEnv = await utilsConnector.execPeer("getEnvironmentVariable", "GITHUB_ACTIONS");
+                    Phoenix.isTestWindowGitHubActions = !!actionsEnv;
+                }
+                _setIsTestWindowGitHubActions().catch(e=>{
+                    console.error("Error setting Phoenix.isTestWindowGitHubActions", e);
+                });
+            } else {
+                const urlSearchParams = new window.URLSearchParams(window.location.search || "");
+                Phoenix.isTestWindowGitHubActions = urlSearchParams.get("isTestWindowGitHubActions") === "yes";
+            }
+        }
+    } catch (e) {
+        console.error("Error setting Phoenix.isTestWindowGitHubActions", e);
+    }
+
     // private apis
     exports._loadNodeExtensionModule = _loadNodeExtensionModule;
     exports._npmInstallInFolder = _npmInstallInFolder;
@@ -119,6 +145,7 @@ define(function (require, exports, module) {
     exports.getLinuxOSFlavorName = getLinuxOSFlavorName;
     exports.openUrlInBrowser = openUrlInBrowser;
     exports.ESLintFile = ESLintFile;
+    exports.getEnvironmentVariable = getEnvironmentVariable;
     exports.isNodeReady = NodeConnector.isNodeReady;
 
     window.NodeUtils = exports;

test/SpecRunner.html

@@ -266,6 +266,7 @@
         baseURL: _getBaseURL(),
         isTestWindow: _isTestWindow(),
         isTestWindowPlaywright: _isTestWindowPlaywright(),
+        // isTestWindowGitHubActions is injected later
         isSpecRunnerWindow: window.location.pathname.endsWith("/SpecRunner.html"),
         firstBoot: false, // will be set below
         startTime: Date.now(),

test/spec/CodeInspection-fix-integ-test.js

@@ -163,6 +163,10 @@ define(function (require, exports, module) {
         }
 
         it("should remember scroll positions", async function () {
+            if(Phoenix.isTestWindowGitHubActions && Phoenix.platform === "win" && Phoenix.isNativeApp){
+                // scroll test doesn't work in GitHub actions in windows desktop apps.
+                return;
+            }
             await _openProjectFile("testFix.vbs");
 
             expect($("#problems-panel").is(":visible")).toBeTrue();

tests-playwright/test-suite.spec.js

@@ -3,6 +3,7 @@
 const { test, expect } = require("@playwright/test");
 
 const testEnv = process.env.TEST_ENV || "unit";
+const isTestWindowGitHubActions = process.env.GITHUB_ACTIONS ? "yes" : "no";
 if(!process.env.TEST_ENV){
     console.log("Test environment TEST_ENV not provided. Defaulting to execute unit tests only.");
 }
@@ -42,5 +43,5 @@ async function execTests(page, url) {
 }
 
 test(`Execute ${testEnv} tests`, async ({ page}) => {
-    await execTests(page, `${baseURL}?spec=all&category=${testEnv}&playwrightTests=true`);
+    await execTests(page, `${baseURL}?spec=all&category=${testEnv}&isTestWindowGitHubActions=${isTestWindowGitHubActions}&playwrightTests=true`);
 });