WIP: Implement feature imports by ExE-Boss · Pull Request #1799 · mdn/browser-compat-data

ExE-Boss · 2018-04-17T14:01:51Z

Fixes #813
Closes #1681

This works by having an extra __import block, which contains the features you wish to import and the optional __as key, which is used to rename the imported feature and optional entries which override the imported data.

Cycles and infinite recursion are currently allowed if imported data isn’t overriden. They might also work if imported data is overriden depending on how the extend package deals with cycles and infinite recursion.

"__import": {
  "<ref_to_import>": {
    // Override stuff here when necessary.
  }
}

To do:

Implement global tests
Implement per-file tests
Update documentation

connorshea · 2018-04-19T16:45:16Z

Just to be clear, this still ends up exporting the same data for the npm package and only effects the source code right?

I'd rather avoid having to parse references to other features in my app that consumes the data :)

ExE-Boss · 2018-04-19T17:02:23Z

Yes, this only affects the source code, as the data exported in the npm package is already pre-parsed (although, you’ll have to watch for infinite recursion and cycles if the implementation gets merged as-is).

a2sheppy · 2018-09-18T13:29:25Z

Any possibility we could come up with a way to allow merging of information? Consider this potential use case:

Create HTMLInputElement.json with only the members that are in all input elements.
Create a separate HTMLInputElement-type.json file for each input type, containing the items that are specific to them, or for which there is information needed beyond what's included in the main HTMLInputElement.json file.
Have HTMLInputElement.json import all of the -type files, with entries that have the same name merged with some appropriate formatting, such as little boxes, footnotes, subheadings or whatever.
Allow the HTMLInputElement-type.json files to indicate that they are based on HTMLInputElement.json. "Based on" means that they include the items that are directly in HTMLInputElement.json, but not any imported files it references.

This lets us create the JSON in a less confusing way while giving us much more control over how the results look. We could even export from the tools that build the files from the imports separate files for each input element type that could be referenced by tools that know how to do so, if we wanted to.

a2sheppy · 2018-09-20T15:58:38Z

@ExE-Boss -- Do you have any examples for what the ref_to_import looks like? Is it a feature path just like we already use ("api.SomeInterface.method.feature")?

ExE-Boss · 2018-09-20T16:25:45Z

It is currently just a feature path, as can be seen in the sample data:

browser-compat-data/test/sample-data.json

Lines 310 to 332 in 406d7f3

    
           "__import": { 
        
             "sample.api.onlyBasicSupport": {}, 
        
             "sample.api.featureWithSubfeatures.chocoCookie": { 
        
               "__as": "superChocoCookie" 
        
             } 
        
           }, 
        
           "recursiveImport": { 
        
             "__import": { 
        
               "sample.api.featureWithImports.recursiveImport": {} 
        
             } 
        
           }, 
        
           "cyclicalImport": { 
        
             "a": { 
        
               "__import": { 
        
                 "sample.api.featureWithImports.cyclicalImport.b": {} 
        
               } 
        
             }, 
        
             "b": { 
        
               "__import": { 
        
                 "sample.api.featureWithImports.cyclicalImport.a": {} 
        
               } 
        
             } 
        
           }

a2sheppy · 2018-09-20T16:31:49Z

That's perfect. Exactly the way I'd love to have it work.

…

On Thu, Sep 20, 2018 at 12:26 PM ExE Boss ***@***.***> wrote: It is currently just a feature path, as can be seen in the sample data: https://github.com/mdn/browser-compat-data/blob/406d7f339253c3c549a6d842b9eb0b044c55f0ae/test/sample-data.json#L310-L332 — You are receiving this because you commented. Reply to this email directly, view it on GitHub <#1799 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/ABkL30W56CuhqSVeEzjc-v9iocI0uKNGks5uc8GtgaJpZM4TYXkH> .

-- Eric Shepherd Senior Technical Writer Mozilla Blog: http://www.bitstampede.com/ Twitter: http://twitter.com/sheppy Check my Availability <https://freebusy.io/eshepherd@mozilla.com>

a2sheppy · 2019-01-08T20:47:30Z

Any chance we're actually going somewhere with this? I ask because I have stuff that I've been keeping on hold pending this landing and I don't know how long I should keep waiting.

