Skip to content

Respect upper bound of Flutter constraint in root packages after 3.9 #4595

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions lib/src/language_version.dart
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,9 @@ class LanguageVersion implements Comparable<LanguageVersion> {
bool get forbidsUnknownDescriptionKeys =>
this >= firstVersionForbidingUnknownDescriptionKeys;

bool get respectsFlutterBoundInRoots =>
this >= firstVersionRespectingFlutterBoundInRoots;

/// Minimum language version at which short hosted syntax is supported.
///
/// This allows `hosted` dependencies to be expressed as:
Expand Down Expand Up @@ -112,6 +115,10 @@ class LanguageVersion implements Comparable<LanguageVersion> {
3,
7,
);
static const firstVersionRespectingFlutterBoundInRoots = LanguageVersion(
3,
9,
);

/// Transform language version to string that can be parsed with
/// [LanguageVersion.parse].
Expand Down
3 changes: 3 additions & 0 deletions lib/src/lock_file.dart
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ import 'package:source_span/source_span.dart';
import 'package:yaml/yaml.dart';

import 'io.dart';
import 'language_version.dart';
import 'package_name.dart';
import 'pubspec.dart';
import 'system_cache.dart';
Expand Down Expand Up @@ -149,6 +150,8 @@ class LockFile {
),
'flutter' => SdkConstraint.interpretFlutterSdkConstraint(
originalConstraint,
isRoot: false,
languageVersion: LanguageVersion.defaultLanguageVersion,
),
_ => SdkConstraint(originalConstraint),
};
Expand Down
48 changes: 29 additions & 19 deletions lib/src/pubspec.dart
Original file line number Diff line number Diff line change
Expand Up @@ -225,15 +225,12 @@ environment:
_FileType.pubspec,
);
}
final constraints = {
'dart': SdkConstraint.interpretDartSdkConstraint(
originalDartSdkConstraint,
defaultUpperBoundConstraint:
_includeDefaultSdkConstraint
? _defaultUpperBoundSdkConstraint
: null,
),
};
final dartConstraint = SdkConstraint.interpretDartSdkConstraint(
originalDartSdkConstraint,
defaultUpperBoundConstraint:
_includeDefaultSdkConstraint ? _defaultUpperBoundSdkConstraint : null,
);
final constraints = {'dart': dartConstraint};

if (yaml is YamlMap) {
yaml.nodes.forEach((nameNode, constraintNode) {
Expand All @@ -253,7 +250,11 @@ environment:
);
constraints[name] =
name == 'flutter'
? SdkConstraint.interpretFlutterSdkConstraint(constraint)
? SdkConstraint.interpretFlutterSdkConstraint(
constraint,
isRoot: _containingDescription is ResolvedRootDescription,
languageVersion: dartConstraint.languageVersion,
)
: SdkConstraint(constraint);
});
}
Expand Down Expand Up @@ -816,17 +817,26 @@ class SdkConstraint {
return SdkConstraint(constraint, originalConstraint: originalConstraint);
}

// Flutter constraints get special treatment, as Flutter won't be using
// semantic versioning to mark breaking releases. We simply ignore upper
// bounds.
/// Flutter constraints get special treatment, as Flutter won't be using
/// semantic versioning to mark breaking releases. We simply ignore upper
/// bounds for dependencies.
///
/// After language version
/// [LanguageVersion.firstVersionRespectingFlutterBoundInRoots] for root
/// packages we use the upper bound, allowing app developers to constrain the
/// Flutter version.
factory SdkConstraint.interpretFlutterSdkConstraint(
VersionConstraint constraint,
) {
VersionConstraint constraint, {
required bool isRoot,
required LanguageVersion languageVersion,
}) {
if (constraint is VersionRange) {
return SdkConstraint(
VersionRange(min: constraint.min, includeMin: constraint.includeMin),
originalConstraint: constraint,
);
if (!(isRoot && languageVersion.respectsFlutterBoundInRoots)) {
return SdkConstraint(
VersionRange(min: constraint.min, includeMin: constraint.includeMin),
originalConstraint: constraint,
);
}
}
return SdkConstraint(constraint);
}
Expand Down
109 changes: 102 additions & 7 deletions test/get/flutter_constraint_upper_bound_ignored_test.dart
Original file line number Diff line number Diff line change
Expand Up @@ -9,21 +9,116 @@ import '../descriptor.dart' as d;
import '../test_pub.dart';

