grpc
/
grpc-node
mirror of https://github.com/grpc/grpc-node.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

grpc-js: Allow garbage collection of IDLE channels

This commit is contained in:
Michael Lumish 2025-01-31 11:24:19 -08:00
parent c6c69df25b
commit ca21e4ab1f
2 changed files with 59 additions and 39 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
packages/grpc-js/package.json
View File

@ -1,6 +1,6 @@
{
"name": "@grpc/grpc-js",
"version": "1.12.5",
"version": "1.12.6",
"description": "gRPC Library for Node - pure JS implementation",
"homepage": "https://grpc.io/",
"repository": "https://github.com/grpc/grpc-node/tree/master/packages/grpc-js",

96
packages/grpc-js/src/internal-channel.ts
View File

@ -125,10 +125,13 @@ class ChannelSubchannelWrapper
) => {
channel.throttleKeepalive(keepaliveTime);
};
childSubchannel.addConnectivityStateListener(this.subchannelStateListener);
}
ref(): void {
if (this.refCount === 0) {
this.child.addConnectivityStateListener(this.subchannelStateListener);
this.channel.addWrappedSubchannel(this);
}
this.child.ref();
this.refCount += 1;
}
@ -159,6 +162,26 @@ class ShutdownPicker implements Picker {
}
}
class ChannelzInfoTracker {
readonly trace = new ChannelzTrace();
readonly callTracker = new ChannelzCallTracker();
readonly childrenTracker = new ChannelzChildrenTracker();
state: ConnectivityState = ConnectivityState.IDLE;
constructor(private target: string) {}
getChannelzInfoCallback(): () => ChannelInfo {
return () => {
return {
target: this.target,
state: this.state,
trace: this.trace,
callTracker: this.callTracker,
children: this.childrenTracker.getChildLists()
};
};
}
}
export class InternalChannel {
private readonly resolvingLoadBalancer: ResolvingLoadBalancer;
private readonly subchannelPool: SubchannelPool;
@ -179,9 +202,10 @@ export class InternalChannel {
* event loop open while there are any pending calls for the channel that
* have not yet been assigned to specific subchannels. In other words,
* the invariant is that callRefTimer is reffed if and only if pickQueue
* is non-empty.
* is non-empty. In addition, the timer is null while the state is IDLE or
* SHUTDOWN and there are no pending calls.
*/
private readonly callRefTimer: NodeJS.Timeout;
private callRefTimer: NodeJS.Timeout | null = null;
private configSelector: ConfigSelector | null = null;
/**
* This is the error from the name resolver if it failed most recently. It
@ -203,11 +227,8 @@ export class InternalChannel {
// Channelz info
private readonly channelzEnabled: boolean = true;
private readonly originalTarget: string;
private readonly channelzRef: ChannelRef;
private readonly channelzTrace: ChannelzTrace;
private readonly callTracker = new ChannelzCallTracker();
private readonly childrenTracker = new ChannelzChildrenTracker();
private readonly channelzInfoTracker: ChannelzInfoTracker;
/**
* Randomly generated ID to be passed to the config selector, for use by
@ -236,7 +257,7 @@ export class InternalChannel {
throw new TypeError('Channel options must be an object');
}
}
this.originalTarget = target;
this.channelzInfoTracker = new ChannelzInfoTracker(target);
const originalTargetUri = parseUri(target);
if (originalTargetUri === null) {
throw new Error(`Could not parse target name "${target}"`);
@ -250,21 +271,17 @@ export class InternalChannel {
);
}
this.callRefTimer = setInterval(() => {}, MAX_TIMEOUT_TIME);
this.callRefTimer.unref?.();
if (this.options['grpc.enable_channelz'] === 0) {
this.channelzEnabled = false;
}
this.channelzTrace = new ChannelzTrace();
this.channelzRef = registerChannelzChannel(
target,
() => this.getChannelzInfo(),
this.channelzInfoTracker.getChannelzInfoCallback(),
this.channelzEnabled
);
if (this.channelzEnabled) {
this.channelzTrace.addTrace('CT_INFO', 'Channel created');
this.channelzInfoTracker.trace.addTrace('CT_INFO', 'Channel created');
}
if (this.options['grpc.default_authority']) {
@ -305,7 +322,7 @@ export class InternalChannel {
);
subchannel.throttleKeepalive(this.keepaliveTime);
if (this.channelzEnabled) {
this.channelzTrace.addTrace(
this.channelzInfoTracker.trace.addTrace(
'CT_INFO',
'Created subchannel or used existing subchannel',
subchannel.getChannelzRef()
@ -315,7 +332,6 @@ export class InternalChannel {
subchannel,
this
);
this.wrappedSubchannels.add(wrappedSubchannel);
return wrappedSubchannel;
},
updateState: (connectivityState: ConnectivityState, picker: Picker) => {
@ -338,12 +354,12 @@ export class InternalChannel {
},
addChannelzChild: (child: ChannelRef | SubchannelRef) => {
if (this.channelzEnabled) {
this.childrenTracker.refChild(child);
this.channelzInfoTracker.childrenTracker.refChild(child);
}
},
removeChannelzChild: (child: ChannelRef | SubchannelRef) => {
if (this.channelzEnabled) {
this.childrenTracker.unrefChild(child);
this.channelzInfoTracker.childrenTracker.unrefChild(child);
}
},
};
@ -366,7 +382,7 @@ export class InternalChannel {
RETRY_THROTTLER_MAP.delete(this.getTarget());
}
if (this.channelzEnabled) {
this.channelzTrace.addTrace(
this.channelzInfoTracker.trace.addTrace(
'CT_INFO',
'Address resolution succeeded'
);
@ -388,7 +404,7 @@ export class InternalChannel {
},
status => {
if (this.channelzEnabled) {
this.channelzTrace.addTrace(
this.channelzInfoTracker.trace.addTrace(
'CT_WARNING',
'Address resolution failed with code ' +
status.code +
@ -440,16 +456,6 @@ export class InternalChannel {
this.lastActivityTimestamp = new Date();
}
private getChannelzInfo(): ChannelInfo {
return {
target: this.originalTarget,
state: this.connectivityState,
trace: this.channelzTrace,
callTracker: this.callTracker,
children: this.childrenTracker.getChildLists(),
};
}
private trace(text: string, verbosityOverride?: LogVerbosity) {
trace(
verbosityOverride ?? LogVerbosity.DEBUG,
@ -459,6 +465,9 @@ export class InternalChannel {
}
private callRefTimerRef() {
if (!this.callRefTimer) {
this.callRefTimer = setInterval(() => {}, MAX_TIMEOUT_TIME)
}
// If the hasRef function does not exist, always run the code
if (!this.callRefTimer.hasRef?.()) {
this.trace(
@ -472,15 +481,15 @@ export class InternalChannel {
}
private callRefTimerUnref() {
// If the hasRef function does not exist, always run the code
if (!this.callRefTimer.hasRef || this.callRefTimer.hasRef()) {
// If the timer or the hasRef function does not exist, always run the code
if (!this.callRefTimer?.hasRef || this.callRefTimer.hasRef()) {
this.trace(
'callRefTimer.unref | configSelectionQueue.length=' +
this.configSelectionQueue.length +
' pickQueue.length=' +
this.pickQueue.length
);
this.callRefTimer.unref?.();
this.callRefTimer?.unref?.();
}
}
@ -509,12 +518,13 @@ export class InternalChannel {
ConnectivityState[newState]
);
if (this.channelzEnabled) {
this.channelzTrace.addTrace(
this.channelzInfoTracker.trace.addTrace(
'CT_INFO',
'Connectivity state change to ' + ConnectivityState[newState]
);
}
this.connectivityState = newState;
this.channelzInfoTracker.state = newState;
const watchersCopy = this.connectivityStateWatchers.slice();
for (const watcherObject of watchersCopy) {
if (newState !== watcherObject.currentState) {
@ -539,6 +549,10 @@ export class InternalChannel {
}
}
addWrappedSubchannel(wrappedSubchannel: ChannelSubchannelWrapper) {
this.wrappedSubchannels.add(wrappedSubchannel);
}
removeWrappedSubchannel(wrappedSubchannel: ChannelSubchannelWrapper) {
this.wrappedSubchannels.delete(wrappedSubchannel);
}
@ -591,6 +605,10 @@ export class InternalChannel {
clearTimeout(this.idleTimer);
this.idleTimer = null;
}
if (this.callRefTimer) {
clearInterval(this.callRefTimer);
this.callRefTimer = null;
}
}
private startIdleTimeout(timeoutMs: number) {
@ -634,7 +652,7 @@ export class InternalChannel {
private onCallStart() {
if (this.channelzEnabled) {
this.callTracker.addCallStarted();
this.channelzInfoTracker.callTracker.addCallStarted();
}
this.callCount += 1;
}
@ -642,9 +660,9 @@ export class InternalChannel {
private onCallEnd(status: StatusObject) {
if (this.channelzEnabled) {
if (status.code === Status.OK) {
this.callTracker.addCallSucceeded();
this.channelzInfoTracker.callTracker.addCallSucceeded();
} else {
this.callTracker.addCallFailed();
this.channelzInfoTracker.callTracker.addCallFailed();
}
}
this.callCount -= 1;
@ -776,7 +794,9 @@ export class InternalChannel {
call.cancelWithStatus(Status.UNAVAILABLE, 'Channel closed before call started');
}
this.pickQueue = [];
clearInterval(this.callRefTimer);
if (this.callRefTimer) {
clearInterval(this.callRefTimer);
}
if (this.idleTimer) {
clearTimeout(this.idleTimer);
}