[cross_file] Updates cross_file to a package separated federated plugin by bparrishMines · Pull Request #11010 · flutter/packages

bparrishMines · 2026-02-12T19:49:37Z

Updates cross_file to a package separated federated plugin. ~~Keeping the package separation is still debatable.~~

Follows the general design outlined at https://flutter.dev/go/flutter-file-system

Implementation is split into

cross_file_io: for use cases supportable by dart:io (all platforms except Web)
cross_file_web: for Web
- Uses Blobs and Blob URLs.
- Supports package:web Files (subclass of Blob.
cross_file_android: for Android Scoped Storage
- Uses the high level abstraction of DocumentFile to interact with content uris.
- Uses Kotlin.
cross_file_darwin: for iOS and macOS App Sandbox
- Creates implementation for security scoped URI that call:
  - Adds support to call URL.startAccessingSecurityScopedResource and URL.stopaccessingsecurityscopedresource.
  - Future Work: Adds support to bookmark URLs following: https://developer.apple.com/documentation/Security/accessing-files-from-the-macos-app-sandbox#Persist-file-access-with-security-scoped-URL-bookmarks
- Creates implementation for accessing an asset with PhotoKit.

Pre-Review Checklist

If you need help, consider asking for advice on the #hackers-new channel on Discord.

Note: The Flutter team is currently trialing the use of Gemini Code Assist for GitHub. Comments from the gemini-code-assist bot should not be taken as authoritative feedback from the Flutter team. If you find its comments useful you can update your code accordingly, but if you are unsure or disagree with the feedback, please feel free to wait for a Flutter team member's review for guidance on which automated comments should be addressed.

Regular contributors who have demonstrated familiarity with the repository guidelines only need to comment if the PR is not auto-exempted by repo tooling. ↩ ↩² ↩³

bparrishMines · 2026-02-13T16:21:14Z

@stuartmorgan-g This is ready for initial review. The tests are mostly failing on missing integration tests, missing examples in cross_file_io, and the git deps. I can work on fixing these while the code is being reviewed.

gemini-code-assist

Code Review

This pull request is a significant and well-executed refactoring of cross_file into a federated plugin structure. The new architecture is clean and aligns with modern Flutter plugin conventions. I've identified a few areas for improvement related to dependency version consistency, native code safety, and asynchronous programming best practices, but overall this is a solid contribution.

gemini-code-assist · 2026-02-13T16:22:23Z

+  func tryCreateBookmarkedUrl(url: String) throws -> String? {
+    let nativeUrl = URL(string: url)!
+    let data = try nativeUrl.bookmarkData(
+      options: [],
+      includingResourceValuesForKeys: nil,
+      relativeTo: nil
+    )
+
+    var isStale: Bool = true
+    let bookmarkedUrl: URL = try URL(resolvingBookmarkData: data, bookmarkDataIsStale: &isStale)
+
+    if !isStale {
+      return bookmarkedUrl.absoluteString
+    }
+
+    return nil
+  }
+
+  func startAccessingSecurityScopedResource(url: String) throws -> Bool {
+    return URL(string: url)!.startAccessingSecurityScopedResource()
+  }
+
+  func stopAccessingSecurityScopedResource(url: String) throws {
+    URL(string: url)!.stopAccessingSecurityScopedResource()
+  }


The use of force unwrapping (!) when creating a URL from a string is unsafe and can lead to a runtime crash if the url string is malformed. It's better to handle this potential failure gracefully, for example by using guard let and throwing an error.

func tryCreateBookmarkedUrl(url: String) throws -> String? { guard let nativeUrl = URL(string: url) else { throw PigeonError(code: "invalid_url", message: "Invalid URL string: \(url)", details: nil) } let data = try nativeUrl.bookmarkData( options: [], includingResourceValuesForKeys: nil, relativeTo: nil ) var isStale: Bool = true let bookmarkedUrl: URL = try URL(resolvingBookmarkData: data, bookmarkDataIsStale: &isStale) if !isStale { return bookmarkedUrl.absoluteString } return nil } func startAccessingSecurityScopedResource(url: String) throws -> Bool { guard let nativeUrl = URL(string: url) else { throw PigeonError(code: "invalid_url", message: "Invalid URL string: \(url)", details: nil) } return nativeUrl.startAccessingSecurityScopedResource() } func stopAccessingSecurityScopedResource(url: String) throws { guard let nativeUrl = URL(string: url) else { throw PigeonError(code: "invalid_url", message: "Invalid URL string: \(url)", details: nil) } nativeUrl.stopAccessingSecurityScopedResource() }

gemini-code-assist · 2026-02-13T16:22:23Z

+    ext.kotlin_version = "2.2.21"
+    repositories {
+        google()
+        mavenCentral()
+    }
+
+    dependencies {
+        classpath("com.android.tools.build:gradle:8.13.1")
+        classpath("org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version")


There are inconsistent versions of Gradle, the Android Gradle Plugin (AGP), and Kotlin across the new packages and examples. For instance, this file uses AGP 8.13.1 and Kotlin 2.2.21, while other parts of the PR use older versions (e.g., AGP 8.9.1, Kotlin 2.1.0). To improve maintainability and prevent potential build issues, it would be beneficial to align these versions to a consistent, recent set across all the new Android projects.

…rossfile

This reverts commit 71f7ab6.

bparrishMines · 2026-08-13T19:16:50Z

@stuartmorgan-g This is ready for another review. I added the FileSystem implementation of XFile that the io implementation uses.

stuartmorgan-g · 2026-08-20T18:03:52Z

+  /// See [FileSystemXDirectory.fromCreationParams] for setting parameters
+  /// for a specific platform.
+  FileSystemXDirectory.fromUri(Uri uri)
+    : this(uri.toFilePath(windows: defaultTargetPlatform == TargetPlatform.windows));


This is fine for now, but we may need to add a static class-level override at some point that lets people change this for use in tests.

stuartmorgan-g · 2026-08-20T18:05:35Z

+
+import '../cross_directory.dart';
+
+/// A reference to a directory (or folder) within a devices scoped storage.


Typo: device's

stuartmorgan-g · 2026-08-20T18:13:47Z

+  }
+
+  /// Instantiates a [ScopedStorageXFile] as a reference to a directory
+  /// (or folder) on the file system within a devices scoped storage.


Typo: device's

stuartmorgan-g · 2026-08-20T18:35:58Z

+  how to access platform-specific feature.
+* **Breaking Change** Removes `XFile.mimeType`.
+* **Breaking Change** Removes `XFile.path`. This has been replaced by `FileSystemXFile.path`.
+* **Breaking Change** Changes `XFile.name` to a method that returns `Future<String>` rather than a


We usually use a single heading and then a sublist for multiple breaking changes; see https://github.com/flutter/flutter/blob/master/docs/ecosystem/contributing/README.md#changelog-style

stuartmorgan-g · 2026-08-20T18:59:57Z

+import 'android_library.g.dart';
+import 'android_scoped_storage_cross_file.dart';
+
+/// Implementation of [PlatformScopedStorageXDirectory] for iOS and macOS.


Probably not for iOS and macOS ;)

