@powersync/service-core 1.24.0 → 1.25.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +17 -0
- package/dist/storage/SourceEntity.d.ts +7 -2
- package/dist/storage/SourceTable.d.ts +24 -1
- package/dist/storage/SourceTable.js +34 -6
- package/dist/storage/SourceTable.js.map +1 -1
- package/dist/storage/SourceTableReconciler.d.ts +83 -0
- package/dist/storage/SourceTableReconciler.js +95 -0
- package/dist/storage/SourceTableReconciler.js.map +1 -0
- package/dist/storage/SyncRulesBucketStorage.d.ts +6 -0
- package/dist/storage/SyncRulesBucketStorage.js.map +1 -1
- package/dist/storage/storage-index.d.ts +1 -0
- package/dist/storage/storage-index.js +1 -0
- package/dist/storage/storage-index.js.map +1 -1
- package/dist/util/utils.d.ts +1 -1
- package/dist/util/utils.js +1 -1
- package/dist/util/utils.js.map +1 -1
- package/package.json +1 -1
- package/src/storage/SourceEntity.ts +6 -2
- package/src/storage/SourceTable.ts +51 -7
- package/src/storage/SourceTableReconciler.ts +188 -0
- package/src/storage/SyncRulesBucketStorage.ts +6 -0
- package/src/storage/storage-index.ts +1 -0
- package/src/util/utils.ts +1 -1
- package/test/src/source-table-reconciler.test.ts +244 -0
- package/tsconfig.tsbuildinfo +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,22 @@
|
|
|
1
1
|
# @powersync/service-core
|
|
2
2
|
|
|
3
|
+
## 1.25.0
|
|
4
|
+
|
|
5
|
+
### Minor Changes
|
|
6
|
+
|
|
7
|
+
- 798d739: Add source-owned `SourceTable` reconciliation.
|
|
8
|
+
|
|
9
|
+
`resolveTables()` now queries all overlapping persisted candidates and passes them to a
|
|
10
|
+
source-provided reconciler that returns compatible and incompatible tables, can return
|
|
11
|
+
modified compatible copies, and supplies values used for potential new records. Storage persists allowlisted
|
|
12
|
+
source metadata differences but never interprets them. MongoDB v1/v3 and PostgreSQL storage were
|
|
13
|
+
refactored to this candidate-first model (PostgreSQL gains a nullable `source_metadata` JSONB column
|
|
14
|
+
via migration).
|
|
15
|
+
|
|
16
|
+
### Patch Changes
|
|
17
|
+
|
|
18
|
+
- 27b56cb: Optimization for generating subkey UUIDs.
|
|
19
|
+
|
|
3
20
|
## 1.24.0
|
|
4
21
|
|
|
5
22
|
### Minor Changes
|
|
@@ -1,4 +1,11 @@
|
|
|
1
1
|
import { SourceTableRef } from '@powersync/service-sync-rules';
|
|
2
|
+
/**
|
|
3
|
+
* Source-specific JSON metadata. Storage does not interpret it. Source-table APIs use null to
|
|
4
|
+
* represent the absence of metadata.
|
|
5
|
+
*/
|
|
6
|
+
export type JsonValue = string | number | boolean | null | JsonValue[] | {
|
|
7
|
+
[key: string]: JsonValue;
|
|
8
|
+
};
|
|
2
9
|
export interface ColumnDescriptor {
|
|
3
10
|
name: string;
|
|
4
11
|
/**
|
|
@@ -17,8 +24,6 @@ export interface SourceEntityDescriptor extends SourceTableRef {
|
|
|
17
24
|
* If specified, this is specifically used to detect renames.
|
|
18
25
|
*/
|
|
19
26
|
objectId: number | string | undefined;
|
|
20
|
-
schema: string;
|
|
21
|
-
name: string;
|
|
22
27
|
/**
|
|
23
28
|
* The columns that are used to uniquely identify a record in the source entity.
|
|
24
29
|
*/
|
|
@@ -1,10 +1,14 @@
|
|
|
1
1
|
import { BucketDataSource, BucketDefinitionId, ParameterIndexId, ParameterIndexLookupCreator, SourceTableRef } from '@powersync/service-sync-rules';
|
|
2
2
|
import { bson } from '../index.js';
|
|
3
|
-
import { ColumnDescriptor } from './SourceEntity.js';
|
|
3
|
+
import { ColumnDescriptor, JsonValue } from './SourceEntity.js';
|
|
4
4
|
/**
|
|
5
5
|
* Format of the id depends on the bucket storage module. It should be consistent within the module.
|
|
6
6
|
*/
|
|
7
7
|
export type SourceTableId = string | bson.ObjectId;
|
|
8
|
+
/**
|
|
9
|
+
* Compare source-table ids without coercing between storage-specific types.
|
|
10
|
+
*/
|
|
11
|
+
export declare function sourceTableIdEquals(left: SourceTableId, right: SourceTableId): boolean;
|
|
8
12
|
export interface SourceTableOptions {
|
|
9
13
|
id: SourceTableId;
|
|
10
14
|
ref: SourceTableRef;
|
|
@@ -15,6 +19,10 @@ export interface SourceTableOptions {
|
|
|
15
19
|
parameterLookupSources: ParameterIndexLookupCreator[];
|
|
16
20
|
bucketDataSourceIds?: Set<BucketDefinitionId>;
|
|
17
21
|
parameterLookupSourceIds?: Set<ParameterIndexId>;
|
|
22
|
+
/**
|
|
23
|
+
* Source-specific metadata. Null when no metadata has been recorded.
|
|
24
|
+
*/
|
|
25
|
+
sourceMetadata?: JsonValue;
|
|
18
26
|
}
|
|
19
27
|
export interface TableSnapshotStatus {
|
|
20
28
|
totalEstimatedCount: number;
|
|
@@ -86,6 +94,9 @@ export declare class SourceTable {
|
|
|
86
94
|
get parameterLookupSources(): ParameterIndexLookupCreator[];
|
|
87
95
|
get bucketDataSourceIds(): Set<string> | undefined;
|
|
88
96
|
get parameterLookupSourceIds(): Set<string> | undefined;
|
|
97
|
+
get sourceMetadata(): string | number | boolean | JsonValue[] | {
|
|
98
|
+
[key: string]: JsonValue;
|
|
99
|
+
} | null;
|
|
89
100
|
/**
|
|
90
101
|
* Sanitized name of the entity in the format of "{schema}.{entity name}".
|
|
91
102
|
* Suitable for safe use in Postgres queries.
|
|
@@ -96,5 +107,17 @@ export declare class SourceTable {
|
|
|
96
107
|
* In-memory clone of the table status.
|
|
97
108
|
*/
|
|
98
109
|
clone(): SourceTable;
|
|
110
|
+
/**
|
|
111
|
+
* Copy this table with different source metadata, preserving its resolved state.
|
|
112
|
+
*/
|
|
113
|
+
withSourceMetadata(sourceMetadata: JsonValue): SourceTable;
|
|
114
|
+
private copyWithSourceMetadata;
|
|
99
115
|
formatSnapshotProgress(): string;
|
|
100
116
|
}
|
|
117
|
+
/**
|
|
118
|
+
* A cloned SourceTable exposed to reconciliation with public fields typed as read-only.
|
|
119
|
+
* `options` is omitted so callers cannot mutate the underlying option bag without an explicit cast.
|
|
120
|
+
*/
|
|
121
|
+
export type SourceTableCandidate = Omit<Readonly<SourceTable>, 'options' | 'withSourceMetadata'> & {
|
|
122
|
+
withSourceMetadata(sourceMetadata: JsonValue): SourceTableCandidate;
|
|
123
|
+
};
|
|
@@ -1,5 +1,14 @@
|
|
|
1
1
|
import { DEFAULT_TAG } from '@powersync/service-sync-rules';
|
|
2
2
|
import * as util from '../util/util-index.js';
|
|
3
|
+
/**
|
|
4
|
+
* Compare source-table ids without coercing between storage-specific types.
|
|
5
|
+
*/
|
|
6
|
+
export function sourceTableIdEquals(left, right) {
|
|
7
|
+
if (typeof left === 'string' || typeof right === 'string') {
|
|
8
|
+
return typeof left === 'string' && typeof right === 'string' && left === right;
|
|
9
|
+
}
|
|
10
|
+
return left.equals(right);
|
|
11
|
+
}
|
|
3
12
|
/**
|
|
4
13
|
* Represents a resolved source table.
|
|
5
14
|
*
|
|
@@ -88,6 +97,9 @@ export class SourceTable {
|
|
|
88
97
|
get parameterLookupSourceIds() {
|
|
89
98
|
return this.options.parameterLookupSourceIds;
|
|
90
99
|
}
|
|
100
|
+
get sourceMetadata() {
|
|
101
|
+
return this.options.sourceMetadata ?? null;
|
|
102
|
+
}
|
|
91
103
|
/**
|
|
92
104
|
* Sanitized name of the entity in the format of "{schema}.{entity name}".
|
|
93
105
|
* Suitable for safe use in Postgres queries.
|
|
@@ -102,22 +114,38 @@ export class SourceTable {
|
|
|
102
114
|
* In-memory clone of the table status.
|
|
103
115
|
*/
|
|
104
116
|
clone() {
|
|
117
|
+
return this.copyWithSourceMetadata(this.sourceMetadata);
|
|
118
|
+
}
|
|
119
|
+
/**
|
|
120
|
+
* Copy this table with different source metadata, preserving its resolved state.
|
|
121
|
+
*/
|
|
122
|
+
withSourceMetadata(sourceMetadata) {
|
|
123
|
+
return this.copyWithSourceMetadata(sourceMetadata);
|
|
124
|
+
}
|
|
125
|
+
copyWithSourceMetadata(sourceMetadata) {
|
|
105
126
|
const copy = new SourceTable({
|
|
106
127
|
id: this.id,
|
|
107
|
-
ref: this.options.ref,
|
|
128
|
+
ref: { ...this.options.ref },
|
|
108
129
|
objectId: this.objectId,
|
|
109
|
-
replicaIdColumns: this.replicaIdColumns,
|
|
130
|
+
replicaIdColumns: this.replicaIdColumns.map((column) => ({ ...column })),
|
|
110
131
|
snapshotComplete: this.snapshotComplete,
|
|
111
|
-
bucketDataSources: this.bucketDataSources,
|
|
112
|
-
parameterLookupSources: this.parameterLookupSources,
|
|
132
|
+
bucketDataSources: [...this.bucketDataSources],
|
|
133
|
+
parameterLookupSources: [...this.parameterLookupSources],
|
|
113
134
|
bucketDataSourceIds: this.bucketDataSourceIds == null ? undefined : new Set(this.bucketDataSourceIds),
|
|
114
|
-
parameterLookupSourceIds: this.parameterLookupSourceIds == null ? undefined : new Set(this.parameterLookupSourceIds)
|
|
135
|
+
parameterLookupSourceIds: this.parameterLookupSourceIds == null ? undefined : new Set(this.parameterLookupSourceIds),
|
|
136
|
+
sourceMetadata: structuredClone(sourceMetadata)
|
|
115
137
|
});
|
|
116
138
|
copy.syncData = this.syncData;
|
|
117
139
|
copy.syncParameters = this.syncParameters;
|
|
118
140
|
copy.syncEvent = this.syncEvent;
|
|
119
141
|
copy.storeCurrentData = this.storeCurrentData;
|
|
120
|
-
copy.snapshotStatus =
|
|
142
|
+
copy.snapshotStatus =
|
|
143
|
+
this.snapshotStatus == null
|
|
144
|
+
? undefined
|
|
145
|
+
: {
|
|
146
|
+
...this.snapshotStatus,
|
|
147
|
+
lastKey: this.snapshotStatus.lastKey?.slice() ?? null
|
|
148
|
+
};
|
|
121
149
|
return copy;
|
|
122
150
|
}
|
|
123
151
|
formatSnapshotProgress() {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"SourceTable.js","sourceRoot":"","sources":["../../src/storage/SourceTable.ts"],"names":[],"mappings":"AAAA,OAAO,EAGL,WAAW,EAIZ,MAAM,+BAA+B,CAAC;AAEvC,OAAO,KAAK,IAAI,MAAM,uBAAuB,CAAC;
|
|
1
|
+
{"version":3,"file":"SourceTable.js","sourceRoot":"","sources":["../../src/storage/SourceTable.ts"],"names":[],"mappings":"AAAA,OAAO,EAGL,WAAW,EAIZ,MAAM,+BAA+B,CAAC;AAEvC,OAAO,KAAK,IAAI,MAAM,uBAAuB,CAAC;AAQ9C;;GAEG;AACH,MAAM,UAAU,mBAAmB,CAAC,IAAmB,EAAE,KAAoB;IAC3E,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC1D,OAAO,OAAO,IAAI,KAAK,QAAQ,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,IAAI,KAAK,KAAK,CAAC;IACjF,CAAC;IACD,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;AAC5B,CAAC;AAwBD;;;;;GAKG;AACH,MAAM,OAAO,WAAW;IAsDM;IArD5B,MAAM,CAAU,WAAW,GAAG,WAAW,CAAC;IAE1C;;;;;;OAMG;IACI,QAAQ,GAAG,IAAI,CAAC;IAEvB;;;;;;OAMG;IACI,cAAc,GAAG,IAAI,CAAC;IAE7B;;;;;;;;OAQG;IACI,SAAS,GAAG,IAAI,CAAC;IAExB;;;;;;;;;;OAUG;IACI,gBAAgB,GAAG,IAAI,CAAC;IAE/B;;;;OAIG;IACI,cAAc,GAAoC,SAAS,CAAC;IAE5D,gBAAgB,CAAU;IAEjC,YAA4B,OAA2B;QAA3B,YAAO,GAAP,OAAO,CAAoB;QACrD,IAAI,CAAC,gBAAgB,GAAG,OAAO,CAAC,gBAAgB,CAAC;IACnD,CAAC;IAED,IAAI,EAAE;QACJ,OAAO,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC;IACzB,CAAC;IAED,IAAI,QAAQ;QACV,OAAO,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC;IAC/B,CAAC;IAED,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC;IACjC,CAAC;IACD,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC;IAC/B,CAAC;IAED,IAAI,GAAG;QACL,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC;IAC1B,CAAC;IAED,IAAI,gBAAgB;QAClB,OAAO,IAAI,CAAC,OAAO,CAAC,gBAAgB,CAAC;IACvC,CAAC;IAED,IAAI,iBAAiB;QACnB,OAAO,IAAI,CAAC,OAAO,CAAC,iBAAiB,CAAC;IACxC,CAAC;IAED,IAAI,sBAAsB;QACxB,OAAO,IAAI,CAAC,OAAO,CAAC,sBAAsB,CAAC;IAC7C,CAAC;IAED,IAAI,mBAAmB;QACrB,OAAO,IAAI,CAAC,OAAO,CAAC,mBAAmB,CAAC;IAC1C,CAAC;IAED,IAAI,wBAAwB;QAC1B,OAAO,IAAI,CAAC,OAAO,CAAC,wBAAwB,CAAC;IAC/C,CAAC;IAED,IAAI,cAAc;QAChB,OAAO,IAAI,CAAC,OAAO,CAAC,cAAc,IAAI,IAAI,CAAC;IAC7C,CAAC;IAED;;;OAGG;IACH,IAAI,aAAa;QACf,OAAO,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACtC,CAAC;IAED,IAAI,OAAO;QACT,OAAO,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAC,cAAc,IAAI,IAAI,CAAC,SAAS,CAAC;IAChE,CAAC;IAED;;OAEG;IACH,KAAK;QACH,OAAO,IAAI,CAAC,sBAAsB,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;IAC1D,CAAC;IAED;;OAEG;IACH,kBAAkB,CAAC,cAAyB;QAC1C,OAAO,IAAI,CAAC,sBAAsB,CAAC,cAAc,CAAC,CAAC;IACrD,CAAC;IAEO,sBAAsB,CAAC,cAAyB;QACtD,MAAM,IAAI,GAAG,IAAI,WAAW,CAAC;YAC3B,EAAE,EAAE,IAAI,CAAC,EAAE;YACX,GAAG,EAAE,EAAE,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE;YAC5B,QAAQ,EAAE,IAAI,CAAC,QAAQ;YACvB,gBAAgB,EAAE,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,MAAM,EAAE,CAAC,CAAC;YACxE,gBAAgB,EAAE,IAAI,CAAC,gBAAgB;YACvC,iBAAiB,EAAE,CAAC,GAAG,IAAI,CAAC,iBAAiB,CAAC;YAC9C,sBAAsB,EAAE,CAAC,GAAG,IAAI,CAAC,sBAAsB,CAAC;YACxD,mBAAmB,EAAE,IAAI,CAAC,mBAAmB,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,GAAG,CAAC,IAAI,CAAC,mBAAmB,CAAC;YACrG,wBAAwB,EACtB,IAAI,CAAC,wBAAwB,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,GAAG,CAAC,IAAI,CAAC,wBAAwB,CAAC;YAC5F,cAAc,EAAE,eAAe,CAAC,cAAc,CAAC;SAChD,CAAC,CAAC;QACH,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;QAC9B,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,cAAc,CAAC;QAC1C,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC;QAChC,IAAI,CAAC,gBAAgB,GAAG,IAAI,CAAC,gBAAgB,CAAC;QAC9C,IAAI,CAAC,cAAc;YACjB,IAAI,CAAC,cAAc,IAAI,IAAI;gBACzB,CAAC,CAAC,SAAS;gBACX,CAAC,CAAC;oBACE,GAAG,IAAI,CAAC,cAAc;oBACtB,OAAO,EAAE,IAAI,CAAC,cAAc,CAAC,OAAO,EAAE,KAAK,EAAE,IAAI,IAAI;iBACtD,CAAC;QACR,OAAO,IAAI,CAAC;IACd,CAAC;IAED,sBAAsB;QACpB,IAAI,IAAI,CAAC,gBAAgB,IAAI,IAAI,CAAC,cAAc,IAAI,IAAI,EAAE,CAAC;YACzD,oBAAoB;YACpB,OAAO,GAAG,CAAC;QACb,CAAC;aAAM,IAAI,IAAI,CAAC,cAAc,CAAC,mBAAmB,GAAG,CAAC,EAAE,CAAC;YACvD,OAAO,GAAG,IAAI,CAAC,cAAc,CAAC,eAAe,IAAI,CAAC;QACpD,CAAC;aAAM,CAAC;YACN,OAAO,GAAG,IAAI,CAAC,cAAc,CAAC,eAAe,KAAK,IAAI,CAAC,cAAc,CAAC,mBAAmB,EAAE,CAAC;QAC9F,CAAC;IACH,CAAC"}
|
|
@@ -0,0 +1,83 @@
|
|
|
1
|
+
import { JsonValue, SourceEntityDescriptor } from './SourceEntity.js';
|
|
2
|
+
import { SourceTable, SourceTableCandidate, SourceTableId } from './SourceTable.js';
|
|
3
|
+
/**
|
|
4
|
+
* A source connector's classification of overlapping persisted tables.
|
|
5
|
+
*/
|
|
6
|
+
export interface SourceTableCandidateResolution {
|
|
7
|
+
/**
|
|
8
|
+
* Records storage can reuse. Copies may include updated source metadata.
|
|
9
|
+
*/
|
|
10
|
+
compatibleTables: ReadonlyArray<SourceTableCandidate>;
|
|
11
|
+
/**
|
|
12
|
+
* Records that cannot be reused. Every candidate must appear in exactly one result list.
|
|
13
|
+
*/
|
|
14
|
+
incompatibleTables: ReadonlyArray<SourceTableCandidate>;
|
|
15
|
+
/**
|
|
16
|
+
* Values for records storage creates during this resolution.
|
|
17
|
+
*/
|
|
18
|
+
newTableValues: SourceTableCreateValues;
|
|
19
|
+
}
|
|
20
|
+
export interface SourceTableCreateValues {
|
|
21
|
+
/**
|
|
22
|
+
* Source metadata for new records. Null means no metadata.
|
|
23
|
+
*/
|
|
24
|
+
sourceMetadata: JsonValue;
|
|
25
|
+
}
|
|
26
|
+
/**
|
|
27
|
+
* Input to a source-owned reconciliation callback. The callback may run inside a storage
|
|
28
|
+
* transaction, so it must not mutate storage or perform slow external work.
|
|
29
|
+
*/
|
|
30
|
+
export interface SourceTableCandidateReconcilerInput {
|
|
31
|
+
/**
|
|
32
|
+
* Source entity being resolved.
|
|
33
|
+
*/
|
|
34
|
+
source: SourceEntityDescriptor;
|
|
35
|
+
/**
|
|
36
|
+
* Persisted tables overlapping by name or object id.
|
|
37
|
+
*/
|
|
38
|
+
candidates: ReadonlyArray<SourceTableCandidate>;
|
|
39
|
+
}
|
|
40
|
+
export type SourceTableCandidateReconciler = (input: SourceTableCandidateReconcilerInput) => SourceTableCandidateResolution | Promise<SourceTableCandidateResolution>;
|
|
41
|
+
/**
|
|
42
|
+
* Compare replica-id columns in order.
|
|
43
|
+
*/
|
|
44
|
+
export declare function sameReplicaIdColumns(left: SourceTableCandidate['replicaIdColumns'], right: SourceEntityDescriptor): boolean;
|
|
45
|
+
/**
|
|
46
|
+
* Compare the shared source-table identity fields.
|
|
47
|
+
*/
|
|
48
|
+
export declare function sourceIdentityCompatible(source: SourceEntityDescriptor, candidate: SourceTableCandidate): boolean;
|
|
49
|
+
/**
|
|
50
|
+
* Default identity-based reconciliation for connectors without source-specific metadata.
|
|
51
|
+
*/
|
|
52
|
+
export declare const defaultSourceTableReconciler: SourceTableCandidateReconciler;
|
|
53
|
+
/**
|
|
54
|
+
* Check that every candidate was classified exactly once.
|
|
55
|
+
*/
|
|
56
|
+
export declare function validateSourceTableCandidateResolution(candidates: ReadonlyArray<SourceTableCandidate>, resolution: SourceTableCandidateResolution): void;
|
|
57
|
+
/**
|
|
58
|
+
* A source-metadata update to persist.
|
|
59
|
+
*/
|
|
60
|
+
export interface SourceTableMetadataUpdate {
|
|
61
|
+
id: SourceTableId;
|
|
62
|
+
sourceMetadata: JsonValue;
|
|
63
|
+
}
|
|
64
|
+
/**
|
|
65
|
+
* Rebuild a resolution from storage-owned tables, applying only reconciler-owned metadata to
|
|
66
|
+
* compatible tables. All other mutable table state comes from storage.
|
|
67
|
+
*
|
|
68
|
+
* Reconciler candidates are typed as read-only, but TypeScript types provide no runtime protection:
|
|
69
|
+
* callback code can cast a cloned candidate and mutate it. Rematerializing by id ensures those
|
|
70
|
+
* mutations are not trusted even when the compile-time boundary is bypassed.
|
|
71
|
+
*/
|
|
72
|
+
export declare function materializeSourceTableResolution(tables: ReadonlyArray<SourceTable>, resolution: SourceTableCandidateResolution): MaterializedSourceTableResolution;
|
|
73
|
+
export interface MaterializedSourceTableResolution {
|
|
74
|
+
compatibleTables: SourceTable[];
|
|
75
|
+
incompatibleTables: SourceTable[];
|
|
76
|
+
newTableValues: SourceTableCreateValues;
|
|
77
|
+
}
|
|
78
|
+
/**
|
|
79
|
+
* Return source-metadata changes from compatible candidates, comparing metadata by value against
|
|
80
|
+
* the original storage-owned tables. The reconciler may mutate its isolated candidate clones, so
|
|
81
|
+
* those clones cannot be used as the persisted baseline.
|
|
82
|
+
*/
|
|
83
|
+
export declare function diffSourceTableUpdates(persistedTables: ReadonlyArray<SourceTable>, resolution: SourceTableCandidateResolution): SourceTableMetadataUpdate[];
|
|
@@ -0,0 +1,95 @@
|
|
|
1
|
+
import { ServiceAssertionError } from '@powersync/lib-services-framework';
|
|
2
|
+
import { isDeepStrictEqual } from 'node:util';
|
|
3
|
+
import { sourceTableIdEquals } from './SourceTable.js';
|
|
4
|
+
/**
|
|
5
|
+
* Compare replica-id columns in order.
|
|
6
|
+
*/
|
|
7
|
+
export function sameReplicaIdColumns(left, right) {
|
|
8
|
+
const target = right.replicaIdColumns;
|
|
9
|
+
return (left.length == target.length &&
|
|
10
|
+
left.every((column, index) => column.name == target[index].name && column.type == target[index].type && column.typeId == target[index].typeId));
|
|
11
|
+
}
|
|
12
|
+
/**
|
|
13
|
+
* Compare the shared source-table identity fields.
|
|
14
|
+
*/
|
|
15
|
+
export function sourceIdentityCompatible(source, candidate) {
|
|
16
|
+
return (candidate.schema == source.schema &&
|
|
17
|
+
candidate.name == source.name &&
|
|
18
|
+
(source.objectId == null || candidate.objectId == source.objectId) &&
|
|
19
|
+
sameReplicaIdColumns(candidate.replicaIdColumns, source));
|
|
20
|
+
}
|
|
21
|
+
/**
|
|
22
|
+
* Default identity-based reconciliation for connectors without source-specific metadata.
|
|
23
|
+
*/
|
|
24
|
+
export const defaultSourceTableReconciler = ({ source, candidates }) => {
|
|
25
|
+
const compatibleTables = [];
|
|
26
|
+
const incompatibleTables = [];
|
|
27
|
+
for (const candidate of candidates) {
|
|
28
|
+
if (sourceIdentityCompatible(source, candidate)) {
|
|
29
|
+
compatibleTables.push(candidate);
|
|
30
|
+
}
|
|
31
|
+
else {
|
|
32
|
+
incompatibleTables.push(candidate);
|
|
33
|
+
}
|
|
34
|
+
}
|
|
35
|
+
return { compatibleTables, incompatibleTables, newTableValues: { sourceMetadata: null } };
|
|
36
|
+
};
|
|
37
|
+
/**
|
|
38
|
+
* Check that every candidate was classified exactly once.
|
|
39
|
+
*/
|
|
40
|
+
export function validateSourceTableCandidateResolution(candidates, resolution) {
|
|
41
|
+
const classifiedTables = [...resolution.compatibleTables, ...resolution.incompatibleTables];
|
|
42
|
+
for (const candidate of candidates) {
|
|
43
|
+
const classifications = classifiedTables.filter((table) => sourceTableIdEquals(table.id, candidate.id));
|
|
44
|
+
if (classifications.length !== 1) {
|
|
45
|
+
throw new ServiceAssertionError(`Source table candidate ${candidate.id.toString()} must be classified exactly once, got ${classifications.length}`);
|
|
46
|
+
}
|
|
47
|
+
}
|
|
48
|
+
for (const table of classifiedTables) {
|
|
49
|
+
if (!candidates.some((candidate) => sourceTableIdEquals(candidate.id, table.id))) {
|
|
50
|
+
throw new ServiceAssertionError(`Source table reconciliation returned unknown candidate ${table.id.toString()}`);
|
|
51
|
+
}
|
|
52
|
+
}
|
|
53
|
+
}
|
|
54
|
+
/**
|
|
55
|
+
* Rebuild a resolution from storage-owned tables, applying only reconciler-owned metadata to
|
|
56
|
+
* compatible tables. All other mutable table state comes from storage.
|
|
57
|
+
*
|
|
58
|
+
* Reconciler candidates are typed as read-only, but TypeScript types provide no runtime protection:
|
|
59
|
+
* callback code can cast a cloned candidate and mutate it. Rematerializing by id ensures those
|
|
60
|
+
* mutations are not trusted even when the compile-time boundary is bypassed.
|
|
61
|
+
*/
|
|
62
|
+
export function materializeSourceTableResolution(tables, resolution) {
|
|
63
|
+
const findTable = (candidate) => {
|
|
64
|
+
const table = tables.find((table) => sourceTableIdEquals(table.id, candidate.id));
|
|
65
|
+
if (table == null) {
|
|
66
|
+
throw new ServiceAssertionError(`Source table candidate ${candidate.id.toString()} was not persisted`);
|
|
67
|
+
}
|
|
68
|
+
return table;
|
|
69
|
+
};
|
|
70
|
+
return {
|
|
71
|
+
compatibleTables: resolution.compatibleTables.map((candidate) => findTable(candidate).withSourceMetadata(candidate.sourceMetadata)),
|
|
72
|
+
incompatibleTables: resolution.incompatibleTables.map(findTable),
|
|
73
|
+
newTableValues: resolution.newTableValues
|
|
74
|
+
};
|
|
75
|
+
}
|
|
76
|
+
/**
|
|
77
|
+
* Return source-metadata changes from compatible candidates, comparing metadata by value against
|
|
78
|
+
* the original storage-owned tables. The reconciler may mutate its isolated candidate clones, so
|
|
79
|
+
* those clones cannot be used as the persisted baseline.
|
|
80
|
+
*/
|
|
81
|
+
export function diffSourceTableUpdates(persistedTables, resolution) {
|
|
82
|
+
const updates = [];
|
|
83
|
+
for (const resolvedTable of resolution.compatibleTables) {
|
|
84
|
+
const persistedTable = persistedTables.find((table) => sourceTableIdEquals(table.id, resolvedTable.id));
|
|
85
|
+
if (persistedTable == null) {
|
|
86
|
+
throw new ServiceAssertionError(`Source table reconciliation returned unknown candidate ${resolvedTable.id.toString()}`);
|
|
87
|
+
}
|
|
88
|
+
if (isDeepStrictEqual(persistedTable.sourceMetadata, resolvedTable.sourceMetadata)) {
|
|
89
|
+
continue;
|
|
90
|
+
}
|
|
91
|
+
updates.push({ id: resolvedTable.id, sourceMetadata: resolvedTable.sourceMetadata });
|
|
92
|
+
}
|
|
93
|
+
return updates;
|
|
94
|
+
}
|
|
95
|
+
//# sourceMappingURL=SourceTableReconciler.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"SourceTableReconciler.js","sourceRoot":"","sources":["../../src/storage/SourceTableReconciler.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,qBAAqB,EAAE,MAAM,mCAAmC,CAAC;AAC1E,OAAO,EAAE,iBAAiB,EAAE,MAAM,WAAW,CAAC;AAE9C,OAAO,EAAoD,mBAAmB,EAAE,MAAM,kBAAkB,CAAC;AAiDzG;;GAEG;AACH,MAAM,UAAU,oBAAoB,CAClC,IAA8C,EAC9C,KAA6B;IAE7B,MAAM,MAAM,GAAG,KAAK,CAAC,gBAAgB,CAAC;IACtC,OAAO,CACL,IAAI,CAAC,MAAM,IAAI,MAAM,CAAC,MAAM;QAC5B,IAAI,CAAC,KAAK,CACR,CAAC,MAAM,EAAE,KAAK,EAAE,EAAE,CAChB,MAAM,CAAC,IAAI,IAAI,MAAM,CAAC,KAAK,CAAC,CAAC,IAAI,IAAI,MAAM,CAAC,IAAI,IAAI,MAAM,CAAC,KAAK,CAAC,CAAC,IAAI,IAAI,MAAM,CAAC,MAAM,IAAI,MAAM,CAAC,KAAK,CAAC,CAAC,MAAM,CAClH,CACF,CAAC;AACJ,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,wBAAwB,CAAC,MAA8B,EAAE,SAA+B;IACtG,OAAO,CACL,SAAS,CAAC,MAAM,IAAI,MAAM,CAAC,MAAM;QACjC,SAAS,CAAC,IAAI,IAAI,MAAM,CAAC,IAAI;QAC7B,CAAC,MAAM,CAAC,QAAQ,IAAI,IAAI,IAAI,SAAS,CAAC,QAAQ,IAAI,MAAM,CAAC,QAAQ,CAAC;QAClE,oBAAoB,CAAC,SAAS,CAAC,gBAAgB,EAAE,MAAM,CAAC,CACzD,CAAC;AACJ,CAAC;AAED;;GAEG;AACH,MAAM,CAAC,MAAM,4BAA4B,GAAmC,CAAC,EAAE,MAAM,EAAE,UAAU,EAAE,EAAE,EAAE;IACrG,MAAM,gBAAgB,GAA2B,EAAE,CAAC;IACpD,MAAM,kBAAkB,GAA2B,EAAE,CAAC;IACtD,KAAK,MAAM,SAAS,IAAI,UAAU,EAAE,CAAC;QACnC,IAAI,wBAAwB,CAAC,MAAM,EAAE,SAAS,CAAC,EAAE,CAAC;YAChD,gBAAgB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QACnC,CAAC;aAAM,CAAC;YACN,kBAAkB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QACrC,CAAC;IACH,CAAC;IACD,OAAO,EAAE,gBAAgB,EAAE,kBAAkB,EAAE,cAAc,EAAE,EAAE,cAAc,EAAE,IAAI,EAAE,EAAE,CAAC;AAC5F,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,UAAU,sCAAsC,CACpD,UAA+C,EAC/C,UAA0C;IAE1C,MAAM,gBAAgB,GAAG,CAAC,GAAG,UAAU,CAAC,gBAAgB,EAAE,GAAG,UAAU,CAAC,kBAAkB,CAAC,CAAC;IAE5F,KAAK,MAAM,SAAS,IAAI,UAAU,EAAE,CAAC;QACnC,MAAM,eAAe,GAAG,gBAAgB,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,mBAAmB,CAAC,KAAK,CAAC,EAAE,EAAE,SAAS,CAAC,EAAE,CAAC,CAAC,CAAC;QACxG,IAAI,eAAe,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACjC,MAAM,IAAI,qBAAqB,CAC7B,0BAA0B,SAAS,CAAC,EAAE,CAAC,QAAQ,EAAE,yCAAyC,eAAe,CAAC,MAAM,EAAE,CACnH,CAAC;QACJ,CAAC;IACH,CAAC;IAED,KAAK,MAAM,KAAK,IAAI,gBAAgB,EAAE,CAAC;QACrC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,mBAAmB,CAAC,SAAS,CAAC,EAAE,EAAE,KAAK,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC;YACjF,MAAM,IAAI,qBAAqB,CAAC,0DAA0D,KAAK,CAAC,EAAE,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;QACnH,CAAC;IACH,CAAC;AACH,CAAC;AAUD;;;;;;;GAOG;AACH,MAAM,UAAU,gCAAgC,CAC9C,MAAkC,EAClC,UAA0C;IAE1C,MAAM,SAAS,GAAG,CAAC,SAA+B,EAAe,EAAE;QACjE,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,mBAAmB,CAAC,KAAK,CAAC,EAAE,EAAE,SAAS,CAAC,EAAE,CAAC,CAAC,CAAC;QAClF,IAAI,KAAK,IAAI,IAAI,EAAE,CAAC;YAClB,MAAM,IAAI,qBAAqB,CAAC,0BAA0B,SAAS,CAAC,EAAE,CAAC,QAAQ,EAAE,oBAAoB,CAAC,CAAC;QACzG,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC,CAAC;IACF,OAAO;QACL,gBAAgB,EAAE,UAAU,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE,CAC9D,SAAS,CAAC,SAAS,CAAC,CAAC,kBAAkB,CAAC,SAAS,CAAC,cAAc,CAAC,CAClE;QACD,kBAAkB,EAAE,UAAU,CAAC,kBAAkB,CAAC,GAAG,CAAC,SAAS,CAAC;QAChE,cAAc,EAAE,UAAU,CAAC,cAAc;KAC1C,CAAC;AACJ,CAAC;AAQD;;;;GAIG;AACH,MAAM,UAAU,sBAAsB,CACpC,eAA2C,EAC3C,UAA0C;IAE1C,MAAM,OAAO,GAAgC,EAAE,CAAC;IAChD,KAAK,MAAM,aAAa,IAAI,UAAU,CAAC,gBAAgB,EAAE,CAAC;QACxD,MAAM,cAAc,GAAG,eAAe,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,mBAAmB,CAAC,KAAK,CAAC,EAAE,EAAE,aAAa,CAAC,EAAE,CAAC,CAAC,CAAC;QACxG,IAAI,cAAc,IAAI,IAAI,EAAE,CAAC;YAC3B,MAAM,IAAI,qBAAqB,CAC7B,0DAA0D,aAAa,CAAC,EAAE,CAAC,QAAQ,EAAE,EAAE,CACxF,CAAC;QACJ,CAAC;QACD,IAAI,iBAAiB,CAAC,cAAc,CAAC,cAAc,EAAE,aAAa,CAAC,cAAc,CAAC,EAAE,CAAC;YACnF,SAAS;QACX,CAAC;QACD,OAAO,CAAC,IAAI,CAAC,EAAE,EAAE,EAAE,aAAa,CAAC,EAAE,EAAE,cAAc,EAAE,aAAa,CAAC,cAAc,EAAE,CAAC,CAAC;IACvF,CAAC;IACD,OAAO,OAAO,CAAC;AACjB,CAAC"}
|
|
@@ -9,6 +9,7 @@ import { ParsedSyncConfigSet } from './ParsedSyncConfigSet.js';
|
|
|
9
9
|
import { ParseSyncConfigOptions } from './PersistedSyncConfigContent.js';
|
|
10
10
|
import { SourceEntityDescriptor } from './SourceEntity.js';
|
|
11
11
|
import { SourceTable } from './SourceTable.js';
|
|
12
|
+
import { SourceTableCandidateReconciler } from './SourceTableReconciler.js';
|
|
12
13
|
import { StorageVersionConfig } from './StorageVersionConfig.js';
|
|
13
14
|
import { SyncStorageWriteCheckpointAPI } from './WriteCheckpointAPI.js';
|
|
14
15
|
/**
|
|
@@ -168,6 +169,11 @@ export interface ResolveTablesOptions {
|
|
|
168
169
|
* Source table or collection metadata discovered during snapshot or streaming.
|
|
169
170
|
*/
|
|
170
171
|
source: SourceEntityDescriptor;
|
|
172
|
+
/**
|
|
173
|
+
* Classifies overlapping persisted tables. Defaults to identity-based reconciliation.
|
|
174
|
+
* This may run inside a storage transaction and must not mutate storage.
|
|
175
|
+
*/
|
|
176
|
+
reconcileSourceTables?: SourceTableCandidateReconciler;
|
|
171
177
|
/**
|
|
172
178
|
* For tests only - custom id generator for stable ids.
|
|
173
179
|
*/
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"SyncRulesBucketStorage.js","sourceRoot":"","sources":["../../src/storage/SyncRulesBucketStorage.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"SyncRulesBucketStorage.js","sourceRoot":"","sources":["../../src/storage/SyncRulesBucketStorage.ts"],"names":[],"mappings":"AAmcA,MAAM,UAAU,UAAU,CAAC,KAAmD;IAC5E,OAAQ,KAAgC,CAAC,OAAO,KAAK,SAAS,CAAC;AACjE,CAAC;AAiBD;;;;GAIG;AACH,MAAM,OAAO,8BAA+B,SAAQ,KAAK;IAE5C;IACA;IAFX,YACW,KAAa,EACb,SAAyC;QAElD,KAAK,CAAC,yCAAyC,KAAK,GAAG,CAAC,CAAC;QAHhD,UAAK,GAAL,KAAK,CAAQ;QACb,cAAS,GAAT,SAAS,CAAgC;IAGpD,CAAC;CACF;AAqDD,MAAM,CAAC,MAAM,yBAAyB,GAAsB;IAC1D,kBAAkB,EAAE,IAAI,GAAG,EAAU;IACrC,qBAAqB,EAAE,IAAI;IAC3B,uBAAuB,EAAE,IAAI,GAAG,EAAU;IAC1C,0BAA0B,EAAE,IAAI;CACjC,CAAC"}
|
|
@@ -13,6 +13,7 @@ export * from './ReplicationLock.js';
|
|
|
13
13
|
export * from './ReportStorage.js';
|
|
14
14
|
export * from './SourceEntity.js';
|
|
15
15
|
export * from './SourceTable.js';
|
|
16
|
+
export * from './SourceTableReconciler.js';
|
|
16
17
|
export * from './storage-metrics.js';
|
|
17
18
|
export * from './StorageEngine.js';
|
|
18
19
|
export * from './StorageProvider.js';
|
|
@@ -13,6 +13,7 @@ export * from './ReplicationLock.js';
|
|
|
13
13
|
export * from './ReportStorage.js';
|
|
14
14
|
export * from './SourceEntity.js';
|
|
15
15
|
export * from './SourceTable.js';
|
|
16
|
+
export * from './SourceTableReconciler.js';
|
|
16
17
|
export * from './storage-metrics.js';
|
|
17
18
|
export * from './StorageEngine.js';
|
|
18
19
|
export * from './StorageProvider.js';
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"storage-index.js","sourceRoot":"","sources":["../../src/storage/storage-index.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAC;AAC1B,cAAc,oBAAoB,CAAC;AACnC,cAAc,yBAAyB,CAAC;AACxC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,yCAAyC,CAAC;AACxD,cAAc,oBAAoB,CAAC;AACnC,cAAc,0BAA0B,CAAC;AACzC,cAAc,iCAAiC,CAAC;AAChD,cAAc,iCAAiC,CAAC;AAChD,cAAc,gCAAgC,CAAC;AAC/C,cAAc,8BAA8B,CAAC;AAC7C,cAAc,sBAAsB,CAAC;AACrC,cAAc,oBAAoB,CAAC;AACnC,cAAc,mBAAmB,CAAC;AAClC,cAAc,kBAAkB,CAAC;AACjC,cAAc,sBAAsB,CAAC;AACrC,cAAc,oBAAoB,CAAC;AACnC,cAAc,sBAAsB,CAAC;AACrC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,6BAA6B,CAAC;AAC5C,cAAc,yBAAyB,CAAC;AAExC,cAAc,6CAA6C,CAAC;AAC5D,cAAc,0DAA0D,CAAC;AACzE,cAAc,0DAA0D,CAAC;AACzE,cAAc,iDAAiD,CAAC"}
|
|
1
|
+
{"version":3,"file":"storage-index.js","sourceRoot":"","sources":["../../src/storage/storage-index.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAC;AAC1B,cAAc,oBAAoB,CAAC;AACnC,cAAc,yBAAyB,CAAC;AACxC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,yCAAyC,CAAC;AACxD,cAAc,oBAAoB,CAAC;AACnC,cAAc,0BAA0B,CAAC;AACzC,cAAc,iCAAiC,CAAC;AAChD,cAAc,iCAAiC,CAAC;AAChD,cAAc,gCAAgC,CAAC;AAC/C,cAAc,8BAA8B,CAAC;AAC7C,cAAc,sBAAsB,CAAC;AACrC,cAAc,oBAAoB,CAAC;AACnC,cAAc,mBAAmB,CAAC;AAClC,cAAc,kBAAkB,CAAC;AACjC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,sBAAsB,CAAC;AACrC,cAAc,oBAAoB,CAAC;AACnC,cAAc,sBAAsB,CAAC;AACrC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,6BAA6B,CAAC;AAC5C,cAAc,yBAAyB,CAAC;AAExC,cAAc,6CAA6C,CAAC;AAC5D,cAAc,0DAA0D,CAAC;AACzE,cAAc,0DAA0D,CAAC;AACzE,cAAc,iDAAiD,CAAC"}
|
package/dist/util/utils.d.ts
CHANGED
|
@@ -23,7 +23,7 @@ export interface PartialChecksum {
|
|
|
23
23
|
* This is just a type alias, but serves to document that we're working with an op_id.
|
|
24
24
|
*/
|
|
25
25
|
export type InternalOpId = bigint;
|
|
26
|
-
export declare const ID_NAMESPACE
|
|
26
|
+
export declare const ID_NAMESPACE: Uint8Array<ArrayBuffer>;
|
|
27
27
|
export declare function escapeIdentifier(identifier: string): string;
|
|
28
28
|
/**
|
|
29
29
|
* Sanitized name of the entity in the format of "{schema}.{entity name}"
|
package/dist/util/utils.js
CHANGED
|
@@ -2,7 +2,7 @@ import * as bson from 'bson';
|
|
|
2
2
|
import crypto from 'crypto';
|
|
3
3
|
import * as uuid from 'uuid';
|
|
4
4
|
import { ServiceAssertionError } from '@powersync/lib-services-framework';
|
|
5
|
-
export const ID_NAMESPACE = 'a396dd91-09fc-4017-a28d-3df722f651e9';
|
|
5
|
+
export const ID_NAMESPACE = uuid.parse('a396dd91-09fc-4017-a28d-3df722f651e9');
|
|
6
6
|
export function escapeIdentifier(identifier) {
|
|
7
7
|
return `"${identifier.replace(/"/g, '""').replace(/\./g, '"."')}"`;
|
|
8
8
|
}
|
package/dist/util/utils.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../src/util/utils.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,IAAI,MAAM,MAAM,CAAC;AAC7B,OAAO,MAAM,MAAM,QAAQ,CAAC;AAC5B,OAAO,KAAK,IAAI,MAAM,MAAM,CAAC;AAK7B,OAAO,EAAE,qBAAqB,EAAE,MAAM,mCAAmC,CAAC;AA2B1E,MAAM,CAAC,MAAM,YAAY,GAAG,sCAAsC,CAAC;
|
|
1
|
+
{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../src/util/utils.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,IAAI,MAAM,MAAM,CAAC;AAC7B,OAAO,MAAM,MAAM,QAAQ,CAAC;AAC5B,OAAO,KAAK,IAAI,MAAM,MAAM,CAAC;AAK7B,OAAO,EAAE,qBAAqB,EAAE,MAAM,mCAAmC,CAAC;AA2B1E,MAAM,CAAC,MAAM,YAAY,GAAG,IAAI,CAAC,KAAK,CAAC,sCAAsC,CAAC,CAAC;AAE/E,MAAM,UAAU,gBAAgB,CAAC,UAAkB;IACjD,OAAO,IAAI,UAAU,CAAC,OAAO,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,KAAK,CAAC,GAAG,CAAC;AACrE,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,aAAa,CAAC,GAA8B;IAC1D,OAAO,GAAG,gBAAgB,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,gBAAgB,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;AACzE,CAAC;AAED,MAAM,UAAU,QAAQ,CAAC,IAAY,EAAE,EAAU,EAAE,IAAY;IAC7D,MAAM,IAAI,GAAG,MAAM,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;IACzC,IAAI,CAAC,MAAM,CAAC,OAAO,IAAI,IAAI,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC;IACzC,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC;IAC7B,OAAO,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;AAChC,CAAC;AAED,MAAM,UAAU,UAAU,CAAC,SAAiB;IAC1C,MAAM,IAAI,GAAG,MAAM,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;IACzC,IAAI,CAAC,MAAM,CAAC,UAAU,SAAS,EAAE,CAAC,CAAC;IACnC,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC;IAC7B,OAAO,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;AAChC,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,sBAAsB,CAAC,EAAgB;IACrD,6EAA6E;IAC7E,6CAA6C;IAC7C,IAAI,OAAO,EAAE,IAAI,QAAQ,EAAE,CAAC;QAC1B,MAAM,IAAI,qBAAqB,CAAC,yBAAyB,EAAE,KAAK,OAAO,EAAE,GAAG,CAAC,CAAC;IAChF,CAAC;IACD,OAAO,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;AACzB,CAAC;AAED,MAAM,UAAU,aAAa,CAAC,QAAqB,EAAE,OAAoB;IACvE,mBAAmB;IACnB,MAAM,cAAc,GAAG,IAAI,GAAG,EAA0B,CAAC;IAEzD,MAAM,QAAQ,GAAG,IAAI,GAAG,CAAS,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC;IAElD,KAAK,IAAI,QAAQ,IAAI,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC;QACtC,MAAM,CAAC,GAAG,QAAQ,CAAC,GAAG,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;QACxC,IAAI,CAAC,IAAI,IAAI,EAAE,CAAC;YACd,QAAQ;YACR,cAAc,CAAC,GAAG,CAAC,QAAQ,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;QAChD,CAAC;aAAM,CAAC;YACN,QAAQ,CAAC,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;YACjC,IAAI,QAAQ,CAAC,QAAQ,IAAI,CAAC,CAAC,QAAQ,IAAI,QAAQ,CAAC,KAAK,IAAI,CAAC,CAAC,KAAK,EAAE,CAAC;gBACjE,UAAU;gBACV,cAAc,CAAC,GAAG,CAAC,QAAQ,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;YAChD,CAAC;iBAAM,CAAC;gBACN,YAAY;YACd,CAAC;QACH,CAAC;IACH,CAAC;IAED,OAAO;QACL,cAAc,EAAE,CAAC,GAAG,cAAc,CAAC,MAAM,EAAE,CAAC;QAC5C,cAAc,EAAE,CAAC,GAAG,QAAQ,CAAC;KAC9B,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,YAAY,CAAC,CAAS,EAAE,CAAS;IAC/C,OAAO,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,UAAU,CAAC;AAC9B,CAAC;AAED,MAAM,UAAU,iBAAiB,CAAC,CAAmC;IACnE,OAAO,iBAAiB,IAAI,CAAC,CAAC;AAChC,CAAC;AAED,MAAM,UAAU,kBAAkB,CAAC,CAAiB,EAAE,CAA0C;IAC9F,MAAM,QAAQ,GAAG,mBAAmB,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;IACrD,IAAI,iBAAiB,CAAC,QAAQ,CAAC,EAAE,CAAC;QAChC,oCAAoC;QACpC,MAAM,IAAI,qBAAqB,CAAC,wBAAwB,CAAC,CAAC;IAC5D,CAAC;IACD,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED,MAAM,UAAU,mBAAmB,CACjC,MAAc,EACd,CAA0C,EAC1C,CAA0C;IAE1C,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,IAAI,IAAI,EAAE,CAAC;QAC3B,IAAI,CAAC,iBAAiB,CAAC,CAAC,CAAC,EAAE,CAAC;YAC1B,aAAa;YACb,OAAO,CAAC,CAAC;QACX,CAAC;QACD,QAAQ;QACR,IAAI,CAAC,iBAAiB,CAAC,CAAC,CAAC,EAAE,CAAC;YAC1B,OAAO;gBACL,MAAM;gBACN,QAAQ,EAAE,YAAY,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC,eAAe,CAAC;gBACrD,KAAK,EAAE,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,YAAY;aAChC,CAAC;QACJ,CAAC;aAAM,CAAC;YACN,OAAO;gBACL,MAAM;gBACN,eAAe,EAAE,YAAY,CAAC,CAAC,CAAC,eAAe,EAAE,CAAC,CAAC,eAAe,CAAC;gBACnE,YAAY,EAAE,CAAC,CAAC,YAAY,GAAG,CAAC,CAAC,YAAY;aAC9C,CAAC;QACJ,CAAC;IACH,CAAC;SAAM,IAAI,CAAC,IAAI,IAAI,EAAE,CAAC;QACrB,OAAO,CAAC,CAAC;IACX,CAAC;SAAM,IAAI,CAAC,IAAI,IAAI,EAAE,CAAC;QACrB,OAAO,CAAC,CAAC;IACX,CAAC;SAAM,CAAC;QACN,+DAA+D;QAC/D,OAAO;YACL,MAAM;YACN,eAAe,EAAE,CAAC;YAClB,YAAY,EAAE,CAAC;SAChB,CAAC;IACJ,CAAC;AACH,CAAC;AAED,SAAS,qBAAqB,CAC5B,KAAoC,EACpC,OAAmC;IAEnC,IAAI,MAAM,GAAwB,EAAE,CAAC;IACrC,KAAK,IAAI,MAAM,IAAI,OAAO,EAAE,CAAC;QAC3B,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC;QACzB,MAAM,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC;IAC7B,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,MAAM,UAAU,0BAA0B,CACxC,KAAoC,EACpC,OAAmC;IAEnC,IAAI,OAAO,CAAC,MAAM,IAAI,CAAC,EAAE,CAAC;QACxB,gDAAgD;QAChD,OAAO,IAAI,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,CAAC,CAAC;IAClC,CAAC;IACD,MAAM,WAAW,GAAG,qBAAqB,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;IAE1D,OAAO,cAAc,CAAC,WAAW,CAAC,CAAC;AACrC,CAAC;AAED,MAAM,UAAU,cAAc,CAAC,GAAyB;IACtD,+EAA+E;IAC/E,4EAA4E;IAC5E,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;IACjC,MAAM,MAAM,GAAG,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;IAChC,OAAO,IAAI,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,EAAE,YAAY,EAAE,MAAM,CAAC,CAAC,CAAC;AAC5D,CAAC;AAED,MAAM,UAAU,gBAAgB,CAAI,GAAqC;IACvE,KAAK,IAAI,GAAG,IAAI,GAAG,EAAE,CAAC;QACpB,IAAI,OAAO,GAAG,CAAC,GAAG,CAAC,IAAI,WAAW,EAAE,CAAC;YACnC,OAAO,IAAI,CAAC;QACd,CAAC;IACH,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,aAAa,CAC3B,SAAkB,EAClB,GAAqC;IAErC,IAAI,CAAC,SAAS,EAAE,CAAC;QACf,gDAAgD;QAChD,OAAO,IAAI,CAAC;IACd,CAAC;IACD,OAAO,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC;AAChC,CAAC;AAED;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,YAAY,CAAC,UAAwB;IACnD,IAAI,QAAQ,GAAG,IAAI,GAAG,EAAsB,CAAC;IAC7C,IAAI,aAAa,GAAG,CAAC,CAAC;IAEtB,KAAK,IAAI,EAAE,IAAI,UAAU,EAAE,CAAC;QAC1B,MAAM,GAAG,GAAG,MAAM,CAAC,EAAE,CAAC,CAAC;QACvB,IAAI,EAAE,CAAC,EAAE,IAAI,KAAK,EAAE,CAAC;YACnB,MAAM,QAAQ,GAAG,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YACnC,IAAI,QAAQ,EAAE,CAAC;gBACb,aAAa,GAAG,YAAY,CAAC,aAAa,EAAE,QAAQ,CAAC,QAAkB,CAAC,CAAC;YAC3E,CAAC;YACD,QAAQ,CAAC,GAAG,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;QACxB,CAAC;aAAM,IAAI,EAAE,CAAC,EAAE,IAAI,QAAQ,EAAE,CAAC;YAC7B,MAAM,QAAQ,GAAG,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YACnC,IAAI,QAAQ,EAAE,CAAC;gBACb,aAAa,GAAG,YAAY,CAAC,aAAa,EAAE,QAAQ,CAAC,QAAkB,CAAC,CAAC;YAC3E,CAAC;YACD,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;YACrB,aAAa,GAAG,YAAY,CAAC,aAAa,EAAE,EAAE,CAAC,QAAkB,CAAC,CAAC;QACrE,CAAC;aAAM,IAAI,EAAE,CAAC,EAAE,IAAI,OAAO,EAAE,CAAC;YAC5B,QAAQ,CAAC,KAAK,EAAE,CAAC;YACjB,aAAa,GAAG,EAAE,CAAC,QAAkB,CAAC;QACxC,CAAC;aAAM,IAAI,EAAE,CAAC,EAAE,IAAI,MAAM,EAAE,CAAC;YAC3B,aAAa,GAAG,YAAY,CAAC,aAAa,EAAE,EAAE,CAAC,QAAkB,CAAC,CAAC;QACrE,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,KAAK,CAAC,qBAAqB,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC;QAChD,CAAC;IACH,CAAC;IAED,MAAM,IAAI,GAAG,CAAC,GAAG,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE;QAChD,OAAO,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC;IACnD,CAAC,CAAC,CAAC;IAEH,IAAI,UAAU,GAAiB;QAC7B,wDAAwD;QACxD,EAAE,KAAK,EAAE,GAAG,EAAE,EAAE,EAAE,OAAO,EAAE,QAAQ,EAAE,aAAa,EAAE;QACpD,GAAG,IAAI;KACR,CAAC;IAEF,OAAO,UAAU,CAAC;AACpB,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,OAAO,CAAC,CAAS;IAC/B,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IACf,OAAO,CAAC,CAAC;AACX,CAAC;AAED,SAAS,MAAM,CAAC,KAAiB;IAC/B,OAAO,GAAG,KAAK,CAAC,WAAW,IAAI,KAAK,CAAC,SAAS,IAAI,KAAK,CAAC,MAAM,EAAE,CAAC;AACnE,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,eAAe,CAAC,MAAiD;IAC/E,IAAI,MAAM,IAAI,IAAI,EAAE,CAAC;QACnB,OAAO,EAAE,CAAC;IACZ,CAAC;IACD,IAAI,IAAI,GAAG,CAAC,CAAC;IACb,KAAK,IAAI,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;QAChD,IAAI,IAAI,EAAE,GAAG,GAAG,CAAC,MAAM,CAAC;QACxB,+CAA+C;QAC/C,IAAI,KAAK,IAAI,IAAI,EAAE,CAAC;YAClB,IAAI,IAAI,CAAC,CAAC;QACZ,CAAC;aAAM,IAAI,OAAO,KAAK,IAAI,QAAQ,EAAE,CAAC;YACpC,IAAI,IAAI,CAAC,CAAC;QACZ,CAAC;aAAM,IAAI,OAAO,KAAK,IAAI,QAAQ,EAAE,CAAC;YACpC,IAAI,IAAI,CAAC,CAAC;QACZ,CAAC;aAAM,IAAI,OAAO,KAAK,IAAI,QAAQ,EAAE,CAAC;YACpC,IAAI,IAAI,KAAK,CAAC,MAAM,CAAC;QACvB,CAAC;aAAM,IAAI,KAAK,YAAY,UAAU,EAAE,CAAC;YACvC,IAAI,IAAI,KAAK,CAAC,UAAU,CAAC;QAC3B,CAAC;IACH,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,5 +1,11 @@
|
|
|
1
1
|
import { SourceTableRef } from '@powersync/service-sync-rules';
|
|
2
2
|
|
|
3
|
+
/**
|
|
4
|
+
* Source-specific JSON metadata. Storage does not interpret it. Source-table APIs use null to
|
|
5
|
+
* represent the absence of metadata.
|
|
6
|
+
*/
|
|
7
|
+
export type JsonValue = string | number | boolean | null | JsonValue[] | { [key: string]: JsonValue };
|
|
8
|
+
|
|
3
9
|
export interface ColumnDescriptor {
|
|
4
10
|
name: string;
|
|
5
11
|
/**
|
|
@@ -19,8 +25,6 @@ export interface SourceEntityDescriptor extends SourceTableRef {
|
|
|
19
25
|
* If specified, this is specifically used to detect renames.
|
|
20
26
|
*/
|
|
21
27
|
objectId: number | string | undefined;
|
|
22
|
-
schema: string;
|
|
23
|
-
name: string;
|
|
24
28
|
/**
|
|
25
29
|
* The columns that are used to uniquely identify a record in the source entity.
|
|
26
30
|
*/
|
|
@@ -8,13 +8,23 @@ import {
|
|
|
8
8
|
} from '@powersync/service-sync-rules';
|
|
9
9
|
import { bson } from '../index.js';
|
|
10
10
|
import * as util from '../util/util-index.js';
|
|
11
|
-
import { ColumnDescriptor } from './SourceEntity.js';
|
|
11
|
+
import { ColumnDescriptor, JsonValue } from './SourceEntity.js';
|
|
12
12
|
|
|
13
13
|
/**
|
|
14
14
|
* Format of the id depends on the bucket storage module. It should be consistent within the module.
|
|
15
15
|
*/
|
|
16
16
|
export type SourceTableId = string | bson.ObjectId;
|
|
17
17
|
|
|
18
|
+
/**
|
|
19
|
+
* Compare source-table ids without coercing between storage-specific types.
|
|
20
|
+
*/
|
|
21
|
+
export function sourceTableIdEquals(left: SourceTableId, right: SourceTableId): boolean {
|
|
22
|
+
if (typeof left === 'string' || typeof right === 'string') {
|
|
23
|
+
return typeof left === 'string' && typeof right === 'string' && left === right;
|
|
24
|
+
}
|
|
25
|
+
return left.equals(right);
|
|
26
|
+
}
|
|
27
|
+
|
|
18
28
|
export interface SourceTableOptions {
|
|
19
29
|
id: SourceTableId;
|
|
20
30
|
ref: SourceTableRef;
|
|
@@ -25,6 +35,10 @@ export interface SourceTableOptions {
|
|
|
25
35
|
parameterLookupSources: ParameterIndexLookupCreator[];
|
|
26
36
|
bucketDataSourceIds?: Set<BucketDefinitionId>;
|
|
27
37
|
parameterLookupSourceIds?: Set<ParameterIndexId>;
|
|
38
|
+
/**
|
|
39
|
+
* Source-specific metadata. Null when no metadata has been recorded.
|
|
40
|
+
*/
|
|
41
|
+
sourceMetadata?: JsonValue;
|
|
28
42
|
}
|
|
29
43
|
|
|
30
44
|
export interface TableSnapshotStatus {
|
|
@@ -136,6 +150,10 @@ export class SourceTable {
|
|
|
136
150
|
return this.options.parameterLookupSourceIds;
|
|
137
151
|
}
|
|
138
152
|
|
|
153
|
+
get sourceMetadata() {
|
|
154
|
+
return this.options.sourceMetadata ?? null;
|
|
155
|
+
}
|
|
156
|
+
|
|
139
157
|
/**
|
|
140
158
|
* Sanitized name of the entity in the format of "{schema}.{entity name}".
|
|
141
159
|
* Suitable for safe use in Postgres queries.
|
|
@@ -152,23 +170,41 @@ export class SourceTable {
|
|
|
152
170
|
* In-memory clone of the table status.
|
|
153
171
|
*/
|
|
154
172
|
clone() {
|
|
173
|
+
return this.copyWithSourceMetadata(this.sourceMetadata);
|
|
174
|
+
}
|
|
175
|
+
|
|
176
|
+
/**
|
|
177
|
+
* Copy this table with different source metadata, preserving its resolved state.
|
|
178
|
+
*/
|
|
179
|
+
withSourceMetadata(sourceMetadata: JsonValue) {
|
|
180
|
+
return this.copyWithSourceMetadata(sourceMetadata);
|
|
181
|
+
}
|
|
182
|
+
|
|
183
|
+
private copyWithSourceMetadata(sourceMetadata: JsonValue) {
|
|
155
184
|
const copy = new SourceTable({
|
|
156
185
|
id: this.id,
|
|
157
|
-
ref: this.options.ref,
|
|
186
|
+
ref: { ...this.options.ref },
|
|
158
187
|
objectId: this.objectId,
|
|
159
|
-
replicaIdColumns: this.replicaIdColumns,
|
|
188
|
+
replicaIdColumns: this.replicaIdColumns.map((column) => ({ ...column })),
|
|
160
189
|
snapshotComplete: this.snapshotComplete,
|
|
161
|
-
bucketDataSources: this.bucketDataSources,
|
|
162
|
-
parameterLookupSources: this.parameterLookupSources,
|
|
190
|
+
bucketDataSources: [...this.bucketDataSources],
|
|
191
|
+
parameterLookupSources: [...this.parameterLookupSources],
|
|
163
192
|
bucketDataSourceIds: this.bucketDataSourceIds == null ? undefined : new Set(this.bucketDataSourceIds),
|
|
164
193
|
parameterLookupSourceIds:
|
|
165
|
-
this.parameterLookupSourceIds == null ? undefined : new Set(this.parameterLookupSourceIds)
|
|
194
|
+
this.parameterLookupSourceIds == null ? undefined : new Set(this.parameterLookupSourceIds),
|
|
195
|
+
sourceMetadata: structuredClone(sourceMetadata)
|
|
166
196
|
});
|
|
167
197
|
copy.syncData = this.syncData;
|
|
168
198
|
copy.syncParameters = this.syncParameters;
|
|
169
199
|
copy.syncEvent = this.syncEvent;
|
|
170
200
|
copy.storeCurrentData = this.storeCurrentData;
|
|
171
|
-
copy.snapshotStatus =
|
|
201
|
+
copy.snapshotStatus =
|
|
202
|
+
this.snapshotStatus == null
|
|
203
|
+
? undefined
|
|
204
|
+
: {
|
|
205
|
+
...this.snapshotStatus,
|
|
206
|
+
lastKey: this.snapshotStatus.lastKey?.slice() ?? null
|
|
207
|
+
};
|
|
172
208
|
return copy;
|
|
173
209
|
}
|
|
174
210
|
|
|
@@ -183,3 +219,11 @@ export class SourceTable {
|
|
|
183
219
|
}
|
|
184
220
|
}
|
|
185
221
|
}
|
|
222
|
+
|
|
223
|
+
/**
|
|
224
|
+
* A cloned SourceTable exposed to reconciliation with public fields typed as read-only.
|
|
225
|
+
* `options` is omitted so callers cannot mutate the underlying option bag without an explicit cast.
|
|
226
|
+
*/
|
|
227
|
+
export type SourceTableCandidate = Omit<Readonly<SourceTable>, 'options' | 'withSourceMetadata'> & {
|
|
228
|
+
withSourceMetadata(sourceMetadata: JsonValue): SourceTableCandidate;
|
|
229
|
+
};
|