Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor(neon_framework): add account column to RequestCache #1741

Merged
merged 1 commit into from
Mar 15, 2024
Merged

refactor(neon_framework): add account column to RequestCache #1741

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
87 changes: 58 additions & 29 deletions packages/neon_framework/lib/src/storage/request_cache.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

import 'package:logging/logging.dart';
import 'package:meta/meta.dart';
import 'package:neon_framework/models.dart';
import 'package:neon_framework/src/platform/platform.dart';
import 'package:neon_framework/src/utils/request_manager.dart';
import 'package:path/path.dart' as p;
Expand All @@ -17,18 +18,18 @@
///
/// Use [getParameters] if you only need to check whether the cache is still
/// valid.
Future<String?> get(String key);
Future<String?> get(Account account, String key);

/// Set's the cached [value] at the given [key].
///
/// If a value is already present it will be updated with the new one.
Future<void> set(String key, String value, CacheParameters? parameters);
Future<void> set(Account account, String key, String value, CacheParameters? parameters);

/// Retrieves the cache parameters for the given [key].
Future<CacheParameters> getParameters(String key);
Future<CacheParameters> getParameters(Account account, String key);

/// Updates the cache [parameters] for a given [key] without modifying the `value`.
Future<void> updateParameters(String key, CacheParameters? parameters);
Future<void> updateParameters(Account account, String key, CacheParameters? parameters);
}

/// Default implementation of the [RequestCache].
Expand Down Expand Up @@ -64,30 +65,32 @@
final cacheDir = await getApplicationCacheDirectory();
database = await openDatabase(
p.join(cacheDir.path, 'cache.db'),
version: 2,
version: 3,
onCreate: onCreate,
onUpgrade: (db, oldVersion, newVersion) async {
final batch = db.batch();
if (oldVersion == 1) {
batch
..execute('ALTER TABLE cache ADD COLUMN etag TEXT')
..execute('ALTER TABLE cache ADD COLUMN expires INTEGER');
}
await batch.commit();
// We can safely drop the table as it only contains cached data.
// Non breaking migrations should not drop the cache. The next
// breaking change should remove all non breaking migrations before it.
await db.transaction((txn) async {
if (oldVersion <= 2) {
await txn.execute('DROP TABLE cache');
await onCreate(txn);

Check warning on line 77 in packages/neon_framework/lib/src/storage/request_cache.dart

View check run for this annotation

Codecov / codecov/patch

packages/neon_framework/lib/src/storage/request_cache.dart#L74-L77 

Added lines #L74 - L77 were not covered by tests
}
});
},
);
}

@visibleForTesting
static Future<void> onCreate(Database db, int version) async {
static Future<void> onCreate(DatabaseExecutor db, [int? version]) async {
await db.execute('''
CREATE TABLE "cache" (
"id" INTEGER UNIQUE,
"key" TEXT UNIQUE,
"value" TEXT,
"account" TEXT NOT NULL,
"key" TEXT NOT NULL,
"value" TEXT NOT NULL,
"etag" TEXT,
"expires" INTEGER,
PRIMARY KEY("id")
PRIMARY KEY("key", "account")
);
''');
}
Expand All @@ -104,10 +107,17 @@
}

