Identity providers(mappers): update form fields for all Social mapper types (#1304)

Co-authored-by: Jon Koops <jonkoops@gmail.com>

cypress/integration/identity_providers.spec.ts

@@ -272,6 +272,20 @@ describe("Identity provider test", () => {
       masthead.checkNotificationMessage(createMapperSuccessMsg);
     });
 
+    it("should add Social mapper of type Attribute Importer", () => {
+      sidebarPage.goToIdentityProviders();
+
+      listingPage.goToItemDetails("facebook");
+
+      addMapperPage.goToMappersTab();
+
+      addMapperPage.addMapper();
+
+      addMapperPage.fillSocialMapper("facebook attribute importer");
+
+      masthead.checkNotificationMessage(createMapperSuccessMsg);
+    });
+
     it("should edit Username Template Importer mapper", () => {
       sidebarPage.goToIdentityProviders();
 
@@ -293,7 +307,7 @@ describe("Identity provider test", () => {
 
       addMapperPage.goToMappersTab();
 
-      listingPage.goToItemDetails("facebook mapper");
+      listingPage.goToItemDetails("facebook attribute importer");
 
       addMapperPage.editSocialMapper();
     });

cypress/support/pages/admin_console/manage/identity_providers/AddMapperPage.ts

@@ -9,7 +9,10 @@ export default class AddMapperPage {
   private mapperRoleInput = "mapper-role-input";
   private attributeName = "attribute-name";
   private attributeFriendlyName = "attribute-friendly-name";
+  private attributeValue = "attribute-value";
   private claimInput = "claim";
+  private claimValueInput = "claim-value-input";
+  private socialProfileJSONfieldPath = "social-profile-JSON-field-path";
   private userAttribute = "user-attribute";
   private userAttributeName = "user-attribute-name";
   private userAttributeValue = "user-attribute-value";
@@ -73,14 +76,17 @@ export default class AddMapperPage {
       .contains("Attribute Importer")
       .click();
 
-    cy.findByTestId(this.userSessionAttribute).clear();
-    cy.findByTestId(this.userSessionAttribute).type("user session attribute");
-    cy.findByTestId(this.userSessionAttributeValue).clear();
-
-    cy.findByTestId(this.userSessionAttributeValue).type(
-      "user session attribute value"
+    cy.findByTestId(this.socialProfileJSONfieldPath).clear();
+    cy.findByTestId(this.socialProfileJSONfieldPath).type(
+      "social profile JSON field path"
     );
 
+    cy.findByTestId(this.userAttributeName).clear();
+
+    cy.findByTestId(this.userAttributeName).type("user attribute name");
+
+    this.saveNewMapper();
+
     return this;
   }
 
@@ -332,16 +338,16 @@ export default class AddMapperPage {
 
     cy.findByTestId("inherit").click();
 
-    cy.findByTestId(this.userSessionAttribute).clear();
-    cy.findByTestId(this.userSessionAttribute).type(
-      "user session attribute_edited"
-    );
-    cy.findByTestId(this.userSessionAttributeValue).clear();
+    cy.findByTestId(this.socialProfileJSONfieldPath).clear();
 
-    cy.findByTestId(this.userSessionAttributeValue).type(
-      "user session attribute value_edited"
+    cy.findByTestId(this.socialProfileJSONfieldPath).type(
+      "social profile JSON field path edited"
     );
 
+    cy.findByTestId(this.userAttributeName).clear();
+
+    cy.findByTestId(this.userAttributeName).type("user attribute name edited");
+
     this.saveNewMapper();
 
     return this;

src/identity-providers/add/AddMapperForm.tsx

@@ -20,11 +20,11 @@ import type { IdPMapperRepresentationWithAttributes } from "./AddMapper";
 type AddMapperFormProps = {
   mapperTypes?: Record<string, IdentityProviderMapperRepresentation>;
   mapperType: string;
-  providerId: string;
   id: string;
   updateMapperType: (mapperType: string) => void;
   form: UseFormMethods<IdPMapperRepresentationWithAttributes>;
   formValues: IdPMapperRepresentationWithAttributes;
+  isSocialIdP: boolean;
 };
 
 export const AddMapperForm = ({
@@ -34,6 +34,7 @@ export const AddMapperForm = ({
   id,
   updateMapperType,
   formValues,
+  isSocialIdP,
 }: AddMapperFormProps) => {
   const { t } = useTranslation("identity-providers");
 
@@ -129,7 +130,9 @@ export const AddMapperForm = ({
             helpText={
               formValues.identityProviderMapper ===
                 "saml-user-attribute-idp-mapper" &&
-              (providerId === "oidc" || providerId === "keycloak-oidc")
+              (providerId === "oidc" ||
+                providerId === "keycloak-oidc" ||
+                isSocialIdP)
                 ? `identity-providers-help:oidcAttributeImporter`
                 : `identity-providers-help:${mapperType}`
             }
@@ -142,7 +145,9 @@ export const AddMapperForm = ({
         <Controller
           name="identityProviderMapper"
           defaultValue={
-            providerId === "saml"
+            isSocialIdP
+              ? `${providerId.toLowerCase()}-user-attribute-mapper`
+              : providerId === "saml"
               ? "saml-advanced-role-idp-mapper"
               : "oidc-advanced-role-idp-mapper"
           }

src/identity-providers/help.ts

@@ -136,6 +136,8 @@ export default {
     userAttribute: "Name of user attribute you want to hardcode",
     claim:
       "Name of claim to search for in token. You can reference nested claims by using a '.', i.e. 'address.locality'. To use dot (.) literally, escape it with backslash. (\\.)",
+    socialProfileJSONFieldPath:
+      "Path of field in Social Provider User Profile JSON data to get value from. You can use dot notation for nesting and square brackets for array index. E.g. 'contact.address[0].country'.",
     userAttributeValue: "Value you want to hardcode",
     attributeName:
       "Name of attribute to search for in assertion. You can leave this blank and specify a friendly name instead.",
@@ -143,6 +145,7 @@ export default {
       "Friendly name of attribute to search for in assertion. You can leave this blank and specify a name instead.",
     userAttributeName:
       "User attribute name to store SAML attribute. Use email, lastName, and firstName to map to those predefined user properties.",
+    socialUserAttributeName: "User attribute name to store information.",
     attributeValue:
       "Value the attribute must have. If the attribute is a list, then the value must be contained in the list.",
     attributes:

src/identity-providers/messages.ts

@@ -74,6 +74,7 @@ export default {
     claim: "Claim",
     claimValue: "Claim Value",
     claims: "Claims",
+    socialProfileJSONFieldPath: "Social Profile JSON Field Path",
     mapperAttributeName: "Attribute Name",
     mapperUserAttributeName: "User Attribute Name",
     mapperAttributeFriendlyName: "Friendly name",