Skip to content

fix(vue): Make options parameter optional on attachErrorHandler #18072

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

Merged
merged 1 commit into from
Nov 3, 2025
Merged

fix(vue): Make options parameter optional on attachErrorHandler #18072

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
5 changes: 3 additions & 2 deletions packages/vue/src/errorhandler.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import { formatComponentName, generateComponentTrace } from './vendor/components

type UnknownFunc = (...args: unknown[]) => void;

export const attachErrorHandler = (app: Vue, options: VueOptions): void => {
export const attachErrorHandler = (app: Vue, options?: Partial<VueOptions>): void => {
const { errorHandler: originalErrorHandler } = app.config;

app.config.errorHandler = (error: Error, vm: ViewModel, lifecycleHook: string): void => {
Expand All @@ -16,7 +16,8 @@ export const attachErrorHandler = (app: Vue, options: VueOptions): void => {
trace,
};

if (options.attachProps && vm) {
// TODO(v11): guard via sendDefaultPii?
if (options?.attachProps !== false && vm) {
// Vue2 - $options.propsData
// Vue3 - $props
if (vm.$options?.propsData) {
Expand Down
37 changes: 30 additions & 7 deletions packages/vue/test/errorHandler.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,6 +112,25 @@ describe('attachErrorHandler', () => {
// assert
t.expect.errorToHaveBeenCaptured().withProps(props);
});

test('`propsData` is added, if no options are provided to `attachErrorHandler`', () => {
// arrange
const props = { stubProp: 'stubData' };
const t = testHarness({
vm: {
$props: props,
},
optionsUndefined: true,
});

// act
vi.useFakeTimers();
expect(() => t.run()).toThrow(DummyError);
vi.runAllTimers();

// assert
t.expect.errorToHaveBeenCaptured().withProps(props);
});
});

describe('and `vm.$props` is defined', () => {
Expand Down Expand Up @@ -220,6 +239,7 @@ type TestHarnessOpts = {
enableConsole?: boolean;
silent?: boolean;
attachProps?: boolean;
optionsUndefined?: boolean;
};

class DummyError extends Error {
Expand All @@ -236,6 +256,7 @@ const testHarness = ({
enableErrorHandler,
enableConsole,
vm,
optionsUndefined = false,
}: TestHarnessOpts) => {
vi.useFakeTimers();
const providedErrorHandlerSpy = vi.fn();
Expand Down Expand Up @@ -274,13 +295,15 @@ const testHarness = ({
}
/* eslint-enable no-global-assign */

const options: Options = {
attachProps: !!attachProps,
tracingOptions: {},
trackComponents: [],
timeout: 0,
hooks: [] as Operation[],
};
const options: Options | undefined = optionsUndefined
? undefined
: {
attachProps: !!attachProps,
tracingOptions: {},
trackComponents: [],
timeout: 0,
hooks: [] as Operation[],
};

return {
run: () => {
Expand Down