Merge remote-tracking branch 'origin/main' into request-parameters

Author: rkistner

.changeset/loud-islands-argue.md

@@ -0,0 +1,6 @@
+---
+'@powersync/service-core': patch
+'powersync-open-service': patch
+---
+
+Add logging and hard exit to migration script

DEVELOP.md

@@ -20,16 +20,22 @@ pnpm build
 
 The PowerSync service requires Postgres and MongoDB server connections. These configuration details can be specified in a `powersync.yaml` (or JSON) configuration file.
 
-See the [Self hosting demo](https://github.com/powersync-ja/self-host-demo) for examples of starting these services.
+See the [Self hosting demo](https://github.com/powersync-ja/self-host-demo) for demos of starting these services.
 
 A quick method for running all required services with a handy backend and frontend is to run the following in a checked-out `self-host-demo` folder.
 
 ```bash
-docker compose up --scale powersync=0
+docker compose -f demos/nodejs/docker-compose.yaml up --scale powersync=0
 ```
 
 Note: The `mongo` hostname specified in the MongoDB replica set needs to be accessible by your host machine if using the Mongo service above.
 
+One method to obtain access is to add the following to `/etc/hosts` (on Unix-like operating systems)
+
+```
+127.0.0.1 mongo
+```
+
 This will start all the services defined in the Self hosting demo except for the PowerSync service - which will be started from this repository.
 
 ## Local Configuration

README.md

@@ -45,6 +45,6 @@ The service can be started using the public Docker image. See the image [notes](
 
 The PowerSync service code is located in the `service` folder. This project is used to build the `journeyapps/powersync-service` Docker image.
 
-# Notes
+# Developing
 
-This mono repo currently relies on `restricted` packages. Currently this repo can only be built in CI. These dependencies will be removed soon.
+See the [notes](./DEVELOP.md) for local development instructions.

packages/service-core/src/entry/commands/migrate-action.ts

@@ -3,6 +3,7 @@ import { Command } from 'commander';
 import { extractRunnerOptions, wrapConfigCommand } from './config-command.js';
 import { migrate } from '../../migrations/migrations.js';
 import { Direction } from '../../migrations/definitions.js';
+import { logger } from '@powersync/lib-services-framework';
 
 const COMMAND_NAME = 'migrate';
 
@@ -17,9 +18,16 @@ export function registerMigrationAction(program: Command) {
     .action(async (direction: Direction, options) => {
       const runnerConfig = extractRunnerOptions(options);
 
-      await migrate({
-        direction,
-        runner_config: runnerConfig
-      });
+      try {
+        await migrate({
+          direction,
+          runner_config: runnerConfig
+        });
+
+        process.exit(0);
+      } catch (e) {
+        logger.error(`Migration failure`, e);
+        process.exit(1);
+      }
     });
 }

packages/service-core/src/migrations/migrations.ts

@@ -8,6 +8,7 @@ import * as locks from '../locks/locks-index.js';
 import { Direction } from './definitions.js';
 import { createMongoMigrationStore } from './store/migration-store.js';
 import { execute, writeLogsToStore } from './executor.js';
+import { logger } from '@powersync/lib-services-framework';
 
 const DEFAULT_MONGO_LOCK_COLLECTION = 'locks';
 const MONGO_LOCK_PROCESS = 'migrations';
@@ -63,6 +64,7 @@ export const migrate = async (options: MigrationOptions) => {
   const { storage } = config;
 
   const client = db.mongo.createMongoClient(storage);
+  logger.info('Connecting to MongoDB');
   await client.connect();
 
   const clientDB = client.db(storage.database);
@@ -73,6 +75,7 @@ export const migrate = async (options: MigrationOptions) => {
   });
 
   // Only one process should execute this at a time.
+  logger.info('Acquiring lock');
   const lockId = await manager.acquire();
 
   if (!lockId) {
@@ -92,13 +95,15 @@ export const migrate = async (options: MigrationOptions) => {
   process.addListener('beforeExit', releaseLock);
 
   try {
+    logger.info('Loading migrations');
     const migrations = await loadMigrations(MIGRATIONS_DIR, runner_config);
 
     // Use the provided config to connect to Mongo
     const store = createMongoMigrationStore(clientDB);
 
     const state = await store.load();
 
+    logger.info('Running migrations');
     const logStream = execute({
       direction: direction,
       migrations,
@@ -111,8 +116,11 @@ export const migrate = async (options: MigrationOptions) => {
       state
     });
   } finally {
+    logger.info('Releasing lock');
     await releaseLock();
+    logger.info('Closing database');
     await client.close(true);
     process.removeListener('beforeExit', releaseLock);
+    logger.info('Done with migrations');
   }
 };