Update reporting functions to include a partial context in the error #28

xnanodax · 2025-03-26T00:06:57Z

add opts to change reporting behavior with create draft -> active (default behavior is warning)
- add tests

type ErrorBehavior = 'error' | 'error-and-continue' | 'warn-and-continue'

export interface TransitionDraftOptions {
  previouslyActivatedBehavior?: ErrorBehavior
  invalidRelatedToBehavior?: ErrorBehavior
}

include partial context in error when reporting errors
consolidate error report functions

descoped:

add matchingIndex to start/end spans for computed spans

Copilot

Pull Request Overview

This PR updates the reporting functions to include a partial context in the error by introducing new types and adding an option to change reporting behavior when transitioning a draft trace to active. Key changes include:

Addition of new types (PartialPossibleTraceContext and ReportErrorFn) in types.ts.
Updates in Tracer.ts and Trace.ts to optionally pass an error-reporting context via opts.
Adjustments in tests to validate the new reporting behavior.

Reviewed Changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated no comments.

Show a summary per file

File	Description
src/v3/types.ts	Introduced new types supporting partial error context
src/v3/Tracer.ts	Updated error reporting logic to conditionally use error vs warning
src/v3/TraceManagerWithDraft.test.ts	Updated tests to reflect new reporting behavior and context checks
src/v3/TraceManager.ts	Adjusted type definitions for reportWarningFn
src/v3/Trace.ts	Updated transitionDraftToActive to pass opts and report context

Comments suppressed due to low confidence (2)

src/v3/Tracer.ts:109

[nitpick] Consider addressing the underlying type issue instead of using @ts-expect-error. Updating type definitions could eliminate the need for suppressing errors.

// @ts-expect-error TS doesn't like this type for some reason

src/v3/Trace.ts:1074

[nitpick] Evaluate the root cause of the TypeScript complaint and update the type definitions accordingly to remove the need for @ts-expect-error.

// @ts-expect-error TS doesn't like this type for some reason

bbrzoska

looks good, left some notes!

did we cover all uses of reportErrorFn?

src/v3/Trace.ts

src/v3/Tracer.ts

xnanodax · 2025-04-02T16:49:11Z

did we cover all uses of reportErrorFn?

yup! should have 🙏 !

…iming-hooks into report-error-fns # Conflicts: # src/v3/Trace.ts

Co-authored-by: Cynthia Ma <[email protected]>

xnanodax · 2025-04-09T17:47:51Z

src/v3/Trace.ts

