Regression tests groups

.env.sample

@@ -1,5 +1,4 @@
 SESSION_DESKTOP_ROOT="<path to session desktop root>"
-PLAYWRIGHT_CUSTOM_REPORTER=1
 PLAYWRIGHT_REPEAT_COUNT=0
 PLAYWRIGHT_RETRIES_COUNT=0
 PLAYWRIGHT_WORKERS_COUNT=1

.eslintignore

@@ -1,2 +1,3 @@
 .eslintrc.js
 *.js
+tests/localization/*

.github/workflows/desktop-regression.yml

@@ -1,4 +1,4 @@
-name: Run android regression tests
+name: Run desktop regression tests
 on:
   workflow_dispatch:
     inputs:
@@ -7,15 +7,168 @@ on:
         required: true
         type: choice
         options:
-          - oxen-io/session-playwright
+          - session-foundation/session-playwright
           - burtonemily/session-playwright
           - bilb/session-playwright
-        default: oxen-io/session-playwright
+        default: session-foundation/session-playwright
+
+      BRANCH_TO_CHECKOUT_PW:
+        description: 'branch to checkout on session-playwright'
+        required: true
+        type: string
+        default: regression-tests-groups
+
+      SESSION_DESKTOP_REPO:
+        description: 'Session desktop repo to checkout'
+        required: true
+        type: choice
+        options:
+          - session-foundation/session-desktop
+          - bilb/session-desktop
+          - yougotwill/session-desktop
+        default: session-foundation/session-desktop
+
+      BRANCH_TO_CHECKOUT_SESSION:
+        description: 'Branch to checkout on session-desktop'
+        required: true
+        type: string
+        default: dev
+
+      PLAYWRIGHT_REPEAT_COUNT:
+        description: 'Repeats of each tests (0 to only run each once)'
+        required: true
+        type: number
+        default: 0
+
+      PLAYWRIGHT_RETRIES_COUNT:
+        description: 'Retries of each tests (0 to only run each once, 1 to run another attempt)'
+        required: true
+        type: number
+        default: 0
+
+      PLAYWRIGHT_WORKERS_COUNT:
+        description: 'Playwright workers to start'
+        required: true
+        type: number
+        default: 8
+
+concurrency:
+  group: ${{ github.workflow }}
+  cancel-in-progress: true
 
 jobs:
   desktop-regression:
     name: Desktop Regression Tests
-    runs-on: [self-hosted, linux, x64, qa-desktop]
+    runs-on: [self-hosted, Linux, X64, qa-desktop]
+    container:
+      image: mcr.microsoft.com/playwright:v1.51.0-noble
+      options: --cpus 16
+
+    env:
+      PLAYWRIGHT_REPEAT_COUNT: ${{ github.event.inputs.PLAYWRIGHT_REPEAT_COUNT }}
+      PLAYWRIGHT_RETRIES_COUNT: ${{ github.event.inputs.PLAYWRIGHT_RETRIES_COUNT }}
+      PLAYWRIGHT_WORKERS_COUNT: ${{ github.event.inputs.PLAYWRIGHT_WORKERS_COUNT }}
+      DESKTOP_CACHED_FOLDER: desktop/node_modules
 
     steps:
       - uses: actions/checkout@v4
+      - name: Runner Details
+        run: |
+          echo "PLAYWRIGHT_REPO ${{ github.event.inputs.PLAYWRIGHT_REPO }}"
+          echo "BRANCH_TO_CHECKOUT_PW ${{ github.event.inputs.BRANCH_TO_CHECKOUT_PW }}"
+          echo "SESSION_DESKTOP_REPO ${{ github.event.inputs.SESSION_DESKTOP_REPO }}"
+          echo "BRANCH_TO_CHECKOUT_SESSION ${{ github.event.inputs.BRANCH_TO_CHECKOUT_SESSION }}"
+
+      - uses: actions/checkout@v4
+        name: 'Checkout playwright'
+        with:
+          repository: ${{ github.event.inputs.PLAYWRIGHT_REPO }}
+          ref: ${{ github.event.inputs.BRANCH_TO_CHECKOUT_PW }}
+          path: 'playwright'
+
+      - name: Install system deps
+        run: apt update && apt install -y git g++ build-essential cmake
+
+      - uses: actions/checkout@v4
+        name: 'Checkout Session desktop'
+        with:
+          repository: ${{ github.event.inputs.SESSION_DESKTOP_REPO }}
+          ref: ${{ github.event.inputs.BRANCH_TO_CHECKOUT_SESSION }}
+          path: 'desktop'
+
+      # Note: caching is breaking things up (app doesn't start)
+      # - name: Calculate desktop cache key
+      #   run: |
+      #     echo "CACHE_KEY=${{ runner.os }}-${{ runner.arch }}-${{ hashFiles('desktop/package.json', 'desktop/yarn.lock', 'desktop/patches/**') }}" >> $GITHUB_ENV
+
+      - name: Install node
+        uses: actions/setup-node@v3
+        with:
+          node-version-file: 'desktop/.nvmrc'
+
+      - uses: actions/setup-python@v4
+        with:
+          python-version: '3.12'
+
+      - name: Install setuptools for python 3.12
+        shell: bash
+        run: python -m pip install --upgrade pip setuptools
+
+      # Note: caching is breaking things up (app doesn't start)
+      # - uses: actions/cache/restore@v4
+      #   id: cache-desktop-modules
+      #   with:
+      #     path: ${{ env.DESKTOP_CACHED_FOLDER }}
+      #     key: ${{ env.CACHE_KEY }}
+
+      - name: Install yarn
+        run: |
+          npm install -g yarn
+
+      - name: List desktop folder
+        run: |
+          pwd
+          ls -la desktop
+
+      - name: List playwright folder
+        run: |
+          pwd
+          ls -la playwright
+
+      - name: Install desktop dependencies
+        shell: bash
+        # if: steps.cache-desktop-modules.outputs.cache-hit != 'true'
+        run: cd $GITHUB_WORKSPACE/desktop && yarn install --frozen-lockfile --network-timeout 600000
+
+      # Note: caching is breaking things up (app doesn't start)
+      # - uses: actions/cache/save@v4
+      #   if: always()
+      #   with:
+      #     path: ${{ env.DESKTOP_CACHED_FOLDER }}
+      #     key: ${{ env.CACHE_KEY }}
+
+      - name: Build desktop
+        shell: bash
+        run: cd $GITHUB_WORKSPACE/desktop && yarn build-everything
+
+      - name: Install playwright dependencies
+        run: |
+          cd $GITHUB_WORKSPACE/playwright && yarn install --frozen-lockfile
+
+      - name: Build the Desktop tests
+        run: |
+          cd  $GITHUB_WORKSPACE/playwright
+          yarn tsc
+
+      - name: Run the Desktop tests
+        run: |
+          cd $GITHUB_WORKSPACE/playwright
+          SESSION_DESKTOP_ROOT=$GITHUB_WORKSPACE/desktop nice ionice xvfb-run --auto-servernum --server-num=1 --server-args='-screen 0, 1920x1080x24' yarn test
+          # DEBUG="pw:*"
+
+      - name: Kill all running electron app
+        if: always()
+        continue-on-error: true # just so we don't fail
+        shell: bash
+        run: |
+          killall electron;

.gitignore

@@ -6,6 +6,8 @@ test-results/
 /*.js
 *.js
 *.js.map
+/*.js.map
+**/*.js.map
 .vscode/settings.json
 tests/automation/todo
 allure-report
