feat: add more info in setWindowOpenHandler details by nornagon · Pull Request #28518 · electron/electron

nornagon · 2021-04-05T22:07:05Z

Description of Change

This adds disposition, referrer and postBody to the details object passed to the window open handler.

Builds on #28513, which fixes a number of PostBody-related issues.

Checklist

PR description included and stakeholders cc'd
npm test passes
tests are changed or added
relevant documentation is changed or added
PR release notes describe the change in a way relevant to app developers, and are capitalized, punctuated, and past tense.

Release Notes

Notes: Added disposition, referrer and postBody to the details object passed to the window open handler registered with setWindowOpenHandler.

nornagon · 2021-04-05T22:07:37Z

This should perhaps be target/12-x-y too

Prinzhorn · 2021-04-06T09:42:44Z

Would it be possible to add the parsed features as well? Originally I opened #28377 before I realized setWindowOpenHandler was lacking additional information too.

nornagon · 2021-04-06T17:37:40Z

Would it be possible to add the parsed features as well? Originally I opened #28377 before I realized setWindowOpenHandler was lacking additional information too.

parsed features is a little more complicated because:

there's already a property called features in the details object which contains the raw features string, and
parsing the features currently splits the results between options, webPreferences and additionalFeatures, which isn't really a great API and I'd rather not propagate that bad API to the new method.

If it helps, the code for parsing the features isn't much more complicated than features.split(","):

electron/lib/common/parse-features-string.ts

Lines 59 to 72 in 77dcf10

    
           export function parseCommaSeparatedKeyValue (source: string, useSoonToBeDeprecatedBehaviorForBareKeys: boolean) { 
        
             const bareKeys = [] as string[]; 
        
             const parsed = {} as { [key: string]: any }; 
        
             for (const keyValuePair of source.split(',')) { 
        
               const [key, value] = keyValuePair.split('=').map(str => str.trim()); 
        
               if (useSoonToBeDeprecatedBehaviorForBareKeys && value === undefined) { 
        
                 if (key) { bareKeys.push(key); } 
        
                 continue; 
        
               } 
        
               parsed[key] = coerce(key, value); 
        
             } 
        
             return { parsed, bareKeys }; 
        
           }

Prinzhorn · 2021-04-07T06:42:56Z

@nornagon thanks for looking into this, I'll probably use JSON then if I can use any string. I'm in control of the features string anyway.

release-clerk · 2021-04-13T19:35:30Z

Release Notes Persisted

Added disposition, referrer and postBody to the details object passed to the window open handler registered with setWindowOpenHandler.

trop · 2021-04-13T19:35:46Z

I was unable to backport this PR to "13-x-y" cleanly;
you will need to perform this backport manually.

* fix: invoke the window open handler for _blank links * feat: add disposition to setWindowOpenHandler details * fix: pass postData to new-window event * postData can be heterogeneous * fix type of postBody * fix type of UploadFile and UploadRawData to be discriminated unions * exclude the empty string from additionalFeatures * add a test * add postBody and referrer to setWindowOpenHandler args * appease typescript * Update api-browser-window-spec.ts * update snapshots

trop · 2021-05-21T16:50:51Z

@VerteDinde has manually backported this PR to "master", please check out #29276

trop · 2021-05-21T16:51:08Z

@VerteDinde has manually backported this PR to "13-x-y", please check out #29276

trop · 2021-05-21T16:54:37Z

@VerteDinde has manually backported this PR to "13-x-y", please check out #29277

* fix: invoke the window open handler for _blank links * feat: add disposition to setWindowOpenHandler details * fix: pass postData to new-window event * postData can be heterogeneous * fix type of postBody * fix type of UploadFile and UploadRawData to be discriminated unions * exclude the empty string from additionalFeatures * add a test * add postBody and referrer to setWindowOpenHandler args * appease typescript * Update api-browser-window-spec.ts * update snapshots Co-authored-by: Jeremy Rose <jeremya@chromium.org>

Since the introduction of `setWindowOpenHandler` `features` is no longer parsed but passed as a raw string (see electron#28518 (comment)). I've switched to JSON to pass data through `window.open` for my multi-window application. The docs should reflect that this can be an arbitrary string.

nornagon and others added 10 commits April 2, 2021 16:54

fix: invoke the window open handler for _blank links

cd9afb6

feat: add disposition to setWindowOpenHandler details

5d429ec

fix: pass postData to new-window event

99a29b9

postData can be heterogeneous

d36fec7

fix type of postBody

6d42113

fix type of UploadFile and UploadRawData to be discriminated unions

07b8be6

exclude the empty string from additionalFeatures

e2dcf91

add a test

5aec617

Merge branch 'nornagon-patch-2' into window-open-opts

67b0da9

add postBody and referrer to setWindowOpenHandler args

cee879a

electron-cation bot added the new-pr 🌱 PR opened recently label Apr 5, 2021

nornagon added the semver/minor backwards-compatible functionality label Apr 5, 2021

electron-cation bot added the api-review/requested 🗳 label Apr 5, 2021

nornagon added target/13-x-y and removed api-review/requested 🗳 labels Apr 5, 2021

electron-cation bot added the api-review/requested 🗳 label Apr 5, 2021

appease typescript

92ee4d9

Merge branch 'master' into window-open-opts

40238af

nornagon and others added 2 commits April 6, 2021 11:42

Update api-browser-window-spec.ts

03735ff

update snapshots

d33db97

miniak approved these changes Apr 9, 2021

View reviewed changes

jkleinsc approved these changes Apr 9, 2021

View reviewed changes

zcbenz approved these changes Apr 12, 2021

View reviewed changes

electron-cation bot removed the new-pr 🌱 PR opened recently label Apr 12, 2021

jkleinsc added api-review/approved ✅ and removed api-review/requested 🗳 labels Apr 13, 2021

electron-cation bot added api-review/requested 🗳 and removed api-review/approved ✅ labels Apr 13, 2021

jkleinsc merged commit dba4df9 into master Apr 13, 2021

jkleinsc deleted the window-open-opts branch April 13, 2021 19:35

trop bot added needs-manual-bp/13-x-y and removed target/13-x-y labels Apr 13, 2021

PalmerAL mentioned this pull request May 14, 2021

Add experimental popup window support minbrowser/min#1608

Merged

Mario-Kart-Felix mentioned this pull request May 17, 2021

Description change Mario-Kart-Felix/electron#7

Open

5 tasks

VerteDinde mentioned this pull request May 21, 2021

feat: add more info in setWindowOpenHandler details #29276

Closed

trop bot added the in-flight/master label May 21, 2021

trop bot added in-flight/13-x-y and removed needs-manual-bp/13-x-y labels May 21, 2021

VerteDinde mentioned this pull request May 21, 2021

feat: add more info in setWindowOpenHandler details (#28518) #29277

Merged

trop bot added in-flight/13-x-y and removed in-flight/13-x-y labels May 21, 2021

trop bot added the merged/13-x-y label May 24, 2021

Prinzhorn mentioned this pull request Jul 29, 2021

Update setWindowOpenHandler "features" docs #30325

Closed

2 tasks

VerteDinde mentioned this pull request Sep 20, 2021

fix: propagate window.open settings to child window #31031

Merged

5 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add more info in setWindowOpenHandler details#28518

feat: add more info in setWindowOpenHandler details#28518
jkleinsc merged 14 commits intomasterfrom
window-open-opts

nornagon commented Apr 5, 2021

Uh oh!

nornagon commented Apr 5, 2021

Uh oh!

Prinzhorn commented Apr 6, 2021 •

edited

Loading

Uh oh!

nornagon commented Apr 6, 2021

Uh oh!

Prinzhorn commented Apr 7, 2021

Uh oh!

release-clerk bot commented Apr 13, 2021

Uh oh!

trop bot commented Apr 13, 2021

Uh oh!

trop bot commented May 21, 2021

Uh oh!

trop bot commented May 21, 2021

Uh oh!

trop bot commented May 21, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Conversation

nornagon commented Apr 5, 2021

Description of Change

Checklist

Release Notes

Uh oh!

nornagon commented Apr 5, 2021

Uh oh!

Prinzhorn commented Apr 6, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

nornagon commented Apr 6, 2021

Uh oh!

Prinzhorn commented Apr 7, 2021

Uh oh!

release-clerk bot commented Apr 13, 2021

Uh oh!

trop bot commented Apr 13, 2021

Uh oh!

trop bot commented May 21, 2021

Uh oh!

trop bot commented May 21, 2021

Uh oh!

trop bot commented May 21, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Prinzhorn commented Apr 6, 2021 •

edited

Loading