feat: implement File System API support #41419

codebytere · 2024-02-22T21:39:36Z

Description of Change

Implements support for the File System API, with permissions brokered through session.setPermissionRequestHandler. When file or directory functions require permissions, setPermissionRequestHandler will be called with details.

Example:

const [fileHandle] = await window.showOpenFilePicker();
const writable = await fileHandle.createWritable();

session.defaultSession.setPermissionRequestHandler((webContents, permission, callback, details) => {
      console.log(permission) // 'fileSystem'
      console.log(details) 
      /*
      {
          accessType: 'writable',
          isDirectory: false,
          isMainFrame: true,
          path: '/path/to/my/file',
          requestingUrl: 'some_url.html'
        }
      */
      callback(true);
    }
);

In the above example, if callback is called with true, the following would be logged to console:

FileSystemWritableFileStream {mode: 'siloed', locked: false}

otherwise, the following error would be logged:

NotAllowedError: The request is not allowed by the user agent or the platform in the current context.

Checklist

PR description included and stakeholders cc'd
npm test passes
tests are changed or added
relevant documentation, tutorials, templates and examples are 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: Implemented support for the File System API.

docs/api/session.md

RangerMauve · 2024-02-26T19:37:07Z

The general API looks great. TY for taking this on. 🙇

MarshallOfSound

Thinking about how to do the details object better

docs/api/session.md

ckerr

There seems to be some other discussion about the API itself, so I've avoided that for this review and just focused on some more basic C++ code review

shell/browser/file_system_access/electron_file_system_access_permission_context.h

shell/browser/file_system_access/electron_file_system_access_permission_context.cc

ckerr

More C++ review

shell/browser/file_system_access/file_system_access_permission_context.cc

shell/browser/file_system_access/file_system_access_permission_context.h

shell/browser/file_system_access/file_system_access_permission_context.cc

ckerr · 2024-02-29T19:32:25Z

@codebytere ooooh I see now a lot of this is copied from upstream. Matching the upstream impl is a higher priority than some of my C++ suggestions; feel free to mark as resolved any suggestions that would cause code shear compared to the upstream code!!

MarshallOfSound

Docs / types seem good. Question about drift from upstream and the block list

shell/browser/file_system_access/file_system_access_permission_context.cc

jkleinsc

API LGTM

spec/chromium-spec.ts

MarshallOfSound

API LGTM

release-clerk · 2024-04-10T20:06:50Z

Release Notes Persisted

Implemented support for the File System API.

trop · 2024-04-10T20:07:31Z

I have automatically backported this PR to "30-x-y", please check out #41827

@codebytere

Chromium implemented the ability to copy files to the clipboard and read file paths from the clipboard in 2021. See: https://chromium-review.googlesource.com/c/chromium/src/+/2651770. In electron#41419, @codebytere has already implemented a partial API (WriteFilesForTesting). In the current PR, I renamed the previous `WriteFilesForTesting` to `WriteFiles` and added a `ReadFiles` method to match it. Additionally, I improved the Write method, and now `clipboard.write` also supports the `files` parameter. Signed-off-by: Kevin Cui <[email protected]>

@codebytere

Chromium implemented the ability to copy files to the clipboard and read file paths from the clipboard in 2021. See: https://chromium-review.googlesource.com/c/chromium/src/+/2651770. In electron#41419, @codebytere has already implemented a partial API (WriteFilesForTesting). In the current PR, I renamed the previous `WriteFilesForTesting` to `WriteFiles` and added a `ReadFiles` method to match it. Additionally, I improved the Write method, and now `clipboard.write` also supports the `files` parameter. fix: electron#9035 electron#26377 Signed-off-by: Kevin Cui <[email protected]>

@codebytere

Chromium implemented the ability to copy files to the clipboard and read file paths from the clipboard in 2021. See: https://chromium-review.googlesource.com/c/chromium/src/+/2651770. In electron#41419, @codebytere has already implemented a partial API (WriteFilesForTesting). In the current PR, I renamed the previous `WriteFilesForTesting` to `WriteFiles` and added a `ReadFiles` method to match it. Additionally, I improved the Write method, and now `clipboard.write` also supports the `files` parameter. fix: electron#9035 electron#26377 Signed-off-by: Kevin Cui <[email protected]>

@codebytere

Chromium implemented the ability to copy files to the clipboard and read file paths from the clipboard in 2021. See: https://chromium-review.googlesource.com/c/chromium/src/+/2651770. In electron#41419, @codebytere has already implemented a partial API (WriteFilesForTesting). In the current PR, I renamed the previous `WriteFilesForTesting` to `WriteFiles` and added a `ReadFiles` method to match it. Additionally, I improved the Write method, and now `clipboard.write` also supports the `files` parameter. fix: electron#9035 electron#26377 Signed-off-by: Kevin Cui <[email protected]>

@codebytere

Chromium implemented the ability to copy files to the clipboard and read file paths from the clipboard in 2021. See: https://chromium-review.googlesource.com/c/chromium/src/+/2651770. In electron#41419, @codebytere has already implemented a partial API (WriteFilesForTesting). In the current PR, I renamed the previous `WriteFilesForTesting` to `WriteFiles` and added a `ReadFiles` method to match it. Additionally, I improved the Write method, and now `clipboard.write` also supports the `files` parameter. fix: electron#9035 electron#26377 Signed-off-by: Kevin Cui <[email protected]>

