Skip to main content

ClusterService

@webda/runtime

Class: ClusterService<T>

Defined in: packages/runtime/src/services/cluster.service.ts:102

Cluster service

It will listen to all events and forward them to the pubsub so all others instances can be notified It will emit the event locally received from the pubsub

It will also invalidates cache based on these events

Webda Modda​

Extends​

  • Service<T>

Type Parameters​

T​

T extends ClusterServiceParameters = ClusterServiceParameters

Constructors​

Constructor​

new ClusterService<T>(name, params): ClusterService<T>

Defined in: packages/core/lib/services/service.d.ts:72

Service

Parameters​

name​

string

The name of the service

params​

T

The parameters block define in the configuration file

Returns​

ClusterService<T>

Inherited from​

Service<T>.constructor

Properties​

_compiledCapabilities​

protected _compiledCapabilities: Record<string, any>

Defined in: packages/core/lib/services/iservice.d.ts:39

Capabilities detected at compile-time from @WebdaCapability-tagged interfaces.

Populated during Service.resolve by reading the service's entry in webda.module.json. Each key is a capability name (e.g., "request-filter"), and the value is an empty object {} by default. Override getCapabilities to provide capability-specific configuration or to conditionally disable capabilities.

See​

getCapabilities

Inherited from​

EchoService._compiledCapabilities

_ready​

_ready: boolean = false

Defined in: packages/runtime/src/services/cluster.service.ts:152

If service is ready

Sent the welcome message

[WEBDA_EVENTS]​

[WEBDA_EVENTS]: object

Defined in: packages/core/lib/services/service.d.ts:50

Set the Webda events here

Inherited from​

Service.[WEBDA_EVENTS]

emitterId​

emitterId: string

Defined in: packages/runtime/src/services/cluster.service.ts:126

Emitter id

hasCodeSyncAlert​

hasCodeSyncAlert: boolean = false

Defined in: packages/runtime/src/services/cluster.service.ts:109

If code is out of sync and warning has been displayed

logger​

protected logger: Logger

Defined in: packages/core/lib/services/service.d.ts:59

Logger with class context

Inherited from​

EchoService.logger

members​

members: object = {}

Defined in: packages/runtime/src/services/cluster.service.ts:114

Cluster member

Index Signature​

[key: string]: object

metrics​

metrics: object

Defined in: packages/runtime/src/services/cluster.service.ts:144

Get metrics

members​

members: Gauge

Overrides​

VersionService.metrics

models​

models: object

Defined in: packages/runtime/src/services/cluster.service.ts:131

Models defined in the app

Index Signature​

[key: string]: any

name​

readonly name: string

Defined in: packages/core/lib/services/iservice.d.ts:19

Inherited from​

EchoService.name

nodeData​

nodeData: any = {}

Defined in: packages/runtime/src/services/cluster.service.ts:156

Node data to send to other nodes

parameters​

readonly parameters: T

Defined in: packages/core/lib/services/iservice.d.ts:20

Inherited from​

Service.parameters

pubSub​

pubSub: PubSubService<ClusterMessage>

Defined in: packages/runtime/src/services/cluster.service.ts:104

services​

services: object

Defined in: packages/runtime/src/services/cluster.service.ts:137

Services defined in the app

Index Signature​

[key: string]: any

stores​

stores: object

Defined in: packages/runtime/src/services/cluster.service.ts:142

Stores defined in the app

Index Signature​

[key: string]: Store<StoreParameters, StoreEvents>

createConfiguration?​

static optional createConfiguration?: (params) => any

Defined in: packages/core/lib/services/iservice.d.ts:24

Create configuration set by the application on load

Parameters​

params​

any

Returns​

any

Inherited from​

Service.createConfiguration

filterConfiguration?​

static optional filterConfiguration?: (params) => any

Defined in: packages/core/lib/services/iservice.d.ts:28

Create configuration set by the application on load

Parameters​

params​

any

Returns​

any

Inherited from​

Service.filterConfiguration

Parameters​

static Parameters: typeof ServiceParameters

Defined in: packages/core/lib/services/service.d.ts:46

Service parameters

Inherited from​

Service.Parameters

Methods​

