adding examples to enabled more collaboration

Author: leftieFriele

examples/failing.js

@@ -0,0 +1,29 @@
+import HttpClient, { HttpClientError } from '../lib/http-client.js';
+
+/**
+ * Example of the circuit breaker opening on a failing request.
+ */
+const client = new HttpClient();
+try {
+    await client.request({
+        origin: 'http://localhost:9099',
+        path: '/',
+        method: 'GET',
+    });
+} catch (_) {
+    // Mute the first one, next request should hit an open breaker
+}
+
+try {
+    await client.request({
+        origin: 'http://localhost:9099',
+        path: '/',
+        method: 'GET',
+    });
+} catch (err) {
+    if (err instanceof HttpClientError) {
+        if (err.code === HttpClientError.ServerDown) {
+            console.error('Server unavailable..');
+        }
+    }
+}

examples/success.js

@@ -0,0 +1,11 @@
+import HttpClient from '../lib/http-client.js';
+
+const client = new HttpClient();
+const response = await client.request({
+    origin: 'https://www.google.com',
+    path: '/',
+    method: 'GET',
+    maxRedirections: 0,
+});
+
+console.log(response.statusCode);

lib/http-client.js

@@ -76,7 +76,13 @@ export default class HttpClient {
     }
 
     async #request(options = {}) {
-        const { statusCode, headers, trailers, body } = await request(options);
+        const { statusCode, headers, trailers, body } = await request({
+            ...options,
+            dispatcher: new Agent({
+                keepAliveTimeout: 10,
+                keepAliveMaxTimeout: 10,
+            }),
+        });
 
         if (this.#throwOn400 && statusCode >= 400 && statusCode <= 499) {
             // Body must be consumed; https://github.com/nodejs/undici/issues/583#issuecomment-855384858
@@ -151,6 +157,7 @@ export default class HttpClient {
  * Error class for the client
  */
 export class HttpClientError extends Error {
+    static ServerDown = 'EOPENBREAKER';
     constructor(message, { code, cause, options }) {
         super(message);
         this.name = 'HttpClientError';