Enable API search with checkbox on the UI. (#1444)

Author: isoos

app/lib/frontend/handlers.dart

@@ -372,13 +372,15 @@ SearchQuery _parseSearchQuery(shelf.Request request, String platform) {
   final SearchOrder sortOrder = (sortParam == null || sortParam.isEmpty)
       ? null
       : parseSearchOrder(sortParam);
-
+  final isApiEnabled = request.requestedUri.queryParameters['api'] != '0';
   return new SearchQuery.parse(
-      query: queryText,
-      platform: platform,
-      order: sortOrder,
-      offset: offset,
-      limit: PackageLinks.resultsPerPage);
+    query: queryText,
+    platform: platform,
+    order: sortOrder,
+    offset: offset,
+    limit: PackageLinks.resultsPerPage,
+    apiEnabled: isApiEnabled,
+  );
 }
 
 /// Handles requests for /packages/...  - multiplexes to HTML/JSON handlers

app/lib/frontend/templates.dart

@@ -723,6 +723,7 @@ class TemplateService {
       'search_query_placeholder': 'Search ${platformDict.name} packages',
       'search_sort_param': searchSort,
       'platform_tabs_html': platformTabs,
+      'api_search_enabled': searchQuery?.isApiEnabled ?? true,
       'landing_blurb_html': platformDict.landingBlurb,
       // This is not escaped as it is already escaped by the caller.
       'content_html': contentHtml,

app/lib/search/index_simple.dart

@@ -184,8 +184,11 @@ class SimplePackageIndex implements PackageIndex {
     }
 
     // do text matching
-    final textResults = _searchText(packages, query.parsedQuery.text,
-        _apiSearchEnabled || query.parsedQuery.isApiEnabled);
+    final isApiEnabled = query.isApiEnabled ||
+        _apiSearchEnabled ||
+        query.parsedQuery.isApiEnabled;
+    final textResults =
+        _searchText(packages, query.parsedQuery.text, isApiEnabled);
 
     // filter packages that doesn't match text query
     if (textResults != null) {

app/lib/shared/search_service.dart

@@ -207,6 +207,7 @@ class SearchQuery {
   final int offset;
   final int limit;
   final bool isAd;
+  final bool isApiEnabled;
 
   SearchQuery._({
     this.query,
@@ -215,6 +216,7 @@ class SearchQuery {
     this.offset,
     this.limit,
     this.isAd,
+    this.isApiEnabled,
   })  : parsedQuery = new ParsedQuery._parse(query),
         platform = (platform == null || platform.isEmpty) ? null : platform;
 
@@ -225,6 +227,7 @@ class SearchQuery {
     int offset: 0,
     int limit: 10,
     bool isAd,
+    bool apiEnabled,
   }) {
     final String q =
         query != null && query.trim().isNotEmpty ? query.trim() : null;
@@ -235,6 +238,7 @@ class SearchQuery {
       offset: offset,
       limit: limit,
       isAd: isAd ?? false,
+      isApiEnabled: apiEnabled ?? true,
     );
   }
 
@@ -252,6 +256,7 @@ class SearchQuery {
     limit = max(_minSearchLimit, limit);
 
     final isAd = (uri.queryParameters['ad'] ?? '0') == '1';
+    final apiEnabled = uri.queryParameters['api'] != '0';
 
     return new SearchQuery.parse(
       query: q,
@@ -260,6 +265,7 @@ class SearchQuery {
       offset: offset,
       limit: limit,
       isAd: isAd,
+      apiEnabled: apiEnabled,
     );
   }
 
@@ -270,6 +276,7 @@ class SearchQuery {
     int offset,
     int limit,
     bool isAd,
+    bool apiEnabled,
   }) {
     return new SearchQuery._(
       query: query ?? this.query,
@@ -278,6 +285,7 @@ class SearchQuery {
       offset: offset ?? this.offset,
       limit: limit ?? this.limit,
       isAd: isAd ?? this.isAd,
+      isApiEnabled: apiEnabled ?? this.isApiEnabled,
     );
   }
 
@@ -289,13 +297,9 @@ class SearchQuery {
       'limit': limit?.toString(),
       'order': serializeSearchOrder(order),
       'ad': isAd ? '1' : null,
+      'api': isApiEnabled ? null : '0',
     };
-
-    for (var key in map.keys.toList()) {
-      if (map[key] == null) {
-        map.remove(key);
-      }
-    }
+    map.removeWhere((k, v) => v == null);
     return map;
   }
 
@@ -329,6 +333,9 @@ class SearchQuery {
       final String paramName = 'sort';
       params[paramName] = serializeSearchOrder(order);
     }
+    if (!isApiEnabled) {
+      params['api'] = '0';
+    }
     if (page != null) {
       params['page'] = page.toString();
     }

app/test/frontend/golden/pkg_index_page.html

@@ -67,12 +67,18 @@ <h1 class="_visuallyhidden">Dart pub</h1>
         <input class="input" name="q" placeholder="Search Dart packages" autocomplete="on" autofocus>
         <button class="icon"></button>
 
+        <input id="search-api-field" type="hidden" name="api" value="0" disabled="disabled" />
       </form>
-      <div class="list-filters">
+      <div class="search-bar-details">
+        <div class="list-filters">
     <a class="filter " href="/flutter/packages">Flutter</a>
     <a class="filter " href="/web/packages">Web</a>
     <a class="filter -active" href="/packages">All</a>
 </div>
+        <div class="search-bar-options">
+            <input id="search-api-checkbox" type="checkbox" name="api" checked="checked" /> Include API results
+        </div>
+      </div>
     </main>
   </div>
 

app/test/frontend/golden/search_page.html

@@ -67,12 +67,18 @@ <h1 class="_visuallyhidden">Dart pub</h1>
         <input class="input" name="q" placeholder="Search Dart packages" autocomplete="on" autofocus value="foobar">
         <button class="icon"></button>
         <input type="hidden" name="sort" value="top"/>
+        <input id="search-api-field" type="hidden" name="api" value="0" disabled="disabled" />
       </form>
-      <div class="list-filters">
+      <div class="search-bar-details">
+        <div class="list-filters">
     <a class="filter " href="/flutter/packages?q=foobar&amp;sort=top">Flutter</a>
     <a class="filter " href="/web/packages?q=foobar&amp;sort=top">Web</a>
     <a class="filter -active" href="/packages?q=foobar&amp;sort=top">All</a>
 </div>
+        <div class="search-bar-options">
+            <input id="search-api-checkbox" type="checkbox" name="api" checked="checked" /> Include API results
+        </div>
+      </div>
     </main>
   </div>
 

app/test/frontend/golden/search_supported_qualifier.html

@@ -67,12 +67,18 @@ <h1 class="_visuallyhidden">Dart pub</h1>
         <input class="input" name="q" placeholder="Search Dart packages" autocomplete="on" autofocus value="email:[email protected]">
         <button class="icon"></button>
 
+        <input id="search-api-field" type="hidden" name="api" value="0" disabled="disabled" />
       </form>
-      <div class="list-filters">
+      <div class="search-bar-details">
+        <div class="list-filters">
     <a class="filter " href="/flutter/packages?q=email%3Auser%40domain.com">Flutter</a>
     <a class="filter " href="/web/packages?q=email%3Auser%40domain.com">Web</a>
     <a class="filter -active" href="/packages?q=email%3Auser%40domain.com">All</a>
 </div>
+        <div class="search-bar-options">
+            <input id="search-api-checkbox" type="checkbox" name="api" checked="checked" /> Include API results
+        </div>
+      </div>
     </main>
   </div>
 

app/test/frontend/golden/search_unsupported_qualifier.html

@@ -67,12 +67,18 @@ <h1 class="_visuallyhidden">Dart pub</h1>
         <input class="input" name="q" placeholder="Search Dart packages" autocomplete="on" autofocus value="foo:bar">
         <button class="icon"></button>
 
+        <input id="search-api-field" type="hidden" name="api" value="0" disabled="disabled" />
       </form>
-      <div class="list-filters">
+      <div class="search-bar-details">
+        <div class="list-filters">
     <a class="filter " href="/flutter/packages?q=foo%3Abar">Flutter</a>
     <a class="filter " href="/web/packages?q=foo%3Abar">Web</a>
     <a class="filter -active" href="/packages?q=foo%3Abar">All</a>
 </div>
+        <div class="search-bar-options">
+            <input id="search-api-checkbox" type="checkbox" name="api" checked="checked" /> Include API results
+        </div>
+      </div>
     </main>
   </div>
 

app/views/layout.mustache

@@ -91,8 +91,14 @@
         <input class="input" name="q" placeholder="{{search_query_placeholder}}" autocomplete="on" autofocus{{#search_query}} value="{{search_query}}"{{/search_query}}>
         <button class="icon"></button>
         {{#search_sort_param}}<input type="hidden" name="sort" value="{{search_sort_param}}"/>{{/search_sort_param}}
+        <input id="search-api-field" type="hidden" name="api" value="0"{{#api_search_enabled}} disabled="disabled"{{/api_search_enabled}} />
       </form>
-      {{& platform_tabs_html }}
+      <div class="search-bar-details">
+        {{& platform_tabs_html }}
+        <div class="search-bar-options">
+            <input id="search-api-checkbox" type="checkbox" name="api"{{#api_search_enabled}} checked="checked"{{/api_search_enabled}} /> Include API results
+        </div>
+      </div>
     </main>
   </div>
 {{/listing_banner}}

static/css/style.css

@@ -20,6 +20,7 @@ void main() {
   _setEventForSearchInput();
   _fixIssueLinks();
   _setEventForSortControl();
+  _setEventForCheckboxChanges();
   _updateDartdocStatus();
 }
 
@@ -255,6 +256,22 @@ void _setEventForSortControl() {
   sortControl.append(select);
 }
 
+void _setEventForCheckboxChanges() {
+  final hiddenApiField =
+      document.getElementById('search-api-field') as InputElement;
+  final visibleApiCheckbox =
+      document.getElementById('search-api-checkbox') as CheckboxInputElement;
+  if (hiddenApiField == null || visibleApiCheckbox == null) {
+    return;
+  }
+  final formElement = hiddenApiField.form;
+  visibleApiCheckbox.onChange.listen((_) {
+    hiddenApiField.disabled = visibleApiCheckbox.checked;
+    // TODO: instead of submitting, compose the URL here (also removing the single `?`)
+    formElement.submit();
+  });
+}
+
 void _fixIssueLinks() {
   for (AnchorElement bugLink in document.querySelectorAll('a.github_issue')) {
     var url = Uri.parse(bugLink.href);