@zero-server/grpc 0.9.1 → 0.9.3

package/lib/grpc/watch.js

@@ -0,0 +1,173 @@
+/**
+ * @module grpc/watch
+ * @description Proto file hot-reload for development.
+ *              Watches `.proto` files for changes using `fs.watch()` and
+ *              re-parses/re-registers gRPC services automatically.
+ *
+ *              **Dev-only** — disabled by default when `NODE_ENV=production`.
+ *
+ * @example
+ *   const { createApp, watchProto } = require('@zero-server/sdk');
+ *   const app = createApp();
+ *
+ *   watchProto(app, './protos/greeter.proto', 'Greeter', handlers, {
+ *       onReload: (schema) => console.log('Reloaded!'),
+ *   });
+ *
+ *   app.listen(50051, { http2: true });
+ */
+
+const fs = require('fs');
+const path = require('path');
+const log = require('../debug')('zero:grpc:watch');
+
+// Lazy-load proto parser
+let _parseProtoFile = null;
+function _getParser()
+{
+    if (!_parseProtoFile) _parseProtoFile = require('./proto').parseProtoFile;
+    return _parseProtoFile;
+}
+
+// -- Constants ---------------------------------------------------
+
+const DEFAULT_DEBOUNCE = 300; // ms
+
+// -- watchProto --------------------------------------------------
+
+/**
+ * Watch a `.proto` file and hot-reload the gRPC service on changes.
+ * Parses the file, registers the service, then watches for modifications.
+ *
+ * Disabled in production unless `opts.production` is `true`.
+ *
+ * @param {object} app - The zero-server App instance.
+ * @param {string} protoPath - Path to the `.proto` file.
+ * @param {string} serviceName - Service name to register.
+ * @param {Object<string, Function>} handlers - Method handlers map.
+ * @param {object} [opts] - Options.
+ * @param {Function[]} [opts.interceptors] - Per-service interceptors.
+ * @param {number} [opts.maxMessageSize] - Max incoming message size.
+ * @param {boolean} [opts.compress=false] - Compress outgoing messages.
+ * @param {number} [opts.debounce=300] - Debounce interval in ms.
+ * @param {boolean} [opts.production=false] - Allow in production.
+ * @param {Function} [opts.onReload] - `(schema) => void` callback after reload.
+ * @param {Function} [opts.onError] - `(err) => void` callback on parse/reload error.
+ * @returns {{ stop: () => void, schema: object }} Controller with `stop()` and current schema.
+ *
+ * @example
+ *   const watcher = watchProto(app, './hello.proto', 'Greeter', {
+ *       SayHello(call) { return { message: 'Hello ' + call.request.name }; },
+ *   });
+ *   // Later: watcher.stop();
+ */
+function watchProto(app, protoPath, serviceName, handlers, opts = {})
+{
+    if (!opts.production && process.env.NODE_ENV === 'production')
+    {
+        log.warn('watchProto disabled in production (set { production: true } to override)');
+        // Still do an initial load
+        const parseProtoFile = _getParser();
+        const schema = parseProtoFile(protoPath);
+        app.grpc(schema, serviceName, handlers, opts);
+        return { stop() {}, schema };
+    }
+
+    const debounceMs = opts.debounce || DEFAULT_DEBOUNCE;
+    const resolvedPath = path.resolve(protoPath);
+
+    const parseProtoFile = _getParser();
+    let currentSchema = null;
+
+    // Initial load
+    try
+    {
+        currentSchema = parseProtoFile(resolvedPath);
+        app.grpc(currentSchema, serviceName, handlers, opts);
+        log.info('proto loaded: %s → %s', resolvedPath, serviceName);
+    }
+    catch (err)
+    {
+        log.error('initial proto parse failed: %s', err.message);
+        if (typeof opts.onError === 'function') opts.onError(err);
+        else throw err;
+    }
+
+    // Debounced reload
+    let debounceTimer = null;
+
+    function _reload()
+    {
+        try
+        {
+            const schema = parseProtoFile(resolvedPath);
+
+            // Verify the service still exists in the schema
+            if (!schema.services[serviceName])
+            {
+                const err = new Error(`Service "${serviceName}" not found after reload`);
+                log.error(err.message);
+                if (typeof opts.onError === 'function') opts.onError(err);
+                return;
+            }
+
+            // Re-register: the grpc registry replaces the existing service entry
+            if (app._grpcRegistry)
+            {
+                app._grpcRegistry.addService(schema, serviceName, handlers, opts);
+            }
+
+            currentSchema = schema;
+            log.info('proto reloaded: %s', resolvedPath);
+
+            if (typeof opts.onReload === 'function') opts.onReload(schema);
+        }
+        catch (err)
+        {
+            log.error('proto reload failed: %s', err.message);
+            if (typeof opts.onError === 'function') opts.onError(err);
+        }
+    }
+
+    // Watch the file
+    let watcher;
+    try
+    {
+        watcher = fs.watch(resolvedPath, (eventType) =>
+        {
+            if (eventType !== 'change') return;
+
+            if (debounceTimer) clearTimeout(debounceTimer);
+            debounceTimer = setTimeout(_reload, debounceMs);
+        });
+
+        watcher.on('error', (err) =>
+        {
+            log.error('fs.watch error: %s', err.message);
+            if (typeof opts.onError === 'function') opts.onError(err);
+        });
+
+        log.info('watching proto file: %s', resolvedPath);
+    }
+    catch (err)
+    {
+        log.error('failed to watch proto file: %s', err.message);
+        if (typeof opts.onError === 'function') opts.onError(err);
+    }
+
+    return {
+        stop()
+        {
+            if (debounceTimer) clearTimeout(debounceTimer);
+            if (watcher) watcher.close();
+            log.info('stopped watching: %s', resolvedPath);
+        },
+        get schema() { return currentSchema; },
+    };
+}
+
+// -- Exports -------------------------------------------------
+
+module.exports = {
+    watchProto,
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zero-server/grpc",
-  "version": "0.9.1",
+  "version": "0.9.3",
   "description": "gRPC server, client, codec, framing, status, metadata, health, reflection, balancer.",
   "keywords": [
     "zero-server",
@@ -20,6 +20,8 @@
     "./package.json": "./package.json"
   },
   "files": [
+    "lib",
+    "types",
     "index.js",
     "index.d.ts",
     "README.md",
@@ -42,7 +44,12 @@
     "access": "public"
   },
   "sideEffects": false,
-  "dependencies": {
-    "@zero-server/sdk": "0.9.1"
+  "peerDependencies": {
+    "@zero-server/sdk": ">=0.9.3"
+  },
+  "peerDependenciesMeta": {
+    "@zero-server/sdk": {
+      "optional": true
+    }
   }
 }

package/types/app.d.ts

@@ -0,0 +1,223 @@
+/// <reference types="node" />
+
+import { Server as HttpServer } from 'http';
+import { Server as HttpsServer, ServerOptions as TlsOptions } from 'https';
+import { Http2Server, Http2SecureServer } from 'http2';
+import { Request } from './request';
+import { Response } from './response';
+import { RouterInstance, RouteChain, RouteInfo, RouteOptions, RouteHandler } from './router';
+import { MiddlewareFunction, ErrorHandlerFunction, NextFunction } from './middleware';
+import { WebSocketHandler, WebSocketOptions, WebSocketPool } from './websocket';
+import { SSEStream } from './sse';
+import { LifecycleState } from './lifecycle';
+import { MetricsRegistry, HealthCheckResult } from './observe';
+import { ProtoSchema, GrpcServiceOptions, GrpcInterceptor, GrpcHandler } from './grpc';
+
+export interface ListenOptions {
+    /** Create an HTTP/2 server. Combined with TLS options for h2 over TLS, or h2c (cleartext) otherwise. */
+    http2?: boolean;
+    /** Allow HTTP/1.1 fallback on HTTP/2 TLS servers (ALPN negotiation). Default: true. */
+    allowHTTP1?: boolean;
+}
+
+export interface App {
+    /** Internal router instance. */
+    router: RouterInstance;
+    /** Middleware stack. */
+    middlewares: MiddlewareFunction[];
+    /** Application-level locals, merged into every request/response locals. */
+    locals: Record<string, any>;
+
+    /**
+     * Register middleware or mount a sub-router.
+     */
+    use(fn: MiddlewareFunction): App;
+    use(path: string, fn: MiddlewareFunction): App;
+    use(path: string, router: RouterInstance): App;
+
+    /**
+     * Register a global error handler.
+     */
+    onError(fn: ErrorHandlerFunction): void;
+
+    /**
+     * Core request handler for use with `http.createServer()`.
+     */
+    handler(req: import('http').IncomingMessage, res: import('http').ServerResponse): void;
+
+    /**
+     * Start listening for connections.
+     * Pass `{ http2: true }` to create an HTTP/2 server (h2c cleartext or TLS with ALPN).
+     */
+    listen(port?: number, cb?: () => void): HttpServer;
+    listen(port: number, opts: TlsOptions, cb?: () => void): HttpsServer;
+    listen(port: number, opts: ListenOptions & { http2: true } & TlsOptions, cb?: () => void): Http2SecureServer;
+    listen(port: number, opts: ListenOptions & { http2: true }, cb?: () => void): Http2Server;
+    listen(port: number, opts: ListenOptions, cb?: () => void): HttpServer | HttpsServer | Http2Server | Http2SecureServer;
+
+    /**
+     * Gracefully close the server.
+     */
+    close(cb?: (err?: Error) => void): void;
+
+    /**
+     * Perform a full graceful shutdown.
+     */
+    shutdown(opts?: { timeout?: number }): Promise<void>;
+
+    /**
+     * Register a lifecycle event listener.
+     */
+    on(event: 'beforeShutdown' | 'shutdown', fn: () => void | Promise<void>): App;
+
+    /**
+     * Remove a lifecycle event listener.
+     */
+    off(event: 'beforeShutdown' | 'shutdown', fn: () => void | Promise<void>): App;
+
+    /**
+     * Register a WebSocket pool for graceful shutdown.
+     */
+    registerPool(pool: WebSocketPool): App;
+
+    /**
+     * Unregister a WebSocket pool from lifecycle management.
+     */
+    unregisterPool(pool: WebSocketPool): App;
+
+    /**
+     * Track an SSE stream for graceful shutdown.
+     */
+    trackSSE(stream: SSEStream): App;
+
+    /**
+     * Register an ORM Database for graceful shutdown.
+     */
+    registerDatabase(db: { close(): Promise<void> }): App;
+
+    /**
+     * Unregister an ORM Database from lifecycle management.
+     */
+    unregisterDatabase(db: { close(): Promise<void> }): App;
+
+    /**
+     * Configure the shutdown timeout in milliseconds.
+     */
+    shutdownTimeout(ms: number): App;
+
+    /**
+     * Current lifecycle state.
+     */
+    readonly lifecycleState: LifecycleState;
+
+    /**
+     * Register a liveness health check endpoint.
+     */
+    health(path?: string, checks?: Record<string, () => HealthCheckResult | boolean | Promise<HealthCheckResult | boolean>>): App;
+    health(checks?: Record<string, () => HealthCheckResult | boolean | Promise<HealthCheckResult | boolean>>): App;
+
+    /**
+     * Register a readiness health check endpoint.
+     */
+    ready(path?: string, checks?: Record<string, () => HealthCheckResult | boolean | Promise<HealthCheckResult | boolean>>): App;
+    ready(checks?: Record<string, () => HealthCheckResult | boolean | Promise<HealthCheckResult | boolean>>): App;
+
+    /**
+     * Register a custom health check.
+     */
+    addHealthCheck(name: string, fn: () => HealthCheckResult | boolean | Promise<HealthCheckResult | boolean>): App;
+
+    /**
+     * Get the application metrics registry.
+     */
+    metrics(): MetricsRegistry;
+
+    /**
+     * Mount a Prometheus metrics endpoint.
+     */
+    metricsEndpoint(path?: string, opts?: { registry?: MetricsRegistry }): App;
+
+    /**
+     * Register a WebSocket upgrade handler.
+     */
+    ws(path: string, handler: WebSocketHandler): void;
+    ws(path: string, opts: WebSocketOptions, handler: WebSocketHandler): void;
+
+    /**
+     * Register a gRPC service with handlers.
+     */
+    grpc(schema: ProtoSchema, serviceName: string, handlers: Record<string, GrpcHandler>, opts?: GrpcServiceOptions): App;
+
+    /**
+     * Add a global gRPC interceptor.
+     */
+    grpcInterceptor(fn: GrpcInterceptor): App;
+
+    /**
+     * Return a flat list of all registered routes.
+     */
+    routes(): RouteInfo[];
+
+    /**
+     * Register a route with a specific HTTP method.
+     */
+    route(method: string, path: string, ...handlers: (RouteOptions | RouteHandler)[]): App;
+
+    /**
+     * Get a setting value (1 arg) or set a setting value (2 args).
+     */
+    set(key: string): any;
+    set(key: string, val: any): App;
+
+    /**
+     * Get a setting value, or register a GET route.
+     * With 1 string arg: returns the setting value.
+     * With path + handlers: registers a GET route.
+     */
+    get(key: string): any;
+    get(path: string, ...handlers: (RouteOptions | RouteHandler)[]): App;
+
+    /**
+     * Enable a boolean setting (set to `true`).
+     */
+    enable(key: string): App;
+
+    /**
+     * Disable a boolean setting (set to `false`).
+     */
+    disable(key: string): App;
+
+    /**
+     * Check if a setting is truthy.
+     */
+    enabled(key: string): boolean;
+
+    /**
+     * Check if a setting is falsy.
+     */
+    disabled(key: string): boolean;
+
+    /**
+     * Register a parameter pre-processing handler.
+     */
+    param(name: string, fn: (req: Request, res: Response, next: NextFunction, value: string) => void): App;
+
+    /**
+     * Create a route group under a prefix with shared middleware.
+     */
+    group(prefix: string, ...args: [...MiddlewareFunction[], (router: RouterInstance) => void]): App;
+
+    /**
+     * Create a chainable route builder for the given path.
+     */
+    chain(path: string): RouteChain;
+
+    // HTTP method shortcuts
+    post(path: string, ...handlers: (RouteOptions | RouteHandler)[]): App;
+    put(path: string, ...handlers: (RouteOptions | RouteHandler)[]): App;
+    delete(path: string, ...handlers: (RouteOptions | RouteHandler)[]): App;
+    patch(path: string, ...handlers: (RouteOptions | RouteHandler)[]): App;
+    options(path: string, ...handlers: (RouteOptions | RouteHandler)[]): App;
+    head(path: string, ...handlers: (RouteOptions | RouteHandler)[]): App;
+    all(path: string, ...handlers: (RouteOptions | RouteHandler)[]): App;
+}