Class AlibabaFcHttpAdapter

Alibaba Cloud Function Compute HTTP adapter for Stone.js.

FC's HTTP trigger (2.0) invokes the function with (req, resp, context): a plain request object (body pre-read into a Buffer) and an imperative response written via setStatusCode/ setHeader/send. run() does not start a server — it returns that handler, and the adapter normalizes the request into an IncomingHttpEvent, runs the kernel, and writes the response.

Remarks

FC 3.0 runs a container with a normal HTTP server, so it does not need this adapter, use @stone-js/node-http-adapter there as-is.

Example

exports.handler = await AlibabaFcHttpAdapter.create(blueprint).run<AlibabaFcHttpEventHandlerFunction>()

Hierarchy

Adapter<
    AlibabaFcHttpRequest,
    AlibabaFcHttpResponse,
    AlibabaFcHttpExecutionContext,
    IncomingHttpEvent,
    IncomingHttpEventOptions,
    OutgoingHttpResponse,
    AlibabaFcHttpAdapterContext,
>
- AlibabaFcHttpAdapter

Constructors

`Protected`constructor

new AlibabaFcHttpAdapter(blueprint: IBlueprint): AlibabaFcHttpAdapter
Create an Adapter.
Parameters
- blueprint: IBlueprint
  The blueprint to create the adapter.
Returns AlibabaFcHttpAdapter

Inherited from Adapter< AlibabaFcHttpRequest, AlibabaFcHttpResponse, AlibabaFcHttpExecutionContext, IncomingHttpEvent, IncomingHttpEventOptions, OutgoingHttpResponse, AlibabaFcHttpAdapterContext >.constructor

Properties

`Protected` `Readonly`blueprint

blueprint: IBlueprint

`Protected` `Readonly`hooks

hooks: AdapterHookType<AlibabaFcHttpAdapterContext, AlibabaFcHttpResponse>

`Protected` `Readonly`middleware

middleware: AdapterMixedPipeType<
AlibabaFcHttpAdapterContext,
AlibabaFcHttpResponse,
>[]

`Protected` `Readonly`resolvedErrorHandlers

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

Methods

`Protected`buildRawResponse

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

Inherited from Adapter.buildRawResponse

`Protected`eventListener

eventListener(
    rawEvent: AlibabaFcHttpRequest,
    rawResponse: AlibabaFcHttpResponse,
    executionContext: AlibabaFcHttpExecutionContext,
): Promise<AlibabaFcHttpResponse>
Handle a single FC HTTP request, writing the response onto resp.
Parameters
- rawEvent: AlibabaFcHttpRequest
  The incoming FC request.
- rawResponse: AlibabaFcHttpResponse
  The imperative FC response object.
- executionContext: AlibabaFcHttpExecutionContext
  The FC invocation context.
Returns Promise<AlibabaFcHttpResponse>
The FC response object.

`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?: AlibabaFcHttpAdapterContext,
    error?: any,
): Promise<void>
Execute adapter lifecycle hooks.
Parameters
- name: AdapterHookName
  The hook's name.
- Optionalcontext: AlibabaFcHttpAdapterContext
  The event context.
- Optionalerror: any
  The error to handle.
Returns Promise<void>

Inherited from Adapter.executeHooks

`Protected`handleError

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

Inherited from Adapter.handleError

`Protected`handleEvent

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

Inherited from Adapter.handleEvent

`Protected`makePipelineOptions

makePipelineOptions(): PipelineOptions<
    AlibabaFcHttpAdapterContext,
    AdapterEventBuilderType<AlibabaFcHttpResponse>,
>

Create pipeline options for the Adapter.

Returns PipelineOptions<
    AlibabaFcHttpAdapterContext,
    AdapterEventBuilderType<AlibabaFcHttpResponse>,
>
The pipeline options for transforming the event.

Inherited from Adapter.makePipelineOptions

`Protected`onStart

onStart(): Promise<void>

Lifecycle hook run once before the first request.

Returns Promise<void>

`Protected`resolveErrorHandler

resolveErrorHandler(
    error: Error,
): IAdapterErrorHandler<
    AlibabaFcHttpRequest,
    AlibabaFcHttpResponse,
    AlibabaFcHttpExecutionContext,
>
Get the error handler for the given error.
Parameters
- error: Error
  The error to get the handler for.
Returns IAdapterErrorHandler<
    AlibabaFcHttpRequest,
    AlibabaFcHttpResponse,
    AlibabaFcHttpExecutionContext,
>
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 = AlibabaFcHttpEventHandlerFunction>(): Promise<
ExecutionResultType,
>
Start the adapter and return the FC HTTP handler (req, resp, context).
Type Parameters
- ExecutionResultType = AlibabaFcHttpEventHandlerFunction
Returns Promise<ExecutionResultType>
The FC HTTP handler.

Overrides Adapter.run

`Protected`sendEventThroughDestination

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

Throws
IntegrationError

Inherited from Adapter.sendEventThroughDestination

`Protected`validateContextAndEventHandler

validateContextAndEventHandler(
    context: AlibabaFcHttpAdapterContext,
    eventHandler: AdapterEventHandlerType<
        IncomingHttpEvent,
        OutgoingHttpResponse,
    >,
): void
Validate the context and event handler.
Parameters
- context: AlibabaFcHttpAdapterContext
  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): AlibabaFcHttpAdapter
Parameters
- blueprint: IBlueprint
  The application blueprint.
Returns AlibabaFcHttpAdapter
A new adapter instance.

Class AlibabaFcHttpAdapter

Remarks

Example

Hierarchy

Index

Constructors

Properties

Methods

Constructors

Protectedconstructor

Parameters

Returns AlibabaFcHttpAdapter

Properties

Protected Readonlyblueprint

Protected Readonlyhooks

Protected Readonlymiddleware

Protected ReadonlyresolvedErrorHandlers

Methods

ProtectedbuildRawResponse

Parameters

Returns Promise<AlibabaFcHttpResponse>

ProtectedeventListener

Parameters

Returns Promise<AlibabaFcHttpResponse>

ProtectedexecuteEventHandlerHooks

Parameters

Returns Promise<void>

ProtectedexecuteHooks

Parameters

Returns Promise<void>

ProtectedhandleError

Parameters

Returns Promise<AdapterEventBuilderType<AlibabaFcHttpResponse>>

ProtectedhandleEvent

Parameters

Returns Promise< IAdapterEventBuilder< RawResponseOptions, IRawResponseWrapper<AlibabaFcHttpResponse>, >,>

ProtectedmakePipelineOptions

Returns PipelineOptions< AlibabaFcHttpAdapterContext, AdapterEventBuilderType<AlibabaFcHttpResponse>,>

ProtectedonStart

Returns Promise<void>

ProtectedresolveErrorHandler

Parameters

Returns IAdapterErrorHandler< AlibabaFcHttpRequest, AlibabaFcHttpResponse, AlibabaFcHttpExecutionContext,>

Throws

ProtectedresolveEventHandler

Returns AdapterEventHandlerType<IncomingHttpEvent, OutgoingHttpResponse>

Throws

run

Type Parameters

Returns Promise<ExecutionResultType>

ProtectedsendEventThroughDestination

Parameters

Returns Promise<AlibabaFcHttpResponse>

Throws

ProtectedvalidateContextAndEventHandler

Parameters

Returns void

Throws

Staticcreate

Parameters

Returns AlibabaFcHttpAdapter

Settings

On This Page

`Protected`constructor

`Protected` `Readonly`blueprint

`Protected` `Readonly`hooks

`Protected` `Readonly`middleware

`Protected` `Readonly`resolvedErrorHandlers

`Protected`buildRawResponse

`Protected`eventListener

`Protected`executeEventHandlerHooks

`Protected`executeHooks

`Protected`handleError

`Protected`handleEvent

Returns Promise<
IAdapterEventBuilder<
RawResponseOptions,
IRawResponseWrapper<AlibabaFcHttpResponse>,
>,
>

`Protected`makePipelineOptions

Returns PipelineOptions<
AlibabaFcHttpAdapterContext,
AdapterEventBuilderType<AlibabaFcHttpResponse>,
>

`Protected`onStart

`Protected`resolveErrorHandler

Returns IAdapterErrorHandler<
AlibabaFcHttpRequest,
AlibabaFcHttpResponse,
AlibabaFcHttpExecutionContext,
>

`Protected`resolveEventHandler

`Protected`sendEventThroughDestination

`Protected`validateContextAndEventHandler

`Static`create