__clean()​

abstract __clean(): Promise<void>

Defined in: packages/core/lib/services/service.d.ts:215

Clean the service data, can only be used in test mode

Returns​

Promise<void>

Inherited from​

Service.__clean

addListener()​

addListener<Key>(eventName, listener): this

Defined in: packages/core/lib/events/asynceventemitter.d.ts:80

Type Parameters​

Key​

Key extends never

Parameters​

eventName​

Key

the event name

listener​

(event) => void | Promise<void>

the event listener

Returns​

this

this for chaining

See​

EventEmitter.addListener

Inherited from​

Service.addListener

addRoute()​

protected addRoute(url, methods, executer, openapi?, override?): void

Defined in: packages/core/lib/services/service.d.ts:177

Add a route dynamicaly

Parameters​

url​

string

of the route can contains dynamic part like {uuid}

methods​

HttpMethodType[]

the HTTP methods

executer​

Function

Method to execute for this route

openapi?​

OpenAPIWebdaDefinition

the OpenAPI specification

override?​

boolean

whether to override existing

Returns​

void

Inherited from​

Service.addRoute

authorizeClientEvent()​

authorizeClientEvent(_event, _context): boolean

Defined in: packages/core/lib/services/service.d.ts:153

Authorize a public event subscription

Parameters​

_event​

string

the event name

_context​

OperationContext

the execution context

Returns​

boolean

true if the condition is met

Inherited from​

Service.authorizeClientEvent

computeParameters()​

computeParameters(): void

Defined in: packages/core/lib/services/service.d.ts:77

Used to compute or derivate input parameter to attribute

Returns​

void

Deprecated​

Inherited from​

Service.computeParameters

emit()​

emit<Key>(event, data): Promise<void>

Defined in: packages/core/lib/services/service.d.ts:204

Emit the event with data and wait for Promise to finish if listener returned a Promise

Type Parameters​

Key​

Key extends never

Parameters​

event​

Key

the event name

data​

object[Key]

the data to process

Returns​

Promise<void>

Inherited from​

Service.emit

getCapabilities()​

getCapabilities(): Record<string, any>

Defined in: packages/core/lib/services/iservice.d.ts:61

Return the capabilities of this service.

By default returns capabilities detected at compile-time from

Returns​

Record<string, any>

the result

Webda Capability-tagged​

interfaces in webda.module.json.

Override to disable capabilities based on configuration:

getCapabilities() {
  const caps = super.getCapabilities();
  if (!this.parameters.enabled) delete caps["request-filter"];
  return caps;
}

Inherited from​

Service.getCapabilities

getClientEvents()​

getClientEvents(): string[]

Defined in: packages/core/lib/services/service.d.ts:144

Return the events that an external system can subscribe to

Returns​

string[]

the list of results

Inherited from​

Service.getClientEvents

getKeepAliveMessage()​

getKeepAliveMessage(): Promise<Partial<ClusterMessage>>

Defined in: packages/runtime/src/services/cluster.service.ts:265

Return the keep alive message to be sent

Useful to override to add some dynamic data If the data is static you can use setMemberInfo

Returns​

Promise<Partial<ClusterMessage>>

partial cluster message to broadcast as keep-alive

getMaxListeners()​

getMaxListeners(): number

Defined in: packages/core/lib/events/asynceventemitter.d.ts:84

Returns​

number

Inherited from​

Service.getMaxListeners

getMembers()​

getMembers(): object

Defined in: packages/runtime/src/services/cluster.service.ts:162

Return cluster members including this node

Returns​

object

map of member IDs to their metadata and lastSeen timestamps

getMetric()​

getMetric<T>(type, configuration): T

Defined in: packages/core/lib/services/service.d.ts:138

Add service name label

Type Parameters​

T​

T = Gauge<string> | Counter<string> | Histogram<string>

Parameters​

type​

CustomConstructor<T, [MetricConfiguration<T>]>

the type to look up

configuration​

MetricConfiguration<T>

the configuration

Returns​

T

the result

Inherited from​

Service.getMetric

getName()​

getName(): string

Defined in: packages/core/lib/services/service.d.ts:209

Get service name

Returns​

