Merge pull request #1411 from session-foundation/release/1.16.0

Session 1.16.0

Author: Bilb

.github/workflows/build-binaries.yml

@@ -22,8 +22,9 @@ concurrency:
   cancel-in-progress: true
 
 env:
-  # we want to publish on "push to master" only. When we don't want to publish, we want to upload artefacts
+  # we only want to publish on "push to master" or alpha releases. When we don't want to publish, we want to upload artefacts
   SHOULD_PUBLISH: ${{ github.event_name == 'push' && github.ref == 'refs/heads/master' }}
+  SHOULD_PUBLISH_ALPHA: ${{ github.event_name == 'push' && startsWith(github.ref, 'refs/heads/release') && contains(github.ref, '-alpha.') }}
 
 jobs:
   build_linux:
@@ -49,7 +50,7 @@ jobs:
 
       - name: Lint Files
         # no need to lint files on all platforms
-        run: yarn lint-full
+        run: yarn lint
 
       - name: Enforce yarn.lock has no duplicates
         uses: ./actions/deduplicate_fail
@@ -58,43 +59,42 @@ jobs:
       - name: Unit Test
         run: yarn test
 
-      - name: Build but do not publish ${{ matrix.pkg_to_build }}
-        # we want this to run always, except on "push" to "master"
-        if: ${{ env.SHOULD_PUBLISH == 'false' }}
+      - name: Make release build but do not publish ${{ matrix.pkg_to_build }}
+        # always run this, except on "push" to "master" or alpha releases
+        if: ${{ env.SHOULD_PUBLISH == 'false' && env.SHOULD_PUBLISH_ALPHA == 'false'  }}
         run: |
           sed -i 's/"target": "deb"/"target": "${{ matrix.pkg_to_build }}"/g' package.json && yarn build-release
 
       - name: Upload artefacts ${{ matrix.pkg_to_build }}
-        # we want this to run always, except on "push" to "master"
-        if: ${{ env.SHOULD_PUBLISH == 'false' }}
+        # always run this, except on "push" to "master" or alpha releases
+        if: ${{ env.SHOULD_PUBLISH == 'false' && env.SHOULD_PUBLISH_ALPHA == 'false'  }}
         uses: ./actions/upload_prod_artefacts
         with:
           upload_prefix: ${{ runner.os }}-${{ runner.arch }}-${{ matrix.pkg_to_build }}
 
-      - name: Build & publish ${{ matrix.pkg_to_build }}
-        # we want this to run only when on "push" to "master"
-        if: ${{ env.SHOULD_PUBLISH == 'true' }}
+      - name: Make release build & publish ${{ matrix.pkg_to_build }}
+        # only run this on "push" to "master" or alpha releases
+        if: ${{ env.SHOULD_PUBLISH == 'true' || env.SHOULD_PUBLISH_ALPHA == 'true' }}
         run: |
           sed -i 's/"target": "deb"/"target": "${{ matrix.pkg_to_build }}"/g' package.json && yarn build-release-publish
 
-      - name: Backup AppImage latest-linux.yml file
-        # only run this on "push" to "master"
-        # Note: only AppImage can auto update via electron-builder on linux.continue-on-error.
-        # Note: We need to backup the latest-linux appImage file as other builds are overwriting it when they finish
-        # after the AppImage build
-        if: ${{ env.SHOULD_PUBLISH == 'true' && matrix.pkg_to_build == 'AppImage' }}
+      - name: Backup release metadata
+        # only run this on "push" to "master" or alpha releases
+        # Note: The jobs are overwriting each other's latest-linux.yml.
+        # So, we upload all of them as artifacts, and then merge them (see `post_build_linux`)
+        # note: freebsd does not generate a latest-linux.yml file so we exclude it
+        if: ${{ (env.SHOULD_PUBLISH == 'true' || env.SHOULD_PUBLISH_ALPHA == 'true') && matrix.pkg_to_build != 'freebsd' }}
         shell: bash
         run: |
-          mv dist/latest-linux.yml dist/latest-linux-${{ matrix.pkg_to_build }}.yml
+          mv dist/latest-linux.yml dist/latest-linux-${{ matrix.pkg_to_build }}-${{ github.sha }}.yml
 
       - name: Upload release metadata
