@powersync/service-core 0.0.0-dev-20240620165206

package/dist/metrics/Metrics.d.ts

@@ -0,0 +1,30 @@
+import { Attributes, Counter, ObservableGauge, UpDownCounter } from '@opentelemetry/api';
+import { CorePowerSyncSystem } from '../system/CorePowerSyncSystem.js';
+export interface MetricsOptions {
+    disable_telemetry_sharing: boolean;
+    powersync_instance_id: string;
+    internal_metrics_endpoint: string;
+}
+export declare class Metrics {
+    private static instance;
+    private prometheusExporter;
+    private meterProvider;
+    data_replicated_bytes: Counter<Attributes>;
+    data_synced_bytes: Counter<Attributes>;
+    rows_replicated_total: Counter<Attributes>;
+    transactions_replicated_total: Counter<Attributes>;
+    chunks_replicated_total: Counter<Attributes>;
+    operations_synced_total: Counter<Attributes>;
+    replication_storage_size_bytes: ObservableGauge<Attributes>;
+    operation_storage_size_bytes: ObservableGauge<Attributes>;
+    parameter_storage_size_bytes: ObservableGauge<Attributes>;
+    concurrent_connections: UpDownCounter<Attributes>;
+    private constructor();
+    resetCounters(): void;
+    static getInstance(): Metrics;
+    static initialise(options: MetricsOptions): Promise<void>;
+    shutdown(): Promise<void>;
+    configureApiMetrics(): void;
+    configureReplicationMetrics(system: CorePowerSyncSystem): void;
+    getMetricValueForTests(name: string): Promise<number | undefined>;
+}

package/dist/metrics/Metrics.js

@@ -0,0 +1,176 @@
+import { ValueType } from '@opentelemetry/api';
+import { PrometheusExporter } from '@opentelemetry/exporter-prometheus';
+import { MeterProvider, PeriodicExportingMetricReader } from '@opentelemetry/sdk-metrics';
+import { OTLPMetricExporter } from '@opentelemetry/exporter-metrics-otlp-http';
+import * as jpgwire from '@powersync/service-jpgwire';
+import * as util from '../util/util-index.js';
+import { Resource } from '@opentelemetry/resources';
+import { logger } from '@powersync/lib-services-framework';
+export class Metrics {
+    constructor(meterProvider, prometheusExporter) {
+        this.meterProvider = meterProvider;
+        this.prometheusExporter = prometheusExporter;
+        const meter = meterProvider.getMeter('powersync');
+        this.data_replicated_bytes = meter.createCounter('powersync_data_replicated_bytes_total', {
+            description: 'Uncompressed size of replicated data',
+            unit: 'bytes',
+            valueType: ValueType.INT
+        });
+        this.data_synced_bytes = meter.createCounter('powersync_data_synced_bytes_total', {
+            description: 'Uncompressed size of synced data',
+            unit: 'bytes',
+            valueType: ValueType.INT
+        });
+        this.rows_replicated_total = meter.createCounter('powersync_rows_replicated_total', {
+            description: 'Total number of replicated rows',
+            valueType: ValueType.INT
+        });
+        this.transactions_replicated_total = meter.createCounter('powersync_transactions_replicated_total', {
+            description: 'Total number of replicated transactions',
+            valueType: ValueType.INT
+        });
+        this.chunks_replicated_total = meter.createCounter('powersync_chunks_replicated_total', {
+            description: 'Total number of replication chunks',
+            valueType: ValueType.INT
+        });
+        this.operations_synced_total = meter.createCounter('powersync_operations_synced_total', {
+            description: 'Number of operations synced',
+            valueType: ValueType.INT
+        });
+        this.replication_storage_size_bytes = meter.createObservableGauge('powersync_replication_storage_size_bytes', {
+            description: 'Size of current data stored in PowerSync',
+            unit: 'bytes',
+            valueType: ValueType.INT
+        });
+        this.operation_storage_size_bytes = meter.createObservableGauge('powersync_operation_storage_size_bytes', {
+            description: 'Size of operations stored in PowerSync',
+            unit: 'bytes',
+            valueType: ValueType.INT
+        });
+        this.parameter_storage_size_bytes = meter.createObservableGauge('powersync_parameter_storage_size_bytes', {
+            description: 'Size of parameter data stored in PowerSync',
+            unit: 'bytes',
+            valueType: ValueType.INT
+        });
+        this.concurrent_connections = meter.createUpDownCounter('powersync_concurrent_connections', {
+            description: 'Number of concurrent sync connections',
+            valueType: ValueType.INT
+        });
+    }
+    // Generally only useful for tests. Note: gauges are ignored here.
+    resetCounters() {
+        this.data_replicated_bytes.add(0);
+        this.data_synced_bytes.add(0);
+        this.rows_replicated_total.add(0);
+        this.transactions_replicated_total.add(0);
+        this.chunks_replicated_total.add(0);
+        this.operations_synced_total.add(0);
+        this.concurrent_connections.add(0);
+    }
+    static getInstance() {
+        if (!Metrics.instance) {
+            throw new Error('Metrics have not been initialised');
+        }
+        return Metrics.instance;
+    }
+    static async initialise(options) {
+        if (Metrics.instance) {
+            return;
+        }
+        logger.info('Configuring telemetry.');
+        logger.info(`
+Attention:
+PowerSync collects completely anonymous telemetry regarding usage.
+This information is used to shape our roadmap to better serve our customers.
+You can learn more, including how to opt-out if you'd not like to participate in this anonymous program, by visiting the following URL:
+https://docs.powersync.com/self-hosting/telemetry
+Anonymous telemetry is currently: ${options.disable_telemetry_sharing ? 'disabled' : 'enabled'}
+    `.trim());
+        const configuredExporters = [];
+        const port = util.env.METRICS_PORT ?? 0;
+        const prometheusExporter = new PrometheusExporter({ port: port, preventServerStart: true });
+        configuredExporters.push(prometheusExporter);
+        if (!options.disable_telemetry_sharing) {
+            logger.info('Sharing anonymous telemetry');
+            const periodicExporter = new PeriodicExportingMetricReader({
+                exporter: new OTLPMetricExporter({
+                    url: options.internal_metrics_endpoint
+                }),
+                exportIntervalMillis: 1000 * 60 * 5 // 5 minutes
+            });
+            configuredExporters.push(periodicExporter);
+        }
+        const meterProvider = new MeterProvider({
+            resource: new Resource({
+                ['service']: 'PowerSync',
+                ['instance_id']: options.powersync_instance_id
+            }),
+            readers: configuredExporters
+        });
+        if (port > 0) {
+            await prometheusExporter.startServer();
+        }
+        Metrics.instance = new Metrics(meterProvider, prometheusExporter);
+        logger.info('Telemetry configuration complete.');
+    }
+    async shutdown() {
+        await this.meterProvider.shutdown();
+    }
+    configureApiMetrics() {
+        // Initialize the metric, so that it reports a value before connections
+        // have been opened.
+        this.concurrent_connections.add(0);
+    }
+    configureReplicationMetrics(system) {
+        // Rate limit collection of these stats, since it may be an expensive query
+        const MINIMUM_INTERVAL = 60000;
+        let cachedRequest = undefined;
+        let cacheTimestamp = 0;
+        function getMetrics() {
+            if (cachedRequest == null || Date.now() - cacheTimestamp > MINIMUM_INTERVAL) {
+                cachedRequest = system.storage.getStorageMetrics().catch((e) => {
+                    logger.error(`Failed to get storage metrics`, e);
+                    return null;
+                });
+                cacheTimestamp = Date.now();
+            }
+            return cachedRequest;
+        }
+        this.operation_storage_size_bytes.addCallback(async (result) => {
+            const metrics = await getMetrics();
+            if (metrics) {
+                result.observe(metrics.operations_size_bytes);
+            }
+        });
+        this.parameter_storage_size_bytes.addCallback(async (result) => {
+            const metrics = await getMetrics();
+            if (metrics) {
+                result.observe(metrics.parameters_size_bytes);
+            }
+        });
+        this.replication_storage_size_bytes.addCallback(async (result) => {
+            const metrics = await getMetrics();
+            if (metrics) {
+                result.observe(metrics.replication_size_bytes);
+            }
+        });
+        const class_scoped_data_replicated_bytes = this.data_replicated_bytes;
+        // Record replicated bytes using global jpgwire metrics.
+        jpgwire.setMetricsRecorder({
+            addBytesRead(bytes) {
+                class_scoped_data_replicated_bytes.add(bytes);
+            }
+        });
+    }
+    async getMetricValueForTests(name) {
+        const metrics = await this.prometheusExporter.collect();
+        const scoped = metrics.resourceMetrics.scopeMetrics[0].metrics;
+        const metric = scoped.find((metric) => metric.descriptor.name == name);
+        if (metric == null) {
+            throw new Error(`Cannot find metric ${name}. Options: ${scoped.map((metric) => metric.descriptor.name).join(',')}`);
+        }
+        const point = metric.dataPoints[metric.dataPoints.length - 1];
+        return point?.value;
+    }
+}
+//# sourceMappingURL=Metrics.js.map