electron-cation bot added the new-pr 🌱 PR opened recently label Feb 22, 2024

dsanders11 reviewed Feb 22, 2024

View reviewed changes

docs/api/session.md Outdated Show resolved Hide resolved

docs/api/session.md Outdated Show resolved Hide resolved

codebytere force-pushed the native-filesystem-permissions branch 3 times, most recently from 87057d5 to eef9839 Compare February 23, 2024 13:55

codebytere requested a review from dsanders11 February 23, 2024 13:55

codebytere added the semver/minor backwards-compatible functionality label Feb 23, 2024

electron-cation bot added the api-review/requested 🗳 label Feb 23, 2024

codebytere marked this pull request as ready for review February 23, 2024 13:56

MarshallOfSound requested changes Feb 26, 2024

View reviewed changes

docs/api/session.md Outdated Show resolved Hide resolved

ckerr reviewed Feb 28, 2024

View reviewed changes

codebytere force-pushed the native-filesystem-permissions branch 2 times, most recently from a88b1b9 to 2dd2753 Compare February 29, 2024 11:46

ckerr reviewed Feb 29, 2024

View reviewed changes

electron-cation bot removed the new-pr 🌱 PR opened recently label Mar 1, 2024

codebytere force-pushed the native-filesystem-permissions branch 2 times, most recently from 99b4a36 to 5165697 Compare March 4, 2024 13:23

larxn mentioned this pull request Mar 9, 2024

[feature] add anthropic provider larxn/dear-ghost#1

Merged

3 tasks

codebytere force-pushed the native-filesystem-permissions branch from 5165697 to 1c41cb9 Compare March 18, 2024 19:45

codebytere requested a review from MarshallOfSound March 18, 2024 19:45

codebytere force-pushed the native-filesystem-permissions branch from 1c41cb9 to 21ec92d Compare March 18, 2024 22:52

codebytere added the target/30-x-y PR should also be added to the "30-x-y" branch. label Mar 25, 2024

codebytere requested a review from a team March 25, 2024 11:43

MarshallOfSound reviewed Mar 25, 2024

View reviewed changes

shell/browser/file_system_access/file_system_access_permission_context.cc Outdated Show resolved Hide resolved

shell/browser/file_system_access/file_system_access_permission_context.cc Outdated Show resolved Hide resolved

codebytere force-pushed the native-filesystem-permissions branch 2 times, most recently from d9e1c1c to 0338431 Compare March 26, 2024 11:26

codebytere requested a review from a team as a code owner March 27, 2024 09:49

codebytere force-pushed the native-filesystem-permissions branch from 81ab428 to 511b705 Compare March 28, 2024 10:51

codebytere added 2 commits April 10, 2024 09:59

lint

25e2398

fix: Windows build

adbbfaa

codebytere force-pushed the native-filesystem-permissions branch from 31ab84c to adbbfaa Compare April 10, 2024 08:03

codebytere requested a review from MarshallOfSound April 10, 2024 08:51

jkleinsc reviewed Apr 10, 2024

View reviewed changes

spec/chromium-spec.ts Outdated Show resolved Hide resolved

spec/chromium-spec.ts Outdated Show resolved Hide resolved

spec/chromium-spec.ts Outdated Show resolved Hide resolved

spec/chromium-spec.ts Show resolved Hide resolved

codebytere requested a review from ckerr April 10, 2024 15:19

test: clarify test verbiage

28db4db

codebytere force-pushed the native-filesystem-permissions branch from 3fa54d1 to 28db4db Compare April 10, 2024 17:22

MarshallOfSound approved these changes Apr 10, 2024

View reviewed changes

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

codebytere merged commit 344aba0 into main Apr 10, 2024

codebytere deleted the native-filesystem-permissions branch April 10, 2024 20:06

trop bot mentioned this pull request Apr 10, 2024

feat: implement File System API support #41827

Merged

trop bot added in-flight/30-x-y merged/30-x-y PR was merged to the "30-x-y" branch. and removed target/30-x-y PR should also be added to the "30-x-y" branch. in-flight/30-x-y labels Apr 10, 2024

Jaifroid mentioned this pull request Apr 24, 2024

[Enhancement]: Missing support for Persistent Permissions with the File System Access API as of Chrome 122 #41957

Closed

3 tasks

erickzhao added the needs-docs An API or larger change that needs expanded documentation label Jul 29, 2024

erickzhao mentioned this pull request Aug 13, 2024

docs: add guide for web api permissions #43306

Open

ckerr mentioned this pull request Apr 17, 2025

refactor: remove WebContentsPermissionHelper::PermissionTypes::KEYBOARD_LOCK #46670

Merged

3 tasks

BlackHole1 mentioned this pull request Aug 6, 2025

feat(clipboard): support read/write files #47975

Closed

5 tasks

feat: implement File System API support #41419

feat: implement File System API support #41419

Uh oh!

Conversation

codebytere commented Feb 22, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description of Change

Checklist

Release Notes

Uh oh!

Uh oh!

Uh oh!

RangerMauve commented Feb 26, 2024

Uh oh!

MarshallOfSound left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

ckerr left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ckerr left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ckerr commented Feb 29, 2024

Uh oh!

MarshallOfSound left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

jkleinsc left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

MarshallOfSound left a comment

Choose a reason for hiding this comment

Uh oh!

release-clerk bot commented Apr 10, 2024

Uh oh!

trop bot commented Apr 10, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

codebytere commented Feb 22, 2024 •

edited

Loading