'User-Agent' Header Generation & More #1294

JaffaKetchup · 2022-06-29T17:35:39Z

Fixes #1292. Includes breaking changes. Will require significant documentation changes.

This PR's main aim is to add a userAgentPackageName parameter to TileLayerOptions, which can be automatically passed to TileProviders for simplicity - developers do not have to specify tile providers if it is the default provider, just to add this parameter. This must then be combined with other headers correctly, resulting in one single correct 'User-Agent', and any other necessary headers.
There is also a 'lower level' headers implementation to TileProviders, so custom headers can be passed if needed when TileLayerOptions is not in use, for whatever reason.

At the same time, this deprecates NonCachingNetworkTileProvider in favour of NetworkNoRetryTileProvider, as the old name was misleading. Also in this refactoring, TileProviders lost their const ability. This will not affect developers that do not override the default provider, or did not include the const keyword when doing so - other developers will see breaking changes here.

In other news:

Some of the ints have been changed to Durations, as in the TODO list. This is a breaking change.
The _positionedForOverlay method has had it's TODO solved as well, by removing unnecessary multiplication by one. Note that this overlaps with [v2.1.0] Fixes For Polar Projection #1295, and will cause merge conflicts.
Other TODOs have been removed, because they were not getting fixed or they were not worth fixing.
Old deprecations (placeholderImage and attributionBuilder) have been completely removed.

Improved headers implementation Deprecated `NonCachingNetworkTileProvider` in favour of `NetworkNoRetryTileProvider` Updated example pages with changes Improved documentation

JaffaKetchup · 2022-06-29T20:36:59Z

It appears this is working. Interestingly, the original 'User-Agent' is being sent as well. Will this be an issue @pnorman?

pnorman · 2022-06-29T22:49:16Z

A user-agent of Dart/2.17 (dart:io), flutter_map (...) is acceptable. If it's sending multiple of the same header, that would be a problem.

JaffaKetchup · 2022-06-30T06:50:50Z

Well I'm not sure if there are multiple headers being sent or just one. It's showing as an array, which suggests to me that there are two, separate user-agents being sent.

Sorry for the pinging @pnorman, but can you provide some insight as to how these user-agents are checked?

Also note, on debug browser, the User-Agent appears to be the browser's and nothing else.

pnorman · 2022-06-30T07:09:07Z

There is only one user-agent header, so I'm not sure which it'd send if it's an array.

The user-agents are checked on the CDN

ibrierley · 2022-06-30T08:16:54Z

I suspect it probably just concatenates all those in an Array. So the ideal would probably be to overwrite the first element, if another is set, but I suspect that's a bit too far removed from our control.

JaffaKetchup · 2022-06-30T14:39:25Z

@ibrierley I've been researching, and it might be possible. I'll see what I can do in terms of using HttpOverrides.

Fixed usage of `NetworkTileProvider` Fixed deprecation notice invalid symbol reference

JaffaKetchup · 2022-07-01T17:11:39Z

Waiting on dart-lang/sdk#49382 now.

Simplified `_positionedForOverlay` (solved TODO) Improved maintainability Improved documentation

pnorman · 2022-07-01T21:10:05Z

I suspect it probably just concatenates all those in an Array

Well, it sends a string. If the string is a concatenation of all the array elements it would work

JaffaKetchup · 2022-07-01T21:12:58Z

Interesting @pnorman. Would prefer to find a way to remove the old agent, but it's proving difficult.
Are you confirming that it's sending a string and concatenation, or not? I'm struggling to understand, sorry.

pnorman · 2022-07-01T22:13:45Z

Headers are strings. I don't know what it's sending, but it's not sending an array, as there are no types in headers.

JaffaKetchup · 2022-07-01T22:21:08Z

Yeah, I guessed/thought/knew as much. It's probably joining them, thinking about it - most servers/code would be sensible enough to not just throw away data.

I'll keep trying to see if I can get my idea to work, but if it takes too long, I'll give up and just go back to the two headers.

JosefWN · 2022-07-01T23:17:17Z

If you want you can merge my additional fixes in my PR into yours, and I can close my PR. Would avoid the merge conflicts.

JaffaKetchup · 2022-07-02T07:42:21Z

Thanks for the offer, but I'd prefer not to. Would make this PR just very big, and you'd lose some credit in the process. The conflicts shouldn't be too hard to iron out.

pablojimpas · 2022-07-05T17:58:29Z

lib/src/layer/tile_layer/tile_provider/tile_provider.dart

@@ -1,9 +1,19 @@
 import 'package:flutter/widgets.dart';
+import 'package:universal_io/io.dart';


Why is this new dependency needed?

pablojimpas · 2022-07-05T18:03:15Z

pubspec.yaml

@@ -21,6 +21,7 @@ dependencies:
  proj4dart: ^2.0.0
  tuple: ^2.0.0
  vector_math: ^2.1.0
