feat: Add network assets package. #2314

erickzanardo · 2023-02-02T16:16:35Z

Description

Adds some documentation and a package that can be used to fetch assets from the network.

Checklist

I have followed the Contributor Guide when preparing my PR.
I have updated/added tests for ALL new/updated/fixed functionality.
I have updated/added relevant documentation in docs and added dartdoc comments with ///.
I have updated/added relevant examples in examples or docs.

Breaking Change?

Yes, this PR is a breaking change.
No, this PR is not a breaking change.

Related Issues

packages/flame_network_image/pubspec.yaml

st-pasha

I feel like this could be a great package for fetching files from the Internet and then caching them locally -- regardless of the type of the file. Currently it focuses on images, but what about audio files, fire atlas bundles, tiled levels, yarn scripts, custom json, etc?

The task of converting a file into an Image is quite trivial -- and we can add a helper function fromBytes into the core Flame Images class:

Future<Image> fromBytes(String key, Uint8List bytes) {
    return (_assets[key] ??= _ImageAsset.future(decodeImageFromList(bytes)))
        .retrieveAsync();
  }

doc/flame/rendering/images.md

packages/flame_network_image/example/analysis_options.yaml

packages/flame_network_image/lib/src/flame_network_image.dart

erickzanardo · 2023-02-03T16:28:53Z

I feel like this could be a great package for fetching files from the Internet and then caching them locally -- regardless of the type of the file. Currently it focuses on images, but what about audio files, fire atlas bundles, tiled levels, yarn scripts, custom json, etc?

The task of converting a file into an Image is quite trivial -- and we can add a helper function fromBytes into the core Flame Images class:
Future<Image> fromBytes(String key, Uint8List bytes) {
    return (_assets[key] ??= _ImageAsset.future(decodeImageFromList(bytes)))
        .retrieveAsync();
  }

That is a good idea tbh, I don't think we need to add a fromBytes helper on Flame since the decodeImageFromList is just simple call :)

How should we call this then? flame_network_assets?

st-pasha · 2023-02-03T18:06:02Z

How should we call this then? flame_network_assets?

Some more alternatives: flame_network_cache, flame_http_cache.

packages/flame_network_image/LICENSE

doc/flame/rendering/images.md

packages/flame_networks_assets/.gitignore

packages/flame_networks_assets/example/.gitignore

packages/flame_networks_assets/lib/src/flame_network_assets.dart

st-pasha · 2023-02-22T04:38:20Z

packages/flame_networks_assets/lib/src/flame_network_assets.dart

+ (
+ String url, {
+ Map<String, String>? headers,
+ }) =>
+ http.get(Uri.parse(url), headers: headers).then((response) {
+ return FlameAssetResponse(
+ statusCode: response.statusCode,
+ bytes: response.bodyBytes,
+ );
+ });


This could be a statue method instead of a function defined inline.

Not sure what you mean about statue method

st-pasha · 2023-02-22T04:54:17Z

packages/flame_networks_assets/lib/src/flame_network_assets.dart

+ /// Flag indicating if files will be cached in the local storage.
+ final bool cacheInStorage;
+
+ final bool _isWeb;


Why can't we use kIsWeb instead?

It is used actually, if you look on the constructor, it is the default value for this attribute.

I wrapped it in this attribute to make it easier to mock on tests.

packages/flame_networks_assets/lib/src/flame_network_assets.dart

packages/flame_networks_assets/CHANGELOG.md

packages/flame_network_assets/CHANGELOG.md

spydon

Lookin' good! Mostly just grammar stuff.

spydon · 2023-03-07T09:39:43Z

.github/.cspell/flame_dictionary.txt

@@ -33,3 +33,4 @@ yarnspinner
 рушниці
 рушниць
 рушниця
+unawaited


I guess this should go in the gamedev_dictionary.txt?

doc/bridge_packages/bridge_packages.md

doc/bridge_packages/flame_network_assets/flame_network_assets.md

packages/flame_network_assets/lib/src/flame_network_assets.dart

packages/flame_network_assets/pubspec.yaml

doc/bridge_packages/flame_network_assets/flame_network_assets.md

Co-authored-by: Lukas Klingsbo <me@lukas.fyi>

spydon

Lgtm!

luanpotter · 2023-03-18T20:19:22Z

packages/flame_network_assets/pubspec.yaml

