Serialize IPC errors #61665
+189
−78
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,68 @@ | ||
| /** | ||
| * Teleport | ||
| * Copyright (C) 2025 Gravitational, Inc. | ||
| * | ||
| * This program is free software: you can redistribute it and/or modify | ||
| * it under the terms of the GNU Affero General Public License as published by | ||
| * the Free Software Foundation, either version 3 of the License, or | ||
| * (at your option) any later version. | ||
| * | ||
| * This program is distributed in the hope that it will be useful, | ||
| * but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
| * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
| * GNU Affero General Public License for more details. | ||
| * | ||
| * You should have received a copy of the GNU Affero General Public License | ||
| * along with this program. If not, see <http://www.gnu.org/licenses/>. | ||
| */ | ||
|
|
||
| import { TshdRpcError } from 'teleterm/services/tshd/cloneableClient'; | ||
|
|
||
| import { deserializeError, serializeError } from './ipcSerializer'; | ||
|
|
||
| test('serializes and deserializes regular error', () => { | ||
| const err = new Error('Boom'); | ||
| err.name = 'CustomError'; | ||
|
|
||
| const serialized = serializeError(err); | ||
| expect(serialized instanceof Error).toBe(false); | ||
| expect(serialized.message).toBe('Boom'); | ||
| expect(serialized.name).toBe('CustomError'); | ||
| expect(serialized.stack).toBe(err.stack); | ||
| expect(serialized.cause).toBe(err.cause); | ||
|
|
||
| const cloned = structuredClone(serialized); | ||
| const deserialized = deserializeError(cloned); | ||
| expect(deserialized instanceof Error).toBe(true); | ||
| expect(deserialized.message).toBe('Boom'); | ||
| expect(deserialized.name).toBe('CustomError'); | ||
| expect(deserialized.stack).toBe(err.stack); | ||
| expect(deserialized.cause).toBe(err.cause); | ||
| }); | ||
|
|
||
| test('serializes and deserializes tshd error', () => { | ||
| const err: TshdRpcError = { | ||
| name: 'TshdRpcError', | ||
| message: 'Could not found', | ||
| toString: () => 'Could not found', | ||
| cause: '', | ||
| stack: '', | ||
| code: 'NOT_FOUND', | ||
| isResolvableWithRelogin: false, | ||
| }; | ||
|
|
||
| const serialized = serializeError(err); | ||
| expect(serialized instanceof Error).toBe(false); | ||
| expect(serialized.message).toBe('Could not found'); | ||
| expect(serialized.name).toBe('TshdRpcError'); | ||
| expect(serialized['isResolvableWithRelogin']).toBe(false); | ||
| expect(serialized['code']).toBe('NOT_FOUND'); | ||
|
|
||
| const cloned = structuredClone(serialized); | ||
| const deserialized = deserializeError(cloned); | ||
| expect(deserialized instanceof Error).toBe(true); | ||
| expect(deserialized.message).toBe('Could not found'); | ||
| expect(deserialized.name).toBe('TshdRpcError'); | ||
| expect(deserialized['isResolvableWithRelogin']).toBe(false); | ||
| expect(deserialized['code']).toBe('NOT_FOUND'); | ||
| }); |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I tried to test this by turning off my wifi while the agent was being downloaded and I got this:
Is this caused by this change? Would it be possible to add a test for that?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for catching it, turns out that calling destructured
toStringfunction can cause issues withthis.