Page MenuHomePhabricator

Move Audit to proper Subscriptions
ClosedPublic

Authored by epriestley on Aug 1 2014, 1:08 AM.
Tags
None
Referenced Files
Unknown Object (File)
Thu, Nov 21, 5:34 PM
Unknown Object (File)
Sun, Nov 17, 9:49 PM
Unknown Object (File)
Sun, Nov 17, 10:25 AM
Unknown Object (File)
Sun, Nov 17, 8:49 AM
Unknown Object (File)
Sun, Nov 17, 8:34 AM
Unknown Object (File)
Oct 22 2024, 9:13 AM
Unknown Object (File)
Oct 21 2024, 1:06 AM
Unknown Object (File)
Oct 17 2024, 12:42 PM
Subscribers
Tokens
"Haypence" token, awarded by btrahan.

Details

Summary

Ref T4896. Currently, subscriptions to commits are stored as auditors with a special "CC" type.

Instead, use normal subscriptions storage, reads and writes.

Test Plan
  • Ran migration and verified data still looked good.
  • Viewed commits in UI and saw "subscribers".
  • Saw "Automatically Subscribed", clicked Subscribe/Unsubscribe on a non-authored commit, saw subscriptions update.
  • Pushed a commit through Herald rules and saw them trigger subscriptions and auditors.
  • Used "Add CCs".
  • Added CCs with mentions.

Diff Detail

Repository
rP Phabricator
Lint
Lint Skipped
Unit
Tests Skipped

Event Timeline

epriestley retitled this revision from to Move Audit to proper Subscriptions.
epriestley updated this object.
epriestley edited the test plan for this revision. (Show Details)
epriestley added reviewers: btrahan, joshuaspence.
btrahan edited edge metadata.

shipitquick

src/applications/repository/storage/PhabricatorRepositoryCommit.php
340–341

fixing it is using some query class everywhere this data is loaded or...?

This revision is now accepted and ready to land.Aug 1 2014, 5:32 PM

The subscriptions issue is kind of tricky, we have some similar problems elsewhere. The easiest example is:

  • user clicks "Subscribe" on an object detail page;
  • request goes to the SubscribeController;
  • it needs to test if the user is already subscribed;
  • it only knows the object PHID.

So it:

  • loads the object by PHID using ObjectQuery; and
  • calls isAutomaticallySubscribed().

This means that isAutomaticallySubscribed() can't rely on any data which isn't loaded by ObjectQuery. Examples of data like this are project members, Differential reviewers, and auditors.

Some options I can see:

  • make ObjectQuery + CursorPagedPolicyAwareQuery aware of subscriptions and add some needDataToFigureOutSubscriptionsLaterOn(true) method. This doesn't feel very good but maybe isn't awful. A major drawback is that third-party applications can't ever do this sort of thing (change the API of the core).
  • add a getSubscribersObjectQuery() method to PhabricatorSubscribableInterface, which defaults to returning an ObjectQuery, and have things use that instead of an ObjectQuery. Instead, objects could return a DiffusionCommitQuery or whatever, configured to load the require data. This is pretty messy and complicated, and we'll end up doing re-loads of all data in some cases, and it's not very general.
  • make this data load/populate lazily, when the call is made? We've been pretty aggressively removing lazy loads and they're generally not good so I don't love this. However, in the case of projects this is probably actually better at scale (i.e., if a project has 4,000 members, we might actually want to just issue a query for the one user we're trying to check instead of loading all the members). So maybe this is reasonable, and we basically implement the methods as "if the data is attached, check it; otherwise, go run a query". We've solved so many other problems without needing surprise queries issued from deep in the infrastructure that I don't particularly like this, though. This would also issue a bunch of sequential queries if a user was adding like 50 subscribers to something. Maybe this is a case for changing how the API functions (e.g., filterAutomaticallySubscribed(array $phids) which removes autosubs and returns remaining PHIDs, instead of isAutomaticallySubscribed($phid)).

I don't really love any of these and it's not a huge issue to get it wrong (users can just appear in both "Subscribers" and "Reviewers/Auditors") so I'm just kind of ignoring it for now and hoping the answer becomes obvious in the future.

joshuaspence edited edge metadata.
joshuaspence added inline comments.
resources/sql/autopatches/20140731.audit.1.subscribers.php
23

This should eventually change to AuditObjectHasSubscriberEdgeType

resources/sql/autopatches/20140731.audit.1.subscribers.php
23

Probably PhabricatorSubscriptionsObjectHasSubscriberEdgeType, but yeah, we should move forward toward modular edge types as time/interest/appetite for tedious string methods permits.

epriestley updated this revision to Diff 24332.

Closed by commit rP89b942c183eb (authored by @epriestley).