@@ -0,0 +1,27 @@
+name: flame_network_assets
+description: Network assets support for Flame.


nit: this will trigger the "package description too short" pub penalty. I think the min is 60 characters. not endorsing unnecessary verbosity but losing points is also bad

luanpotter · 2023-03-18T20:23:03Z

packages/flame_network_assets/CHANGELOG.md

do we need an empty file at all?

luanpotter · 2023-03-18T20:23:54Z

packages/flame_network_assets/README.md

+ <img src="https://github.com/flame-engine/flame_network_image/workflows/Lint/badge.svg?branch=master&event=push" alt="Test" />
+ <a title="Discord" href="https://discord.gg/pxrBmy4" ><img src="https://img.shields.io/discord/509714518008528896.svg" /></a>


why not the 4 standard badges? (I know the package hasnt been released yet if you add as soon as it is it will work)

luanpotter · 2023-03-18T20:24:52Z

packages/flame_network_assets/example/pubspec.yaml

+ sdk: flutter
+
+dev_dependencies:
+ flame_lint: ^0.1.3


use 0.2.0 ?

luanpotter · 2023-03-18T20:26:09Z

doc/bridge_packages/flame_network_assets/flame_network_assets.md

@@ -0,0 +1,35 @@
+# FlameNetworkAssets
+
+`FlameNetworkAssets` is a bridge package focused on providing a solution to fetch, and cache assets


Suggested change

`FlameNetworkAssets` is a bridge package focused on providing a solution to fetch, and cache assets

`FlameNetworkAssets` is a bridge package focused on providing a solution to fetch and cache assets

luanpotter · 2023-03-18T20:26:32Z

doc/bridge_packages/flame_network_assets/flame_network_assets.md

+By default, the package relies on the `http` package to make http requests, and `path_provider`
+to get the place to store the local cache, to use a different approach for those, use the
+optional arguments in the constructor.


Suggested change

By default, the package relies on the `http` package to make http requests, and `path_provider`

to get the place to store the local cache, to use a different approach for those, use the

optional arguments in the constructor.

By default, the package relies on the `http` package to make http requests, and `path_provider`

to get the place to store the local cache; to use a different approach for those, use the

optional arguments in the constructor.

luanpotter · 2023-03-18T20:27:50Z

doc/flame/rendering/images.md

+```{note}
+Check [`flame_network_assets`](https://pub.dev/packages/flame_network_assets)
+for a ready to use network assets solution that provides a built in cache.
+```


we could probably be even more persuasive about using the flame_network_assets, and frame importing http "by hand" as an alternative

luanpotter · 2023-03-18T20:30:44Z

packages/flame_network_assets/lib/src/flame_network_assets.dart

+ /// Flag indicating if files will be cached in the local storage.
+ final bool cacheInStorage;
+
+ final bool _isWeb;


can we just set the default value of cacheInStorage to be kIsWeb instead of having two flags?

luanpotter · 2023-03-18T20:32:10Z

packages/flame_network_assets/lib/src/flame_network_assets.dart

