Skip to content

Conversation

@jclee
Copy link
Contributor

@jclee jclee commented Feb 11, 2025

Summary

Adds entries to the Workers and DO changelogs describing a change to "internal error" exception messages to include "reference" ids.

Documentation checklist

@github-actions
Copy link
Contributor

github-actions bot commented Feb 11, 2025

Copy link
Contributor

@vy-ton vy-ton left a comment

Choose a reason for hiding this comment

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

entries:
- publish_date: "2025-02-11"
description: |-
- When the runtime generates an "internal error" exception in response to certain failures, the exception message may include a reference ID that customers can include in support communication, to help make the error easier to diagnose. For example, an exception with the new message might look like: `internal error; reference = 0123456789abcdefghijklmn`.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
- When the runtime generates an "internal error" exception in response to certain failures, the exception message may include a reference ID that customers can include in support communication, to help make the error easier to diagnose. For example, an exception with the new message might look like: `internal error; reference = 0123456789abcdefghijklmn`.
- When Durable Objects generate an "internal error" exception in response to certain failures, the exception message may include a reference ID that customers can include in support communication, to help make the error easier to diagnose. For example, an exception with the new message might look like: `internal error; reference = 0123456789abcdefghijklmn`.

@jclee Why may include? Are there internal errors that won't have a reference ID?

Copy link
Contributor Author

@jclee jclee Feb 12, 2025

Choose a reason for hiding this comment

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

I think as currently implemented, most exceptions that were generated with the text "internal error" will have the reference id.

There is one remaining "internal error" exception that requires more work to add the reference id, but I think it is only generated in rare circumstances, like worker startup exceptions that we'd expect to be detected during worker validation, before they reach the edge.

And there are some other instances where we generate similar but more verbose exceptions -- like jsg.Error: Internal error in Durable Object storage write caused object to be reset. -- that we may want to also add reference ids to, but that are not affected by the current implementation.

@jclee jclee merged commit 7a56086 into production Feb 13, 2025
10 checks passed
@jclee jclee deleted the jlee/workers-internal-error-id branch February 13, 2025 18:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

8 participants