-        # only run this on "push" to "master"
-        # Check the details of why we need this above (and why only for AppImage)
-        if: ${{ env.SHOULD_PUBLISH == 'true' && matrix.pkg_to_build == 'AppImage' }}
+        # only run this on "push" to "master" or alpha releases
+        if: ${{ (env.SHOULD_PUBLISH == 'true' || env.SHOULD_PUBLISH_ALPHA == 'true') && matrix.pkg_to_build != 'freebsd' }}
         uses: actions/upload-artifact@v4
         with:
-          name: latest-linux-${{ matrix.pkg_to_build }}.yml
-          path: dist/latest-linux-${{ matrix.pkg_to_build }}.yml
+          name: latest-linux-${{ matrix.pkg_to_build }}-${{ github.sha }}.yml
+          path: dist/latest-linux-${{ matrix.pkg_to_build }}-${{ github.sha }}.yml
 
   post_build_linux:
     needs: [build_linux]
@@ -103,45 +103,50 @@ jobs:
       GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
     steps:
       - name: Checkout git repo
-        # only run this on "push" to "master"
-        if: ${{ env.SHOULD_PUBLISH == 'true' }}
+        # only run this on "push" to "master" or alpha releases
+        if: ${{ env.SHOULD_PUBLISH == 'true' || env.SHOULD_PUBLISH_ALPHA == 'true' }}
         uses: actions/checkout@v4
-        # We only need the package.json file in this run (to extract the version being built)
+        # We only need a few files in this run, no point cloning everything
         with:
           sparse-checkout: |
             package.json
+            build/setup-release-combine.sh
+            build/release-notes.md
+            build/release-notes-alpha.md
           sparse-checkout-cone-mode: false
 
       - name: Get version tag from package.json
         id: get_version
-        # only run this on "push" to "master"
-        if: ${{ env.SHOULD_PUBLISH == 'true' }}
+        # only run this on "push" to "master" or alpha releases
+        if: ${{ env.SHOULD_PUBLISH == 'true' || env.SHOULD_PUBLISH_ALPHA == 'true' }}
         run: |
           version=$(node -p "require('./package.json').version")
           echo "VERSION_TAG=$version" >> "$GITHUB_OUTPUT"
 
       - name: Download release metadata
-        # only run this on "push" to "master"
-        if: ${{ env.SHOULD_PUBLISH == 'true' }}
+        # only run this on "push" to "master" or alpha releases
+        if: ${{ env.SHOULD_PUBLISH == 'true' || env.SHOULD_PUBLISH_ALPHA == 'true' }}
         uses: actions/download-artifact@v4
         with:
-          name: latest-linux-AppImage.yml
+          pattern: latest-linux-*-${{ github.sha }}.yml
           path: dist
+          merge-multiple: true
 
-      - name: Rename
-        # only run this on "push" to "master"
-        if: ${{ env.SHOULD_PUBLISH == 'true'  }}
+      - name: Combine release metadata
+        # only run this on "push" to "master" or alpha releases
+        if: ${{ env.SHOULD_PUBLISH == 'true' || env.SHOULD_PUBLISH_ALPHA == 'true' }}
         run: |
-          mv dist/latest-linux-AppImage.yml dist/latest-linux.yml
+          ./build/setup-release-combine.sh ${{ github.sha }} linux
 
       - name: Upload changes to draft release
-        # only run this on "push" to "master"
-        if: ${{ env.SHOULD_PUBLISH == 'true' }}
+        # only run this on "push" to "master" or alpha releases
+        if: ${{ env.SHOULD_PUBLISH == 'true' || env.SHOULD_PUBLISH_ALPHA == 'true' }}
         uses: ncipollo/release-action@v1
         with:
           tag: v${{ steps.get_version.outputs.VERSION_TAG }}
           draft: true
           name: 'Draft'
+          bodyFile: ${{ env.SHOULD_PUBLISH_ALPHA == 'true' && 'build/release-notes-alpha.md' || 'build/release-notes.md' }}
           artifacts: 'dist/latest-linux.yml'
           allowUpdates: true
           omitNameDuringUpdate: true
@@ -167,26 +172,56 @@ jobs:
       - name: Unit Test
         run: yarn test
 
-      - name: Build but do not publish
-        # we want this to run always, except on "push" to "master"
-        if: ${{ env.SHOULD_PUBLISH == 'false' }}
+      - name: Make release build but do not publish
+        # always run this, except on "push" to "master" or alpha releases
+        if: ${{ env.SHOULD_PUBLISH == 'false' && env.SHOULD_PUBLISH_ALPHA == 'false'  }}
         run: yarn build-release
 
       - name: Upload artefacts
