@powersync/node 0.0.0-dev-20250417091221 → 0.0.0-dev-20250418125956

package/README.md

@@ -56,6 +56,22 @@ contains everything you need to know to get started implementing PowerSync in yo
 
 A simple example using `@powersync/node` is available in the [`demos/example-node/`](../demos/example-node) directory.
 
+# Proxy Support
+
+This SDK supports HTTP, HTTPS, and WebSocket proxies via environment variables.
+
+## HTTP Connection Method
+
+Internally we probe the http environment variables and apply it to fetch requests ([undici](https://www.npmjs.com/package/undici/v/5.6.0))
+
+- Set the `HTTPS_PROXY` or `HTTP_PROXY` environment variable to automatically route HTTP requests through a proxy.
+
+## WEB Socket Connection Method
+
+Internally the [proxy-agent](https://www.npmjs.com/package/proxy-agent) dependency for WebSocket proxies, which has its own internal code for automatically picking up the appropriate environment variables:
+
+- Set the `WS_PROXY` or `WSS_PROXY` environment variable to route the webocket connections through a proxy.
+
 # Found a bug or need help?
 
 - Join our [Discord server](https://discord.gg/powersync) where you can browse topics from our community, ask questions, share feedback, or just say hello :)

package/lib/sync/stream/NodeRemote.d.ts

@@ -1,10 +1,13 @@
 import { ILogger } from 'js-logger';
 import { AbstractRemote, AbstractRemoteOptions, BSONImplementation, RemoteConnector } from '@powersync/common';
+import { ProxyAgent } from 'undici';
 export declare const STREAMING_POST_TIMEOUT_MS = 30000;
 export declare class NodeRemote extends AbstractRemote {
     protected connector: RemoteConnector;
     protected logger: ILogger;
+    protected agent: ProxyAgent | undefined;
     constructor(connector: RemoteConnector, logger?: ILogger, options?: Partial<AbstractRemoteOptions>);
+    protected createSocket(url: string): globalThis.WebSocket;
     getUserAgent(): string;
     getBSON(): Promise<BSONImplementation>;
 }

package/lib/sync/stream/NodeRemote.js

@@ -1,6 +1,9 @@
 import * as os from 'node:os';
 import { AbstractRemote, DEFAULT_REMOTE_LOGGER, FetchImplementationProvider } from '@powersync/common';
 import { BSON } from 'bson';
+import Agent from 'proxy-agent';
+import { ProxyAgent } from 'undici';
+import { WebSocket } from 'ws';
 export const STREAMING_POST_TIMEOUT_MS = 30_000;
 class NodeFetchProvider extends FetchImplementationProvider {
     getFetch() {
@@ -10,13 +13,32 @@ class NodeFetchProvider extends FetchImplementationProvider {
 export class NodeRemote extends AbstractRemote {
     connector;
     logger;
+    agent;
     constructor(connector, logger = DEFAULT_REMOTE_LOGGER, options) {
+        // Automatic env vars are not supported by undici
+        // proxy-agent does not work directly with dispatcher
+        const proxy = process.env.HTTPS_PROXY ?? process.env.HTTP_PROXY;
+        const agent = proxy ? new ProxyAgent(proxy) : undefined;
         super(connector, logger, {
             ...(options ?? {}),
-            fetchImplementation: options?.fetchImplementation ?? new NodeFetchProvider()
+            fetchImplementation: options?.fetchImplementation ?? new NodeFetchProvider(),
+            fetchOptions: {
+                dispatcher: agent
+            }
         });
         this.connector = connector;
         this.logger = logger;
+        this.agent = agent;
+    }
+    createSocket(url) {
+        return new WebSocket(url, {
+            // Undici does not seem to be compatible with ws, using `proxy-agent` instead.
+            // Automatically uses WS_PROXY or WSS_PROXY env vars
+            agent: new Agent.ProxyAgent(),
+            headers: {
+                'User-Agent': this.getUserAgent()
+            }
+        }); // This is compatible in Node environments
     }
     getUserAgent() {
         return [

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@powersync/node",
-  "version": "0.0.0-dev-20250417091221",
+  "version": "0.0.0-dev-20250418125956",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
     "access": "public"
@@ -36,14 +36,17 @@
   },
   "homepage": "https://docs.powersync.com/",
   "peerDependencies": {
-    "@powersync/common": "0.0.0-dev-20250417091221"
+    "@powersync/common": "0.0.0-dev-20250418125956"
   },
   "dependencies": {
     "@powersync/better-sqlite3": "^0.1.1",
     "async-lock": "^1.4.0",
     "bson": "^6.6.0",
     "comlink": "^4.4.2",
-    "@powersync/common": "0.0.0-dev-20250417091221"
+    "proxy-agent": "^6.5.0",
+    "undici": "^7.8.0",
+    "ws": "^8.18.1",
+    "@powersync/common": "0.0.0-dev-20250418125956"
   },
   "devDependencies": {
     "@types/async-lock": "^1.4.0",