package/dist/metrics/Metrics.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Metrics.js","sourceRoot":"","sources":["../../src/metrics/Metrics.ts"],"names":[],"mappings":"AAAA,OAAO,EAAuD,SAAS,EAAE,MAAM,oBAAoB,CAAC;AACpG,OAAO,EAAE,kBAAkB,EAAE,MAAM,oCAAoC,CAAC;AACxE,OAAO,EAAE,aAAa,EAAgB,6BAA6B,EAAE,MAAM,4BAA4B,CAAC;AACxG,OAAO,EAAE,kBAAkB,EAAE,MAAM,2CAA2C,CAAC;AAC/E,OAAO,KAAK,OAAO,MAAM,4BAA4B,CAAC;AACtD,OAAO,KAAK,IAAI,MAAM,uBAAuB,CAAC;AAG9C,OAAO,EAAE,QAAQ,EAAE,MAAM,0BAA0B,CAAC;AACpD,OAAO,EAAE,MAAM,EAAE,MAAM,mCAAmC,CAAC;AAQ3D,MAAM,OAAO,OAAO;IA6ClB,YAAoB,aAA4B,EAAE,kBAAsC;QACtF,IAAI,CAAC,aAAa,GAAG,aAAa,CAAC;QACnC,IAAI,CAAC,kBAAkB,GAAG,kBAAkB,CAAC;QAC7C,MAAM,KAAK,GAAG,aAAa,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;QAElD,IAAI,CAAC,qBAAqB,GAAG,KAAK,CAAC,aAAa,CAAC,uCAAuC,EAAE;YACxF,WAAW,EAAE,sCAAsC;YACnD,IAAI,EAAE,OAAO;YACb,SAAS,EAAE,SAAS,CAAC,GAAG;SACzB,CAAC,CAAC;QAEH,IAAI,CAAC,iBAAiB,GAAG,KAAK,CAAC,aAAa,CAAC,mCAAmC,EAAE;YAChF,WAAW,EAAE,kCAAkC;YAC/C,IAAI,EAAE,OAAO;YACb,SAAS,EAAE,SAAS,CAAC,GAAG;SACzB,CAAC,CAAC;QAEH,IAAI,CAAC,qBAAqB,GAAG,KAAK,CAAC,aAAa,CAAC,iCAAiC,EAAE;YAClF,WAAW,EAAE,iCAAiC;YAC9C,SAAS,EAAE,SAAS,CAAC,GAAG;SACzB,CAAC,CAAC;QAEH,IAAI,CAAC,6BAA6B,GAAG,KAAK,CAAC,aAAa,CAAC,yCAAyC,EAAE;YAClG,WAAW,EAAE,yCAAyC;YACtD,SAAS,EAAE,SAAS,CAAC,GAAG;SACzB,CAAC,CAAC;QAEH,IAAI,CAAC,uBAAuB,GAAG,KAAK,CAAC,aAAa,CAAC,mCAAmC,EAAE;YACtF,WAAW,EAAE,oCAAoC;YACjD,SAAS,EAAE,SAAS,CAAC,GAAG;SACzB,CAAC,CAAC;QAEH,IAAI,CAAC,uBAAuB,GAAG,KAAK,CAAC,aAAa,CAAC,mCAAmC,EAAE;YACtF,WAAW,EAAE,6BAA6B;YAC1C,SAAS,EAAE,SAAS,CAAC,GAAG;SACzB,CAAC,CAAC;QAEH,IAAI,CAAC,8BAA8B,GAAG,KAAK,CAAC,qBAAqB,CAAC,0CAA0C,EAAE;YAC5G,WAAW,EAAE,0CAA0C;YACvD,IAAI,EAAE,OAAO;YACb,SAAS,EAAE,SAAS,CAAC,GAAG;SACzB,CAAC,CAAC;QAEH,IAAI,CAAC,4BAA4B,GAAG,KAAK,CAAC,qBAAqB,CAAC,wCAAwC,EAAE;YACxG,WAAW,EAAE,wCAAwC;YACrD,IAAI,EAAE,OAAO;YACb,SAAS,EAAE,SAAS,CAAC,GAAG;SACzB,CAAC,CAAC;QAEH,IAAI,CAAC,4BAA4B,GAAG,KAAK,CAAC,qBAAqB,CAAC,wCAAwC,EAAE;YACxG,WAAW,EAAE,4CAA4C;YACzD,IAAI,EAAE,OAAO;YACb,SAAS,EAAE,SAAS,CAAC,GAAG;SACzB,CAAC,CAAC;QAEH,IAAI,CAAC,sBAAsB,GAAG,KAAK,CAAC,mBAAmB,CAAC,kCAAkC,EAAE;YAC1F,WAAW,EAAE,uCAAuC;YACpD,SAAS,EAAE,SAAS,CAAC,GAAG;SACzB,CAAC,CAAC;IACL,CAAC;IAED,kEAAkE;IAClE,aAAa;QACX,IAAI,CAAC,qBAAqB,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;QAClC,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;QAC9B,IAAI,CAAC,qBAAqB,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;QAClC,IAAI,CAAC,6BAA6B,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;QAC1C,IAAI,CAAC,uBAAuB,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;QACpC,IAAI,CAAC,uBAAuB,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;QACpC,IAAI,CAAC,sBAAsB,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;IACrC,CAAC;IAEM,MAAM,CAAC,WAAW;QACvB,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE;YACrB,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAC;SACtD;QAED,OAAO,OAAO,CAAC,QAAQ,CAAC;IAC1B,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,OAAuB;QACpD,IAAI,OAAO,CAAC,QAAQ,EAAE;YACpB,OAAO;SACR;QACD,MAAM,CAAC,IAAI,CAAC,wBAAwB,CAAC,CAAC;QAEtC,MAAM,CAAC,IAAI,CACT;;;;;;oCAM8B,OAAO,CAAC,yBAAyB,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS;KACzF,CAAC,IAAI,EAAE,CACP,CAAC;QAEF,MAAM,mBAAmB,GAAmB,EAAE,CAAC;QAE/C,MAAM,IAAI,GAAW,IAAI,CAAC,GAAG,CAAC,YAAY,IAAI,CAAC,CAAC;QAChD,MAAM,kBAAkB,GAAG,IAAI,kBAAkB,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,kBAAkB,EAAE,IAAI,EAAE,CAAC,CAAC;QAC5F,mBAAmB,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;QAE7C,IAAI,CAAC,OAAO,CAAC,yBAAyB,EAAE;YACtC,MAAM,CAAC,IAAI,CAAC,6BAA6B,CAAC,CAAC;YAC3C,MAAM,gBAAgB,GAAG,IAAI,6BAA6B,CAAC;gBACzD,QAAQ,EAAE,IAAI,kBAAkB,CAAC;oBAC/B,GAAG,EAAE,OAAO,CAAC,yBAAyB;iBACvC,CAAC;gBACF,oBAAoB,EAAE,IAAI,GAAG,EAAE,GAAG,CAAC,CAAC,YAAY;aACjD,CAAC,CAAC;YAEH,mBAAmB,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;SAC5C;QAED,MAAM,aAAa,GAAG,IAAI,aAAa,CAAC;YACtC,QAAQ,EAAE,IAAI,QAAQ,CAAC;gBACrB,CAAC,SAAS,CAAC,EAAE,WAAW;gBACxB,CAAC,aAAa,CAAC,EAAE,OAAO,CAAC,qBAAqB;aAC/C,CAAC;YACF,OAAO,EAAE,mBAAmB;SAC7B,CAAC,CAAC;QAEH,IAAI,IAAI,GAAG,CAAC,EAAE;YACZ,MAAM,kBAAkB,CAAC,WAAW,EAAE,CAAC;SACxC;QAED,OAAO,CAAC,QAAQ,GAAG,IAAI,OAAO,CAAC,aAAa,EAAE,kBAAkB,CAAC,CAAC;QAElE,MAAM,CAAC,IAAI,CAAC,mCAAmC,CAAC,CAAC;IACnD,CAAC;IAEM,KAAK,CAAC,QAAQ;QACnB,MAAM,IAAI,CAAC,aAAa,CAAC,QAAQ,EAAE,CAAC;IACtC,CAAC;IAEM,mBAAmB;QACxB,uEAAuE;QACvE,oBAAoB;QACpB,IAAI,CAAC,sBAAsB,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;IACrC,CAAC;IAEM,2BAA2B,CAAC,MAA2B;QAC5D,2EAA2E;QAC3E,MAAM,gBAAgB,GAAG,KAAM,CAAC;QAEhC,IAAI,aAAa,GAAuD,SAAS,CAAC;QAClF,IAAI,cAAc,GAAG,CAAC,CAAC;QAEvB,SAAS,UAAU;YACjB,IAAI,aAAa,IAAI,IAAI,IAAI,IAAI,CAAC,GAAG,EAAE,GAAG,cAAc,GAAG,gBAAgB,EAAE;gBAC3E,aAAa,GAAG,MAAM,CAAC,OAAO,CAAC,iBAAiB,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE;oBAC7D,MAAM,CAAC,KAAK,CAAC,+BAA+B,EAAE,CAAC,CAAC,CAAC;oBACjD,OAAO,IAAI,CAAC;gBACd,CAAC,CAAC,CAAC;gBACH,cAAc,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;aAC7B;YACD,OAAO,aAAa,CAAC;QACvB,CAAC;QAED,IAAI,CAAC,4BAA4B,CAAC,WAAW,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE;YAC7D,MAAM,OAAO,GAAG,MAAM,UAAU,EAAE,CAAC;YACnC,IAAI,OAAO,EAAE;gBACX,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,qBAAqB,CAAC,CAAC;aAC/C;QACH,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,4BAA4B,CAAC,WAAW,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE;YAC7D,MAAM,OAAO,GAAG,MAAM,UAAU,EAAE,CAAC;YACnC,IAAI,OAAO,EAAE;gBACX,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,qBAAqB,CAAC,CAAC;aAC/C;QACH,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,8BAA8B,CAAC,WAAW,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE;YAC/D,MAAM,OAAO,GAAG,MAAM,UAAU,EAAE,CAAC;YACnC,IAAI,OAAO,EAAE;gBACX,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,sBAAsB,CAAC,CAAC;aAChD;QACH,CAAC,CAAC,CAAC;QAEH,MAAM,kCAAkC,GAAG,IAAI,CAAC,qBAAqB,CAAC;QACtE,wDAAwD;QACxD,OAAO,CAAC,kBAAkB,CAAC;YACzB,YAAY,CAAC,KAAK;gBAChB,kCAAkC,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;YAChD,CAAC;SACF,CAAC,CAAC;IACL,CAAC;IAEM,KAAK,CAAC,sBAAsB,CAAC,IAAY;QAC9C,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,kBAAkB,CAAC,OAAO,EAAE,CAAC;QACxD,MAAM,MAAM,GAAG,OAAO,CAAC,eAAe,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC;QAC/D,MAAM,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,UAAU,CAAC,IAAI,IAAI,IAAI,CAAC,CAAC;QACvE,IAAI,MAAM,IAAI,IAAI,EAAE;YAClB,MAAM,IAAI,KAAK,CACb,sBAAsB,IAAI,cAAc,MAAM,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CACnG,CAAC;SACH;QACD,MAAM,KAAK,GAAG,MAAM,CAAC,UAAU,CAAC,MAAM,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;QAC9D,OAAO,KAAK,EAAE,KAAe,CAAC;IAChC,CAAC;CACF"}