-        # we want this to run always, except on "push" to "master"
-        if: ${{ env.SHOULD_PUBLISH == 'false' }}
+        # always run this, except on "push" to "master" or alpha releases
+        if: ${{ env.SHOULD_PUBLISH == 'false' && env.SHOULD_PUBLISH_ALPHA == 'false'  }}
         uses: ./actions/upload_prod_artefacts
         with:
           upload_prefix: ${{ runner.os }}-${{ runner.arch }}
 
-      - name: Build & publish
-        # we want this to run only when on "push" to "master"
-        if: ${{ env.SHOULD_PUBLISH == 'true' }}
+      - name: Make release build & publish
+        # only run this on "push" to "master" or alpha releases
+        if: ${{ env.SHOULD_PUBLISH == 'true' || env.SHOULD_PUBLISH_ALPHA == 'true' }}
         run: yarn build-release-publish # No other args needed for windows publish
 
-  # We want a mac arm64 build, and according to this https://github.com/actions/runner-images#available-images macos-14 is always arm64
-  # macos-14 is disabled for now as we hit our free tier limit for macos builds
-  build_macos_x64:
+  # We want both arm64 and intel mac builds, and according to this https://docs.github.com/en/actions/using-github-hosted-runners/using-github-hosted-runners/about-github-hosted-runners#supported-runners-and-hardware-resources macos-14 and above is always arm64 and macos-13 is the last intel runner
+  # NOTE x64 builds made on an arm64 host will not bundle the native modules correctly https://github.com/electron-userland/electron-builder/issues/8646
+  build_mac_arm64:
+    runs-on: macos-14
+    env:
+      GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      MAC_CERTIFICATE: ${{ secrets.MAC_CERTIFICATE }}
+      MAC_CERTIFICATE_PASSWORD: ${{ secrets.MAC_CERTIFICATE_PASSWORD }}
+      SIGNING_APPLE_ID: ${{ secrets.SIGNING_APPLE_ID }}
+      SIGNING_APP_PASSWORD: ${{ secrets.SIGNING_APP_PASSWORD }}
+      SIGNING_TEAM_ID: ${{ secrets.SIGNING_TEAM_ID }}
+    steps:
+      - run: git config --global core.autocrlf false
+
+      - name: Checkout git repo
+        uses: actions/checkout@v4
+
+      - name: Setup & Build
+        uses: ./actions/setup_and_build
+        with:
+          cache_suffix: mac-arm64
+
+        # we want to test on all platforms since some are testing the rendered menus (and are dependent on the platform)
+      - name: Unit Test
+        run: yarn test
+
+      - name: Make release build arm64
+        uses: ./actions/make_release_build
+        with:
+          architecture: arm64
+          should_publish: ${{ env.SHOULD_PUBLISH == 'true' || env.SHOULD_PUBLISH_ALPHA == 'true' }}
+
+  build_mac_x64:
     runs-on: macos-13
     env:
       GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
@@ -204,29 +239,66 @@ jobs:
       - name: Setup & Build
         uses: ./actions/setup_and_build
         with:
-          cache_suffix: 'macos_x64'
+          cache_suffix: mac-x64
 
         # we want to test on all platforms since some are testing the rendered menus (and are dependent on the platform)
       - name: Unit Test
         run: yarn test
 
-      - name: Build but do not publish
-        # we want this to run always, except on "push" to "master"
-        if: ${{ env.SHOULD_PUBLISH == 'false' }}
+      - name: Make release build x64
+        uses: ./actions/make_release_build
+        with:
+          architecture: x64
+          should_publish: ${{ env.SHOULD_PUBLISH == 'true' || env.SHOULD_PUBLISH_ALPHA == 'true' }}
+
+  post_build_mac:
+    needs: [build_mac_arm64, build_mac_x64]
+    runs-on: ubuntu-22.04
+    steps:
+      - name: Checkout git repo
+        # only run this on "push" to "master" or alpha releases
+        if: ${{ env.SHOULD_PUBLISH == 'true' || env.SHOULD_PUBLISH_ALPHA == 'true' }}
+        uses: actions/checkout@v4
+        # We only need the package.json file in this run (to extract the version being built)
+        with:
+          sparse-checkout: |
+            package.json
+            build/setup-release-combine.sh
+
+      - name: Get version tag from package.json
+        id: get_version
+        # only run this on "push" to "master" or alpha releases
+        if: ${{ env.SHOULD_PUBLISH == 'true' || env.SHOULD_PUBLISH_ALPHA == 'true' }}
         run: |
