dart-lang/sdk
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

[pkg] Introduce dart_data_home

Browse Source 
The directory location depends on the current OS:
 - on Windows:
   - `%LOCALAPPDATA%\Dart\<tool>`
 - on Mac OS:
   - `$HOME/Library/Application Support/Dart/<tool>`
 - on Linux:
   - `$XDG_STATE_HOME/Dart/<tool>` if `$XDG_STATE_HOME` is defined,
      and
   - `$HOME/.local/state/Dart/<tool>` otherwise.

The Dart data home can be overridden with the `DART_DATA_HOME`
environment variable.

This CL does not start using the new location yet.

Bug: https://github.com/dart-lang/sdk/issues/60922
Bug: https://github.com/dart-lang/sdk/issues/41560
Bug: https://github.com/flutter/flutter/issues/59430
Change-Id: I55e0ba610f8665ea3c9f053b36c943b097313046
Cq-Include-Trybots: luci.dart.try:pkg-linux-debug-try,pkg-linux-release-arm64-try,pkg-linux-release-try,pkg-mac-release-arm64-try,pkg-mac-release-try,pkg-win-release-arm64-try,pkg-win-release-try
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/440462
Reviewed-by: Alexander Thomas <athom@google.com>
Auto-Submit: Daco Harkes <dacoharkes@google.com>
Commit-Queue: Daco Harkes <dacoharkes@google.com>
This commit is contained in:
Daco Harkes
2025-07-16 01:05:13 -07:00
committed by Commit Queue
parent 615e1d1e64
commit 2af31661c6
8 changed files with 154 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files
DEPS
+1 -1
View File
@@ -147,7 +147,7 @@ vars = {
"sync_http_rev": "c07f96f89a7eec7e3daac641fa6c587224fcfbaa",
"tar_rev": "5a1ea943e70cdf3fa5e1102cdbb9418bd9b4b81a",
"test_rev": "2be5ca067bdf09e999be2ad760ab8efab854e789",
"tools_rev": "e1b1b4c6f3a25bcd52c201a535f2f3ed66f7ac7e",
"tools_rev": "a4335eb80c55c3944a6af1a5ce20f5694298afdc",
"vector_math_rev": "13f185f7e97d559e003f5ac79201da12f9a01049",
"web_rev": "7e0853d6255d988a5813e680853565b4317da729",
"webdev_rev": "7f376d242709e933fff70610503d0c5c09b2e17e",
pkg/dart_data_home/OWNERS
+5
View File
@@ -0,0 +1,5 @@
set noparent
file:/tools/OWNERS_INTEROP
bkonyi@google.com
# In addition allow global owners.
file:/OWNERS
pkg/dart_data_home/lib/dart_data_home.dart
+13
View File
@@ -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.
/// @docImport 'src/dart_data_home.dart';
/// A package providing [getDartDataHome], a standardized way to access a
/// user-specific data directory for Dart and Flutter tooling, defaulting to
/// OS-conventions and configurable via the `DART_USER_HOME` environment
/// variable.
library;
export 'src/dart_data_home.dart';
pkg/dart_data_home/lib/src/dart_data_home.dart
+50
View File
@@ -0,0 +1,50 @@
// 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 'package:cli_util/cli_util.dart';
/// Get the file system location for storing global data on the users' system.
///
/// The directory follows OS defaults and is not backed up or synchronized
/// across devices by the OS.
///
/// The [packageName] must be a valid Dart package name. Prefer using the name
/// of the package calling this function to avoid name clashes.
///
/// If provided, [environment] is used for environment variables. Otherwise,
/// [Platform.environment] is used.
///
/// The directory location depends on the current [Platform.operatingSystem]:
/// - on **Windows**:
/// - `%LOCALAPPDATA%\Dart\<packageName>`
/// - on **Mac OS**:
/// - `$HOME/Library/Application Support/Dart/<packageName>`
/// - on **Linux**:
/// - `$XDG_STATE_HOME/Dart/<packageName>` if `$XDG_STATE_HOME` is defined,
/// and
/// - `$HOME/.local/state/Dart/<packageName>` otherwise.
///
/// The Dart data home can be overridden with the `DART_DATA_HOME` environment
/// variable.
///
/// The directory won't be created, this method merely returns the recommended
/// location.
String getDartDataHome(String packageName, {Map<String, String>? environment}) {
environment ??= Platform.environment;
final overridden = environment['DART_DATA_HOME'];
final Directory dartDataHome;
if (overridden != null) {
dartDataHome = Directory(overridden);
} else {
final dartBaseDirectories = BaseDirectories(
'Dart',
environment: environment,
);
// Use 'state', not 'data': Don't synchronize across devices.
dartDataHome = Directory(dartBaseDirectories.stateHome);
}
return dartDataHome.uri.resolve('$packageName/').toFilePath();
}
pkg/dart_data_home/pubspec.yaml
+25
View File
@@ -0,0 +1,25 @@
name: dart_data_home
version: 0.1.0-wip
description: >-
A package providing a standardized way to access a user-specific data
directory for Dart and Flutter tooling, defaulting to OS-conventions
and configurable via the `DART_USER_HOME` environment variable.
# This package will be published at some point to be able to use it for Dart and
# Flutter tooling that does not live in the Dart SDK.
environment:
sdk: ^3.8.0
resolution: workspace
dependencies:
cli_util: 0.5.0-wip
# We use 'any' version constraints here as we get our package versions from
# the dart-lang/sdk repo's DEPS file. Note that this is a special case; the
# best practice for packages is to specify their compatible version ranges.
# See also https://dart.dev/tools/pub/dependencies.
dev_dependencies:
path: any
test: any
pkg/dart_data_home/test/dart_data_home_test.dart
+35
View File
@@ -0,0 +1,35 @@
// 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 'package:dart_data_home/dart_data_home.dart';
import 'package:path/path.dart' as p;
import 'package:test/test.dart';
void main() {
test('returns a non-empty string', () {
final myAppHome = getDartDataHome('my_app');
expect(myAppHome, isNotEmpty);
});
test('has an ancestor folder that exists', () {
void expectAncestorExists(String path) {
// We expect that first two segments of the path exist. This is really
// just a dummy check that some part of the path exists.
final ancestorPath = p.joinAll(p.split(path).take(2));
expect(Directory(ancestorPath).existsSync(), isTrue);
}
final myAppHome = getDartDataHome('my_app');
expectAncestorExists(myAppHome);
});
test('empty environment throws exception', () async {
expect(
() => getDartDataHome('some_app', environment: <String, String>{}),
throwsA(isA<Exception>()),
);
});
}
pubspec.yaml
+1
View File
@@ -34,6 +34,7 @@ workspace:
- pkg/dart2native
- pkg/dart2wasm
- pkg/dartdev
- pkg/dart_data_home
- pkg/dart_internal
- pkg/dart_service_protocol_shared
- pkg/dds
tools/bots/test_matrix.json
+24 -13
View File
@@ -170,6 +170,7 @@
"tests/ffi/",
"pkg/_fe_analyzer_shared/",
"pkg/build_integration/",
"pkg/dart_data_home/",
"pkg/dart_internal/",
"pkg/dart2native/",
"pkg/dart2js_tools/",
@@ -310,12 +311,12 @@
},
"vm-aot-mac-(debug|product|release)-(x64|x64c|arm64|arm64c)": {
"options": {
"gen-snapshot-format" : "macho-dylib"
"gen-snapshot-format": "macho-dylib"
}
},
"vm-aot-(linux|mac|win)-(debug|product|release)-(simarm|simarm_x64|simarm64|simriscv32|simriscv64)": {
"options": {
"gen-snapshot-format" : "elf"
"gen-snapshot-format": "elf"
}
},
"vm-asan-(linux|mac|win)-(debug|product|release)-(ia32|x64|arm64|simarm|simarm64|simriscv32|simriscv64)": {},
@@ -330,12 +331,12 @@
},
"vm-aot-lsan-(linux|mac)-(debug|product|release)-(x64|arm64|simarm|simarm64|simriscv32|simriscv64)": {
"options": {
"gen-snapshot-format" : "elf"
"gen-snapshot-format": "elf"
}
},
"vm-aot-msan-linux-(debug|product|release)-(x64|arm64|simarm64|simriscv64)": {
"options": {
"gen-snapshot-format" : "elf"
"gen-snapshot-format": "elf"
}
},
"vm-aot-tsan-(linux|mac)-(debug|product|release)-(x64|arm64|simarm64|simriscv64)": {
@@ -345,27 +346,37 @@
},
"vm-aot-ubsan-(linux|mac|win)-(debug|product|release)-(x64|arm64|simarm|simarm64|simriscv32|simriscv64)": {
"options": {
"gen-snapshot-format" : "elf"
"gen-snapshot-format": "elf"
}
},
"vm-linux-(debug|product|release)-simarm64_arm64": {
"options": {
"vm-options": ["--use_simulator=true"], "use-qemu": true
"vm-options": [
"--use_simulator=true"
],
"use-qemu": true
}
},
"vm-linux-(debug|product|release)-simarm64_arm64-nosim": {
"options": {
"vm-options": ["--use_simulator=false"], "use-qemu": true
"vm-options": [
"--use_simulator=false"
],
"use-qemu": true
}
},
"vm-mac-(debug|product|release)-simarm64_arm64": {
"options": {
"vm-options": ["--use_simulator=true"]
"vm-options": [
"--use_simulator=true"
]
}
},
"vm-mac-(debug|product|release)-simarm64_arm64-nosim": {
"options": {
"vm-options": ["--use_simulator=false"]
"vm-options": [
"--use_simulator=false"
]
}
},
"dart2js-(linux|win)-chrome": {
@@ -501,12 +512,12 @@
"vm-aot-android-(debug|product|release)-arm_x64": {
"options": {
"builder-tag": "crossword",
"gen-snapshot-format" : "elf"
"gen-snapshot-format": "elf"
}
},
"vm-aot-android-(debug|product|release)-(ia32|x64|x64c|arm|arm64|arm64c|riscv64)": {
"options": {
"gen-snapshot-format" : "elf"
"gen-snapshot-format": "elf"
}
},
"vm-aot-dwarf-linux-(debug|release|product)-x64": {
@@ -515,7 +526,7 @@
"vm-options": [
"--dwarf_stack_traces"
],
"gen-snapshot-format" : "elf"
"gen-snapshot-format": "elf"
}
},
"vm-aot-obfuscate-linux-(debug|release|product)-x64": {
@@ -2667,7 +2678,7 @@
},
{
"name": "dart2wasm unit tests",
"script": "out/ReleaseX64/dart-sdk/bin/dart",
"script": "out/ReleaseX64/dart-sdk/bin/dart",
"testRunner": true,
"arguments": [
"pkg/dart2wasm/test/dry_run/dry_run_test.dart",