Support for Generic OAuth Providers (initial support for Microsoft, Yahoo, and Apple) (#1705)

Author: lsirac

app/src/main/java/com/firebase/uidemo/auth/AuthUiActivity.java

@@ -76,6 +76,9 @@ public class AuthUiActivity extends AppCompatActivity {
     @BindView(R.id.email_link_provider) CheckBox mUseEmailLinkProvider;
     @BindView(R.id.phone_provider) CheckBox mUsePhoneProvider;
     @BindView(R.id.anonymous_provider) CheckBox mUseAnonymousProvider;
+    @BindView(R.id.apple_provider) CheckBox mUseAppleProvider;
+    @BindView(R.id.microsoft_provider) CheckBox mUseMicrosoftProvider;
+    @BindView(R.id.yahoo_provider) CheckBox mUseYahooProvider;
 
     @BindView(R.id.default_layout) RadioButton mDefaultLayout;
     @BindView(R.id.custom_layout) RadioButton mCustomLayout;
@@ -182,6 +185,8 @@ public void onCheckedChanged(CompoundButton compoundButton, boolean checked) {
                     mUseEmailLinkProvider.setChecked(false);
                     mUsePhoneProvider.setChecked(false);
                     mUseAnonymousProvider.setChecked(false);
+                    mUseYahooProvider.setChecked(false);
+                    mUseAppleProvider.setChecked(false);
                 }
             }
         });
@@ -421,6 +426,18 @@ private List<IdpConfig> getSelectedProviders() {
             selectedProviders.add(new IdpConfig.AnonymousBuilder().build());
         }
 
+        if (mUseMicrosoftProvider.isChecked()) {
+            selectedProviders.add(new IdpConfig.MicrosoftBuilder().build());
+        }
+
+        if (mUseYahooProvider.isChecked()) {
+            selectedProviders.add(new IdpConfig.YahooBuilder().build());
+        }
+
+        if (mUseAppleProvider.isChecked()) {
+            selectedProviders.add(new IdpConfig.AppleBuilder().build());
+        }
+
         return selectedProviders;
     }
 

app/src/main/java/com/firebase/uidemo/auth/SignedInActivity.java

@@ -192,8 +192,7 @@ private void populateProfile(@Nullable IdpResponse response) {
                         // Ignore this provider, it's not very meaningful
                         break;
                     default:
-                        throw new IllegalStateException(
-                                "Unknown provider: " + info.getProviderId());
+                        providers.add(info.getProviderId());
                 }
             }
         }

app/src/main/java/com/firebase/uidemo/util/ConfigurationUtils.java

@@ -67,7 +67,8 @@ public static List<AuthUI.IdpConfig> getConfiguredProviders(@NonNull Context con
 
 
         providers.add(new AuthUI.IdpConfig.PhoneBuilder().build());
-
+        providers.add(new AuthUI.IdpConfig.MicrosoftBuilder().build());
+        providers.add(new AuthUI.IdpConfig.YahooBuilder().build());
 
         return providers;
     }

app/src/main/res/layout/auth_ui_layout.xml

@@ -102,6 +102,27 @@
                 android:checked="true"
                 android:text="@string/providers_anonymous" />
 
+            <CheckBox
+                android:id="@+id/apple_provider"
+                android:layout_width="wrap_content"
+                android:layout_height="wrap_content"
+                android:checked="true"
+                android:text="@string/providers_apple" />
+
+            <CheckBox
+                android:id="@+id/microsoft_provider"
+                android:layout_width="wrap_content"
+                android:layout_height="wrap_content"
+                android:checked="true"
+                android:text="@string/providers_microsoft" />
+
+            <CheckBox
+                android:id="@+id/yahoo_provider"
+                android:layout_width="wrap_content"
+                android:layout_height="wrap_content"
+                android:checked="true"
+                android:text="@string/providers_yahoo" />
+
             <TextView
                 style="@style/Base.TextAppearance.AppCompat.Subhead"
                 android:layout_width="wrap_content"

app/src/main/res/values/strings.xml

@@ -30,6 +30,9 @@
     <string name="providers_email_link">Email link</string>
     <string name="providers_phone">Phone</string>
     <string name="providers_anonymous">Anonymous</string>
+    <string name="providers_apple">Apple</string>
+    <string name="providers_microsoft">Microsoft</string>
+    <string name="providers_yahoo">Yahoo</string>
 
     <string name="layout_header">Layout</string>
     <string name="layout_default">Default</string>

auth-github/src/main/java/com/firebase/ui/auth/data/remote/GitHubSignInHandler.java

@@ -20,6 +20,7 @@
 import com.firebase.ui.auth.util.ExtraConstants;
 import com.firebase.ui.auth.viewmodel.ProviderSignInBase;
 import com.firebase.ui.auth.viewmodel.RequestCodes;
