GrpcService

@webda/grpc

---

Class: GrpcService<T>

Defined in: grpc/src/grpcservice.service.ts:87

gRPC transport service.

Exposes Webda operations as gRPC services over HTTP/2. Hooks into the HttpServer via the Webda.Init.Http event to intercept requests with content-type: application/grpc.

Run webdac build to generate the .proto file from operations.

Webda Modda

Extends

• OperationsTransport<T>

Type Parameters

T

T extends GrpcServiceParameters = GrpcServiceParameters

Constructors

Constructor

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

Defined in: 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

GrpcService<T>

Inherited from

OperationsTransport<T>.constructor

Properties

_compiledCapabilities

protected _compiledCapabilities: Record<string, any>

Defined in: core/lib/services/iservice.d.ts:38

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

OperationsTransport._compiledCapabilities

---

[WEBDA_EVENTS]

[WEBDA_EVENTS]: object

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

Set the Webda events here

Inherited from

OperationsTransport.[WEBDA_EVENTS]

---

logger

protected logger: Logger

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

Logger with class context

Inherited from

OperationsTransport.logger

---

metrics?

protected optional metrics?: object

Defined in: core/lib/services/service.d.ts:63

Get metrics

Inherited from

OperationsTransport.metrics

---

name

readonly name: string

Defined in: core/lib/services/iservice.d.ts:18

Inherited from

OperationsTransport.name

---

parameters

readonly parameters: T

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

Inherited from

OperationsTransport.parameters

---

filterConfiguration?

static optional filterConfiguration?: (params) => any

Defined in: core/lib/services/iservice.d.ts:27

Create configuration set by the application on load

Parameters

params

any

Returns

any

Inherited from

OperationsTransport.filterConfiguration

---

Parameters

static Parameters: typeof ServiceParameters

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

Service parameters

Inherited from

OperationsTransport.Parameters

Methods

__clean()

abstract __clean(): Promise<void>

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

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

Returns

Promise<void>

Inherited from

OperationsTransport.__clean

---

addListener()

addListener<Key>(eventName, listener): this

Defined in: 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

OperationsTransport.addListener

---

addRoute()

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

Defined in: 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

OperationsTransport.addRoute

---

authorizeClientEvent()

authorizeClientEvent(_event, _context): boolean

Defined in: 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

OperationsTransport.authorizeClientEvent

---

build()

build(): Promise<void>

Defined in: grpc/src/grpcservice.service.ts:112

Generate a .proto file from the current operation registry.

Returns

Promise<void>

a promise that resolves when the proto file has been written to disk

---

computeParameters()

computeParameters(): void

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

Used to compute or derivate input parameter to attribute

Returns

void

Deprecated

Inherited from

OperationsTransport.computeParameters

---

emit()

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

Defined in: 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

OperationsTransport.emit

---

exposeOperation()

exposeOperation(_operationId, _definition): void

Defined in: grpc/src/grpcservice.service.ts:451

No-op — gRPC operations are exposed via the proto definition, not individual routes.

Parameters

_operationId

string

the operation ID (unused; routing is handled by the proto definition)

_definition

OperationDefinition

the operation definition (unused)

Returns

void

void

Overrides

OperationsTransport.exposeOperation

---

getCapabilities()

getCapabilities(): Record<string, any>

Defined in: core/lib/services/iservice.d.ts:60

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

OperationsTransport.getCapabilities

---

getClientEvents()

getClientEvents(): string[]

Defined in: 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

OperationsTransport.getClientEvents

---

getMaxListeners()

getMaxListeners(): number

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

Returns

number

Inherited from

OperationsTransport.getMaxListeners

---

getMetric()

getMetric<T>(type, configuration): T

Defined in: 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

OperationsTransport.getMetric

---

getName()

getName(): string

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

Get service name

Returns

string

the result string

Inherited from

OperationsTransport.getName

---

getOpenApiReplacements()

getOpenApiReplacements(): any

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

Return variables for replacement in openapi

Returns

any

the result

Inherited from

OperationsTransport.getOpenApiReplacements

---

getOperationId()

getOperationId(id): string | undefined

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

If undefined is returned it cancel the operation registration

Parameters

id

string

the identifier

Returns

string | undefined

the result

Inherited from

OperationsTransport.getOperationId

---

getOperations()

getOperations(): Record<string, OperationDefinition>

Defined in: core/lib/services/operationstransport.d.ts:61

Get all registered operations, filtered by this transport's include/exclude config

Returns

Record<string, OperationDefinition>

filtered map of operation id to definition