@@ -929,8 +931,12 @@ export class Trace<
    VariantsT
  > {
    if (!this.input.relatedTo) {
-      throw new Error(
-        "Tried to access trace's activeInput, but the trace was never provided a 'relatedTo' input value",
+      this.traceUtilities.reportErrorFn(


small clean up: replacing throw error with this.traceUtilities.reportErrorFn

xnanodax · 2025-04-09T17:49:08Z

src/v3/Trace.ts

@@ -1250,7 +1313,11 @@ export class Trace<
    this.applyDefinitionModifications(inputAndDefinitionModifications)

    this.wasActivated = true
-    this.stateMachine.emit('onMakeActive', undefined)
+
+    if (isDraft) {


only drafts can switch the state to active

xnanodax · 2025-04-09T17:54:12Z

src/v3/Trace.ts

+        new Error(
+          "Tried to access trace's activeInput, but the trace was never provided a 'relatedTo' input value",
+        ),
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any


this was the best way we can address this time for the time being

xnanodax · 2025-04-09T17:55:14Z

src/v3/Tracer.ts

@@ -97,29 +98,8 @@ export class Tracer<
  }

  interrupt = ({ error }: { error?: Error } = {}) => {
-    const trace:


consolidated these into getCurrentTraceOrWarn

xnanodax · 2025-04-09T17:55:26Z

src/v3/Tracer.ts

@@ -153,28 +133,8 @@ export class Tracer<
      VariantsT
    >,
  ): void => {
-    const trace:


consolidated these into getCurrentTraceOrWarn

xnanodax · 2025-04-09T17:57:00Z

src/v3/Tracer.ts

  ): void => {
+    const trace = this.getCurrentTraceOrWarn()


the flow is we check if we have a current trace, if not, we do a blanket warning (not customizable)

once a current trace is confirmed, and we transitionDraftToActive, then we can use the new optional draft options (previouslyActivatedBehavior and invalidRelatedToBehavior)

xnanodax · 2025-04-09T17:57:39Z

src/v3/Tracer.ts

      this.traceUtilities.reportWarningFn(
        new Error(
-          `You are trying to initialize a trace that has already been initialized before (${trace.definition.name}).`,


whoops, originally had the wrong message

xnanodax · 2025-04-09T17:57:51Z

src/v3/Tracer.ts

    }

    // verify that trace is the same definition as the Tracer's definition
    if (trace.sourceDefinition !== this.definition) {
      this.traceUtilities.reportWarningFn(
        new Error(
-          `You are trying to initialize a trace that is not the same definition as the Tracer's definition is different.`,


whoops, originally had the wrong message

src/v3/TraceManager.ts

Co-authored-by: Evan Jenkins <[email protected]>

github-actions · 2025-04-09T21:15:36Z

🎉 This PR is included in version 2.4.0-next.1 🎉

The release is available on:

Your semantic-release bot 📦🚀

xnanodax changed the base branch from main to next March 26, 2025 00:07

feat: update report error and warning fn

7052e7e

xnanodax force-pushed the report-error-fns branch from 3f049db to 7052e7e Compare March 26, 2025 19:12

xnanodax added 2 commits March 31, 2025 15:15

update tests

9516ed0

add transition to draft to active reporting options

bc0b386

xnanodax force-pushed the report-error-fns branch from 7cdbfae to bc0b386 Compare April 1, 2025 00:29

Base automatically changed from next to main April 1, 2025 21:50

bbrzoska requested a review from Copilot April 1, 2025 23:46

Copilot AI reviewed Apr 1, 2025

View reviewed changes

bbrzoska reviewed Apr 1, 2025

View reviewed changes

src/v3/Trace.ts Outdated Show resolved Hide resolved

src/v3/Tracer.ts Outdated Show resolved Hide resolved

src/v3/Tracer.ts Outdated Show resolved Hide resolved

src/v3/Tracer.ts Outdated Show resolved Hide resolved

src/v3/Tracer.ts Outdated Show resolved Hide resolved

address code review comments

64d9199

xnanodax added 7 commits April 2, 2025 10:48

update second arg to reporting function

012ae70

remove ts expect and switch to cast

2678be1

feat: update report error and warning fn

44c4e05

update tests

1ee31c1

add transition to draft to active reporting options

891cda6

address code review comments

8e62288

update second arg to reporting function

c8e0a25

bbrzoska force-pushed the report-error-fns branch from 012ae70 to c8e0a25 Compare April 2, 2025 22:09

xnanodax and others added 3 commits April 2, 2025 15:42

Merge branch 'report-error-fns' of github.com:zendesk/react-measure-t…

fd0870c

…iming-hooks into report-error-fns # Conflicts: # src/v3/Trace.ts

fix: improvements to error reporting and warning

1a11e2d

Co-authored-by: Cynthia Ma <[email protected]>

test: partially update test

875eb00

xnanodax changed the base branch from main to next April 9, 2025 17:25

test: update failing tests

e7a6ee8

xnanodax force-pushed the report-error-fns branch from fac558b to e7a6ee8 Compare April 9, 2025 17:42

xnanodax commented Apr 9, 2025

View reviewed changes

yojenkins approved these changes Apr 9, 2025

View reviewed changes

src/v3/TraceManager.ts Outdated Show resolved Hide resolved

Update src/v3/TraceManager.ts

db335ea

Co-authored-by: Evan Jenkins <[email protected]>

xnanodax merged commit 500c409 into next Apr 9, 2025
3 checks passed

xnanodax deleted the report-error-fns branch April 9, 2025 21:13

github-actions bot added the released on @next label Apr 9, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update reporting functions to include a partial context in the error #28

Update reporting functions to include a partial context in the error #28

xnanodax commented Mar 26, 2025 •

edited

Loading

Copilot AI left a comment

bbrzoska left a comment

xnanodax commented Apr 2, 2025 •

edited

Loading

xnanodax Apr 9, 2025

xnanodax Apr 9, 2025

xnanodax Apr 9, 2025

xnanodax Apr 9, 2025

xnanodax Apr 9, 2025

xnanodax Apr 9, 2025

xnanodax Apr 9, 2025

xnanodax Apr 9, 2025

github-actions bot commented Apr 9, 2025

Update reporting functions to include a partial context in the error #28

Update reporting functions to include a partial context in the error #28

Conversation

xnanodax commented Mar 26, 2025 • edited Loading

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

bbrzoska left a comment

Choose a reason for hiding this comment

xnanodax commented Apr 2, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

github-actions bot commented Apr 9, 2025

xnanodax commented Mar 26, 2025 •

edited

Loading

xnanodax commented Apr 2, 2025 •

edited

Loading