Add Ngram support to Dashboards / Panels

Summary: Build ngram indexs, adds search by name capability.

Test Plan: Search for a dashboard by partial name, search for a panel by partial name.

Reviewers: epriestley

Reviewed By: epriestley

Subscribers: Korvin

Differential Revision: https://secure.phabricator.com/D17090

resources/sql/autopatches/20161216.dashboard.ngram.01.sql

···
+CREATE TABLE {$NAMESPACE}_dashboard.dashboard_dashboard_ngrams (
+  id INT UNSIGNED NOT NULL AUTO_INCREMENT PRIMARY KEY,
+  objectID INT UNSIGNED NOT NULL,
+  ngram CHAR(3) NOT NULL COLLATE {$COLLATE_TEXT},
+  KEY `key_object` (objectID),
+  KEY `key_ngram` (ngram, objectID)
+) ENGINE=InnoDB, COLLATE {$COLLATE_TEXT};
+
+CREATE TABLE {$NAMESPACE}_dashboard.dashboard_dashboardpanel_ngrams (
+  id INT UNSIGNED NOT NULL AUTO_INCREMENT PRIMARY KEY,
+  objectID INT UNSIGNED NOT NULL,
+  ngram CHAR(3) NOT NULL COLLATE {$COLLATE_TEXT},
+  KEY `key_object` (objectID),
+  KEY `key_ngram` (ngram, objectID)
+) ENGINE=InnoDB, COLLATE {$COLLATE_TEXT};

resources/sql/autopatches/20161216.dashboard.ngram.02.php

···
+<?php
+
+$table_db = new PhabricatorDashboard();
+
+foreach (new LiskMigrationIterator($table_db) as $dashboard) {
+  PhabricatorSearchWorker::queueDocumentForIndexing(
+    $dashboard->getPHID(),
+    array(
+      'force' => true,
+    ));
+}
+
+$table_dbp = new PhabricatorDashboardPanel();
+
+foreach (new LiskMigrationIterator($table_dbp) as $panel) {
+  PhabricatorSearchWorker::queueDocumentForIndexing(
+    $panel->getPHID(),
+    array(
+      'force' => true,
+    ));
+}

src/__phutil_library_map__.php

···
     'PhabricatorDashboardListController' => 'applications/dashboard/controller/PhabricatorDashboardListController.php',
     'PhabricatorDashboardManageController' => 'applications/dashboard/controller/PhabricatorDashboardManageController.php',
     'PhabricatorDashboardMovePanelController' => 'applications/dashboard/controller/PhabricatorDashboardMovePanelController.php',
+    'PhabricatorDashboardNgrams' => 'applications/dashboard/storage/PhabricatorDashboardNgrams.php',
     'PhabricatorDashboardPanel' => 'applications/dashboard/storage/PhabricatorDashboardPanel.php',
     'PhabricatorDashboardPanelArchiveController' => 'applications/dashboard/controller/PhabricatorDashboardPanelArchiveController.php',
     'PhabricatorDashboardPanelCoreCustomField' => 'applications/dashboard/customfield/PhabricatorDashboardPanelCoreCustomField.php',
···
     'PhabricatorDashboardPanelEditproController' => 'applications/dashboard/controller/PhabricatorDashboardPanelEditproController.php',
     'PhabricatorDashboardPanelHasDashboardEdgeType' => 'applications/dashboard/edge/PhabricatorDashboardPanelHasDashboardEdgeType.php',
     'PhabricatorDashboardPanelListController' => 'applications/dashboard/controller/PhabricatorDashboardPanelListController.php',
+    'PhabricatorDashboardPanelNgrams' => 'applications/dashboard/storage/PhabricatorDashboardPanelNgrams.php',
     'PhabricatorDashboardPanelPHIDType' => 'applications/dashboard/phid/PhabricatorDashboardPanelPHIDType.php',
     'PhabricatorDashboardPanelQuery' => 'applications/dashboard/query/PhabricatorDashboardPanelQuery.php',
     'PhabricatorDashboardPanelRenderController' => 'applications/dashboard/controller/PhabricatorDashboardPanelRenderController.php',
