Skip to content

feat(conversations): expose disconnect method for clean process exit #340

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
dsuresh-ap wants to merge 1 commit into
base: main
Choose a base branch
from
+17 −1
Open

feat(conversations): expose disconnect method for clean process exit #340

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@uipath/uipath-typescript",
"version": "1.2.1",
"version": "1.3.0",
Copy link
Copy Markdown
Collaborator

@swati354 swati354 Apr 2, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's not bump up the version with this change. We might have a few other changes we want to ship with the next version. We'll raise a separate PR for the version change.

"description": "UiPath TypeScript SDK",
"license": "MIT",
"keywords": [
Expand Down
16 changes: 16 additions & 0 deletions src/services/conversational-agent/conversations/conversations.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -467,6 +467,22 @@ export class ConversationService extends BaseService implements ConversationServ
return this._sessionManager.onConnectionStatusChanged(handler);
}

/**
* Disconnects the WebSocket and releases all session resources.
*
* Immediately closes the WebSocket connection and clears all per-conversation
* socket tracking. Call this after ending all sessions to allow the process to exit.
Copy link
Copy Markdown
Collaborator

@Raina451 Raina451 Apr 2, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"Call this after ending all sessions" implies endSession() is a required prerequisite. It isn't,disconnect closes all sockets directly without needing prior endSession calls.
better add: "Call this to shut down the WebSocket connection entirely."

Copy link
Copy Markdown
Collaborator

@Raina451 Raina451 Apr 2, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

have the same description in models as well when you add, because in public docs, comments from models get picked up.

Copy link
Copy Markdown
Collaborator

@Raina451 Raina451 Apr 2, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

also add a line somehting like this: "In Node.js, the WebSocket keeps the event loop alive until disconnected, call this to allow the process to exit cleanly." because In a browser, the runtime handles socket cleanup on page unload, so this is a no-op there.

*
* @example
* ```typescript
* conversationalAgent.conversations.endSession(conversationId);
* conversationalAgent.conversations.disconnect();
* ```
*/
disconnect(): void {
Copy link
Copy Markdown
Collaborator

@swati354 swati354 Apr 2, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  1. Please add this method in the ConversationServiceModel as well.

    uipath-typescript/src/models/conversational-agent/conversations/conversations.models.ts

    Line 73 in 0900e2d

    export interface ConversationServiceModel {
  2. Add a test case here -

    uipath-typescript/tests/unit/services/conversational-agent/conversations.test.ts

    Line 603 in 0900e2d

    describe('connection properties', () => {

this._sessionManager.disconnect();
}

// ==================== Private Methods ====================

private _getEvents(): ConversationEventHelperManager {
Expand Down
Loading