ExE-Boss · 2019-01-08T21:15:42Z

#2487 will have to be merged first to avoid merge conflicts.

queengooborg · 2019-02-03T06:28:17Z

@ExE-Boss Looks like that PR has been merged now. I'm eager to see this PR get merged -- would you be up for rebasing?

Elchi3 · 2019-02-04T11:02:25Z

Thanks for your enthusiasm @vinyldarkscratch but I don't see this landing anytime soon from a maintainer's point of view. It would be a major change to how we have the data stored here and I don't think we're ready to make this change just yet. I will let you know when we want to revisit this. :)

jpmedley · 2019-02-04T16:26:05Z

test/sample-data.json

+        "__compat": {
+          "description": "This sub-feature has imports",
+          "support": {
+            "webview_android": {


This should be last, not first.

Yeah, this was written before work on #1882 began.

queengooborg · 2019-02-04T17:44:06Z

Sounds like a plan, @Elchi3! I am indeed pretty eager for this, haha -- whilst going through the JSON I've run into instances where an import would be more than helpful. Looking forward to seeing this complete and merged!

a2sheppy · 2019-02-04T21:49:56Z

Yeah, I have updates to BCD that are holding for this to land because otherwise the repetitiveness would be ugly :)

Elchi3 · 2019-04-10T17:22:41Z

Bulk data updates through external sources and scripts are our preferred approach to better compat data right now and we're not currently considering de-duplicating version data. Therefore I'm closing this issue. Thanks for your thoughts here! Maybe we will reconsider this idea at a later stage.

ExE-Boss added 2 commits April 17, 2018 15:57

Implement feature imports

784f2b6

Implement unit tests for imports

406d7f3

Elchi3 added schema Isses or pull requests regarding the JSON schema files used in this project. infra Infrastructure issues (npm, GitHub Actions, releases) of this project labels Apr 17, 2018

ExE-Boss mentioned this pull request May 18, 2018

Add <input> element [WIP – Do Not Merge] #1698

Closed

ExE-Boss mentioned this pull request May 29, 2018

Add browser_style #2154

Closed

ExE-Boss changed the title ~~Implement feature imports~~ WIP: Implement feature imports Aug 16, 2018

ExE-Boss mentioned this pull request Sep 18, 2018

Rewrite display property documentation mdn/sprints#456

Closed

a2sheppy mentioned this pull request Sep 20, 2018

Note Firefox 63 support for report-sample [DO NOT MERGE] #2761

Closed

Elchi3 added the not ready This is not yet ready to be merged. It's pending a decision, other PR, or a prerequisite action. label Feb 4, 2019

jpmedley suggested changes Feb 4, 2019

View reviewed changes

ExE-Boss mentioned this pull request Feb 28, 2019

Add calc() to @media. #3549

Merged

ddbeck mentioned this pull request Apr 9, 2019

API: Mirror Chrome Desktop onto Chromium browsers when null #3748

Closed

Elchi3 closed this Apr 10, 2019

Elchi3 mentioned this pull request Aug 27, 2020

Linter: check consistency of dependent features #6571

Open

Conversation

ExE-Boss commented Apr 17, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

To do:

Uh oh!

connorshea commented Apr 19, 2018

Uh oh!

ExE-Boss commented Apr 19, 2018

Uh oh!

a2sheppy commented Sep 18, 2018

Uh oh!

a2sheppy commented Sep 20, 2018

Uh oh!

ExE-Boss commented Sep 20, 2018

Uh oh!

a2sheppy commented Sep 20, 2018 via email

Uh oh!

a2sheppy commented Jan 8, 2019

Uh oh!

ExE-Boss commented Jan 8, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

queengooborg commented Feb 3, 2019

Uh oh!

Elchi3 commented Feb 4, 2019

Uh oh!

jpmedley Feb 4, 2019

Choose a reason for hiding this comment

Uh oh!

ExE-Boss Feb 4, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

queengooborg commented Feb 4, 2019

Uh oh!

a2sheppy commented Feb 4, 2019

Uh oh!

Elchi3 commented Apr 10, 2019

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

ExE-Boss commented Apr 17, 2018 •

edited

Loading

ExE-Boss commented Jan 8, 2019 •

edited

Loading

ExE-Boss Feb 4, 2019 •

edited

Loading