@hazeljs/discovery 0.2.0-alpha.1

package/LICENSE

@@ -0,0 +1,192 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   Copyright 2024 HazelJS Team
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+
+---
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+   "License" shall mean the terms and conditions for use, reproduction,
+   and distribution as defined by Sections 1 through 9 of this document.
+
+   "Licensor" shall mean the copyright owner or entity authorized by
+   the copyright owner that is granting the License.
+
+   "Legal Entity" shall mean the union of the acting entity and all
+   other entities that control, are controlled by, or are under common
+   control with that entity. For the purposes of this definition,
+   "control" means (i) the power, direct or indirect, to cause the
+   direction or management of such entity, whether by contract or
+   otherwise, or (ii) ownership of fifty percent (50%) or more of the
+   outstanding shares, or (iii) beneficial ownership of such entity.
+
+   "You" (or "Your") shall mean an individual or Legal Entity
+   exercising permissions granted by this License.
+
+   "Source" form shall mean the preferred form for making modifications,
+   including but not limited to software source code, documentation
+   source, and configuration files.
+
+   "Object" form shall mean any form resulting from mechanical
+   transformation or translation of a Source form, including but
+   not limited to compiled object code, generated documentation,
+   and conversions to other media types.
+
+   "Work" shall mean the work of authorship, whether in Source or
+   Object form, made available under the License, as indicated by a
+   copyright notice that is included in or attached to the work
+   (an example is provided in the Appendix below).
+
+   "Derivative Works" shall mean any work, whether in Source or Object
+   form, that is based on (or derived from) the Work and for which the
+   editorial revisions, annotations, elaborations, or other modifications
+   represent, as a whole, an original work of authorship. For the purposes
+   of this License, Derivative Works shall not include works that remain
+   separable from, or merely link (or bind by name) to the interfaces of,
+   the Work and Derivative Works thereof.
+
+   "Contribution" shall mean any work of authorship, including
+   the original version of the Work and any modifications or additions
+   to that Work or Derivative Works thereof, that is intentionally
+   submitted to Licensor for inclusion in the Work by the copyright owner
+   or by an individual or Legal Entity authorized to submit on behalf of
+   the copyright owner. For the purposes of this definition, "submitted"
+   means any form of electronic, verbal, or written communication sent
+   to the Licensor or its representatives, including but not limited to
+   communication on electronic mailing lists, source code control systems,
+   and issue tracking systems that are managed by, or on behalf of, the
+   Licensor for the purpose of discussing and improving the Work, but
+   excluding communication that is conspicuously marked or otherwise
+   designated in writing by the copyright owner as "Not a Contribution."
+
+   "Contributor" shall mean Licensor and any individual or Legal Entity
+   on behalf of whom a Contribution has been received by Licensor and
+   subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   copyright license to reproduce, prepare Derivative Works of,
+   publicly display, publicly perform, sublicense, and distribute the
+   Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   (except as stated in this section) patent license to make, have made,
+   use, offer to sell, sell, import, and otherwise transfer the Work,
+   where such license applies only to those patent claims licensable
+   by such Contributor that are necessarily infringed by their
+   Contribution(s) alone or by combination of their Contribution(s)
+   with the Work to which such Contribution(s) was submitted. If You
+   institute patent litigation against any entity (including a
+   cross-claim or counterclaim in a lawsuit) alleging that the Work
+   or a Contribution incorporated within the Work constitutes direct
+   or contributory patent infringement, then any patent licenses
+   granted to You under this License for that Work shall terminate
+   as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+   Work or Derivative Works thereof in any medium, with or without
+   modifications, and in Source or Object form, provided that You
+   meet the following conditions:
+
+   (a) You must give any other recipients of the Work or
+   Derivative Works a copy of this License; and
+
+   (b) You must cause any modified files to carry prominent notices
+   stating that You changed the files; and
+
+   (c) You must retain, in the Source form of any Derivative Works
+   that You distribute, all copyright, patent, trademark, and
+   attribution notices from the Source form of the Work,
+   excluding those notices that do not pertain to any part of
+   the Derivative Works; and
+
+   (d) If the Work includes a "NOTICE" text file as part of its
+   distribution, then any Derivative Works that You distribute must
+   include a readable copy of the attribution notices contained
+   within such NOTICE file, excluding those notices that do not
+   pertain to any part of the Derivative Works, in at least one
+   of the following places: within a NOTICE text file distributed
+   as part of the Derivative Works; within the Source form or
+   documentation, if provided along with the Derivative Works; or,
+   within a display generated by the Derivative Works, if and
+   wherever such third-party notices normally appear. The contents
+   of the NOTICE file are for informational purposes only and
+   do not modify the License. You may add Your own attribution
+   notices within Derivative Works that You distribute, alongside
+   or as an addendum to the NOTICE text from the Work, provided
+   that such additional attribution notices cannot be construed
+   as modifying the License.
+
+   You may add Your own copyright statement to Your modifications and
+   may provide additional or different license terms and conditions
+   for use, reproduction, or distribution of Your modifications, or
+   for any such Derivative Works as a whole, provided Your use,
+   reproduction, and distribution of the Work otherwise complies with
+   the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+   any Contribution intentionally submitted for inclusion in the Work
+   by You to the Licensor shall be under the terms and conditions of
+   this License, without any additional terms or conditions.
+   Notwithstanding the above, nothing herein shall supersede or modify
+   the terms of any separate license agreement you may have executed
+   with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+   names, trademarks, service marks, or product names of the Licensor,
+   except as required for reasonable and customary use in describing the
+   origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+   agreed to in writing, Licensor provides the Work (and each
+   Contributor provides its Contributions) on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied, including, without limitation, any warranties or conditions
+   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+   PARTICULAR PURPOSE. You are solely responsible for determining the
+   appropriateness of using or redistributing the Work and assume any
+   risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+   whether in tort (including negligence), contract, or otherwise,
+   unless required by applicable law (such as deliberate and grossly
+   negligent acts) or agreed to in writing, shall any Contributor be
+   liable to You for damages, including any direct, indirect, special,
+   incidental, or consequential damages of any character arising as a
+   result of this License or out of the use or inability to use the
+   Work (including but not limited to damages for loss of goodwill,
+   work stoppage, computer failure or malfunction, or any and all
+   other commercial damages or losses), even if such Contributor
+   has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+   the Work or Derivative Works thereof, You may choose to offer,
+   and charge a fee for, acceptance of support, warranty, indemnity,
+   or other liability obligations and/or rights consistent with this
+   License. However, in accepting such obligations, You may act only
+   on Your own behalf and on Your sole responsibility, not on behalf
+   of any other Contributor, and only if You agree to indemnify,
+   defend, and hold each Contributor harmless for any liability
+   incurred by, or claims asserted against, such Contributor by reason
+   of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS

package/README.md

@@ -0,0 +1,450 @@
+# @hazeljs/discovery
+
+**Microservices that find each other.**
+
+Service registry, health checks, load balancing. Round Robin, Least Connections, Zone Aware — 6 strategies. Memory, Redis, Consul, or Kubernetes. Eureka-style, without the Java.
+
+[![npm version](https://img.shields.io/npm/v/@hazeljs/discovery.svg)](https://www.npmjs.com/package/@hazeljs/discovery)
+[![npm downloads](https://img.shields.io/npm/dm/@hazeljs/discovery)](https://www.npmjs.com/package/@hazeljs/discovery)
+[![License: Apache-2.0](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://www.apache.org/licenses/LICENSE-2.0)
+
+## Features
+
+- **Service Registration & Discovery** - Automatic service registration with health checks
+- **Load Balancing** - 6 built-in strategies (Round Robin, Random, Least Connections, Weighted Round Robin, IP Hash, Zone Aware)
+- **Health Checks** - Automatic health monitoring with heartbeat
+- **Service Filtering** - Filter by zone, tags, metadata, and status
+- **Multiple Backends** - Memory (dev), Redis, Consul, Kubernetes
+- **Decorator Support** - Clean integration with HazelJS apps
+- **Caching** - Built-in service discovery caching with auto-refresh
+- **Auto-Cleanup** - Automatic removal of expired instances
+- **Smart Retries** - Only retries on transient/network errors, not client errors
+- **Pluggable Logging** - Bring your own logger or use the built-in console logger
+- **Config Validation** - Runtime validation of all configuration objects
+- **Graceful Shutdown** - Proper cleanup of intervals, connections, and resources
+
+## Installation
+
+```bash
+npm install @hazeljs/discovery
+```
+
+### Optional peer dependencies
+
+Install the backend you need:
+
+```bash
+# Redis backend
+npm install ioredis
+
+# Consul backend
+npm install consul
+
+# Kubernetes backend
+npm install @kubernetes/client-node
+```
+
+## Quick Start
+
+### 1. Register a Service
+
+```typescript
+import { ServiceRegistry } from '@hazeljs/discovery';
+
+const registry = new ServiceRegistry({
+  name: 'user-service',
+  port: 3000,
+  host: 'localhost',
+  healthCheckPath: '/health',
+  healthCheckInterval: 30000,
+  metadata: { version: '1.0.0' },
+  zone: 'us-east-1',
+  tags: ['api', 'users'],
+});
+
+await registry.register();
+
+// On shutdown
+await registry.deregister();
+```
+
+### 2. Discover Services
+
+```typescript
+import { DiscoveryClient } from '@hazeljs/discovery';
+
+const client = new DiscoveryClient({
+  cacheEnabled: true,
+  cacheTTL: 30000,
+  refreshInterval: 15000, // auto-refresh cache every 15s
+});
+
+// Get all instances
+const instances = await client.getInstances('user-service');
+
+// Get one instance with load balancing
+const instance = await client.getInstance('user-service', 'round-robin');
+
+// On shutdown
+client.close();
+```
+
+### 3. Call Services
+
+```typescript
+import { ServiceClient } from '@hazeljs/discovery';
+
+const serviceClient = new ServiceClient(discoveryClient, {
+  serviceName: 'user-service',
+  loadBalancingStrategy: 'round-robin',
+  timeout: 5000,
+  retries: 3,
+  retryDelay: 1000,
+});
+
+// Automatic service discovery + load balancing + smart retries
+const user = await serviceClient.get('/users/123');
+const created = await serviceClient.post('/users', { name: 'John' });
+```
+
+### 4. With HazelJS Decorators
+
+```typescript
+import { ServiceRegistryDecorator, InjectServiceClient } from '@hazeljs/discovery';
+
+@ServiceRegistryDecorator({
+  name: 'order-service',
+  port: 3001,
+  healthCheckPath: '/health',
+})
+export class AppModule {}
+
+@Injectable()
+export class OrderService {
+  constructor(
+    @InjectServiceClient('user-service')
+    private userClient: ServiceClient
+  ) {}
+
+  async createOrder(userId: string) {
+    const user = await this.userClient.get(`/users/${userId}`);
+    // ... create order
+  }
+}
+```
+
+## Load Balancing Strategies
+
+### Round Robin
+
+```typescript
+const instance = await client.getInstance('service-name', 'round-robin');
+```
+
+### Random
+
+```typescript
+const instance = await client.getInstance('service-name', 'random');
+```
+
+### Least Connections
+
+Tracks active connections per instance. When used with `ServiceClient`, connection counts are automatically incremented/decremented on each request.
+
+```typescript
+const instance = await client.getInstance('service-name', 'least-connections');
+```
+
+### Weighted Round Robin
+
+```typescript
+// Set weight in service metadata
+const registry = new ServiceRegistry({
+  name: 'api-service',
+  port: 3000,
+  metadata: { weight: 5 }, // Higher weight = more traffic
+});
+```
+
+### IP Hash (Sticky Sessions)
+
+```typescript
+const instance = await client.getInstance('service-name', 'ip-hash');
+```
+
+### Zone Aware
+
+```typescript
+const factory = client.getLoadBalancerFactory();
+const strategy = factory.create('zone-aware', { zone: 'us-east-1' });
+```
+
+## Service Filtering
+
+```typescript
+import { ServiceStatus } from '@hazeljs/discovery';
+
+const instances = await client.getInstances('user-service', {
+  zone: 'us-east-1',
+  status: ServiceStatus.UP,
+  tags: ['api', 'production'],
+  metadata: { version: '2.0.0' },
+});
+```
+
+The `applyServiceFilter` utility is also exported for use in custom backends or application code:
+
+```typescript
+import { applyServiceFilter } from '@hazeljs/discovery';
+
+const filtered = applyServiceFilter(instances, { zone: 'us-east-1' });
+```
+
+## Registry Backends
+
+### Memory (Development)
+
+The default backend. Stores everything in-process memory -- suitable for development and testing.
+
+```typescript
+import { MemoryRegistryBackend } from '@hazeljs/discovery';
+
+const backend = new MemoryRegistryBackend(90000); // optional expiration in ms
+const registry = new ServiceRegistry(config, backend);
+```
+
+### Redis (Production)
+
+Distributed registry using Redis with TTL-based expiration. Uses `SCAN` (not `KEYS`) for production safety and `MGET` for efficient batch lookups. Includes connection error handling with automatic reconnection support.
+
+```bash
+npm install ioredis
+```
+
+```typescript
+import Redis from 'ioredis';
+import { RedisRegistryBackend } from '@hazeljs/discovery';
+
+const redis = new Redis({
+  host: 'localhost',
+  port: 6379,
+  password: 'your-password',
+});
+
+const backend = new RedisRegistryBackend(redis, {
+  keyPrefix: 'myapp:discovery:', // default: 'hazeljs:discovery:'
+  ttl: 90, // seconds, default: 90
+});
+
+const registry = new ServiceRegistry(config, backend);
+
+// On shutdown
+await backend.close();
+```
+
+### Consul
+
+Integrates with HashiCorp Consul using TTL-based health checks.
+
+```bash
+npm install consul
+```
+
+```typescript
+import Consul from 'consul';
+import { ConsulRegistryBackend } from '@hazeljs/discovery';
+
+const consul = new Consul({
+  host: 'localhost',
+  port: 8500,
+});
+
+const backend = new ConsulRegistryBackend(consul, {
+  ttl: '30s',       // TTL check interval (supports "30s", "5m", "1h")
+  datacenter: 'dc1',
+});
+
+const registry = new ServiceRegistry(config, backend);
+
+// On shutdown
+await backend.close();
+```
+
+### Kubernetes
+
+Read-only discovery backend that integrates with Kubernetes Endpoints API. Registration, deregistration, heartbeat, and status updates are no-ops since Kubernetes manages these through its own primitives (Services, Endpoints, probes).
+
+```bash
+npm install @kubernetes/client-node
+```
+
+```typescript
+import { KubeConfig } from '@kubernetes/client-node';
+import { KubernetesRegistryBackend } from '@hazeljs/discovery';
+
+const kubeConfig = new KubeConfig();
+kubeConfig.loadFromDefault();
+
+const backend = new KubernetesRegistryBackend(kubeConfig, {
+  namespace: 'default',
+  labelSelector: 'app.kubernetes.io/managed-by=hazeljs',
+});
+
+// Use the backend for service discovery only
+const client = new DiscoveryClient({}, backend);
+```
+
+## Smart Retry Logic
+
+`ServiceClient` only retries on transient errors. Client errors (4xx) are thrown immediately without wasting retries:
+
+| Error Type | Retried? |
+|---|---|
+| Network errors (ECONNREFUSED, timeout) | Yes |
+| 502 Bad Gateway | Yes |
+| 503 Service Unavailable | Yes |
+| 504 Gateway Timeout | Yes |
+| 408 Request Timeout | Yes |
+| 429 Too Many Requests | Yes |
+| 400 Bad Request | No |
+| 401 Unauthorized | No |
+| 403 Forbidden | No |
+| 404 Not Found | No |
+| Other 4xx | No |
+
+## Custom Logging
+
+By default, the package logs to the console with a `[discovery]` prefix. You can plug in your own logger (e.g., Winston, Pino, Bunyan):
+
+```typescript
+import { DiscoveryLogger } from '@hazeljs/discovery';
+
+DiscoveryLogger.setLogger({
+  debug: (msg, ...args) => myLogger.debug(msg, ...args),
+  info: (msg, ...args) => myLogger.info(msg, ...args),
+  warn: (msg, ...args) => myLogger.warn(msg, ...args),
+  error: (msg, ...args) => myLogger.error(msg, ...args),
+});
+
+// Reset to default console logger
+DiscoveryLogger.resetLogger();
+```
+
+## Config Validation
+
+All configuration objects are validated at construction time. Invalid configs throw a `ConfigValidationError` with a descriptive message:
+
+```typescript
+import { ServiceRegistry, ConfigValidationError } from '@hazeljs/discovery';
+
+try {
+  const registry = new ServiceRegistry({
+    name: '',     // invalid: empty string
+    port: -1,     // invalid: negative port
+  });
+} catch (error) {
+  if (error instanceof ConfigValidationError) {
+    console.error(error.message);
+    // => 'ServiceRegistryConfig: "name" is required and must be a non-empty string'
+  }
+}
+```
+
+## API Reference
+
+### ServiceRegistry
+
+```typescript
+class ServiceRegistry {
+  constructor(config: ServiceRegistryConfig, backend?: RegistryBackend);
+  register(): Promise<void>;
+  deregister(): Promise<void>;
+  getInstance(): ServiceInstance | null;
+  getBackend(): RegistryBackend;
+}
+```
+
+### DiscoveryClient
+
+```typescript
+class DiscoveryClient {
+  constructor(config?: DiscoveryClientConfig, backend?: RegistryBackend);
+  getInstances(serviceName: string, filter?: ServiceFilter): Promise<ServiceInstance[]>;
+  getInstance(serviceName: string, strategy?: string, filter?: ServiceFilter): Promise<ServiceInstance | null>;
+  getAllServices(): Promise<string[]>;
+  clearCache(serviceName?: string): void;
+  getLoadBalancerFactory(): LoadBalancerFactory;
+  close(): void;
+}
+```
+
+### ServiceClient
+
+```typescript
+class ServiceClient {
+  constructor(discoveryClient: DiscoveryClient, config: ServiceClientConfig);
+  get<T>(path: string, config?: AxiosRequestConfig): Promise<AxiosResponse<T>>;
+  post<T>(path: string, data?: unknown, config?: AxiosRequestConfig): Promise<AxiosResponse<T>>;
+  put<T>(path: string, data?: unknown, config?: AxiosRequestConfig): Promise<AxiosResponse<T>>;
+  delete<T>(path: string, config?: AxiosRequestConfig): Promise<AxiosResponse<T>>;
+  patch<T>(path: string, data?: unknown, config?: AxiosRequestConfig): Promise<AxiosResponse<T>>;
+}
+```
+
+### Configuration Types
+
+```typescript
+interface ServiceRegistryConfig {
+  name: string;
+  port: number;
+  host?: string;
+  protocol?: 'http' | 'https' | 'grpc';
+  healthCheckPath?: string;       // default: '/health'
+  healthCheckInterval?: number;   // default: 30000 (ms)
+  metadata?: Record<string, unknown>;
+  zone?: string;
+  tags?: string[];
+}
+
+interface DiscoveryClientConfig {
+  cacheEnabled?: boolean;
+  cacheTTL?: number;           // default: 30000 (ms)
+  refreshInterval?: number;    // auto-refresh cache interval (ms)
+}
+
+interface ServiceClientConfig {
+  serviceName: string;
+  loadBalancingStrategy?: string;  // default: 'round-robin'
+  filter?: ServiceFilter;
+  timeout?: number;                // default: 5000 (ms)
+  retries?: number;                // default: 3
+  retryDelay?: number;             // default: 1000 (ms)
+}
+```
+
+## Examples
+
+See the [examples](./examples) directory for complete working examples.
+
+## Testing
+
+```bash
+npm test
+```
+
+The package includes 145+ unit tests across 9 test suites with 85%+ code coverage.
+
+## Contributing
+
+Contributions are welcome! Please read our [Contributing Guide](../../CONTRIBUTING.md) for details.
+
+## License
+
+Apache 2.0 &copy; [HazelJS](https://hazeljs.com)
+
+## Links
+
+- [Documentation](https://hazeljs.com/docs)
+- [GitHub](https://github.com/hazel-js/hazeljs)
+- [Issues](https://github.com/hazel-js/hazeljs/issues)
+- [Roadmap](../../ROADMAP_2.0.md)

package/dist/__tests__/consul-backend.test.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Consul Backend Tests
+ * Uses mocked Consul client
+ */
+export {};
+//# sourceMappingURL=consul-backend.test.d.ts.map

package/dist/__tests__/consul-backend.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"consul-backend.test.d.ts","sourceRoot":"","sources":["../../src/__tests__/consul-backend.test.ts"],"names":[],"mappings":"AAAA;;;GAGG"}