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

Update CDDL generation script to also read external definitions #791

Open
whimboo opened this issue Sep 26, 2024 · 3 comments
Open

Update CDDL generation script to also read external definitions #791

whimboo opened this issue Sep 26, 2024 · 3 comments
Labels
infra Infrastructure related issues needs-discussion Issues to be discussed by the working group

Comments

@whimboo
Copy link
Contributor

whimboo commented Sep 26, 2024

We have external definitions of WebDriver BiDi command and events like this on-exhaustive list shows:

https://w3c.github.io/webdriver-bidi/#external-specifications

Right now we do not yet read their CDDL defintions which means even if implemented in browsers clients will not know about in case they rely on auto-generated code.

We should probably update our cddl generation script to check external documents as well.

CC @jgraham @gsnedders

@whimboo whimboo added needs-discussion Issues to be discussed by the working group infra Infrastructure related issues labels Sep 26, 2024
@gsnedders
Copy link
Member

We should be careful to not accidentally change the definition of the Remote End Definition (or Local End Definition) if/when we do this; various things are matched against it, and if we explicitly include all external specifications in the definition, does that not oblige them to be implemented?

@whimboo
Copy link
Contributor Author

whimboo commented Oct 24, 2024

The inclusion of any external spec would require an agreement by the Browser Testing and Tools group for sure. Further it would apply to any other CDDL changes afterward.

If we don't agree on that what else could we do to provide a CDDL export that also includes all the extension commands and events?

@tidoust
Copy link
Member

tidoust commented Oct 25, 2024

I haven't had time to dig into it yet but I plan to work on adding CDDL extracts to Webref data in a not so distant future, see w3c/webref#1353.

There are also interesting considerations on the notion of CDDL modules in a recent IETF thread (initially focused on ABNF extracts), which could perhaps be used to create a consolidated view.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
infra Infrastructure related issues needs-discussion Issues to be discussed by the working group
Projects
None yet
Development

No branches or pull requests

3 participants