package/dist/migrations/db/migrations/1684951997326-init.d.ts

@@ -0,0 +1,3 @@
+import * as utils from '../../../util/util-index.js';
+export declare const up: (context?: utils.MigrationContext) => Promise<void>;
+export declare const down: (context?: utils.MigrationContext) => Promise<void>;

package/dist/migrations/db/migrations/1684951997326-init.js

@@ -0,0 +1,31 @@
+import * as mongo from '../../../db/mongo.js';
+import * as storage from '../../../storage/storage-index.js';
+import * as utils from '../../../util/util-index.js';
+export const up = async (context) => {
+    const config = await utils.loadConfig(context?.runner_config);
+    const database = storage.createPowerSyncMongo(config.storage);
+    await mongo.waitForAuth(database.db);
+    try {
+        await database.bucket_parameters.createIndex({
+            'key.g': 1,
+            lookup: 1,
+            _id: 1
+        }, { name: 'lookup1' });
+    }
+    finally {
+        await database.client.close();
+    }
+};
+export const down = async (context) => {
+    const config = await utils.loadConfig(context?.runner_config);
+    const database = storage.createPowerSyncMongo(config.storage);
+    try {
+        if (await database.bucket_parameters.indexExists('lookup')) {
+            await database.bucket_parameters.dropIndex('lookup1');
+        }
+    }
+    finally {
+        await database.client.close();
+    }
+};
+//# sourceMappingURL=1684951997326-init.js.map

