Video Tutorials : Using translate backend to provide the language info

For video tutorials, instead of passing the language display name from
the server, we can just pass the locale, from which we can consult with
the translate backend to get the display name for the given locale.
This CL makes the Java side changes required to obtain this information.

Bug: 1137912
Change-Id: Ia9ce3c94088f9f4311b04141df9542a0846263f2
Reviewed-on: https://chromium-review.googlesource.com/c/chromium/src/+/2468781Reviewed-by: Megan Jablonski <megjablon@chromium.org>
Commit-Queue: Shakti Sahu <shaktisahu@chromium.org>
Cr-Commit-Position: refs/heads/master@{#817330}

chrome/android/chrome_java_sources.gni

@@ -88,6 +88,7 @@ chrome_java_sources = [
   "java/src/org/chromium/chrome/browser/app/tabmodel/ChromeTabModelFilterFactory.java",
   "java/src/org/chromium/chrome/browser/app/tabmodel/DefaultTabModelSelectorFactory.java",
   "java/src/org/chromium/chrome/browser/app/tabmodel/TabWindowManagerSingleton.java",
+  "java/src/org/chromium/chrome/browser/app/video_tutorials/ChromeLanguageInfoProvider.java",
   "java/src/org/chromium/chrome/browser/app/video_tutorials/NewTabPageVideoIPHManager.java",
   "java/src/org/chromium/chrome/browser/app/video_tutorials/VideoPlayerActivity.java",
   "java/src/org/chromium/chrome/browser/app/video_tutorials/VideoTutorialListActivity.java",

chrome/android/java/src/org/chromium/chrome/browser/app/video_tutorials/ChromeLanguageInfoProvider.java

+// Copyright 2020 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.app.video_tutorials;
+
+import org.chromium.chrome.browser.language.settings.LanguageItem;
+import org.chromium.chrome.browser.language.settings.LanguagesManager;
+import org.chromium.chrome.browser.video_tutorials.Language;
+import org.chromium.chrome.browser.video_tutorials.LanguageInfoProvider;
+
+/**
+ * See {@link LanguageInfoProvider}.
+ */
+public class ChromeLanguageInfoProvider implements LanguageInfoProvider {
+    @Override
+    public Language getLanguageInfo(String locale) {
+        LanguageItem languageItem = LanguagesManager.getInstance().getLanguageMap().get(locale);
+        if (languageItem == null) return null;
+
+        return new Language(languageItem.getCode(), languageItem.getDisplayName(),
+                languageItem.getNativeDisplayName());
+    }
+}

chrome/android/java/src/org/chromium/chrome/browser/app/video_tutorials/VideoPlayerActivity.java

@@ -47,8 +47,9 @@ public class VideoPlayerActivity extends SynchronousInitializationActivity {
         VideoTutorialService videoTutorialService =
                 VideoTutorialServiceFactory.getForProfile(Profile.getLastUsedRegularProfile());
         mWindowAndroid = new ActivityWindowAndroid(this);
-        mCoordinator = VideoTutorialServiceFactory.createVideoPlayerCoordinator(
-                this, videoTutorialService, this::createWebContents, this::tryNow, this::finish);
+        mCoordinator = VideoTutorialServiceFactory.createVideoPlayerCoordinator(this,
+                videoTutorialService, this::createWebContents, new ChromeLanguageInfoProvider(),
+                this::tryNow, this::finish);
         setContentView(mCoordinator.getView());
 
         int featureType =

chrome/android/java/src/org/chromium/chrome/browser/language/settings/LanguagesManager.java

@@ -21,7 +21,7 @@ import java.util.Map;
  *
  *The LanguagesManager is responsible for fetching languages details from native.
  */
-class LanguagesManager {
+public class LanguagesManager {
     /**
      * An observer interface that allows other classes to know when the accept language list is
      * updated in native side.
@@ -168,6 +168,14 @@ class LanguagesManager {
         if (reload) notifyAcceptLanguageObserver();
     }
 
+    /**
+     * Called to get all languages available in chrome.
+     * @return A map of language code to {@code LanguageItem} for all available languages.
+     */
+    public Map<String, LanguageItem> getLanguageMap() {
+        return mLanguagesMap;
+    }
+
     /**
      * Get the static instance of ChromePreferenceManager if it exists else create it.
      * @return the LanguagesManager singleton.

chrome/browser/video_tutorials/BUILD.gn

@@ -61,6 +61,7 @@ if (is_android) {
   android_library("java") {
     sources = [
       "android/java/src/org/chromium/chrome/browser/video_tutorials/Language.java",
+      "android/java/src/org/chromium/chrome/browser/video_tutorials/LanguageInfoProvider.java",
       "android/java/src/org/chromium/chrome/browser/video_tutorials/Tutorial.java",
       "android/java/src/org/chromium/chrome/browser/video_tutorials/VideoTutorialService.java",
       "android/java/src/org/chromium/chrome/browser/video_tutorials/iph/VideoIPHCoordinator.java",

chrome/browser/video_tutorials/android/java/src/org/chromium/chrome/browser/video_tutorials/LanguageInfoProvider.java

+// Copyright 2020 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.video_tutorials;
+
+/**
+ * Interface for obtaining the language information for a given locale in order to display on the
+ * UI.
+ */
+public interface LanguageInfoProvider {
+    /**
+x     * @return The language info for a given {@code locale}.
+     */
+    Language getLanguageInfo(String locale);
+}

chrome/browser/video_tutorials/android/java/src/org/chromium/chrome/browser/video_tutorials/VideoTutorialService.java

@@ -26,7 +26,7 @@ public interface VideoTutorialService {
     /**
      * Called to get the list of supported languages.
      */
-    List<Language> getSupportedLanguages();
+    List<String> getSupportedLanguages();
 
     /**
      * @return The user's language of choice for watching the video tutorials.

chrome/browser/video_tutorials/android/java/src/org/chromium/chrome/browser/video_tutorials/test/TestVideoTutorialService.java

@@ -15,12 +15,12 @@ import java.util.List;
 
 /** A video tutorial service implementation for tests. */
 public class TestVideoTutorialService implements VideoTutorialService {
-    public static final Language HINDI = new Language("hi", "Hindi", "Hindi Native");
-    public static final Language TAMIL = new Language("ta", "Tamil", "Tamil Native");
-    public static final Language ENGLISH = new Language("en", "English", "English Native");
+    public static final Language HINDI = new Language("hi", "hindi", "हिंदी");
+    public static final Language TAMIL = new Language("ta", "Tamil", "தமிழ்");
+    public static final Language ENGLISH = new Language("en", "English", "English");
 
     private final List<Tutorial> mTutorials = new ArrayList<>();
-    private final List<Language> mLanguages = new ArrayList<>();
+    private final List<String> mLanguages = new ArrayList<>();
     private String mPreferredLocale;
 
     public TestVideoTutorialService() {
@@ -42,7 +42,7 @@ public class TestVideoTutorialService implements VideoTutorialService {
     }
 
     @Override
-    public List<Language> getSupportedLanguages() {
+    public List<String> getSupportedLanguages() {
         return mLanguages;
     }
 
@@ -56,7 +56,7 @@ public class TestVideoTutorialService implements VideoTutorialService {
         mPreferredLocale = locale;
     }
 
-    public List<Language> getTestLanguages() {
+    public List<String> getTestLanguages() {
         return mLanguages;
     }
 
@@ -84,8 +84,8 @@ public class TestVideoTutorialService implements VideoTutorialService {
     }
 
     private void initializeLanguages() {
-        mLanguages.add(HINDI);
-        mLanguages.add(TAMIL);
-        mLanguages.add(ENGLISH);
+        mLanguages.add("hi");
+        mLanguages.add("ta");
+        mLanguages.add("en");
     }
 }

chrome/browser/video_tutorials/internal/android/java/src/org/chromium/chrome/browser/video_tutorials/VideoTutorialServiceFactory.java

@@ -54,9 +54,10 @@ public class VideoTutorialServiceFactory {
     public static VideoPlayerCoordinator createVideoPlayerCoordinator(Context context,
             VideoTutorialService videoTutorialService,
             Supplier<Pair<WebContents, ContentView>> webContentsFactory,
-            Callback<Tutorial> tryNowCallback, Runnable closeCallback) {
-        return new VideoPlayerCoordinatorImpl(
-                context, videoTutorialService, webContentsFactory, tryNowCallback, closeCallback);
+            LanguageInfoProvider languageInfoProvider, Callback<Tutorial> tryNowCallback,
+            Runnable closeCallback) {
+        return new VideoPlayerCoordinatorImpl(context, videoTutorialService, webContentsFactory,
+                languageInfoProvider, tryNowCallback, closeCallback);
     }
 
     /** See {@link TutorialListCoordinator}.*/

chrome/browser/video_tutorials/internal/android/java/src/org/chromium/chrome/browser/video_tutorials/bridges/VideoTutorialServiceBridge.java

@@ -46,10 +46,12 @@ public class VideoTutorialServiceBridge implements VideoTutorialService {
     }
 
     @Override
-    public List<Language> getSupportedLanguages() {
-        if (mNativeVideoTutorialServiceBridge == 0) return null;
-        return VideoTutorialServiceBridgeJni.get().getSupportedLanguages(
-                mNativeVideoTutorialServiceBridge, this);
+    public List<String> getSupportedLanguages() {
+        return null;
+        // TODO(shaktisahu): Fix the native to return a list of locales instead of languages.
+        // if (mNativeVideoTutorialServiceBridge == 0) return null;
+        // return VideoTutorialServiceBridgeJni.get().getSupportedLanguages(
+        //         mNativeVideoTutorialServiceBridge, this);
     }
 
     @Override

chrome/browser/video_tutorials/internal/android/java/src/org/chromium/chrome/browser/video_tutorials/languages/LanguagePickerCoordinator.java

@@ -7,6 +7,7 @@ package org.chromium.chrome.browser.video_tutorials.languages;
 import android.content.Context;
 import android.view.View;
 
+import org.chromium.chrome.browser.video_tutorials.LanguageInfoProvider;
 import org.chromium.chrome.browser.video_tutorials.VideoTutorialService;
 import org.chromium.ui.modelutil.MVCListAdapter.ModelList;
 import org.chromium.ui.modelutil.PropertyModel;
@@ -27,13 +28,15 @@ public class LanguagePickerCoordinator {
      * @param view The view representing this language picker.
      * @param videoTutorialService The video tutorial service backend.
      */
-    public LanguagePickerCoordinator(View view, VideoTutorialService videoTutorialService) {
+    public LanguagePickerCoordinator(View view, VideoTutorialService videoTutorialService,
+            LanguageInfoProvider languageInfoProvider) {
         mContext = view.getContext();
         mVideoTutorialService = videoTutorialService;
         mModel = new PropertyModel(LanguagePickerProperties.ALL_KEYS);
         mListModel = new ModelList();
         mView = new LanguagePickerView(view, mModel, mListModel);
-        mMediator = new LanguagePickerMediator(mContext, mModel, mListModel, videoTutorialService);
+        mMediator = new LanguagePickerMediator(
+                mContext, mModel, mListModel, videoTutorialService, languageInfoProvider);
     }
 
     /**

chrome/browser/video_tutorials/internal/android/java/src/org/chromium/chrome/browser/video_tutorials/languages/LanguagePickerMediator.java

@@ -8,6 +8,7 @@ import android.content.Context;
 import android.text.TextUtils;
 
 import org.chromium.chrome.browser.video_tutorials.Language;
+import org.chromium.chrome.browser.video_tutorials.LanguageInfoProvider;
 import org.chromium.chrome.browser.video_tutorials.VideoTutorialService;
 import org.chromium.ui.modelutil.MVCListAdapter.ListItem;
 import org.chromium.ui.modelutil.MVCListAdapter.ModelList;
@@ -22,6 +23,7 @@ import java.util.List;
 public class LanguagePickerMediator {
     private final Context mContext;
     private final VideoTutorialService mVideoTutorialService;
+    private final LanguageInfoProvider mLanguageInfoProvider;
     private final PropertyModel mModel;
     private final ModelList mListModel;
 
@@ -30,9 +32,10 @@ public class LanguagePickerMediator {
      * @param videoTutorialService The video tutorial service backend.
      */
     public LanguagePickerMediator(Context context, PropertyModel model, ModelList listModel,
-            VideoTutorialService videoTutorialService) {
+            VideoTutorialService videoTutorialService, LanguageInfoProvider languageInfoProvider) {
         mContext = context;
         mVideoTutorialService = videoTutorialService;
+        mLanguageInfoProvider = languageInfoProvider;
         mModel = model;
         mListModel = listModel;
     }
@@ -51,11 +54,14 @@ public class LanguagePickerMediator {
         populateList(mVideoTutorialService.getSupportedLanguages());
     }
 
-    private void populateList(List<Language> supportedLanguages) {
+    private void populateList(List<String> supportedLanguages) {
         List<ListItem> listItems = new ArrayList<>();
-        for (Language locale : supportedLanguages) {
+        for (String locale : supportedLanguages) {
+            Language language = mLanguageInfoProvider.getLanguageInfo(locale);
+            if (language == null) continue;
+
             ListItem listItem = new ListItem(
-                    LanguageItemProperties.ITEM_VIEW_TYPE, buildListItemModelFromLocale(locale));
+                    LanguageItemProperties.ITEM_VIEW_TYPE, buildListItemModelFromLocale(language));
             listItems.add(listItem);
         }
         mListModel.set(listItems);

chrome/browser/video_tutorials/internal/android/java/src/org/chromium/chrome/browser/video_tutorials/languages/LanguagePickerMediatorUnitTest.java

@@ -14,10 +14,12 @@ import org.junit.Before;
 import org.junit.Test;
 import org.junit.runner.RunWith;
 import org.mockito.Mock;
+import org.mockito.Mockito;
 import org.mockito.MockitoAnnotations;
 
 import org.chromium.base.metrics.test.ShadowRecordHistogram;
 import org.chromium.base.test.BaseRobolectricTestRunner;
+import org.chromium.chrome.browser.video_tutorials.LanguageInfoProvider;
 import org.chromium.chrome.browser.video_tutorials.test.TestVideoTutorialService;
 import org.chromium.ui.modelutil.MVCListAdapter.ListItem;
 import org.chromium.ui.modelutil.MVCListAdapter.ModelList;
@@ -37,7 +39,9 @@ public class LanguagePickerMediatorUnitTest {
     private ModelList mListModel;
     private LanguagePickerMediator mMediator;
     @Mock
-    PropertyObservable.PropertyObserver<PropertyKey> mPropertyObserver;
+    private PropertyObservable.PropertyObserver<PropertyKey> mPropertyObserver;
+    @Mock
+    private LanguageInfoProvider mLanguageProvider;
 
     @Before
     public void setUp() {
@@ -49,8 +53,8 @@ public class LanguagePickerMediatorUnitTest {
 
         mListModel = new ModelList();
         mTestVideoTutorialService = new TestVideoTutorialService();
-        mMediator =
-                new LanguagePickerMediator(mContext, mModel, mListModel, mTestVideoTutorialService);
+        mMediator = new LanguagePickerMediator(
+                mContext, mModel, mListModel, mTestVideoTutorialService, mLanguageProvider);
     }
 
     @Test
@@ -64,6 +68,13 @@ public class LanguagePickerMediatorUnitTest {
 
     @Test
     public void loadsLanguagesInTheList() {
+        Mockito.when(mLanguageProvider.getLanguageInfo("hi"))
+                .thenReturn(TestVideoTutorialService.HINDI);
+        Mockito.when(mLanguageProvider.getLanguageInfo("ta"))
+                .thenReturn(TestVideoTutorialService.TAMIL);
+        Mockito.when(mLanguageProvider.getLanguageInfo("en"))
+                .thenReturn(TestVideoTutorialService.ENGLISH);
+
         mMediator.showLanguagePicker(() -> {}, () -> {});
 
         assertThat(mListModel.size(), equalTo(mTestVideoTutorialService.getTestLanguages().size()));

chrome/browser/video_tutorials/internal/android/java/src/org/chromium/chrome/browser/video_tutorials/languages/LanguagePickerTest.java

@@ -26,6 +26,7 @@ import org.mockito.Mock;
 import org.mockito.Mockito;
 import org.mockito.MockitoAnnotations;
 
+import org.chromium.chrome.browser.video_tutorials.LanguageInfoProvider;
 import org.chromium.chrome.browser.video_tutorials.R;
 import org.chromium.chrome.browser.video_tutorials.VideoTutorialService;
 import org.chromium.chrome.browser.video_tutorials.test.TestVideoTutorialService;
@@ -46,6 +47,8 @@ public class LanguagePickerTest {
     private View mContentView;
     private VideoTutorialService mVideoTutorialService;
     private LanguagePickerCoordinator mCoordinator;
+    @Mock
+    private LanguageInfoProvider mLanguageProvider;
 
     @Mock
     private Runnable mWatchCallback;
@@ -63,7 +66,10 @@ public class LanguagePickerTest {
             mContentView =
                     LayoutInflater.from(mActivity).inflate(R.layout.language_picker, null, false);
             parentView.addView(mContentView);
-            mCoordinator = new LanguagePickerCoordinator(mContentView, mVideoTutorialService);
+            Mockito.when(mLanguageProvider.getLanguageInfo("hi"))
+                    .thenReturn(TestVideoTutorialService.HINDI);
+            mCoordinator = new LanguagePickerCoordinator(
+                    mContentView, mVideoTutorialService, mLanguageProvider);
             mCoordinator.showLanguagePicker(mWatchCallback, mCloseCallback);
         });
     }

chrome/browser/video_tutorials/internal/android/java/src/org/chromium/chrome/browser/video_tutorials/player/VideoPlayerCoordinatorImpl.java

@@ -10,6 +10,7 @@ import android.view.View;
 
 import org.chromium.base.Callback;
 import org.chromium.base.supplier.Supplier;
+import org.chromium.chrome.browser.video_tutorials.LanguageInfoProvider;
 import org.chromium.chrome.browser.video_tutorials.PlaybackStateObserver;
 import org.chromium.chrome.browser.video_tutorials.R;
 import org.chromium.chrome.browser.video_tutorials.Tutorial;
@@ -48,17 +49,19 @@ public class VideoPlayerCoordinatorImpl implements VideoPlayerCoordinator {
      */
     public VideoPlayerCoordinatorImpl(Context context, VideoTutorialService videoTutorialService,
             Supplier<Pair<WebContents, ContentView>> webContentsFactory,
-            Callback<Tutorial> tryNowCallback, Runnable closeCallback) {
+            LanguageInfoProvider languageInfoProvider, Callback<Tutorial> tryNowCallback,
+            Runnable closeCallback) {
         mContext = context;
         mVideoTutorialService = videoTutorialService;
         mModel = new PropertyModel(VideoPlayerProperties.ALL_KEYS);
 
         ThinWebView thinWebView = createThinWebView(webContentsFactory);
         mView = new VideoPlayerView(context, mModel, thinWebView);
-        mLanguagePicker = new LanguagePickerCoordinator(
-                mView.getView().findViewById(R.id.language_picker), mVideoTutorialService);
+        mLanguagePicker =
+                new LanguagePickerCoordinator(mView.getView().findViewById(R.id.language_picker),
+                        mVideoTutorialService, languageInfoProvider);
         mMediator = new VideoPlayerMediator(mContext, mModel, videoTutorialService, mLanguagePicker,
-                mWebContents, tryNowCallback, closeCallback);
+                languageInfoProvider, mWebContents, tryNowCallback, closeCallback);
         PropertyModelChangeProcessor.create(mModel, mView, new VideoPlayerViewBinder());
     }
 

chrome/browser/video_tutorials/internal/android/java/src/org/chromium/chrome/browser/video_tutorials/player/VideoPlayerMediator.java

@@ -5,10 +5,10 @@
 package org.chromium.chrome.browser.video_tutorials.player;
 
 import android.content.Context;
-import android.text.TextUtils;
 
 import org.chromium.base.Callback;
 import org.chromium.chrome.browser.video_tutorials.Language;
+import org.chromium.chrome.browser.video_tutorials.LanguageInfoProvider;
 import org.chromium.chrome.browser.video_tutorials.PlaybackStateObserver;
 import org.chromium.chrome.browser.video_tutorials.R;
 import org.chromium.chrome.browser.video_tutorials.Tutorial;
@@ -35,16 +35,19 @@ class VideoPlayerMediator implements PlaybackStateObserver.Observer {
     private Tutorial mTutorial;
     private final Callback<Tutorial> mTryNowCallback;
     private final Runnable mCloseCallback;
+    private final LanguageInfoProvider mLanguageInfoProvider;
     private long mVideoStartTime;
 
     /** Constructor. */
     public VideoPlayerMediator(Context context, PropertyModel model,
             VideoTutorialService videoTutorialService, LanguagePickerCoordinator languagePicker,
-            WebContents webContents, Callback<Tutorial> tryNowCallback, Runnable closeCallback) {
+            LanguageInfoProvider languageInfoProvider, WebContents webContents,
+            Callback<Tutorial> tryNowCallback, Runnable closeCallback) {
         mContext = context;
         mModel = model;
         mVideoTutorialService = videoTutorialService;
         mLanguagePicker = languagePicker;
+        mLanguageInfoProvider = languageInfoProvider;
         mWebContents = webContents;
         mTryNowCallback = tryNowCallback;
         mCloseCallback = closeCallback;
@@ -129,14 +132,13 @@ class VideoPlayerMediator implements PlaybackStateObserver.Observer {
     }
 
     private void updateChangeLanguageButtonText() {
-        String locale = mVideoTutorialService.getPreferredLocale();
-        for (Language language : mVideoTutorialService.getSupportedLanguages()) {
-            if (TextUtils.equals(language.locale, locale)) {
-                String buttonText = mContext.getResources().getString(
-                        R.string.video_tutorials_change_language, language.nativeName);
-                mModel.set(VideoPlayerProperties.CHANGE_LANGUAGE_BUTTON_TEXT, buttonText);
-            }
-        }
+        String preferredLocale = mVideoTutorialService.getPreferredLocale();
+        Language language = mLanguageInfoProvider.getLanguageInfo(preferredLocale);
+        if (language == null) return;
+
+        String buttonText = mContext.getResources().getString(
+                R.string.video_tutorials_change_language, language.nativeName);
+        mModel.set(VideoPlayerProperties.CHANGE_LANGUAGE_BUTTON_TEXT, buttonText);
     }
 
     private void onLanguageSelected() {

chrome/browser/video_tutorials/internal/android/java/src/org/chromium/chrome/browser/video_tutorials/player/VideoPlayerMediatorUnitTest.java

@@ -23,6 +23,7 @@ import org.mockito.MockitoAnnotations;
 import org.chromium.base.Callback;
 import org.chromium.base.metrics.test.ShadowRecordHistogram;
 import org.chromium.base.test.BaseRobolectricTestRunner;
+import org.chromium.chrome.browser.video_tutorials.LanguageInfoProvider;
 import org.chromium.chrome.browser.video_tutorials.Tutorial;
 import org.chromium.chrome.browser.video_tutorials.VideoTutorialUtils;
 import org.chromium.chrome.browser.video_tutorials.languages.LanguagePickerCoordinator;
@@ -60,6 +61,8 @@ public class VideoPlayerMediatorUnitTest {
     PropertyObservable.PropertyObserver<PropertyKey> mPropertyObserver;
     @Mock
     Callback<Tutorial> mTryNowCallback;
+    @Mock
+    private LanguageInfoProvider mLanguageProvider;
 
     @Before
     public void setUp() {
@@ -73,7 +76,7 @@ public class VideoPlayerMediatorUnitTest {
 
         mTestVideoTutorialService = new TestVideoTutorialService();
         mMediator = new VideoPlayerMediator(mContext, mModel, mTestVideoTutorialService,
-                mLanguagePicker, mWebContents, mTryNowCallback, mCloseCallback);
+                mLanguagePicker, mLanguageProvider, mWebContents, mTryNowCallback, mCloseCallback);
     }
 
     @Test
@@ -91,7 +94,7 @@ public class VideoPlayerMediatorUnitTest {
 
     @Test
     public void languagePickerNotShownIfPreferredLocaleSetAlready() {
-        mTestVideoTutorialService.setPreferredLocale(TestVideoTutorialService.ENGLISH.locale);
+        mTestVideoTutorialService.setPreferredLocale("en");
         Tutorial tutorial = mTestVideoTutorialService.getTestTutorials().get(0);
         mMediator.playVideoTutorial(tutorial);