All files / packages/coordination/src node.ts

56.41% Statements 22/39
66.66% Branches 20/30
100% Functions 7/7
56.41% Lines 22/39

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153                                            10x                                       11x       8x 8x 8x                                             4x     4x       80x 80x 80x                             2x 2x 2x                             81x 81x 81x                             10x 82x               82x     10x 4x               4x    
import * as assert from 'node:assert/strict'
 
import { create, fromBinary } from '@bufbuild/protobuf'
import {
	AlterNodeRequestSchema,
	type Config,
	ConfigSchema,
	ConsistencyMode,
	CoordinationServiceDefinition,
	CreateNodeRequestSchema,
	DescribeNodeRequestSchema,
	DescribeNodeResultSchema,
	DropNodeRequestSchema,
	RateLimiterCountersMode,
} from '@ydbjs/api/coordination'
import { StatusIds_StatusCode } from '@ydbjs/api/operation'
import type { Entry } from '@ydbjs/api/scheme'
import type { Driver } from '@ydbjs/core'
import { loggers } from '@ydbjs/debug'
import { YDBError } from '@ydbjs/error'
import type { Client } from 'nice-grpc'
 
let dbg = loggers.coordination.extend('node')
 
export interface CoordinationNodeConfig {
	selfCheckPeriod?: number
	sessionGracePeriod?: number
 
	readConsistencyMode?: ConsistencyMode
	attachConsistencyMode?: ConsistencyMode
	rateLimiterCountersMode?: RateLimiterCountersMode
}
 
export interface CoordinationNodeDescription {
	self?: Entry
	config: CoordinationNodeConfig
}
 
export class CoordinationNodeRuntime {
	#client: Client<typeof CoordinationServiceDefinition>
 
	constructor(driver: Driver) {
		this.#client = driver.createClient(CoordinationServiceDefinition)
	}
 
	async describe(path: string, signal?: AbortSignal): Promise<CoordinationNodeDescription> {
		dbg.log('reading configuration of coordination node at %s', path)
		let request = create(DescribeNodeRequestSchema, { path })
		let response = signal
			? await this.#client.describeNode(request, { signal })
			: await this.#client.describeNode(request)
 
		assert.ok(response.operation, 'Missing operation in coordination response')
		assert.ok(response.operation.ready, 'Coordination operation is not ready')
		assert.strictEqual(
			response.operation.status,
			StatusIds_StatusCode.SUCCESS,
			new YDBError(response.operation.status, response.operation.issues)
		)
 
		assert.ok(response.operation.result, 'Missing result in coordination response')
 
		let describeResult = fromBinary(DescribeNodeResultSchema, response.operation.result.value)
 
		assert.ok(describeResult.config, 'Missing config in coordination node description')
 
		let description: CoordinationNodeDescription = {
			config: fromNodeConfigMessage(describeResult.config),
		}
 
		if (describeResult.self) {
			description.self = describeResult.self
		}
 
		return description
	}
 
	async create(path: string, cfg: CoordinationNodeConfig, signal?: AbortSignal): Promise<void> {
		dbg.log('creating coordination node at %s', path)
		let request = create(CreateNodeRequestSchema, { path, config: toNodeConfigMessage(cfg) })
		let response = signal
			? await this.#client.createNode(request, { signal })
			: await this.#client.createNode(request)
 
		assert.ok(response.operation, 'Missing operation in coordination response')
		assert.ok(response.operation.ready, 'Coordination operation is not ready')
 
		assert.strictEqual(
			response.operation.status,
			StatusIds_StatusCode.SUCCESS,
			new YDBError(response.operation.status, response.operation.issues)
		)
	}
 
	async alter(path: string, cfg: CoordinationNodeConfig, signal?: AbortSignal): Promise<void> {
		dbg.log('updating configuration of coordination node at %s', path)
		let request = create(AlterNodeRequestSchema, { path, config: toNodeConfigMessage(cfg) })
		let response = signal
			? await this.#client.alterNode(request, { signal })
			: await this.#client.alterNode(request)
 
		assert.ok(response.operation, 'Missing operation in coordination response')
		assert.ok(response.operation.ready, 'Coordination operation is not ready')
 
		assert.strictEqual(
			response.operation.status,
			StatusIds_StatusCode.SUCCESS,
			new YDBError(response.operation.status, response.operation.issues)
		)
	}
 
	async drop(path: string, signal?: AbortSignal): Promise<void> {
		dbg.log('dropping coordination node at %s', path)
		let request = create(DropNodeRequestSchema, { path })
		let response = signal
			? await this.#client.dropNode(request, { signal })
			: await this.#client.dropNode(request)
 
		assert.ok(response.operation, 'Missing operation in coordination response')
		assert.ok(response.operation.ready, 'Coordination operation is not ready')
 
		assert.strictEqual(
			response.operation.status,
			StatusIds_StatusCode.SUCCESS,
			new YDBError(response.operation.status, response.operation.issues)
		)
	}
}
 
let toNodeConfigMessage = function toNodeConfigMessage(config: CoordinationNodeConfig) {
	let configMessage = create(ConfigSchema, {
		selfCheckPeriodMillis: config.selfCheckPeriod ?? 0,
		sessionGracePeriodMillis: config.sessionGracePeriod ?? 0,
		readConsistencyMode: config.readConsistencyMode ?? ConsistencyMode.UNSET,
		attachConsistencyMode: config.attachConsistencyMode ?? ConsistencyMode.UNSET,
		rateLimiterCountersMode: config.rateLimiterCountersMode ?? RateLimiterCountersMode.UNSET,
	})
 
	return configMessage
}
 
let fromNodeConfigMessage = function fromNodeConfigMessage(config: Config): CoordinationNodeConfig {
	let nodeConfig: CoordinationNodeConfig = {
		selfCheckPeriod: config.selfCheckPeriodMillis ?? undefined,
		sessionGracePeriod: config.sessionGracePeriodMillis ?? undefined,
		readConsistencyMode: config.readConsistencyMode ?? ConsistencyMode.UNSET,
		attachConsistencyMode: config.attachConsistencyMode ?? ConsistencyMode.UNSET,
		rateLimiterCountersMode: config.rateLimiterCountersMode ?? RateLimiterCountersMode.UNSET,
	}
 
	return nodeConfig
}