feat: add slot to extend the profile fields #1211

bra-i-am · 2025-05-19T22:36:02Z

Description

This PR creates a slot ExtendedProfileFieldsSlot and inserts it into ProfilePage.jsx. The main goal of this change is to allow the extension of the profile fields.

This use case is required by NAU and can be validated by @igobranco

Screenshots

Before	After

How Has This Been Tested?

In case you want to test my implementation, I'll leave you a little guide down below:

Have a tutor environment (I used Tutor Main)

You have to mount this MFE on the branch of this PR so you can use the slot:
a. Add this script to the following tutor plugin to override the branch of Profle MFE

from tutormfe.hooks import MFE_APPS

@MFE_APPS.add()
def _add_my_mfe(mfes):
mfes["profile"] = {
     "repository": "https://github.com/edunext/frontend-app-profile.git",
     "port": 1995,
     "version": "bc/add-extra-fields-slot",
 }

b. Another way we can do this in the queue is by tutor mounts add the MFE in our Tutor local env. To do this, we must:

Install the @edunext/frontend-component-extended-fields@latest package in our MFE Profile.

Create an env.config.jsx file in the root of the MFE with the following configuration:

import { PLUGIN_OPERATIONS, DIRECT_PLUGIN } from '@openedx/frontend-plugin-framework';
import { ExtendedProfileFields } from '@edunext/frontend-component-extended-fields';

// Load environment variables from .env file
const config = {
  ...process.env,
  pluginSlots: {
    extended_profile_fields_slot: {
      plugins: [
        {
          op: PLUGIN_OPERATIONS.Insert,
          widget: {
            id: 'extended_profile_fields',
            type: DIRECT_PLUGIN,
        RenderWidget: ExtendedProfileFields,
          },
        },
      ],
    },
  },
};

export default config;

Create a tutor plugin and enable it:

from tutormfe.hooks import PLUGIN_SLOTS
from tutor import hooks

hooks.Filters.ENV_PATCHES.add_item(
    (
        "mfe-dockerfile-post-npm-install",
        """
# npm package
RUN npm install '@edunext/frontend-component-extended-fields@latest'
""",
    )
)

hooks.Filters.ENV_PATCHES.add_item(
    (
        "mfe-env-config-buildtime-imports",
        """
import { ExtendedProfileFields } from '@edunext/frontend-component-extended-fields';
""",
    )
)

PLUGIN_SLOTS.add_items(
    [
        (
            "profile",
            "extended_profile_fields_slot",
            """
        {
          op: PLUGIN_OPERATIONS.Insert,
          widget: {
            id: 'extended_profile_fields',
		    type: DIRECT_PLUGIN,
		    RenderWidget: ExtendedProfileFields,
          },
        }""",
        ),
    ]
)

Run tutor images build mfe --no-cache

Add this in the config.yml to add the custom form:

OPENEDX_EXTRA_PIP_REQUIREMENTS:
- git+https://github.com/bra-i-am/custom-form-app.git

Add the following env variables

# lms.env.yml
ADDL_INSTALLED_APPS:
  - "custom_reg_form"
ENABLE_COMBINED_LOGIN_REGISTRATION: true
REGISTRATION_EXTENSION_FORM: "custom_reg_form.forms.ExtraInfoForm"

# cms.env.yml
ENABLE_COMBINED_LOGIN_REGISTRATION: true

Run tutor images build openedx --no-cache
Run tutor local start

Add the following settings to the Site Configurations > local.openedx.io:

{
    "ENABLE_PROFILE_MICROFRONTEND": "true",
    "ENABLE_DYNAMIC_REGISTRATION_FIELDS": "true",
    "MFE_CONFIG": {
        "ENABLE_DYNAMIC_REGISTRATION_FIELDS": "true"
    },
    "REGISTRATION_EXTRA_FIELDS": {
        "employment_situation": "required",
        "data_authorization": "required",
        "allow_newsletter": "required",
        "terms_of_service": "hidden",
        "honor_code": "hidden",
        "full_name": "required",
        "bio": "required",
        "wants_newsletter": "required",
        "favorite_language": "required",
        "password_hint": "required",
        "terms_accepted": "required"
    },
    "extended_profile_fields": [
        "data_authorization",
        "full_name",
        "bio",
        "wants_newsletter",
        "favorite_language",
        "password_hint",
        "terms_accepted"
    ]
}

Run tutor local restart to update the settings

… components

… fields components

…e it

openedx-webhooks · 2025-05-19T22:36:07Z

Thanks for the pull request, @bra-i-am!

This repository is currently maintained by @openedx/2u-infinity.

Once you've gone through the following steps feel free to tag them in a comment and let them know that your changes are ready for engineering review.

🔘 Get product approval

If you haven't already, check this list to see if your contribution needs to go through the product review process.