-          source ./build/setup-mac-certificate.sh
-          yarn build-release --config.mac.bundleVersion=${{ github.ref }}
+          version=$(node -p "require('./package.json').version")
+          echo "VERSION_TAG=$version" >> "$GITHUB_OUTPUT"
 
-      - name: Upload artefacts
-        # we want this to run always, except on "push" to "master"
-        if: ${{ env.SHOULD_PUBLISH == 'false' }}
-        uses: ./actions/upload_prod_artefacts
+      - name: Download release metadata
+        # only run this on "push" to "master" or alpha releases
+        if: ${{ env.SHOULD_PUBLISH == 'true' || env.SHOULD_PUBLISH_ALPHA == 'true' }}
+        uses: actions/download-artifact@v4
         with:
-          upload_prefix: ${{ runner.os }}-${{ runner.arch }}
+          pattern: latest-mac-*-${{ github.sha }}.yml
+          path: dist
+          merge-multiple: true
 
-      - name: Build & publish
-        # we want this to run only when on "push" to "master"
-        if: ${{ env.SHOULD_PUBLISH == 'true' }}
+      - name: Combine release metadata
+        # only run this on "push" to "master" or alpha releases
+        if: ${{ env.SHOULD_PUBLISH == 'true' || env.SHOULD_PUBLISH_ALPHA == 'true' }}
         run: |
-          source ./build/setup-mac-certificate.sh
-          yarn build-release-publish --config.mac.bundleVersion=${{ github.ref }}
+          ./build/setup-release-combine.sh ${{ github.sha }} mac
+
+      - name: Upload changes to draft release
+        # only run this on "push" to "master" or alpha releases
+        if: ${{ env.SHOULD_PUBLISH == 'true' || env.SHOULD_PUBLISH_ALPHA == 'true' }}
+        uses: ncipollo/release-action@v1
+        with:
+          tag: v${{ steps.get_version.outputs.VERSION_TAG }}
+          draft: true
+          name: 'Draft'
+          artifacts: 'dist/latest-mac.yml'
+          allowUpdates: true
+          omitBodyDuringUpdate: true
+          omitNameDuringUpdate: true
+          replacesArtifacts: true
+          updateOnlyUnreleased: true

.gitignore

@@ -37,6 +37,7 @@ yarn-error.log
 # editor
 .vscode/
 .vscrof/
+.idea/
 
 
 playwright.config.js

CONTRIBUTING.md

@@ -284,6 +284,20 @@ We use the `python3` command for many of our scripts. If you have installed Pyth
 
 </details>
 
+<details>
+<summary><em>...(mach-o file, but is an incompatible architecture (have 'x86_64', need 'arm64'))...</em></summary>
+
+> **TLDR**
+> If you are using VS Code, check the architecture of your integrated terminal by running `uname -m` in it.
+> This also applies to NodeJS installations. Check with `node -p process.arch`.
+> If the architecture doesn't match your host operating system Session will fail to run.
+
+Are you using Visual Studio Code? Make sure that your installation matches your host operating system. For example if your device is `arm64` make sure the VS Code installation is not `x86_64`. If they do not match and you are using VS Code's integrated terminal, it will run on the architecture of the VS Code installation. Therefore if you installed NodeJS or adding packages via the integrated terminal, it will use the wrong architecture and not match your host system. You can check the architecture of your NodeJS installation by running `node -p process.arch` in the terminal.
+
+This error comes from when you build Session's native modules e.g. `better-sqlite3`, `libsession_util_nodejs`, they have been compiled for the wrong cpu architecture.
+
+</details>
+
 ## Hot reloading
 
 More often than not, you'll need to restart the application regularly to see your changes, as there

README.md

