@powersync/service-core 0.0.0-dev-20250618131818 → 0.0.0-dev-20250714115156

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.
Files changed (78) hide show
  1. package/CHANGELOG.md +36 -4
  2. package/dist/auth/CachedKeyCollector.js +26 -2
  3. package/dist/auth/CachedKeyCollector.js.map +1 -1
  4. package/dist/auth/KeySpec.d.ts +1 -0
  5. package/dist/auth/KeySpec.js +12 -0
  6. package/dist/auth/KeySpec.js.map +1 -1
  7. package/dist/auth/KeyStore.js +2 -2
  8. package/dist/auth/KeyStore.js.map +1 -1
  9. package/dist/auth/RemoteJWKSCollector.js +6 -2
  10. package/dist/auth/RemoteJWKSCollector.js.map +1 -1
  11. package/dist/emitters/AbstractEmitterEngine.d.ts +13 -0
  12. package/dist/emitters/AbstractEmitterEngine.js +57 -0
  13. package/dist/emitters/AbstractEmitterEngine.js.map +1 -0
  14. package/dist/emitters/EmitterEngine.d.ts +12 -0
  15. package/dist/emitters/EmitterEngine.js +35 -0
  16. package/dist/emitters/EmitterEngine.js.map +1 -0
  17. package/dist/emitters/emitter-interfaces.d.ts +37 -0
  18. package/dist/emitters/emitter-interfaces.js +10 -0
  19. package/dist/emitters/emitter-interfaces.js.map +1 -0
  20. package/dist/emitters/event-error.d.ts +5 -0
  21. package/dist/emitters/event-error.js +8 -0
  22. package/dist/emitters/event-error.js.map +1 -0
  23. package/dist/emitters/events/connect-event.d.ts +10 -0
  24. package/dist/emitters/events/connect-event.js +32 -0
  25. package/dist/emitters/events/connect-event.js.map +1 -0
  26. package/dist/emitters/events/disconnect-event.d.ts +10 -0
  27. package/dist/emitters/events/disconnect-event.js +27 -0
  28. package/dist/emitters/events/disconnect-event.js.map +1 -0
  29. package/dist/emitters/events/index.d.ts +1 -0
  30. package/dist/emitters/events/index.js +4 -0
  31. package/dist/emitters/events/index.js.map +1 -0
  32. package/dist/replication/AbstractReplicator.d.ts +8 -2
  33. package/dist/replication/AbstractReplicator.js +25 -9
  34. package/dist/replication/AbstractReplicator.js.map +1 -1
  35. package/dist/routes/auth.d.ts +1 -21
  36. package/dist/routes/auth.js +1 -97
  37. package/dist/routes/auth.js.map +1 -1
  38. package/dist/routes/configure-rsocket.js +4 -2
  39. package/dist/routes/configure-rsocket.js.map +1 -1
  40. package/dist/routes/endpoints/sync-stream.js +23 -1
  41. package/dist/routes/endpoints/sync-stream.js.map +1 -1
  42. package/dist/routes/router.d.ts +1 -2
  43. package/dist/routes/router.js.map +1 -1
  44. package/dist/system/ServiceContext.d.ts +3 -0
  45. package/dist/system/ServiceContext.js +8 -1
  46. package/dist/system/ServiceContext.js.map +1 -1
  47. package/dist/util/config/compound-config-collector.js +0 -13
  48. package/dist/util/config/compound-config-collector.js.map +1 -1
  49. package/dist/util/config/types.d.ts +0 -12
  50. package/dist/util/util-index.d.ts +1 -0
  51. package/dist/util/util-index.js +1 -0
  52. package/dist/util/util-index.js.map +1 -1
  53. package/dist/util/version.d.ts +1 -0
  54. package/dist/util/version.js +3 -0
  55. package/dist/util/version.js.map +1 -0
  56. package/package.json +4 -4
  57. package/src/auth/CachedKeyCollector.ts +25 -3
  58. package/src/auth/KeySpec.ts +14 -0
  59. package/src/auth/KeyStore.ts +2 -2
  60. package/src/auth/RemoteJWKSCollector.ts +6 -2
  61. package/src/emitters/AbstractEmitterEngine.ts +64 -0
  62. package/src/emitters/EmitterEngine.ts +41 -0
  63. package/src/emitters/emitter-interfaces.ts +47 -0
  64. package/src/emitters/event-error.ts +10 -0
  65. package/src/emitters/events/connect-event.ts +34 -0
  66. package/src/emitters/events/disconnect-event.ts +36 -0
  67. package/src/emitters/events/index.ts +4 -0
  68. package/src/replication/AbstractReplicator.ts +30 -10
  69. package/src/routes/auth.ts +1 -124
  70. package/src/routes/configure-rsocket.ts +3 -2
  71. package/src/routes/endpoints/sync-stream.ts +25 -2
  72. package/src/routes/router.ts +0 -1
  73. package/src/system/ServiceContext.ts +11 -1
  74. package/src/util/config/compound-config-collector.ts +0 -16
  75. package/src/util/config/types.ts +0 -11
  76. package/src/util/util-index.ts +1 -0
  77. package/src/util/version.ts +3 -0
  78. package/tsconfig.tsbuildinfo +1 -1