···
       'PhabricatorFlaggableInterface',
       'PhabricatorDestructibleInterface',
       'PhabricatorProjectInterface',
+      'PhabricatorNgramsInterface',
     ),
     'PhabricatorDashboardAddPanelController' => 'PhabricatorDashboardController',
     'PhabricatorDashboardApplication' => 'PhabricatorApplication',
···
     'PhabricatorDashboardListController' => 'PhabricatorDashboardController',
     'PhabricatorDashboardManageController' => 'PhabricatorDashboardController',
     'PhabricatorDashboardMovePanelController' => 'PhabricatorDashboardController',
+    'PhabricatorDashboardNgrams' => 'PhabricatorSearchNgrams',
     'PhabricatorDashboardPanel' => array(
       'PhabricatorDashboardDAO',
       'PhabricatorApplicationTransactionInterface',
···
       'PhabricatorCustomFieldInterface',
       'PhabricatorFlaggableInterface',
       'PhabricatorDestructibleInterface',
+      'PhabricatorNgramsInterface',
     ),
     'PhabricatorDashboardPanelArchiveController' => 'PhabricatorDashboardController',
     'PhabricatorDashboardPanelCoreCustomField' => array(
···
     'PhabricatorDashboardPanelEditproController' => 'PhabricatorDashboardController',
     'PhabricatorDashboardPanelHasDashboardEdgeType' => 'PhabricatorEdgeType',
     'PhabricatorDashboardPanelListController' => 'PhabricatorDashboardController',
+    'PhabricatorDashboardPanelNgrams' => 'PhabricatorSearchNgrams',
     'PhabricatorDashboardPanelPHIDType' => 'PhabricatorPHIDType',
     'PhabricatorDashboardPanelQuery' => 'PhabricatorCursorPagedPolicyAwareQuery',
     'PhabricatorDashboardPanelRenderController' => 'PhabricatorDashboardController',

src/applications/dashboard/editor/PhabricatorDashboardPanelEditEngine.php

···
     return pht('Edit Dashboard Panels');
   }
 
+  protected function supportsSearch() {
+    return true;
+  }
+
   public function getSummaryText() {
     return pht('This engine is used to modify dashboard panels.');
   }
 
   public function getEngineApplicationClass() {
-    return 'PhabricatorSearchApplication';
+    return 'PhabricatorDashboardApplication';
   }
 
   protected function newEditableObject() {

src/applications/dashboard/query/PhabricatorDashboardPanelQuery.php

···
     return $this;
   }
 
+  public function withNameNgrams($ngrams) {
+    return $this->withNgramsConstraint(
+      id(new PhabricatorDashboardPanelNgrams()),
+      $ngrams);
+  }
+
   protected function loadPage() {
     return $this->loadStandardPage($this->newResultObject());
   }
···
 
   public function getQueryApplicationClass() {
     return 'PhabricatorDashboardApplication';
+  }
+
+  protected function getPrimaryTableAlias() {
+    return 'dashboard_panel';
   }
 
 }

src/applications/dashboard/query/PhabricatorDashboardPanelSearchEngine.php

···
       $query->withAuthorPHIDs($map['authorPHIDs']);
     }
 
+    if ($map['name'] !== null) {
+      $query->withNameNgrams($map['name']);
+    }
+
     return $query;
   }
 
   protected function buildCustomSearchFields() {
 
     return array(
+        id(new PhabricatorSearchTextField())
+          ->setLabel(pht('Name Contains'))
+          ->setKey('name')
+          ->setDescription(pht('Search for panels by name substring.')),
         id(new PhabricatorSearchDatasourceField())
           ->setLabel(pht('Authored By'))
           ->setKey('authorPHIDs')

src/applications/dashboard/query/PhabricatorDashboardQuery.php

···
     return $this;
   }
 
+  public function withNameNgrams($ngrams) {
+    return $this->withNgramsConstraint(
+      id(new PhabricatorDashboardNgrams()),
+      $ngrams);
+  }
+
   protected function loadPage() {
     return $this->loadStandardPage($this->newResultObject());
   }
···
 
   public function getQueryApplicationClass() {
     return 'PhabricatorDashboardApplication';
+  }
+
+  protected function getPrimaryTableAlias() {
+    return 'dashboard';
   }
 
 }