@@ -12,13 +12,13 @@ Session integrates directly with [Oxen Service Nodes](https://docs.oxen.io/about
 
 ## Want to Contribute? Found a Bug or Have a feature request?
 
-Please search for any [existing issues](https://github.com/session-foundation/session-desktop/issues) that describe your bug in order to avoid duplicate submissions.
+Please search for any [existing issues](https://github.com/session-foundation/session-desktop/issues) that describe your bug or feature request to avoid duplicate submissions.
 
 Submissions can be made by making a pull request to our development branch.If you don't know where to start contributing please read [Contributing.md](CONTRIBUTING.md) and refer to issues tagged with the [good-first-issue](https://github.com/session-foundation/session-desktop/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22) tag.
 
 ## Supported platforms
 
-Session requires Windows 10 or later, macOS Ventura (13) or later, or a Linux distribution with glibc 2.28 or later like Debian 10 or Ubuntu 22.04.
+Check Session's system requirements and what platforms are supported [here](https://github.com/session-foundation/session-desktop/releases/latest#user-content-supported-platforms).
 
 ## Build instructions
 

_locales/af/messages.json

@@ -250,7 +250,6 @@
   "copy": "Kopieer",
   "create": "Skep",
   "cut": "Sny",
-  "databaseErrorGeneric": "’n Databasisfout het voorgekom.<br/><br/>Voer jou toepassingslogboeke uit om te deel vir foutsporing. Indien dit onsuksesvol is, herinstalleer Session en herstel jou rekening.<br/><br/>Waarskuwing: Dit sal lei tot die verlies van alle boodskappe, aanhegsels, en rekeningdata ouer as twee weke.",
   "databaseErrorTimeout": "Ons het opgemerk Session neem lank om te begin.<br/><br/>Jy kan aanhou wag, jou toestel logs uitvoer om te deel vir foutsporing, of probeer om Session te herbegin.",
   "databaseErrorUpdate": "Jou app databasis is onversoenbaar met hierdie weergawe van Session. Herinstalleer die app en herstel jou rekening om 'n nuwe databasis te genereer en voort te gaan met die gebruik van Session.<br/><br/>Waarskuwing: Dit sal lei tot die verlies van alle boodskappe en aanhegsels ouer as twee weke.",
   "databaseOptimizing": "Optimalisering databasis",
@@ -371,7 +370,6 @@
   "groupCreate": "Skep Groep",
   "groupCreateErrorNoMembers": "Kies ten minste een ander groep lid.",
   "groupDelete": "Skrap Groep",
-  "groupDeleteDescription": "Is jy seker jy wil <b>{group_name}</b> verwyder? Dit sal alle lede verwyder en alle groepinhoud skrap.",
   "groupDescriptionEnter": "Voer 'n groep beskrywing in",
   "groupDisplayPictureUpdated": "Groep vertoon prent opgedateer.",
   "groupEdit": "Wysig Groep",

_locales/ar/messages.json

@@ -252,7 +252,6 @@
   "copy": "نسخ",
   "create": "إنشاء",
   "cut": "قص",
-  "databaseErrorGeneric": "حدث خطأ في قاعدة البيانات.<br/> <br/> صدر سجلات التطبيق الخاصة بك للمشاركة في استكشاف الأخطاء وإصلاحها. إذا لم ينجح ذلك، أعد تثبيت Session واستعد حسابك. <br/> <br/>تحذير: سيؤدي ذلك إلى فقدان جميع الرسائل والمرفقات وبيانات الحساب التي يزيد عمرها عن أسبوعين.",
   "databaseErrorTimeout": "لقد لاحظنا أن Session يستغرق وقتًا طويلاً لبدء.<br/><br/>يمكنك مواصلة الانتظار، تصدير سجلات الجهاز للمشاركة في استكشاف الأخطاء وإصلاحها، أو محاولة إعادة تشغيل Session.",
   "databaseErrorUpdate": "قاعدة بيانات تطبيقك غير متوافقة مع هذا الإصدار من Session. أعد تثبيت التطبيق واستعد حسابك لإنشاء قاعدة بيانات جديدة ومتابعة استخدام Session.<br/><br/>تحذير: سيؤدي هذا إلى فقدان جميع الرسائل والمرفقات التي يزيد عمرها عن أسبوعين.",
   "databaseOptimizing": "تحسين قاعدة البيانات",
@@ -375,7 +374,6 @@
   "groupCreate": "إنشاء مجموعة",
   "groupCreateErrorNoMembers": "الرجاء إختيار عضو اخر على الأقل.",
   "groupDelete": "حذف مجموعة",
-  "groupDeleteDescription": "هل أنت متأكد من حذف <b>{group_name}؟</b> سيؤدي ذلك إلى إزالة جميع الأعضاء وحذف كافة محتويات المجموعة.",
   "groupDeletedMemberDescription": "{group_name} تم حذفه بواسطة مشرف المجموعة. لن تتمكن من إرسال أي رسائل أخرى.",
   "groupDescriptionEnter": "أدخل وصف للمجموعة",
   "groupDisplayPictureUpdated": "تم تحديث صورة العرض للمجموعة.",