@@ -1,4 +1,4 @@
1
- import { ErrorCode, errors, logger, router, schema } from '@powersync/lib-services-framework';
1
+ import { ErrorCode, errors, router, schema } from '@powersync/lib-services-framework';
2
2
  import { RequestParameters } from '@powersync/service-sync-rules';
3
3
  import { Readable } from 'stream';
4
4
 
@@ -9,6 +9,7 @@ import { authUser } from '../auth.js';
9
9
  import { routeDefinition } from '../router.js';
10
10
 
11
11
  import { APIMetric } from '@powersync/service-types';
12
+ import { EventNames } from '../../emitters/emitter-interfaces.js';
12
13
 
13
14
  export enum SyncRoutes {
14
15
  STREAM = '/sync/stream'
@@ -20,7 +21,7 @@ export const syncStreamed = routeDefinition({
20
21
  authorize: authUser,
21
22
  validator: schema.createTsCodecValidator(util.StreamingSyncRequest, { allowAdditional: true }),
22
23
  handler: async (payload) => {
23
- const { service_context, logger } = payload.context;
24
+ const { service_context, logger, token_payload } = payload.context;
24
25
  const { routerEngine, storageEngine, metricsEngine, syncContext } = service_context;
25
26
  const headers = payload.request.headers;
26
27
  const userAgent = headers['x-user-agent'] ?? headers['user-agent'];
@@ -34,6 +35,13 @@ export const syncStreamed = routeDefinition({
34
35
  user_id: payload.context.user_id
35
36
  };
36
37
 
38
+ const sdkData = {
39
+ client_id: clientId,
40
+ user_id: payload.context.user_id!,
41
+ user_agent: userAgent as string,
42
+ jwt_token: token_payload
43
+ };
44
+
37
45
  if (routerEngine.closed) {
38
46
  throw new errors.ServiceError({
39
47
  status: 503,
@@ -61,6 +69,11 @@ export const syncStreamed = routeDefinition({
61
69
  const tracker = new sync.RequestTracker(metricsEngine);
62
70
  try {
63
71
  metricsEngine.getUpDownCounter(APIMetric.CONCURRENT_CONNECTIONS).add(1);
72
+ service_context.emitterEngine.emitEvent(EventNames.SDK_CONNECT_EVENT, {
73
+ type: EventNames.SDK_CONNECT_EVENT,
74
+ ...sdkData,
75
+ connect_at: streamStart
76
+ });
64
77
  const stream = Readable.from(
65
78
  sync.transformToBytesTracked(
66
79
  sync.ndjson(
@@ -123,6 +136,11 @@ export const syncStreamed = routeDefinition({
123
136
  }
124
137
  controller.abort();
125
138
  metricsEngine.getUpDownCounter(APIMetric.CONCURRENT_CONNECTIONS).add(-1);
139
+ service_context.emitterEngine.emitEvent(EventNames.SDK_DISCONNECT_EVENT, {
140
+ type: EventNames.SDK_DISCONNECT_EVENT,
141
+ ...sdkData,
142
+ disconnect_at: Date.now()
143
+ });
126
144
  logger.info(`Sync stream complete`, {
127
145
  ...tracker.getLogMeta(),
128
146
  stream_ms: Date.now() - streamStart,
@@ -133,6 +151,11 @@ export const syncStreamed = routeDefinition({
133
151
  } catch (ex) {
134
152
  controller.abort();
135
153
  metricsEngine.getUpDownCounter(APIMetric.CONCURRENT_CONNECTIONS).add(-1);
154
+ service_context.emitterEngine.emitEvent(EventNames.SDK_DISCONNECT_EVENT, {
155
+ type: EventNames.SDK_DISCONNECT_EVENT,
156
+ ...sdkData,
157
+ disconnect_at: Date.now()
158
+ });
136
159
  }
137
160
  }
138
161
  });
@@ -17,7 +17,6 @@ export type Context = {
17
17
  service_context: RouterServiceContext;
18
18
 
19
19
  token_payload?: JwtPayload;
20
- token_error?: ServiceError;
21
20
  /**
22
21
  * Only on websocket endpoints.
23
22
  */
@@ -1,4 +1,4 @@
1
- import { LifeCycledSystem, MigrationManager, ServiceIdentifier, container } from '@powersync/lib-services-framework';
1
+ import { container, LifeCycledSystem, MigrationManager, ServiceIdentifier } from '@powersync/lib-services-framework';
2
2
 
3
3
  import { framework } from '../index.js';
4
4
  import * as metrics from '../metrics/MetricsEngine.js';
@@ -8,6 +8,8 @@ import * as routes from '../routes/routes-index.js';
8
8
  import * as storage from '../storage/storage-index.js';
9
9
  import { SyncContext } from '../sync/SyncContext.js';
10
10
  import * as utils from '../util/util-index.js';
11
+ import { EmitterEngine } from '../emitters/EmitterEngine.js';
12
+ import { events } from '../emitters/events/index.js';
11
13
 
12
14
  export interface ServiceContext {
13
15
  configuration: utils.ResolvedPowerSyncConfig;
@@ -19,6 +21,7 @@ export interface ServiceContext {
19
21
  migrations: PowerSyncMigrationManager;
20
22
  syncContext: SyncContext;
21
23
  serviceMode: ServiceContextMode;
24
+ emitterEngine: EmitterEngine;
22
25
  }
23
26
 
24
27
  export enum ServiceContextMode {
@@ -45,6 +48,7 @@ export class ServiceContextContainer implements ServiceContext {
45
48
  configuration: utils.ResolvedPowerSyncConfig;
46
49
  lifeCycleEngine: LifeCycledSystem;
47
50
  storageEngine: storage.StorageEngine;
51
+ emitterEngine: EmitterEngine;
48
52
  syncContext: SyncContext;
49
53
  routerEngine: routes.RouterEngine;
50
54
  serviceMode: ServiceContextMode;
@@ -66,6 +70,8 @@ export class ServiceContextContainer implements ServiceContext {
66
70
  }
67
71
  });
68
72
 
73
+ this.emitterEngine = new EmitterEngine(events, this.storageEngine);
74
+
69
75
  this.lifeCycleEngine.withLifecycle(this.storageEngine, {
70
76
  start: (storageEngine) => storageEngine.start(),
71
77
  stop: (storageEngine) => storageEngine.shutDown()
@@ -89,6 +95,10 @@ export class ServiceContextContainer implements ServiceContext {
89
95
  // Migrations should be executed before the system starts
90
96
  start: () => migrationManager[Symbol.asyncDispose]()
91
97
  });
98
+
99
+ this.lifeCycleEngine.withLifecycle(this.emitterEngine, {
100
+ stop: (emitterEngine) => emitterEngine.shutDown()
101
+ });
92
102
  }
93
103
 
94
104
  get replicationEngine(): replication.ReplicationEngine | null {
@@ -42,8 +42,6 @@ export type ConfigCollectorListener = {
42
42
  configCollected?: (event: ConfigCollectedEvent) => Promise<void>;
43
43
  };
44
44
 
45
- const POWERSYNC_DEV_KID = 'powersync-dev';
46
-
47
45
  const DEFAULT_COLLECTOR_OPTIONS: CompoundConfigCollectorOptions = {
48
46
  configCollectors: [new Base64ConfigCollector(), new FileSystemConfigCollector(), new FallbackConfigCollector()],
49
47
  syncRulesCollectors: [
@@ -117,13 +115,6 @@ export class CompoundConfigCollector {
117
115
  collectors.add(new auth.CachedKeyCollector(new auth.RemoteJWKSCollector(uri, { lookupOptions: jwksLookup })));
118
116
  }
119
117
 
120
- const baseDevKey = (baseConfig.client_auth?.jwks?.keys ?? []).find((key) => key.kid == POWERSYNC_DEV_KID);
121
-
122
- let devKey: auth.KeySpec | undefined;
123
- if (baseConfig.dev?.demo_auth && baseDevKey != null && baseDevKey.kty == 'oct') {
124
- devKey = await auth.KeySpec.importKey(baseDevKey);
125
- }
126
-
127
118
  const sync_rules = await this.collectSyncRules(baseConfig, runnerConfig);
128
119
 
129
120
  let jwt_audiences: string[] = baseConfig.client_auth?.audience ?? [];
@@ -138,14 +129,7 @@ export class CompoundConfigCollector {
138
129
  }
139
130
  },
140
131
  client_keystore: keyStore,
141
- // Dev tokens only use the static keys, no external key sources
142
- // We may restrict this even further to only the powersync-dev key.
143
- dev_client_keystore: new auth.KeyStore(staticCollector),
144
132
  api_tokens: baseConfig.api?.tokens ?? [],
145
- dev: {
146
- demo_auth: baseConfig.dev?.demo_auth ?? false,
147
- dev_key: devKey
148
- },
149
133
  port: baseConfig.port ?? 8080,
150
134
  sync_rules,
151
135
  jwt_audiences,
@@ -32,18 +32,7 @@ export type ResolvedPowerSyncConfig = {
32
32
  base_config: configFile.PowerSyncConfig;
33
33
  connections?: configFile.GenericDataSourceConfig[];
34
34
  storage: configFile.GenericStorageConfig;
35
- dev: {
36
- demo_auth: boolean;
37
- /**
38
- * Only present when demo_auth == true
39
- */
40
- dev_key?: KeySpec;
41
- };
42
35
  client_keystore: KeyStore<CompoundKeyCollector>;
43
- /**
44
- * Keystore for development tokens.
45
- */
46
- dev_client_keystore: KeyStore;
47
36
  port: number;
48
37
  sync_rules: SyncRulesConfig;
49
38
  api_tokens: string[];
@@ -6,6 +6,7 @@ export * from './protocol-types.js';
6
6
  export * from './secs.js';
7
7
  export * from './utils.js';
8
8
  export * from './checkpointing.js';
9
+ export * from './version.js';
9
10
 
10
11
  export * from './config.js';
11
12
  export * from './config/compound-config-collector.js';
@@ -0,0 +1,3 @@
1
+ import pkg from '../../package.json' with { type: 'json' };
2
+
3
+ export const POWERSYNC_VERSION = pkg.version;