stuartmorgan-g · 2026-08-20T20:20:45Z

+
+    let plugin = CrossFileDarwinPlugin(binaryMessenger: messenger)
+
+    registrar.publish(plugin)


Let's add a comment here saying it's so that we get detachFromEngine, since this a really non-obvious aspect of the Flutter plugin APIs.

stuartmorgan-g · 2026-08-20T20:21:25Z

+
+#if os(iOS)
+  import Flutter
+  import UIKit


Do we use this?

stuartmorgan-g · 2026-08-20T20:21:39Z

+  import UIKit
+#elseif os(macOS)
+  import FlutterMacOS
+  import Foundation


This is already imported outside the platform-specific logic.

stuartmorgan-g · 2026-08-20T20:22:24Z

I've gotten confused about the current implementation state; why is there both ffigen code and pigeon code in the iOS implementation package?

stuartmorgan-g · 2026-08-20T20:25:10Z

+  #error("Unsupported platform.")
+#endif
+
+// Placeholder for adding tests.


Ah right, I forgot we don't do this via config-level excludes because of the way native unit and integration tests are combined for running on iOS.

Let's change this to a comment explaining why we don't do native unit testing for this package as an exception to general repo policy, so it's clear why this is a placeholder.

…rossfile

github-actions Bot added p: cross_file platform-android platform-ios platform-linux platform-macos platform-web platform-windows labels Feb 12, 2026

