Merge remote-tracking branch 'foundation/main' into ci-desktop-regression-self-hosted

Author: Bilb

.env.sample

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

.eslintrc.js

@@ -7,11 +7,11 @@ module.exports = {
     },
   },
 
-  extends: ['airbnb-base', 'prettier', 'plugin:@typescript-eslint/recommended'],
+  extends: ['airbnb-base', 'airbnb-typescript/base', 'prettier', 'plugin:@typescript-eslint/recommended'],
 
   plugins: ['mocha', 'more', '@typescript-eslint'],
   parser: '@typescript-eslint/parser',
-  parserOptions: { project: ['tsconfig.json'] },
+  parserOptions: { project: ['./tsconfig.json'] },
 
   rules: {
     'comma-dangle': [

.gitignore

@@ -3,6 +3,9 @@ test-results/
 /playwright-report/
 /playwright/.cache/
 **/*.js
+/*.js
+*.js
+*.js.map
 .vscode/settings.json
 tests/automation/todo
 allure-report

README.md

@@ -42,7 +42,7 @@ Create your own config from the `.env.sample` and edit the values to match your
   - *type*: number
   - *default*: 0
   - *description*: the number of retries each test. i.e. if a test **failed** on attempt x, and our current attempt is `< PLAYWRIGHT_RETRIES_COUNT` the test will be scheduled to be run again. This can be used to debug flaky tests
-- `PLAYWRIGHT_WORKER_COUNT`
+- `PLAYWRIGHT_WORKERS_COUNT`
   - *type*: number
   - *default*: 1
   - *description*: the number of workers to start in parallel. The more, the faster the test suite is going to run, but if you hit your CPU limit they'll start to be unnecessarily flaky. Should be fine with a value between 10-20 depending on the machine.

global.setup.ts

@@ -37,7 +37,7 @@ export default async function globalSetup() {
       ? join(homedir(), '.config')
       : null;
     if (!parentFolderOfAllDataPath) {
-      throw new Error('Only macOS/linux are currently supported ');
+      throw new Error('Only macOS/linux are currently supported');
     }
 
     if (!parentFolderOfAllDataPath || parentFolderOfAllDataPath.length < 9) {

package.json

@@ -19,6 +19,7 @@
     "electron": "^25.4.0",
     "eslint": "^8.46.0",
     "eslint-config-airbnb-base": "^15.0.0",
+    "eslint-config-airbnb-typescript": "^18.0.0",
     "eslint-config-prettier": "^9.0.0",
     "eslint-plugin-import": "^2.28.0",
     "eslint-plugin-mocha": "^10.1.0",
@@ -32,6 +33,7 @@
   },
   "scripts": {
     "lint": "yarn prettier . --write && yarn eslint .",
+    "dev": "yarn tsc --watch",
     "test": "npx playwright test",
     "watch": "tsc -w",
     "allure-create": "allure generate ./allure-results",

playwright.config.ts

@@ -3,7 +3,9 @@
 import { defineConfig } from '@playwright/test';
 import { isEmpty, toNumber } from 'lodash';
 
-import 'dotenv/config';
+import dotenv from 'dotenv';
+
+dotenv.config();
 
 const useSessionReporter = !isEmpty(process.env.PLAYWRIGHT_CUSTOM_REPORTER);
 
@@ -23,7 +25,7 @@ export default defineConfig({
   repeatEach: process.env.PLAYWRIGHT_REPEAT_COUNT
     ? toNumber(process.env.PLAYWRIGHT_REPEAT_COUNT)
     : 0,
-  workers: toNumber(process.env.PLAYWRIGHT_WORKER_COUNT) || 1,
+  workers: toNumber(process.env.PLAYWRIGHT_WORKERS_COUNT) || 1,
   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

sessionReporter.ts

@@ -8,7 +8,7 @@ import type {
   TestResult,
 } from '@playwright/test/reporter';
 import chalk from 'chalk';
-import { Dictionary, groupBy, mean, sortBy } from 'lodash';
+import { Dictionary, groupBy, isString, mean, sortBy } from 'lodash';
 
 type TestAndResult = { test: TestCase; result: TestResult };
 
@@ -21,6 +21,8 @@ function getChalkColorForStatus(result: Pick<TestResult, 'status'>) {
     ? chalk.green
     : result.status === 'interrupted'
     ? chalk.yellow
+    : result.status === 'skipped'
+    ? chalk.blue
     : chalk.red;
 }
 
@@ -33,7 +35,8 @@ function testResultToDurationStr(tests: Array<Pick<TestAndResult, 'result'>>) {
 
 function formatGroupedByResults(testAndResults: Array<TestAndResult>) {
   const allPassed = testAndResults.every((m) => m.result.status === 'passed');
-  const allFailed = testAndResults.every((m) => m.result.status !== 'passed');
+  const allFailed = testAndResults.every((m) => m.result.status === 'failed');
+  const allSkipped = testAndResults.every((m) => m.result.status === 'skipped');
   const firstItem = testAndResults[0]; // we know they all have the same state
   const statuses = testAndResults.map((m) => `"${m.result.status}"`).join(',');
 
@@ -49,6 +52,8 @@ function formatGroupedByResults(testAndResults: Array<TestAndResult>) {
         ? { status: 'passed' }
         : allFailed
         ? { status: 'failed' }
+        : allSkipped
+        ? { status: 'skipped' }
         : { status: 'interrupted' },
     )(
       `\t\t\t"${
@@ -60,18 +65,24 @@ function formatGroupedByResults(testAndResults: Array<TestAndResult>) {
   );
 }
 
+function printOngoingTestLogs() {
+  return process.env.PRINT_ONGOING_TEST_LOGS === '1';
+}
+
+function printFailedTestLogs() {
+  return process.env.PRINT_FAILED_TEST_LOGS === '1';
+}
+
 class SessionReporter implements Reporter {
-  private printTestConsole = false;
-  private startTime: number = 0;
-  private allTestsCount: number = 0;
+  private startTime = 0;
+  private allTestsCount = 0;
   private allResults: Array<TestAndResult> = [];
-  private countWorkers: number = 1;
+  private countWorkers = 1;
 
   onBegin(config: FullConfig, suite: Suite) {
     this.allTestsCount = suite.allTests().length;
     this.countWorkers = config.workers;
 
-    this.printTestConsole = this.allTestsCount <= 1;
     console.log(
       `\t\tStarting the run with ${this.allTestsCount} tests, with ${this.countWorkers} workers, ${config.projects[0].retries} retries and ${config.projects[0].repeatEach} repeats`,
     );
@@ -94,11 +105,24 @@ class SessionReporter implements Reporter {
           `\t\tFinished test "${test.title}": ${result.status} with stdout/stderr`,
         )}`,
       );
-      console.warn(`stdout:`);
-      result.stdout.map((t) => process.stdout.write(t.toString()));
-
-      console.warn('stderr:');
-      result.stderr.map((t) => process.stderr.write(t.toString()));
+      if (printFailedTestLogs()) {
+        console.info(`stdout:`);
+        result.stdout.map((t) => process.stdout.write(t.toString()));
+
+        console.info('stderr:');
+        result.stderr.map((t) => process.stderr.write(t.toString()));
+      } else {
+        console.info(
+          `not printing stderr/stdout as PRINT_FAILED_TEST_LOGS is not '1'`,
+        );
+      }
+
+      const lastError = result.errors[result.errors.length - 1];
+      console.info(
+        `test failed with "${lastError?.message || 'unknown'}"\n\tsnippet:${
+          lastError?.snippet || 'unknown'
+        } \n\tstack:${lastError?.stack || 'unknown'}`,
+      );
     } else {
       console.log(
         `${getChalkColorForStatus(result)(
@@ -108,7 +132,7 @@ class SessionReporter implements Reporter {
     }
     this.allResults.push({ test, result });
 
-    console.log(chalk.bgWhiteBright(`\t\tResults so far:`));
+    console.log(chalk.bgWhiteBright.black(`\t\tResults so far:`));
     // we keep track of all the failed/passed states, but only render the passed status here even if it took a few retries
 
     const { allFailedSoFar, allPassedSoFar, partiallyPassed } =
@@ -125,8 +149,8 @@ class SessionReporter implements Reporter {
       notPassedCount * mean(this.allResults.map((m) => m.result.duration));
     const estimatedTotalMins = Math.floor(estimateLeftMs / (60 * 1000));
     console.log(
-      chalk.bgWhite(
-        `\t\tRemaining tests: ${notPassedCount}, rougly ${estimatedTotalMins}min total left, so about ${Math.ceil(
+      chalk.bgWhite.black(
+        `\t\tRemaining tests: ${notPassedCount}, roughly ${estimatedTotalMins}min total left, so about ${Math.ceil(
           estimatedTotalMins / this.countWorkers,
         )}min as we have ${this.countWorkers} worker(s)...`,
       ),
@@ -176,7 +200,7 @@ class SessionReporter implements Reporter {
 
   onEnd(result: FullResult) {
     console.log(
-      chalk.bgWhiteBright(
+      chalk.bgWhiteBright.black(
         `\n\n\n\t\tFinished the run: ${result.status}, count of tests run: ${
           this.allResults.length
         }, took ${Math.floor(
@@ -197,15 +221,31 @@ class SessionReporter implements Reporter {
     test: void | TestCase,
     _result: void | TestResult,
   ) {
-    if (this.printTestConsole) {
+    if (printOngoingTestLogs()) {
+      process.stdout.write(
+        `"${test ? `${chalk.cyanBright(test.title)}` : ''}": ${
+          isString(chunk) ? chunk : chunk.toString('utf-8')
+        }`,
+      );
+    }
+  }
+
+  onStdErr?(
+    chunk: string | Buffer,
+    test: void | TestCase,
+    _result: void | TestResult,
+  ) {
+    if (printOngoingTestLogs()) {
       process.stdout.write(
-        `"${test ? `${chalk.cyanBright(test.title)}` : ''}": ${chunk}`,
+        `"${test ? `${chalk.cyanBright(test.title)}` : ''}":err: ${
+          isString(chunk) ? chunk : chunk.toString('utf-8')
+        }`,
       );
     }
   }
 
   onError?(error: TestError) {
-    console.warn('global error:', error);
+    console.info('global error:', error);
   }
 }
 

tests/automation/call_checks.spec.ts

@@ -1,33 +1,35 @@
 import { englishStrippedStr } from '../locale/localizedString';
-import { sleepFor } from '../promise_utils';
 import { test_Alice_1W_Bob_1W } from './setup/sessionTest';
 import { createContact } from './utilities/create_contact';
-import { clickOnMatchingText, clickOnTestIdWithText } from './utilities/utils';
+import { waitForTestIdWithText } from './utilities/utils';
+import { makeVoiceCall } from './utilities/voice_call';
 
 test_Alice_1W_Bob_1W(
   'Voice calls',
   async ({ alice, aliceWindow1, bob, bobWindow1 }) => {
     await createContact(aliceWindow1, bobWindow1, alice, bob);
-    await clickOnTestIdWithText(aliceWindow1, 'call-button');
-    await clickOnTestIdWithText(aliceWindow1, 'session-toast');
-    await clickOnTestIdWithText(aliceWindow1, 'enable-calls');
-    await clickOnTestIdWithText(aliceWindow1, 'session-confirm-ok-button');
-    await clickOnTestIdWithText(aliceWindow1, 'message-section');
-    await clickOnTestIdWithText(
-      aliceWindow1,
-      'module-conversation__user__profile-name',
-      bob.userName,
-    );
-    await clickOnTestIdWithText(aliceWindow1, 'call-button');
-    // Enable calls in window B
-    await clickOnTestIdWithText(bobWindow1, 'session-toast');
-    await clickOnTestIdWithText(bobWindow1, 'enable-calls');
-    await clickOnTestIdWithText(bobWindow1, 'session-confirm-ok-button');
-    await clickOnMatchingText(
+    await makeVoiceCall(aliceWindow1, bobWindow1, alice, bob);
+    // In the receivers window, the message is 'Call in progress'
+    await waitForTestIdWithText(
       bobWindow1,
-      englishStrippedStr('accept').toString(),
+      'call-notification-answered-a-call',
+      englishStrippedStr('callsInProgress').toString(),
+    );
+    // Control message should be '{callerName} called you'
+    // await waitForTestIdWithText(
+    //   bobWindow1,
+    //   'call-notification-answered-a-call',
+    //   englishStrippedStr('callsCalledYou')
+    //     .withArgs({ name: caller.userName })
+    //     .toString(),
+    // );
+    // In the callers window, the message is 'You called {reciverName}'
+    await waitForTestIdWithText(
+      aliceWindow1,
+      'call-notification-started-call',
+      englishStrippedStr('callsYouCalled')
+        .withArgs({ name: bob.userName })
+        .toString(),
     );
-    await sleepFor(5000);
-    await clickOnTestIdWithText(aliceWindow1, 'end-call');
   },
 );

tests/automation/community_tests.spec.ts

@@ -0,0 +1,64 @@
+import { testCommunityName } from './constants/community';
+import { test_Alice_2W, test_Alice_2W_Bob_1W } 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';
+
+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
+  await clickOnTestIdWithText(
+    aliceWindow2,
+    'module-conversation__user__profile-name',
+    testCommunityName,
+  );
+});
+
+test_Alice_2W_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([
+      clickOnTestIdWithText(aliceWindow1, 'scroll-to-bottom-button'),
+      clickOnTestIdWithText(bobWindow1, 'scroll-to-bottom-button'),
+    ]);
+    await sendMessage(aliceWindow1, testMessage);
+    // Check linked device for community
+    await clickOnTestIdWithText(
+      aliceWindow1,
+      'module-conversation__user__profile-name',
+      testCommunityName,
+    );
+    await aliceWindow1.setInputFiles(
+      "input[type='file']",
+      'fixtures/test-image.png',
+    );
+    await typeIntoInput(
+      aliceWindow1,
+      'message-input-text-area',
+      testImageMessage,
+    );
+    await clickOnTestIdWithText(aliceWindow1, 'send-message-button');
+    await replyTo({
+      senderWindow: bobWindow1,
+      textMessage: testImageMessage,
+      replyText: testReply,
+      receiverWindow: aliceWindow1,
+    });
+  },
+);

tests/automation/constants/community.ts

@@ -0,0 +1,3 @@
+export const testCommunityLink =
+  'https://chat.lokinet.dev/testing-all-the-things?public_key=1d7e7f92b1ed3643855c98ecac02fc7274033a3467653f047d6e433540c03f17';
+export const testCommunityName = 'Testing All The Things!';