+import com.google.firebase.auth.FirebaseAuth;
 import com.google.firebase.auth.GithubAuthProvider;
 
 import java.util.ArrayList;
@@ -183,4 +184,11 @@ private interface GitHubApi {
         @GET("user")
         Call<GitHubProfile> getUser(@Header("Authorization") String token);
     }
+
+    @Override
+    public void startSignIn(@NonNull FirebaseAuth auth,
+                            @NonNull HelperActivityBase activity,
+                            @NonNull String providerId) {
+        startSignIn(activity);
+    }
 }

auth/README.md

@@ -97,8 +97,8 @@ for more information.
 
 ### Identity provider configuration
 
-In order to use either Google, Facebook or Twitter accounts with your app, ensure that
-these authentication methods are first configured in the Firebase console.
+In order to use either Google, Facebook, Twitter, Microsoft, Apple, or Yahoo accounts with your
+app, ensure that these authentication methods are first configured in the Firebase console.
 
 #### Google
 
@@ -148,6 +148,34 @@ allprojects {
 }
 ```
 
+#### Microsoft, Apple, and Yahoo
+
+No FirebaseUI configuration is required for these providers.
+
+We support the use of scopes and custom parameters for these providers. For example:
+
+```java
+List<String> scopes =
+    new ArrayList<String>() {
+      {
+        add("mail.read");
+        add("calendars.read");
+      }
+    };
+
+Map<String, String> customParams = new HashMap<>();
+customParams.put("tenant", "TENANT_ID");
+
+IdpConfig microsoftConfig = new IdpConfig.MicrosoftBuilder()
+                    .setScopes(scopes)
+                    .setCustomParameters(customParams)
+                    .build();
+selectedProviders.add(microsoftConfig);
+```
+
+Note: unlike other sign-in methods, signing in with these providers involves the use of a
+[Custom Chrome Tab](https://developer.chrome.com/multidevice/android/customtabs).
+
 #### GitHub
 
 We do not currently support Github as a sign-in method in FirebaseUI on Android. The current
@@ -236,6 +264,9 @@ startActivityForResult(
                         new AuthUI.IdpConfig.GoogleBuilder().build(),
                         new AuthUI.IdpConfig.FacebookBuilder().build(),
                         new AuthUI.IdpConfig.TwitterBuilder().build(),
+                        new AuthUI.IdpConfig.MicrosoftBuilder().build(),
+                        new AuthUI.IdpConfig.YahooBuilder().build(),
+                        new AuthUI.IdpConfig.AppleBuilder().build(),
                         new AuthUI.IdpConfig.EmailBuilder().build(),
                         new AuthUI.IdpConfig.PhoneBuilder().build(),
                         new AuthUI.IdpConfig.AnonymousBuilder().build()))

auth/build.gradle.kts

@@ -13,6 +13,10 @@ android {
         disable("UnknownNullness")  // TODO fix in future PR
         disable("TypographyQuotes") // Straight versus directional quotes
         disable("DuplicateStrings")
+        disable("MissingTranslation") // TODO add translations
+        disable("LocaleFolder")
+        disable("IconLocation")
+        disable("VectorPath")
     }
 
     testOptions {

auth/src/main/java/com/firebase/ui/auth/AuthMethodPickerLayout.java

@@ -158,6 +158,24 @@ public AuthMethodPickerLayout.Builder setAnonymousButtonId(@IdRes int anonymousB
             return this;
         }
 
+        public AuthMethodPickerLayout.Builder setMicrosoftButtonId(
+                @IdRes int microsoftButtonId) {
+            providersMapping.put(AuthUI.MICROSOFT_PROVIDER, microsoftButtonId);
+            return this;
+        }
+
+        public AuthMethodPickerLayout.Builder setAppleButtonId(
+                @IdRes int appleButtonId) {
+            providersMapping.put(AuthUI.APPLE_PROVIDER, appleButtonId);
+            return this;
+        }
+
+        public AuthMethodPickerLayout.Builder setYahooButtonId(
+                @IdRes int yahooButtonId) {
+            providersMapping.put(AuthUI.YAHOO_PROVIDER, yahooButtonId);
+            return this;
+        }
+
         /**
          * Set the ID of a TextView where terms of service and privacy policy should be
          * displayed.
@@ -173,7 +191,8 @@ public AuthMethodPickerLayout build() {
             }
 
             for (String key : providersMapping.keySet()) {
-                if (!AuthUI.SUPPORTED_PROVIDERS.contains(key)) {
+                if (!AuthUI.SUPPORTED_PROVIDERS.contains(key)
+                        && !AuthUI.SUPPORTED_OAUTH_PROVIDERS.contains(key)) {
                     throw new IllegalArgumentException("Unknown provider: " + key);
                 }
             }