Expand details in database application name. (#293)

rkistner · web-flow · commit 61f48cdf11d4 · 2025-07-01T17:12:30.000+02:00
diff --git a/.changeset/slow-hounds-walk.md b/.changeset/slow-hounds-walk.md
@@ -1,10 +1,12 @@
 ---
 '@powersync/service-module-mongodb-storage': patch
+'@powersync/service-module-postgres-storage': patch
 '@powersync/service-module-mongodb': patch
+'@powersync/service-module-postgres': patch
 '@powersync/service-module-mysql': patch
 '@powersync/lib-service-mongodb': patch
-'@powersync/service-core': patch
-'@powersync/service-image': patch
+'@powersync/service-core': minor
+'@powersync/service-image': minor
 ---
 
-Add 'powersync' as the app name for MongoDB and MySQL connections.
+Add 'powersync' or 'powersync-storage' as the app name for database connections.
diff --git a/libs/lib-mongodb/src/db/mongo.ts b/libs/lib-mongodb/src/db/mongo.ts
@@ -29,7 +29,8 @@ export const MONGO_OPERATION_TIMEOUT_MS = 30_000;
 export const MONGO_CLEAR_OPERATION_TIMEOUT_MS = 5_000;
 
 export interface MongoConnectionOptions {
-  maxPoolSize: number;
+  maxPoolSize?: number;
+  powersyncVersion?: string;
 }
 
 /**
@@ -50,7 +51,12 @@ export function createMongoClient(config: BaseMongoConfigDecoded, options?: Mong
     serverSelectionTimeoutMS: 30_000,
 
     // Identify the client
-    appName: 'powersync-storage',
+    appName: options?.powersyncVersion ? `powersync-storage ${options.powersyncVersion}` : 'powersync-storage',
+    driverInfo: {
+      // This is merged with the node driver info.
+      name: 'powersync-storage',
+      version: options?.powersyncVersion
+    },
 
     lookup: normalized.lookup,
 
diff --git a/libs/lib-postgres/src/db/connection/ConnectionSlot.ts b/libs/lib-postgres/src/db/connection/ConnectionSlot.ts
@@ -19,6 +19,7 @@ export type ConnectionLease = {
 export type ConnectionSlotOptions = {
   config: pgwire.NormalizedConnectionConfig;
   notificationChannels?: string[];
+  applicationName: string;
 };
 
 export const MAX_CONNECTION_ATTEMPTS = 5;
@@ -46,7 +47,10 @@ export class ConnectionSlot extends framework.BaseObserver<ConnectionSlotListene
   }
 
   protected async connect() {
-    this.connectingPromise = pgwire.connectPgWire(this.options.config, { type: 'standard' });
+    this.connectingPromise = pgwire.connectPgWire(this.options.config, {
+      type: 'standard',
+      applicationName: this.options.applicationName
+    });
     const connection = await this.connectingPromise;
     this.connectingPromise = null;
     await this.iterateAsyncListeners(async (l) => l.connectionCreated?.(connection));
diff --git a/libs/lib-postgres/src/db/connection/DatabaseClient.ts b/libs/lib-postgres/src/db/connection/DatabaseClient.ts
@@ -15,6 +15,8 @@ export type DatabaseClientOptions = {
    * Notification channels to listen to.
    */
   notificationChannels?: string[];
+
+  applicationName: string;
 };
 
 export type DatabaseClientListener = NotificationListener & {
@@ -43,12 +45,17 @@ export class DatabaseClient extends AbstractPostgresConnection<DatabaseClientLis
     super();
     this.closed = false;
     this.pool = pgwire.connectPgWirePool(options.config, {
-      maxSize: options.config.max_pool_size
+      maxSize: options.config.max_pool_size,
+      applicationName: options.applicationName
     });
     this.connections = Array.from({ length: TRANSACTION_CONNECTION_COUNT }, (v, index) => {
       // Only listen to notifications on a single (the first) connection
       const notificationChannels = index == 0 ? options.notificationChannels : [];
-      const slot = new ConnectionSlot({ config: options.config, notificationChannels });
+      const slot = new ConnectionSlot({
+        config: options.config,
+        notificationChannels,
+        applicationName: options.applicationName
+      });
       slot.registerListener({
         connectionAvailable: () => this.processConnectionQueue(),
         connectionError: (ex) => this.handleConnectionError(ex),
diff --git a/modules/module-mongodb-storage/src/storage/implementation/MongoStorageProvider.ts b/modules/module-mongodb-storage/src/storage/implementation/MongoStorageProvider.ts
@@ -1,6 +1,6 @@
 import * as lib_mongo from '@powersync/lib-service-mongodb';
 import { ErrorCode, logger, ServiceAssertionError, ServiceError } from '@powersync/lib-services-framework';
-import { storage } from '@powersync/service-core';
+import { POWERSYNC_VERSION, storage } from '@powersync/service-core';
 import { MongoStorageConfig } from '../../types/types.js';
 import { MongoBucketStorage } from '../MongoBucketStorage.js';
 import { PowerSyncMongo } from './db.js';
@@ -23,6 +23,7 @@ export class MongoStorageProvider implements storage.BucketStorageProvider {
 
     const decodedConfig = MongoStorageConfig.decode(storage as any);
     const client = lib_mongo.db.createMongoClient(decodedConfig, {
+      powersyncVersion: POWERSYNC_VERSION,
       maxPoolSize: resolvedConfig.storage.max_pool_size ?? 8
     });
 
diff --git a/modules/module-mongodb-storage/src/storage/implementation/db.ts b/modules/module-mongodb-storage/src/storage/implementation/db.ts
@@ -1,6 +1,6 @@
 import * as lib_mongo from '@powersync/lib-service-mongodb';
 import { mongo } from '@powersync/lib-service-mongodb';
-import { storage } from '@powersync/service-core';
+import { POWERSYNC_VERSION, storage } from '@powersync/service-core';
 
 import { MongoStorageConfig } from '../../types/types.js';
 import {
@@ -130,5 +130,11 @@ export class PowerSyncMongo {
 }
 
 export function createPowerSyncMongo(config: MongoStorageConfig, options?: lib_mongo.MongoConnectionOptions) {
-  return new PowerSyncMongo(lib_mongo.createMongoClient(config, options), { database: config.database });
+  return new PowerSyncMongo(
+    lib_mongo.createMongoClient(config, {
+      powersyncVersion: POWERSYNC_VERSION,
+      ...options
+    }),
+    { database: config.database }
+  );
 }
diff --git a/modules/module-mongodb-storage/src/storage/implementation/util.ts b/modules/module-mongodb-storage/src/storage/implementation/util.ts
@@ -104,20 +104,13 @@ export function replicaIdToSubkey(table: bson.ObjectId, id: storage.ReplicaId):
   }
 }
 
-/**
- * Helper function for creating a MongoDB client from consumers of this package
- */
-const createMongoClient = (url: string, options?: mongo.MongoClientOptions) => {
-  return new mongo.MongoClient(url, options);
-};
-
 /**
  * Helper for unit tests
  */
 export const connectMongoForTests = (url: string, isCI: boolean) => {
   // Short timeout for tests, to fail fast when the server is not available.
   // Slightly longer timeouts for CI, to avoid arbitrary test failures
-  const client = createMongoClient(url, {
+  const client = new mongo.MongoClient(url, {
     connectTimeoutMS: isCI ? 15_000 : 5_000,
     socketTimeoutMS: isCI ? 15_000 : 5_000,
     serverSelectionTimeoutMS: isCI ? 15_000 : 2_500
diff --git a/modules/module-mongodb/src/replication/MongoManager.ts b/modules/module-mongodb/src/replication/MongoManager.ts
@@ -1,7 +1,7 @@
 import { mongo } from '@powersync/lib-service-mongodb';
 
 import { NormalizedMongoConnectionConfig } from '../types/types.js';
-import { BSON_DESERIALIZE_DATA_OPTIONS } from '@powersync/service-core';
+import { BSON_DESERIALIZE_DATA_OPTIONS, POWERSYNC_VERSION } from '@powersync/service-core';
 
 /**
  * Manage a MongoDB source database connection.
@@ -30,7 +30,12 @@ export class MongoManager {
       serverSelectionTimeoutMS: 30_000,
 
       // Identify the client
-      appName: 'powersync',
+      appName: `powersync ${POWERSYNC_VERSION}`,
+      driverInfo: {
+        // This is merged with the node driver info.
+        name: 'powersync',
+        version: POWERSYNC_VERSION
+      },
 
       // Avoid too many connections:
       // 1. It can overwhelm the source database.
diff --git a/modules/module-mysql/src/replication/BinLogReplicationJob.ts b/modules/module-mysql/src/replication/BinLogReplicationJob.ts
@@ -1,5 +1,5 @@
 import { container, logger as defaultLogger } from '@powersync/lib-services-framework';
-import { replication } from '@powersync/service-core';
+import { POWERSYNC_VERSION, replication } from '@powersync/service-core';
 import { BinlogConfigurationError, BinLogStream } from './BinLogStream.js';
 import { MySQLConnectionManagerFactory } from './MySQLConnectionManagerFactory.js';
 
@@ -61,7 +61,8 @@ export class BinLogReplicationJob extends replication.AbstractReplicationJob {
         // https://dev.mysql.com/doc/refman/8.0/en/performance-schema-connection-attribute-tables.html
         // These do not appear to be supported by Zongji yet, so we only specify it here.
         // Query using `select * from performance_schema.session_connect_attrs`.
-        program_name: 'powersync'
+        program_name: 'powersync',
+        program_version: POWERSYNC_VERSION
 
         // _client_name and _client_version is specified by the driver
       }
diff --git a/modules/module-postgres-storage/src/migrations/PostgresMigrationAgent.ts b/modules/module-postgres-storage/src/migrations/PostgresMigrationAgent.ts
@@ -6,6 +6,7 @@ import { fileURLToPath } from 'url';
 
 import { normalizePostgresStorageConfig, PostgresStorageConfigDecoded } from '../types/types.js';
 
+import { getStorageApplicationName } from '../utils/application-name.js';
 import { STORAGE_SCHEMA_NAME } from '../utils/db.js';
 import { PostgresMigrationStore } from './PostgresMigrationStore.js';
 
@@ -25,7 +26,8 @@ export class PostgresMigrationAgent extends migrations.AbstractPowerSyncMigratio
 
     this.db = new lib_postgres.DatabaseClient({
       config: normalizePostgresStorageConfig(config),
-      schema: STORAGE_SCHEMA_NAME
+      schema: STORAGE_SCHEMA_NAME,
+      applicationName: getStorageApplicationName()
     });
     this.store = new PostgresMigrationStore({
       db: this.db
diff --git a/modules/module-postgres-storage/src/migrations/migration-utils.ts b/modules/module-postgres-storage/src/migrations/migration-utils.ts
@@ -3,13 +3,15 @@ import { configFile } from '@powersync/service-types';
 import { isPostgresStorageConfig, normalizePostgresStorageConfig, PostgresStorageConfig } from '../types/types.js';
 import { STORAGE_SCHEMA_NAME } from '../utils/db.js';
 import { ServiceAssertionError } from '@powersync/lib-services-framework';
+import { getStorageApplicationName } from '../utils/application-name.js';
 
 export const openMigrationDB = (config: configFile.BaseStorageConfig) => {
   if (!isPostgresStorageConfig(config)) {
     throw new ServiceAssertionError(`Input storage configuration is not for Postgres`);
   }
   return new lib_postgres.DatabaseClient({
     config: normalizePostgresStorageConfig(PostgresStorageConfig.decode(config)),
-    schema: STORAGE_SCHEMA_NAME
+    schema: STORAGE_SCHEMA_NAME,
+    applicationName: getStorageApplicationName()
   });
 };
diff --git a/modules/module-postgres-storage/src/storage/PostgresBucketStorageFactory.ts b/modules/module-postgres-storage/src/storage/PostgresBucketStorageFactory.ts
@@ -12,6 +12,7 @@ import { NOTIFICATION_CHANNEL, STORAGE_SCHEMA_NAME } from '../utils/db.js';
 import { notifySyncRulesUpdate } from './batch/PostgresBucketBatch.js';
 import { PostgresSyncRulesStorage } from './PostgresSyncRulesStorage.js';
 import { PostgresPersistedSyncRulesContent } from './sync-rules/PostgresPersistedSyncRulesContent.js';
+import { getStorageApplicationName } from '../utils/application-name.js';
 
 export type PostgresBucketStorageOptions = {
   config: NormalizedPostgresStorageConfig;
@@ -32,7 +33,8 @@ export class PostgresBucketStorageFactory
     this.db = new lib_postgres.DatabaseClient({
       config: options.config,
       schema: STORAGE_SCHEMA_NAME,
-      notificationChannels: [NOTIFICATION_CHANNEL]
+      notificationChannels: [NOTIFICATION_CHANNEL],
+      applicationName: getStorageApplicationName()
     });
     this.slot_name_prefix = options.slot_name_prefix;
 
diff --git a/modules/module-postgres-storage/src/utils/application-name.ts b/modules/module-postgres-storage/src/utils/application-name.ts
@@ -0,0 +1,8 @@
+import { POWERSYNC_VERSION } from '@powersync/service-core';
+
+/**
+ * Name for postgres application_name, for bucket storage connections.
+ */
+export function getStorageApplicationName() {
+  return `powersync-storage/${POWERSYNC_VERSION}`;
+}
diff --git a/modules/module-postgres/src/api/PostgresRouteAPIAdapter.ts b/modules/module-postgres/src/api/PostgresRouteAPIAdapter.ts
@@ -8,6 +8,7 @@ import * as replication_utils from '../replication/replication-utils.js';
 import { getDebugTableInfo } from '../replication/replication-utils.js';
 import { KEEPALIVE_STATEMENT, PUBLICATION_NAME } from '../replication/WalStream.js';
 import * as types from '../types/types.js';
+import { getApplicationName } from '../utils/application-name.js';
 
 export class PostgresRouteAPIAdapter implements api.RouteAPI {
   connectionTag: string;
@@ -16,7 +17,8 @@ export class PostgresRouteAPIAdapter implements api.RouteAPI {
 
   static withConfig(config: types.ResolvedConnectionConfig) {
     const pool = pgwire.connectPgWirePool(config, {
-      idleTimeout: 30_000
+      idleTimeout: 30_000,
+      applicationName: getApplicationName()
     });
     return new PostgresRouteAPIAdapter(pool, config.tag, config);
   }
diff --git a/modules/module-postgres/src/auth/SupabaseKeyCollector.ts b/modules/module-postgres/src/auth/SupabaseKeyCollector.ts
@@ -5,6 +5,7 @@ import * as jose from 'jose';
 
 import * as types from '../types/types.js';
 import { AuthorizationError, ErrorCode } from '@powersync/lib-services-framework';
+import { getApplicationName } from '../utils/application-name.js';
 
 /**
  * Fetches key from the Supabase database.
@@ -28,7 +29,8 @@ export class SupabaseKeyCollector implements auth.KeyCollector {
       // limit to a single connection, and close the connection shortly
       // after using it.
       idleTimeout: 5_000,
-      maxSize: 1
+      maxSize: 1,
+      applicationName: getApplicationName()
     });
   }
 
diff --git a/modules/module-postgres/src/module/PostgresModule.ts b/modules/module-postgres/src/module/PostgresModule.ts
@@ -20,6 +20,7 @@ import * as types from '../types/types.js';
 import { PostgresConnectionConfig } from '../types/types.js';
 import { baseUri, NormalizedBasePostgresConnectionConfig } from '@powersync/lib-service-postgres';
 import { ReplicationMetric } from '@powersync/service-types';
+import { getApplicationName } from '../utils/application-name.js';
 
 export class PostgresModule extends replication.ReplicationModule<types.PostgresConnectionConfig> {
   constructor() {
@@ -88,7 +89,8 @@ export class PostgresModule extends replication.ReplicationModule<types.Postgres
     const normalisedConfig = this.resolveConfig(this.decodedConfig!);
     const connectionManager = new PgManager(normalisedConfig, {
       idleTimeout: 30_000,
-      maxSize: 1
+      maxSize: 1,
+      applicationName: getApplicationName()
     });
 
     try {
@@ -144,7 +146,8 @@ export class PostgresModule extends replication.ReplicationModule<types.Postgres
     // FIXME: This is not a complete implementation yet.
     const connectionManager = new PgManager(normalizedConfig, {
       idleTimeout: 30_000,
-      maxSize: 1
+      maxSize: 1,
+      applicationName: getApplicationName()
     });
     const connection = await connectionManager.snapshotConnection();
     try {
diff --git a/modules/module-postgres/src/replication/PgManager.ts b/modules/module-postgres/src/replication/PgManager.ts
@@ -1,6 +1,7 @@
 import * as pgwire from '@powersync/service-jpgwire';
 import semver from 'semver';
 import { NormalizedPostgresConnectionConfig } from '../types/types.js';
+import { getApplicationName } from '../utils/application-name.js';
 
 /**
  * Shorter timeout for snapshot connections than for replication connections.
@@ -31,7 +32,7 @@ export class PgManager {
    * Create a new replication connection.
    */
   async replicationConnection(): Promise<pgwire.PgConnection> {
-    const p = pgwire.connectPgWire(this.options, { type: 'replication' });
+    const p = pgwire.connectPgWire(this.options, { type: 'replication', applicationName: getApplicationName() });
     this.connectionPromises.push(p);
     return await p;
   }
@@ -51,7 +52,7 @@ export class PgManager {
    * This connection must not be shared between multiple async contexts.
    */
   async snapshotConnection(): Promise<pgwire.PgConnection> {
-    const p = pgwire.connectPgWire(this.options, { type: 'standard' });
+    const p = pgwire.connectPgWire(this.options, { type: 'standard', applicationName: getApplicationName() });
     this.connectionPromises.push(p);
     const connection = await p;
 
diff --git a/modules/module-postgres/src/replication/WalStreamReplicationJob.ts b/modules/module-postgres/src/replication/WalStreamReplicationJob.ts
@@ -4,6 +4,7 @@ import { MissingReplicationSlotError, sendKeepAlive, WalStream } from './WalStre
 
 import { replication } from '@powersync/service-core';
 import { ConnectionManagerFactory } from './ConnectionManagerFactory.js';
+import { getApplicationName } from '../utils/application-name.js';
 
 export interface WalStreamReplicationJobOptions extends replication.AbstractReplicationJobOptions {
   connectionFactory: ConnectionManagerFactory;
@@ -21,7 +22,8 @@ export class WalStreamReplicationJob extends replication.AbstractReplicationJob
     this.connectionManager = this.connectionFactory.create({
       // Pool connections are only used intermittently.
       idleTimeout: 30_000,
-      maxSize: 2
+      maxSize: 2,
+      applicationName: getApplicationName()
     });
   }
 
@@ -87,7 +89,8 @@ export class WalStreamReplicationJob extends replication.AbstractReplicationJob
     const connectionManager = this.connectionFactory.create({
       // Pool connections are only used intermittently.
       idleTimeout: 30_000,
-      maxSize: 2
+      maxSize: 2,
+      applicationName: getApplicationName()
     });
     try {
       await this.rateLimiter?.waitUntilAllowed({ signal: this.abortController.signal });
diff --git a/modules/module-postgres/src/replication/WalStreamReplicator.ts b/modules/module-postgres/src/replication/WalStreamReplicator.ts
@@ -1,8 +1,9 @@
 import { replication, storage } from '@powersync/service-core';
+import { PostgresModule } from '../module/PostgresModule.js';
+import { getApplicationName } from '../utils/application-name.js';
 import { ConnectionManagerFactory } from './ConnectionManagerFactory.js';
 import { cleanUpReplicationSlot } from './replication-utils.js';
 import { WalStreamReplicationJob } from './WalStreamReplicationJob.js';
-import { PostgresModule } from '../module/PostgresModule.js';
 
 export interface WalStreamReplicatorOptions extends replication.AbstractReplicatorOptions {
   connectionFactory: ConnectionManagerFactory;
@@ -29,6 +30,7 @@ export class WalStreamReplicator extends replication.AbstractReplicator<WalStrea
 
   async cleanUp(syncRulesStorage: storage.SyncRulesBucketStorage): Promise<void> {
     const connectionManager = this.connectionFactory.create({
+      applicationName: getApplicationName(),
       idleTimeout: 30_000,
       maxSize: 1
     });
diff --git a/modules/module-postgres/src/utils/application-name.ts b/modules/module-postgres/src/utils/application-name.ts
@@ -0,0 +1,8 @@
+import { POWERSYNC_VERSION } from '@powersync/service-core';
+
+/**
+ * application_name for PostgreSQL connections to the source database
+ */
+export function getApplicationName() {
+  return `powersync/${POWERSYNC_VERSION}`;
+}
diff --git a/modules/module-postgres/src/utils/populate_test_data_worker.ts b/modules/module-postgres/src/utils/populate_test_data_worker.ts
diff --git a/modules/module-postgres/test/src/util.ts b/modules/module-postgres/test/src/util.ts
diff --git a/packages/jpgwire/src/util.ts b/packages/jpgwire/src/util.ts
diff --git a/packages/service-core/src/util/util-index.ts b/packages/service-core/src/util/util-index.ts
diff --git a/packages/service-core/src/util/version.ts b/packages/service-core/src/util/version.ts
diff --git a/service/src/util/version.ts b/service/src/util/version.ts
