Beeper 1.96.1

.github/workflows/beeper-ci.yaml

@@ -0,0 +1,138 @@
+name: Beep
+
+on:
+  push:
+    branches: ["beeper", "beeper-*"]
+  pull_request:
+
+
+jobs:
+  lint-style:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-python@v2
+      - run: pip install poetry
+      - run: poetry install
+      - run: poetry run isort --check synapse
+      - run: poetry run black --check synapse
+
+  lint-types:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-python@v2
+      - run: pip install poetry
+      - run: poetry install --extras all
+      - run: poetry run mypy
+
+  # Tests
+
+  test-trial:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-python@v2
+      - run: pip install poetry
+      - run: poetry install --extras all
+      - run: poetry run trial -j4 tests
+
+  test-sytest:
+    runs-on: ubuntu-latest
+    container:
+      image: matrixdotorg/sytest-synapse:focal
+      volumes:
+        - ${{ github.workspace }}:/src
+      env:
+        SYTEST_BRANCH: 845764081c890180e3842f135f87e0aa778557a6
+        TOP: ${{ github.workspace }}
+        POSTGRES: 1
+        MULTI_POSTGRES: 1
+        WOKRERS: 1
+    steps:
+      - uses: actions/checkout@v2
+      - name: Run SyTest
+        run: /bootstrap.sh synapse
+        working-directory: /src
+      - name: Summarise results.tap
+        if: ${{ always() }}
+        run: /sytest/scripts/tap_to_gha.pl /logs/results.tap
+      - name: Upload SyTest logs
+        uses: actions/upload-artifact@v2
+        if: ${{ always() }}
+        with:
+          name: Sytest Logs - ${{ job.status }} - (${{ join(matrix.*, ', ') }})
+          path: |
+            /logs/results.tap
+            /logs/**/*.log*
+
+  test-complement:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/checkout@v2
+        with:
+          repository: matrix-org/complement
+          path: complement
+          ref: 39b3b9dbb2df96ca1df6b6ae86bdbc63fc96f39e
+      - name: Install complement dependencies
+        run: |-
+          sudo apt-get -qq update
+          sudo apt-get install -qqy libolm3 libolm-dev
+          go install -v github.com/gotesttools/gotestfmt/v2/cmd/gotestfmt@latest
+      - name: Run Complement
+        run: ./scripts-dev/complement.sh
+        env:
+          COMPLEMENT_DIR: complement
+
+  # Builds
+
+  build-python:
+    runs-on: ubuntu-latest
+    env:
+      DOCKER_BUILDKIT: 1
+    steps:
+      - uses: actions/checkout@v2
+      - uses: docker/setup-qemu-action@v2
+      - uses: docker/setup-buildx-action@v2
+        with:
+          # TEMPORARY, see: https://github.com/docker/build-push-action/issues/761
+          driver-opts: |
+            image=moby/buildkit:v0.10.6
+      - uses: docker/login-action@v2
+        with:
+          registry: ${{ secrets.CI_REGISTRY }}
+          username: ${{ secrets.CI_REGISTRY_USER }}
+          password: ${{ secrets.CI_REGISTRY_PASSWORD }}
+      - run: |-
+          if [ "${{ github.ref_name }}" = "beeper" ]; then
+            tag=$(cat pyproject.toml | grep -E "^version =" | sed -E 's/^version = "(.+)"$/\1/')
+          else
+            tag="${{ github.head_ref || github.ref_name }}"
+          fi
+
+          docker buildx build \
+            --push \
+            --platform linux/amd64 \
+            --tag ${{ secrets.CI_REGISTRY }}/synapse:$tag-${{ github.sha }} \
+            -f docker/Dockerfile \
+            .
+
+          if [ "${{ github.ref_name }}" = "beeper" ]; then
+            docker pull ${{ secrets.CI_REGISTRY }}/synapse:$tag-${{ github.sha }}
+            docker tag \
+              ${{ secrets.CI_REGISTRY }}/synapse:$tag-${{ github.sha }} \
+              ${{ secrets.CI_REGISTRY }}/synapse:latest
+            docker push ${{ secrets.CI_REGISTRY }}/synapse:latest
+          fi
+
+          # Ensure the image works properly
+          docker run \
+            --entrypoint '' \
+            ${{ secrets.CI_REGISTRY }}/synapse:$tag-${{ github.sha }} \
+            python -m synapse.app.homeserver --help
+
+          echo "Pushed image: synapse:$tag-${{ github.sha }}"
+          if [ "${{ github.ref_name }}" = "beeper" ]; then
+            echo "Pushed image: synapse:latest"
+          fi

README.md

