Framework7 Ajax request caching ignoring query‑string variations

Direct Answers

No global cacheKey configuration exists. You must supply a cacheKey function in the options object of each app.request.get (or app.request.post, etc.) call. There is no app.request.cacheKey or similar app-level setting.

Query strings are already part of the default cache key. The built-in key is the full request URL including the query string, so /api/users?page=1 and /api/users?page=2 are cached separately without any extra code. There is no built-in option to fold specific request or response headers into the key; header-aware caching requires a per-request cacheKey function.

Why This Matters

Framework7’s request cache is an in-memory Map keyed by the resolved cacheKey string. The default resolver simply uses the final URL (base + query string). Because the key is computed before the request fires, a custom cacheKey function receives only the request options—it cannot read response headers such as ETag or Last-Modified.

Consistent Per-Request Strategy

To avoid repeating a custom key function across the codebase, create a helper that returns a pre-configured options object:

function cachedRequestOptions(overrides = {}) {
  return {
    cache: true,           // or a TTL in ms, e.g. 5 * 60 * 1000
    cacheKey: (opts) => {
      // Example: include a custom header value if present
      const headerPart = opts.headers?.['X-Cache-Version'] ?? '';
      return `${opts.url}::${headerPart}`;
    },
    ...overrides
  };
}

// Usage
app.request.get('/api/items', cachedRequestOptions({ headers: { 'X-Cache-Version': 'v2' } }));
app.request.get('/api/items?page=2', cachedRequestOptions()); // different URL → different key automatically

Spread the helper’s return value into each call. This keeps the key logic centralized while respecting Framework7’s per-request design.

Verification Steps

1. Open the Framework7 docs for your version (v7 or v8) under “Request / Ajax → Caching” and confirm the cacheKey parameter signature.
2. In browser DevTools, set a breakpoint inside your cacheKey function to verify it is invoked per request and receives the expected options object.
3. After a few requests, inspect app.request.cache (a Map) in the console to see the actual keys stored.
4. Fire two requests that differ only in query string (e.g., /api/test?id=1 and /api/test?id=2) without a custom cacheKey; confirm they create two distinct cache entries.

One Diagnostic Detail

Are you targeting Framework 7 or Framework 8? The caching API has not changed between these major versions, but confirming the exact version lets me point you to the correct documentation section if you need to verify the cacheKey signature yourself.