fix(widget-builder): Prevent TypeError when sorting with equation-only yAxis #106834
+26
−18
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.
This PR addresses a
TypeError: Cannot read properties of undefined (reading 'kind')that occurred in the widget builder when attempting to update the sort field.Root Cause:
The error happened in
useWidgetBuilderState.tsxwithin theSET_FIELDSaction handler. Specifically, when a user removed a group-by field from a chart widget, the logic to determine the new sort field could passundefinedtogenerateFieldAsString().This occurred because:
firstYAxisNotEquationwould beundefinedif theyAxisonly contained fields ofFieldValueKind.EQUATION.firstActionPayloadNotEquationwould also beundefinedif the remainingaction.payload(fields) were empty or only contained equations.generateFieldAsString(undefined as QueryFieldValue), where theas QueryFieldValuecast silenced TypeScript but allowedundefinedto be passed at runtime, leading to theTypeErrorwhenundefined.kindwas accessed.Solution:
The fix introduces explicit null checks before calling
generateFieldAsString()orgenerateMetricAggregate().sortFieldvariable is now initialized asstring | undefined.generateMetricAggregate()is called only iffirstYAxisNotEquationis defined forTRACEMETRICS.generateFieldAsString()is called only iffirstYAxisNotEquationorfirstActionPayloadNotEquationare defined.setSortaction is now guarded by anif (sortField)check, preventing a sort update (and thus the crash) if no valid field can be determined for sorting.Closes JAVASCRIPT-35PG
Legal Boilerplate
Look, I get it. The entity doing business as "Sentry" was incorporated in the State of Delaware in 2015 as Functional Software, Inc. and is gonna need some rights from me in order to utilize my contributions in this here PR. So here's the deal: I retain all rights, title and interest in and to my contributions, and by keeping this boilerplate intact I confirm that Sentry can use, modify, copy, and redistribute my contributions, under Sentry's choice of terms.