StoreClusterService
Class: StoreClusterService<T>
Defined in: packages/core/src/services/storecluster.service.ts:28
Leader election on a Registry entry cluster:<leaseName>
The lease is { owner, leaseUntil }, written with a conditional patch on leaseUntil: two instances never both
win. It works on every store backing the Registry.
Webda Modda
Extends
Type Parameters
T
T extends StoreClusterServiceParameters = StoreClusterServiceParameters
Constructors
Constructor
new StoreClusterService<
T>(name,params):StoreClusterService<T>
Defined in: packages/core/src/services/service.ts:205
Create a new Service instance
Service
Parameters
name
string
The name of the service
params
T
The parameters block define in the configuration file
Returns
StoreClusterService<T>
Inherited from
Properties
_compiledCapabilities
protected_compiledCapabilities:Record<string,any> ={}
Defined in: packages/core/src/services/iservice.ts:61
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
ClusterService._compiledCapabilities
[WEBDA_EVENTS]
[WEBDA_EVENTS]:
object
Defined in: packages/core/src/services/service.ts:179
Set the Webda events here
Inherited from
deadlineTimer?
protectedoptionaldeadlineTimer?:Timeout
Defined in: packages/core/src/services/cluster.service.ts:192
Step down when no attempt succeeded before the deadline
Inherited from
leading
protectedleading:boolean=false
Defined in: packages/core/src/services/cluster.service.ts:186
Whether this instance holds the lease
Inherited from
leaseUntil?
protectedoptionalleaseUntil?:number
Defined in: packages/core/src/services/storecluster.service.ts:37
leaseUntil last written by this instance
logger
protectedlogger:Logger
Defined in: packages/core/src/services/service.ts:192
Logger with class context
Inherited from
metrics?
protectedoptionalmetrics?:object
Defined in: packages/core/src/services/service.ts:196
Get metrics
Inherited from
name
readonlyname:string
Defined in: packages/core/src/services/iservice.ts:35
Name
Inherited from
parameters
readonlyparameters:T
Defined in: packages/core/src/services/iservice.ts:39
Parameters
Inherited from
registrations
protectedregistrations:LeaderRegistrations
Defined in: packages/core/src/services/cluster.service.ts:194
whenLeader registrations
Inherited from
running
protectedrunning:boolean=false
Defined in: packages/core/src/services/cluster.service.ts:188
Whether the election loop runs
Inherited from
timer?
protectedoptionaltimer?:Timeout
Defined in: packages/core/src/services/cluster.service.ts:190
Next attempt
Inherited from
createConfiguration?
staticoptionalcreateConfiguration?: (params) =>any
Defined in: packages/core/src/services/iservice.ts:44
Create configuration set by the application on load
Parameters
params
any
Returns
any
Inherited from
ClusterService.createConfiguration
filterConfiguration?
staticoptionalfilterConfiguration?: (params) =>any
Defined in: packages/core/src/services/iservice.ts:49
Create configuration set by the application on load
Parameters
params
any
Returns
any
Inherited from
ClusterService.filterConfiguration
Parameters
staticParameters: typeofStoreClusterServiceParameters=StoreClusterServiceParameters
Defined in: packages/core/src/services/storecluster.service.ts:34
Parameters
Overrides
Methods
__clean()
abstract__clean():Promise<void>
Defined in: packages/core/src/services/service.ts:539
Clean the service data, can only be used in test mode
Returns
Promise<void>
Inherited from
acquireOrRenew()
protectedacquireOrRenew():Promise<boolean>
Defined in: packages/core/src/services/storecluster.service.ts:48
Returns
Promise<boolean>
Overrides
addListener()
addListener<
Key>(eventName,listener):this
Defined in: packages/core/src/events/asynceventemitter.ts:90
Add listener
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
addRoute()
protectedaddRoute(url,methods,executer,openapi?,override?):void
Defined in: packages/core/src/services/service.ts:400
Add a route dynamicaly
Parameters
url
string
of the route can contains dynamic part like {uuid}
methods
the HTTP methods
executer
Function
Method to execute for this route
openapi?
the OpenAPI specification
override?
boolean = false
whether to override existing
Returns
void
Inherited from
attempt()
protectedattempt():Promise<void>
Defined in: packages/core/src/services/cluster.service.ts:277
Acquire or renew the lease once, then schedule the next attempt
The callbacks are not awaited: a long fn never delays the renewals.
Returns
Promise<void>
Inherited from
authorizeClientEvent()
authorizeClientEvent(
_event,_context):boolean
Defined in: packages/core/src/services/service.ts:353
Authorize a public event subscription
Parameters
_event
string
the event name
_context
the execution context
Returns
boolean
true if the condition is met
Inherited from
ClusterService.authorizeClientEvent
computeParameters()
computeParameters():
void
Defined in: packages/core/src/services/service.ts:214
Used to compute or derivate input parameter to attribute
Returns
void
Deprecated
Inherited from
ClusterService.computeParameters
emit()
emit<
Key>(event,data):Promise<void>
Defined in: packages/core/src/services/service.ts:520
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
getCapabilities()
getCapabilities():
Record<string,any>
Defined in: packages/core/src/services/iservice.ts:89
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
ClusterService.getCapabilities
getClientEvents()
getClientEvents():
string[]
Defined in: packages/core/src/services/service.ts:341
Return the events that an external system can subscribe to
Returns
string[]
the list of results
Inherited from
ClusterService.getClientEvents
getInstanceId()
getInstanceId():
string
Defined in: packages/core/src/services/cluster.service.ts:222
Returns
string
Inherited from
getLeadingWindow()
protectedgetLeadingWindow():number
Defined in: packages/core/src/services/cluster.service.ts:314
Get milliseconds after the start of a successful attempt during which this instance leads:
Returns
number
milliseconds after the start of a successful attempt during which this instance leads:
(leaseDuration + renewInterval) / 2, between the next attempt and the expiry of the lease
Inherited from
ClusterService.getLeadingWindow
getMaxListeners()
getMaxListeners():
number
Defined in: packages/core/src/events/asynceventemitter.ts:97
Returns
number
Inherited from
ClusterService.getMaxListeners
getMetric()
getMetric<
T>(type,configuration):T
Defined in: packages/core/src/services/service.ts:323
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
the configuration
Returns
T
the result
Inherited from
getName()
getName():
string
Defined in: packages/core/src/services/service.ts:530
Get service name
Returns
string
the result string
Inherited from
getOpenApiReplacements()
getOpenApiReplacements():
any
Defined in: packages/core/src/services/service.ts:429
Return variables for replacement in openapi
Returns
any
the result
Inherited from
ClusterService.getOpenApiReplacements
getOperationId()
getOperationId(
id):string
Defined in: packages/core/src/services/service.ts:387
If undefined is returned it cancel the operation registration
Parameters
id
string
the identifier
Returns
string
the result
Inherited from
getParameters()
getParameters():
T
Defined in: packages/core/src/services/service.ts:222
Get the service parameters
Returns
T
the result
Inherited from
getService()
getService<
T>(name):ServicesMap[T]
Defined in: packages/core/src/services/service.ts:313
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
getState()
getState():
ServiceStates
Defined in: packages/core/src/services/service.ts:185
Get the current state
Returns
the result
Inherited from
getUrl()
getUrl(
url,_methods):string
Defined in: packages/core/src/services/service.ts:364
Return the full path url based on parameters
Parameters
url
string
relative url to service
_methods
in case we need filtering (like Store)
Returns
string
absolute url or undefined if need to skip the Route
Inherited from
init()
init():
Promise<StoreClusterService<T>>
Defined in: packages/core/src/services/cluster.service.ts:245
Start the election loop
Returns
Promise<StoreClusterService<T>>
once the first attempt is done
Inherited from
initMetrics()
initMetrics():
void
Defined in: packages/core/src/services/service.ts:303
Init the metrics
Returns
void
Inherited from
initOperations()
initOperations():
void
Defined in: packages/core/src/services/service.ts:459
Init the operations from
Returns
void
Operation
decorators on this service
Inherited from
isLeader()
isLeader():
boolean
Defined in: packages/core/src/services/cluster.service.ts:217
Returns
boolean
Inherited from
leaseChanged()
protectedleaseChanged(entry):Promise<boolean>
Defined in: packages/core/src/services/storecluster.service.ts:84
After a failed conditional patch, tell a lost race from any other Registry failure
Stores do not all raise UpdateConditionFailError on a failed condition.
Parameters
entry
LeaseEntry
the lease the patch expected
Returns
Promise<boolean>
whether the lease changed since it was read
leaseId()
protectedleaseId():string
Defined in: packages/core/src/services/storecluster.service.ts:43
Return the Registry entry id of the lease
Returns
string
the Registry entry id of the lease
listeners()
listeners(
eventName):Function[]
Defined in: packages/core/src/events/asynceventemitter.ts:195
Get all listeners for an event
Parameters
eventName
never
the event name
Returns
Function[]
the list of results
Inherited from
loadCapabilities()
protectedloadCapabilities():void
Defined in: packages/core/src/services/service.ts:283
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
ClusterService.loadCapabilities
log()
log(
level, ...args):void
Defined in: packages/core/src/services/service.ts:561
Log operation
Parameters
level
WorkerLogLevel
to log
args
...any[]
additional arguments
Returns
void
Inherited from
off()
off<
Key>(eventName,listener):this
Defined in: packages/core/src/events/asynceventemitter.ts:152
Perform off
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
on()
on<
Key>(eventName,listener):this
Defined in: packages/core/src/events/asynceventemitter.ts:128
Perform on
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
once()
once<
Key>(eventName,listener):this
Defined in: packages/core/src/events/asynceventemitter.ts:116
Perform once
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
operationSchemaName()
protectedoperationSchemaName(method,side):string
Defined in: packages/core/src/services/service.ts:441
Schema of an operation side: <service name>.<method>.<side> when the application knows it, else the one the
build writes, <class>.<method>.<side>, for the class or its nearest ancestor that has it (a service configured
under another name than its class)
Parameters
method
string
the method name
side
"input" | "output"
input or output
Returns
string
the schema name
Inherited from
ClusterService.operationSchemaName
release()
protectedrelease():Promise<void>
Defined in: packages/core/src/services/storecluster.service.ts:94
Returns
Promise<void>
Overrides
removeAllListeners()
removeAllListeners<
Key>(eventName?):this
Defined in: packages/core/src/events/asynceventemitter.ts:162
Remove all listeners
Type Parameters
Key
Key extends never
Parameters
eventName?
Key
the event name
Returns
this
this for chaining
See
EventEmitter.removeAllListeners
Inherited from
ClusterService.removeAllListeners
removeListener()
removeListener<
Key>(eventName,listener):this
Defined in: packages/core/src/events/asynceventemitter.ts:140
Remove listener
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
resolve()
resolve():
this
Defined in: packages/core/src/services/cluster.service.ts:230
Adopt the free whenLeader registrations made before this service was created
Returns
this
this
Inherited from
setLeading()
protectedsetLeading(leading):Promise<void>
Defined in: packages/core/src/services/cluster.service.ts:343
Change the leadership, running the callbacks of the registrations
Parameters
leading
boolean
whether this instance leads
Returns
Promise<void>
once the callbacks settled
Inherited from
setMaxListeners()
setMaxListeners(
n):this
Defined in: packages/core/src/events/asynceventemitter.ts:104
Parameters
n
number
Returns
this
Inherited from
ClusterService.setMaxListeners
stop()
stop():
Promise<void>
Defined in: packages/core/src/services/cluster.service.ts:255
Stop the election loop, release the lease when held and call the deregisteredFns
Returns
Promise<void>
Inherited from
toJSON()
toJSON():
string
Defined in: packages/core/src/services/service.ts:499
Prevent service to be serialized
Returns
string
the result
Inherited from
toString()
toString():
string
Defined in: packages/core/src/services/service.ts:238
Return service representation
Returns
string
the result
Inherited from
whenLeader()
whenLeader(
fn,deregisteredFn?): () =>void
Defined in: packages/core/src/services/cluster.service.ts:212
Parameters
fn
deregisteredFn?
Returns
() => void
Inherited from
withTimeout()
protectedwithTimeout<R>(attempt):Promise<R>
Defined in: packages/core/src/services/cluster.service.ts:323
Fail an attempt that does not answer within leaseDuration - renewInterval
Type Parameters
R
R
Parameters
attempt
Promise<R>
the attempt
Returns
Promise<R>
its result