Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Submit feedback
Sign in
Toggle navigation
F
Front-End
Project
Project
Details
Activity
Releases
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
0
Issues
0
List
Board
Labels
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Charts
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
abdullh.alsoleman
Front-End
Commits
83bdde2b
Unverified
Commit
83bdde2b
authored
Jan 29, 2024
by
Andrew Kolos
Committed by
GitHub
Jan 29, 2024
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Catch file system exceptions when trying to parse user-provided asset file paths (#142214)
Fixes #141211
parent
38879dae
Changes
3
Expand all
Hide whitespace changes
Inline
Side-by-side
Showing
3 changed files
with
351 additions
and
202 deletions
+351
-202
asset.dart
packages/flutter_tools/lib/src/asset.dart
+16
-8
asset_bundle_flavors_test.dart
...r_tools/test/general.shard/asset_bundle_flavors_test.dart
+249
-0
asset_bundle_test.dart
...s/flutter_tools/test/general.shard/asset_bundle_test.dart
+86
-194
No files found.
packages/flutter_tools/lib/src/asset.dart
View file @
83bdde2b
...
@@ -958,8 +958,8 @@ class ManifestAssetBundle implements AssetBundle {
...
@@ -958,8 +958,8 @@ class ManifestAssetBundle implements AssetBundle {
}
on
UnsupportedError
catch
(
e
)
{
}
on
UnsupportedError
catch
(
e
)
{
throwToolExit
(
throwToolExit
(
'Unable to search for asset files in directory path "
${assetUri.path}
". '
'Unable to search for asset files in directory path "
${assetUri.path}
". '
'Please ensure that this
is valid URI that points to a directory
'
'Please ensure that this
entry in pubspec.yaml is a valid file path.
\n
'
'
that is available on the local file system.
\n
Error details:
\n
$e
'
);
'Error details:
\n
$e
'
);
}
}
if
(!
_fileSystem
.
directory
(
directoryPath
).
existsSync
())
{
if
(!
_fileSystem
.
directory
(
directoryPath
).
existsSync
())
{
...
@@ -1296,17 +1296,25 @@ class _AssetDirectoryCache {
...
@@ -1296,17 +1296,25 @@ class _AssetDirectoryCache {
final
Map
<
String
,
List
<
File
>>
_variantsPerFolder
=
<
String
,
List
<
File
>>{};
final
Map
<
String
,
List
<
File
>>
_variantsPerFolder
=
<
String
,
List
<
File
>>{};
List
<
String
>
variantsFor
(
String
assetPath
)
{
List
<
String
>
variantsFor
(
String
assetPath
)
{
final
String
directory
=
_fileSystem
.
path
.
dirname
(
assetPath
);
final
String
directory
Name
=
_fileSystem
.
path
.
dirname
(
assetPath
);
if
(!
_fileSystem
.
directory
(
directory
).
existsSync
())
{
try
{
return
const
<
String
>[];
if
(!
_fileSystem
.
directory
(
directoryName
).
existsSync
())
{
return
const
<
String
>[];
}
}
on
FileSystemException
catch
(
e
)
{
throwToolExit
(
'Unable to check the existence of asset file "
$assetPath
". '
'Ensure that the asset file is declared as a valid local file system path.
\n
'
'Details:
$e
'
,
);
}
}
if
(
_cache
.
containsKey
(
assetPath
))
{
if
(
_cache
.
containsKey
(
assetPath
))
{
return
_cache
[
assetPath
]!;
return
_cache
[
assetPath
]!;
}
}
if
(!
_variantsPerFolder
.
containsKey
(
directory
))
{
if
(!
_variantsPerFolder
.
containsKey
(
directory
Name
))
{
_variantsPerFolder
[
directory
]
=
_fileSystem
.
directory
(
directory
)
_variantsPerFolder
[
directory
Name
]
=
_fileSystem
.
directory
(
directoryName
)
.
listSync
()
.
listSync
()
.
whereType
<
Directory
>()
.
whereType
<
Directory
>()
.
where
((
Directory
dir
)
=>
_assetVariantDirectoryRegExp
.
hasMatch
(
dir
.
basename
))
.
where
((
Directory
dir
)
=>
_assetVariantDirectoryRegExp
.
hasMatch
(
dir
.
basename
))
...
@@ -1315,7 +1323,7 @@ class _AssetDirectoryCache {
...
@@ -1315,7 +1323,7 @@ class _AssetDirectoryCache {
.
toList
();
.
toList
();
}
}
final
File
assetFile
=
_fileSystem
.
file
(
assetPath
);
final
File
assetFile
=
_fileSystem
.
file
(
assetPath
);
final
List
<
File
>
potentialVariants
=
_variantsPerFolder
[
directory
]!;
final
List
<
File
>
potentialVariants
=
_variantsPerFolder
[
directory
Name
]!;
final
String
basename
=
assetFile
.
basename
;
final
String
basename
=
assetFile
.
basename
;
return
_cache
[
assetPath
]
=
<
String
>[
return
_cache
[
assetPath
]
=
<
String
>[
// It's possible that the user specifies only explicit variants (e.g. .../1x/asset.png),
// It's possible that the user specifies only explicit variants (e.g. .../1x/asset.png),
...
...
packages/flutter_tools/test/general.shard/asset_bundle_flavors_test.dart
0 → 100644
View file @
83bdde2b
// Copyright 2014 The Flutter Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
import
'package:file/memory.dart'
;
import
'package:flutter_tools/src/asset.dart'
;
import
'package:flutter_tools/src/base/file_system.dart'
;
import
'package:flutter_tools/src/base/logger.dart'
;
import
'package:flutter_tools/src/base/platform.dart'
;
import
'package:flutter_tools/src/base/user_messages.dart'
;
import
'package:flutter_tools/src/cache.dart'
;
import
'package:flutter_tools/src/project.dart'
;
import
'../src/common.dart'
;
void
main
(
)
{
Future
<
ManifestAssetBundle
>
buildBundleWithFlavor
(
String
?
flavor
,
{
required
Logger
logger
,
required
FileSystem
fileSystem
,
required
Platform
platform
,
})
async
{
final
ManifestAssetBundle
bundle
=
ManifestAssetBundle
(
logger:
logger
,
fileSystem:
fileSystem
,
platform:
platform
,
flutterRoot:
Cache
.
defaultFlutterRoot
(
platform:
platform
,
fileSystem:
fileSystem
,
userMessages:
UserMessages
(),
),
splitDeferredAssets:
true
,
);
await
bundle
.
build
(
packagesPath:
'.packages'
,
flutterProject:
FlutterProject
.
fromDirectoryTest
(
fileSystem
.
currentDirectory
),
flavor:
flavor
,
);
return
bundle
;
}
testWithoutContext
(
'correctly bundles assets given a simple asset manifest with flavors'
,
()
async
{
final
MemoryFileSystem
fileSystem
=
MemoryFileSystem
();
fileSystem
.
currentDirectory
=
fileSystem
.
systemTempDirectory
.
createTempSync
(
'flutter_asset_bundle_test.'
);
final
BufferLogger
logger
=
BufferLogger
.
test
();
final
FakePlatform
platform
=
FakePlatform
();
fileSystem
.
file
(
'.packages'
).
createSync
();
fileSystem
.
file
(
fileSystem
.
path
.
join
(
'assets'
,
'common'
,
'image.png'
)).
createSync
(
recursive:
true
);
fileSystem
.
file
(
fileSystem
.
path
.
join
(
'assets'
,
'vanilla'
,
'ice-cream.png'
)).
createSync
(
recursive:
true
);
fileSystem
.
file
(
fileSystem
.
path
.
join
(
'assets'
,
'strawberry'
,
'ice-cream.png'
)).
createSync
(
recursive:
true
);
fileSystem
.
file
(
fileSystem
.
path
.
join
(
'assets'
,
'orange'
,
'ice-cream.png'
)).
createSync
(
recursive:
true
);
fileSystem
.
file
(
'pubspec.yaml'
)
..
createSync
()
..
writeAsStringSync
(
r''
'
name: example
flutter:
assets:
- assets/common/
- path: assets/vanilla/
flavors:
- vanilla
- path: assets/strawberry/
flavors:
- strawberry
- path: assets/orange/ice-cream.png
flavors:
- orange
'''
);
ManifestAssetBundle
bundle
;
bundle
=
await
buildBundleWithFlavor
(
null
,
logger:
logger
,
fileSystem:
fileSystem
,
platform:
platform
,
);
expect
(
bundle
.
entries
.
keys
,
contains
(
'assets/common/image.png'
));
expect
(
bundle
.
entries
.
keys
,
isNot
(
contains
(
'assets/vanilla/ice-cream.png'
)));
expect
(
bundle
.
entries
.
keys
,
isNot
(
contains
(
'assets/strawberry/ice-cream.png'
)));
expect
(
bundle
.
entries
.
keys
,
isNot
(
contains
(
'assets/orange/ice-cream.png'
)));
bundle
=
await
buildBundleWithFlavor
(
'strawberry'
,
logger:
logger
,
fileSystem:
fileSystem
,
platform:
platform
,
);
expect
(
bundle
.
entries
.
keys
,
contains
(
'assets/common/image.png'
));
expect
(
bundle
.
entries
.
keys
,
isNot
(
contains
(
'assets/vanilla/ice-cream.png'
)));
expect
(
bundle
.
entries
.
keys
,
contains
(
'assets/strawberry/ice-cream.png'
));
expect
(
bundle
.
entries
.
keys
,
isNot
(
contains
(
'assets/orange/ice-cream.png'
)));
bundle
=
await
buildBundleWithFlavor
(
'orange'
,
logger:
logger
,
fileSystem:
fileSystem
,
platform:
platform
,
);
expect
(
bundle
.
entries
.
keys
,
contains
(
'assets/common/image.png'
));
expect
(
bundle
.
entries
.
keys
,
isNot
(
contains
(
'assets/vanilla/ice-cream.png'
)));
expect
(
bundle
.
entries
.
keys
,
isNot
(
contains
(
'assets/strawberry/ice-cream.png'
)));
expect
(
bundle
.
entries
.
keys
,
contains
(
'assets/orange/ice-cream.png'
));
});
testWithoutContext
(
'throws a tool exit when a non-flavored folder contains a flavored asset'
,
()
async
{
final
MemoryFileSystem
fileSystem
=
MemoryFileSystem
();
fileSystem
.
currentDirectory
=
fileSystem
.
systemTempDirectory
.
createTempSync
(
'flutter_asset_bundle_test.'
);
final
BufferLogger
logger
=
BufferLogger
.
test
();
final
FakePlatform
platform
=
FakePlatform
();
fileSystem
.
file
(
'.packages'
).
createSync
();
fileSystem
.
file
(
fileSystem
.
path
.
join
(
'assets'
,
'unflavored.png'
)).
createSync
(
recursive:
true
);
fileSystem
.
file
(
fileSystem
.
path
.
join
(
'assets'
,
'vanillaOrange.png'
)).
createSync
(
recursive:
true
);
fileSystem
.
file
(
'pubspec.yaml'
)
..
createSync
()
..
writeAsStringSync
(
r''
'
name: example
flutter:
assets:
- assets/
- path: assets/vanillaOrange.png
flavors:
- vanilla
- orange
'''
);
expect
(
buildBundleWithFlavor
(
null
,
logger:
logger
,
fileSystem:
fileSystem
,
platform:
platform
,
),
throwsToolExit
(
message:
'Multiple assets entries include the file '
'"assets/vanillaOrange.png", but they specify different lists of flavors.
\n
'
'An entry with the path "assets/" does not specify any flavors.
\n
'
'An entry with the path "assets/vanillaOrange.png" specifies the flavor(s): "vanilla", "orange".
\n\n
'
'Consider organizing assets with different flavors into different directories.'
),
);
});
testWithoutContext
(
'throws a tool exit when a flavored folder contains a flavorless asset'
,
()
async
{
final
MemoryFileSystem
fileSystem
=
MemoryFileSystem
();
fileSystem
.
currentDirectory
=
fileSystem
.
systemTempDirectory
.
createTempSync
(
'flutter_asset_bundle_test.'
);
final
BufferLogger
logger
=
BufferLogger
.
test
();
final
FakePlatform
platform
=
FakePlatform
();
fileSystem
.
file
(
'.packages'
).
createSync
();
fileSystem
.
file
(
fileSystem
.
path
.
join
(
'vanilla'
,
'vanilla.png'
)).
createSync
(
recursive:
true
);
fileSystem
.
file
(
fileSystem
.
path
.
join
(
'vanilla'
,
'flavorless.png'
)).
createSync
(
recursive:
true
);
fileSystem
.
file
(
'pubspec.yaml'
)
..
createSync
()
..
writeAsStringSync
(
r''
'
name: example
flutter:
assets:
- path: vanilla/
flavors:
- vanilla
- vanilla/flavorless.png
'''
);
expect
(
buildBundleWithFlavor
(
null
,
logger:
logger
,
fileSystem:
fileSystem
,
platform:
platform
,
),
throwsToolExit
(
message:
'Multiple assets entries include the file '
'"vanilla/flavorless.png", but they specify different lists of flavors.
\n
'
'An entry with the path "vanilla/" specifies the flavor(s): "vanilla".
\n
'
'An entry with the path "vanilla/flavorless.png" does not specify any flavors.
\n\n
'
'Consider organizing assets with different flavors into different directories.'
),
);
});
testWithoutContext
(
'tool exits when two file-explicit entries give the same asset different flavors'
,
()
{
final
MemoryFileSystem
fileSystem
=
MemoryFileSystem
();
fileSystem
.
currentDirectory
=
fileSystem
.
systemTempDirectory
.
createTempSync
(
'flutter_asset_bundle_test.'
);
final
BufferLogger
logger
=
BufferLogger
.
test
();
final
FakePlatform
platform
=
FakePlatform
();
fileSystem
.
file
(
'.packages'
).
createSync
();
fileSystem
.
file
(
'orange.png'
).
createSync
(
recursive:
true
);
fileSystem
.
file
(
'pubspec.yaml'
)
..
createSync
()
..
writeAsStringSync
(
r''
'
name: example
flutter:
assets:
- path: orange.png
flavors:
- orange
- path: orange.png
flavors:
- mango
'''
);
expect
(
buildBundleWithFlavor
(
null
,
logger:
logger
,
fileSystem:
fileSystem
,
platform:
platform
,
),
throwsToolExit
(
message:
'Multiple assets entries include the file '
'"orange.png", but they specify different lists of flavors.
\n
'
'An entry with the path "orange.png" specifies the flavor(s): "orange".
\n
'
'An entry with the path "orange.png" specifies the flavor(s): "mango".'
),
);
});
testWithoutContext
(
'throws ToolExit when flavor from file-level declaration has different flavor from containing folder flavor declaration'
,
()
async
{
final
MemoryFileSystem
fileSystem
=
MemoryFileSystem
();
fileSystem
.
currentDirectory
=
fileSystem
.
systemTempDirectory
.
createTempSync
(
'flutter_asset_bundle_test.'
);
final
BufferLogger
logger
=
BufferLogger
.
test
();
final
FakePlatform
platform
=
FakePlatform
();
fileSystem
.
file
(
'.packages'
).
createSync
();
fileSystem
.
file
(
fileSystem
.
path
.
join
(
'vanilla'
,
'actually-strawberry.png'
)).
createSync
(
recursive:
true
);
fileSystem
.
file
(
fileSystem
.
path
.
join
(
'vanilla'
,
'vanilla.png'
)).
createSync
(
recursive:
true
);
fileSystem
.
file
(
'pubspec.yaml'
)
..
createSync
()
..
writeAsStringSync
(
r''
'
name: example
flutter:
assets:
- path: vanilla/
flavors:
- vanilla
- path: vanilla/actually-strawberry.png
flavors:
- strawberry
'''
);
expect
(
buildBundleWithFlavor
(
null
,
logger:
logger
,
fileSystem:
fileSystem
,
platform:
platform
,
),
throwsToolExit
(
message:
'Multiple assets entries include the file '
'"vanilla/actually-strawberry.png", but they specify different lists of flavors.
\n
'
'An entry with the path "vanilla/" specifies the flavor(s): "vanilla".
\n
'
'An entry with the path "vanilla/actually-strawberry.png" '
'specifies the flavor(s): "strawberry".'
),
);
});
}
packages/flutter_tools/test/general.shard/asset_bundle_test.dart
View file @
83bdde2b
This diff is collapsed.
Click to expand it.
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment