Skip to content

Use CMS Certificate Title for program verifiable credentials #3698

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
zamanafzal merged 3 commits into from
Aug 6, 2026
Merged

Use CMS Certificate Title for program verifiable credentials #3698

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9e6724c
feat: use CMS Certificate Title for program verifiable credentials
zamanafzal Jun 24, 2026
ac9f2e1
fix: trim CMS Certificate Title before VC name fallback
zamanafzal Jun 30, 2026
7a86c8f
refactor: drop redundant comment on VC name fallback
zamanafzal Jun 30, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion courses/api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1779,7 +1779,9 @@ def get_verifiable_credentials_payload(
program = certificate.program
program_page = program.program_page
url = get_learn_product_url("programs", program.readable_id)
certificate_name = certificate.program.title
certificate_name = (
certificate_page.product_name or ""
).strip() or certificate.program.title

@annagav annagav Jun 30, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So are we giving higher precedence to product name over the program title?

@annagav annagav Jun 30, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

oh, I see

activity_start_date = ProgramEnrollment.all_objects.get(
user_id=certificate.user_id, program=program
).created_on.strftime("%Y-%m-%dT%H:%M:%SZ")
Expand Down
42 changes: 40 additions & 2 deletions courses/api_test.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3377,6 +3377,7 @@ def test_program_certificate_verifiable_credentials(
mock_certificate_page = Mock()
mock_certificate_page.verifiable_credential_criteria = "mock_credential_data"
mock_certificate_page.should_provision_verifiable_credential = True
mock_certificate_page.product_name = "Test Program Certificate"
mocker.patch("courses.api.get_certificate_page", return_value=mock_certificate_page)
courses = CourseFactory.create_batch(3)
course_runs = CourseRunFactory.create_batch(3, course=factory.Iterator(courses))
Expand Down Expand Up @@ -3588,6 +3589,9 @@ def test_program_certificate_verifiable_credentials_signing_payload(

mock_certificate_page = Mock()
mock_certificate_page.verifiable_credential_criteria = "mock_credential_data"
# The verifiable credential name should come from the CMS "Certificate Title"
# (product_name), not the program title.
mock_certificate_page.product_name = "Universal AI"
payload = get_verifiable_credentials_payload(program_cert, mock_certificate_page)

# Assert the expected payload structure
Expand Down Expand Up @@ -3630,8 +3634,8 @@ def test_program_certificate_verifiable_credentials_signing_payload(
"criteria": {
"narrative": mock_certificate_page.verifiable_credential_criteria
},
"description": "Jane Smith has successfully completed all modules and earned a Program Certificate in Data Science MicroMasters.",
"name": "Data Science MicroMasters",
"description": "Jane Smith has successfully completed all modules and earned a Program Certificate in Universal AI.",
"name": "Universal AI",
"image": {
"id": "https://example.com/program-thumbnail.jpg",
"type": "Image",
Expand All @@ -3644,6 +3648,40 @@ def test_program_certificate_verifiable_credentials_signing_payload(
assert payload == expected_payload


@pytest.mark.parametrize("product_name", ["", " "])
@patch("courses.api.ProgramEnrollment.all_objects.get")
@patch("courses.api.get_thumbnail_url")
def test_program_verifiable_credential_name_falls_back_to_program_title(
mock_get_thumbnail_url, mock_enrollment_get, product_name, settings, mocker
):
"""The VC name falls back to the program title when product_name is blank."""
mocker.patch("hubspot_sync.task_helpers.sync_hubspot_user")
mocker.patch("hubspot_sync.api.upsert_custom_properties")

mock_enrollment = Mock()
mock_enrollment.created_on = datetime(
2024, 2, 20, 14, 45, 0, tzinfo=ZoneInfo("UTC")
)
mock_enrollment_get.return_value = mock_enrollment
mock_get_thumbnail_url.return_value = ""

settings.ENVIRONMENT = "production"

program_cert = ProgramCertificateFactory.create()
program_cert.program.title = "Data Science MicroMasters"
program_cert.program.save()

mock_certificate_page = Mock()
mock_certificate_page.verifiable_credential_criteria = "mock_credential_data"
mock_certificate_page.product_name = product_name

payload = get_verifiable_credentials_payload(program_cert, mock_certificate_page)

achievement = payload["credentialSubject"]["achievement"]
assert achievement["name"] == "Data Science MicroMasters"
assert "Data Science MicroMasters" in achievement["description"]


@pytest.mark.parametrize(
"keep_failed_enrollments,flag_enabled,expected_behavior", # noqa: PT006
[
Expand Down