void main() {
test('pub get succeeds despite of "invalid" flutter upper bound', () async {
test(
'pub get succeeds despite of "invalid" flutter upper bound in dependency',
() async {
final fakeFlutterRoot = d.dir('fake_flutter_root', [
d.flutterVersion('1.23.0'),
]);
await fakeFlutterRoot.create();

final server = await servePackages();
server.serve(
'foo',
'1.0.0',
pubspec: {
'environment': {'sdk': '^$testVersion', 'flutter': '>=0.5.0 <1.0.0'},
},
);

await d.appDir(dependencies: {'foo': '^1.0.0'}).create();

await pubGet(
exitCode: exit_codes.SUCCESS,
environment: {'FLUTTER_ROOT': fakeFlutterRoot.io.path},
);
},
);

test('pub get ignores the bound of the root package before 3.10', () async {
final fakeFlutterRoot = d.dir('fake_flutter_root', [
d.flutterVersion('1.23.0'),
]);
await fakeFlutterRoot.create();

await d
.appDir(
pubspec: {
'environment': {'sdk': '^3.8.0', 'flutter': '>=0.5.0 <1.0.0'},
},
)
.create();

await pubGet(
environment: {
'FLUTTER_ROOT': fakeFlutterRoot.io.path,
'_PUB_TEST_SDK_VERSION': '3.9.0',
},
);
});

test('pub get respects the bound of the root package after 3.9', () async {
final fakeFlutterRoot = d.dir('fake_flutter_root', [
d.flutterVersion('1.23.0'),
]);
await fakeFlutterRoot.create();

await d
.appDir(
pubspec: {
'environment': {'sdk': '^3.9.0', 'flutter': '>=0.5.0 <1.0.0'},
},
)
.create();

await pubGet(
exitCode: 1,
environment: {
'FLUTTER_ROOT': fakeFlutterRoot.io.path,
'_PUB_TEST_SDK_VERSION': '3.9.0',
},
error: contains(
'Because myapp requires '
'Flutter SDK version >=0.5.0 <1.0.0, version solving failed',
),
);
});

test('pub get respects the bound of a workspace root package', () async {
final fakeFlutterRoot = d.dir('fake_flutter_root', [
d.flutterVersion('1.23.0'),
]);
await fakeFlutterRoot.create();

await d.dir(appPath, [
d.pubspec({
'name': 'myapp',
'environment': {'flutter': '>=0.5.0 <1.0.0'},
}),
d.appPubspec(
extras: {
'environment': {'sdk': '^3.9.0'},
'workspace': ['app'],
},
),
d.dir('app', [
d.libPubspec(
'app',
'1.0.0',
resolutionWorkspace: true,
extras: {
'environment': {'sdk': '^3.9.0', 'flutter': '>=0.5.0 <1.0.0'},
},
),
]),
]).create();

await pubGet(
exitCode: exit_codes.SUCCESS,
environment: {'FLUTTER_ROOT': fakeFlutterRoot.io.path},
exitCode: 1,
environment: {
'_PUB_TEST_SDK_VERSION': '3.9.0',
'FLUTTER_ROOT': fakeFlutterRoot.io.path,
},
error: contains(
'Because app requires '
'Flutter SDK version >=0.5.0 <1.0.0, version solving failed',
),
);
});
}
9 changes: 3 additions & 6 deletions test/pubspec_test.dart
Original file line number Diff line number Diff line change
Expand Up @@ -793,7 +793,7 @@ dependencies:
final pubspec = Pubspec.parse(
'''
environment:
sdk: ">=1.2.3 <2.3.4"
sdk: ">=3.10.3 <3.11.4"
flutter: ^0.1.2
fuchsia: ^5.6.7
''',
Expand All @@ -804,17 +804,14 @@ environment:
pubspec.sdkConstraints,
containsPair(
'dart',
SdkConstraint(VersionConstraint.parse('>=1.2.3 <2.3.4')),
SdkConstraint(VersionConstraint.parse('>=3.10.3 <3.11.4')),
),
);
expect(
pubspec.sdkConstraints,
containsPair(
'flutter',
SdkConstraint(
VersionConstraint.parse('>=0.1.2'),
originalConstraint: VersionConstraint.parse('^0.1.2'),
),
SdkConstraint(VersionConstraint.parse('^0.1.2')),
),
);
expect(
Expand Down