🔍 Don't display the search engine until First Run completes

chrome/android/java/src/org/chromium/chrome/browser/searchwidget/SearchWidgetProvider.java

 // Copyright 2017 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 package org.chromium.chrome.browser.searchwidget;
 
 import android.annotation.SuppressLint;
 import android.app.PendingIntent;
 import android.appwidget.AppWidgetManager;
 import android.appwidget.AppWidgetProvider;
@@ skipping 77 matching lines @@
             TemplateUrlService.getInstance().unregisterLoadListener(this);
             updateCachedEngineName();
         }
 
         @Override
         public void onTemplateURLServiceChanged() {
             updateCachedEngineName();
         }
 
         private void updateCachedEngineName() {
-            assert LibraryLoader.isInitialized();
-
-            // Getting an instance of the TemplateUrlService requires that the native library be
-            // loaded, but the TemplateUrlService also itself needs to be initialized.
-            TemplateUrlService service = TemplateUrlService.getInstance();
-            assert service.isLoaded();
-            SearchWidgetProvider.updateCachedEngineName(
-                    service.getDefaultSearchEngineTemplateUrl().getShortName());
+            SearchWidgetProvider.updateCachedEngineName();
         }
     }
 
     static final String ACTION_START_TEXT_QUERY =
             "org.chromium.chrome.browser.searchwidget.START_TEXT_QUERY";
     static final String ACTION_START_VOICE_QUERY =
             "org.chromium.chrome.browser.searchwidget.START_VOICE_QUERY";
     static final String ACTION_UPDATE_ALL_WIDGETS =
             "org.chromium.chrome.browser.searchwidget.UPDATE_ALL_WIDGETS";
 
     static final String EXTRA_START_VOICE_SEARCH =
             "org.chromium.chrome.browser.searchwidget.START_VOICE_SEARCH";
 
     private static final String PREF_IS_VOICE_SEARCH_AVAILABLE =
             "org.chromium.chrome.browser.searchwidget.IS_VOICE_SEARCH_AVAILABLE";
     private static final String PREF_NUM_CONSECUTIVE_CRASHES =
             "org.chromium.chrome.browser.searchwidget.NUM_CONSECUTIVE_CRASHES";
-    private static final String PREF_SEARCH_ENGINE_SHORTNAME =
+    static final String PREF_SEARCH_ENGINE_SHORTNAME =
             "org.chromium.chrome.browser.searchwidget.SEARCH_ENGINE_SHORTNAME";
 
     /** Number of consecutive crashes this widget will absorb before giving up. */
     private static final int CRASH_LIMIT = 3;
 
     private static final String TAG = "searchwidget";
     private static final Object DELEGATE_LOCK = new Object();
     private static final Object OBSERVER_LOCK = new Object();
 
     private static SearchWidgetTemplateUrlServiceObserver sObserver;
@@ skipping 122 matching lines @@
             Intent voiceIntent = createStartQueryIntent(context, ACTION_START_VOICE_QUERY, id);
             views.setOnClickPendingIntent(R.id.microphone_icon,
                     PendingIntent.getBroadcast(
                             context, 0, voiceIntent, PendingIntent.FLAG_UPDATE_CURRENT));
             views.setViewVisibility(R.id.microphone_icon, View.VISIBLE);
         } else {
             views.setViewVisibility(R.id.microphone_icon, View.GONE);
         }
 
         // Update what string is displayed by the widget.
-        String text = TextUtils.isEmpty(engineName)
+        String text = TextUtils.isEmpty(engineName) || !shouldShowFullString()

[Ted C, 2017/04/24 21:23:38]

is this check necessary?  Should we have received an empty value here?

Worth asserting in that case?

[gone, 2017/04/24 21:36:17]

I _believe_ it's necessary in the case where Android automatically tells us to
update the widget (currently once per day).  It's a fallback to catch cases like
that.

                 ? context.getString(R.string.search_widget_default)
                 : context.getString(R.string.search_with_product, engineName);
         views.setTextViewText(R.id.title, text);
 
         return views;
     }
 
     /** Creates a trusted Intent that lets the user begin performing queries. */
     private static Intent createStartQueryIntent(Context context, String action, int widgetId) {
         Intent intent = new Intent(action, Uri.parse(String.valueOf(widgetId)));
         intent.setClass(context, SearchWidgetProvider.class);
         IntentHandler.addTrustedIntentExtras(intent);
         return intent;
     }
 
     /** Caches whether or not a voice search is possible. */
     static void updateCachedVoiceSearchAvailability(boolean isVoiceSearchAvailable) {
         SharedPreferences prefs = getDelegate().getSharedPreferences();
         if (getCachedVoiceSearchAvailability(prefs) != isVoiceSearchAvailable) {
             prefs.edit().putBoolean(PREF_IS_VOICE_SEARCH_AVAILABLE, isVoiceSearchAvailable).apply();
             performUpdate(null);
         }
     }
 
+    /** Attempts to update the cached search engine name. */
+    public static void updateCachedEngineName() {
+        ThreadUtils.assertOnUiThread();
+        if (!LibraryLoader.isInitialized()) return;
+
+        // Getting an instance of the TemplateUrlService requires that the native library be
+        // loaded, but the TemplateUrlService also itself needs to be initialized.
+        TemplateUrlService service = TemplateUrlService.getInstance();
+        if (!service.isLoaded()) return;
+
+        updateCachedEngineName(service.getDefaultSearchEngineTemplateUrl().getShortName());
+    }
+
     /**
      * Updates the name of the user's default search engine that is cached in SharedPreferences.
      * Caching it in SharedPreferences prevents us from having to load the native library and the
      * TemplateUrlService whenever the widget is updated.
      */
     static void updateCachedEngineName(String engineName) {
         SharedPreferences prefs = getDelegate().getSharedPreferences();
+
+        if (!shouldShowFullString()) engineName = null;
+
         if (!TextUtils.equals(getCachedEngineName(prefs), engineName)) {
             prefs.edit().putString(PREF_SEARCH_ENGINE_SHORTNAME, engineName).apply();
             performUpdate(null);
         }
     }
 
     /** Updates the number of consecutive crashes this widget has absorbed. */
     @SuppressLint("CommitPrefEdits")
     static void updateNumConsecutiveCrashes(int newValue) {
         SharedPreferences prefs = getDelegate().getSharedPreferences();
@@ skipping 47 matching lines @@
             if (numCrashes < CRASH_LIMIT) {
                 // Absorb the crash.
                 Log.e(TAG, "Absorbing exception caught when attempting to launch widget.", e);
             } else {
                 // Too many crashes have happened consecutively.  Let Android handle it.
                 throw e;
             }
         }
     }
 
+    static boolean shouldShowFullString() {
+        Intent freIntent = FirstRunFlowSequencer.checkIfFirstRunIsNecessary(
+                getDelegate().getContext(), null, false);
+        return freIntent == null;
+    }
+
     /** Sets an {@link SearchWidgetProviderDelegate} to interact with. */
     @VisibleForTesting
     static void setDelegateForTest(SearchWidgetProviderDelegate delegate) {
         assert sDelegate == null;
         sDelegate = delegate;
     }
 }