string

the result string

Inherited from​

Service.getName

getOpenApiReplacements()​

getOpenApiReplacements(): any

Defined in: packages/core/lib/services/service.d.ts:182

Return variables for replacement in openapi

Returns​

any

the result

Inherited from​

Service.getOpenApiReplacements

getOperationId()​

getOperationId(id): string

Defined in: packages/core/lib/services/service.d.ts:167

If undefined is returned it cancel the operation registration

Parameters​

id​

string

the identifier

Returns​

string

the result

Inherited from​

Service.getOperationId

getParameters()​

getParameters(): T

Defined in: packages/core/lib/services/service.d.ts:82

Get the service parameters

Returns​

T

the result

Inherited from​

Service.getParameters

getService()​

getService<T>(name): ServicesMap[T]

Defined in: packages/core/lib/services/service.d.ts:131

Get a service by name

Type Parameters​

T​

T extends keyof ServicesMap

Parameters​

name​

T

the name to use

Returns​

ServicesMap[T]

the result map

Deprecated​

Use useService, might reconsider

Inherited from​

Service.getService

getState()​

getState(): ServiceStates

Defined in: packages/core/lib/services/service.d.ts:55

Get the current state

Returns​

ServiceStates

the result

Inherited from​

Service.getState

getUrl()​

getUrl(url, _methods): string

Defined in: packages/core/lib/services/service.d.ts:161

Return the full path url based on parameters

Parameters​

url​

string

relative url to service

_methods​

HttpMethodType[]

in case we need filtering (like Store)

Returns​

string

absolute url or undefined if need to skip the Route

Inherited from​

Service.getUrl

handleMessage()​

protected handleMessage(message): Promise<void>

Defined in: packages/runtime/src/services/cluster.service.ts:369

Dispatch a message received from the pub/sub to the appropriate local emitter

Parameters​

message​

ClusterMessage

incoming cluster message with type, emitter, and event data

Returns​

Promise<void>

init()​

init(): Promise<ClusterService<T>>

Defined in: packages/runtime/src/services/cluster.service.ts:188

Subscribe to model, service, and store events for cross-instance replication

Returns​

Promise<ClusterService<T>>

this instance for chaining

Overrides​

Service.init

initMetrics()​

initMetrics(): void

Defined in: packages/runtime/src/services/cluster.service.ts:178

Add a prometheus gauge for members in the cluster

Returns​

void

Overrides​

Service.initMetrics

initOperations()​

initOperations(): void

Defined in: packages/core/lib/services/service.d.ts:186

Init the operations from

Returns​

void

Operation​

decorators on this service

Inherited from​

Service.initOperations

listeners()​

listeners(eventName): Function[]

Defined in: packages/core/lib/events/asynceventemitter.d.ts:139

Get all listeners for an event

Parameters​

eventName​

never

the event name

Returns​

Function[]

the list of results

Inherited from​

Service.listeners

loadCapabilities()​

protected loadCapabilities(): void

Defined in: packages/core/lib/services/service.d.ts:120

Load capabilities from webda.module.json metadata into _compiledCapabilities.

Called during resolve after dependency injection. Reads the service's type name from parameters, looks it up in the application's module metadata (moddas or beans section), and populates _compiledCapabilities with an empty object for each declared capability name.

Fails silently if the application is not available (e.g., in unit tests where services are instantiated without a full application context).

Returns​

void

Example​

// If webda.module.json contains:
// { "moddas": { "MyApp/HawkService": { "capabilities": ["request-filter", "cors-filter"] } } }
// Then after resolve(), this.getCapabilities() returns:
// { "request-filter": {}, "cors-filter": {} }

See​

getCapabilities

Inherited from​

Service.loadCapabilities

loadParameters()​

loadParameters(params): ServiceParameters

Defined in: packages/runtime/src/services/cluster.service.ts:169

Parameters​

params​

any

Returns​

ServiceParameters

log()​

log(level, ...args): void

Defined in: packages/core/lib/services/service.d.ts:226

Parameters​

level​

WorkerLogLevel

to log

args​

...any[]

additional arguments

Returns​

void

Inherited from​

Service.log

off()​