package/dist/migrations/db/migrations/1684951997326-init.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"1684951997326-init.js","sourceRoot":"","sources":["../../../../src/migrations/db/migrations/1684951997326-init.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,MAAM,sBAAsB,CAAC;AAC9C,OAAO,KAAK,OAAO,MAAM,mCAAmC,CAAC;AAC7D,OAAO,KAAK,KAAK,MAAM,6BAA6B,CAAC;AAErD,MAAM,CAAC,MAAM,EAAE,GAAG,KAAK,EAAE,OAAgC,EAAE,EAAE;IAC3D,MAAM,MAAM,GAAG,MAAM,KAAK,CAAC,UAAU,CAAC,OAAO,EAAE,aAAa,CAAC,CAAC;IAC9D,MAAM,QAAQ,GAAG,OAAO,CAAC,oBAAoB,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IAC9D,MAAM,KAAK,CAAC,WAAW,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;IACrC,IAAI;QACF,MAAM,QAAQ,CAAC,iBAAiB,CAAC,WAAW,CAC1C;YACE,OAAO,EAAE,CAAC;YACV,MAAM,EAAE,CAAC;YACT,GAAG,EAAE,CAAC;SACP,EACD,EAAE,IAAI,EAAE,SAAS,EAAE,CACpB,CAAC;KACH;YAAS;QACR,MAAM,QAAQ,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC;KAC/B;AACH,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,IAAI,GAAG,KAAK,EAAE,OAAgC,EAAE,EAAE;IAC7D,MAAM,MAAM,GAAG,MAAM,KAAK,CAAC,UAAU,CAAC,OAAO,EAAE,aAAa,CAAC,CAAC;IAC9D,MAAM,QAAQ,GAAG,OAAO,CAAC,oBAAoB,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IAC9D,IAAI;QACF,IAAI,MAAM,QAAQ,CAAC,iBAAiB,CAAC,WAAW,CAAC,QAAQ,CAAC,EAAE;YAC1D,MAAM,QAAQ,CAAC,iBAAiB,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;SACvD;KACF;YAAS;QACR,MAAM,QAAQ,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC;KAC/B;AACH,CAAC,CAAC"}

package/dist/migrations/db/migrations/1688556755264-initial-sync-rules.d.ts

@@ -0,0 +1,2 @@
+export declare const up: () => Promise<void>;
+export declare const down: () => Promise<void>;

package/dist/migrations/db/migrations/1688556755264-initial-sync-rules.js

@@ -0,0 +1,5 @@
+export const up = async () => {
+    // No-op - we don't auto-create sync rules anymore
+};
+export const down = async () => { };
+//# sourceMappingURL=1688556755264-initial-sync-rules.js.map

package/dist/migrations/db/migrations/1688556755264-initial-sync-rules.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"1688556755264-initial-sync-rules.js","sourceRoot":"","sources":["../../../../src/migrations/db/migrations/1688556755264-initial-sync-rules.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,EAAE,GAAG,KAAK,IAAI,EAAE;IAC3B,kDAAkD;AACpD,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,IAAI,GAAG,KAAK,IAAI,EAAE,GAAE,CAAC,CAAC"}

package/dist/migrations/db/migrations/1702295701188-sync-rule-state.d.ts

@@ -0,0 +1,3 @@
+import * as utils from '../../../util/util-index.js';
+export declare const up: (context?: utils.MigrationContext) => Promise<void>;
+export declare const down: (context?: utils.MigrationContext) => Promise<void>;

package/dist/migrations/db/migrations/1702295701188-sync-rule-state.js

