ENT-11235: Updating schema to add invited_date and joined_date fields to customer admin. by sjasti-sonata-svg · Pull Request #2491 · openedx/edx-enterprise

sjasti-sonata-svg · 2025-12-16T17:55:19Z

Merge checklist:

Any new requirements are in the right place (do not manually modify the requirements/*.txt files)
- base.in if needed in production but edx-platform doesn't install it
- test-master.in if edx-platform pins it, with a matching version
- make upgrade && make requirements have been run to regenerate requirements
make static has been run to update webpack bundling if any static content was updated
./manage.py makemigrations has been run
- Checkout the Database Migration Confluence page for helpful tips on creating migrations.
- Note: This must be run if you modified any models.
  - It may or may not make a migration depending on exactly what you modified, but it should still be run.
- This should be run from either a venv with all the lms/edx-enterprise requirements installed or if you checked out edx-enterprise into the src directory used by lms, you can run this command through an lms shell.
  - It would be ./manage.py lms makemigrations in the shell.
Version bumped
Changelog record added
Translations updated (see docs/internationalization.rst but also this isn't blocking for merge atm)

Post merge:

Tag pushed and a new version released
- Note: Assets will be added automatically. You just need to provide a tag (should match your version number) and title and description.
After versioned build finishes in GitHub Actions, verify version has been pushed to PyPI
- Each step in the release build has a condition flag that checks if the rest of the steps are done and if so will deploy to PyPi.
  (so basically once your build finishes, after maybe a minute you should see the new version in PyPi automatically (on refresh))
PR created in edx-platform to upgrade dependencies (including edx-enterprise)
- Trigger the 'Upgrade one Python dependency' action against master in edx-platform with new version number to generate version bump PR
- This must be done after the version is visible in PyPi as make upgrade in edx-platform will look for the latest version in PyPi.
- Note: the edx-enterprise constraint in edx-platform must also be bumped to the latest version in PyPi.

sjasti-sonata-svg · 2025-12-17T05:46:40Z

This is the ticket :
ENT-11235
Description:
We need to support new metadata for admins, including tracking when an admin was invited and when they joined. Review the existing admin table and ensure new fields do not break existing APIs.

kiram15

I'm confused as to why we are changing fields in the EnterpriseCustomerUser table. When you are going to pull all the admins for the new admin DataTable, we should not be going through a list of the EnterpriseCustomerUsers, but rather another table of all the admins. As I said in the comment, I think the best approach would be adding the invited_date and joined_date fields to EnterpriseCustomerAdmin table, and then plan to pull in the (relevant, non-onboarding tour) information for the DataTable y'all will be creating.

I also think that whenever we're adding new fields, its good to include in the PR how they will be getting populated. Here is how EnterpriseCustomerAdmins are currently created (in a post_save django signal where an "enterprise_admin" system-wide role is assigned to the user). I'm assuming the plan is to have the invited_date be when the PendingEnterpriseCustomerAdminUser record is created, and then a joined_date be populated if/when the EnterpriseCustomerAdmin record is created, but in order for me to review these fields, I need to know more information about these dates.

enterprise/models.py

Don't want to block this PR before I go on vacation

enterprise/migrations/0243_enterprisecustomeradmin_invited_date_and_more.py

enterprise/models.py

enterprise/api/v1/serializers.py

enterprise/signals.py

pwnage101 · 2026-01-05T23:44:51Z

Before merging, please squash your commits to only one commit and use a more descriptive title, such as "feat: add date fields to track enterprise user invitation lifecycle". Please also change the title of this PR to match that more descriptive title.

enterprise/models.py

enterprise/api/v1/serializers.py

msaha-sonata · 2026-01-12T07:40:25Z

tests/test_enterprise/test_signals.py

        self._assert_pending_ecus_exist(should_exist=False)

+@mark.django_db
+class TestEnterpriseCustomerAdminSignals(unittest.TestCase):


Can you please verify that invited_date and joined_date fields are set to the correct values, you can extend your test cases to compare against expected timestamps

Hi @msaha-sonata ,
Added the test cases.

msaha-sonata

Looks good to me

kiram15

Make sure you update the changelog and init file, and rename the title and commits like Troy mentioned. Once it's in a good state, I can merge it in tomorrow!

kiram15 · 2026-01-20T21:46:11Z

CHANGELOG.rst

 ---------------------
 * feat: added atlas translations flow in enterprise app

+[6.5.8] - 2025-12-16


The changelog needs to be updated because of updates that happened since, and also the init file needs to be updated too.

Hi @kiram15
Done the changes. I have updated the files. could you please do the further process.

pwnage101

In additional to my requested changes, please also make sure your commits do not include a "Merge" commit. In your case, the number of commits should be just 1.

pwnage101 · 2026-01-22T22:57:02Z

enterprise/models.py

+    """Track the date and time when a pending enterprise admin invite was created."""
+    invited_date = models.DateTimeField(
+        null=True,
+        blank=True,
+        help_text="Timestamp when the admin invite was created."
+    )


This field seems redundant; there's already a created field inherited from TimeStampedModel. Furthermore, this PR lacks code changes for populating this field.

Hi @pwnage101
I am removing invited_date and joined_date, populated invited_date directly at creation time in init.py.
Is that fine?

pwnage101 · 2026-01-22T22:58:09Z

enterprise/models.py

        default=False,
        help_text=_("Whether the admin has completed the onboarding tour.")
    )
+    """Track when the admin was invited."""


This is the incorrect syntax for code comments. Use # prefix:

Suggested change

"""Track when the admin was invited."""

# Track when the admin was invited.

Hi @pwnage101
Done

pwnage101 · 2026-01-22T23:35:45Z

enterprise/models.py

+        help_text="Timestamp when the admin was invited."
+    )
+    """Track when the admin accepted the invite and joined."""
+    joined_date = models.DateTimeField(


This model also inherits TimeStampedModel, so joined_date is redundant with created.

pwnage101 · 2026-01-22T23:50:06Z

enterprise/signals.py

            instance.display_name = f'SSO-config-{instance.identity_provider}-{num_records_for_customer + 1}'

+@receiver(post_save, sender=EnterpriseCustomerAdmin)
+def populate_admin_onboarding_metadata(sender, instance, created, **kwargs):


I think this entire signal is not necessary. We have direct access to the code that creates the EnterpriseCustomerAdmins:

edx-enterprise/enterprise/api/__init__.py

Lines 27 to 29 in b42d184

EnterpriseCustomerAdmin.objects.get_or_create(

enterprise_customer_user=enterprise_customer_user,

)

You only need to update that call to look like this:

EnterpriseCustomerAdmin.objects.get_or_create( enterprise_customer_user=enterprise_customer_user, defaults={'invited_date': pending_admin_user.created}, )

We typically reserve signals in cases where direct code manipulation is not possible, or breaks modularity.

Hi @pwnage101
I have worked on this .
could you please review the same and let me any changes required.

pwnage101 · 2026-02-02T22:20:36Z

enterprise/management/commands/create_enterprise_customer_admins.py

                                    enterprise_customer_user=eu,
-                                    last_login=timezone.now()
+                                    last_login=timezone.now(),
+                                    joined_date=timezone.now()


Nit: leave a trailing comma.

pwnage101 · 2026-02-02T22:22:23Z

enterprise/migrations/0243_enterprisecustomeradmin_invited_date_and_more.py

@@ -0,0 +1,49 @@
+# Generated by Django 5.2.8 on 2025-12-29 17:47


Looks like you forgot to delete this file.

Hi @pwnage101
Deleted the file.

pwnage101 · 2026-02-02T22:23:57Z

enterprise/models.py

        default=False,
        help_text=_("Whether the admin has completed the onboarding tour.")
    )
+    """Track when the admin accepted the invite and joined."""


This is the incorrect syntax for code comments. Use # prefix:

Suggested change

"""Track when the admin accepted the invite and joined."""

# Track when the admin accepted the invite and joined.

pwnage101 · 2026-02-02T22:24:41Z

enterprise/signals.py

            ).count()
            instance.display_name = f'SSO-config-{instance.identity_provider}-{num_records_for_customer + 1}'

-


re-add empty line to simplify diff.

Added empty line.

pwnage101 · 2026-02-02T22:25:44Z

enterprise/signals.py

+from django.utils.timezone import now

 from enterprise import models, roles_api
 from enterprise.api import activate_admin_permissions
 from enterprise.api_client.enterprise_catalog import EnterpriseCatalogApiClient
 from enterprise.decorators import disable_for_loaddata
+from enterprise.models import (
+    EnterpriseCustomerAdmin,
+    PendingEnterpriseCustomerAdminUser,
+)


Remove added imports which are no longer used.

pwnage101 · 2026-02-02T22:28:53Z

CHANGELOG.rst

 [6.6.2] - 2026-01-15
 ---------------------
 * feat: add a waffle flag for invite admins

 [6.6.1] - 2026-01-09
 ---------------------
 * fix: issue regarding the gettext package in atlas translations flow

 [6.6.0] - 2026-01-08
 ---------------------
 * feat: added atlas translations flow in enterprise app


Your commit should never include changelog entries from other commits. You still need to rebase your commit onto the upstream origin.

pwnage101 · 2026-02-02T22:30:03Z

enterprise/__init__.py

 Your project description goes here.
 """

-__version__ = "6.6.2"


If the version jump is this large, you need to rebase your commit on the origin (openedx/edx-enterprise master branch).

pwnage101 · 2026-02-02T22:32:27Z

tests/test_enterprise/test_signals.py

        self._assert_pending_ecus_exist(should_exist=False)

+@mark.django_db
+class TestEnterpriseCustomerAdminSignals(unittest.TestCase):


This feature no longer uses signals, so it should not be considered a signals test. You should relocate these test cases. Probably tests/test_models.py

sjasti-sonata-svg · 2026-02-04T12:00:31Z

Hi @pwnage101 ,
I have done the changes. please review the same and let me know any changes needed.

…and add invitation lifecycle fields removed signal and set invited_date via defaults updating changelog.rst Removed unintended migration file fixed comments

kiram15 previously requested changes Dec 24, 2025

View reviewed changes

enterprise/models.py Outdated Show resolved Hide resolved

kiram15 mentioned this pull request Dec 24, 2025

Feat/admin invite migration ENT- 11235 #2492

Open

9 tasks

kiram15 self-requested a review December 24, 2025 00:42

kiram15 reviewed Jan 5, 2026

View reviewed changes

pwnage101 reviewed Jan 5, 2026

View reviewed changes

enterprise/signals.py Outdated Show resolved Hide resolved

sjasti-sonata-svg force-pushed the feat/admin-invite-metadata-ENT-11235 branch 2 times, most recently from 0cda236 to dc95ac2 Compare January 7, 2026 17:47

msaha-sonata suggested changes Jan 12, 2026

View reviewed changes

msaha-sonata approved these changes Jan 15, 2026

View reviewed changes

kiram15 approved these changes Jan 20, 2026

View reviewed changes

sjasti-sonata-svg force-pushed the feat/admin-invite-metadata-ENT-11235 branch from 339bbdb to 63a0c5f Compare January 22, 2026 03:07

sjasti-sonata-svg changed the title ~~ENT-11235: update schema~~ ENT-11235: Updating schema to add invited_date and joined_date fields to customer admin. Jan 22, 2026

pwnage101 requested changes Jan 22, 2026

View reviewed changes

sjasti-sonata-svg force-pushed the feat/admin-invite-metadata-ENT-11235 branch from e64e451 to dce1bd4 Compare February 2, 2026 17:34

pwnage101 requested changes Feb 2, 2026

View reviewed changes

sjasti-sonata-svg force-pushed the feat/admin-invite-metadata-ENT-11235 branch 2 times, most recently from bf159c2 to bd4b650 Compare February 4, 2026 11:57

sjasti-sonata-svg force-pushed the feat/admin-invite-metadata-ENT-11235 branch from ed0f57b to 9cce301 Compare February 6, 2026 05:49

feat(enterprise) ENT-11235: Fix EnterpriseCustomerAdmin invited_date …

fd8e276

…and add invitation lifecycle fields removed signal and set invited_date via defaults updating changelog.rst Removed unintended migration file fixed comments

sjasti-sonata-svg force-pushed the feat/admin-invite-metadata-ENT-11235 branch from 41dd5ec to fd8e276 Compare February 6, 2026 07:15

	"""Track when the admin was invited."""
	# Track when the admin was invited.

	EnterpriseCustomerAdmin.objects.get_or_create(
	enterprise_customer_user=enterprise_customer_user,
	)

		@@ -0,0 +1,49 @@
		# Generated by Django 5.2.8 on 2025-12-29 17:47

	"""Track when the admin accepted the invite and joined."""
	# Track when the admin accepted the invite and joined.

		).count()
		instance.display_name = f'SSO-config-{instance.identity_provider}-{num_records_for_customer + 1}'

Conversation

sjasti-sonata-svg commented Dec 16, 2025

Uh oh!

sjasti-sonata-svg commented Dec 17, 2025

Uh oh!

kiram15 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

pwnage101 commented Jan 5, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

msaha-sonata left a comment

Choose a reason for hiding this comment

Uh oh!

kiram15 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

pwnage101 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment