Class GcpCloudFunctionsHttpAdapter

GCP Cloud Functions HTTP Adapter for the Stone.js framework.

The GcpCloudFunctionsHttpAdapter integrates a Google Cloud Functions HTTP function (the Functions Framework (req, res) signature) with the Stone.js framework. It converts the incoming Express-flavoured request into an IncomingHttpEvent, runs it through the kernel, and writes the OutgoingHttpResponse back onto the response object.

Unlike the Node HTTP adapter, it does NOT create or own an HTTP server: the platform owns the process lifecycle and the socket. run() returns the handler that the Functions Framework invokes per request.

Remarks

Cloud Run runs a container with a normal long-running HTTP server, so it does not need this adapter, use @stone-js/node-http-adapter as-is. This adapter is specifically for the event-driven HTTP functions runtime (1st and 2nd gen Cloud Functions).

Hierarchy

Adapter<
    IncomingMessage,
    ServerResponse,
    undefined,
    IncomingHttpEvent,
    IncomingHttpEventOptions,
    OutgoingHttpResponse,
    GcpCloudFunctionsHttpAdapterContext,
>
- GcpCloudFunctionsHttpAdapter

Constructors

`Protected`constructor

new GcpCloudFunctionsHttpAdapter(
blueprint: IBlueprint,
): GcpCloudFunctionsHttpAdapter
Constructs a GcpCloudFunctionsHttpAdapter instance.

This constructor is protected and is intended to be used via the static create method.
Parameters
- blueprint: IBlueprint
  The application blueprint for dependency resolution.
Returns GcpCloudFunctionsHttpAdapter

Overrides Adapter< IncomingMessage, ServerResponse, undefined, IncomingHttpEvent, IncomingHttpEventOptions, OutgoingHttpResponse, GcpCloudFunctionsHttpAdapterContext >.constructor

Properties

`Protected` `Readonly`blueprint

blueprint: IBlueprint

`Protected` `Readonly`hooks

hooks: AdapterHookType<
GcpCloudFunctionsHttpAdapterContext,
ServerResponse<IncomingMessage>,
>

`Protected` `Readonly`logger

logger: ILogger

`Protected` `Readonly`middleware

middleware: AdapterMixedPipeType<
GcpCloudFunctionsHttpAdapterContext,
ServerResponse<IncomingMessage>,
>[]

`Protected` `Readonly`resolvedErrorHandlers

resolvedErrorHandlers: Record<
string,
IAdapterErrorHandler<RawEventType, RawResponseType, ExecutionContextType>,
>

Methods

`Protected`buildRawResponse

buildRawResponse(
    context: GcpCloudFunctionsHttpAdapterContext,
    eventHandler?: AdapterEventHandlerType<
        IncomingHttpEvent,
        OutgoingHttpResponse,
    >,
): Promise<ServerResponse<IncomingMessage>>
Build the raw response.
Parameters
- context: GcpCloudFunctionsHttpAdapterContext
  The event context.
- OptionaleventHandler: AdapterEventHandlerType<IncomingHttpEvent, OutgoingHttpResponse>
  The event handler to be run.
Returns Promise<ServerResponse<IncomingMessage>>
The raw response wrapper.

Inherited from Adapter.buildRawResponse

`Protected`eventListener

eventListener(
rawEvent: GcpHttpFunctionRequest,
rawResponse: GcpHttpFunctionResponse,
): Promise<ServerResponse<IncomingMessage>>
Protected
Handles an incoming HTTP request and sends it through the adapter's event pipeline.
Parameters
- rawEvent: GcpHttpFunctionRequest
  The raw GCP Cloud Functions HTTP request object.
- rawResponse: GcpHttpFunctionResponse
  The raw HTTP response object.
Returns Promise<ServerResponse<IncomingMessage>>
A promise resolving to the ServerResponse.

`Protected`executeEventHandlerHooks

executeEventHandlerHooks(
    hook: KernelHookName,
    eventHandler: AdapterEventHandlerType<
        IncomingHttpEvent,
        OutgoingHttpResponse,
    >,
): Promise<void>
Execute the event handler lifecycle hooks.
Parameters
- hook: KernelHookName
  The hook to execute.
- eventHandler: AdapterEventHandlerType<IncomingHttpEvent, OutgoingHttpResponse>
  The event handler to be run.
Returns Promise<void>

Inherited from Adapter.executeEventHandlerHooks

`Protected`executeHooks

executeHooks(
    name: AdapterHookName,
    context?: GcpCloudFunctionsHttpAdapterContext,
    error?: any,
): Promise<void>
Execute adapter lifecycle hooks.
Parameters
- name: AdapterHookName
  The hook's name.
- Optionalcontext: GcpCloudFunctionsHttpAdapterContext
  The event context.
- Optionalerror: any
  The error to handle.
Returns Promise<void>

Inherited from Adapter.executeHooks

`Protected`handleError

handleError(
error: Error,
context: GcpCloudFunctionsHttpAdapterContext,
): Promise<AdapterEventBuilderType<ServerResponse<IncomingMessage>>>
Handle error.
Parameters
- error: Error
  The error to handle.
- context: GcpCloudFunctionsHttpAdapterContext
  The event context.
Returns Promise<AdapterEventBuilderType<ServerResponse<IncomingMessage>>>
The raw response.

Inherited from Adapter.handleError

`Protected`handleEvent

handleEvent(
    context: GcpCloudFunctionsHttpAdapterContext,
    eventHandler: AdapterEventHandlerType<
        IncomingHttpEvent,
        OutgoingHttpResponse,
    >,
): Promise<
    IAdapterEventBuilder<
        RawResponseOptions,
        IRawResponseWrapper<ServerResponse<IncomingMessage>>,
    >,
>
Handle the event.
Parameters
- context: GcpCloudFunctionsHttpAdapterContext
  The event context.
- eventHandler: AdapterEventHandlerType<IncomingHttpEvent, OutgoingHttpResponse>
  The event handler to be run.
Returns Promise<
    IAdapterEventBuilder<
        RawResponseOptions,
        IRawResponseWrapper<ServerResponse<IncomingMessage>>,
    >,
>
The raw response wrapper.

Inherited from Adapter.handleEvent

`Protected`makePipelineOptions

makePipelineOptions(): PipelineOptions<
    GcpCloudFunctionsHttpAdapterContext,
    AdapterEventBuilderType<ServerResponse<IncomingMessage>>,
>

Create pipeline options for the Adapter.

Returns PipelineOptions<
    GcpCloudFunctionsHttpAdapterContext,
    AdapterEventBuilderType<ServerResponse<IncomingMessage>>,
>
The pipeline options for transforming the event.

Inherited from Adapter.makePipelineOptions

`Protected`onStart

onStart(): Promise<void>

Lifecycle hook for adapter initialization.

The platform owns the process, so this only guards the runtime environment and fires the onStart hooks; it does NOT bind process signals or a server (the runtime manages shutdown).

Returns Promise<void>

Throws
If the adapter is used outside a Node.js context.

`Protected`resolveErrorHandler

resolveErrorHandler(
    error: Error,
): IAdapterErrorHandler<
    IncomingMessage,
    ServerResponse<IncomingMessage>,
    undefined,
>
Get the error handler for the given error.
Parameters
- error: Error
  The error to get the handler for.
Returns IAdapterErrorHandler<
    IncomingMessage,
    ServerResponse<IncomingMessage>,
    undefined,
>
The error handler.

Throws
IntegrationError

Inherited from Adapter.resolveErrorHandler

`Protected`resolveEventHandler

resolveEventHandler(): AdapterEventHandlerType<
IncomingHttpEvent,
OutgoingHttpResponse,
>

Get the event handler for the adapter.

Returns AdapterEventHandlerType<IncomingHttpEvent, OutgoingHttpResponse>
The event handler for the adapter.

Throws
If the event handler is missing.

Inherited from Adapter.resolveEventHandler

run

run<ExecutionResultType = GcpHttpFunctionHandler>(): Promise<
ExecutionResultType,
>
Boots the application and returns the HTTP function handler.

Register the returned handler with the Functions Framework:
```
import * as functions from '@google-cloud/functions-framework'
functions.http('stone', await StoneFactory.create({ ...blueprint }).run())
```
Type Parameters
- ExecutionResultType = GcpHttpFunctionHandler
Returns Promise<ExecutionResultType>
A promise resolving to the (req, res) handler invoked per request.

Throws
If the adapter is used outside a Node.js context.

Overrides Adapter.run

`Protected`sendEventThroughDestination

sendEventThroughDestination(
    context: GcpCloudFunctionsHttpAdapterContext,
    eventHandler: AdapterEventHandlerType<
        IncomingHttpEvent,
        OutgoingHttpResponse,
    >,
): Promise<ServerResponse<IncomingMessage>>
Send the raw event through the destination.
Parameters
- context: GcpCloudFunctionsHttpAdapterContext
  The event context.