@@ -0,0 +1,54 @@
+import * as mongo from '../../../db/mongo.js';
+import * as storage from '../../../storage/storage-index.js';
+import * as utils from '../../../util/util-index.js';
+export const up = async (context) => {
+    const config = await utils.loadConfig(context?.runner_config);
+    const db = storage.createPowerSyncMongo(config.storage);
+    await mongo.waitForAuth(db.db);
+    try {
+        // We keep the old flags for existing deployments still shutting down.
+        // 1. New sync rules: `active = false, snapshot_done = false, replicating = true, auto_activate = true`
+        await db.sync_rules.updateMany({
+            active: { $ne: true },
+            replicating: true,
+            auto_activate: true
+        }, { $set: { state: storage.SyncRuleState.PROCESSING } });
+        // 2. Snapshot done: `active = true, snapshot_done = true, replicating = true, auto_activate = false`
+        await db.sync_rules.updateMany({
+            active: true
+        }, { $set: { state: storage.SyncRuleState.ACTIVE } });
+        // 3. Stopped: `active = false, snapshot_done = true, replicating = false, auto_activate = false`.
+        await db.sync_rules.updateMany({
+            active: { $ne: true },
+            replicating: { $ne: true },
+            auto_activate: { $ne: true }
+        }, { $set: { state: storage.SyncRuleState.STOP } });
+        const remaining = await db.sync_rules.find({ state: null }).toArray();
+        if (remaining.length > 0) {
+            const slots = remaining.map((doc) => doc.slot_name).join(', ');
+            throw new Error(`Invalid state for sync rules: ${slots}`);
+        }
+    }
+    finally {
+        await db.client.close();
+    }
+};
+export const down = async (context) => {
+    const config = await utils.loadConfig(context?.runner_config);
+    const db = storage.createPowerSyncMongo(config.storage);
+    try {
+        await db.sync_rules.updateMany({
+            state: storage.SyncRuleState.ACTIVE
+        }, { $set: { active: true, replicating: true } });
+        await db.sync_rules.updateMany({
+            state: storage.SyncRuleState.PROCESSING
+        }, { $set: { active: false, replicating: true, auto_activate: true } });
+        await db.sync_rules.updateMany({
+            $or: [{ state: storage.SyncRuleState.STOP }, { state: storage.SyncRuleState.TERMINATED }]
+        }, { $set: { active: false, replicating: false, auto_activate: false } });
+    }
+    finally {
+        await db.client.close();
+    }
+};
+//# sourceMappingURL=1702295701188-sync-rule-state.js.map

package/dist/migrations/db/migrations/1702295701188-sync-rule-state.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"1702295701188-sync-rule-state.js","sourceRoot":"","sources":["../../../../src/migrations/db/migrations/1702295701188-sync-rule-state.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,MAAM,sBAAsB,CAAC;AAC9C,OAAO,KAAK,OAAO,MAAM,mCAAmC,CAAC;AAC7D,OAAO,KAAK,KAAK,MAAM,6BAA6B,CAAC;AAuBrD,MAAM,CAAC,MAAM,EAAE,GAAG,KAAK,EAAE,OAAgC,EAAE,EAAE;IAC3D,MAAM,MAAM,GAAG,MAAM,KAAK,CAAC,UAAU,CAAC,OAAO,EAAE,aAAa,CAAC,CAAC;IAC9D,MAAM,EAAE,GAAG,OAAO,CAAC,oBAAoB,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IACxD,MAAM,KAAK,CAAC,WAAW,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;IAC/B,IAAI;QACF,sEAAsE;QAEtE,uGAAuG;QACvG,MAAM,EAAE,CAAC,UAAU,CAAC,UAAU,CAC5B;YACE,MAAM,EAAE,EAAE,GAAG,EAAE,IAAI,EAAE;YACrB,WAAW,EAAE,IAAI;YACjB,aAAa,EAAE,IAAI;SACpB,EACD,EAAE,IAAI,EAAE,EAAE,KAAK,EAAE,OAAO,CAAC,aAAa,CAAC,UAAU,EAAE,EAAE,CACtD,CAAC;QAEF,qGAAqG;QACrG,MAAM,EAAE,CAAC,UAAU,CAAC,UAAU,CAC5B;YACE,MAAM,EAAE,IAAI;SACb,EACD,EAAE,IAAI,EAAE,EAAE,KAAK,EAAE,OAAO,CAAC,aAAa,CAAC,MAAM,EAAE,EAAE,CAClD,CAAC;QAEF,kGAAkG;QAClG,MAAM,EAAE,CAAC,UAAU,CAAC,UAAU,CAC5B;YACE,MAAM,EAAE,EAAE,GAAG,EAAE,IAAI,EAAE;YACrB,WAAW,EAAE,EAAE,GAAG,EAAE,IAAI,EAAE;YAC1B,aAAa,EAAE,EAAE,GAAG,EAAE,IAAI,EAAE;SAC7B,EACD,EAAE,IAAI,EAAE,EAAE,KAAK,EAAE,OAAO,CAAC,aAAa,CAAC,IAAI,EAAE,EAAE,CAChD,CAAC;QAEF,MAAM,SAAS,GAAG,MAAM,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,IAAW,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC;QAC7E,IAAI,SAAS,CAAC,MAAM,GAAG,CAAC,EAAE;YACxB,MAAM,KAAK,GAAG,SAAS,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAC/D,MAAM,IAAI,KAAK,CAAC,iCAAiC,KAAK,EAAE,CAAC,CAAC;SAC3D;KACF;YAAS;QACR,MAAM,EAAE,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC;KACzB;AACH,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,IAAI,GAAG,KAAK,EAAE,OAAgC,EAAE,EAAE;IAC7D,MAAM,MAAM,GAAG,MAAM,KAAK,CAAC,UAAU,CAAC,OAAO,EAAE,aAAa,CAAC,CAAC;IAE9D,MAAM,EAAE,GAAG,OAAO,CAAC,oBAAoB,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IACxD,IAAI;QACF,MAAM,EAAE,CAAC,UAAU,CAAC,UAAU,CAC5B;YACE,KAAK,EAAE,OAAO,CAAC,aAAa,CAAC,MAAM;SACpC,EACD,EAAE,IAAI,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,EAAE,CAC9C,CAAC;QAEF,MAAM,EAAE,CAAC,UAAU,CAAC,UAAU,CAC5B;YACE,KAAK,EAAE,OAAO,CAAC,aAAa,CAAC,UAAU;SACxC,EACD,EAAE,IAAI,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,WAAW,EAAE,IAAI,EAAE,aAAa,EAAE,IAAI,EAAE,EAAE,CACpE,CAAC;QAEF,MAAM,EAAE,CAAC,UAAU,CAAC,UAAU,CAC5B;YACE,GAAG,EAAE,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,aAAa,CAAC,IAAI,EAAE,EAAE,EAAE,KAAK,EAAE,OAAO,CAAC,aAAa,CAAC,UAAU,EAAE,CAAC;SAC1F,EACD,EAAE,IAAI,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,WAAW,EAAE,KAAK,EAAE,aAAa,EAAE,KAAK,EAAE,EAAE,CACtE,CAAC;KACH;YAAS;QACR,MAAM,EAAE,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC;KACzB;AACH,CAAC,CAAC"}

package/dist/migrations/db/migrations/1711543888062-write-checkpoint-index.d.ts

@@ -0,0 +1,3 @@
+import * as utils from '../../../util/util-index.js';
+export declare const up: (context?: utils.MigrationContext) => Promise<void>;
+export declare const down: (context?: utils.MigrationContext) => Promise<void>;

package/dist/migrations/db/migrations/1711543888062-write-checkpoint-index.js

@@ -0,0 +1,27 @@
+import * as storage from '../../../storage/storage-index.js';
+import * as utils from '../../../util/util-index.js';
+export const up = async (context) => {
+    const config = await utils.loadConfig(context?.runner_config);
+    const db = storage.createPowerSyncMongo(config.storage);
+    try {
+        await db.write_checkpoints.createIndex({
+            user_id: 1
+        }, { name: 'user_id' });
+    }
+    finally {
+        await db.client.close();
+    }
+};
+export const down = async (context) => {
+    const config = await utils.loadConfig(context?.runner_config);
+    const db = storage.createPowerSyncMongo(config.storage);
+    try {
+        if (await db.write_checkpoints.indexExists('user_id')) {
+            await db.write_checkpoints.dropIndex('user_id');
+        }
+    }
+    finally {
+        await db.client.close();
+    }
+};
+//# sourceMappingURL=1711543888062-write-checkpoint-index.js.map

package/dist/migrations/db/migrations/1711543888062-write-checkpoint-index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"1711543888062-write-checkpoint-index.js","sourceRoot":"","sources":["../../../../src/migrations/db/migrations/1711543888062-write-checkpoint-index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,OAAO,MAAM,mCAAmC,CAAC;AAC7D,OAAO,KAAK,KAAK,MAAM,6BAA6B,CAAC;AAErD,MAAM,CAAC,MAAM,EAAE,GAAG,KAAK,EAAE,OAAgC,EAAE,EAAE;IAC3D,MAAM,MAAM,GAAG,MAAM,KAAK,CAAC,UAAU,CAAC,OAAO,EAAE,aAAa,CAAC,CAAC;IAC9D,MAAM,EAAE,GAAG,OAAO,CAAC,oBAAoB,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IAExD,IAAI;QACF,MAAM,EAAE,CAAC,iBAAiB,CAAC,WAAW,CACpC;YACE,OAAO,EAAE,CAAC;SACX,EACD,EAAE,IAAI,EAAE,SAAS,EAAE,CACpB,CAAC;KACH;YAAS;QACR,MAAM,EAAE,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC;KACzB;AACH,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,IAAI,GAAG,KAAK,EAAE,OAAgC,EAAE,EAAE;IAC7D,MAAM,MAAM,GAAG,MAAM,KAAK,CAAC,UAAU,CAAC,OAAO,EAAE,aAAa,CAAC,CAAC;IAE9D,MAAM,EAAE,GAAG,OAAO,CAAC,oBAAoB,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IAExD,IAAI;QACF,IAAI,MAAM,EAAE,CAAC,iBAAiB,CAAC,WAAW,CAAC,SAAS,CAAC,EAAE;YACrD,MAAM,EAAE,CAAC,iBAAiB,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;SACjD;KACF;YAAS;QACR,MAAM,EAAE,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC;KACzB;AACH,CAAC,CAAC"}

package/dist/migrations/definitions.d.ts

@@ -0,0 +1,18 @@
+export type Migration = {
+    name: string;
+    up: () => Promise<void>;
+    down: () => Promise<void>;
+};
+export declare enum Direction {
+    Up = "up",
+    Down = "down"
+}
+export type ExecutedMigration = {
+    name: string;
+    direction: Direction;
+    timestamp: Date;
+};
+export type MigrationState = {
+    last_run: string;
+    log: ExecutedMigration[];
+};

package/dist/migrations/definitions.js

@@ -0,0 +1,6 @@
+export var Direction;
+(function (Direction) {
+    Direction["Up"] = "up";
+    Direction["Down"] = "down";
+})(Direction || (Direction = {}));
+//# sourceMappingURL=definitions.js.map

package/dist/migrations/definitions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"definitions.js","sourceRoot":"","sources":["../../src/migrations/definitions.ts"],"names":[],"mappings":"AAMA,MAAM,CAAN,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,sBAAS,CAAA;IACT,0BAAa,CAAA;AACf,CAAC,EAHW,SAAS,KAAT,SAAS,QAGpB"}

package/dist/migrations/executor.d.ts

@@ -0,0 +1,16 @@
+import * as defs from './definitions.js';
+import { MigrationStore } from './store/migration-store.js';
+type ExecuteParams = {
+    migrations: defs.Migration[];
+    state?: defs.MigrationState;
+    direction: defs.Direction;
+    count?: number;
+};
+export declare function execute(params: ExecuteParams): AsyncGenerator<defs.ExecutedMigration>;
+type WriteLogsParams = {
+    store: MigrationStore;
+    state?: defs.MigrationState;
+    log_stream: Iterable<defs.ExecutedMigration> | AsyncIterable<defs.ExecutedMigration>;
+};
+export declare const writeLogsToStore: (params: WriteLogsParams) => Promise<void>;
+export {};

package/dist/migrations/executor.js

@@ -0,0 +1,64 @@
+import { logger } from '@powersync/lib-services-framework';
+import * as defs from './definitions.js';
+export async function* execute(params) {
+    let migrations = [...params.migrations];
+    if (params.direction === defs.Direction.Down) {
+        migrations = migrations.reverse();
+    }
+    let index = 0;
+    if (params.state) {
+        // Find the index of the last run
+        index = migrations.findIndex((migration) => {
+            return migration.name === params.state.last_run;
+        });
+        if (index === -1) {
+            throw new Error(`The last run migration ${params.state?.last_run} was not found in the given set of migrations`);
+        }
+        // If we are migrating down then we want to include the last run migration, otherwise we want to start at the next one
+        if (params.direction === defs.Direction.Up) {
+            index += 1;
+        }
+    }
+    migrations = migrations.slice(index);
+    let i = 0;
+    for (const migration of migrations) {
+        if (params.count && params.count === i) {
+            return;
+        }
+        logger.info(`Executing ${migration.name} (${params.direction})`);
+        try {
+            switch (params.direction) {
+                case defs.Direction.Up: {
+                    await migration.up();
+                    break;
+                }
+                case defs.Direction.Down: {
+                    await migration.down();
+                    break;
+                }
+            }
+            logger.debug(`Success`);
+        }
+        catch (err) {
+            logger.error(`Failed`, err);
+            process.exit(1);
+        }
+        yield {
+            name: migration.name,
+            direction: params.direction,
+            timestamp: new Date()
+        };
+        i++;
+    }
+}
+export const writeLogsToStore = async (params) => {
+    const log = [...(params.state?.log || [])];
+    for await (const migration of params.log_stream) {
+        log.push(migration);
+        await params.store.save({
+            last_run: migration.name,
+            log: log
+        });
+    }
+};
+//# sourceMappingURL=executor.js.map

