feat(2759): Add QSS sigchain syncing to Quiet (#2877)

* Add dotenvx

* Pass on env variables to backend

* First connection to QSS

* Initial sigchain sync with qss

* Ongoing sync (no admittance yet)

* Don't add member role to server

* Fixes for joining and syncing via qss

* Cleanup

* First round of tests

* QSS endpoint can only be set via manual environment variable

* add qss submodule

* Update qss

* Package json updates

* Small fixes and reliable running of qss on e2e tests

* Mostly working

* Fix qss e2e test and make joining more reliable

* Consolidate logic

* Clean up qss auth connections and more consolidation

* stashing

* Post merge fixes/updates

* Cleanup

* Remove encryption and fix bug related to failing to connect to qss

* Update package-lock.json

* Update changelogs

* Update test snapshots

* Add QSS e2e test to github

* Start qss docker on e2e tests

* Update qss

* Separate qss tests and only run on linux

* Update variable check

* Fix state manager unit test

* Bump backwards compatibility version

* Add qss unit tests and mild tweaks to QSS logic

* Use windows-2025 runner in place of deprecated windows-2019 runner

* Hopefully fix backwards compat test issue

* Update add chain and add comments to QSS code

* Update backwards compatibility test

* Split out backwards compatibility test since its the most unstable

* Cleanup

* Take a screenshot

* Fix

* Don't write file

* Update backwardsCompatibility.test.ts

* Add submodule pull to bootstrap

* Update qss

* Use correct orbitdb version

* Update package-lock.json

* Handle team ID to name mapping in the qss logic

* Fix bootstrap

* Fixes post merge

* Fix snapshots

* Update e2e-mac.yml

* Fix invite link test

Author: islathehut

.github/actions/setup-env/action.yml

@@ -4,6 +4,10 @@ inputs:
   bootstrap-packages:
     description: 'Lerna bootstrap packages (comma separated without spaces)'
     required: false
+  install-docker:
+    description: 'Install and setup docker/docker compose'
+    required: false
+    default: false
   cachePrefix:
     description: 'For correct caching'
     required: false
@@ -22,6 +26,12 @@ runs:
       with:
         python-version: 3.12
 
+    - name: Set up Docker
+      uses: docker/setup-docker-action@v4
+      if: ${{ inputs.install-docker == true || inputs.install-docker == 'true' }}
+      with:
+        version: version=28.1.1
+
     - name: Print python version
       run: which python3
       if: runner.os == 'macOS'

.github/workflows/e2e-crossplatform.yml

@@ -16,10 +16,10 @@ jobs:
     uses: ./.github/workflows/e2e-mac.yml
   linux:
     uses: ./.github/workflows/e2e-linux.yml
-  # separated out from other linux tests since this fails the most
+  linux-qss:
+    uses: ./.github/workflows/e2e-qss-linux.yml
   linux-back-compat:
     uses: ./.github/workflows/e2e-back-compat-linux.yml
-  # the windows runners are garbage and always fail on long running tests (sometimes don't even make it past setup)
   # windows:
   #   uses: ./.github/workflows/e2e-win.yml
 

.github/workflows/e2e-mac.yml

@@ -18,6 +18,7 @@ jobs:
       - name: "Setup environment"
         uses: ./.github/actions/setup-env
         with:
+          install-docker: false
           cachePrefix: "e2e-crossplatform-mac"
           bootstrap-packages: "@quiet/eslint-config,@quiet/logger,@quiet/common,@quiet/types,@quiet/state-manager,@quiet/backend,@quiet/identity,@quiet/desktop,backend-bundle,e2e-tests,helia,@quiet/node-common"
 

.github/workflows/e2e-qss-linux.yml

@@ -0,0 +1,82 @@
+name: E2E with QSS linux
+
+on: [workflow_call]
+jobs:
+
+  linux:
+    runs-on: ${{ matrix.os }}
+
+    strategy:
+      matrix:
+        os: [ubuntu-22.04]
+
+    timeout-minutes: 180
+
+    env:
+      DISPLAY: ":99.0"
+      TEST_MODE: true
+      IS_CI: true
+
+    steps:
+      - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
+        with:
+          submodules: 'recursive'
+
+      - name: Extract version
+        id: extract_version
+        uses: Saionaro/extract-package-version@fdb5b74adc1278ddb777dfed4c988b9d098bb48d # v1.2.1
+        with:
+          path: packages/mobile
+
+      - name: Check for major version
+        id: major-ver
+        run: |
+          echo ${{ steps.extract_version.outputs.version }}
+          if [[ "${{ steps.extract_version.outputs.version }}" =~ ^[[:digit:]]+\.0\.0(-alpha.[[:digit:]]+)?$ ]]; then
+              echo "This is a major version"
+              echo "match=true" >> $GITHUB_OUTPUT
+          else
+              echo "This is NOT a major version"
+              echo "match=false" >> $GITHUB_OUTPUT
+          fi
+
+      - name: Install WM
+        run: sudo apt install fluxbox
+
+      - name: Install libfuse2
+        run: sudo apt install libfuse2
+
+      - name: "Setup environment"
+        uses: ./.github/actions/setup-env
+        with:
+          install-docker: true
+          cachePrefix: "e2e-crossplatform-linux-qss"
+          bootstrap-packages: "@quiet/eslint-config,@quiet/logger,@quiet/common,@quiet/types,@quiet/state-manager,@quiet/backend,@quiet/identity,@quiet/desktop,backend-bundle,e2e-tests,helia,@quiet/node-common"
+
+      - name: Start QSS docker
+        run: npm run start:qss
+        
+      - name: Run X11
+        run: |
+          Xvfb :99 -screen 0 1920x1080x24 &
+          sleep 3
+          fluxbox &
+
+      - name: Build App Image
+        working-directory: ./packages/desktop
+        run: npm run distUbuntu && VERSION=$(jq -r ".version" package.json) && cd dist && FILE_NAME=$(ls | grep $VERSION) && echo "FILE_NAME=$(ls | grep $VERSION)" >> $GITHUB_ENV && cp $FILE_NAME ../../e2e-tests/Quiet && export FILE_NAME=$FILE_NAME
+
+      - name: Chmod
+        working-directory: ./packages/e2e-tests/Quiet
+        run: chmod +x $FILE_NAME
+
+      - name: Run multiple clients with QSS test
+        uses: nick-fields/retry@14672906e672a08bd6eeb15720e9ed3ce869cdd4 # v2.9.0
+        with:
+          timeout_minutes: 25
+          max_attempts: 3
+          command: cd packages/e2e-tests && npm run test multipleClients.qss.test.ts
+
+      - name: Stop QSS docker
+        if: always()
+        run: npm run stop:qss

.gitmodules

@@ -10,3 +10,7 @@
 	path = 3rd-party/orbitdb
 	url = https://github.com/TryQuiet/orbitdb.git
 	branch = main
+[submodule "3rd-party/qss"]
+	path = 3rd-party/qss
+	url = https://github.com/TryQuiet/quiet-storage-service.git
+	branch = feat/2759-adding-qss-to-sigchain