Page MenuHomePhabricator

Add DB column for subscription data blob
Open, HighPublic

Description

For push notifications support on Echo we added some DB tables to keep the state required:

https://gerrit.wikimedia.org/r/plugins/gitiles/mediawiki/extensions/Echo/+/master/db_patches/echo_push_provider.sql
https://gerrit.wikimedia.org/r/plugins/gitiles/mediawiki/extensions/Echo/+/master/db_patches/echo_push_subscription.sql

While working on the push-notifications service it looked like we might need some extra, maybe optional, information on the API requests like:

  • APNS topic
  • (maybe) notifications expiry

To avoid complicated migrations ideally we prefer to only add columns.

Decision: Add a eps_data column to store a JSON blob of subscription data that need not be indexed for querying.

Event Timeline

Restricted Application added a subscriber: Aklapper. · View Herald TranscriptJun 12 2020, 8:25 AM

Since most of the things we identified were metadata around the notification messages one solution could be to add a new column to store the metadata as JSON blobs, since we are not planning to query based on metadata.

Jgiannelos updated the task description. (Show Details)Jun 12 2020, 8:27 AM

Maybe you're thinking about it differently, but to me notification expiry seems like the kind of thing we'd want to define in configuration rather than store in a DB on a per-notification basis. (One thing to bear in mind is that we'll probably want to use the same TTL, if any, for all notification types, otherwise we'll end up leaking info about the underlying notification type.)

With respect to APNS topic, is it correct that we'll only need that if we use cert-based authentication? Looking at the docs, it looks like token-based auth is preferred.

I'm thinking about this task now becuase it's a bit awkward to request final DBA signoff for launch when there's an open task called "finalize DB schema..."

Mholloway renamed this task from Finalize DB schema for push notifications support on echo to Add DB column for subscription data blob.Jun 17 2020, 4:34 PM
Mholloway updated the task description. (Show Details)

Updated the task title/description per real-time discussion. Feel feel free to edit further if you'd like!

Change 607047 had a related patch set uploaded (by Jgiannelos; owner: Jgiannelos):
[mediawiki/extensions/Echo@master] Αdd column on eps_subscription table to store subscription metadata

https://gerrit.wikimedia.org/r/607047

LGoto triaged this task as High priority.Jun 23 2020, 3:36 PM
bearND added a subscriber: bearND.Jun 25 2020, 5:11 AM
This comment was removed by bearND.

Change 607047 merged by jenkins-bot:
[mediawiki/extensions/Echo@master] Αdd column on eps_subscription table to store subscription metadata

https://gerrit.wikimedia.org/r/c/mediawiki/extensions/Echo/ /607047