@@ -15,3 +17,6 @@ TODO.md
 playwright.config.js
 sessionReporter.js
 .env
+output/
+dist/
+.eslintcache

.nvmrc

@@ -1 +1 @@
-18.15.0
+20.18.2

README.md

@@ -5,7 +5,7 @@ This repository holds the code to do regression testing with Playwright for Sess
 ## Setup
 
 
-`git clone https://github.com/oxen-io/session-playwright/`
+`git clone https://github.com/session-foundation/session-playwright/`
 
 Install [nvm](https://github.com/nvm-sh/nvm) or [nvm for windows](https://github.com/coreybutler/nvm-windows).
 
@@ -30,10 +30,6 @@ Create your own config from the `.env.sample` and edit the values to match your
   - *type*: string
   - *default*: 1
   - *description*: the path to the root of session-desktop to test
-- `PLAYWRIGHT_CUSTOM_REPORTER`
-  - *type*: number
-  - *default*: undefined
-  - *description*: set to 1 to use our custom reporter, see `sessionReporter.ts`
 - `PLAYWRIGHT_REPEAT_COUNT`
   - *type*: number
   - *default*: 0

package.json

@@ -2,11 +2,11 @@
   "name": "session-playwright",
   "version": "1.0.0",
   "main": "index.js",
-  "repository": "git@github.com:oxen-io/session-playwright.git",
+  "repository": "git@github.com:session-foundation/session-playwright.git",
   "author": "Audric Ackermann <audric@loki.network>",
   "license": "MIT",
   "devDependencies": {
-    "@playwright/test": "^1.50.1",
+    "@playwright/test": "^1.51",
     "@types/fs-extra": "^11.0.1",
     "@types/lodash": "^4.14.196",
     "@types/uuid": "^9.0.8",
@@ -15,7 +15,7 @@
     "allure-commandline": "^2.23.1",
     "allure-playwright": "2.6.0",
     "dotenv": "^16.4.5",
-    "electron": "^25.4.0",
+    "electron": "34.2.0",
     "eslint": "^8.46.0",
     "eslint-config-airbnb-base": "^15.0.0",
     "eslint-config-airbnb-typescript": "^18.0.0",
@@ -30,7 +30,8 @@
     "uuid": "^9.0.1"
   },
   "scripts": {
-    "lint": "yarn prettier . --write && yarn eslint .",
+    "build": "yarn tsc --watch",
+    "lint": "yarn prettier . --write --cache && yarn eslint . --cache",
     "dev": "yarn tsc --watch",
     "test": "npx playwright test",
     "watch": "tsc -w",

playwright.config.ts

@@ -1,20 +1,15 @@
 import { defineConfig } from '@playwright/test';
-import { isEmpty, toNumber } from 'lodash';
+import { toNumber } from 'lodash';
 
 import dotenv from 'dotenv';
 import { screenshotFolder } from './tests/automation/constants/variables';
 
 dotenv.config();
 
-const useSessionReporter = !isEmpty(process.env.PLAYWRIGHT_CUSTOM_REPORTER);
-
 export default defineConfig({
   timeout: 350000,
   globalTimeout: 6000000,
-  reporter: [
-    useSessionReporter ? ['./sessionReporter.ts'] : ['list'],
-    ['allure-playwright'],
-  ],
+  reporter: [['./sessionReporter.ts'], ['allure-playwright']],
   testDir: './tests/automation',
   testIgnore: '*.js',
   outputDir: './tests/automation/test-results',
@@ -28,5 +23,5 @@ export default defineConfig({
   reportSlowTests: null,
   fullyParallel: true, // otherwise, tests in the same file are not run in parallel
   globalSetup: './global.setup', // clean leftovers of previous test runs on start, runs only once
-  snapshotPathTemplate:  screenshotFolder + '/{testName}/{arg}-{platform}{ext}',
+  snapshotPathTemplate: screenshotFolder + '/{testName}/{arg}-{platform}{ext}',
 });

sessionReporter.ts

@@ -75,8 +75,11 @@ function printFailedTestLogs() {
 
 class SessionReporter implements Reporter {
   private startTime = 0;
+
   private allTestsCount = 0;
+
   private allResults: Array<TestAndResult> = [];
+
   private countWorkers = 1;
 
   onBegin(config: FullConfig, suite: Suite) {

tests/automation/community_tests.spec.ts

@@ -1,17 +1,13 @@
 import { testCommunityName } from './constants/community';
-import { test_Alice_2W, test_Alice_2W_Bob_1W } from './setup/sessionTest';
+import { test_Alice_1W_Bob_1W, test_Alice_2W } from './setup/sessionTest';
 import { joinCommunity } from './utilities/join_community';
 import { sendMessage } from './utilities/message';
 import { replyTo } from './utilities/reply_message';
-import {
-  clickOnTestIdWithText,
-  typeIntoInput,
-  waitForLoadingAnimationToFinish,
-} from './utilities/utils';
+import { sendMedia } from './utilities/send_media';
+import { clickOnTestIdWithText } from './utilities/utils';
 
 test_Alice_2W('Join community', async ({ aliceWindow1, aliceWindow2 }) => {
   await joinCommunity(aliceWindow1);
-  await waitForLoadingAnimationToFinish(aliceWindow1, 'loading-spinner');
   await clickOnTestIdWithText(aliceWindow1, 'scroll-to-bottom-button');
   await sendMessage(aliceWindow1, 'Hello, community!');
   // Check linked device for community
@@ -22,17 +18,17 @@ test_Alice_2W('Join community', async ({ aliceWindow1, aliceWindow2 }) => {
   );
 });
 
-test_Alice_2W_Bob_1W(
+test_Alice_1W_Bob_1W(
   'Send image to community',
   async ({ alice, bob, aliceWindow1, bobWindow1 }) => {
     const testMessage = 'Testing sending images to communities';
     const testImageMessage = `Image message + ${Date.now()}`;
     const testReply = `${bob.userName} replying to image from ${alice.userName}`;
     await Promise.all([joinCommunity(aliceWindow1), joinCommunity(bobWindow1)]);
-    await Promise.all([
-      waitForLoadingAnimationToFinish(aliceWindow1, 'loading-spinner'),
-      waitForLoadingAnimationToFinish(bobWindow1, 'loading-spinner'),
-    ]);
+    // await Promise.all([
+    //   waitForLoadingAnimationToFinish(aliceWindow1, 'loading-spinner'),
+    //   waitForLoadingAnimationToFinish(bobWindow1, 'loading-spinner'),
+    // ]);
     await Promise.all([
       clickOnTestIdWithText(aliceWindow1, 'scroll-to-bottom-button'),
       clickOnTestIdWithText(bobWindow1, 'scroll-to-bottom-button'),
@@ -44,16 +40,7 @@ test_Alice_2W_Bob_1W(
       'module-conversation__user__profile-name',
       testCommunityName,
     );
-    await aliceWindow1.setInputFiles(
-      "input[type='file']",
-      'sample_files/test-image.png',
-    );
-    await typeIntoInput(
-      aliceWindow1,
-      'message-input-text-area',
-      testImageMessage,
-    );
-    await clickOnTestIdWithText(aliceWindow1, 'send-message-button');
+    await sendMedia(aliceWindow1, 'sample_files/test-image.png', testImageMessage);
     await replyTo({
       senderWindow: bobWindow1,
       textMessage: testImageMessage,