halkyon-days/serverpod-offline-sync
Watch
1
0
Fork
You've already forked serverpod-offline-sync
 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

fix: Require unique FK columns to be nullable (#95)

Browse source
This commit is contained in:
Marcelo Mendonça Soares 2026-07-04 21:16:37 -03:00 • committed by GitHub
commit c6a873d04c
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 184 additions and 20 deletions
Download patch file Download diff file Expand all files Collapse all files

91
test/serverpod_offline_sync_test_server/test/integration/schema/schema_test.dart
View file

@ -198,7 +198,7 @@ void main() {
);
test(
'Given a CRDT schema registry with a synced foreign-key-only unique index, '
'Given a CRDT schema registry with a synced nullable foreign-key-only unique index, '
'when syncAndGetSchema is called, '
'then the index is accepted.',
() async {
@ -214,6 +214,42 @@ void main() {
},
);
test(
'Given a CRDT schema registry with a synced required foreign-key-only unique index, '
'when the registry is created, '
'then an error is thrown.',
() async {
final addressDefinition = testSession.db.serializationManager
.getTargetTableDefinitions()
.firstWhere((definition) => definition.name == Address.t.tableName);
final requiredForeignKeyDefinition = addressDefinition.copyWith(
columns: [
for (final column in addressDefinition.columns)
column.name == 'inhabitantId' ? column.copyWith(isNullable: false) : column,
],
);
expect(
() => CrdtSchemaRegistry(
session,
syncTables: [Address.t, Person.t],
tableDefinitions: [requiredForeignKeyDefinition],
),
throwsA(
isA<StateError>().having(
(e) => e.message,
'message',
contains(
'CRDT can only synchronize 1:1 relations when the foreign key column is '
'nullable, but the following foreign keys are non-nullable: '
'"address.inhabitantId". Make the relation optional/nullable.',
),
),
),
);
},
);
test(
'Given a CRDT schema registry with a global unique index containing only foreign keys to synced tables, '
'when syncAndGetSchema is called, '
@ -256,6 +292,59 @@ void main() {
},
);
test(
'Given a CRDT schema registry with a global unique index containing a required foreign key to a synced table, '
'when the registry is created, '
'then an error is thrown.',
() async {
final tableDefinitions = testSession.db.serializationManager
.getTargetTableDefinitions();
final townDefinition = tableDefinitions.firstWhere(
(definition) => definition.name == Town.t.tableName,
);
final addressDefinition = tableDefinitions.firstWhere(
(definition) => definition.name == Address.t.tableName,
);
final indexTemplate = addressDefinition.indexes.singleWhere(
(index) => index.indexName == 'address__inhabitantId__unique_idx',
);
final requiredForeignKeyDefinition = townDefinition.copyWith(
columns: [
for (final column in townDefinition.columns)
column.name == 'cityId' ? column.copyWith(isNullable: false) : column,
],
indexes: [
indexTemplate.copyWith(
indexName: 'town_global_city_mayor_unique_idx',
elements: [
indexTemplate.elements.single.copyWith(definition: 'cityId'),
indexTemplate.elements.single.copyWith(definition: 'mayorId'),
],
),
],
);
expect(
() => CrdtSchemaRegistry(
session,
syncTables: [Town.t, City.t, Person.t],
tableDefinitions: [requiredForeignKeyDefinition],
),
throwsA(
isA<StateError>().having(
(e) => e.message,
'message',
contains(
'CRDT can only synchronize 1:1 relations when the foreign key column is '
'nullable, but the following foreign keys are non-nullable: '
'"town.cityId". Make the relation optional/nullable.',
),
),
),
);
},
);
test(
'Given a CRDT schema registry with a global unique index mixing a foreign key and an application column, '
'when the registry is created, '