JU-11 Add the ability to customize the registration fields (DS-303)

[Henrrypg]

This feature adds the ability to customize the registration form

Documentation

https://docs.google.com/document/d/1XpVO596QXbx6IAzo88jiHMxH08tCO3s-NXx85TWjrB0/edit

For further context about the implementation, you can refer to the PRs description from the Juniper migration, where the feature was added.

PRs from previous migration

• JU-11 Add the ability to customize the registration fields #580
• fix: fix instance typo when creating select field #583

About the code refactor

The idea is support this feature as a filter pipeline, so this refactor is in order to take it as example to sustent the filter in the upstream PR.

• feat: add filter before user setttings context is rendered openedx/openedx-filters#46
• Add openedx-filters hook to account settings before rendering it context openedx/edx-platform#31295

Testing

Microsite settings

   "EDNX_CUSTOM_REGISTRATION_FIELDS": [
       {
           "label": "Document Type",
           "name": "type_document",
           "options": [
               "DNI",
               "PASSPORT",
               "ID"
           ],
           "type": "select"
       },
       {
           "label": "Document Number",
           "name": "personal_id",
           "type": "text"
       },
       {
           "label": "Phone number",
           "name": "mobile",
           "type": "text"
       },
       {
           "label": "Address",
           "name": "address",
           "type": "text"
       },
       {
           "label": "Company Name",
           "name": "company",
           "type": "text"
       }
   ],
   "REGISTRATION_EXTRA_FIELDS": {
       "address": "required",
       "company": "optional",
       "country": "hidden",
       "gender": "required",
       "goals": "hidden",
       "honor_code": "hidden",
       "level_of_education": "hidden",
       "mailing_address": "hidden",
       "mobile": "required",
       "personal_id": "required",
       "terms_of_service": "required",
       "type_document": "required",
       "year_of_birth": "hidden"
   },
   "REGISTRATION_FIELD_ORDER": [
       "gender",
       "type_document",
       "personal_id",
       "email",
       "mobile",
       "address",
       "company"
   ],
   "extended_profile_fields": [
       "type_document",
       "personal_id",
       "mobile",
       "address",
       "company"
   ],
   "OPEN_EDX_FILTERS_CONFIG": {
        "org.openedx.learning.student.registration.render.started.v1": {
            "fail_silently": false,
            "pipeline": [
                "openedx.core.djangoapps.user_authn.views.registration_form.AddCustomFieldsBeforeRegistration"
            ]
        },
        "org.openedx.learning.student.settings.render.started.v1": {
                  "fail_silently": false,
                  "pipeline": [
                      "openedx.core.djangoapps.user_api.accounts.settings_views.AddCustomOptionsOnAccountSettings"
                  ]
              }
          }

Now you look at registration form in /register

in /admin/auth/user/

In account/settings you should look your custom field types, for this example Type Document as List instead of plain text.

[Henrrypg]

@mariajgrimaldi @felipemontoya what are your thoughts on this?

[Henrrypg]

Thank you @MaferMazu, i focused in the implementation and forget to change these names. I made some changes, can you check again?

[JuanDavidBuitrago]

I'm not sure with some classes names, but I think this would be a conversation in upstream PRs.

I tested it and it's working as expected

[MaferMazu]

Looks good to me. I tested the extra fields and the scripts. I had problems testing the alert on the login page (I tried using /login and /login.*, maybe is something wrong in my config); if you can test it, I don't have problems merging this.

On the other hand, please update the doc in this PR and in the drive for leave instructions on how to test this with filters and Tenant Config; we want to deprecate Microsite.

[felipemontoya]

I'm ok with the way this was implemented in this PR, but I wonder if we use the StudentRegistrationRequested for part of this logic.

Would it make sense to alter the form only at theme and later receive those fields in the StudentRegistrationRequested filter for processing?