+ }
+
+ final response = await _get(url, headers: headers);
+ if (response.statusCode >= 200 && response.statusCode < 400) {


nit: invert the if for an early-exit

erickzanardo added 8 commits January 26, 2023 08:52

feat: adding flame network image package

00c582a

feat: adding implementation

6309175

adding example

153054e

removing widget test

4d43652

improving tests

70b449d

test and docs

1d4737c

Merge branch 'main' into erick.flame-network-image

84c8bf7

some fixes

ce5a39d

Hwan-seok reviewed Feb 2, 2023

View reviewed changes

packages/flame_network_image/pubspec.yaml Outdated Show resolved Hide resolved

st-pasha reviewed Feb 2, 2023

View reviewed changes

doc/flame/rendering/images.md Outdated Show resolved Hide resolved

packages/flame_network_image/example/analysis_options.yaml Outdated Show resolved Hide resolved

packages/flame_network_image/lib/src/flame_network_image.dart Outdated Show resolved Hide resolved

st-pasha reviewed Feb 4, 2023

View reviewed changes

packages/flame_network_image/LICENSE Outdated Show resolved Hide resolved

erickzanardo added 6 commits February 21, 2023 19:00

Merge branch 'main' into erick.flame-network-image

aacba5c

feat: package repurpose to be able to load any kind of assets

9fabebb

fix md lint

e29a41d

fix md lint

42b218d

fix dev dep

94e2194

updting LICENSE

8e6880c

st-pasha reviewed Feb 22, 2023

View reviewed changes

luanpotter reviewed Mar 1, 2023

View reviewed changes

packages/flame_networks_assets/CHANGELOG.md Outdated Show resolved Hide resolved

erickzanardo changed the title ~~feat: Add network image package.~~ feat: Add network assets package. Mar 6, 2023

erickzanardo added 5 commits March 6, 2023 08:55

pr suggestions

fedce82

removing example folder

15b7775

md fix

5feaa43

Merge branch 'main' into erick.flame-network-image

5228961

fix spell

18323db

erickzanardo requested review from spydon, luanpotter and st-pasha March 6, 2023 12:15

erickzanardo requested a review from Hwan-seok March 6, 2023 12:15

erickzanardo commented Mar 6, 2023

View reviewed changes

packages/flame_network_assets/CHANGELOG.md Outdated Show resolved Hide resolved

Update packages/flame_network_assets/CHANGELOG.md

420dec7

spydon reviewed Mar 7, 2023

View reviewed changes

st-pasha approved these changes Mar 12, 2023

View reviewed changes

doc/bridge_packages/flame_network_assets/flame_network_assets.md Show resolved Hide resolved

erickzanardo and others added 4 commits March 18, 2023 16:02

pr suggestions

d114c20

Apply suggestions from code review

97540df

Co-authored-by: Lukas Klingsbo <me@lukas.fyi>

Update packages/flame_network_assets/README.md

7c69cd9

pr

c2d4cee

erickzanardo requested review from spydon and Hwan-seok and removed request for Hwan-seok March 18, 2023 19:11

spydon approved these changes Mar 18, 2023

View reviewed changes

Merge branch 'main' into erick.flame-network-image

aa2030f

erickzanardo enabled auto-merge (squash) March 18, 2023 20:04

erickzanardo merged commit 61d6965 into main Mar 18, 2023

erickzanardo deleted the erick.flame-network-image branch March 18, 2023 20:12

luanpotter reviewed Mar 18, 2023

View reviewed changes

packages/flame_network_assets/CHANGELOG.md

Copy link

Member

luanpotter Mar 18, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

do we need an empty file at all?

luanpotter reviewed Mar 18, 2023

View reviewed changes

packages/flame_network_assets/example/pubspec.yaml

sdk: flutter

dev_dependencies:

flame_lint: ^0.1.3

Copy link

Member

luanpotter Mar 18, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

use 0.2.0 ?

luanpotter reviewed Mar 18, 2023

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Add network assets package. #2314

feat: Add network assets package. #2314

erickzanardo commented Feb 2, 2023 •

edited

Loading

st-pasha left a comment

erickzanardo commented Feb 3, 2023

st-pasha commented Feb 3, 2023

st-pasha Feb 22, 2023

erickzanardo Mar 6, 2023

st-pasha Feb 22, 2023

erickzanardo Mar 6, 2023

spydon left a comment

spydon Mar 7, 2023

spydon left a comment

luanpotter Mar 18, 2023

luanpotter Mar 18, 2023

luanpotter Mar 18, 2023

luanpotter Mar 18, 2023

luanpotter Mar 18, 2023

luanpotter Mar 18, 2023

luanpotter Mar 18, 2023

luanpotter Mar 18, 2023

luanpotter Mar 18, 2023

		@@ -0,0 +1,27 @@
		name: flame_network_assets
		description: Network assets support for Flame.

		<img src="https://github.com/flame-engine/flame_network_image/workflows/Lint/badge.svg?branch=master&event=push" alt="Test" />
		<a title="Discord" href="https://discord.gg/pxrBmy4" ><img src="https://img.shields.io/discord/509714518008528896.svg" /></a>

		@@ -0,0 +1,35 @@
		# FlameNetworkAssets

		`FlameNetworkAssets` is a bridge package focused on providing a solution to fetch, and cache assets

feat: Add network assets package. #2314

feat: Add network assets package. #2314

Conversation

erickzanardo commented Feb 2, 2023 • edited Loading

Description

Checklist

Breaking Change?

Related Issues

st-pasha left a comment

Choose a reason for hiding this comment

erickzanardo commented Feb 3, 2023

st-pasha commented Feb 3, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

spydon left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

spydon left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

erickzanardo commented Feb 2, 2023 •

edited

Loading