Added automatic push distributor selection by ArnyminerZ · Pull Request #1774 · bitfireAT/davx5-ose

ArnyminerZ · 2025-10-25T10:58:41Z

Purpose

See #1737, but basically, Push is basically stable enough to at least select a distributor by default.

In any case, if one doesn't trust it, the server admin should simply not install support for push on the server, and the distributor will be unused.

Short description

Added automatic push distributor selection
- Added a new optionally injectable class called PushDistributorDefaults. It contains a preferred distributor.
- For OSE, no distributor has preference.
- For Play Store builds we might want to pre-select FCM for example, or for managed. This can be set with the DistributorPreferences implementation.
Added a new settings entry which will be set to true whenever the user manually disables push (because it will be enabled by default). If this setting is true, no push distributor will be automatically selected.
On the push distributor selection dialog, the preferred distributor, if any, is marked with "Recommended"

Screenshot

We still have to add the individual implementations for each flavor on bitfireAt/davx5.

Subscriptions are invalidated when the push distributor is changed to make sure they're again registered with the correct endpoint.

Checklist

The PR has a proper title, description and label.
I have self-reviewed the PR.
I have added documentation to complex functions and functions that can be used by other modules.
I have added reasonable tests or consciously decided to not add tests.

sunkup · 2025-11-20T11:18:15Z

I will change to draft for now and we can reopen when we want to merge it - that is when we know in which version it will be added.

rfc2822

I think it will finally be time 😄

As I understand it, the basic idea is to check/update the push distributor whenever the PushRegistrationWorker is run, instead of setting it explicitly from the UI.

This sounds good to me! However some notes.

(Also please fix conflicts)

app/src/main/kotlin/at/bitfire/davdroid/push/PushRegistrationManager.kt

core/src/main/kotlin/at/bitfire/davdroid/push/PushRegistrationManager.kt

# Conflicts: # app/src/ose/kotlin/at/bitfire/davdroid/di/OseFlavorModule.kt

Signed-off-by: Arnau Mora Gras <arnyminerz@proton.me>

ArnyminerZ · 2026-01-29T12:01:57Z

As agreed on the meeting, FCM pre-selection for gplay variant is kept. So this should be ready for now. We can keep it improving later (actual distributor pinging to make sure it's available)

Note: The gplay preference should be established on the private repo

# Conflicts: # core/src/androidTest/kotlin/at/bitfire/davdroid/di/TestFlavorModule.kt # core/src/main/kotlin/at/bitfire/davdroid/push/PushDistributorManager.kt # core/src/main/kotlin/at/bitfire/davdroid/push/PushRegistrationManager.kt # core/src/main/kotlin/at/bitfire/davdroid/ui/AppSettingsModel.kt

Signed-off-by: Arnau Mora <arnyminerz@proton.me>

…efault

Signed-off-by: Arnau Mora <arnyminerz@proton.me>

…ble-push-by-default

Signed-off-by: Arnau Mora <arnyminerz@proton.me>

- Simplify push disable setting from `EXPLICIT_PUSH_DISABLE` to `PUSH_DISABLE` - Improve push distributor list UI with better labels and icons - Remove unused imports and `AppTheme` wrapper from previews

- Refactor `PushRegistrationManager.update()` to explicitly handle distributor, subscriptions, and worker updates - Add thread-safety documentation for `update()` and `update(serviceId)` - Fix push distributor preference comparison in `AppSettingsModel`

Copilot

Pull request overview

Adds automatic UnifiedPush distributor selection with an opt-out flag, and updates the settings UI to surface a “Recommended” distributor.

Changes:

Introduces PushDistributorManager to auto-select a distributor (preferred/first available) unless the user explicitly disabled push.
Adds Settings.PUSH_DISABLE to prevent auto-selection after the user disables push.
Updates distributor selection UI to show a “Recommended” label and adjusts how distributor icons/names are derived.

Reviewed changes

Copilot reviewed 8 out of 8 changed files in this pull request and generated 6 comments.

Show a summary per file

File	Description
core/src/main/res/values/strings.xml	Adds “Recommended” label string for the distributor picker UI.
core/src/main/kotlin/at/bitfire/davdroid/ui/AppSettingsScreen.kt	Updates distributor picker list rendering to display “Recommended” and simplifies icon handling.
core/src/main/kotlin/at/bitfire/davdroid/ui/AppSettingsModel.kt	Switches to `PushDistributorManager`, computes preferred flag per distributor, and persists `PUSH_DISABLE` when user disables push.
core/src/main/kotlin/at/bitfire/davdroid/settings/Settings.kt	Adds `PUSH_DISABLE` setting key with documentation.
core/src/main/kotlin/at/bitfire/davdroid/push/PushRegistrationManager.kt	Delegates distributor selection to `PushDistributorManager` during update flows and updates docs.
core/src/main/kotlin/at/bitfire/davdroid/push/PushDistributorManager.kt	New: centralizes distributor selection and opt-out behavior via settings.
core/src/main/kotlin/at/bitfire/davdroid/push/PushDistributorDefaults.kt	New: interface for build-variant preferred distributor selection.
core/src/main/kotlin/at/bitfire/davdroid/di/PushDistributorDefaultsModule.kt	New: Hilt optional binding for `PushDistributorDefaults`.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

core/src/main/kotlin/at/bitfire/davdroid/push/PushDistributorManager.kt

core/src/main/kotlin/at/bitfire/davdroid/ui/AppSettingsScreen.kt

core/src/main/kotlin/at/bitfire/davdroid/push/PushRegistrationManager.kt

core/src/main/kotlin/at/bitfire/davdroid/di/PushDistributorDefaultsModule.kt

core/src/main/kotlin/at/bitfire/davdroid/push/PushDistributorDefaults.kt

- Move push disable setting logic to `PushDistributorManager.setPushDistributor()` - Update comments and docstrings for clarity - Rename `pushDistributorPreferences` to `pushDistributorDefaults` in DI module

Copilot

Pull request overview

Copilot reviewed 8 out of 8 changed files in this pull request and generated 4 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

core/src/main/kotlin/at/bitfire/davdroid/push/PushDistributorManager.kt

core/src/main/kotlin/at/bitfire/davdroid/ui/AppSettingsModel.kt

core/src/main/kotlin/at/bitfire/davdroid/ui/AppSettingsScreen.kt

- Cache icon bitmap in `AppSettingsScreen` to avoid recomputation - Add `PushRegistrationManager` to `AppSettingsModel` and update registrations on distributor change - Improve `PushDistributorManager.getCurrentDistributor()` docs to clarify behavior when distributor is uninstalled

- Rename `update()` to `updateDistributor()` for consistency - Improve comments and docstrings in `PushRegistrationManager` - Add documentation for UnifiedPush callback behavior

- Add `CollectionDao.invalidatePushSubscriptions()` to clear push subscription expires - Update `PushDistributorManager` to invalidate subscriptions when distributor changes - Use application scope in `AppSettingsModel` to prevent interruption during push distributor updates

sunkup

So this will do nothing in davx5-ose, because there is no hradcoded/injected preference?

Also, sounds like this implementation will be superseeded by: #2091 (comment) so maybe we should do that instead of merging something unfinished?

I am not quite sure what the requirements for accepting an implementation are. The issue #1737 does not really look agreed and settled yet.

Also, since we need to work on the flavors across repos, maybe some sub-issues would be good?

ArnyminerZ · 2026-03-23T08:35:42Z

I'd discuss this further after seeing #2091 and the official guide.

ArnyminerZ self-assigned this Oct 25, 2025

ArnyminerZ requested a review from a team as a code owner October 25, 2025 10:58

ArnyminerZ added pr-feature Implements a new feature or functionality (only for PRs) push Related to WebDAV-Push labels Oct 25, 2025

ArnyminerZ linked an issue Oct 25, 2025 that may be closed by this pull request

Enable Push by default (first available UnifiedPush provider) #1737

Open

3 tasks

sunkup force-pushed the 1737-enable-push-by-default branch from adfee4b to 09f359d Compare November 20, 2025 10:58

sunkup marked this pull request as draft November 20, 2025 11:18

rfc2822 force-pushed the main-ose branch from 8ad15e6 to 2d10cbb Compare December 2, 2025 15:02

Added automatic push distributor selection

6e0cde7

rfc2822 force-pushed the 1737-enable-push-by-default branch from d4c00a0 to 6e0cde7 Compare December 11, 2025 14:33

Merge branch 'main-ose' into 1737-enable-push-by-default

425478b

rfc2822 reviewed Jan 28, 2026

View reviewed changes

app/src/main/kotlin/at/bitfire/davdroid/push/PushRegistrationManager.kt Outdated Show resolved Hide resolved

core/src/main/kotlin/at/bitfire/davdroid/push/PushRegistrationManager.kt Outdated Show resolved Hide resolved

ArnyminerZ added 4 commits January 29, 2026 09:25

Merge branch 'main-ose' into 1737-enable-push-by-default

5b58fac

# Conflicts: # app/src/ose/kotlin/at/bitfire/davdroid/di/OseFlavorModule.kt

Optimize imports

e61d4b9

Signed-off-by: Arnau Mora Gras <arnyminerz@proton.me>

Create PushDistributorManager

7cd161f

Signed-off-by: Arnau Mora Gras <arnyminerz@proton.me>

Merge branch 'main-ose' into 1737-enable-push-by-default

0362c72

ArnyminerZ marked this pull request as ready for review January 29, 2026 12:01

Merge branch 'main-ose' into 1737-enable-push-by-default

6d478de

ArnyminerZ requested a review from rfc2822 February 2, 2026 09:29

ArnyminerZ added 7 commits March 16, 2026 13:33

Add PushDistributorManager back

e7c7b64

Signed-off-by: Arnau Mora <arnyminerz@proton.me>

Merge remote-tracking branch 'origin/main' into 1737-enable-push-by-d…

6adf4b9

…efault

Move file

a6d29a6

Signed-off-by: Arnau Mora <arnyminerz@proton.me>

Merge remote-tracking branch 'refs/remotes/origin/main' into 1737-ena…

5a677a3

…ble-push-by-default

Update required files

5f8a9e4

Signed-off-by: Arnau Mora <arnyminerz@proton.me>

Remove remaining log methods

06ee22b

Signed-off-by: Arnau Mora <arnyminerz@proton.me>

ArnyminerZ requested review from cketti and removed request for rfc2822 March 18, 2026 11:20

rfc2822 self-assigned this Mar 20, 2026

rfc2822 removed request for cketti and sunkup March 20, 2026 15:08

rfc2822 added 4 commits March 20, 2026 16:15

Merge branch 'main' into 1737-enable-push-by-default

2963c94

Remove DistributorPreferences and replace with PushDistributorDefaults

043a284

Update push distributor selection and UI improvements

18102ab

- Simplify push disable setting from `EXPLICIT_PUSH_DISABLE` to `PUSH_DISABLE` - Improve push distributor list UI with better labels and icons - Remove unused imports and `AppTheme` wrapper from previews

rfc2822 requested a review from Copilot March 20, 2026 16:07

Copilot started reviewing on behalf of rfc2822 March 20, 2026 16:08 View session

Copilot AI reviewed Mar 20, 2026

View reviewed changes

Refactor push distributor logic and improve UI

1d97a68

- Move push disable setting logic to `PushDistributorManager.setPushDistributor()` - Update comments and docstrings for clarity - Rename `pushDistributorPreferences` to `pushDistributorDefaults` in DI module

rfc2822 requested a review from Copilot March 20, 2026 16:22

Copilot started reviewing on behalf of rfc2822 March 20, 2026 16:22 View session

Copilot AI reviewed Mar 20, 2026

View reviewed changes

rfc2822 requested a review from sunkup March 20, 2026 16:43

rfc2822 marked this pull request as draft March 21, 2026 08:47

rfc2822 removed the request for review from sunkup March 21, 2026 08:48

rfc2822 added 2 commits March 21, 2026 10:22

Update PushDistributorManager to clarify distributor selection logic

4e92b1f

- Rename `update()` to `updateDistributor()` for consistency - Improve comments and docstrings in `PushRegistrationManager` - Add documentation for UnifiedPush callback behavior

Improve comment clarity for push distributor unregistration behavior

609f4b9

rfc2822 marked this pull request as ready for review March 21, 2026 09:43

rfc2822 force-pushed the 1737-enable-push-by-default branch from 0bca3ed to 8d7d49f Compare March 21, 2026 10:00

rfc2822 requested a review from sunkup March 21, 2026 10:00

ArnyminerZ mentioned this pull request Mar 23, 2026

[Push] Use new UnifiedPush mechanism to resolve default distributor #2091

Open

sunkup reviewed Mar 23, 2026

View reviewed changes

rfc2822 removed their assignment Mar 23, 2026

rfc2822 linked an issue Mar 23, 2026 that may be closed by this pull request

[Push] Changing push distributor doesn't register subscriptions again #2095

Open

rfc2822 marked this pull request as draft March 26, 2026 11:18

Uh oh!

Conversation

ArnyminerZ commented Oct 25, 2025 • edited by rfc2822 Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Purpose

Short description

Checklist

Uh oh!

sunkup commented Nov 20, 2025

Uh oh!

rfc2822 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

ArnyminerZ commented Jan 29, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

sunkup left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ArnyminerZ commented Mar 23, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

ArnyminerZ commented Oct 25, 2025 •

edited by rfc2822

Loading

ArnyminerZ commented Jan 29, 2026 •

edited

Loading

sunkup left a comment •

edited

Loading