@override
Future<String?> get(String key) async {
Future<String?> get(Account account, String key) async {
List<Map<String, Object?>>? result;
try {
result = await _requireDatabase.rawQuery('SELECT value FROM cache WHERE key = ?', [key]);
result = await _requireDatabase.rawQuery(
'''
SELECT value
FROM cache
WHERE account = ? AND key = ?
''',
[account.id, key],
);
} on DatabaseException catch (error, stackTrace) {
_log.severe(
'Error while getting `$key` from cache.',
Expand All @@ -120,25 +130,36 @@
}

@override
Future<void> set(String key, String value, CacheParameters? parameters) async {
Future<void> set(Account account, String key, String value, CacheParameters? parameters) async {
try {
// UPSERT is only available since SQLite 3.24.0 (June 4, 2018).
// Using a manual solution from https://stackoverflow.com/a/38463024
final batch = _requireDatabase.batch()
..update(
'cache',
{
'account': account.id,
'key': key,
'value': value,
'etag': parameters?.etag,
'expires': parameters?.expires?.millisecondsSinceEpoch,
},
where: 'key = ?',
whereArgs: [key],
where: 'account = ? AND key = ?',
whereArgs: [account.id, key],
)
..rawInsert(
'INSERT INTO cache (key, value, etag, expires) SELECT ?, ?, ?, ? WHERE (SELECT changes() = 0)',
[key, value, parameters?.etag, parameters?.expires?.millisecondsSinceEpoch],
'''
INSERT INTO cache (account, key, value, etag, expires)
SELECT ?, ?, ?, ?, ?
WHERE (SELECT changes() = 0)
''',
[
account.id,
key,
value,
parameters?.etag,
parameters?.expires?.millisecondsSinceEpoch,
],
);
await batch.commit(noResult: true);
} on DatabaseException catch (error, stackTrace) {
Expand All @@ -151,10 +172,17 @@
}

@override
Future<CacheParameters> getParameters(String key) async {
Future<CacheParameters> getParameters(Account account, String key) async {
List<Map<String, Object?>>? result;
try {
result = await _requireDatabase.rawQuery('SELECT etag, expires FROM cache WHERE key = ?', [key]);
result = await _requireDatabase.rawQuery(
'''
SELECT etag, expires
FROM cache
WHERE account = ? AND key = ?
''',
[account.id, key],
);
} on DatabaseException catch (error, stackTrace) {
_log.severe(
'Error getting the cache parameters for `$key` from cache.',
Expand All @@ -178,16 +206,17 @@
}

@override
Future<void> updateParameters(String key, CacheParameters? parameters) async {
Future<void> updateParameters(Account account, String key, CacheParameters? parameters) async {
try {
await _requireDatabase.update(
'cache',
{
'account': account.id,
'etag': parameters?.etag,
'expires': parameters?.expires?.millisecondsSinceEpoch,
},
where: 'key = ?',
whereArgs: [key],
where: 'account = ? AND key = ?',
whereArgs: [account.id, key],
);
} on DatabaseException catch (error, stackTrace) {
_log.severe(
Expand Down
15 changes: 7 additions & 8 deletions packages/neon_framework/lib/src/utils/request_manager.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -212,20 +212,18 @@ class RequestManager {
bool disableTimeout = false,
Duration timeLimit = kDefaultTimeout,
}) async {
final key = '${account.id}-$cacheKey';

if (subject.isClosed) {
return;
}
if (!subject.hasValue) {
subject.add(Result.loading());
}

final cachedParameters = await _cache?.getParameters(key);
final cachedParameters = await _cache?.getParameters(account, cacheKey);

if (cachedParameters != null) {
if (cachedParameters.expires != null && !cachedParameters.isExpired) {
final cachedValue = await _cache?.get(key);
final cachedValue = await _cache?.get(account, cacheKey);
if (cachedValue != null) {
if (!subject.isClosed) {
subject.add(Result(unwrap(deserialize(cachedValue)), null, isLoading: false, isCached: true));
Expand Down Expand Up @@ -255,11 +253,12 @@ class RequestManager {
}

if (cacheParameters != null && cacheParameters.etag == cachedParameters.etag) {
final cachedValue = await _cache?.get(key);
final cachedValue = await _cache?.get(account, cacheKey);
if (cachedValue != null) {
unawaited(
_cache?.updateParameters(
key,
account,
cacheKey,
cacheParameters,
),
);
Expand All @@ -272,7 +271,7 @@ class RequestManager {
}
}

final cachedValue = await _cache?.get(key);
final cachedValue = await _cache?.get(account, cacheKey);
if (subject.isClosed) {
return;
}
Expand Down Expand Up @@ -307,7 +306,7 @@ class RequestManager {
cacheParameters = CacheParameters.parseHeaders(rawHeaders);
}

await _cache?.set(key, serialized, cacheParameters);
await _cache?.set(account, cacheKey, serialized, cacheParameters);
break;
} on TimeoutException catch (error, stackTrace) {
_log.info(
Expand Down
27 changes: 16 additions & 11 deletions packages/neon_framework/test/persistence_test.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,44 +3,49 @@

import 'package:built_collection/built_collection.dart';
import 'package:flutter_test/flutter_test.dart';
import 'package:mocktail/mocktail.dart';
import 'package:neon_framework/src/storage/request_cache.dart';
import 'package:neon_framework/src/storage/sqlite_persistence.dart';
import 'package:neon_framework/src/utils/request_manager.dart';
import 'package:neon_framework/testing.dart';
import 'package:sqflite_common_ffi/sqflite_ffi.dart';
import 'package:timezone/timezone.dart' as tz;

void main() {
group('Persistences', () {
test('RequestCache', () async {
final account = MockAccount();
when(() => account.id).thenReturn('clientID');

final cache = DefaultRequestCache();
sqfliteFfiInit();
databaseFactory = databaseFactoryFfi;

expect(() async => cache.get('key'), throwsA(isA<StateError>()));
expect(() async => cache.get(account, 'key'), throwsA(isA<StateError>()));

cache.database = await openDatabase(
inMemoryDatabasePath,
version: 1,
onCreate: DefaultRequestCache.onCreate,
);

dynamic result = await cache.get('key');
dynamic result = await cache.get(account, 'key');
expect(result, isNull);

await cache.set('key', 'value', null);
result = await cache.get('key');
await cache.set(account, 'key', 'value', null);
result = await cache.get(account, 'key');
expect(result, equals('value'));

await cache.set('key', 'upsert', null);
result = await cache.get('key');
await cache.set(account, 'key', 'upsert', null);
result = await cache.get(account, 'key');
expect(result, equals('upsert'));

var parameters = const CacheParameters(etag: null, expires: null);
result = await cache.getParameters('newKey');
result = await cache.getParameters(account, 'newKey');
expect(result, equals(parameters));

await cache.set('key', 'value', parameters);
result = await cache.getParameters('key');
await cache.set(account, 'key', 'value', parameters);
result = await cache.getParameters(account, 'key');
expect(result, equals(parameters));

parameters = CacheParameters(
Expand All @@ -50,8 +55,8 @@ void main() {
tz.TZDateTime.now(tz.UTC).millisecondsSinceEpoch,
),
);
await cache.updateParameters('key', parameters);
result = await cache.getParameters('key');
await cache.updateParameters(account, 'key', parameters);
result = await cache.getParameters(account, 'key');
expect(result, equals(parameters));
});

Expand Down
Loading