+  universal_io: ^2.0.4


ibrierley · 2022-07-08T07:00:13Z

Hopefully I should get a bit of time at the weekend to check this. Couple of questions in meantime...
There was a note about universal_io earlier and why it's needed...is this an issue for people ?
Are there any other issues on NonCachingNetworkTileProvider being removed...are we fairly happy there's no missing functionality (I know we thought this provider didn't actually stop caching anyway...)

JaffaKetchup · 2022-07-08T07:27:19Z

Wouldn't worry about checking it just yet, it still doesn't 100% work.
In terms of universal_io, I needed it to keep web support when using things from 'dart:_http', which can usually only be accessed through 'dart:io', which doesn't support web.
There is no lost functionality, only renaming. Everything that there was before can still be used, just with a different name and description.

JaffaKetchup · 2022-07-08T19:32:50Z

Just wrote this: dart-lang/sdk#49382 (comment).

…82 (comment)

Added custom `ImageProvider`s Reduced reliance on 'universal_io' library Prepared for review

JaffaKetchup · 2022-07-09T09:10:35Z

@ibrierley This is now ready for review.

I've reduced the reliance on 'universal_io', but it is still necessary to allow the library to compile for the web.

EDIT: Just found a compilation bug for the web, which needs to be fixed.

Seperated tile_provider.dart for web and other plaforms Removed 'universal_io' dependency Updated CHANGELOG

JaffaKetchup · 2022-07-09T10:35:50Z

Ah, finally fixed it. Needed to remove the dependency on 'universal_io' in the end, it was not helping. Unfortunately, this has made the code less organised, as two 'tile_provider.dart' files are needed now.

ibrierley

This all tests fine for me. If anyone relies on things like user_agents in requests somehow I would test this (maybe give a couple of days for anyone to test and scream before merging :D?)

…rOptions`

JaffaKetchup · 2022-07-09T18:35:58Z

OK, I'm happy to wait for a couple of days, just in case anyone has any feedback.

I've prepared the documentation for v2 as well, so that's ready to go on release. Migration instructions have also been provided.

Refactored base `TileProvider` into independent file

JaffaKetchup · 2022-07-11T20:29:07Z

@greensopinion Looking through your plugin for vector tiles specifically, as this brought that to the forefront of my mind as I was editing the docs, you might need to make some changes to your custom tile providers to reflect these changes. Specifically https://docs.fleaflet.dev/usage/layers/tile-layer/tile-providers and https://docs.fleaflet.dev/plugins/making-a-plugin/creating-new-tile-providers#extending-the-base-tileprovider. Happy to help if you can't understand something!

This also applies to anyone else with custom tile providers, but this is quite a major plugin that uses them. If anyone's looking for info about flutter_map_tile_caching v5, the next prerelease will support flutter_map v2.

greensopinion · 2022-07-12T00:08:30Z

@greensopinion Looking through your plugin for vector tiles specifically, as this brought that to the forefront of my mind as I was editing the docs, you might need to make some changes to your custom tile providers to reflect these changes.

@JaffaKetchup Thanks for the heads-up! Great to see more improvements to this library!

The vector_map_tiles plug-in doesn't use the TileProvider class of flutter_map because that one is specific to raster images. Instead, we have VectorTileProvider that is specific to vector tiles.

I've checked out this PR and run the example app. Everything appears to build and run without error. Not sure if you had something else in mind, but from what I can gather no changes are needed in the vector_map_tiles plug-in. Let me know if I'm missing something!

JaffaKetchup · 2022-07-12T05:37:04Z

@greensopinion No problem!

In that case, I think the only thing to do is implement the 'User-Agent' header in your library, specifically in your custom layer options. You can use the implementation here for inspiration, if you need it.

Added userAgentPackageName implementation

fccc71e

Improved headers implementation Deprecated `NonCachingNetworkTileProvider` in favour of `NetworkNoRetryTileProvider` Updated example pages with changes Improved documentation

JaffaKetchup requested a review from ibrierley June 29, 2022 17:35

JaffaKetchup changed the title ~~'User-Agent' Header Generation~~ 'User-Agent' Header Generation & More Jun 29, 2022

Temporarily fixed multiple User-Agent headers

a66dfd6

Fixed usage of `NetworkTileProvider` Fixed deprecation notice invalid symbol reference

JaffaKetchup added 2 commits July 1, 2022 21:46

Removed some old TODOs

ce5d283

Simplified `_positionedForOverlay` (solved TODO) Improved maintainability Improved documentation

Removed old deprecations (placeholderImage and attributionBuilder)

9dcdfde

JaffaKetchup mentioned this pull request Jul 3, 2022

[FEATURE] [v5.0.0] General Questions & Ideas JaffaKetchup/flutter_map_tile_caching#56

Closed

pablojimpas reviewed Jul 5, 2022

View reviewed changes

This was referenced Jul 7, 2022

Expose RetryClient in NetworkTileProvider initialisation #1297

Closed

Proposed fix for unsymmetrical anchored markers disappearing #1291

Merged

Merge branch 'fleaflet:master' into master

e81e7be

JaffaKetchup added 2 commits July 8, 2022 20:35

Atempt to fix HttpOverrides issue - unsuccessful: dart-lang/sdk#493…

d7c7648

…82 (comment)

Fixed issues

ad2adb6

Added custom `ImageProvider`s Reduced reliance on 'universal_io' library Prepared for review

JaffaKetchup marked this pull request as ready for review July 9, 2022 09:09

JaffaKetchup marked this pull request as draft July 9, 2022 09:11

Fixed web platform support

cc61383

Seperated tile_provider.dart for web and other plaforms Removed 'universal_io' dependency Updated CHANGELOG

JaffaKetchup marked this pull request as ready for review July 9, 2022 10:34

JaffaKetchup added 2 commits July 9, 2022 11:51

Fixed 'Refused to set unsafe header' error

f5569d5

Improved in-code documentation

2f5ef97

ibrierley approved these changes Jul 9, 2022

View reviewed changes

Removed deprecated API remenant attributionAlignment from `TileLaye…

