@jaredwray/mockhttp 0.4.1 → 0.4.2

package/README.md

@@ -16,6 +16,7 @@ A simple HTTP server that can be used to mock HTTP responses for testing purpose
 * Deploy via `docker` or `nodejs`
 * Global deployment via [mockhttp.org](https://mockhttp.org) (free service)
 * Better API documentation and examples
+* Auto detect the port that is not in use
 * Maintained and updated regularly!
 
 # Deploy via Docker
@@ -23,6 +24,29 @@ A simple HTTP server that can be used to mock HTTP responses for testing purpose
 docker run -d -p 3000:3000 jaredwray/mockhttp
 ```
 
+# Deploy via Docker Compose
+```yaml
+services:
+  mockhttp:
+    image: jaredwray/mockhttp:latest
+    ports:
+      - "3000:3000"
+```
+
+If you want to run it on a different port, just change the `3000` to whatever port you want and add in the environment variable `PORT` to the environment.
+
+```yaml
+services:
+  mockhttp:
+    image: jaredwray/mockhttp:latest
+    ports:
+      - "3001:3001"
+    environment:
+      - PORT=3001
+```
+
+You can see an example of this in the [docker-compose.yaml](docker-compose.yaml) file.
+
 # Deploy via NodeJS
 ```bash
 npm install @jaredwray/mockhttp --save
@@ -34,6 +58,7 @@ then run `mockhttp` in your code.
 import { mockhttp } from '@jaredwray/mockhttp';
 await mockhttp.start(); // start the server
 const response = await fetch('http://localhost:3000/get');
+console.log(reaponse);
 await mockhttp.stop(); // stop the server
 ```
 

package/dist/index.d.ts

@@ -1,5 +1,5 @@
-import { Hookified, HookifiedOptions } from 'hookified';
 import { FastifyInstance } from 'fastify';
+import { Hookified, HookifiedOptions } from 'hookified';
 
 type HttpBinOptions = {
     httpMethods?: boolean;
@@ -10,13 +10,18 @@ type HttpBinOptions = {
 };
 type MockHttpOptions = {
     /**
-     * The port to listen on. If not provided, defaults to 3000 and falls back to 3001 if the PORT is in use.
+     * The port to listen on. If not provided, defaults to 3000 and detects the next available port if in use.
      */
     port?: number;
     /**
      * The host to listen on. If not provided, defaults to '0.0.0.0'.
      */
     host?: string;
+    /**
+     * Whether to automatically detect the next available port if the provided port is in use. Defaults
+     * to true.
+     */
+    autoDetectPort?: boolean;
     /**
      * Whether to use Helmet for security headers. Defaults to true.
      */
@@ -37,30 +42,120 @@ type MockHttpOptions = {
 declare class MockHttp extends Hookified {
     private _port;
     private _host;
+    private _autoDetectPort;
     private _helmet;
     private _apiDocs;
     private _httpBin;
     private _server;
     constructor(options?: MockHttpOptions);
+    /**
+     * The port to listen on. If not provided, defaults to 3000 and detects the next available port if in use.
+     * @default 3000
+     */
     get port(): number;
+    /**
+     * The port to listen on. If not provided, defaults to 3000 and detects the next available port if in use.
+     * @default 3000
+     */
     set port(port: number);
+    /**
+     * The host to listen on. If not provided, defaults to 'localhost'.
+     * @default 'localhost'
+     */
     get host(): string;
+    /**
+     * The host to listen on. If not provided, defaults to 'localhost'.
+     * @default 'localhost'
+     */
     set host(host: string);
+    /**
+     * Whether to automatically detect the next available port if the provided port is in use. Defaults to true.
+     * @default true
+     */
+    get autoDetectPort(): boolean;
+    /**
+     * Whether to automatically detect the next available port if the provided port is in use. Defaults to true.
+     * @default true
+     */
+    set autoDetectPort(autoDetectPort: boolean);
+    /**
+     * Whether to use Helmet for security headers. Defaults to true.
+     * @default true
+     */
     get helmet(): boolean;
+    /**
+     * Whether to use Helmet for security headers. Defaults to true.
+     * @default true
+     */
     set helmet(helmet: boolean);
+    /**
+     * Whether to use Swagger for API documentation. Defaults to true.
+     * @default true
+     */
     get apiDocs(): boolean;
+    /**
+     * Whether to use Swagger for API documentation. Defaults to true.
+     * @default true
+     */
     set apiDocs(apiDocs: boolean);
+    /**
+     * HTTP Bin options. Defaults to all enabled.
+     */
     get httpBin(): HttpBinOptions;
+    /**
+     * HTTP Bin options. Defaults to all enabled.
+     */
     set httpBin(httpBinary: HttpBinOptions);
+    /**
+     * The Fastify server instance.
+     */
     get server(): FastifyInstance;
+    /**
+     * The Fastify server instance.
+     */
     set server(server: FastifyInstance);
+    /**
+     * Start the Fastify server. If the server is already running, it will be closed and restarted.
+     */
     start(): Promise<void>;
+    /**
+     * Close the Fastify server.
+     */
     close(): Promise<void>;
+    /**
+     * Detect the next available port to run on.
+     * @returns The port that is available to run on
+     */
+    detectPort(): Promise<number>;
+    /**
+     * This will register the API documentation routes including openapi and swagger ui.
+     * @param fastifyInstance - the server instance to register the routes on.
+     */
     registerApiDocs(fastifyInstance?: FastifyInstance): Promise<void>;
+    /**
+     * Register the HTTP methods routes.
+     * @param fastifyInstance - the server instance to register the routes on.
+     */
     registerHttpMethods(fastifyInstance?: FastifyInstance): Promise<void>;
+    /**
+     * Register the status code routes.
+     * @param fastifyInstance - the server instance to register the routes on.
+     */
     registerStatusCodeRoutes(fastifyInstance?: FastifyInstance): Promise<void>;
+    /**
+     * Register the request inspection routes.
+     * @param fastifyInstance - the server instance to register the routes on.
+     */
     registerRequestInspectionRoutes(fastifyInstance?: FastifyInstance): Promise<void>;
+    /**
+     * Register the response inspection routes.
+     * @param fastifyInstance - the server instance to register the routes on.
+     */
     registerResponseInspectionRoutes(fastifyInstance?: FastifyInstance): Promise<void>;
+    /**
+     * Register the redirect routes.
+     * @param fastifyInstance - the server instance to register the routes on.
+     */
     registerRedirectRoutes(fastifyInstance?: FastifyInstance): Promise<void>;
 }
 

package/dist/index.js

@@ -9,8 +9,9 @@ import path from "node:path";
 import fastifyStatic from "@fastify/static";
 import fastifyHelmet from "@fastify/helmet";
 import { fastifySwagger } from "@fastify/swagger";
-import { Hookified } from "hookified";
 import Fastify from "fastify";
+import { Hookified } from "hookified";
+import { detect } from "detect-port";
 
 // src/swagger.ts
 import { fastifySwaggerUi } from "@fastify/swagger-ui";
@@ -18,7 +19,7 @@ import { fastifySwaggerUi } from "@fastify/swagger-ui";
 // package.json
 var package_default = {
   name: "@jaredwray/mockhttp",
-  version: "0.4.1",
+  version: "0.4.2",
   description: "Mock Http - Easy way to mock http with httpbin replacement",
   type: "module",
   main: "dist/index.js",
@@ -34,7 +35,9 @@ var package_default = {
     "docker:push": "docker push jaredwray/mockhttp",
     "docker:stop": 'docker stop $(docker ps -a -q --filter ancestor=jaredwray/mockhttp --format="{{.ID}}")',
     "docker:readme": "tsx ./scripts/create-docker-readme.ts",
-    prepare: "npm run build",
+    "docker:compose:up": "docker-compose up -d",
+    "docker:compose:down": "docker-compose down",
+    prepare: "pnpm build",
     start: "node dist/index.js"
   },
   repository: {
@@ -54,14 +57,14 @@ var package_default = {
   },
   homepage: "https://github.com/jaredwray/mockhttp#readme",
   devDependencies: {
-    "@swc/core": "^1.11.5",
+    "@swc/core": "^1.11.16",
     "@types/html-escaper": "^3.0.4",
-    "@vitest/coverage-v8": "^3.0.7",
+    "@vitest/coverage-v8": "^3.1.1",
     rimraf: "^6.0.1",
     tsup: "^8.4.0",
     tsx: "^4.19.3",
-    typescript: "^5.8.2",
-    vitest: "^3.0.7",
+    typescript: "^5.8.3",
+    vitest: "^3.1.1",
     xo: "^0.60.0"
   },
   dependencies: {
@@ -69,9 +72,10 @@ var package_default = {
     "@fastify/static": "^8.1.1",
     "@fastify/swagger": "^9.4.2",
     "@fastify/swagger-ui": "^5.2.2",
-    "@scalar/api-reference": "^1.25.124",
-    fastify: "^5.2.1",
-    hookified: "^1.7.1",
+    "@scalar/api-reference": "^1.28.12",
+    "detect-port": "^2.1.0",
+    fastify: "^5.2.2",
+    hookified: "^1.8.1",
     "html-escaper": "^3.0.3",
     pino: "^9.6.0",
     "pino-pretty": "^13.0.0"
@@ -100,7 +104,7 @@ A simple HTTP server that can be used to mock HTTP responses for testing purpose
 
 # About mockhttp.org 
 
-[mockhttp.org](https://mockhttp.org) is a free service that runs this codebase and allows you to use it for testing purposes. It is a simple way to mock HTTP responses for testing purposes. It is globally available has some limitations on it to prevent abuse but many people will not see it. It is ran via [Cloudflare](https://cloudflare.com) and [Google Cloud Run](https://cloud.google.com/run/) across 7 regions globally and can do millions of requests per second.
+[mockhttp.org](https://mockhttp.org) is a free service that runs this codebase and allows you to use it for testing purposes. It is a simple way to mock HTTP responses for testing purposes. Ran via [Cloudflare](https://cloudflare.com) and [Google Cloud Run](https://cloud.google.com/run/) across 7 regions globally and can do millions of requests per second.
 `;
 var fastifySwaggerConfig = {
   openapi: {
@@ -1273,6 +1277,7 @@ var MockHttp = class extends Hookified {
   }
   _port = 3e3;
   _host = "0.0.0.0";
+  _autoDetectPort = true;
   _helmet = true;
   _apiDocs = true;
   _httpBin = {
@@ -1302,46 +1307,106 @@ var MockHttp = class extends Hookified {
       this._httpBin = options.httpBin;
     }
   }
+  /**
+  * The port to listen on. If not provided, defaults to 3000 and detects the next available port if in use.
+  * @default 3000
+  */
   get port() {
     return this._port;
   }
+  /**
+  * The port to listen on. If not provided, defaults to 3000 and detects the next available port if in use.
+  * @default 3000
+  */
   set port(port) {
     this._port = port;
   }
+  /**
+  * The host to listen on. If not provided, defaults to 'localhost'.
+  * @default 'localhost'
+  */
   get host() {
     return this._host;
   }
+  /**
+  * The host to listen on. If not provided, defaults to 'localhost'.
+  * @default 'localhost'
+  */
   set host(host) {
     this._host = host;
   }
+  /**
+  * Whether to automatically detect the next available port if the provided port is in use. Defaults to true.
+  * @default true
+  */
+  get autoDetectPort() {
+    return this._autoDetectPort;
+  }
+  /**
+  * Whether to automatically detect the next available port if the provided port is in use. Defaults to true.
+  * @default true
+  */
+  set autoDetectPort(autoDetectPort) {
+    this._autoDetectPort = autoDetectPort;
+  }
+  /**
+  * Whether to use Helmet for security headers. Defaults to true.
+  * @default true
+  */
   get helmet() {
     return this._helmet;
   }
+  /**
+  * Whether to use Helmet for security headers. Defaults to true.
+  * @default true
+  */
   set helmet(helmet) {
     this._helmet = helmet;
   }
+  /**
+  * Whether to use Swagger for API documentation. Defaults to true.
+  * @default true
+  */
   get apiDocs() {
     return this._apiDocs;
   }
+  /**
+  * Whether to use Swagger for API documentation. Defaults to true.
+  * @default true
+  */
   // eslint-disable-next-line unicorn/prevent-abbreviations
   set apiDocs(apiDocs) {
     this._apiDocs = apiDocs;
   }
+  /**
+  * HTTP Bin options. Defaults to all enabled.
+  */
   get httpBin() {
     return this._httpBin;
   }
+  /**
+  * HTTP Bin options. Defaults to all enabled.
+  */
   set httpBin(httpBinary) {
     this._httpBin = httpBinary;
   }
+  /**
+  * The Fastify server instance.
+  */
   get server() {
     return this._server;
   }
+  /**
+  * The Fastify server instance.
+  */
   set server(server) {
     this._server = server;
   }
+  /**
+  * Start the Fastify server. If the server is already running, it will be closed and restarted.
+  */
   async start() {
     try {
-      const { port, host } = this;
       if (this._server) {
         await this._server.close();
       }
@@ -1377,23 +1442,49 @@ var MockHttp = class extends Hookified {
       if (redirects) {
         await this.registerRedirectRoutes();
       }
+      if (this._autoDetectPort) {
+        const originalPort = this._port;
+        this._port = await this.detectPort();
+        if (originalPort !== this._port) {
+          this._server.log.info(`Port ${originalPort} is in use, detected next available port: ${this._port}`);
+        }
+      }
       await this._server.listen({
-        port,
-        host
+        port: this._port,
+        host: this._host
       });
     } catch (error) {
       this._server.log.error(error);
     }
   }
+  /**
+  * Close the Fastify server.
+  */
   async close() {
     await this._server.close();
   }
+  /**
+  * Detect the next available port to run on.
+  * @returns The port that is available to run on
+  */
+  async detectPort() {
+    const { port } = this;
+    return detect(port);
+  }
+  /**
+  * This will register the API documentation routes including openapi and swagger ui.
+  * @param fastifyInstance - the server instance to register the routes on.
+  */
   async registerApiDocs(fastifyInstance) {
     const fastify = fastifyInstance ?? this._server;
     await fastify.register(fastifySwagger, fastifySwaggerConfig);
     await registerSwaggerUi(fastify);
     await fastify.register(indexRoute);
   }
+  /**
+  * Register the HTTP methods routes.
+  * @param fastifyInstance - the server instance to register the routes on.
+  */
   async registerHttpMethods(fastifyInstance) {
     const fastify = fastifyInstance ?? this._server;
     await fastify.register(getRoute);
@@ -1402,22 +1493,38 @@ var MockHttp = class extends Hookified {
     await fastify.register(putRoute);
     await fastify.register(patchRoute);
   }
+  /**
+  * Register the status code routes.
+  * @param fastifyInstance - the server instance to register the routes on.
+  */
   async registerStatusCodeRoutes(fastifyInstance) {
     const fastify = fastifyInstance ?? this._server;
     await fastify.register(statusCodeRoute);
   }
+  /**
+  * Register the request inspection routes.
+  * @param fastifyInstance - the server instance to register the routes on.
+  */
   async registerRequestInspectionRoutes(fastifyInstance) {
     const fastify = fastifyInstance ?? this._server;
     await fastify.register(ipRoute);
     await fastify.register(headersRoute);
     await fastify.register(userAgentRoute);
   }
+  /**
+  * Register the response inspection routes.
+  * @param fastifyInstance - the server instance to register the routes on.
+  */
   async registerResponseInspectionRoutes(fastifyInstance) {
     const fastify = fastifyInstance ?? this._server;
     await fastify.register(cacheRoutes);
     await fastify.register(etagRoutes);
     await fastify.register(responseHeadersRoutes);
   }
+  /**
+  * Register the redirect routes.
+  * @param fastifyInstance - the server instance to register the routes on.
+  */
   async registerRedirectRoutes(fastifyInstance) {
     const fastify = fastifyInstance ?? this._server;
     await fastify.register(absoluteRedirectRoute);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jaredwray/mockhttp",
-  "version": "0.4.1",
+  "version": "0.4.2",
   "description": "Mock Http - Easy way to mock http with httpbin replacement",
   "type": "module",
   "main": "dist/index.js",
@@ -16,7 +16,9 @@
     "docker:push": "docker push jaredwray/mockhttp",
     "docker:stop": "docker stop $(docker ps -a -q --filter ancestor=jaredwray/mockhttp --format=\"{{.ID}}\")",
     "docker:readme": "tsx ./scripts/create-docker-readme.ts",
-    "prepare": "npm run build",
+    "docker:compose:up": "docker-compose up -d",
+    "docker:compose:down": "docker-compose down",
+    "prepare": "pnpm build",
     "start": "node dist/index.js"
   },
   "repository": {
@@ -36,14 +38,14 @@
   },
   "homepage": "https://github.com/jaredwray/mockhttp#readme",
   "devDependencies": {
-    "@swc/core": "^1.11.5",
+    "@swc/core": "^1.11.16",
     "@types/html-escaper": "^3.0.4",
-    "@vitest/coverage-v8": "^3.0.7",
+    "@vitest/coverage-v8": "^3.1.1",
     "rimraf": "^6.0.1",
     "tsup": "^8.4.0",
     "tsx": "^4.19.3",
-    "typescript": "^5.8.2",
-    "vitest": "^3.0.7",
+    "typescript": "^5.8.3",
+    "vitest": "^3.1.1",
     "xo": "^0.60.0"
   },
   "dependencies": {
@@ -51,9 +53,10 @@
     "@fastify/static": "^8.1.1",
     "@fastify/swagger": "^9.4.2",
     "@fastify/swagger-ui": "^5.2.2",
-    "@scalar/api-reference": "^1.25.124",
-    "fastify": "^5.2.1",
-    "hookified": "^1.7.1",
+    "@scalar/api-reference": "^1.28.12",
+    "detect-port": "^2.1.0",
+    "fastify": "^5.2.2",
+    "hookified": "^1.8.1",
     "html-escaper": "^3.0.3",
     "pino": "^9.6.0",
     "pino-pretty": "^13.0.0"