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

[Web API] Add structured cloning of error types #18208

Closed
5 of 7 tasks
hamishwillee opened this issue Jul 11, 2022 · 4 comments
Closed
5 of 7 tasks

[Web API] Add structured cloning of error types #18208

hamishwillee opened this issue Jul 11, 2022 · 4 comments
Assignees
Labels
Content:WebAPI Web API docs fx release archive A closed issue relating to firefox release notes for developers.

Comments

@hamishwillee
Copy link
Collaborator

hamishwillee commented Jul 11, 2022

Acceptance Criteria

  • The listed features are documented sufficiently on MDN
  • BCD is updated
  • Interactive example and data repos are updated if appropriate
  • The content has been reviewed as needed

For folks helping with Firefox related documentation

  • Set bugs to dev-doc-complete
  • Add entry to Firefox release notes if feature is enabled in release
    or
  • Add entry to Firefox experimental features page if feature is not yet enabled in release

Features to document

Related Gecko bugs

https://bugzilla.mozilla.org/show_bug.cgi?id=1556604

Other

Clarifying the scope of this in https://bugzilla.mozilla.org/show_bug.cgi?id=1556604#c32

Essentially though I think it is a BCD update for all the error types to indicate support for serializable errors and also addition to the list of structured clone types.
The open question is mostly around what is not serialized and any limitations of this.

@github-actions github-actions bot added the needs triage Triage needed by staff and/or partners. Automatically applied when an issue is opened. label Jul 11, 2022
@hamishwillee hamishwillee added javascript Pull requests that update Javascript code Firefox 103 and removed needs triage Triage needed by staff and/or partners. Automatically applied when an issue is opened. labels Jul 11, 2022
@hamishwillee hamishwillee self-assigned this Jul 11, 2022
@Josh-Cena Josh-Cena added Content:WebAPI Web API docs and removed javascript Pull requests that update Javascript code labels Jul 11, 2022
@Josh-Cena Josh-Cena changed the title [JS] Add structured cloning of error types [Web API] Add structured cloning of error types Jul 11, 2022
@Josh-Cena
Copy link
Member

Will this edit the Error pages? AFAICT we don't document clonability of JS structs elsewhere since structuredClone is a web API.

@hamishwillee
Copy link
Collaborator Author

@Josh-Cena

AFAICT we don't document clonability of JS structs elsewhere since structuredClone is a web API.

I suspect don't document clonability of JS because we've never thought about it. IMO a developer would find this useful to know when looking at the error classes. My intent was to add a note like this one for the errors (from DOMException):
image

If there is a good reason not to update the pages (or you are strongly against this) I don't feel strongly since we'll still have the serializability info in the BCD: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RangeError#browser_compatibility

@Josh-Cena
Copy link
Member

I'd be happy to document it in JS references—one or two sentences is good enough.

@hamishwillee
Copy link
Collaborator Author

hamishwillee commented Jul 15, 2022

@Rumyra Rumyra closed this as completed Jul 21, 2022
@bsmth bsmth added fx release archive A closed issue relating to firefox release notes for developers. and removed Firefox 103 labels Dec 20, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Content:WebAPI Web API docs fx release archive A closed issue relating to firefox release notes for developers.
Projects
Archived in project
Development

No branches or pull requests

4 participants