Rename "IDPaged" to "CursorPaged", "executeWithPager" to "executeWith[Cursor|Offset]Pager"

Summary: I'm trying to make progress on the policy/visibility stuff since it's a blocker for Wikimedia. First, I want to improve Projects so they can serve as policy groups (e.g., an object can have a visibility policy like "Visible to: members of project 'security'"). However, doing this without breaking anything or snowballing into a bigger change is a bit awkward because Projects are name-ordered and we have a Conduit API which does offset paging. Rather than breaking or rewriting this stuff, I want to just continue offset paging them for now. So I'm going to make PhabricatorPolicyQuery extend PhabricatorOffsetPagedQuery, but can't currently since the `executeWithPager` methods would clash. These methods do different things anyway and are probably better with different names. This also generally improves the names of these classes, since cursors are not necessarily IDs (in the feed case, they're "chronlogicalKeys", for example). I did leave some of the interals as "ID" since calling them "Cursor"s (e.g., `setAfterCursor()`) seemed a little wrong -- it should maybe be `setAfterCursorPosition()`. These APIs have very limited use and can easily be made more consistent later. Test Plan: Browsed around various affected tools; any issues here should throw/fail in a loud/obvious way. Reviewers: vrana, btrahan Reviewed By: vrana CC: aran Maniphest Tasks: T603 Differential Revision: https://secure.phabricator.com/D3177
2024-09-20 09:18:48 +02:00 · 2012-08-07 11:54:06 -07:00 · 2012-08-07 11:54:06 -07:00 · ed4a155c91
commit ed4a155c91
parent 8ab1789329
21 changed files with 35 additions and 34 deletions
--- a/src/__phutil_library_map__.php
+++ b/src/__phutil_library_map__.php
@ -23,6 +23,7 @@ phutil_register_library_map(array(
    'AphrontContextBarView' => 'view/layout/AphrontContextBarView.php',
    'AphrontController' => 'aphront/AphrontController.php',
    'AphrontCrumbsView' => 'view/layout/AphrontCrumbsView.php',
+    'AphrontCursorPagerView' => 'view/control/AphrontCursorPagerView.php',
    'AphrontDefaultApplicationConfiguration' => 'aphront/configuration/AphrontDefaultApplicationConfiguration.php',
    'AphrontDialogResponse' => 'aphront/response/AphrontDialogResponse.php',
    'AphrontDialogView' => 'view/AphrontDialogView.php',
@ -57,7 +58,6 @@ phutil_register_library_map(array(
    'AphrontHeadsupActionListView' => 'view/layout/headsup/AphrontHeadsupActionListView.php',
    'AphrontHeadsupActionView' => 'view/layout/headsup/AphrontHeadsupActionView.php',
    'AphrontHeadsupView' => 'view/layout/headsup/AphrontHeadsupView.php',
-    'AphrontIDPagerView' => 'view/control/AphrontIDPagerView.php',
    'AphrontIsolatedDatabaseConnectionTestCase' => 'infrastructure/storage/__tests__/AphrontIsolatedDatabaseConnectionTestCase.php',
    'AphrontIsolatedHTTPSink' => 'aphront/sink/AphrontIsolatedHTTPSink.php',
    'AphrontJSONResponse' => 'aphront/response/AphrontJSONResponse.php',
@ -606,6 +606,7 @@ phutil_register_library_map(array(
    'PhabricatorCountdownEditController' => 'applications/countdown/controller/PhabricatorCountdownEditController.php',
    'PhabricatorCountdownListController' => 'applications/countdown/controller/PhabricatorCountdownListController.php',
    'PhabricatorCountdownViewController' => 'applications/countdown/controller/PhabricatorCountdownViewController.php',
+    'PhabricatorCursorPagedPolicyQuery' => 'infrastructure/query/policy/PhabricatorCursorPagedPolicyQuery.php',
    'PhabricatorDaemon' => 'infrastructure/daemon/PhabricatorDaemon.php',
    'PhabricatorDaemonCombinedLogController' => 'applications/daemon/controller/PhabricatorDaemonCombinedLogController.php',
    'PhabricatorDaemonConsoleController' => 'applications/daemon/controller/PhabricatorDaemonConsoleController.php',
@ -734,7 +735,6 @@ phutil_register_library_map(array(
    'PhabricatorHash' => 'infrastructure/util/PhabricatorHash.php',
    'PhabricatorHelpController' => 'applications/help/controller/PhabricatorHelpController.php',
    'PhabricatorHelpKeyboardShortcutController' => 'applications/help/controller/PhabricatorHelpKeyboardShortcutController.php',
-    'PhabricatorIDPagedPolicyQuery' => 'infrastructure/query/policy/PhabricatorIDPagedPolicyQuery.php',
    'PhabricatorIRCBot' => 'infrastructure/daemon/irc/PhabricatorIRCBot.php',
    'PhabricatorIRCDifferentialNotificationHandler' => 'infrastructure/daemon/irc/handler/PhabricatorIRCDifferentialNotificationHandler.php',
    'PhabricatorIRCHandler' => 'infrastructure/daemon/irc/handler/PhabricatorIRCHandler.php',
@ -1168,6 +1168,7 @@ phutil_register_library_map(array(
    'AphrontCalendarMonthView' => 'AphrontView',
    'AphrontContextBarView' => 'AphrontView',
    'AphrontCrumbsView' => 'AphrontView',
+    'AphrontCursorPagerView' => 'AphrontView',
    'AphrontDefaultApplicationConfiguration' => 'AphrontApplicationConfiguration',
    'AphrontDialogResponse' => 'AphrontResponse',
    'AphrontDialogView' => 'AphrontView',
@ -1201,7 +1202,6 @@ phutil_register_library_map(array(
    'AphrontHeadsupActionListView' => 'AphrontView',
    'AphrontHeadsupActionView' => 'AphrontView',
    'AphrontHeadsupView' => 'AphrontView',
-    'AphrontIDPagerView' => 'AphrontView',
    'AphrontIsolatedDatabaseConnectionTestCase' => 'PhabricatorTestCase',
    'AphrontIsolatedHTTPSink' => 'AphrontHTTPSink',
    'AphrontJSONResponse' => 'AphrontResponse',
@ -1667,7 +1667,7 @@ phutil_register_library_map(array(
      1 => 'PhabricatorPolicyInterface',
    ),
    'PhabricatorChatLogEventType' => 'PhabricatorChatLogConstants',
-    'PhabricatorChatLogQuery' => 'PhabricatorIDPagedPolicyQuery',
+    'PhabricatorChatLogQuery' => 'PhabricatorCursorPagedPolicyQuery',
    'PhabricatorConduitAPIController' => 'PhabricatorConduitController',
    'PhabricatorConduitCertificateToken' => 'PhabricatorConduitDAO',
    'PhabricatorConduitConnectionLog' => 'PhabricatorConduitDAO',
@ -1686,6 +1686,7 @@ phutil_register_library_map(array(
    'PhabricatorCountdownEditController' => 'PhabricatorCountdownController',
    'PhabricatorCountdownListController' => 'PhabricatorCountdownController',
    'PhabricatorCountdownViewController' => 'PhabricatorCountdownController',
+    'PhabricatorCursorPagedPolicyQuery' => 'PhabricatorPolicyQuery',
    'PhabricatorDaemon' => 'PhutilDaemon',
    'PhabricatorDaemonCombinedLogController' => 'PhabricatorDaemonController',
    'PhabricatorDaemonConsoleController' => 'PhabricatorDaemonController',
@ -1741,7 +1742,7 @@ phutil_register_library_map(array(
    'PhabricatorFeedController' => 'PhabricatorController',
    'PhabricatorFeedDAO' => 'PhabricatorLiskDAO',
    'PhabricatorFeedPublicStreamController' => 'PhabricatorFeedController',
-    'PhabricatorFeedQuery' => 'PhabricatorIDPagedPolicyQuery',
+    'PhabricatorFeedQuery' => 'PhabricatorCursorPagedPolicyQuery',
    'PhabricatorFeedStory' => 'PhabricatorPolicyInterface',
    'PhabricatorFeedStoryAggregate' => 'PhabricatorFeedStory',
    'PhabricatorFeedStoryAudit' => 'PhabricatorFeedStory',
@ -1795,7 +1796,6 @@ phutil_register_library_map(array(
    'PhabricatorGoodForNothingWorker' => 'PhabricatorWorker',
    'PhabricatorHelpController' => 'PhabricatorController',
    'PhabricatorHelpKeyboardShortcutController' => 'PhabricatorHelpController',
-    'PhabricatorIDPagedPolicyQuery' => 'PhabricatorPolicyQuery',
    'PhabricatorIRCBot' => 'PhabricatorDaemon',
    'PhabricatorIRCDifferentialNotificationHandler' => 'PhabricatorIRCHandler',
    'PhabricatorIRCLogHandler' => 'PhabricatorIRCHandler',
@ -1911,7 +1911,7 @@ phutil_register_library_map(array(
    'PhabricatorPasteController' => 'PhabricatorController',
    'PhabricatorPasteDAO' => 'PhabricatorLiskDAO',
    'PhabricatorPasteListController' => 'PhabricatorPasteController',
-    'PhabricatorPasteQuery' => 'PhabricatorIDPagedPolicyQuery',
+    'PhabricatorPasteQuery' => 'PhabricatorCursorPagedPolicyQuery',
    'PhabricatorPasteViewController' => 'PhabricatorPasteController',
    'PhabricatorPeopleController' => 'PhabricatorController',
    'PhabricatorPeopleEditController' => 'PhabricatorPeopleController',
--- a/src/applications/chatlog/PhabricatorChatLogQuery.php
+++ b/src/applications/chatlog/PhabricatorChatLogQuery.php
@ -16,7 +16,7 @@
 * limitations under the License.
 */

-final class PhabricatorChatLogQuery extends PhabricatorIDPagedPolicyQuery {
+final class PhabricatorChatLogQuery extends PhabricatorCursorPagedPolicyQuery {

  private $channels;
  private $maximumEpoch;
--- a/src/applications/chatlog/controller/PhabricatorChatLogChannelLogController.php
+++ b/src/applications/chatlog/controller/PhabricatorChatLogChannelLogController.php
@ -32,7 +32,7 @@ final class PhabricatorChatLogChannelLogController
    $uri = clone $request->getRequestURI();
    $uri->setQueryParams(array());

-    $pager = new AphrontIDPagerView();
+    $pager = new AphrontCursorPagerView();
    $pager->setURI($uri);
    $pager->setPageSize(250);

@ -46,7 +46,7 @@ final class PhabricatorChatLogChannelLogController
    $pager->setAfterID($after);
    $pager->setBeforeID($before);

-    $logs = $query->executeWithPager($pager);
+    $logs = $query->executeWithCursorPager($pager);

    // Show chat logs oldest-first.
    $logs = array_reverse($logs);
--- a/src/applications/chatlog/storage/PhabricatorChatLogEvent.php
+++ b/src/applications/chatlog/storage/PhabricatorChatLogEvent.php
@ -35,7 +35,7 @@ final class PhabricatorChatLogEvent

  public function getPolicy($capability) {
    // TODO: This is sort of silly and mostly just so that we can use
-    // IDPagedPolicyQuery; once we implement Channel objects we should
+    // CursorPagedPolicyQuery; once we implement Channel objects we should
    // just delegate policy to them.
    return PhabricatorPolicies::POLICY_PUBLIC;
  }
--- a/src/applications/directory/controller/PhabricatorDirectoryMainController.php
+++ b/src/applications/directory/controller/PhabricatorDirectoryMainController.php
@ -402,11 +402,11 @@ final class PhabricatorDirectoryMainController
      $feed_query->setFilterPHIDs($phids);
    }

-    $pager = new AphrontIDPagerView();
+    $pager = new AphrontCursorPagerView();
    $pager->readFromRequest($request);
    $pager->setPageSize(200);

-    $feed = $feed_query->executeWithPager($pager);
+    $feed = $feed_query->executeWithCursorPager($pager);

    $builder = new PhabricatorFeedBuilder($feed);
    $builder->setUser($user);
--- a/src/applications/drydock/controller/DrydockLogController.php
+++ b/src/applications/drydock/controller/DrydockLogController.php
@ -41,7 +41,7 @@ final class DrydockLogController extends DrydockController {
    $pager->setOffset($request->getInt('offset'));
    $pager->setURI($request->getRequestURI(), 'offset');

-    $logs = $query->executeWithPager($pager);
+    $logs = $query->executeWithOffsetPager($pager);

    $rows = array();
    foreach ($logs as $log) {
--- a/src/applications/feed/PhabricatorFeedQuery.php
+++ b/src/applications/feed/PhabricatorFeedQuery.php
@ -16,7 +16,7 @@
 * limitations under the License.
 */

-final class PhabricatorFeedQuery extends PhabricatorIDPagedPolicyQuery {
+final class PhabricatorFeedQuery extends PhabricatorCursorPagedPolicyQuery {

  private $filterPHIDs;

--- a/src/applications/herald/controller/HeraldHomeController.php
+++ b/src/applications/herald/controller/HeraldHomeController.php
@ -93,7 +93,7 @@ final class HeraldHomeController extends HeraldController {
    $pager->setURI($request->getRequestURI(), 'offset');
    $pager->setOffset($request->getStr('offset'));

-    $rules = $query->executeWithPager($pager);
+    $rules = $query->executeWithOffsetPager($pager);

    $need_phids = mpull($rules, 'getAuthorPHID');
    $handles = id(new PhabricatorObjectHandleData($need_phids))
--- a/src/applications/herald/controller/HeraldRuleEditHistoryController.php
+++ b/src/applications/herald/controller/HeraldRuleEditHistoryController.php
@ -36,7 +36,7 @@ final class HeraldRuleEditHistoryController extends HeraldController {
    $pager->setURI($request->getRequestURI(), 'offset');
    $pager->setOffset($request->getStr('offset'));

-    $edits = $edit_query->executeWithPager($pager);
+    $edits = $edit_query->executeWithOffsetPager($pager);

    $need_phids = mpull($edits, 'getEditorPHID');
    $handles = id(new PhabricatorObjectHandleData($need_phids))
--- a/src/applications/notification/controller/PhabricatorNotificationListController.php
+++ b/src/applications/notification/controller/PhabricatorNotificationListController.php
@ -54,7 +54,7 @@ final class PhabricatorNotificationListController
        break;
    }

-    $notifications = $query->executeWithPager($pager);
+    $notifications = $query->executeWithOffsetPager($pager);

    if ($notifications) {
      $builder = new PhabricatorNotificationBuilder($notifications);
--- a/src/applications/oauthserver/controller/client/PhabricatorOAuthClientListController.php
+++ b/src/applications/oauthserver/controller/client/PhabricatorOAuthClientListController.php
@ -40,7 +40,7 @@ extends PhabricatorOAuthClientBaseController {

    $query = new PhabricatorOAuthServerClientQuery();
    $query->withCreatorPHIDs(array($current_user->getPHID()));
-    $clients = $query->executeWithPager($pager);
+    $clients = $query->executeWithOffsetPager($pager);

    $rows      = array();
    $rowc      = array();
--- a/src/applications/oauthserver/controller/clientauthorization/PhabricatorOAuthClientAuthorizationListController.php
+++ b/src/applications/oauthserver/controller/clientauthorization/PhabricatorOAuthClientAuthorizationListController.php
@ -40,7 +40,7 @@ extends PhabricatorOAuthClientAuthorizationBaseController {

    $query = new PhabricatorOAuthClientAuthorizationQuery();
    $query->withUserPHIDs(array($current_user->getPHID()));
-    $authorizations = $query->executeWithPager($pager);
+    $authorizations = $query->executeWithOffsetPager($pager);

    $client_authorizations = mpull($authorizations, null, 'getClientPHID');
    $client_phids          = array_keys($client_authorizations);
--- a/src/applications/paste/controller/PhabricatorPasteListController.php
+++ b/src/applications/paste/controller/PhabricatorPasteListController.php
@ -73,7 +73,7 @@ final class PhabricatorPasteListController extends PhabricatorPasteController {
    $request = $this->getRequest();
    $user = $request->getUser();

-    $pager = new AphrontIDPagerView();
+    $pager = new AphrontCursorPagerView();
    $pager->readFromRequest($request);

    $query = new PhabricatorPasteQuery();
@ -95,10 +95,10 @@ final class PhabricatorPasteListController extends PhabricatorPasteController {
        break;
      case 'my':
        $query->withAuthorPHIDs(array($user->getPHID()));
-        $paste_list = $query->executeWithPager($pager);
+        $paste_list = $query->executeWithCursorPager($pager);
        break;
      case 'all':
-        $paste_list = $query->executeWithPager($pager);
+        $paste_list = $query->executeWithCursorPager($pager);
        break;
    }

--- a/src/applications/paste/query/PhabricatorPasteQuery.php
+++ b/src/applications/paste/query/PhabricatorPasteQuery.php
@ -16,7 +16,7 @@
 * limitations under the License.
 */

-final class PhabricatorPasteQuery extends PhabricatorIDPagedPolicyQuery {
+final class PhabricatorPasteQuery extends PhabricatorCursorPagedPolicyQuery {

  private $pasteIDs;
  private $authorPHIDs;
--- a/src/applications/people/controller/PhabricatorPeopleListController.php
+++ b/src/applications/people/controller/PhabricatorPeopleListController.php
@ -39,7 +39,7 @@ final class PhabricatorPeopleListController

    $users = id(new PhabricatorPeopleQuery())
      ->needPrimaryEmail(true)
-      ->executeWithPager($pager);
+      ->executeWithOffsetPager($pager);

    $rows = array();
    foreach ($users as $user) {
--- a/src/applications/phame/controller/blog/list/PhameAllBlogListController.php
+++ b/src/applications/phame/controller/blog/list/PhameAllBlogListController.php
@ -31,7 +31,7 @@ final class PhameAllBlogListController

    $blogs = id(new PhameBlogQuery())
      ->needBloggers(true)
-      ->executeWithPager($this->getPager());
+      ->executeWithOffsetPager($this->getPager());
    $this->setBlogs($blogs);

    $page_title = 'All Blogs';
--- a/src/applications/phame/controller/blog/list/PhameUserBlogListController.php
+++ b/src/applications/phame/controller/blog/list/PhameUserBlogListController.php
@ -51,7 +51,7 @@ final class PhameUserBlogListController
    $blogs = id(new PhameBlogQuery())
      ->withPHIDs($blog_phids)
      ->needBloggers(true)
-      ->executeWithPager($this->getPager());
+      ->executeWithOffsetPager($this->getPager());

    $this->setBlogs($blogs);

--- a/src/applications/phame/controller/post/list/PhamePostListBaseController.php
+++ b/src/applications/phame/controller/post/list/PhamePostListBaseController.php
@ -73,7 +73,7 @@ abstract class PhamePostListBaseController
  protected function buildPostListPageResponse() {
    $pager = $this->getPager();
    $query = $this->getPhamePostQuery();
-    $posts = $query->executeWithPager($pager);
+    $posts = $query->executeWithOffsetPager($pager);

    $bloggers =  $this->loadBloggersFromPosts($posts);

--- a/src/infrastructure/query/PhabricatorOffsetPagedQuery.php
+++ b/src/infrastructure/query/PhabricatorOffsetPagedQuery.php
@ -47,7 +47,7 @@ abstract class PhabricatorOffsetPagedQuery extends PhabricatorQuery {
    }
  }

-  final public function executeWithPager(AphrontPagerView $pager) {
+  final public function executeWithOffsetPager(AphrontPagerView $pager) {
    $this->setLimit($pager->getPageSize() + 1);
    $this->setOffset($pager->getOffset());

--- a/src/infrastructure/query/policy/PhabricatorCursorPagedPolicyQuery.php
+++ b/src/infrastructure/query/policy/PhabricatorCursorPagedPolicyQuery.php
@ -17,10 +17,11 @@
 */

 /**
- * A query class which uses ID-based paging. This paging is much more performant
- * than offset-based paging in the presence of policy filtering.
+ * A query class which uses cursor-based paging. This paging is much more
+ * performant than offset-based paging in the presence of policy filtering.
 */
-abstract class PhabricatorIDPagedPolicyQuery extends PhabricatorPolicyQuery {
+abstract class PhabricatorCursorPagedPolicyQuery
+  extends PhabricatorPolicyQuery {

  private $afterID;
  private $beforeID;
@ -101,7 +102,7 @@ abstract class PhabricatorIDPagedPolicyQuery extends PhabricatorPolicyQuery {
  }


-  final public function executeWithPager(AphrontIDPagerView $pager) {
+  final public function executeWithCursorPager(AphrontCursorPagerView $pager) {
    $this->setLimit($pager->getPageSize() + 1);

    if ($pager->getAfterID()) {
--- a/src/view/control/AphrontCursorPagerView.php
+++ b/src/view/control/AphrontCursorPagerView.php
@ -16,7 +16,7 @@
 * limitations under the License.
 */

-final class AphrontIDPagerView extends AphrontView {
+final class AphrontCursorPagerView extends AphrontView {

  private $afterID;
  private $beforeID;