package/dist/migrations/executor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"executor.js","sourceRoot":"","sources":["../../src/migrations/executor.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,mCAAmC,CAAC;AAC3D,OAAO,KAAK,IAAI,MAAM,kBAAkB,CAAC;AAWzC,MAAM,CAAC,KAAK,SAAS,CAAC,CAAC,OAAO,CAAC,MAAqB;IAClD,IAAI,UAAU,GAAG,CAAC,GAAG,MAAM,CAAC,UAAU,CAAC,CAAC;IACxC,IAAI,MAAM,CAAC,SAAS,KAAK,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE;QAC5C,UAAU,GAAG,UAAU,CAAC,OAAO,EAAE,CAAC;KACnC;IAED,IAAI,KAAK,GAAG,CAAC,CAAC;IAEd,IAAI,MAAM,CAAC,KAAK,EAAE;QAChB,iCAAiC;QACjC,KAAK,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,SAAS,EAAE,EAAE;YACzC,OAAO,SAAS,CAAC,IAAI,KAAK,MAAM,CAAC,KAAM,CAAC,QAAQ,CAAC;QACnD,CAAC,CAAC,CAAC;QAEH,IAAI,KAAK,KAAK,CAAC,CAAC,EAAE;YAChB,MAAM,IAAI,KAAK,CAAC,0BAA0B,MAAM,CAAC,KAAK,EAAE,QAAQ,+CAA+C,CAAC,CAAC;SAClH;QAED,sHAAsH;QACtH,IAAI,MAAM,CAAC,SAAS,KAAK,IAAI,CAAC,SAAS,CAAC,EAAE,EAAE;YAC1C,KAAK,IAAI,CAAC,CAAC;SACZ;KACF;IAED,UAAU,GAAG,UAAU,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IAErC,IAAI,CAAC,GAAG,CAAC,CAAC;IACV,KAAK,MAAM,SAAS,IAAI,UAAU,EAAE;QAClC,IAAI,MAAM,CAAC,KAAK,IAAI,MAAM,CAAC,KAAK,KAAK,CAAC,EAAE;YACtC,OAAO;SACR;QAED,MAAM,CAAC,IAAI,CAAC,aAAa,SAAS,CAAC,IAAI,KAAK,MAAM,CAAC,SAAS,GAAG,CAAC,CAAC;QACjE,IAAI;YACF,QAAQ,MAAM,CAAC,SAAS,EAAE;gBACxB,KAAK,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;oBACtB,MAAM,SAAS,CAAC,EAAE,EAAE,CAAC;oBACrB,MAAM;iBACP;gBACD,KAAK,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;oBACxB,MAAM,SAAS,CAAC,IAAI,EAAE,CAAC;oBACvB,MAAM;iBACP;aACF;YACD,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;SACzB;QAAC,OAAO,GAAG,EAAE;YACZ,MAAM,CAAC,KAAK,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC;YAC5B,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;SACjB;QAED,MAAM;YACJ,IAAI,EAAE,SAAS,CAAC,IAAI;YACpB,SAAS,EAAE,MAAM,CAAC,SAAS;YAC3B,SAAS,EAAE,IAAI,IAAI,EAAE;SACtB,CAAC;QAEF,CAAC,EAAE,CAAC;KACL;AACH,CAAC;AAOD,MAAM,CAAC,MAAM,gBAAgB,GAAG,KAAK,EAAE,MAAuB,EAAiB,EAAE;IAC/E,MAAM,GAAG,GAAG,CAAC,GAAG,CAAC,MAAM,CAAC,KAAK,EAAE,GAAG,IAAI,EAAE,CAAC,CAAC,CAAC;IAC3C,IAAI,KAAK,EAAE,MAAM,SAAS,IAAI,MAAM,CAAC,UAAU,EAAE;QAC/C,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QACpB,MAAM,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC;YACtB,QAAQ,EAAE,SAAS,CAAC,IAAI;YACxB,GAAG,EAAE,GAAG;SACT,CAAC,CAAC;KACJ;AACH,CAAC,CAAC"}

package/dist/migrations/migrations-index.d.ts

@@ -0,0 +1,3 @@
+export * from './definitions.js';
+export * from './executor.js';
+export * from './migrations.js';

package/dist/migrations/migrations-index.js

@@ -0,0 +1,4 @@
+export * from './definitions.js';
+export * from './executor.js';
+export * from './migrations.js';
+//# sourceMappingURL=migrations-index.js.map

package/dist/migrations/migrations-index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"migrations-index.js","sourceRoot":"","sources":["../../src/migrations/migrations-index.ts"],"names":[],"mappings":"AAAA,cAAc,kBAAkB,CAAC;AACjC,cAAc,eAAe,CAAC;AAC9B,cAAc,iBAAiB,CAAC"}

package/dist/migrations/migrations.d.ts

@@ -0,0 +1,10 @@
+import * as util from '../util/util-index.js';
+import { Direction } from './definitions.js';
+export type MigrationOptions = {
+    direction: Direction;
+    runner_config: util.RunnerConfig;
+};
+/**
+ * Runs migration scripts exclusively using Mongo locks
+ */
+export declare const migrate: (options: MigrationOptions) => Promise<void>;

package/dist/migrations/migrations.js

@@ -0,0 +1,90 @@
+import * as fs from 'fs/promises';
+import * as path from 'path';
+import { fileURLToPath } from 'url';
+import * as db from '../db/db-index.js';
+import * as util from '../util/util-index.js';
+import * as locks from '../locks/locks-index.js';
+import { createMongoMigrationStore } from './store/migration-store.js';
+import { execute, writeLogsToStore } from './executor.js';
+const DEFAULT_MONGO_LOCK_COLLECTION = 'locks';
+const MONGO_LOCK_PROCESS = 'migrations';
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+const MIGRATIONS_DIR = path.join(__dirname, '/db/migrations');
+/**
+ * Loads migrations and injects a custom context for loading the specified
+ * runner configuration.
+ */
+const loadMigrations = async (dir, runner_config) => {
+    const files = await fs.readdir(dir);
+    const migrations = files.filter((file) => {
+        return path.extname(file) === '.js';
+    });
+    const context = {
+        runner_config
+    };
+    return await Promise.all(migrations.map(async (migration) => {
+        const module = await import(path.resolve(dir, migration));
+        return {
+            name: path.basename(migration).replace(path.extname(migration), ''),
+            up: () => module.up(context),
+            down: () => module.down(context)
+        };
+    }));
+};
+/**
+ * Runs migration scripts exclusively using Mongo locks
+ */
+export const migrate = async (options) => {
+    const { direction, runner_config } = options;
+    /**
+     * Try and get Mongo from config file.
+     * But this might not be available in Journey Micro as we use the standard Mongo.
+     */
+    const config = await util.loadConfig(runner_config);
+    const { storage } = config;
+    const client = db.mongo.createMongoClient(storage);
+    await client.connect();
+    const clientDB = client.db(storage.database);
+    const collection = clientDB.collection(DEFAULT_MONGO_LOCK_COLLECTION);
+    const manager = locks.createMongoLockManager(collection, {
+        name: MONGO_LOCK_PROCESS
+    });
+    // Only one process should execute this at a time.
+    const lockId = await manager.acquire();
+    if (!lockId) {
+        throw new Error('Could not acquire lock_id');
+    }
+    let isReleased = false;
+    const releaseLock = async () => {
+        if (isReleased) {
+            return;
+        }
+        await manager.release(lockId);
+        isReleased = true;
+    };
+    // For the case where the migration is terminated
+    process.addListener('beforeExit', releaseLock);
+    try {
+        const migrations = await loadMigrations(MIGRATIONS_DIR, runner_config);
+        // Use the provided config to connect to Mongo
+        const store = createMongoMigrationStore(client);
+        const state = await store.load();
+        const logStream = execute({
+            direction: direction,
+            migrations,
+            state
+        });
+        await writeLogsToStore({
+            log_stream: logStream,
+            store,
+            state
+        });
+    }
+    finally {
+        await releaseLock();
+        await client.close(true);
+        process.removeListener('beforeExit', releaseLock);
+    }
+};
+//# sourceMappingURL=migrations.js.map

