Add optional submitter argument to FormData constructor #366

jenseng · 2023-01-12T01:13:04Z

Closes #262, I went with the approach outlined here. Implementation/MDN issues have been filed, and some implementation-specific POCs have also been created (chromium, gecko, and jsdom).

At least two implementers are interested (and none opposed):
- Chromium
- Gecko (via "👍" 😃 )
- WebKit
- Additional context in FormData: Add ability to specify submitter in addition to <form> #262 and Would be nice if submit events exposed the "submitter" element html#3195
Tests are written and can be reviewed and commented upon at:
- Add FormData.constructor submitter tests web-platform-tests/wpt#37895
Implementation bugs are filed:
- Chromium: https://bugs.chromium.org/p/chromium/issues/detail?id=1410542
- Gecko: https://bugzilla.mozilla.org/show_bug.cgi?id=1812696
- WebKit: https://bugs.webkit.org/show_bug.cgi?id=251220
MDN issue is filed: Document FormData constructor submitter parameter mdn/content#23917

(See WHATWG Working Mode: Changes for more details.)

Preview | Diff

Closes whatwg#262

annevk

This will require some minor export tweaks to the HTML Standard. I'd be willing to help with that. Making this change still seems reasonable.

xhr.bs

annevk · 2023-01-12T15:28:45Z

@mfreed7 @rniwa @smaug---- tagging you here for visibility and to ensure nothing much changed here since 2019...

Co-authored-by: Anne van Kesteren <[email protected]>

jenseng · 2023-01-23T17:12:02Z

@mfreed7 if it helps the discussion along, here's a first pass at a blink implementation (caveats: my first time working in Chromium, haven't written C/C++ in a decade, probably needs more testing, etc. 😅). From my quick manual test in the console it seems to be working:

jenseng · 2023-01-23T17:24:08Z

@smaug---- here's the equivalent POC for gecko/FF. Same caveats apply as in the comment above :)

mfreed7 · 2023-01-23T18:11:38Z

@mfreed7 if it helps the discussion along, here's a first pass at a blink implementation (caveats: my first time working in Chromium, haven't written C/C++ in a decade, probably needs more testing, etc. 😅). From my quick manual test in the console it seems to be working:

Wow, this is the best ping I've received: "here's a prototype". Thanks!

I think we're generally still supportive of this proposal and this PR.

jenseng · 2023-01-24T23:54:25Z

👋 @rniwa I haven't forgotten about WebKit, I have a comparable patch there too, though I got stuck in XCode/dlopen hell so I haven't been able to test it just yet. Happy to send it your way if it helps.

cdumez · 2023-01-25T17:01:49Z

👋 @rniwa I haven't forgotten about WebKit, I have a comparable patch there too, though I got stuck in XCode/dlopen hell so I haven't been able to test it just yet. Happy to send it your way if it helps.

Looks good to me from WebKit side. I don't mind implementing it and working on getting whatever patch you have landed. This seems like a minor change and I can see how this could be useful.

For whatwg/xhr#366.

annevk · 2023-01-25T17:40:08Z

@jenseng I think we're all good here. Just need to wait for HTML to be indexed by Reffy. The only outstanding task is filing implementation bugs (and linking them to this PR and the tests). Would you like to do that as well?

jenseng · 2023-01-25T17:40:47Z

@jenseng I think we're all good here. Just need to wait for HTML to be indexed by Reffy. The only outstanding task is filing implementation bugs (and linking them to this PR and the tests). Would you like to do that as well?

Sure thing, I'll do that in a bit here 👍

annevk · 2023-01-25T17:45:00Z

xhr.bs