- eventHandler: AdapterEventHandlerType<IncomingHttpEvent, OutgoingHttpResponse>
  The event handler to be run.
Returns Promise<ServerResponse<IncomingMessage>>
Platform-specific response.

Throws
IntegrationError

Inherited from Adapter.sendEventThroughDestination

`Protected`validateContextAndEventHandler

validateContextAndEventHandler(
    context: GcpCloudFunctionsHttpAdapterContext,
    eventHandler: AdapterEventHandlerType<
        IncomingHttpEvent,
        OutgoingHttpResponse,
    >,
): void
Validate the context and event handler.
Parameters
- context: GcpCloudFunctionsHttpAdapterContext
  The context to validate.
- eventHandler: AdapterEventHandlerType<IncomingHttpEvent, OutgoingHttpResponse>
  The event handler to validate.
Returns void

Throws
IntegrationError

Inherited from Adapter.validateContextAndEventHandler

`Static`create

create(blueprint: IBlueprint): GcpCloudFunctionsHttpAdapter
Creates a new GcpCloudFunctionsHttpAdapter instance.
Parameters
- blueprint: IBlueprint
  The application blueprint.
Returns GcpCloudFunctionsHttpAdapter
A new instance of GcpCloudFunctionsHttpAdapter.
Example
```
const adapter = GcpCloudFunctionsHttpAdapter.create(blueprint);
const handler = await adapter.run();
```

Class GcpCloudFunctionsHttpAdapter

Remarks

Hierarchy

Index

Constructors

Properties

Methods

Constructors

Protectedconstructor

Parameters

Returns GcpCloudFunctionsHttpAdapter

Properties

Protected Readonlyblueprint

Protected Readonlyhooks

Protected Readonlylogger

Protected Readonlymiddleware

Protected ReadonlyresolvedErrorHandlers

Methods

ProtectedbuildRawResponse

Parameters

Returns Promise<ServerResponse<IncomingMessage>>

ProtectedeventListener

Parameters

Returns Promise<ServerResponse<IncomingMessage>>

ProtectedexecuteEventHandlerHooks

Parameters

Returns Promise<void>

ProtectedexecuteHooks

Parameters

Returns Promise<void>

ProtectedhandleError

Parameters

Returns Promise<AdapterEventBuilderType<ServerResponse<IncomingMessage>>>

ProtectedhandleEvent

Parameters

Returns Promise< IAdapterEventBuilder< RawResponseOptions, IRawResponseWrapper<ServerResponse<IncomingMessage>>, >,>

ProtectedmakePipelineOptions

Returns PipelineOptions< GcpCloudFunctionsHttpAdapterContext, AdapterEventBuilderType<ServerResponse<IncomingMessage>>,>

ProtectedonStart

Returns Promise<void>

Throws

ProtectedresolveErrorHandler

Parameters

Returns IAdapterErrorHandler< IncomingMessage, ServerResponse<IncomingMessage>, undefined,>

Throws

ProtectedresolveEventHandler

Returns AdapterEventHandlerType<IncomingHttpEvent, OutgoingHttpResponse>

Throws

run

Type Parameters

Returns Promise<ExecutionResultType>

Throws

ProtectedsendEventThroughDestination

Parameters

Returns Promise<ServerResponse<IncomingMessage>>

Throws

ProtectedvalidateContextAndEventHandler

Parameters

Returns void

Throws

Staticcreate

Parameters

Returns GcpCloudFunctionsHttpAdapter

Example

Settings

On This Page

`Protected`constructor

`Protected` `Readonly`blueprint

`Protected` `Readonly`hooks

`Protected` `Readonly`logger

`Protected` `Readonly`middleware

`Protected` `Readonly`resolvedErrorHandlers

`Protected`buildRawResponse

`Protected`eventListener

`Protected`executeEventHandlerHooks

`Protected`executeHooks

`Protected`handleError

`Protected`handleEvent

Returns Promise<
IAdapterEventBuilder<
RawResponseOptions,
IRawResponseWrapper<ServerResponse<IncomingMessage>>,
>,
>

`Protected`makePipelineOptions

Returns PipelineOptions<
GcpCloudFunctionsHttpAdapterContext,
AdapterEventBuilderType<ServerResponse<IncomingMessage>>,
>

`Protected`onStart

`Protected`resolveErrorHandler

Returns IAdapterErrorHandler<
IncomingMessage,
ServerResponse<IncomingMessage>,
undefined,
>

`Protected`resolveEventHandler

`Protected`sendEventThroughDestination

`Protected`validateContextAndEventHandler

`Static`create