off<Key>(eventName, listener): this

Defined in: packages/core/lib/events/asynceventemitter.d.ts:116

Type Parameters​

Key​

Key extends never

Parameters​

eventName​

Key

the event name

listener​

(event) => void

the event listener

Returns​

this

this for chaining

See​

EventEmitter.off

Inherited from​

Service.off

on()​

on<Key>(eventName, listener): this

Defined in: packages/core/lib/events/asynceventemitter.d.ts:102

Type Parameters​

Key​

Key extends never

Parameters​

eventName​

Key

the event name

listener​

(event) => void

the event listener

Returns​

this

this for chaining

See​

EventEmitter.once

Inherited from​

Service.on

once()​

once<Key>(eventName, listener): this

Defined in: packages/core/lib/events/asynceventemitter.d.ts:95

Type Parameters​

Key​

Key extends never

Parameters​

eventName​

Key

the event name

listener​

(event) => void

the event listener

Returns​

this

this for chaining

See​

EventEmitter.once

Inherited from​

Service.once

ready()​

ready(): boolean

Defined in: packages/runtime/src/services/cluster.service.ts:318

Whether this cluster node has completed initialization and sent its welcome

Returns​

boolean

true if the service has joined the cluster

readyEndpoint()​

readyEndpoint(ctx): void

Defined in: packages/runtime/src/services/cluster.service.ts:306

Health-check endpoint returning 503 until the cluster is ready

Parameters​

ctx​

WebContext

incoming web context

Returns​

void

removeAllListeners()​

removeAllListeners<Key>(eventName?): this

Defined in: packages/core/lib/events/asynceventemitter.d.ts:122

Type Parameters​

Key​

Key extends never

Parameters​

eventName?​

Key

the event name

Returns​

this

this for chaining

See​

EventEmitter.removeAllListeners

Inherited from​

Service.removeAllListeners

removeListener()​

removeListener<Key>(eventName, listener): this

Defined in: packages/core/lib/events/asynceventemitter.d.ts:109

Type Parameters​

Key​

Key extends never

Parameters​

eventName​

Key

the event name

listener​

(event) => void

the event listener

Returns​

this

this for chaining

See​

EventEmitter.removeListener

Inherited from​

Service.removeListener

resolve()​

resolve(): this

Defined in: packages/runtime/src/services/cluster.service.ts:346

Populate node metadata from package.json and CLUSTER_* environment variables

Returns​

this

this instance for chaining

Overrides​

Service.resolve

sendMessage()​

sendMessage(message, force?): Promise<void>

Defined in: packages/runtime/src/services/cluster.service.ts:328

Broadcast a message to other cluster members via pub/sub

Parameters​

message​

Partial<ClusterMessage>

partial cluster message to send

force?​

boolean

send even if no other members are known

Returns​

Promise<void>

setMaxListeners()​

setMaxListeners(n): this

Defined in: packages/core/lib/events/asynceventemitter.d.ts:88

Parameters​

n​

number

Returns​

this

Inherited from​

Service.setMaxListeners

setMemberInfo()​

setMemberInfo(data?, erase?): void

Defined in: packages/runtime/src/services/cluster.service.ts:254

Allow to set some data on the member

Parameters​

data?​

any = {}

key-value pairs to attach to this node's member info

erase?​

boolean

if true, replaces all existing data instead of merging

Returns​

void

stop()​

stop(): Promise<void>

Defined in: packages/core/lib/services/service.d.ts:86

Shutdown the current service if action need to be taken

Returns​

Promise<void>

Inherited from​

Service.stop

toJSON()​

toJSON(): string

Defined in: packages/core/lib/services/service.d.ts:191

Prevent service to be serialized

Returns​

string

the result

Inherited from​

Service.toJSON

toString()​

toString(): string

Defined in: packages/core/lib/services/service.d.ts:91

Return service representation

Returns​

string

the result

Inherited from​

Service.toString

updateCluster()​

updateCluster(): Promise<void>

Defined in: packages/runtime/src/services/cluster.service.ts:278

Send a keep alive on pub/sub and remove any member that we haven't seen in the last 64s -> missed 2 ttl

Returns​

Promise<void>