Add rename support for Windows (#201)

brianquinlan · web-flow · commit a36923b68845 · 2025-03-17T10:20:10.000-07:00
diff --git a/pkgs/io_file/README.md b/pkgs/io_file/README.md
@@ -27,7 +27,7 @@ See
 |  read file (bytes)    |   [ ]   |  [ ]  |  [ ]  |  [ ]  |   [ ]   |
 |  read file (lines)    |   [ ]   |  [ ]  |  [ ]  |  [ ]  |   [ ]   |
 |  read file (string)   |   [ ]   |  [ ]  |  [ ]  |  [ ]  |   [ ]   |
-|  rename               |   [ ]   |  [X]  |  [ ]  |  [X]  |   [ ]   |
+|  rename               |   [ ]   |  [X]  |  [ ]  |  [X]  |   [X]   |
 |  set permissions      |   [ ]   |  [ ]  |  [ ]  |  [ ]  |   [ ]   |
 |  write file (bytes)   |   [ ]   |  [ ]  |  [ ]  |  [ ]  |   [ ]   |
 |  write file (string)  |   [ ]   |  [ ]  |  [ ]  |  [ ]  |   [ ]   |
diff --git a/pkgs/io_file/lib/io_file.dart b/pkgs/io_file/lib/io_file.dart
@@ -3,3 +3,5 @@
 // BSD-style license that can be found in the LICENSE file.
 
 export 'src/file_system.dart';
+export 'src/vm_file_system_property.dart'
+    if (dart.library.html) 'src/web_file_system_property.dart';
diff --git a/pkgs/io_file/lib/posix_file_system.dart b/pkgs/io_file/lib/posix_file_system.dart
@@ -2,4 +2,5 @@
 // for details. All rights reserved. Use of this source code is governed by a
 // BSD-style license that can be found in the LICENSE file.
 
-export 'src/posix_file_system.dart';
+export 'src/vm_posix_file_system.dart'
+    if (dart.library.html) 'src/web_posix_file_system.dart';
diff --git a/pkgs/io_file/lib/src/vm_file_system_property.dart b/pkgs/io_file/lib/src/vm_file_system_property.dart
@@ -0,0 +1,13 @@
+// Copyright (c) 2025, the Dart project authors.  Please see the AUTHORS file
+// for details. All rights reserved. Use of this source code is governed by a
+// BSD-style license that can be found in the LICENSE file.
+
+import 'dart:io';
+
+import 'file_system.dart';
+import 'vm_posix_file_system.dart';
+import 'vm_windows_file_system.dart';
+
+/// Return the default [FileSystem] for the current platform.
+FileSystem get fileSystem =>
+    Platform.isWindows ? WindowsFileSystem() : PosixFileSystem();
diff --git a/pkgs/io_file/lib/src/vm_posix_file_system.dart b/pkgs/io_file/lib/src/vm_posix_file_system.dart
diff --git a/pkgs/io_file/lib/src/vm_windows_file_system.dart b/pkgs/io_file/lib/src/vm_windows_file_system.dart
@@ -0,0 +1,83 @@
+// Copyright (c) 2025, the Dart project authors.  Please see the AUTHORS file
+// for details. All rights reserved. Use of this source code is governed by a
+// BSD-style license that can be found in the LICENSE file.
+
+import 'dart:ffi';
+import 'dart:io' as io;
+
+import 'package:ffi/ffi.dart';
+import 'package:win32/win32.dart' as win32;
+
+import 'file_system.dart';
+
+String _formatMessage(int errorCode) {
+  final buffer = win32.wsalloc(1024);
+  try {
+    final result = win32.FormatMessage(
+      win32.FORMAT_MESSAGE_FROM_SYSTEM | win32.FORMAT_MESSAGE_IGNORE_INSERTS,
+      nullptr,
+      errorCode,
+      0, // default language
+      buffer,
+      1024,
+      nullptr,
+    );
+    if (result == 0) {
+      return '';
+    } else {
+      return buffer.toDartString();
+    }
+  } finally {
+    win32.free(buffer);
+  }
+}
+
+Exception _getError(int errorCode, String message, String path) {
+  final osError = io.OSError(_formatMessage(errorCode), errorCode);
+
+  switch (errorCode) {
+    case win32.ERROR_ACCESS_DENIED:
+    case win32.ERROR_CURRENT_DIRECTORY:
+    case win32.ERROR_WRITE_PROTECT:
+    case win32.ERROR_BAD_LENGTH:
+    case win32.ERROR_SHARING_VIOLATION:
+    case win32.ERROR_LOCK_VIOLATION:
+    case win32.ERROR_NETWORK_ACCESS_DENIED:
+    case win32.ERROR_DRIVE_LOCKED:
+      return io.PathAccessException(path, osError, message);
+    case win32.ERROR_FILE_EXISTS:
+    case win32.ERROR_ALREADY_EXISTS:
+      return io.PathExistsException(path, osError, message);
+    case win32.ERROR_FILE_NOT_FOUND:
+    case win32.ERROR_PATH_NOT_FOUND:
+    case win32.ERROR_INVALID_DRIVE:
+    case win32.ERROR_INVALID_NAME:
+    case win32.ERROR_NO_MORE_FILES:
+    case win32.ERROR_BAD_NETPATH:
+    case win32.ERROR_BAD_NET_NAME:
+    case win32.ERROR_BAD_PATHNAME:
+      return io.PathNotFoundException(path, osError, message);
+    default:
+      return io.FileSystemException(message, path, osError);
+  }
+}
+
+/// A [FileSystem] implementation for Windows systems.
+base class WindowsFileSystem extends FileSystem {
+  @override
+  void rename(String oldPath, String newPath) => using((arena) {
+    // Calling `GetLastError` for the first time causes the `GetLastError`
+    // symbol to be loaded, which resets `GetLastError`. So make a harmless
+    // call before the value is needed.
+    win32.GetLastError();
+    if (win32.MoveFileEx(
+          oldPath.toNativeUtf16(allocator: arena),
+          newPath.toNativeUtf16(allocator: arena),
+          win32.MOVEFILE_WRITE_THROUGH | win32.MOVEFILE_REPLACE_EXISTING,
+        ) ==
+        win32.FALSE) {
+      final errorCode = win32.GetLastError();
+      throw _getError(errorCode, 'rename failed', oldPath);
+    }
+  });
+}
diff --git a/pkgs/io_file/lib/src/web_file_system_property.dart b/pkgs/io_file/lib/src/web_file_system_property.dart
@@ -0,0 +1,10 @@
+// Copyright (c) 2025, the Dart project authors.  Please see the AUTHORS file
+// for details. All rights reserved. Use of this source code is governed by a
+// BSD-style license that can be found in the LICENSE file.
+
+import 'file_system.dart';
+
+/// Return the default [FileSystem] for the current platform.
+FileSystem get fileSystem {
+  throw UnsupportedError('fileSystem');
+}
diff --git a/pkgs/io_file/lib/src/web_posix_file_system.dart b/pkgs/io_file/lib/src/web_posix_file_system.dart
@@ -0,0 +1,9 @@
+// Copyright (c) 2025, the Dart project authors.  Please see the AUTHORS file
+// for details. All rights reserved. Use of this source code is governed by a
+// BSD-style license that can be found in the LICENSE file.
+
+import 'file_system.dart';
+
+/// A [FileSystem] implementation for POSIX systems (e.g. Android, iOS, Linux,
+/// macOS).
+base class PosixFileSystem extends FileSystem {}
diff --git a/pkgs/io_file/lib/src/web_windows_file_system.dart b/pkgs/io_file/lib/src/web_windows_file_system.dart
@@ -0,0 +1,8 @@
+// Copyright (c) 2025, the Dart project authors.  Please see the AUTHORS file
+// for details. All rights reserved. Use of this source code is governed by a
+// BSD-style license that can be found in the LICENSE file.
+
+import 'file_system.dart';
+
+/// A [FileSystem] implementation for Windows systems.
+base class WindowsFileSystem extends FileSystem {}
diff --git a/pkgs/io_file/lib/windows_file_system.dart b/pkgs/io_file/lib/windows_file_system.dart
@@ -0,0 +1,6 @@
+// Copyright (c) 2025, the Dart project authors.  Please see the AUTHORS file
+// for details. All rights reserved. Use of this source code is governed by a
+// BSD-style license that can be found in the LICENSE file.
+
+export 'src/vm_windows_file_system.dart'
+    if (dart.library.html) 'src/web_windows_file_system.dart';
diff --git a/pkgs/io_file/pubspec.yaml b/pkgs/io_file/pubspec.yaml
@@ -8,6 +8,7 @@ environment:
   sdk: ^3.7.0
 
 dependencies:
+  ffi: ^2.1.4
   stdlibc:
     git:
       # Change this to a released version.
diff --git a/pkgs/io_file/test/rename_test.dart b/pkgs/io_file/test/rename_test.dart
@@ -2,23 +2,23 @@
 // for details. All rights reserved. Use of this source code is governed by a
 // BSD-style license that can be found in the LICENSE file.
 
-@TestOn('posix')
+@TestOn('vm')
 library;
 
 import 'dart:io';
 
-import 'package:io_file/posix_file_system.dart';
+import 'package:io_file/io_file.dart';
 import 'package:test/test.dart';
 
+import 'test_utils.dart';
+
 void main() {
   group('move', () {
     late String tmp;
 
-    setUp(
-      () => tmp = Directory.systemTemp.createTempSync('move').absolute.path,
-    );
+    setUp(() => tmp = createTemp('move'));
 
-    tearDown(() => Directory(tmp).deleteSync(recursive: true));
+    tearDown(() => deleteTemp(tmp));
 
     //TODO(brianquinlan): test with a very long path.
 
@@ -27,7 +27,7 @@ void main() {
       final path2 = '$tmp/file2';
 
       File(path1).writeAsStringSync('Hello World');
-      PosixFileSystem().rename(path1, path2);
+      fileSystem.rename(path1, path2);
       expect(File(path1).existsSync(), isFalse);
       expect(File(path2).existsSync(), isTrue);
     });
@@ -38,7 +38,7 @@ void main() {
 
       File(path1).writeAsStringSync('Hello World #1');
       File(path2).writeAsStringSync('Hello World #2');
-      PosixFileSystem().rename(path1, path2);
+      fileSystem.rename(path1, path2);
       expect(File(path1).existsSync(), isFalse);
       expect(File(path2).readAsStringSync(), 'Hello World #1');
     });
@@ -48,7 +48,7 @@ void main() {
       final path2 = '$tmp/dir2';
 
       Directory(path1).createSync(recursive: true);
-      PosixFileSystem().rename(path1, path2);
+      fileSystem.rename(path1, path2);
       expect(Directory(path1).existsSync(), isFalse);
       expect(Directory(path2).existsSync(), isTrue);
     });
@@ -58,14 +58,14 @@ void main() {
       final path2 = '$tmp/file2';
 
       expect(
-        () => PosixFileSystem().rename(path1, path2),
+        () => fileSystem.rename(path1, path2),
         throwsA(
           isA<PathNotFoundException>()
               .having((e) => e.message, 'message', 'rename failed')
               .having(
                 (e) => e.osError?.errorCode,
                 'errorCode',
-                2, // ENOENT
+                2, // ENOENT, ERROR_FILE_NOT_FOUND
               ),
         ),
       );
@@ -79,14 +79,16 @@ void main() {
       Directory(path2).createSync(recursive: true);
 
       expect(
-        () => PosixFileSystem().rename(path1, path2),
+        () => fileSystem.rename(path1, path2),
         throwsA(
           isA<FileSystemException>()
               .having((e) => e.message, 'message', 'rename failed')
               .having(
                 (e) => e.osError?.errorCode,
                 'errorCode',
-                21, // EISDIR
+                Platform.isWindows
+                    ? 5 // ERROR_ACCESS_DENIED
+                    : 21, // EISDIR
               ),
         ),
       );
diff --git a/pkgs/io_file/test/test_utils.dart b/pkgs/io_file/test/test_utils.dart
@@ -0,0 +1,9 @@
+// Copyright (c) 2025, the Dart project authors.  Please see the AUTHORS file
+// for details. All rights reserved. Use of this source code is governed by a
+// BSD-style license that can be found in the LICENSE file.
+
+import 'dart:io';
+
+String createTemp(String testName) =>
+    Directory.systemTemp.createTempSync('move').absolute.path;
+void deleteTemp(String path) => Directory(path).deleteSync(recursive: true);
