[FEATURE] Tiles counter

[readyiman]

Package

flutter_map_cache

Feature Description

Counter for how many used tiles was downloaded and cached on a load.

Feature importance

(1) would be nice to have

[josxha]

Hi @readyiman, could you specify what you mean by "on a load"?

[readyiman]

Hi @readyiman, could you specify what you mean by "on a load"?

It's just a map loads. It's actually a term that Google Maps Service introduce as a cost to use their map. I just want to compare it. In here, I guess it means one object lifecycle (Flutter Map), or just count for any tiles load for each source (network and cached) will be good.

[josxha]

I think this is out of scope for the flutter_map_cache package but you can check this number yourself. Just check how many entities are in stored in your cache store.

[readyiman]

I feel just counting tiles is not enough.

So I make dio interceptors for this (with deepseek help).

import 'package:dio/dio.dart';

class FlutterMapCacheCounter {
  int _cacheHits = 0;
  int _cacheMisses = 0;
  int _totalRequests = 0;

  int get cacheHits => _cacheHits;
  int get cacheMisses => _cacheMisses;
  int get totalRequests => _totalRequests;

  Interceptor get interceptor => InterceptorsWrapper(
        onRequest: (options, handler) {
          _totalRequests++;
          handler.next(options);
        },
        onResponse: (response, handler) {
          // log('response extra: ${response.extra}');
          if (response.extra['@cache_key@'] != null) {
            _cacheHits++;
          } else {
            _cacheMisses++;
          }
          handler.next(response);
        },
      );

  @override
  String toString() =>
      'flutterMapCache(hits: $_cacheHits, misses: $_cacheMisses, 
      requests: $_totalRequests)';
}

import 'package:dio_http_cache_lts/dio_http_cache_lts.dart';

final flutterMapCacheManager = DioCacheManager(CacheConfig());
final flutterMapCacheCounter = FlutterMapCacheCounter();

...
      CachedTileProvider(
          store: HiveCacheStore(
           ...
          ),
          interceptors: [
            flutterMapCacheCounter.interceptor,
            flutterMapCacheManager.interceptor,
          ],
        ),
...

Print
flutterMapCache(hits: 204, misses: 0, requests: 265)
response extra: {@cache_key@: 3151dfd4-ffb5-521d-b051-f20b5103859a, @fromNetwork@: false}

This works for me.

Btw some questions,

• Does @cache_key@ has const?
• What is @fromNetwork@ used for? I mean it always from cache right?