Improved reliability of automated testing.

Author: RobertWesner

CHANGELOG.md

@@ -5,6 +5,7 @@
 Added automated validation of userscript with [eslint](https://github.com/eslint/eslint) and [semgrep](https://github.com/semgrep/semgrep).
 
 * Applied eslint recommendations.
+* Improved reliability of automated testing.
 
 `eslint` and `semgrep` are used to check for risky/insecure code inside the userscript.
 This is a measure to build reliability and trust by making it easier to audit the code.

linting/package.json

@@ -6,10 +6,6 @@
   "devDependencies": {
     "@eslint/js": "^9.39.1",
     "eslint": "^9.39.1",
-    "eslint-config-standard": "^17.1.0",
-    "eslint-plugin-import": "^2.32.0",
-    "eslint-plugin-n": "^16.6.2",
-    "eslint-plugin-promise": "^6.6.0",
     "globals": "^16.5.0"
   },
   "scripts": {

script.user.js

@@ -51,7 +51,7 @@
     }
 
     // TODO: look into rewriting this "trick" to improve quality of this script
-    if (window.getOwnPropertyDescriptor('trustedTypes') && !window.trustedTypes.defaultPolicy) {
+    if ('trustedTypes' in window && !window.trustedTypes.defaultPolicy) {
         window.trustedTypes.createPolicy('default', { createHTML: string => string });
     }
 

testing/src/Helpers.purs

@@ -6,15 +6,15 @@ import Effect.Aff (Aff)
 import Node.FS.Aff (readTextFile)
 import Node.Encoding (Encoding(UTF8))
 
-injectScript :: String -> T.Page -> Aff Unit
-injectScript script page =
-    void $ T.unsafeEvaluateStringFunction script page
+setUpJS :: String -> T.Page -> Aff Unit
+setUpJS script page =
+    void $ T.unsafeEvaluateOnNewDocument ("document.addEventListener('DOMContentLoaded', () => {\n" <> script <> "\n});") page
 
-injectUserscript :: T.Page -> Aff Unit
-injectUserscript page = do
+setUpUserscript :: T.Page -> Aff Unit
+setUpUserscript page = do
     src <- readTextFile UTF8 "../script.user.js"
-    injectScript "window.GM_info = { script: { version: '21110101-0-test' } };" page
-    injectScript src page
+    setUpJS "window.GM_info = { script: { version: '21110101-0-test' } };" page
+    setUpJS src page
 
 waitForAndClick :: String -> T.Page -> Aff Unit
 waitForAndClick selector page = do

testing/src/Script.purs

@@ -4,7 +4,7 @@ import Prelude
 import Toppokki as T
 import Effect.Aff (Aff, delay)
 import Info (info)
-import Helpers (injectUserscript, waitForAndClick, ytpaSelector)
+import Helpers (setUpUserscript, waitForAndClick, ytpaSelector)
 import Data.Time.Duration (Milliseconds(Milliseconds))
 import Foreign (isNull, isUndefined, readString)
 import Control.Monad.Except (runExcept)
@@ -41,6 +41,7 @@ script = do
     browser <- T.launch { args: [ "--no-sandbox", "--disable-setuid-sandbox"] }
     page <- T.newPage browser
 
+    setUpUserscript page
     T.goto (T.URL "https://youtube.com") page
 
     info "Waiting to reject cookies..."
@@ -50,8 +51,6 @@ script = do
     delay (Milliseconds 500.0)
     _ <- T.pageWaitForSelector (T.Selector "[aria-label*=\"Your YouTube history is off\"]") {} page
     delay (Milliseconds 1000.0)
-    injectUserscript page
-    delay (Milliseconds 1000.0)
 
     -- Actual testing
 
@@ -100,7 +99,6 @@ script = do
                 _ <- T.pageWaitForSelector (T.Selector "#lock") {} page'
                 delay (Milliseconds 500.0)
                 T.goto (T.URL "https://www.youtube.com/@TechnologyConnections/videos") page'
-                injectUserscript page'
                 delay (Milliseconds 500.0)
                 _ <- T.pageWaitForSelector (T.Selector "yt-tab-shape[tab-title=\"Videos\"]") {} page'
                 delay (Milliseconds 500.0)
@@ -168,7 +166,6 @@ script = do
                 _ <- T.pageWaitForSelector (T.Selector "#lock") {} page'
                 delay (Milliseconds 500.0)
                 T.goto (T.URL "https://www.youtube.com/@Insym/streams") page'
-                injectUserscript page'
                 delay (Milliseconds 500.0)
                 _ <- T.pageWaitForSelector (T.Selector "yt-tab-shape[tab-title=\"Live\"]") {} page'
                 delay (Milliseconds 500.0)