Inherited from

OperationsTransport.getOperations

---

getParameters()

getParameters(): T

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

Get the service parameters

Returns

T

the result

Inherited from

OperationsTransport.getParameters

---

getService()

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

Defined in: 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

OperationsTransport.getService

---

getState()

getState(): ServiceStates

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

Get the current state

Returns

ServiceStates

the result

Inherited from

OperationsTransport.getState

---

getUrl()

getUrl(url, _methods): string

Defined in: 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

OperationsTransport.getUrl

---

handleGrpcRequest()

handleGrpcRequest(req, res, server?): Promise<void>

Defined in: grpc/src/grpcservice.service.ts:290

Handle an incoming gRPC request: one path for the four modes. Incoming messages feed the operation (as its input, or as the stream in operationInputStream), streamed output is sent as it is produced.

Called by the HttpServer when content-type is application/grpc.

Parameters

req

IncomingMessage

HTTP/2 request carrying the gRPC method path and framed message body

res

ServerResponse

HTTP/2 response used to write gRPC frames and trailers

server?

the HttpServer that received the request, it extracts the client certificate

extractClientCertificate?

(req) => ClientCertificate | undefined

client certificate of the request

Returns

Promise<void>

a promise that resolves when the response has been fully sent

---

init()

init(): Promise<GrpcService<T>>

Defined in: grpc/src/grpcservice.service.ts:189

Initialize the gRPC transport: load proto, build RPC map, hook into HTTP/2.

Returns

Promise<GrpcService<T>>

a promise resolving to this service instance once initialization is complete

Overrides

OperationsTransport.init

---

initMetrics()

initMetrics(): void

Defined in: core/lib/services/service.d.ts:124

Init the metrics

Returns

void

Inherited from

OperationsTransport.initMetrics

---

initOperations()

initOperations(): void

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

Init the operations from

Returns

void

Operation

decorators on this service

Inherited from

OperationsTransport.initOperations

---

initTransport()

protected initTransport(): void

Defined in: core/lib/services/operationstransport.d.ts:70

Walk the filtered operations and call exposeOperation for each non-hidden one

Returns

void

Inherited from

OperationsTransport.initTransport

---

listeners()

listeners(eventName): Function[]

Defined in: 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

OperationsTransport.listeners

---

loadCapabilities()

protected loadCapabilities(): void

Defined in: 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

OperationsTransport.loadCapabilities

---

loadDefinitions()

loadDefinitions(): void

Defined in: grpc/src/grpcservice.service.ts:159

Load the .proto file and map its RPC methods to operations (also callable after registering operations late)

Returns

void

---

log()

log(level, ...args): void

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

Parameters

level

WorkerLogLevel

to log

args

...any[]

additional arguments

Returns

void

Inherited from

OperationsTransport.log

---

off()

off<Key>(eventName, listener): this

Defined in: 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

OperationsTransport.off

---

on()

on<Key>(eventName, listener): this

Defined in: 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

OperationsTransport.on

---

once()

once<Key>(eventName, listener): this

Defined in: 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

OperationsTransport.once

---

removeAllListeners()

removeAllListeners<Key>(eventName?): this

Defined in: 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

OperationsTransport.removeAllListeners

---

removeListener()

removeListener<Key>(eventName, listener): this

Defined in: 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

OperationsTransport.removeListener

---

resolve()

resolve(): this

Defined in: core/lib/services/service.d.ts:98

Resolve parameters and load metadata. @Route-declared routes are scanned and registered by Router.discoverRoutes(services) from Core.init() once every service has resolved — nothing to do per-service here.

Returns

this

the result

Inherited from

OperationsTransport.resolve

---

setMaxListeners()

setMaxListeners(n): this

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

Parameters

n

number

Returns

this

Inherited from

OperationsTransport.setMaxListeners

---

stop()

stop(): Promise<void>

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

Shutdown the current service if action need to be taken

Returns

Promise<void>

Inherited from

OperationsTransport.stop

---

toJSON()

toJSON(): string

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

Prevent service to be serialized

Returns

string

the result

Inherited from

OperationsTransport.toJSON

---

toString()

toString(): string

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

Return service representation

Returns

string

the result

Inherited from

OperationsTransport.toString

---

createConfiguration()

static createConfiguration(params?): GrpcServiceParameters

Defined in: grpc/src/grpcservice.service.ts:99

Parameters

params?

any = {}

raw service parameters

Returns

GrpcServiceParameters

the loaded parameters (with the operations include/exclude filter)

Overrides

OperationsTransport.createConfiguration