AzureFunction

Implements: Container

Description

The AzureFunction class allows you to create an Abstract Azure Function that acts as a container to instantiate and run components and expose them via an external entry point.

Importan points

• When handling calls, the “cmd” parameter determines the action that shall be called, while the other parameters are passed to the action itself.

• The container configuration for this Azure Function is stored in "./config/config.yml" file. But this path can be overriden by CONFIG_PATH environment variable.

References

• *:logger:*:*:1.0: (optional) ILogger components to pass log messages
• *:counters:*:*:1.0: (optional) ICounters components to pass collected measurements
• *:service:azure-function:*:1.0: (optional) IAzureFunctionService services to handle action requests.
• *:service:commandable-azure-function:*:1.0: (optional) IAzureFunctionService services to handle action requests.

Constructors

Creates a new instance of this Azure Function.

public constructor(name?: string, description?: string)

• name: string - (optional) container’s name (accessible via ContextInfo)
• description: string - (optional) container’s description (accessible via ContextInfo)

Fields

Instance methods

act

Calls registered action in this Azure Function. “cmd” parameter in the action parameters determin what action shall be called.

This method shall only be used in testing.

public act(context: any): Promise<any>

• context: any - action parameters.
• returns: Promise<any> - action result.

execute

Executes this Azure Function and returns the result. This method can be overloaded in child classes if they need to change the default behavior

protected execute(context: any): Promise<any>

• context: any - context the context parameters (or function arguments)
• returns: Promise<any> - the result of the function execution.

getCommand

Returns command from Azure Function context. This method can be overloaded in child classes

protected getCommand(context: any): string

• context: any - Azure Function context
• returns: string - Returns command from context

getCorrelationId

Returns correlationId from Azure Function context. This method can be overloaded in child classes

protected getCorrelationId(context: any): string

• context: any - Azure Function context
• returns: string - Returns correlationId from context

getHandler

Return plugin function

public getHandler(): (context: any) => Promise<any>

• returns: (context: any) => Promise<any> - plugin function

instrument

Adds instrumentation to log calls and measures call time. It returns a Timing object that is used to end the time measurement.

protected instrument(correlationId: string, name: string): InstrumentTiming

• correlationId: string - (optional) transaction id used to trace execution through the call chain.
• name: string - method’s name.
• returns: InstrumentTiming - Timing object to end the time measurement.

open

Opens the component.

public open(correlationId: string) :Promise<void>

• correlationId: string - (optional) transaction id used to trace execution through the call chain.

registerAction

Registers an action in this Azure Function.

Note: This method has been deprecated. Use AzureFunctionService instead.

protected registerAction(cmd: string, schema: Schema, action: (context: any) => Promise<any>): void

• cmd: str - a action/command name.
• schema: Schema - a validation schema to validate received parameters.
• action: (context: any) => Promise<any> - an action function that is called when action is invoked.

register

Registers all actions in this Azure Function.

Note: Overloading of this method has been deprecated. Use AzureFunctionService instead.

register()

registerServices

Registers all Azure Function services in the container.

protected registerServices(): void

run

Runs this Azure Function, loads container configuration, instantiate components and manage their lifecycle, makes this function ready to access action calls.

public run(): Promise<void>

setReferences

Sets references to dependent components.

public setReferences(references: IReferences)

• references: IReferences - references to locate the component’s dependencies.

Examples

class MyAzureFunctionFunction extends AzureFunction {
    public constructor() {
        base("mygroup", "MyGroup Azure Function");
    }
}

let azureFunction = new MyAzureFunctionFunction();
 
await service.run();
console.log("MyAzureFunctionFunction is started");