Skip to content
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.

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

fix(bcd): re-surface "see bug xxxxx" notes #10549

Merged
merged 1 commit into from
Feb 19, 2024
Merged

Conversation

LeoMcA
Copy link
Member

@LeoMcA LeoMcA commented Feb 19, 2024

Summary

Fixes #10522
Relates to web-platform-dx/web-features#591

cc @queengooborg, @foolip

Problem

bcd migrated to using the impl_url field over the notes field in most cases: mdn/browser-compat-data#20608

Solution

this commit attempts to bring back the same functionality as before


Screenshots

Before mdn/browser-compat-data#20608

image

Before

image

After

image


How did you test this change?

Set REACT_APP_BCD_BASE_URL="" in .env in order to use local bcd data, rather than stage data.

In yari/node_modules/@mdn/browser-compat-data/data.json, replaced

{"chrome":{"impl_url":"https://crbug.com/393466","version_added":false},"chrome_android":{"impl_url":"https://crbug.com/393466","version_added":false}

with

{"chrome":{"notes": "See <a href='https://crbug.com/393466'>bug 393466</a>.","version_added":false},"chrome_android":{"impl_url":"https://crbug.com/foobar/393466","version_added":false}

Visited http://localhost:3000/en-US/docs/Web/API/HTMLElement/accessKeyLabel#browser_compatibility to test that the display of the notes with Chrome was the same as the display of impl_url with Edge, and that the malformed url with Chrome for Android rendered without error.

Also installed the version of BCD prior to mdn/browser-compat-data#20608 with yarn add @mdn/browser-compat-data@v5.3.13.

bcd migrated to using the `impl_url` field over the `notes` field in
most cases: mdn/browser-compat-data#20608

this commit attempts to bring back the same functionality as before
@LeoMcA LeoMcA requested a review from a team as a code owner February 19, 2024 13:24
Copy link
Contributor

@fiji-flo fiji-flo left a comment

Choose a reason for hiding this comment

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

Looks good. Thanks for fixing!

@fiji-flo fiji-flo merged commit 6da4660 into main Feb 19, 2024
14 checks passed
@fiji-flo fiji-flo deleted the add-impl-url-to-bcd-table branch February 19, 2024 20:16
@foolip
Copy link
Contributor

foolip commented Feb 21, 2024

Thank you @LeoMcA!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Surface impl_url from BCD
3 participants