@@ -0,0 +1,38 @@
+# Synapse: Beeper Edition
+
+
+## Rebase flow
+
+### Create PR
+
+Here we're upgrading to `v1.96.1`:
+
+```
+# Make a new branch from the upstream release, we do this so we can create a PR
+# of Beeper -> upstream to run tests/confirm we're happy.
+git checkout -f v1.96.1
+git checkout -b upstream-1.96.1
+git push -u beeper upstream-1.96.1
+
+# Check out the base branch, pull any changes
+git checkout beeper
+git pull
+
+# Now create a new branch to rebase
+git checkout -b beeper-1.96.1
+# And do the rebase
+git rebase v1.96.1
+# fix any conflicts...
+
+# Push and make a PR from this branch to the upstream one created above
+git push -u beeper beeper-1.96.1
+```
+
+### Make release
+
+Once it's ready we just overwrite the `beeper` branch with the new one:
+
+```
+git checkout beeper-1.96.1
+git push --force beeper beeper
+```

docker/Dockerfile

@@ -134,6 +134,10 @@ COPY --from=requirements /synapse/requirements.txt /synapse/
 RUN --mount=type=cache,target=/root/.cache/pip \
   pip install --prefix="/install" --no-deps --no-warn-script-location -r /synapse/requirements.txt
 
+# Beeper: install shared secret authenticator
+RUN pip install --prefix="/install" --no-deps --no-warn-script-location \
+   'git+https://github.com/devture/matrix-synapse-shared-secret-auth@e178353ec87c56e0169dd04466d4769da5ed9c46#egg=shared_secret_authenticator'
+
 # Copy over the rest of the synapse source code.
 COPY synapse /synapse/synapse/
 COPY rust /synapse/rust/

rust/src/push/base_rules.rs

@@ -76,19 +76,76 @@ pub const BASE_APPEND_OVERRIDE_RULES: &[PushRule] = &[
         default: true,
         default_enabled: false,
     },
+    // Disable notifications for auto-accepted room invites
+    // NOTE: this rule must be a higher prio than .m.rule.invite_for_me because
+    // that will also match the same events.
     PushRule {
-        rule_id: Cow::Borrowed("global/override/.m.rule.suppress_notices"),
+        rule_id: Cow::Borrowed("global/override/.com.beeper.suppress_auto_invite"),
+        priority_class: 5,
+        conditions: Cow::Borrowed(&[
+            Condition::Known(KnownCondition::EventMatch(EventMatchCondition {
+                key: Cow::Borrowed("type"),
+                pattern: Cow::Borrowed("m.room.member"),
+            })),
+            Condition::Known(KnownCondition::EventMatch(EventMatchCondition {
+                key: Cow::Borrowed("content.membership"),
+                pattern: Cow::Borrowed("invite"),
+            })),
+            Condition::Known(KnownCondition::EventMatchType(EventMatchTypeCondition {
+                key: Cow::Borrowed("state_key"),
+                pattern_type: Cow::Borrowed(&EventMatchPatternType::UserId),
+            })),
+            Condition::Known(KnownCondition::EventPropertyIs(EventPropertyIsCondition {
+                key: Cow::Borrowed("content.fi\\.mau\\.will_auto_accept"),
+                value: Cow::Borrowed(&SimpleJsonValue::Bool(true)),
+            })),
+        ]),
+        actions: Cow::Borrowed(&[Action::DontNotify]),
+        default: true,
+        default_enabled: true,
+    },
+    // We don't want to notify on edits. Not only can this be confusing in real
+    // time (2 notifications, one message) but it's especially confusing
+    // if a bridge needs to edit a previously backfilled message.
+    PushRule {
+        rule_id: Cow::Borrowed("global/override/.com.beeper.suppress_edits"),
         priority_class: 5,
         conditions: Cow::Borrowed(&[Condition::Known(KnownCondition::EventMatch(
             EventMatchCondition {
-                key: Cow::Borrowed("content.msgtype"),
-                pattern: Cow::Borrowed("m.notice"),
+                key: Cow::Borrowed("content.m\\.relates_to.rel_type"),
+                pattern: Cow::Borrowed("m.replace"),
             },
         ))]),
         actions: Cow::Borrowed(&[]),
         default: true,
         default_enabled: true,
     },
+    PushRule {
+        rule_id: Cow::Borrowed("global/override/.com.beeper.suppress_send_message_status"),
+        priority_class: 5,
+        conditions: Cow::Borrowed(&[
+            Condition::Known(KnownCondition::EventMatch(EventMatchCondition {
+                key: Cow::Borrowed("type"),
+                pattern: Cow::Borrowed("com.beeper.message_send_status"),
+            })),
+        ]),
+        actions: Cow::Borrowed(&[Action::DontNotify]),
+        default: true,
+        default_enabled: true,
+    },
+    PushRule {
+        rule_id: Cow::Borrowed("global/override/.com.beeper.suppress_power_levels"),
+        priority_class: 5,
+        conditions: Cow::Borrowed(&[
+            Condition::Known(KnownCondition::EventMatch(EventMatchCondition {
+                key: Cow::Borrowed("type"),
+                pattern: Cow::Borrowed("cm.room.power_levels"),
+            })),
+        ]),
+        actions: Cow::Borrowed(&[Action::DontNotify]),
+        default: true,
+        default_enabled: true,
+    },
     PushRule {
         rule_id: Cow::Borrowed("global/override/.m.rule.invite_for_me"),
         priority_class: 5,
@@ -208,19 +265,6 @@ pub const BASE_APPEND_OVERRIDE_RULES: &[PushRule] = &[
         default: true,
         default_enabled: true,
     },
-    PushRule {
-        rule_id: Cow::Borrowed("global/override/.m.rule.reaction"),
-        priority_class: 5,
-        conditions: Cow::Borrowed(&[Condition::Known(KnownCondition::EventMatch(
-            EventMatchCondition {
-                key: Cow::Borrowed("type"),
-                pattern: Cow::Borrowed("m.reaction"),
-            },
-        ))]),
-        actions: Cow::Borrowed(&[]),
-        default: true,
-        default_enabled: true,
-    },
     PushRule {
         rule_id: Cow::Borrowed("global/override/.m.rule.room.server_acl"),
         priority_class: 5,
@@ -283,6 +327,22 @@ pub const BASE_APPEND_CONTENT_RULES: &[PushRule] = &[PushRule {
 }];
 
 pub const BASE_APPEND_UNDERRIDE_RULES: &[PushRule] = &[
+    // Beeper change: this rule is moved down from override. This means room
+    // rules take precedence, so if you enable bot notifications (by modifying
+    // this rule) notifications will not be sent for muted rooms.
+    PushRule {
+        rule_id: Cow::Borrowed("global/underride/.m.rule.suppress_notices"),
+        priority_class: 1,
+        conditions: Cow::Borrowed(&[Condition::Known(KnownCondition::EventMatch(
+            EventMatchCondition {
+                key: Cow::Borrowed("content.msgtype"),
+                pattern: Cow::Borrowed("m.notice"),
+            },
+        ))]),
+        actions: Cow::Borrowed(&[Action::DontNotify]),
+        default: true,
+        default_enabled: true,
+    },
     PushRule {
         rule_id: Cow::Borrowed("global/underride/.m.rule.call"),
         priority_class: 1,
@@ -633,6 +693,30 @@ pub const BASE_APPEND_UNDERRIDE_RULES: &[PushRule] = &[
         default: true,
         default_enabled: true,
     },
+    // Enable notifications for reactions to your own messages *in rooms with less
+    // than 20 members*.
+    PushRule {
+        rule_id: Cow::Borrowed("global/underride/.com.beeper.reaction"),
+        priority_class: 1,
+        conditions: Cow::Borrowed(&[
+            Condition::Known(KnownCondition::EventMatch(EventMatchCondition {
+                key: Cow::Borrowed("type"),
+                pattern: Cow::Borrowed("m.reaction"),
+            })),
+            Condition::Known(KnownCondition::RoomMemberCount {
+                is: Some(Cow::Borrowed("<20")),
+            }),
+            Condition::Known(KnownCondition::RelatedEventMatchType(RelatedEventMatchTypeCondition {
+                key: Cow::Borrowed("sender"),
+                pattern_type: Cow::Borrowed(&EventMatchPatternType::UserId),
+                rel_type: Cow::Borrowed("m.annotation"),
+                include_fallbacks: None,
+            })),
+        ]),
+        actions: Cow::Borrowed(&[Action::Notify, HIGHLIGHT_FALSE_ACTION]),
+        default: true,
+        default_enabled: true,
+    },
     PushRule {
         rule_id: Cow::Borrowed("global/underride/.org.matrix.msc3930.rule.poll_start_one_to_one"),
         priority_class: 1,

synapse/api/constants.py

@@ -83,6 +83,7 @@ class LoginType:
     SSO: Final = "m.login.sso"
     DUMMY: Final = "m.login.dummy"
     REGISTRATION_TOKEN: Final = "m.login.registration_token"
+    JWT: Final = "org.matrix.login.jwt"
 
 
 # This is used in the `type` parameter for /register when called by
@@ -262,6 +263,7 @@ class ReceiptTypes:
     READ: Final = "m.read"
     READ_PRIVATE: Final = "m.read.private"
     FULLY_READ: Final = "m.fully_read"
+    BEEPER_INBOX_DONE: Final = "com.beeper.inbox.done"
 
 
 class PublicRoomsFilterFields:

synapse/app/generic_worker.py

@@ -56,6 +56,7 @@
     ApplicationServiceTransactionWorkerStore,
     ApplicationServiceWorkerStore,
 )
+from synapse.storage.databases.main.beeper import BeeperStore
 from synapse.storage.databases.main.censor_events import CensorEventsStore
 from synapse.storage.databases.main.client_ips import ClientIpWorkerStore
 from synapse.storage.databases.main.deviceinbox import DeviceInboxWorkerStore
@@ -148,6 +149,7 @@ class GenericWorkerStore(
     LockStore,
     SessionStore,
     TaskSchedulerWorkerStore,
+    BeeperStore,
 ):
     # Properties that multiple storage classes define. Tell mypy what the
     # expected type is.