desktop: add tests (#6900)

* desktop: add tests

* ci: fix install packages step

* ci: set NOTESNOOK_STAGING env

* ci: fix working dir

* ci: use cross-env on windows

* desktop: fix tests

* ci: use `xvfb-run` on linux

* ci: install playwright deps

* ci: remove DEBUG=pw*

* ci: no need to install playwright deps

.github/workflows/desktop.tests.yml

@@ -0,0 +1,171 @@
+name: Test @notesnook/desktop
+
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - "master"
+    paths:
+      - "app/desktop/**"
+      # re-run workflow if workflow file changes
+      - ".github/workflows/desktop.tests.yml"
+  pull_request:
+
+jobs:
+  build:
+    name: Build
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Node
+        uses: ./.github/actions/setup-node-with-cache
+
+      - name: Install packages
+        run: |
+          npm ci --ignore-scripts --prefer-offline --no-audit
+          npm run bootstrap -- --scope=web
+
+      - name: Setup environment
+        run: |
+          echo "NX_CLOUD_ACCESS_TOKEN=${{ secrets.NX_CLOUD_ACCESS_TOKEN }}" >> $GITHUB_ENV
+
+      - name: Generate desktop build
+        run: npx nx build:desktop @notesnook/web
+
+      - name: Archive build artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: build
+          path: apps/web/build/**/*
+
+  test-macos:
+    name: Test macOS
+    needs: build
+    runs-on: macos-latest
+
+    steps:
+      - name: Check out Git repository
+        uses: actions/checkout@v4
+
+      - name: Setup Node
+        uses: ./.github/actions/setup-node-with-cache
+
+      - name: Install setuptools
+        run: brew install python-setuptools
+
+      - name: Setup notarization
+        run: |
+          mkdir -p ~/private_keys/
+          echo '${{ secrets.api_key }}' > ~/private_keys/AuthKey_${{ secrets.api_key_id }}.p8
+
+      - name: Collect app metadata
+        id: app_metadata
+        working-directory: ./apps/desktop
+        run: |
+          echo ::set-output name=apple_app_id::$(cat package.json | jq -r .appAppleId)
+          echo ::set-output name=app_bundle_id::$(cat package.json | jq -r .build.appId)
+          echo ::set-output name=app_version::$(cat package.json | jq -r .version)
+          echo ::set-output name=bundle_version::$(cat package.json | jq -r .build.mac.bundleVersion)
+
+      - name: Download build
+        uses: actions/download-artifact@v4
+        with:
+          name: build
+          path: ./apps/web/build
+
+      - name: Install packages
+        run: |
+          npm ci --ignore-scripts --prefer-offline --no-audit
+          npm run bootstrap -- --scope=desktop
+          npx nx run release --project @notesnook/desktop
+
+      - name: Install provisioning profile
+        run: echo "${{ secrets.MAC_PROVISIONING_PROFILE }}" | base64 --decode > embedded.provisionprofile
+        working-directory: ./apps/desktop
+
+      - name: Build app
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          CSC_LINK: ${{ secrets.mac_certs }}
+          CSC_KEY_PASSWORD: ${{ secrets.mac_certs_password }}
+          APPLE_API_KEY: ~/private_keys/AuthKey_${{ secrets.api_key_id }}.p8
+          APPLE_API_KEY_ID: ${{ secrets.api_key_id }}
+          APPLE_API_ISSUER: ${{ secrets.api_key_issuer_id }}
+        run: |
+          yarn electron-builder --mac --dir --arm64 --x64
+        working-directory: ./apps/desktop
+
+      - name: Run tests
+        run: |
+          EXECUTABLE_PATH=output/mac-arm64/Notesnook.app/Contents/MacOS/Notesnook npm run test
+        working-directory: ./apps/desktop
+
+  test-linux:
+    name: Test for Linux
+    needs: build
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Check out Git repository
+        uses: actions/checkout@v4
+
+      - name: Setup Node
+        uses: ./.github/actions/setup-node-with-cache
+
+      - name: Download build
+        uses: actions/download-artifact@v4
+        with:
+          name: build
+          path: ./apps/web/build
+
+      - name: Install packages
+        run: |
+          npm ci --ignore-scripts --prefer-offline --no-audit
+          npm run bootstrap -- --scope=desktop
+          npx nx run release --project @notesnook/desktop
+
+      - name: Build app
+        run: |
+          yarn electron-builder --linux --dir --arm64 --x64
+        working-directory: ./apps/desktop
+
+      - name: Run tests
+        run: |
+          EXECUTABLE_PATH=output/linux-unpacked/notesnook xvfb-run --auto-servernum --server-args="-screen 0 1920x1080x24" -- npm run test
+        working-directory: ./apps/desktop
+
+  test-windows:
+    name: Test for Windows
+    needs: build
+    runs-on: windows-latest
+
+    steps:
+      - name: Check out Git repository
+        uses: actions/checkout@v4
+
+      - name: Setup Node
+        uses: ./.github/actions/setup-node-with-cache
+
+      - name: Download build
+        uses: actions/download-artifact@v4
+        with:
+          name: build
+          path: ./apps/web/build
+
+      - name: Install packages
+        run: |
+          npm ci --ignore-scripts --prefer-offline --no-audit
+          npm run bootstrap -- --scope=desktop
+          npx nx run release --project @notesnook/desktop
+
+      - name: Build app
+        run: |
+          npx cross-env NOTESNOOK_STAGING=true yarn electron-builder --win --dir --arm64 --x64
+        working-directory: ./apps/desktop
+
+      - name: Run tests
+        run: |
+          npx cross-env EXECUTABLE_PATH=output/win-unpacked/Notesnook.exe npm run test
+        working-directory: ./apps/desktop

apps/desktop/__tests__/launch.test.mjs

@@ -0,0 +1,40 @@
+/*
+This file is part of the Notesnook project (https://notesnook.com/)
+
+Copyright (C) 2023 Streetwriters (Private) Limited
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.
+*/
+
+import test from "node:test";
+import { launchApp } from "./utils.mjs";
+import assert from "assert";
+
+test("make sure app loads", async () => {
+  const { app, page } = await launchApp();
+
+  await page.waitForSelector("#authForm");
+
+  assert.ok(
+    await page.getByRole("button", { name: "Create account" }).isVisible()
+  );
+
+  await page
+    .getByRole("button", { name: "Skip & go directly to the app" })
+    .click();
+
+  await page.waitForSelector(".ProseMirror");
+
+  await app.close();
+});

apps/desktop/__tests__/utils.mjs

@@ -0,0 +1,38 @@
+/*
+This file is part of the Notesnook project (https://notesnook.com/)
+
+Copyright (C) 2023 Streetwriters (Private) Limited
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.
+*/
+
+import { _electron as electron } from "playwright";
+
+const executablePath = process.env.EXECUTABLE_PATH;
+
+// process.platform === "linux"
+//   ? "output/linux-unpacked/Notesnook"
+//   : process.platform === "darwin"
+//   ? "output/mac/Notesnook.app/Contents/MacOS/Notesnook"
+//   : "output/win-unpacked/Notesnook.exe";
+
+export async function launchApp() {
+  const app = await electron.launch({
+    executablePath
+  });
+
+  const page = await app.firstWindow();
+
+  return { app, page };
+}

apps/desktop/package.json

@@ -48,9 +48,11 @@
     "esbuild": "^0.24.0",
     "node-abi": "^3.68.0",
     "node-gyp-build": "^4.8.2",
+    "playwright": "^1.48.2",
     "prebuildify": "^6.0.1",
     "tree-kill": "^1.2.2",
-    "undici": "^6.19.8"
+    "undici": "^6.19.8",
+    "vitest": "^2.1.5"
   },
   "optionalDependencies": {
     "dmg-license": "^1.0.11"
@@ -62,7 +64,8 @@
     "build": "node ../../scripts/build.mjs",
     "bundle": "esbuild electron=./src/main.ts ./src/preload.ts --external:electron --external:fsevents --external:better-sqlite3-multiple-ciphers --external:sodium-native --minify --bundle --outdir=./build --platform=node --tsconfig=tsconfig.json --define:MAC_APP_STORE=false --define:RELEASE=true",
     "bundle:mas": "esbuild electron=./src/main.ts ./src/preload.ts --minify --external:electron --external:fsevents --bundle --outdir=./build --platform=node --tsconfig=tsconfig.json --define:MAC_APP_STORE=true --define:RELEASE=true",
-    "postinstall": "patch-package"
+    "postinstall": "patch-package",
+    "test": "node --test"
   },
   "author": {
     "name": "Streetwriters (Private) Limited",
@@ -94,8 +97,12 @@
       "node_modules/sqlite-better-trigram",
       "node_modules/sodium-native/prebuilds/${platform}-${arch}",
       {
-        "from": "node_modules/sqlite-better-trigram-${platform}-${arch}",
+        "from": "node_modules/sqlite-better-trigram-linux-${arch}",
-        "to": "node_modules/sqlite-better-trigram-${platform}-${arch}"
+        "to": "node_modules/sqlite-better-trigram-linux-${arch}"
+      },
+      {
+        "from": "node_modules/sqlite-better-trigram-darwin-${arch}",
+        "to": "node_modules/sqlite-better-trigram-darwin-${arch}"
       },
       {
         "from": "node_modules/sqlite-better-trigram-windows-${arch}",