bparrishMines added the federated: all_changes PR that contains changes for all packages for a federated plugin change label Feb 12, 2026

bparrishMines changed the title ~~New crossfile~~ [cross_file] Updates cross_file to a package separated federated plugin Feb 12, 2026

bparrishMines marked this pull request as ready for review February 13, 2026 16:19

bparrishMines requested a review from stuartmorgan-g as a code owner February 13, 2026 16:19

bparrishMines requested a review from ditman February 13, 2026 16:21

gemini-code-assist Bot reviewed Feb 13, 2026

View reviewed changes

bparrishMines added 16 commits February 16, 2026 21:13

formatting

1d1e949

change settings file to groovy

b623ad4

publish too

f420e80

add new files

6415ea6

add example app

00a9f10

update project gradles

5fc9cd5

add dart integration test file

79a98cb

improve pubspecs and add test drivers

fe48304

fix darwin tests

8a5d3cc

update interface

a234ecd

web update

9765b61

update darwin

54d0668

update android

b276f77

update io

9eeb9ed

update cross_file

ac3dcf0

format and excerpts

ae1f8e0

bparrishMines added 14 commits August 11, 2026 20:47

add readbytes test

cad1509

Merge branch 'main' of https://github.com/flutter/packages into new_c…

247b770

…rossfile

update excerpts

feff9f3

update readme

cf91564

add breaking changes

8d7ff92

unused import

87e5c74

remove darwin tests that aren't used

71f7ab6

formatting

1634e7d

Merge branch 'main' of https://github.com/flutter/packages into new_c…

cf58005

…rossfile

unused import

076e08e

add license to darwin ffi

3f6f303

Revert "remove darwin tests that aren't used"

ec62032

This reverts commit 71f7ab6.

fix android tests

7966743

add cross_file_web because it uses chrome for flutter

74a5fda

bparrishMines added 5 commits August 14, 2026 13:19

doc improvements

42900f4

update readme with implementations explanation

96c63ae

fix cross_file readme more

5ed1a41

add docs to platform implementation

96784f5

extra bar

913f18e

bparrishMines mentioned this pull request Aug 20, 2026

[cross_file] Platform-aware factories. flutter/flutter#91869

Open

bparrishMines added 2 commits August 20, 2026 15:29

copy dart_test files

d2d336b

add files

30860ab

stuartmorgan-g reviewed Aug 20, 2026

View reviewed changes

bparrishMines added 6 commits August 21, 2026 15:20

formatting

af76d10

Merge branch 'main' of https://github.com/flutter/packages into new_c…

d2f54f0

…rossfile

remove dart_test.yaml

34a8489

format swift

b98426e

remove changes from other packages

a90e200

update pigeon files

a1c238a


		import '../cross_directory.dart';

		/// A reference to a directory (or folder) within a devices scoped storage.


		let plugin = CrossFileDarwinPlugin(binaryMessenger: messenger)

		registrar.publish(plugin)

Uh oh!

Conversation

bparrishMines commented Feb 12, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pre-Review Checklist

Footnotes

Uh oh!

bparrishMines commented Feb 13, 2026

Uh oh!

gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

Code Review

Uh oh!

gemini-code-assist Bot Feb 13, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

gemini-code-assist Bot Feb 13, 2026

Choose a reason for hiding this comment

Uh oh!

bparrishMines commented Aug 13, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

bparrishMines commented Feb 12, 2026 •

edited

Loading