If it does, you'll need to submit a product proposal for your contribution, and have it reviewed by the Product Working Group.
- This process (including the steps you'll need to take) is documented here.
If it doesn't, simply proceed with the next step.

🔘 Provide context

To help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:

Dependencies

This PR must be merged before / after / at the same time as ...
Blockers

This PR is waiting for OEP-1234 to be accepted.
Timeline information

This PR must be merged by XX date because ...
Partner information

This is for a course on edx.org.
Supporting documentation
Relevant Open edX discussion forum threads

🔘 Get a green build

If one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green.

Where can I find more information?

If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources:

When can I expect my changes to be merged?

Our goal is to get community contributions seen and reviewed as efficiently as possible.

However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:

The size and impact of the changes that it introduces
The need for product review
Maintenance status of the parent repository

💡 As a result it may take up to several weeks or months to complete a review and merge your PR.

…ed components

…used dompurify

codecov · 2025-05-22T19:33:47Z

Codecov Report

Attention: Patch coverage is 83.33333% with 1 line in your changes missing coverage. Please review.

Project coverage is 66.93%. Comparing base (37feffc) to head (4900dd4).
Report is 5 commits behind head on master.

Files with missing lines	Patch %	Lines
...c/plugin-slots/ExtendedProfileFieldsSlot/index.jsx	83.33%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #1211      +/-   ##
==========================================
+ Coverage   66.82%   66.93%   +0.11%     
==========================================
  Files          51       52       +1     
  Lines         856      862       +6     
  Branches      176      179       +3     
==========================================
+ Hits          572      577       +5     
- Misses        273      274       +1     
  Partials       11       11

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

… component

src/plugin-slots/ExtendedProfileFieldsSlot/index.jsx

src/plugin-slots/ExtendedProfileFieldsSlot/README.md

jignaciopm

I was testing this PluginSlot, thanks to README It was easy. I like this kind of contributions.We need to expand our range of plugin slots and it is good to have this example base

Asespinel

Everything in the PR looks good to me overall. One suggestion: it might be better to update the plugin so that it only installs the form for the profile/account MFE. This would help keep things more scoped and prevent unnecessary installations. couldn't replicate the changes locally due to some environment configs not loading, but the logic looks solid.

I tested with this plugin and I could build the MFE images with no problems:

from tutormfe.hooks import PLUGIN_SLOTS
from tutor import hooks

hooks.Filters.ENV_PATCHES.add_item(
    (
        "mfe-dockerfile-post-npm-install-profile",
        """
# npm package
RUN npm install '@edunext/frontend-component-extended-fields@latest' --force
""",
    )
)

hooks.Filters.ENV_PATCHES.add_item(
    (
        "mfe-dockerfile-post-npm-install-account",
        """
# npm package
RUN npm install '@edunext/frontend-component-extended-fields@latest' --force
""",
    )
)

hooks.Filters.ENV_PATCHES.add_item(
    (
        "mfe-env-config-buildtime-imports-profile",
        """
import { ExtendedProfileFields } from '@edunext/frontend-component-extended-fields';
""",
    )
)

hooks.Filters.ENV_PATCHES.add_item(
    (
        "mfe-env-config-buildtime-imports-account",
        """
import { ExtendedProfileFields } from '@edunext/frontend-component-extended-fields';
""",
    )
)

PLUGIN_SLOTS.add_items(
    [
        (
            "profile",
            "extended_profile_fields_slot",
            """
        {
          op: PLUGIN_OPERATIONS.Insert,
          widget: {
            id: 'extended_profile_fields',
		    type: DIRECT_PLUGIN,
		    RenderWidget: ExtendedProfileFields,
          },
        }""",
        ),
    ]
)

jignaciopm · 2025-06-04T18:53:15Z

I want to take this opportunity to mention a few things in the steps to test this development:

There is no mention of the use of this branch in our Local Tutor

Add the next script to tutor plugin to override the branch of Profle MFE

from tutormfe.hooks import MFE_APPS

@MFE_APPS.add()
def _add_my_mfe(mfes):
    mfes["profile"] = {
        "repository": "https://github.com/edunext/frontend-app-profile.git",
        "port": 1995,
        "version": "bc/add-extra-fields-slot",
    }

Another way we can do this in the queue is by using mount in our Local Tutor. To do this, we must:

Install the @edunext/frontend-component-extended-fields@latest package in our MFE Profile.
Create the env.config.jsx file in the root of the MFE with the following configuration:

import { PLUGIN_OPERATIONS, DIRECT_PLUGIN } from '@openedx/frontend-plugin-framework';
import { ExtendedProfileFields } from '@edunext/frontend-component-extended-fields';

// Load environment variables from .env file
const config = {
  ...process.env,
  pluginSlots: {
    extended_profile_fields_slot: {
      plugins: [
        {
          op: PLUGIN_OPERATIONS.Insert,
          widget: {
            id: 'extended_profile_fields',
            type: DIRECT_PLUGIN,
	    RenderWidget: ExtendedProfileFields,
          },
        },
      ],
    },
  },
};

export default config;

Problem with backend to update values

I think this problem is not associate with this PR, but maybe we have to mention this in troubleshooting section

Install dependency only in Profile and Account MFE

What Andres mentions is important, we don't have to install @edunext/frontend-component-extended-fields dependency in each MFE, it's too much. We must figure out another way to make this work.

Finally @bra-i-am I don't see anything about the PR of @edunext/frontend-component-extended-fields and custom-form-app. Do you need any review of this?

bra-i-am · 2025-06-04T22:16:31Z

@Asespinel, thank you for your review. I'll be working on the change of the plugin you mentioned!

I hope the issue is gone, and you can test it properly. Please let me know any other comments/questions you have ✨

bra-i-am · 2025-06-04T22:27:17Z

@jignaciopm, thank you again for your review 🙏✨

There is no mention of the use of this branch in our Local Tutor

You're right, I forgot to mention that really important thing... with your permission, I'll paste the steps you give in the cover letter of this PR 😅

Problem with backend to update values

I already reviewed this: it was an error with the handling I was doing in the frontend-component-extended-fields custom library. I already published a new version with the fix, so if you build the MFE image again, it should be solved

Install dependency only in Profile and Account MFE

Yees, you are right... I'll be checking this out

Finally @bra-i-am I don't see anything about the PR of @edunext/frontend-component-extended-fields and custom-form-app. Do you need any review of this?

Honestly, I didn't create any PR for those things... but the repositories are not too big, so if you take a look at them, it would be great!

bra-i-am added 4 commits May 19, 2025 16:07

feat: add extended profile fields functionality with context and form…

a4d8f24

… components

refactor: replace string literals with FORM_MODE constants in profile…

85e5676

… fields components

feat: implement BaseField component and refactor field elements to us…

9e39796

…e it

chore: remove unused webpack development configuration file

e073915

openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label May 19, 2025

openedx-webhooks added this to Contributions May 19, 2025

github-project-automation bot moved this to Needs Triage in Contributions May 19, 2025

bra-i-am added 2 commits May 22, 2025 14:27

feat: refactor extended profile fields implementation and remove unus…

9eaa1a2

…ed components

feat: update dependencies for frontend-plugin-framework and remove un…

c4506c0

…used dompurify

refactor: simplify pluginProps structure in ExtendedProfileFieldsSlot…

f6fcb78

… component

bra-i-am changed the title ~~Bc/add extra fields slot~~ feat: add slot to extend the profile fields May 23, 2025

feat: add README and example images for Extended Profile Fields slot

65a004a

This was referenced May 26, 2025

feat: extend the account fields with the already existing extended_profile_fields openedx/frontend-app-account#1193

Closed

feat: extend the profile fields with the already existing extended_profile_fields #1167

Closed

bra-i-am marked this pull request as ready for review May 26, 2025 22:57

bra-i-am requested a review from a team as a code owner May 26, 2025 22:57

openedx-webhooks added this to Aperture-Maintained May 26, 2025

mphilbrick211 moved this from Needs Triage to Ready for Review in Contributions May 27, 2025

jignaciopm reviewed Jun 2, 2025

View reviewed changes

src/plugin-slots/ExtendedProfileFieldsSlot/index.jsx Outdated Show resolved Hide resolved

jignaciopm reviewed Jun 2, 2025

View reviewed changes

src/plugin-slots/ExtendedProfileFieldsSlot/README.md Outdated Show resolved Hide resolved

jignaciopm approved these changes Jun 3, 2025

View reviewed changes

Asespinel approved these changes Jun 4, 2025

View reviewed changes

refactor: improve performance & keep consistency

4900dd4

deborahgu removed this from Aperture-Maintained Jun 5, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat: add slot to extend the profile fields #1211

feat: add slot to extend the profile fields #1211

Uh oh!

bra-i-am commented May 19, 2025 •

edited

Loading

Uh oh!

openedx-webhooks commented May 19, 2025 •

edited

Loading

Uh oh!

codecov bot commented May 22, 2025 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

jignaciopm left a comment

Uh oh!

Asespinel left a comment

Uh oh!

jignaciopm commented Jun 4, 2025 •

edited

Loading

Uh oh!

bra-i-am commented Jun 4, 2025

Uh oh!

bra-i-am commented Jun 4, 2025

Uh oh!

Uh oh!

feat: add slot to extend the profile fields #1211

Are you sure you want to change the base?

feat: add slot to extend the profile fields #1211

Uh oh!

Conversation

bra-i-am commented May 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Screenshots

How Has This Been Tested?

Uh oh!

openedx-webhooks commented May 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codecov bot commented May 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

Uh oh!

jignaciopm left a comment

Choose a reason for hiding this comment

Uh oh!

Asespinel left a comment

Choose a reason for hiding this comment

Uh oh!

jignaciopm commented Jun 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

There is no mention of the use of this branch in our Local Tutor

Problem with backend to update values

Install dependency only in Profile and Account MFE

Uh oh!

bra-i-am commented Jun 4, 2025

Uh oh!

bra-i-am commented Jun 4, 2025

Uh oh!

Uh oh!

bra-i-am commented May 19, 2025 •

edited

Loading

openedx-webhooks commented May 19, 2025 •

edited

Loading

codecov bot commented May 22, 2025 •

edited

Loading

jignaciopm commented Jun 4, 2025 •

edited

Loading