src/applications/dashboard/query/PhabricatorDashboardSearchEngine.php

···
 
   protected function buildCustomSearchFields() {
     return array(
+      id(new PhabricatorSearchTextField())
+        ->setLabel(pht('Name Contains'))
+        ->setKey('name')
+        ->setDescription(pht('Search for dashboards by name substring.')),
       id(new PhabricatorSearchDatasourceField())
         ->setLabel(pht('Authored By'))
         ->setKey('authorPHIDs')
···
 
     if ($map['authorPHIDs']) {
       $query->withAuthorPHIDs($map['authorPHIDs']);
+    }
+
+    if ($map['name'] !== null) {
+      $query->withNameNgrams($map['name']);
     }
 
     return $query;

src/applications/dashboard/storage/PhabricatorDashboard.php

···
     PhabricatorPolicyInterface,
     PhabricatorFlaggableInterface,
     PhabricatorDestructibleInterface,
-    PhabricatorProjectInterface {
+    PhabricatorProjectInterface,
+    PhabricatorNgramsInterface {
 
   protected $name;
   protected $authorPHID;
···
         'layoutConfig' => self::SERIALIZATION_JSON,
       ),
       self::CONFIG_COLUMN_SCHEMA => array(
-        'name' => 'text255',
+        'name' => 'sort255',
         'status' => 'text32',
         'icon' => 'text32',
         'authorPHID' => 'phid',
···
     $this->saveTransaction();
   }
 
+
+/* -(  PhabricatorNgramInterface  )------------------------------------------ */
+
+
+  public function newNgrams() {
+    return array(
+      id(new PhabricatorDashboardNgrams())
+        ->setValue($this->getName()),
+    );
+  }
 
 }

src/applications/dashboard/storage/PhabricatorDashboardNgrams.php

···
+<?php
+
+final class PhabricatorDashboardNgrams
+  extends PhabricatorSearchNgrams {
+
+  public function getNgramKey() {
+    return 'dashboard';
+  }
+
+  public function getColumnName() {
+    return 'name';
+  }
+
+  public function getApplicationName() {
+    return 'dashboard';
+  }
+
+}

src/applications/dashboard/storage/PhabricatorDashboardPanel.php

···
     PhabricatorPolicyInterface,
     PhabricatorCustomFieldInterface,
     PhabricatorFlaggableInterface,
-    PhabricatorDestructibleInterface {
+    PhabricatorDestructibleInterface,
+    PhabricatorNgramsInterface {
 
   protected $name;
   protected $panelType;
···
         'properties' => self::SERIALIZATION_JSON,
       ),
       self::CONFIG_COLUMN_SCHEMA => array(
-        'name' => 'text255',
+        'name' => 'sort255',
         'panelType' => 'text64',
         'authorPHID' => 'phid',
         'isArchived' => 'bool',
···
     $this->openTransaction();
       $this->delete();
     $this->saveTransaction();
+  }
+
+
+/* -(  PhabricatorNgramInterface  )------------------------------------------ */
+
+
+  public function newNgrams() {
+    return array(
+      id(new PhabricatorDashboardPanelNgrams())
+        ->setValue($this->getName()),
+    );
   }
 
 }

src/applications/dashboard/storage/PhabricatorDashboardPanelNgrams.php

···
+<?php
+
+final class PhabricatorDashboardPanelNgrams
+  extends PhabricatorSearchNgrams {
+
+  public function getNgramKey() {
+    return 'dashboardpanel';
+  }
+
+  public function getColumnName() {
+    return 'name';
+  }
+
+  public function getApplicationName() {
+    return 'dashboard';
+  }
+
+}