package/dist/migrations/migrations.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"migrations.js","sourceRoot":"","sources":["../../src/migrations/migrations.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,aAAa,CAAC;AAClC,OAAO,KAAK,IAAI,MAAM,MAAM,CAAC;AAC7B,OAAO,EAAE,aAAa,EAAE,MAAM,KAAK,CAAC;AAEpC,OAAO,KAAK,EAAE,MAAM,mBAAmB,CAAC;AACxC,OAAO,KAAK,IAAI,MAAM,uBAAuB,CAAC;AAC9C,OAAO,KAAK,KAAK,MAAM,yBAAyB,CAAC;AAEjD,OAAO,EAAE,yBAAyB,EAAE,MAAM,4BAA4B,CAAC;AACvE,OAAO,EAAE,OAAO,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAC;AAE1D,MAAM,6BAA6B,GAAG,OAAO,CAAC;AAC9C,MAAM,kBAAkB,GAAG,YAAY,CAAC;AAExC,MAAM,UAAU,GAAG,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAClD,MAAM,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;AAE3C,MAAM,cAAc,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,gBAAgB,CAAC,CAAC;AAO9D;;;GAGG;AACH,MAAM,cAAc,GAAG,KAAK,EAAE,GAAW,EAAE,aAAgC,EAAE,EAAE;IAC7E,MAAM,KAAK,GAAG,MAAM,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IACpC,MAAM,UAAU,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE;QACvC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,KAAK,CAAC;IACtC,CAAC,CAAC,CAAC;IAEH,MAAM,OAAO,GAA0B;QACrC,aAAa;KACd,CAAC;IAEF,OAAO,MAAM,OAAO,CAAC,GAAG,CACtB,UAAU,CAAC,GAAG,CAAC,KAAK,EAAE,SAAS,EAAE,EAAE;QACjC,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,SAAS,CAAC,CAAC,CAAC;QAC1D,OAAO;YACL,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,EAAE,CAAC;YACnE,EAAE,EAAE,GAAG,EAAE,CAAC,MAAM,CAAC,EAAE,CAAC,OAAO,CAAC;YAC5B,IAAI,EAAE,GAAG,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC;SACjC,CAAC;IACJ,CAAC,CAAC,CACH,CAAC;AACJ,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,OAAO,GAAG,KAAK,EAAE,OAAyB,EAAE,EAAE;IACzD,MAAM,EAAE,SAAS,EAAE,aAAa,EAAE,GAAG,OAAO,CAAC;IAE7C;;;OAGG;IAEH,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC;IACpD,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC;IAE3B,MAAM,MAAM,GAAG,EAAE,CAAC,KAAK,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC;IACnD,MAAM,MAAM,CAAC,OAAO,EAAE,CAAC;IAEvB,MAAM,QAAQ,GAAG,MAAM,CAAC,EAAE,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;IAC7C,MAAM,UAAU,GAAG,QAAQ,CAAC,UAAU,CAAa,6BAA6B,CAAC,CAAC;IAElF,MAAM,OAAO,GAAG,KAAK,CAAC,sBAAsB,CAAC,UAAU,EAAE;QACvD,IAAI,EAAE,kBAAkB;KACzB,CAAC,CAAC;IAEH,kDAAkD;IAClD,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,OAAO,EAAE,CAAC;IAEvC,IAAI,CAAC,MAAM,EAAE;QACX,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAC;KAC9C;IAED,IAAI,UAAU,GAAG,KAAK,CAAC;IACvB,MAAM,WAAW,GAAG,KAAK,IAAI,EAAE;QAC7B,IAAI,UAAU,EAAE;YACd,OAAO;SACR;QACD,MAAM,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QAC9B,UAAU,GAAG,IAAI,CAAC;IACpB,CAAC,CAAC;IAEF,iDAAiD;IACjD,OAAO,CAAC,WAAW,CAAC,YAAY,EAAE,WAAW,CAAC,CAAC;IAE/C,IAAI;QACF,MAAM,UAAU,GAAG,MAAM,cAAc,CAAC,cAAc,EAAE,aAAa,CAAC,CAAC;QAEvE,8CAA8C;QAC9C,MAAM,KAAK,GAAG,yBAAyB,CAAC,MAAM,CAAC,CAAC;QAEhD,MAAM,KAAK,GAAG,MAAM,KAAK,CAAC,IAAI,EAAE,CAAC;QAEjC,MAAM,SAAS,GAAG,OAAO,CAAC;YACxB,SAAS,EAAE,SAAS;YACpB,UAAU;YACV,KAAK;SACN,CAAC,CAAC;QAEH,MAAM,gBAAgB,CAAC;YACrB,UAAU,EAAE,SAAS;YACrB,KAAK;YACL,KAAK;SACN,CAAC,CAAC;KACJ;YAAS;QACR,MAAM,WAAW,EAAE,CAAC;QACpB,MAAM,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QACzB,OAAO,CAAC,cAAc,CAAC,YAAY,EAAE,WAAW,CAAC,CAAC;KACnD;AACH,CAAC,CAAC"}

package/dist/migrations/store/migration-store.d.ts

@@ -0,0 +1,11 @@
+import Mongo from 'mongodb';
+import * as defs from '../definitions.js';
+export type MigrationStore = {
+    load: () => Promise<defs.MigrationState | undefined>;
+    save: (state: defs.MigrationState) => Promise<void>;
+};
+/**
+ * A custom store for node-migrate which is used to save and load migrations that have
+ * been operated on to mongo.
+ */
+export declare const createMongoMigrationStore: (client: Mongo.MongoClient) => MigrationStore;