Objective HTTP Server

Common errors

• TypeError: (0 , server_1.Server) is not a constructor

  cause Attempting to import `Server` using an incorrect ESM syntax or path when the package primarily uses CommonJS `require` with nested exports.
  fix Use the correct CommonJS `require` statement: `const { Server } = require('objective-http').server;`

• Error: Cannot find module 'objective-http/server'

  cause This error typically occurs when attempting to use a direct path import for a submodule (`objective-http/server`) in a CommonJS context, or if the package's internal structure doesn't expose modules in that specific way for direct import.
  fix The primary entry point for server components is usually `require('objective-http').server`. Avoid direct path imports like `require('objective-http/server')` unless explicitly documented.

• ReferenceError: MyEndpoint is not defined

  cause When using `autoconfig` or manually configuring the `Server`, an `Endpoint` class (like `MyEndpoint`) is referenced but not defined or correctly imported within the scope.
  fix Ensure that any custom `Endpoint` classes are properly defined and instantiated before being passed to the server configuration. For example, `class MyEndpoint { ... }`.

Warnings

• breaking Version 1.3.0 introduced a 'new import signature'. This likely changed how classes and functions were exported, requiring users to update their `require` statements or destructuring paths. Code written for versions prior to 1.3.0 will likely break due to module resolution errors.
  Fix: Review the README and source code for the correct import paths and destructuring patterns. Update `require()` calls to match the new module structure.
• breaking Version 1.4.0 explicitly 'removed json request and response' functionality. If your application relied on `JsonServerRequest` or `JsonServerResponse` classes in versions before 1.4.0, your code would have broken. Note that these classes were later reintroduced in version 2.x, but with potential API changes.
  Fix: For versions 1.x, you would need to implement custom JSON parsing/serialization. For versions 2.x and above, `JsonServerRequest` and `JsonServerResponse` have been re-added, but verify their usage patterns as they might differ from pre-1.4.0 versions.
• gotcha The library heavily relies on deeply nested object structures for its classes and utilities, especially when not using `autoconfig`. For example, `EndpointHandler` is under `objective-http.server.handler.endpoint.EndpointHandler`. This can lead to verbose `require` statements and makes direct ESM imports challenging or impossible.
  Fix: Prefer the `autoconfig` utility for simpler server setups. When building custom server configurations, carefully follow the provided examples for destructuring the `objective-http.server` object to access nested components.
• gotcha The `autoconfig` utility requires an array of `Endpoint` instances and an `env` object. Forgetting to provide these, or providing them in an incorrect format, can lead to server startup failures or requests not being handled correctly.
  Fix: Always ensure the `endpoints` array contains valid instances of classes implementing the `Endpoint` interface (with `route` and `handle` methods). Pass `process.env` or a compatible object as the `env` parameter.

Install

• npm install objective-http npm
• yarn add objective-http yarn
• pnpm add objective-http pnpm

Imports

• Server
  wrong:

  import { Server } from 'objective-http';

  correct:

  const { Server } = require('objective-http').server;

  The primary `Server` class is exposed via the `.server` namespace in CommonJS. Direct ESM imports like `import { Server } from 'objective-http';` are likely incorrect or unsupported due to the deep nesting of exports.
• autoconfig
  wrong:

  import { autoconfigServer } from 'objective-http/server/autoconfig';

  correct:

  const { server: autoconfigServer } = require('objective-http').server.autoconfig;

  The autoconfiguration utility is nested under `server.autoconfig`. It's exported as `server` within that module, so it's common to rename it on import.
• EndpointHandler, JsonServerRequest, LogErrorHandler

  const { handler, request, response } = require('objective-http').server;
  const { EndpointHandler } = handler.endpoint;
  const { JsonServerRequest } = request.chunk;
  const { LogErrorHandler } = handler.error;

  Many core classes are deeply nested within the `handler`, `request`, and `response` namespaces. Proper CommonJS destructuring is required to access them.

Quickstart

This quickstart demonstrates setting up a basic HTTP server using `objective-http`'s `autoconfig` utility, defining a simple GET endpoint, and starting the server.

const { server: autoconfigServer } = require('objective-http').server.autoconfig;
const { env } = require('node:process');

class MyEndpoint {
    route = {
        method: 'GET',
        path: '/hello'
    }

    async handle(request) {
        console.log(`Received request for: ${request.url}`);
        try {
            // Simulate some async processing
            await new Promise(resolve => setTimeout(resolve, 50));
            return {
                status: 200,
                body: 'Hello, Objective HTTP!'
            };
        
        } catch (e) {
            console.error('Error handling request:', e);
            return {
                status: 500,
                body: 'Internal server error'
            };
        }
    }
}

// Start the server using autoconfig
autoconfigServer({
    env: env,
    endpoints: [
        new MyEndpoint()
    ],
    options: { port: 3000 } // You can pass http.createServer options here
})
.then(() => console.log('Objective HTTP server listening on port 3000'))
.catch(err => console.error('Failed to start server:', err));

// Optional: Keep the process alive or graceful shutdown
// process.on('SIGINT', () => { console.log('Shutting down...'); process.exit(0); });