Support login custom parameter for github. (#607)

Author: wti806

javascript/widgets/config.js

@@ -551,11 +551,14 @@ firebaseui.auth.widget.Config.prototype.getProviderCustomParameters =
   if (goog.isObject(customParameters)) {
     // Clone original custom parameters.
     var clonedCustomParameters = goog.object.clone(customParameters);
-    // Delete login_hint from provider (only Google supports it) as it could
-    // break the flow.
+    // Delete login_hint from Google provider as it could break the flow.
     if (providerId === firebase.auth.GoogleAuthProvider.PROVIDER_ID) {
       delete clonedCustomParameters['login_hint'];
     }
+    // Delete login from GitHub provider as it could break the flow.
+    if (providerId === firebase.auth.GithubAuthProvider.PROVIDER_ID) {
+      delete clonedCustomParameters['login'];
+    }
     return clonedCustomParameters;
   }
   return null;

javascript/widgets/config_test.js

@@ -50,6 +50,7 @@ function setUp() {
   });
   firebase.auth = {
     GoogleAuthProvider: {PROVIDER_ID: 'google.com'},
+    GithubAuthProvider: {PROVIDER_ID: 'github.com'},
     FacebookAuthProvider: {PROVIDER_ID: 'facebook.com'},
     EmailAuthProvider: {
       EMAIL_LINK_SIGN_IN_METHOD: 'emailLink',
@@ -574,6 +575,25 @@ function testGetProviderCustomParameters_multipleIdp() {
 }
 
 
+function testGetProviderCustomParameters_github() {
+  config.update('signInOptions', [
+    {
+      'provider': 'github.com',
+      'customParameters': {
+        'allow_signup': 'false',
+        'login': '[email protected]'
+      }
+    }
+  ]);
+  // login custom parameter should be deleted.
+  assertObjectEquals(
+      {
+        'allow_signup': 'false'
+      },
+      config.getProviderCustomParameters('github.com'));
+}
+
+
 function testIsAccountSelectionPromptEnabled_googleLoginHint() {
   config.update('signInOptions', [
     {

javascript/widgets/handler/common.js

@@ -811,11 +811,13 @@ firebaseui.auth.widget.handler.common.getAuthProvider_ = function(
   // set and if the provider supports it, add it to the custom paramaters.
   if (opt_email) {
     var loginHintKey;
+    // Since the name of the parameter is known for Google and GitHub, set this
+    // automatically. Google and GitHub are the only default providers which
+    // support a login hint.
     if (providerId == firebase.auth.GoogleAuthProvider.PROVIDER_ID) {
-      // Since the name of the parameter is known for Google, set this
-      // automatically. Google is the only default provider which supports a
-      // login hint.
       loginHintKey = 'login_hint';
+    } else if (providerId == firebase.auth.GithubAuthProvider.PROVIDER_ID) {
+      loginHintKey = 'login';
     } else {
       // For other providers, check if the name is set in the configuration.
       var providerConfig = app.getConfig().getConfigForProvider(providerId);

javascript/widgets/handler/federatedlinking_test.js

@@ -71,6 +71,22 @@ function testHandleFederatedLinking() {
 }
 
 
+function testHandleFederatedLinking_githubLoginHint() {
+  // The login custom parameter should automatically be passed to the
+  // github.com provider.
+  var expectedProvider =
+      getExpectedProviderWithCustomParameters(
+          'github.com', {'login': federatedAccount.getEmail()});
+  setPendingEmailCredentials();
+  firebaseui.auth.widget.handler.handleFederatedLinking(
+      app, container, federatedAccount.getEmail(), 'github.com');
+  assertFederatedLinkingPage(federatedAccount.getEmail());
+  submitForm();
+  testAuth.assertSignInWithRedirect([expectedProvider]);
+  return testAuth.process();
+}
+
+
 function testHandleFederatedLinking_genericLoginHint() {
   // Since Microsoft's signInOptions include a loginHintKey definition,
   // a login_hint should be set in the customParameters.
@@ -88,13 +104,13 @@ function testHandleFederatedLinking_genericLoginHint() {
 
 
 function testHandleFederatedLinking_noLoginHint() {
-  // Since GitHub doesn't support sending a login_hint,
+  // Since Facebook doesn't support sending a login_hint,
   // it should not be set in the customParameters.
   var expectedProvider =
-      getExpectedProviderWithCustomParameters('github.com');
+      getExpectedProviderWithCustomParameters('facebook.com');
   setPendingEmailCredentials();
   firebaseui.auth.widget.handler.handleFederatedLinking(
-      app, container, federatedAccount.getEmail(), 'github.com');
+      app, container, federatedAccount.getEmail(), 'facebook.com');
   assertFederatedLinkingPage(federatedAccount.getEmail());
   submitForm();
   testAuth.assertSignInWithRedirect([expectedProvider]);
@@ -128,18 +144,18 @@ function testHandleFederatedLinking_genericLoginHint_upgradeAnonymous() {
 
 
 function testHandleFederatedLinking_noLoginHint_upgradeAnonymous() {
-  // Since GitHub doesn't support sending a login_hint,
+  // Since Facebook doesn't support sending a login_hint,
   // it should not be set in the customParameters.
   var expectedProvider =
-      getExpectedProviderWithCustomParameters('github.com');
+      getExpectedProviderWithCustomParameters('facebook.com');
   // Simulate pending email credentials.
   setPendingEmailCredentials();
   // Enable anonymous user upgrade.
   app.updateConfig('autoUpgradeAnonymousUsers', true);
   // Simulate anonymous user signed in.
   externalAuth.setUser(anonymousUser);
   firebaseui.auth.widget.handler.handleFederatedLinking(
-      app, container, federatedAccount.getEmail(), 'github.com');
+      app, container, federatedAccount.getEmail(), 'facebook.com');
   assertFederatedLinkingPage(federatedAccount.getEmail());
   submitForm();
   // Trigger initial onAuthStateChanged listener.
@@ -221,16 +237,16 @@ function testHandleFederatedLinking_noLoginHint_cordova() {
   // Simulate a Cordova environment.
   simulateCordovaEnvironment();
   var githubCred = createMockCredential({
-    'providerId': 'github.com',
+    'providerId': 'facebook.com',
     'accessToken': 'ACCESS_TOKEN'
   });
-  // Since GitHub doesn't support sending a login_hint,
+  // Since Facebook doesn't support sending a login_hint,
   // it should not be set in the customParameters.
   var expectedProvider =
-      getExpectedProviderWithCustomParameters('github.com');
+      getExpectedProviderWithCustomParameters('facebook.com');
   setPendingEmailCredentials();
   firebaseui.auth.widget.handler.handleFederatedLinking(
-      app, container, federatedAccount.getEmail(), 'github.com');
+      app, container, federatedAccount.getEmail(), 'facebook.com');
   assertFederatedLinkingPage(federatedAccount.getEmail());
   submitForm();
   testAuth.assertSignInWithRedirect([expectedProvider]);
@@ -253,7 +269,7 @@ function testHandleFederatedLinking_noLoginHint_cordova() {
       'user': testAuth.currentUser,
       'credential': credential,
       'operationType': 'link',
-      'additionalUserInfo': {'providerId': 'facebook.com', 'isNewUser': false}
+      'additionalUserInfo': {'providerId': 'github.com', 'isNewUser': false}
     };
     // Saved pending credential loaded from storage and linked to current user.
     testAuth.currentUser.assertLinkWithCredential(
@@ -284,13 +300,13 @@ function testHandleFederatedLinking_noLoginHint_error_cordova() {
   // Test federated linking error flow in a Cordova environment.
   // Simulate a Cordova environment.
   simulateCordovaEnvironment();
-  // Since GitHub doesn't support sending a login_hint,
+  // Since Facebook doesn't support sending a login_hint,
   // it should not be set in the customParameters.
   var expectedProvider =
-      getExpectedProviderWithCustomParameters('github.com');
+      getExpectedProviderWithCustomParameters('facebook.com');
   setPendingEmailCredentials();
   firebaseui.auth.widget.handler.handleFederatedLinking(
-      app, container, federatedAccount.getEmail(), 'github.com');
+      app, container, federatedAccount.getEmail(), 'facebook.com');
   assertFederatedLinkingPage(federatedAccount.getEmail());
   submitForm();
   testAuth.assertSignInWithRedirect([expectedProvider]);

javascript/widgets/handler/federatedsignin_test.js

@@ -50,6 +50,20 @@ function testHandleFederatedSignIn() {
 }
 
 
+function testHandleFederatedSignIn_githubLoginHint() {
+  // login custom parameter should be passed to the GitHub provider.
+  var expectedProvider = getExpectedProviderWithCustomParameters(
+      'github.com', {'login': '[email protected]'});
+  firebaseui.auth.widget.handler.handleFederatedSignIn(
+      app, container, '[email protected]', 'github.com');
+  assertFederatedLinkingPage();
+  submitForm();
+  testAuth.assertSignInWithRedirect(
+      [expectedProvider]);
+  return testAuth.process();
+}
+
+
 function testHandleFederatedSignIn_cordova() {
   // Test federated sign-in success from a Cordova environment.
   // Add additional scopes to test they are properly passed to sign-in method.