Adjust saucelabs EOL feature

Author: igneel64

.github/workflows/build.yml

@@ -12,6 +12,7 @@ jobs:
     env:
       SAUCE_USERNAME: ${{ secrets.SAUCE_USERNAME }}
       SAUCE_ACCESS_KEY: ${{ secrets.SAUCE_ACCESS_KEY }}
+      SAUCE_TUNNEL_NAME: sp-js-tracker-${{ github.run_id }}-${{ github.run_attempt }}
       BROWSERSLIST_IGNORE_OLD_DATA: true
 
     steps:
@@ -52,8 +53,18 @@ jobs:
         if: ${{ env.SAUCE_ACCESS_KEY != '' }}
         run: echo "127.0.0.1 snowplow-js-tracker.local" | sudo tee -a /etc/hosts
 
+      - name: Start Saucelabs Tunnel
+        if: ${{ env.SAUCE_ACCESS_KEY != '' }}
+        uses: saucelabs/sauce-connect-action@v3
+        with:
+          username: ${{ secrets.SAUCE_USERNAME }}
+          accessKey: ${{ secrets.SAUCE_ACCESS_KEY }}
+          region: us
+          tunnelName: ${{ env.SAUCE_TUNNEL_NAME }}
+
       - name: Run End to End Tests
         if: ${{ env.SAUCE_ACCESS_KEY != '' }}
+        timeout-minutes: 60
         working-directory: ./trackers/javascript-tracker
         run: node ../../common/scripts/install-run-rushx.js test:e2e:sauce
 

trackers/javascript-tracker/test/wdio.default.conf.ts

@@ -9,13 +9,15 @@ function getFullPath(path: string): string {
 type CustomTestRunnerConfig = Options.Testrunner & { dockerInstance?: DockerWrapper };
 
 export const config: Omit<Options.Testrunner, 'capabilities'> = {
-  specs: [[
-    getFullPath('test/functional/*.test.ts'),
-    getFullPath('test/integration/*.test.ts'),
-    getFullPath('test/media/media.test.ts'),
-    getFullPath('test/performance/*.test.ts'),
-    // YouTube and Vimeo tests are disabled since they block SauceLabs on CI
-  ]],
+  specs: [
+    [
+      getFullPath('test/functional/*.test.ts'),
+      getFullPath('test/integration/*.test.ts'),
+      getFullPath('test/media/media.test.ts'),
+      getFullPath('test/performance/*.test.ts'),
+      // YouTube and Vimeo tests are disabled since they block SauceLabs on CI
+    ],
+  ],
   logLevel: 'warn',
   baseUrl: 'http://snowplow-js-tracker.local:8080',
   waitforTimeout: 30000,
@@ -31,7 +33,11 @@ export const config: Omit<Options.Testrunner, 'capabilities'> = {
     defaultTimeoutInterval: 120000,
   },
   async onPrepare(config: CustomTestRunnerConfig) {
-    const isSauce = config.services?.some((service) => Array.isArray(service) && service[0] === 'sauce');
+    // Tolerate both the `'sauce'` and `['sauce', opts]` service forms, since Micro must be
+    // advertised under the tunnel hostname rather than loopback whenever tests run on Sauce.
+    const isSauce = config.services?.some((service) =>
+      Array.isArray(service) ? service[0] === 'sauce' : service === 'sauce'
+    );
     config.dockerInstance = await start(isSauce);
     await setValue('dockerInstanceUrl', config.dockerInstance.url);
     return;

trackers/javascript-tracker/test/wdio.sauce.conf.ts

@@ -8,6 +8,15 @@ if (process.env.GITHUB_WORKFLOW) {
 
 const buildName = `snowplow-js-tracker-${buildIdentifier}`;
 
+// The Sauce Connect tunnel is started outside of WebdriverIO (see the `Start Saucelabs Tunnel`
+// step in `.github/workflows/build.yml`) since Sauce Connect 4, the only version the pinned
+// `@wdio/sauce-service` can launch, is no longer accepted by Sauce Labs.
+const tunnelName = process.env.SAUCE_TUNNEL_NAME;
+const sauceOptions = {
+  build: buildName,
+  ...(tunnelName ? { tunnelName } : {}),
+};
+
 export const config: Partial<Options.Testrunner> = {
   ...defaultConfig,
 
@@ -20,59 +29,41 @@ export const config: Partial<Options.Testrunner> = {
       browserName: 'firefox',
       platformName: 'macOS 10.15',
       browserVersion: '96',
-      'sauce:options': {
-        build: buildName,
-      },
+      'sauce:options': { ...sauceOptions },
     },
     {
       browserName: 'firefox',
       browserVersion: '78',
       platformName: 'Windows 10',
-      'sauce:options': {
-        build: buildName,
-      },
+      'sauce:options': { ...sauceOptions },
     },
     {
       browserName: 'chrome',
       platformName: 'Windows 10',
       browserVersion: '109',
-      'sauce:options': {
-        build: buildName,
-      },
+      'sauce:options': { ...sauceOptions },
     },
     {
       browserName: 'chrome',
       platformName: 'macOS 10.15',
       browserVersion: '95',
-      'sauce:options': {
-        build: buildName,
-      },
+      'sauce:options': { ...sauceOptions },
     },
     {
       browserName: 'MicrosoftEdge',
       platformName: 'Windows 10',
       browserVersion: 'latest',
-      'sauce:options': {
-        build: buildName,
-      },
+      'sauce:options': { ...sauceOptions },
     },
     {
       browserName: 'safari',
       browserVersion: '14',
       platformName: 'macOS 11.00',
-      'sauce:options': {
-        build: buildName,
-      },
+      'sauce:options': { ...sauceOptions },
     },
   ],
   services: [
-    [
-      'sauce',
-      {
-        sauceConnect: true,
-        sauceConnectOpts: {},
-      },
-    ],
+    'sauce',
     [
       'static-server',
       {