@@ -1609,7 +1609,7 @@ typedef (File or USVString) FormDataEntryValue;

 [Exposed=(Window,Worker)]
 interface FormData {
-  constructor(optional HTMLFormElement form);
+  constructor(optional HTMLFormElement form, optional HTMLElement? submitter = null);


Found a nit after all. Is there a good reason to allow null here? Or would requiring undefined by fine? If there's no use case for passing null we should not allow it and change the language below from "is non-null" to "is given".

(And then have an additional test that null throws.)

I don't have a strong preference here, mainly I was making it consistent with HTMLFormElement.requestSubmit which allows a null submitter.

But I agree that allowing a null submitter but not a null form is inconsistent, so 🤷‍♂️😆

Okay, that's fairly compelling I suppose, although I don't remember the rationale for that one. 😅

Let's leave this as-is then unless @domenic cares more strongly than I do.

It's possible it was an oversight, as you had a similar suggestion when requestSubmit was proposed and afaict it was never directly addressed

Ah here's a good justification for requestSubmit accepting null: whatwg/html#3195 (comment)

Similarly this could be useful for the FormData constructor, e.g. SubmitEvent.submitter could be null, and it would be nice to avoid null checks:

myForm.addEventListener("submit", (e) => { e.preventDefault(); const formData = new FormData(e.target, e.submitter); // ... });

For whatwg/xhr#366.

jenseng · 2023-01-25T22:42:08Z

There's one minor ambiguity around Image Button submitters that I'd like to clarify, see this comment on the WPT test PR

jenseng · 2023-01-26T16:17:50Z

Seems like the build is failing due to some webdriver-bidi export ambiguity around events, though I'm not sure why it didn't fail before 🤔 ... looks similar to these recent issues (w3c/webdriver-bidi#348, w3c/webdriver-bidi#349). Should I just do some link-defaults stuff in the current PR, or would it be better to get webdriver-bidi fixed?

edited, aha, I see @annevk is already on it

annevk · 2023-01-26T18:39:18Z

@jenseng if you file the relevant bugs today I will merge this tomorrow (addressing the webdriver-bidi issue locally). If you don't get around to filing the bugs I might be able to take that on as well. Thanks for all your work on this and guiding me through the design decisions and bug in the HTML Standard. 😊

jenseng · 2023-01-26T20:10:20Z

Ok issues have all been filed, thanks for your help on this @annevk!

For whatwg/xhr#366.

jenseng · 2023-01-28T04:34:16Z

If anyone needs this in the meantime (or in older browsers), I made a polyfill that supports it with some form shenanigans 🙈

This patch adds support for the new submitter argument to the FormData constructor. Spec: https://xhr.spec.whatwg.org/#interface-formdata Spec PR (merged): whatwg/xhr#366 WPT PR: #37895 Bug: 1410542 Change-Id: If17f782f75ae40ae21241c169afc52761fc89544

Also add a "Submit button" glossary page and link to it from various places to help facilitate a consistent and correct understanding of what a submit button is :) Spec PR (merged): whatwg/xhr#366 Spec: https://xhr.spec.whatwg.org/#interface-formdata

https://bugs.webkit.org/show_bug.cgi?id=251220 Reviewed by Chris Dumez Implement the new submitter parameter to the FormData constructor Spec PR: whatwg/xhr#366 WPT PR: web-platform-tests/wpt#37895 Test: imported/w3c/web-platform-tests/xhr/formdata/constructor-submitter.html * LayoutTests/imported/w3c/web-platform-tests/xhr/formdata/constructor-submitter-expected.txt: Added. * LayoutTests/imported/w3c/web-platform-tests/xhr/formdata/constructor-submitter.html: Added. * Source/WebCore/html/DOMFormData.cpp: (WebCore::DOMFormData::create): add submitter support * Source/WebCore/html/DOMFormData.h: update signature * Source/WebCore/html/DOMFormData.idl: update interface * Source/WebCore/html/HTMLFormElement.cpp: (WebCore::HTMLFormElement::requestSubmit): improve error messages# Canonical link: https://commits.webkit.org/259558@main

…, a=testonly Automatic update from web-platform-tests Add FormData constructor submitter tests For whatwg/xhr#366. -- wpt-commits: 0986c763928822dd6b62ee7223d8a54827f357c7 wpt-pr: 37895

…bidl,smaug Also improve error messages for current submitter validations Spec PR: whatwg/xhr#366 WPT PR: web-platform-tests/wpt#37895 Differential Revision: https://phabricator.services.mozilla.com/D167576

This patch adds support for the new submitter argument to the FormData constructor. Spec: https://xhr.spec.whatwg.org/#interface-formdata Spec PR (merged): whatwg/xhr#366 WPT PR: web-platform-tests/wpt#37895 Bug: 1410542 Change-Id: If17f782f75ae40ae21241c169afc52761fc89544 Reviewed-on: https://chromium-review.googlesource.com/c/chromium/src/+/4189297 Reviewed-by: Mason Freed <[email protected]> Commit-Queue: Mason Freed <[email protected]> Cr-Commit-Position: refs/heads/main@{#1100734}

This patch adds support for the new submitter argument to the FormData constructor. Spec: https://xhr.spec.whatwg.org/#interface-formdata Spec PR (merged): whatwg/xhr#366 WPT PR: #37895 Bug: 1410542 Change-Id: If17f782f75ae40ae21241c169afc52761fc89544 Reviewed-on: https://chromium-review.googlesource.com/c/chromium/src/+/4189297 Reviewed-by: Mason Freed <[email protected]> Commit-Queue: Mason Freed <[email protected]> Cr-Commit-Position: refs/heads/main@{#1100734}

…, a=testonly Automatic update from web-platform-tests Add FormData constructor submitter tests For whatwg/xhr#366. -- wpt-commits: 0986c763928822dd6b62ee7223d8a54827f357c7 wpt-pr: 37895

…bidl,smaug Also improve error messages for current submitter validations Spec PR: whatwg/xhr#366 WPT PR: web-platform-tests/wpt#37895 Differential Revision: https://phabricator.services.mozilla.com/D167576

…ata constructor, a=testonly Automatic update from web-platform-tests Add optional submitter argument to FormData constructor This patch adds support for the new submitter argument to the FormData constructor. Spec: https://xhr.spec.whatwg.org/#interface-formdata Spec PR (merged): whatwg/xhr#366 WPT PR: web-platform-tests/wpt#37895 Bug: 1410542 Change-Id: If17f782f75ae40ae21241c169afc52761fc89544 Reviewed-on: https://chromium-review.googlesource.com/c/chromium/src/+/4189297 Reviewed-by: Mason Freed <[email protected]> Commit-Queue: Mason Freed <[email protected]> Cr-Commit-Position: refs/heads/main@{#1100734} -- wpt-commits: 181fc870aeae110d95537bac969f76caa55d5112 wpt-pr: 38242

In order to fully support it, this requires more robust Image Button support (i.e. track selected coordinate, use when constructing form data set) Spec: https://xhr.spec.whatwg.org/#interface-formdata Spec PR: whatwg/xhr#366

Also add a "Submit button" glossary page and link to it from various places to help facilitate a consistent and correct understanding of what a submit button is :) Spec PR (merged): whatwg/xhr#366 Spec: https://xhr.spec.whatwg.org/#interface-formdata

* Document the FormData constructor submitter parameter Also add a "Submit button" glossary page and link to it from various places to help facilitate a consistent and correct understanding of what a submit button is :) Spec PR (merged): whatwg/xhr#366 Spec: https://xhr.spec.whatwg.org/#interface-formdata * Fix some wording, add a link * Tweak submitter wording/links, add text around form* attrs * Add release note entry * Remove tags

For whatwg/xhr#366.

This patch adds support for the new submitter argument to the FormData constructor. Spec: https://xhr.spec.whatwg.org/#interface-formdata Spec PR (merged): whatwg/xhr#366 WPT PR: #37895 Bug: 1410542 Change-Id: If17f782f75ae40ae21241c169afc52761fc89544 Reviewed-on: https://chromium-review.googlesource.com/c/chromium/src/+/4189297 Reviewed-by: Mason Freed <[email protected]> Commit-Queue: Mason Freed <[email protected]> Cr-Commit-Position: refs/heads/main@{#1100734}

In order to fully support it, this requires more robust Image Button support (i.e. track selected coordinate, use when constructing form data set). This feature is implemented in the latest versions of Chrome/Firefox/ Safari, where the newly enabled WPTs are also passing. Spec: https://xhr.spec.whatwg.org/#interface-formdata Spec PR: whatwg/xhr#366

This was recently added to the standard in whatwg/xhr#366.

Summary: This has been widely available for a [while](https://caniuse.com/?search=FormData.submitter) now References: - https://xhr.spec.whatwg.org/#interface-formdata - https://developer.mozilla.org/en-US/docs/Web/API/FormData/FormData - whatwg/xhr#366 (review) (discussion on why null is allowed) Pull Request resolved: #9145 Reviewed By: SamChou19815 Differential Revision: D57181660 fbshipit-source-id: 98502daf0a26d361820739a90607e7a2d1275d66

…, a=testonly Automatic update from web-platform-tests Add FormData constructor submitter tests For whatwg/xhr#366. -- wpt-commits: 0986c763928822dd6b62ee7223d8a54827f357c7 wpt-pr: 37895

Add optional submitter argument to FormData constructor

29b1df8

Closes whatwg#262

annevk reviewed Jan 12, 2023

View reviewed changes

xhr.bs Outdated Show resolved Hide resolved

jenseng and others added 2 commits January 12, 2023 08:54

Update xhr.bs

3433d32

Co-authored-by: Anne van Kesteren <[email protected]>

Remove trailing whitespace

6e014f7

This was referenced Jan 12, 2023

Meta: export form owner and submit button whatwg/html#8718

Merged

fix(react-router-dom): fix submitter serialization remix-run/react-router#9865

Merged

Add FormData.constructor submitter tests web-platform-tests/wpt#37895

Merged

annevk pushed a commit to whatwg/html that referenced this pull request Jan 25, 2023

Meta: export form owner and submit button

e3c56ca

For whatwg/xhr#366.

annevk reviewed Jan 25, 2023

View reviewed changes

pmeenan pushed a commit to pmeenan/html that referenced this pull request Jan 25, 2023

Meta: export form owner and submit button

37b4a08

For whatwg/xhr#366.

jenseng mentioned this pull request Jan 26, 2023

Document FormData constructor submitter parameter mdn/content#23917

Closed

This was referenced Jan 26, 2023

Add optional submitter parameter to FormData constructor WebKit/WebKit#9188

Merged

An un-activated Image Button submitter should add (0, 0) entries to the form data set whatwg/html#8785

Closed

Update xhr.bs

e28ed75

annevk pushed a commit to web-platform-tests/wpt that referenced this pull request Jan 27, 2023

Add FormData constructor submitter tests

0986c76

For whatwg/xhr#366.

annevk merged commit 1c2d7f2 into whatwg:main Jan 27, 2023

jenseng deleted the form-data-submitter branch January 27, 2023 15:43

chromium-wpt-export-bot mentioned this pull request Jan 28, 2023

Add optional submitter argument to FormData constructor web-platform-tests/wpt#38242

Merged

jenseng mentioned this pull request Jan 28, 2023

Document the FormData constructor submitter parameter mdn/content#23950

Merged

jenseng mentioned this pull request Jan 30, 2023

FYI - Add optional submitter parameter to the FormData constructor w3ctag/design-reviews#812

Closed

1 task

jenseng mentioned this pull request Feb 7, 2023

Update web-platform-tests jsdom/jsdom#3508

Merged

jenseng mentioned this pull request Feb 17, 2023

FormData.constructor: implement optional submitter parameter jsdom/jsdom#3496

Merged

jenseng mentioned this pull request Mar 10, 2023

Issue with "FormData()": type=submit inputs not included mdn/content#14305

Closed

marcoscaceres pushed a commit to web-platform-tests/wpt that referenced this pull request Mar 28, 2023

Add FormData constructor submitter tests

ae57130

For whatwg/xhr#366.

domenic pushed a commit to jsdom/jsdom that referenced this pull request May 27, 2023

Implement FormData constructor's submitter argument

d2103e4

This was recently added to the standard in whatwg/xhr#366.

jenseng mentioned this pull request May 9, 2024

Add submitter parameter to FormData constructor facebook/flow#9145

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add optional submitter argument to FormData constructor #366

Add optional submitter argument to FormData constructor #366

jenseng commented Jan 12, 2023 •

edited

Loading

annevk left a comment

annevk commented Jan 12, 2023

jenseng commented Jan 23, 2023

jenseng commented Jan 23, 2023

mfreed7 commented Jan 23, 2023

jenseng commented Jan 24, 2023

cdumez commented Jan 25, 2023

annevk commented Jan 25, 2023

jenseng commented Jan 25, 2023

annevk Jan 25, 2023

jenseng Jan 25, 2023 •

edited

Loading

annevk Jan 25, 2023

jenseng Jan 25, 2023

jenseng Jan 25, 2023 •

edited

Loading

jenseng commented Jan 25, 2023

jenseng commented Jan 26, 2023 •

edited

Loading

annevk commented Jan 26, 2023

jenseng commented Jan 26, 2023

jenseng commented Jan 28, 2023

Add optional submitter argument to FormData constructor #366

Add optional submitter argument to FormData constructor #366

Conversation

jenseng commented Jan 12, 2023 • edited Loading

annevk left a comment

Choose a reason for hiding this comment

annevk commented Jan 12, 2023

jenseng commented Jan 23, 2023

jenseng commented Jan 23, 2023

mfreed7 commented Jan 23, 2023

jenseng commented Jan 24, 2023

cdumez commented Jan 25, 2023

annevk commented Jan 25, 2023

jenseng commented Jan 25, 2023

annevk Jan 25, 2023

Choose a reason for hiding this comment

jenseng Jan 25, 2023 • edited Loading

Choose a reason for hiding this comment

annevk Jan 25, 2023

Choose a reason for hiding this comment

jenseng Jan 25, 2023

Choose a reason for hiding this comment

jenseng Jan 25, 2023 • edited Loading

Choose a reason for hiding this comment

jenseng commented Jan 25, 2023

jenseng commented Jan 26, 2023 • edited Loading

annevk commented Jan 26, 2023

jenseng commented Jan 26, 2023

jenseng commented Jan 28, 2023

jenseng commented Jan 12, 2023 •

edited

Loading

jenseng Jan 25, 2023 •

edited

Loading

jenseng Jan 25, 2023 •

edited

Loading

jenseng commented Jan 26, 2023 •

edited

Loading