b006398

…rOptions`

JaffaKetchup added 2 commits July 10, 2022 10:00

Fix false positive linter warning: see dart-lang/linter#1381

cb81eae

Improved documentation

6402034

Refactored base `TileProvider` into independent file

JaffaKetchup merged commit f55e156 into fleaflet:master Jul 11, 2022

JaffaKetchup mentioned this pull request Jul 11, 2022

[v2.1.0] Fixes For Polar Projection #1295

Merged

TesteurManiak mentioned this pull request Sep 26, 2022

Minor documentation updates #1377

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

'User-Agent' Header Generation & More #1294

'User-Agent' Header Generation & More #1294

JaffaKetchup commented Jun 29, 2022 •

edited

JaffaKetchup commented Jun 29, 2022

pnorman commented Jun 29, 2022

JaffaKetchup commented Jun 30, 2022

pnorman commented Jun 30, 2022

ibrierley commented Jun 30, 2022

JaffaKetchup commented Jun 30, 2022

JaffaKetchup commented Jul 1, 2022

pnorman commented Jul 1, 2022

JaffaKetchup commented Jul 1, 2022

pnorman commented Jul 1, 2022

JaffaKetchup commented Jul 1, 2022

JosefWN commented Jul 1, 2022

JaffaKetchup commented Jul 2, 2022

pablojimpas Jul 5, 2022

pablojimpas Jul 5, 2022

ibrierley commented Jul 8, 2022

JaffaKetchup commented Jul 8, 2022

JaffaKetchup commented Jul 8, 2022

JaffaKetchup commented Jul 9, 2022 •

edited

JaffaKetchup commented Jul 9, 2022

ibrierley left a comment

JaffaKetchup commented Jul 9, 2022

JaffaKetchup commented Jul 11, 2022

greensopinion commented Jul 12, 2022

JaffaKetchup commented Jul 12, 2022 •

edited

		@@ -1,9 +1,19 @@
		import 'package:flutter/widgets.dart';
		import 'package:universal_io/io.dart';

'User-Agent' Header Generation & More #1294

'User-Agent' Header Generation & More #1294

Conversation

JaffaKetchup commented Jun 29, 2022 • edited

JaffaKetchup commented Jun 29, 2022

pnorman commented Jun 29, 2022

JaffaKetchup commented Jun 30, 2022

pnorman commented Jun 30, 2022

ibrierley commented Jun 30, 2022

JaffaKetchup commented Jun 30, 2022

JaffaKetchup commented Jul 1, 2022

pnorman commented Jul 1, 2022

JaffaKetchup commented Jul 1, 2022

pnorman commented Jul 1, 2022

JaffaKetchup commented Jul 1, 2022

JosefWN commented Jul 1, 2022

JaffaKetchup commented Jul 2, 2022

pablojimpas Jul 5, 2022

Choose a reason for hiding this comment

pablojimpas Jul 5, 2022

Choose a reason for hiding this comment

ibrierley commented Jul 8, 2022

JaffaKetchup commented Jul 8, 2022

JaffaKetchup commented Jul 8, 2022

JaffaKetchup commented Jul 9, 2022 • edited

JaffaKetchup commented Jul 9, 2022

ibrierley left a comment

Choose a reason for hiding this comment

JaffaKetchup commented Jul 9, 2022

JaffaKetchup commented Jul 11, 2022

greensopinion commented Jul 12, 2022

JaffaKetchup commented Jul 12, 2022 • edited

JaffaKetchup commented Jun 29, 2022 •

edited

JaffaKetchup commented Jul 9, 2022 •

edited

JaffaKetchup commented Jul 12, 2022 •

edited