[TwitterKit Deprecation] Replace TwitterKit use with Generic IDP (#1714)

Author: lsirac

app/build.gradle.kts

@@ -46,7 +46,6 @@ dependencies {
     // Needed to override Facebook
     implementation(Config.Libs.Androidx.cardView)
     implementation(Config.Libs.Androidx.customTabs)
-    implementation(Config.Libs.Provider.twitter) { isTransitive = true }
 
     implementation(Config.Libs.Misc.glide)
     annotationProcessor(Config.Libs.Misc.glideCompiler)

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

@@ -149,12 +149,6 @@ public void onCheckedChanged(CompoundButton compoundButton, boolean checked) {
             });
         }
 
-        if (ConfigurationUtils.isTwitterMisconfigured(this)) {
-            mUseTwitterProvider.setChecked(false);
-            mUseTwitterProvider.setEnabled(false);
-            mUseTwitterProvider.setText(R.string.twitter_label_missing_config);
-        }
-
         mUseEmailLinkProvider.setOnCheckedChangeListener(new OnCheckedChangeListener() {
             @Override
             public void onCheckedChanged(CompoundButton buttonView, boolean isChecked) {
@@ -193,8 +187,7 @@ public void onCheckedChanged(CompoundButton compoundButton, boolean checked) {
         });
 
         if (ConfigurationUtils.isGoogleMisconfigured(this)
-                || ConfigurationUtils.isFacebookMisconfigured(this)
-                || ConfigurationUtils.isTwitterMisconfigured(this)) {
+                || ConfigurationUtils.isFacebookMisconfigured(this)) {
             showSnackbar(R.string.configuration_required);
         }
 
@@ -394,10 +387,6 @@ private List<IdpConfig> getSelectedProviders() {
                     .build());
         }
 
-        if (mUseTwitterProvider.isChecked()) {
-            selectedProviders.add(new IdpConfig.TwitterBuilder().build());
-        }
-
         if (mUseEmailProvider.isChecked()) {
             selectedProviders.add(new IdpConfig.EmailBuilder()
                     .setRequireName(mRequireName.isChecked())
@@ -427,6 +416,10 @@ private List<IdpConfig> getSelectedProviders() {
             selectedProviders.add(new IdpConfig.AnonymousBuilder().build());
         }
 
+        if (mUseTwitterProvider.isChecked()) {
+            selectedProviders.add(new IdpConfig.TwitterBuilder().build());
+        }
+
         if (mUseMicrosoftProvider.isChecked()) {
             selectedProviders.add(new IdpConfig.MicrosoftBuilder().build());
         }

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

@@ -28,15 +28,6 @@ public static boolean isFacebookMisconfigured(@NonNull Context context) {
                 context.getString(R.string.facebook_application_id));
     }
 
-    public static boolean isTwitterMisconfigured(@NonNull Context context) {
-        List<String> twitterConfigs = Arrays.asList(
-                context.getString(R.string.twitter_consumer_key),
-                context.getString(R.string.twitter_consumer_secret)
-        );
-
-        return twitterConfigs.contains(AuthUI.UNCONFIGURED_CONFIG_VALUE);
-    }
-
     @NonNull
     public static List<AuthUI.IdpConfig> getConfiguredProviders(@NonNull Context context) {
         List<AuthUI.IdpConfig> providers = new ArrayList<>();
@@ -49,10 +40,6 @@ public static List<AuthUI.IdpConfig> getConfiguredProviders(@NonNull Context con
             providers.add(new AuthUI.IdpConfig.FacebookBuilder().build());
         }
 
-        if (!isTwitterMisconfigured(context)) {
-            providers.add(new AuthUI.IdpConfig.TwitterBuilder().build());
-        }
-
         ActionCodeSettings actionCodeSettings = ActionCodeSettings.newBuilder()
                 .setAndroidPackageName("com.firebase.uidemo", true, null)
                 .setHandleCodeInApp(true)
@@ -65,7 +52,7 @@ public static List<AuthUI.IdpConfig> getConfiguredProviders(@NonNull Context con
                 .setActionCodeSettings(actionCodeSettings)
                 .build());
 
-
+        providers.add(new AuthUI.IdpConfig.TwitterBuilder().build());
         providers.add(new AuthUI.IdpConfig.PhoneBuilder().build());
         providers.add(new AuthUI.IdpConfig.MicrosoftBuilder().build());
         providers.add(new AuthUI.IdpConfig.YahooBuilder().build());

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

@@ -6,9 +6,6 @@
     <string name="facebook_application_id" translatable="false">CHANGE-ME</string>
     <string name="facebook_login_protocol_scheme" translatable="false">fbYOUR_APP_ID</string>
 
-    <string name="twitter_consumer_key" translatable="false">CHANGE-ME</string>
-    <string name="twitter_consumer_secret" translatable="false">CHANGE-ME</string>
-
     <string name="github_client_id" translatable="false">CHANGE-ME</string>
     <string name="github_client_secret" translatable="false">CHANGE-ME</string>
 </resources>

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

@@ -71,7 +71,6 @@
     <string name="configuration_required">Configuration required - see README.md</string>
     <string name="google_label_missing_config">Google configuration missing</string>
     <string name="facebook_label_missing_config">Facebook configuration missing</string>
-    <string name="twitter_label_missing_config">Twitter configuration missing</string>
 
     <string name="sign_in_cancelled">Sign in cancelled</string>
     <string name="no_internet_connection">No internet connection</string>

auth/README.md

@@ -70,10 +70,6 @@ dependencies {
     // Required only if Facebook login support is required
     // Find the latest Facebook SDK releases here: https://goo.gl/Ce5L94
     implementation 'com.facebook.android:facebook-login:4.x'
-
-    // Required only if Twitter login support is required
-    // Find the latest Twitter SDK releases here: https://goo.gl/E5wZvQ
-    implementation("com.twitter.sdk.android:twitter-core:3.x@aar") { transitive = true }
 }
 ```
 
@@ -121,34 +117,7 @@ the [Facebook developer dashboard](https://developers.facebook.com):
 </resources>
 ```
 
-#### Twitter
-
-If support for Twitter Sign-in is also required, define the resource strings
-`twitter_consumer_key` and `twitter_consumer_secret` to match the values of your
-Twitter app as reported by the [Twitter application manager](https://apps.twitter.com/).
-
-```xml
-<resources>
-  <string name="twitter_consumer_key" translatable="false">YOUR_CONSUMER_KEY</string>
-  <string name="twitter_consumer_secret" translatable="false">YOUR_CONSUMER_SECRET</string>
-</resources>
-```
-
-In addition, you must enable the "Request email addresses from users" permission
-in the "Permissions" tab of your Twitter app.
-
-In order to resolve the Twitter SDK, add the following repository to your `build.gradle`:
-
-```groovy
-allprojects {
-    repositories {
-        // ...
-        maven { url 'https://maven.fabric.io/public' }
-    }
-}
-```
-
-#### Microsoft, Apple, and Yahoo
+#### Microsoft, Apple, Twitter and Yahoo
 
 No FirebaseUI configuration is required for these providers.
 
@@ -176,6 +145,11 @@ 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).
 
+##### Twitter
+
+You must enable the "Request email addresses from users" permission in the "Permissions" tab of your
+Twitter app.
+
 #### GitHub
 
 We do not currently support Github as a sign-in method in FirebaseUI on Android. The current

auth/auth-proguard.pro

@@ -1,14 +1,11 @@
 # 3P providers are optional
 -dontwarn com.facebook.**
--dontwarn com.twitter.**
 # Keep the class names used to check for availablility
 -keepnames class com.facebook.login.LoginManager
--keepnames class com.twitter.sdk.android.core.identity.TwitterAuthClient
 
 # Don't note a bunch of dynamically referenced classes
 -dontnote com.google.**
 -dontnote com.facebook.**
--dontnote com.twitter.**
 -dontnote com.squareup.okhttp.**
 -dontnote okhttp3.internal.**
 
@@ -18,7 +15,7 @@
 
 # Retrofit config
 -dontnote retrofit2.Platform
--dontwarn retrofit2.** # Also keeps Twitter at bay as long as they keep using Retrofit
+-dontwarn retrofit2.**
 -dontwarn okhttp3.**
 -dontwarn okio.**
 -keepattributes Exceptions

auth/build.gradle.kts

@@ -40,15 +40,13 @@ dependencies {
     compileOnly(Config.Libs.Provider.facebook)
     implementation(Config.Libs.Androidx.legacySupportv4) // Needed to override deps
     implementation(Config.Libs.Androidx.cardView) // Needed to override Facebook
-    compileOnly(Config.Libs.Provider.twitter) { isTransitive = true }
 
     testImplementation(Config.Libs.Test.junit)
     testImplementation(Config.Libs.Test.truth)
     testImplementation(Config.Libs.Test.mockito)
     testImplementation(Config.Libs.Test.core)
     testImplementation(Config.Libs.Test.robolectric)
     testImplementation(Config.Libs.Provider.facebook)
-    testImplementation(Config.Libs.Provider.twitter) { isTransitive = true }
 
     debugImplementation(project(":internal:lintchecks"))
 }

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

@@ -24,7 +24,6 @@
 
 import com.facebook.login.LoginManager;
 import com.firebase.ui.auth.data.model.FlowParameters;
-import com.firebase.ui.auth.data.remote.TwitterSignInHandler;
 import com.firebase.ui.auth.ui.idp.AuthMethodPickerActivity;
 import com.firebase.ui.auth.util.CredentialUtils;
 import com.firebase.ui.auth.util.ExtraConstants;
@@ -61,7 +60,6 @@
 import com.google.firebase.auth.PhoneAuthProvider;
 import com.google.firebase.auth.TwitterAuthProvider;
 import com.google.firebase.auth.UserInfo;
-import com.twitter.sdk.android.core.TwitterCore;
 
 import java.lang.annotation.Retention;
 import java.lang.annotation.RetentionPolicy;
@@ -139,18 +137,18 @@ public final class AuthUI {
             Collections.unmodifiableSet(new HashSet<>(Arrays.asList(
                     MICROSOFT_PROVIDER,
                     YAHOO_PROVIDER,
-                    APPLE_PROVIDER
+                    APPLE_PROVIDER,
+                    TwitterAuthProvider.PROVIDER_ID
             )));
 
     /**
-     * The set of social authentication providers supported in Firebase Auth UI.
+     * The set of social authentication providers supported in Firebase Auth UI using their SDK.
      */
     @RestrictTo(RestrictTo.Scope.LIBRARY_GROUP)
     public static final Set<String> SOCIAL_PROVIDERS =
             Collections.unmodifiableSet(new HashSet<>(Arrays.asList(
                     GoogleAuthProvider.PROVIDER_ID,
                     FacebookAuthProvider.PROVIDER_ID,
-                    TwitterAuthProvider.PROVIDER_ID,
                     GithubAuthProvider.PROVIDER_ID)));
 
     @RestrictTo(RestrictTo.Scope.LIBRARY_GROUP)
@@ -203,6 +201,13 @@ public static AuthUI getInstance() {
      */
     @NonNull
     public static AuthUI getInstance(@NonNull FirebaseApp app) {
+        if (ProviderAvailability.IS_TWITTER_AVAILABLE) {
+            String releaseUrl = "https://github.com/firebase/FirebaseUI-Android/releases/tag/6.2.0";
+            Log.w(TAG, String.format("Beginning with FirebaseUI 6.2.0 you no longer need to " +
+                    "include the TwitterKit SDK to sign in with Twitter. " +
+                    "Go to %s for more information", releaseUrl));
+        }
+
         AuthUI authUi;
         synchronized (INSTANCES) {
             authUi = INSTANCES.get(app);
@@ -455,10 +460,6 @@ private Task<Void> signOutIdps(@NonNull Context context) {
         if (ProviderAvailability.IS_FACEBOOK_AVAILABLE) {
             LoginManager.getInstance().logOut();
         }
-        if (ProviderAvailability.IS_TWITTER_AVAILABLE) {
-            TwitterSignInHandler.initializeTwitter();
-            TwitterCore.getInstance().getSessionManager().clearActiveSession();
-        }
         return GoogleSignIn.getClient(context, GoogleSignInOptions.DEFAULT_SIGN_IN).signOut();
     }
 
@@ -483,7 +484,8 @@ public SignInIntentBuilder createSignInIntentBuilder() {
     })
 
     @Retention(RetentionPolicy.SOURCE)
-    public @interface SupportedProvider {}
+    public @interface SupportedProvider {
+    }
 
     /**
      * Configuration for an identity provider.
@@ -1068,29 +1070,6 @@ public FacebookBuilder setPermissions(@NonNull List<String> permissions) {
             }
         }
 
-        /**
-         * {@link IdpConfig} builder for the Twitter provider.
-         */
-        public static final class TwitterBuilder extends Builder {
-            public TwitterBuilder() {
-                super(TwitterAuthProvider.PROVIDER_ID);
-                if (!ProviderAvailability.IS_TWITTER_AVAILABLE) {
-                    throw new RuntimeException(
-                            "Twitter provider cannot be configured " +
-                                    "without dependency. Did you forget to add " +
-                                    "'com.twitter.sdk.android:twitter-core:VERSION' dependency?");
-                }
-                Preconditions.checkConfigured(getApplicationContext(),
-                        "Twitter provider unconfigured. Make sure to add your key and secret." +
-                                " See the docs for more info:" +
-                                " https://github" +
-                                ".com/firebase/FirebaseUI-Android/blob/master/auth/README" +
-                                ".md#twitter",
-                        R.string.twitter_consumer_key,
-                        R.string.twitter_consumer_secret);
-            }
-        }
-
         /**
          * {@link IdpConfig} builder for the GitHub provider.
          */
@@ -1138,6 +1117,19 @@ public AnonymousBuilder() {
             }
         }
 
+        /**
+         * {@link IdpConfig} builder for the Twitter provider.
+         */
+        public static final class TwitterBuilder extends GenericOAuthProviderBuilder {
+            private static final String PROVIDER_NAME = "Twitter";
+
+            public TwitterBuilder() {
+                super(TwitterAuthProvider.PROVIDER_ID, PROVIDER_NAME,
+                        R.layout.fui_idp_button_twitter);
+            }
+        }
+
+
         /**
          * {@link IdpConfig} builder for the Apple provider.
          */