feat(vue): Expose VueIntegration to initialize vue app later#9180

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
mydea merged 2 commits into from
Oct 9, 2023
Merged

feat(vue): Expose VueIntegration to initialize vue app later #9180

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b037465
feat(vue): Expose `initVueApp` method to initialize vue app later
mydea Oct 5, 2023
827475d
ref: Refactor to integration
mydea Oct 5, 2023
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
4 changes: 2 additions & 2 deletions packages/vue/src/errorhandler.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
import { getCurrentHub } from '@sentry/browser';
import { addExceptionMechanism } from '@sentry/utils';

import type { Options, ViewModel, Vue } from './types';
import type { ViewModel, Vue, VueOptions } from './types';
import { formatComponentName, generateComponentTrace } from './vendor/components';

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

export const attachErrorHandler = (app: Vue, options: Options): void => {
export const attachErrorHandler = (app: Vue, options: VueOptions): void => {
const { errorHandler, warnHandler, silent } = app.config;

app.config.errorHandler = (error: Error, vm: ViewModel, lifecycleHook: string): void => {
Expand Down
1 change: 1 addition & 0 deletions packages/vue/src/index.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,3 +4,4 @@ export { init } from './sdk';
export { vueRouterInstrumentation } from './router';
export { attachErrorHandler } from './errorhandler';
export { createTracingMixins } from './tracing';
export { VueIntegration } from './integration';
99 changes: 99 additions & 0 deletions packages/vue/src/integration.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,99 @@
import { hasTracingEnabled } from '@sentry/core';
import type { Hub, Integration } from '@sentry/types';
import { arrayify, GLOBAL_OBJ } from '@sentry/utils';

import { DEFAULT_HOOKS } from './constants';
import { attachErrorHandler } from './errorhandler';
import { createTracingMixins } from './tracing';
import type { Options, Vue, VueOptions } from './types';

const globalWithVue = GLOBAL_OBJ as typeof GLOBAL_OBJ & { Vue: Vue };

const DEFAULT_CONFIG: VueOptions = {
Vue: globalWithVue.Vue,
attachProps: true,
logErrors: true,
hooks: DEFAULT_HOOKS,
timeout: 2000,
trackComponents: false,
};

/**
* Initialize Vue error & performance tracking.
*/
export class VueIntegration implements Integration {
/**
* @inheritDoc
*/
public static id: string = 'Vue';

/**
* @inheritDoc
*/
public name: string;

private readonly _options: Partial<VueOptions>;

public constructor(options: Partial<VueOptions> = {}) {
this.name = VueIntegration.id;
this._options = options;
}

/** @inheritDoc */
public setupOnce(_addGlobaleventProcessor: unknown, getCurrentHub: () => Hub): void {
this._setupIntegration(getCurrentHub());
}

/** Just here for easier testing */
protected _setupIntegration(hub: Hub): void {
const client = hub.getClient();
const options: Options = { ...DEFAULT_CONFIG, ...(client && client.getOptions()), ...this._options };

if (!options.Vue && !options.app) {
// eslint-disable-next-line no-console
console.warn(
`[@sentry/vue]: Misconfigured SDK. Vue specific errors will not be captured.
Update your \`Sentry.init\` call with an appropriate config option:
\`app\` (Application Instance - Vue 3) or \`Vue\` (Vue Constructor - Vue 2).`,
);
return;
}

if (options.app) {
const apps = arrayify(options.app);
apps.forEach(app => vueInit(app, options));
} else if (options.Vue) {
vueInit(options.Vue, options);
}
}
}

const vueInit = (app: Vue, options: Options): void => {
// Check app is not mounted yet - should be mounted _after_ init()!
// This is _somewhat_ private, but in the case that this doesn't exist we simply ignore it
// See: https://github.com/vuejs/core/blob/eb2a83283caa9de0a45881d860a3cbd9d0bdd279/packages/runtime-core/src/component.ts#L394
const appWithInstance = app as Vue & {
_instance?: {
isMounted?: boolean;
};
};

const isMounted = appWithInstance._instance && appWithInstance._instance.isMounted;
if (isMounted === true) {
// eslint-disable-next-line no-console
console.warn(
'[@sentry/vue]: Misconfigured SDK. Vue app is already mounted. Make sure to call `app.mount()` after `Sentry.init()`.',
);
}

attachErrorHandler(app, options);

if (hasTracingEnabled(options)) {
app.mixin(
createTracingMixins({
...options,
...options.tracingOptions,
}),
);
}
};
94 changes: 16 additions & 78 deletions packages/vue/src/sdk.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,7 @@
import { init as browserInit, SDK_VERSION } from '@sentry/browser';
import { hasTracingEnabled } from '@sentry/core';
import { arrayify, GLOBAL_OBJ } from '@sentry/utils';
import { defaultIntegrations, init as browserInit, SDK_VERSION } from '@sentry/browser';

import { DEFAULT_HOOKS } from './constants';
import { attachErrorHandler } from './errorhandler';
import { createTracingMixins } from './tracing';
import type { Options, TracingOptions, Vue } from './types';

const globalWithVue = GLOBAL_OBJ as typeof GLOBAL_OBJ & { Vue: Vue };

const DEFAULT_CONFIG: Options = {
Vue: globalWithVue.Vue,
attachProps: true,
logErrors: true,
hooks: DEFAULT_HOOKS,
timeout: 2000,
trackComponents: false,
_metadata: {
sdk: {
name: 'sentry.javascript.vue',
packages: [
{
name: 'npm:@sentry/vue',
version: SDK_VERSION,
},
],
version: SDK_VERSION,
},
},
};
import { VueIntegration } from './integration';
import type { Options, TracingOptions } from './types';

/**
* Inits the Vue SDK
Expand All@@ -37,56 +10,21 @@ export function init(
config: Partial<Omit<Options, 'tracingOptions'> & { tracingOptions: Partial<TracingOptions> }> = {},
): void {
const options = {
...DEFAULT_CONFIG,
_metadata: {
sdk: {
name: 'sentry.javascript.vue',
packages: [
{
name: 'npm:@sentry/vue',
version: SDK_VERSION,
},
],
version: SDK_VERSION,
},
},
defaultIntegrations: [...defaultIntegrations, new VueIntegration()],
...config,
};

browserInit(options);

if (!options.Vue && !options.app) {
// eslint-disable-next-line no-console
console.warn(
`[@sentry/vue]: Misconfigured SDK. Vue specific errors will not be captured.
Update your \`Sentry.init\` call with an appropriate config option:
\`app\` (Application Instance - Vue 3) or \`Vue\` (Vue Constructor - Vue 2).`,
);
return;
}

if (options.app) {
const apps = arrayify(options.app);
apps.forEach(app => vueInit(app, options));
} else if (options.Vue) {
vueInit(options.Vue, options);
}
}

const vueInit = (app: Vue, options: Options): void => {
// Check app is not mounted yet - should be mounted _after_ init()!
// This is _somewhat_ private, but in the case that this doesn't exist we simply ignore it
// See: https://github.com/vuejs/core/blob/eb2a83283caa9de0a45881d860a3cbd9d0bdd279/packages/runtime-core/src/component.ts#L394
const appWithInstance = app as Vue & {
_instance?: {
isMounted?: boolean;
};
};

const isMounted = appWithInstance._instance && appWithInstance._instance.isMounted;
if (isMounted === true) {
// eslint-disable-next-line no-console
console.warn(
'[@sentry/vue]: Misconfigured SDK. Vue app is already mounted. Make sure to call `app.mount()` after `Sentry.init()`.',
);
}

attachErrorHandler(app, options);

if (hasTracingEnabled(options)) {
app.mixin(
createTracingMixins({
...options,
...options.tracingOptions,
}),
);
}
};
8 changes: 6 additions & 2 deletions packages/vue/src/types.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -25,11 +25,13 @@ export type ViewModel = {
};
};

export interface Options extends TracingOptions, BrowserOptions {
export interface VueOptions extends TracingOptions {
/** Vue constructor to be used inside the integration (as imported by `import Vue from 'vue'` in Vue2) */
Vue?: Vue;

/** Vue app instance(s) to be used inside the integration (as generated by `createApp` in Vue3 ) */
/**
* Vue app instance(s) to be used inside the integration (as generated by `createApp` in Vue3).
*/
app?: Vue | Vue[];

/**
Expand All@@ -48,6 +50,8 @@ export interface Options extends TracingOptions, BrowserOptions {
tracingOptions?: Partial<TracingOptions>;
}

export interface Options extends BrowserOptions, VueOptions {}

/** Vue specific configuration for Tracing Integration */
export interface TracingOptions {
/**
Expand Down
68 changes: 68 additions & 0 deletions packages/vue/test/integration/VueIntegration.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
import { logger } from '@sentry/utils';
import { createApp } from 'vue';

import * as Sentry from '../../src';

const PUBLIC_DSN = 'https://username@domain/123';

describe('Sentry.VueIntegration', () => {
let loggerWarnings: unknown[] = [];
let warnings: unknown[] = [];

beforeEach(() => {
warnings = [];
loggerWarnings = [];

jest.spyOn(logger, 'warn').mockImplementation((message: unknown) => {
loggerWarnings.push(message);
});

jest.spyOn(console, 'warn').mockImplementation((message: unknown) => {
warnings.push(message);
});
});

afterEach(() => {
jest.resetAllMocks();
});

it('allows to initialize integration later', () => {
Sentry.init({ dsn: PUBLIC_DSN, defaultIntegrations: false, autoSessionTracking: false });

const el = document.createElement('div');
const app = createApp({
template: '<div>hello</div>',
});

// This would normally happen through client.addIntegration()
const integration = new Sentry.VueIntegration({ app });
integration['_setupIntegration'](Sentry.getCurrentHub());

app.mount(el);

expect(warnings).toEqual([]);
expect(loggerWarnings).toEqual([]);

expect(app.config.errorHandler).toBeDefined();
});

it('warns when mounting before SDK.VueIntegration', () => {
Sentry.init({ dsn: PUBLIC_DSN, defaultIntegrations: false, autoSessionTracking: false });

const el = document.createElement('div');
const app = createApp({
template: '<div>hello</div>',
});

app.mount(el);

// This would normally happen through client.addIntegration()
const integration = new Sentry.VueIntegration({ app });
integration['_setupIntegration'](Sentry.getCurrentHub());

expect(warnings).toEqual([
'[@sentry/vue]: Misconfigured SDK. Vue app is already mounted. Make sure to call `app.mount()` after `Sentry.init()`.',
]);
expect(loggerWarnings).toEqual([]);
});
});
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
feat(vue): Expose VueIntegration to initialize vue app later#9180

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

mydea
merged 2 commits into

from

Oct 9, 2023
 Merged


feat(vue): Expose VueIntegration to initialize vue app later
#9180
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
b037465

feat(vue): Expose `initVueApp` method to initialize vue app later


mydea Oct 5, 2023
827475d

ref: Refactor to integration


mydea Oct 5, 2023

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


4 changes: 2 additions & 2 deletions
packages/vue/src/errorhandler.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
import { getCurrentHub } from '@sentry/browser';
import { addExceptionMechanism } from '@sentry/utils';

import type { Options, ViewModel, Vue } from './types';
import type { ViewModel, Vue, VueOptions } from './types';
import { formatComponentName, generateComponentTrace } from './vendor/components';

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

export const attachErrorHandler = (app: Vue, options: Options): void => {
export const attachErrorHandler = (app: Vue, options: VueOptions): void => {
 const { errorHandler, warnHandler, silent } = app.config;

 app.config.errorHandler = (error: Error, vm: ViewModel, lifecycleHook: string): void => {
Expand Down

1 change: 1 addition & 0 deletions
packages/vue/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,3 +4,4 @@ export { init } from './sdk';
export { vueRouterInstrumentation } from './router';
export { attachErrorHandler } from './errorhandler';
export { createTracingMixins } from './tracing';
export { VueIntegration } from './integration';

99 changes: 99 additions & 0 deletions
packages/vue/src/integration.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,99 @@
import { hasTracingEnabled } from '@sentry/core';
import type { Hub, Integration } from '@sentry/types';
import { arrayify, GLOBAL_OBJ } from '@sentry/utils';

import { DEFAULT_HOOKS } from './constants';
import { attachErrorHandler } from './errorhandler';
import { createTracingMixins } from './tracing';
import type { Options, Vue, VueOptions } from './types';

const globalWithVue = GLOBAL_OBJ as typeof GLOBAL_OBJ & { Vue: Vue };

const DEFAULT_CONFIG: VueOptions = {
 Vue: globalWithVue.Vue,
 attachProps: true,
 logErrors: true,
 hooks: DEFAULT_HOOKS,
 timeout: 2000,
 trackComponents: false,
};

/**
 * Initialize Vue error & performance tracking.
 */
export class VueIntegration implements Integration {
 /**
 * @inheritDoc
 */
 public static id: string = 'Vue';

 /**
 * @inheritDoc
 */
 public name: string;

 private readonly _options: Partial<VueOptions>;

 public constructor(options: Partial<VueOptions> = {}) {
 this.name = VueIntegration.id;
 this._options = options;
 }

 /** @inheritDoc */
 public setupOnce(_addGlobaleventProcessor: unknown, getCurrentHub: () => Hub): void {
 this._setupIntegration(getCurrentHub());
 }

 /** Just here for easier testing */
 protected _setupIntegration(hub: Hub): void {
 const client = hub.getClient();
 const options: Options = { ...DEFAULT_CONFIG, ...(client && client.getOptions()), ...this._options };

 if (!options.Vue && !options.app) {
 // eslint-disable-next-line no-console
 console.warn(
 `[@sentry/vue]: Misconfigured SDK. Vue specific errors will not be captured.
Update your \`Sentry.init\` call with an appropriate config option:
\`app\` (Application Instance - Vue 3) or \`Vue\` (Vue Constructor - Vue 2).`,
 );
 return;
 }

 if (options.app) {
 const apps = arrayify(options.app);
 apps.forEach(app => vueInit(app, options));
 } else if (options.Vue) {
 vueInit(options.Vue, options);
 }
 }
}

const vueInit = (app: Vue, options: Options): void => {
 // Check app is not mounted yet - should be mounted _after_ init()!
 // This is _somewhat_ private, but in the case that this doesn't exist we simply ignore it
 // See: https://github.com/vuejs/core/blob/eb2a83283caa9de0a45881d860a3cbd9d0bdd279/packages/runtime-core/src/component.ts#L394
 const appWithInstance = app as Vue & {
 _instance?: {
 isMounted?: boolean;
 };
 };

 const isMounted = appWithInstance._instance && appWithInstance._instance.isMounted;
 if (isMounted === true) {
 // eslint-disable-next-line no-console
 console.warn(
 '[@sentry/vue]: Misconfigured SDK. Vue app is already mounted. Make sure to call `app.mount()` after `Sentry.init()`.',
 );
 }

 attachErrorHandler(app, options);

 if (hasTracingEnabled(options)) {
 app.mixin(
 createTracingMixins({
 ...options,
 ...options.tracingOptions,
 }),
 );
 }
};

94 changes: 16 additions & 78 deletions
packages/vue/src/sdk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,34 +1,7 @@
import { init as browserInit, SDK_VERSION } from '@sentry/browser';
import { hasTracingEnabled } from '@sentry/core';
import { arrayify, GLOBAL_OBJ } from '@sentry/utils';
import { defaultIntegrations, init as browserInit, SDK_VERSION } from '@sentry/browser';

import { DEFAULT_HOOKS } from './constants';
import { attachErrorHandler } from './errorhandler';
import { createTracingMixins } from './tracing';
import type { Options, TracingOptions, Vue } from './types';

const globalWithVue = GLOBAL_OBJ as typeof GLOBAL_OBJ & { Vue: Vue };

const DEFAULT_CONFIG: Options = {
 Vue: globalWithVue.Vue,
 attachProps: true,
 logErrors: true,
 hooks: DEFAULT_HOOKS,
 timeout: 2000,
 trackComponents: false,
 _metadata: {
 sdk: {
 name: 'sentry.javascript.vue',
 packages: [
 {
 name: 'npm:@sentry/vue',
 version: SDK_VERSION,
 },
 ],
 version: SDK_VERSION,
 },
 },
};
import { VueIntegration } from './integration';
import type { Options, TracingOptions } from './types';

/**
 * Inits the Vue SDK
Expand All@@ -37,56 +10,21 @@ export function init(
 config: Partial<Omit<Options, 'tracingOptions'> & { tracingOptions: Partial<TracingOptions> }> = {},
): void {
 const options = {
 ...DEFAULT_CONFIG,
 _metadata: {
 sdk: {
 name: 'sentry.javascript.vue',
 packages: [
 {
 name: 'npm:@sentry/vue',
 version: SDK_VERSION,
 },
 ],
 version: SDK_VERSION,
 },
 },
 defaultIntegrations: [...defaultIntegrations, new VueIntegration()],
 ...config,
 };

 browserInit(options);

 if (!options.Vue && !options.app) {
 // eslint-disable-next-line no-console
 console.warn(
 `[@sentry/vue]: Misconfigured SDK. Vue specific errors will not be captured.
Update your \`Sentry.init\` call with an appropriate config option:
\`app\` (Application Instance - Vue 3) or \`Vue\` (Vue Constructor - Vue 2).`,
 );
 return;
 }

 if (options.app) {
 const apps = arrayify(options.app);
 apps.forEach(app => vueInit(app, options));
 } else if (options.Vue) {
 vueInit(options.Vue, options);
 }
}

const vueInit = (app: Vue, options: Options): void => {
 // Check app is not mounted yet - should be mounted _after_ init()!
 // This is _somewhat_ private, but in the case that this doesn't exist we simply ignore it
 // See: https://github.com/vuejs/core/blob/eb2a83283caa9de0a45881d860a3cbd9d0bdd279/packages/runtime-core/src/component.ts#L394
 const appWithInstance = app as Vue & {
 _instance?: {
 isMounted?: boolean;
 };
 };

 const isMounted = appWithInstance._instance && appWithInstance._instance.isMounted;
 if (isMounted === true) {
 // eslint-disable-next-line no-console
 console.warn(
 '[@sentry/vue]: Misconfigured SDK. Vue app is already mounted. Make sure to call `app.mount()` after `Sentry.init()`.',
 );
 }

 attachErrorHandler(app, options);

 if (hasTracingEnabled(options)) {
 app.mixin(
 createTracingMixins({
 ...options,
 ...options.tracingOptions,
 }),
 );
 }
};

8 changes: 6 additions & 2 deletions
packages/vue/src/types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,11 +25,13 @@ export type ViewModel = {
 };
};

export interface Options extends TracingOptions, BrowserOptions {
export interface VueOptions extends TracingOptions {
 /** Vue constructor to be used inside the integration (as imported by `import Vue from 'vue'` in Vue2) */
 Vue?: Vue;

 /** Vue app instance(s) to be used inside the integration (as generated by `createApp` in Vue3 ) */
 /**
 * Vue app instance(s) to be used inside the integration (as generated by `createApp` in Vue3).
 */
 app?: Vue | Vue[];

 /**
Expand All@@ -48,6 +50,8 @@ export interface Options extends TracingOptions, BrowserOptions {
 tracingOptions?: Partial<TracingOptions>;
}

export interface Options extends BrowserOptions, VueOptions {}

/** Vue specific configuration for Tracing Integration */
export interface TracingOptions {
 /**
Expand Down

68 changes: 68 additions & 0 deletions
packages/vue/test/integration/VueIntegration.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
import { logger } from '@sentry/utils';
import { createApp } from 'vue';

import * as Sentry from '../../src';

const PUBLIC_DSN = 'https://username@domain/123';

describe('Sentry.VueIntegration', () => {
 let loggerWarnings: unknown[] = [];
 let warnings: unknown[] = [];

 beforeEach(() => {
 warnings = [];
 loggerWarnings = [];

 jest.spyOn(logger, 'warn').mockImplementation((message: unknown) => {
 loggerWarnings.push(message);
 });

 jest.spyOn(console, 'warn').mockImplementation((message: unknown) => {
 warnings.push(message);
 });
 });

 afterEach(() => {
 jest.resetAllMocks();
 });

 it('allows to initialize integration later', () => {
 Sentry.init({ dsn: PUBLIC_DSN, defaultIntegrations: false, autoSessionTracking: false });

 const el = document.createElement('div');
 const app = createApp({
 template: '<div>hello</div>',
 });

 // This would normally happen through client.addIntegration()
 const integration = new Sentry.VueIntegration({ app });
 integration['_setupIntegration'](Sentry.getCurrentHub());

 app.mount(el);

 expect(warnings).toEqual([]);
 expect(loggerWarnings).toEqual([]);

 expect(app.config.errorHandler).toBeDefined();
 });

 it('warns when mounting before SDK.VueIntegration', () => {
 Sentry.init({ dsn: PUBLIC_DSN, defaultIntegrations: false, autoSessionTracking: false });

 const el = document.createElement('div');
 const app = createApp({
 template: '<div>hello</div>',
 });

 app.mount(el);

 // This would normally happen through client.addIntegration()
 const integration = new Sentry.VueIntegration({ app });
 integration['_setupIntegration'](Sentry.getCurrentHub());

 expect(warnings).toEqual([
 '[@sentry/vue]: Misconfigured SDK. Vue app is already mounted. Make sure to call `app.mount()` after `Sentry.init()`.',
 ]);
 expect(loggerWarnings).toEqual([]);
 });
});
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(vue): Expose VueIntegration to initialize vue app later#9180

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

mydea
merged 2 commits into

from

Oct 9, 2023
 Merged


feat(vue): Expose VueIntegration to initialize vue app later
#9180
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
b037465

feat(vue): Expose `initVueApp` method to initialize vue app later


mydea Oct 5, 2023
827475d

ref: Refactor to integration


mydea Oct 5, 2023

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


4 changes: 2 additions & 2 deletions
packages/vue/src/errorhandler.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
import { getCurrentHub } from '@sentry/browser';
import { addExceptionMechanism } from '@sentry/utils';

import type { Options, ViewModel, Vue } from './types';
import type { ViewModel, Vue, VueOptions } from './types';
import { formatComponentName, generateComponentTrace } from './vendor/components';

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

export const attachErrorHandler = (app: Vue, options: Options): void => {
export const attachErrorHandler = (app: Vue, options: VueOptions): void => {
 const { errorHandler, warnHandler, silent } = app.config;

 app.config.errorHandler = (error: Error, vm: ViewModel, lifecycleHook: string): void => {
Expand Down

1 change: 1 addition & 0 deletions
packages/vue/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,3 +4,4 @@ export { init } from './sdk';
export { vueRouterInstrumentation } from './router';
export { attachErrorHandler } from './errorhandler';
export { createTracingMixins } from './tracing';
export { VueIntegration } from './integration';

99 changes: 99 additions & 0 deletions
packages/vue/src/integration.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,99 @@
import { hasTracingEnabled } from '@sentry/core';
import type { Hub, Integration } from '@sentry/types';
import { arrayify, GLOBAL_OBJ } from '@sentry/utils';

import { DEFAULT_HOOKS } from './constants';
import { attachErrorHandler } from './errorhandler';
import { createTracingMixins } from './tracing';
import type { Options, Vue, VueOptions } from './types';

const globalWithVue = GLOBAL_OBJ as typeof GLOBAL_OBJ & { Vue: Vue };

const DEFAULT_CONFIG: VueOptions = {
 Vue: globalWithVue.Vue,
 attachProps: true,
 logErrors: true,
 hooks: DEFAULT_HOOKS,
 timeout: 2000,
 trackComponents: false,
};

/**
 * Initialize Vue error & performance tracking.
 */
export class VueIntegration implements Integration {
 /**
 * @inheritDoc
 */
 public static id: string = 'Vue';

 /**
 * @inheritDoc
 */
 public name: string;

 private readonly _options: Partial<VueOptions>;

 public constructor(options: Partial<VueOptions> = {}) {
 this.name = VueIntegration.id;
 this._options = options;
 }

 /** @inheritDoc */
 public setupOnce(_addGlobaleventProcessor: unknown, getCurrentHub: () => Hub): void {
 this._setupIntegration(getCurrentHub());
 }

 /** Just here for easier testing */
 protected _setupIntegration(hub: Hub): void {
 const client = hub.getClient();
 const options: Options = { ...DEFAULT_CONFIG, ...(client && client.getOptions()), ...this._options };

 if (!options.Vue && !options.app) {
 // eslint-disable-next-line no-console
 console.warn(
 `[@sentry/vue]: Misconfigured SDK. Vue specific errors will not be captured.
Update your \`Sentry.init\` call with an appropriate config option:
\`app\` (Application Instance - Vue 3) or \`Vue\` (Vue Constructor - Vue 2).`,
 );
 return;
 }

 if (options.app) {
 const apps = arrayify(options.app);
 apps.forEach(app => vueInit(app, options));
 } else if (options.Vue) {
 vueInit(options.Vue, options);
 }
 }
}

const vueInit = (app: Vue, options: Options): void => {
 // Check app is not mounted yet - should be mounted _after_ init()!
 // This is _somewhat_ private, but in the case that this doesn't exist we simply ignore it
 // See: https://github.com/vuejs/core/blob/eb2a83283caa9de0a45881d860a3cbd9d0bdd279/packages/runtime-core/src/component.ts#L394
 const appWithInstance = app as Vue & {
 _instance?: {
 isMounted?: boolean;
 };
 };

 const isMounted = appWithInstance._instance && appWithInstance._instance.isMounted;
 if (isMounted === true) {
 // eslint-disable-next-line no-console
 console.warn(
 '[@sentry/vue]: Misconfigured SDK. Vue app is already mounted. Make sure to call `app.mount()` after `Sentry.init()`.',
 );
 }

 attachErrorHandler(app, options);

 if (hasTracingEnabled(options)) {
 app.mixin(
 createTracingMixins({
 ...options,
 ...options.tracingOptions,
 }),
 );
 }
};

94 changes: 16 additions & 78 deletions
packages/vue/src/sdk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,34 +1,7 @@
import { init as browserInit, SDK_VERSION } from '@sentry/browser';
import { hasTracingEnabled } from '@sentry/core';
import { arrayify, GLOBAL_OBJ } from '@sentry/utils';
import { defaultIntegrations, init as browserInit, SDK_VERSION } from '@sentry/browser';

import { DEFAULT_HOOKS } from './constants';
import { attachErrorHandler } from './errorhandler';
import { createTracingMixins } from './tracing';
import type { Options, TracingOptions, Vue } from './types';

const globalWithVue = GLOBAL_OBJ as typeof GLOBAL_OBJ & { Vue: Vue };

const DEFAULT_CONFIG: Options = {
 Vue: globalWithVue.Vue,
 attachProps: true,
 logErrors: true,
 hooks: DEFAULT_HOOKS,
 timeout: 2000,
 trackComponents: false,
 _metadata: {
 sdk: {
 name: 'sentry.javascript.vue',
 packages: [
 {
 name: 'npm:@sentry/vue',
 version: SDK_VERSION,
 },
 ],
 version: SDK_VERSION,
 },
 },
};
import { VueIntegration } from './integration';
import type { Options, TracingOptions } from './types';

/**
 * Inits the Vue SDK
Expand All@@ -37,56 +10,21 @@ export function init(
 config: Partial<Omit<Options, 'tracingOptions'> & { tracingOptions: Partial<TracingOptions> }> = {},
): void {
 const options = {
 ...DEFAULT_CONFIG,
 _metadata: {
 sdk: {
 name: 'sentry.javascript.vue',
 packages: [
 {
 name: 'npm:@sentry/vue',
 version: SDK_VERSION,
 },
 ],
 version: SDK_VERSION,
 },
 },
 defaultIntegrations: [...defaultIntegrations, new VueIntegration()],
 ...config,
 };

 browserInit(options);

 if (!options.Vue && !options.app) {
 // eslint-disable-next-line no-console
 console.warn(
 `[@sentry/vue]: Misconfigured SDK. Vue specific errors will not be captured.
Update your \`Sentry.init\` call with an appropriate config option:
\`app\` (Application Instance - Vue 3) or \`Vue\` (Vue Constructor - Vue 2).`,
 );
 return;
 }

 if (options.app) {
 const apps = arrayify(options.app);
 apps.forEach(app => vueInit(app, options));
 } else if (options.Vue) {
 vueInit(options.Vue, options);
 }
}

const vueInit = (app: Vue, options: Options): void => {
 // Check app is not mounted yet - should be mounted _after_ init()!
 // This is _somewhat_ private, but in the case that this doesn't exist we simply ignore it
 // See: https://github.com/vuejs/core/blob/eb2a83283caa9de0a45881d860a3cbd9d0bdd279/packages/runtime-core/src/component.ts#L394
 const appWithInstance = app as Vue & {
 _instance?: {
 isMounted?: boolean;
 };
 };

 const isMounted = appWithInstance._instance && appWithInstance._instance.isMounted;
 if (isMounted === true) {
 // eslint-disable-next-line no-console
 console.warn(
 '[@sentry/vue]: Misconfigured SDK. Vue app is already mounted. Make sure to call `app.mount()` after `Sentry.init()`.',
 );
 }

 attachErrorHandler(app, options);

 if (hasTracingEnabled(options)) {
 app.mixin(
 createTracingMixins({
 ...options,
 ...options.tracingOptions,
 }),
 );
 }
};

8 changes: 6 additions & 2 deletions
packages/vue/src/types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,11 +25,13 @@ export type ViewModel = {
 };
};

export interface Options extends TracingOptions, BrowserOptions {
export interface VueOptions extends TracingOptions {
 /** Vue constructor to be used inside the integration (as imported by `import Vue from 'vue'` in Vue2) */
 Vue?: Vue;

 /** Vue app instance(s) to be used inside the integration (as generated by `createApp` in Vue3 ) */
 /**
 * Vue app instance(s) to be used inside the integration (as generated by `createApp` in Vue3).
 */
 app?: Vue | Vue[];

 /**
Expand All@@ -48,6 +50,8 @@ export interface Options extends TracingOptions, BrowserOptions {
 tracingOptions?: Partial<TracingOptions>;
}

export interface Options extends BrowserOptions, VueOptions {}

/** Vue specific configuration for Tracing Integration */
export interface TracingOptions {
 /**
Expand Down

68 changes: 68 additions & 0 deletions
packages/vue/test/integration/VueIntegration.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
import { logger } from '@sentry/utils';
import { createApp } from 'vue';

import * as Sentry from '../../src';

const PUBLIC_DSN = 'https://username@domain/123';

describe('Sentry.VueIntegration', () => {
 let loggerWarnings: unknown[] = [];
 let warnings: unknown[] = [];

 beforeEach(() => {
 warnings = [];
 loggerWarnings = [];

 jest.spyOn(logger, 'warn').mockImplementation((message: unknown) => {
 loggerWarnings.push(message);
 });

 jest.spyOn(console, 'warn').mockImplementation((message: unknown) => {
 warnings.push(message);
 });
 });

 afterEach(() => {
 jest.resetAllMocks();
 });

 it('allows to initialize integration later', () => {
 Sentry.init({ dsn: PUBLIC_DSN, defaultIntegrations: false, autoSessionTracking: false });

 const el = document.createElement('div');
 const app = createApp({
 template: '<div>hello</div>',
 });

 // This would normally happen through client.addIntegration()
 const integration = new Sentry.VueIntegration({ app });
 integration['_setupIntegration'](Sentry.getCurrentHub());

 app.mount(el);

 expect(warnings).toEqual([]);
 expect(loggerWarnings).toEqual([]);

 expect(app.config.errorHandler).toBeDefined();
 });

 it('warns when mounting before SDK.VueIntegration', () => {
 Sentry.init({ dsn: PUBLIC_DSN, defaultIntegrations: false, autoSessionTracking: false });

 const el = document.createElement('div');
 const app = createApp({
 template: '<div>hello</div>',
 });

 app.mount(el);

 // This would normally happen through client.addIntegration()
 const integration = new Sentry.VueIntegration({ app });
 integration['_setupIntegration'](Sentry.getCurrentHub());

 expect(warnings).toEqual([
 '[@sentry/vue]: Misconfigured SDK. Vue app is already mounted. Make sure to call `app.mount()` after `Sentry.init()`.',
 ]);
 expect(loggerWarnings).toEqual([]);
 });
});
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(vue): Expose VueIntegration to initialize vue app later#9180

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

mydea
merged 2 commits into

from

Oct 9, 2023
 Merged


feat(vue): Expose VueIntegration to initialize vue app later
#9180
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
b037465

feat(vue): Expose `initVueApp` method to initialize vue app later


mydea Oct 5, 2023
827475d

ref: Refactor to integration


mydea Oct 5, 2023

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


4 changes: 2 additions & 2 deletions
packages/vue/src/errorhandler.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
import { getCurrentHub } from '@sentry/browser';
import { addExceptionMechanism } from '@sentry/utils';

import type { Options, ViewModel, Vue } from './types';
import type { ViewModel, Vue, VueOptions } from './types';
import { formatComponentName, generateComponentTrace } from './vendor/components';

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

export const attachErrorHandler = (app: Vue, options: Options): void => {
export const attachErrorHandler = (app: Vue, options: VueOptions): void => {
 const { errorHandler, warnHandler, silent } = app.config;

 app.config.errorHandler = (error: Error, vm: ViewModel, lifecycleHook: string): void => {
Expand Down

1 change: 1 addition & 0 deletions
packages/vue/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,3 +4,4 @@ export { init } from './sdk';
export { vueRouterInstrumentation } from './router';
export { attachErrorHandler } from './errorhandler';
export { createTracingMixins } from './tracing';
export { VueIntegration } from './integration';

99 changes: 99 additions & 0 deletions
packages/vue/src/integration.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,99 @@
import { hasTracingEnabled } from '@sentry/core';
import type { Hub, Integration } from '@sentry/types';
import { arrayify, GLOBAL_OBJ } from '@sentry/utils';

import { DEFAULT_HOOKS } from './constants';
import { attachErrorHandler } from './errorhandler';
import { createTracingMixins } from './tracing';
import type { Options, Vue, VueOptions } from './types';

const globalWithVue = GLOBAL_OBJ as typeof GLOBAL_OBJ & { Vue: Vue };

const DEFAULT_CONFIG: VueOptions = {
 Vue: globalWithVue.Vue,
 attachProps: true,
 logErrors: true,
 hooks: DEFAULT_HOOKS,
 timeout: 2000,
 trackComponents: false,
};

/**
 * Initialize Vue error & performance tracking.
 */
export class VueIntegration implements Integration {
 /**
 * @inheritDoc
 */
 public static id: string = 'Vue';

 /**
 * @inheritDoc
 */
 public name: string;

 private readonly _options: Partial<VueOptions>;

 public constructor(options: Partial<VueOptions> = {}) {
 this.name = VueIntegration.id;
 this._options = options;
 }

 /** @inheritDoc */
 public setupOnce(_addGlobaleventProcessor: unknown, getCurrentHub: () => Hub): void {
 this._setupIntegration(getCurrentHub());
 }

 /** Just here for easier testing */
 protected _setupIntegration(hub: Hub): void {
 const client = hub.getClient();
 const options: Options = { ...DEFAULT_CONFIG, ...(client && client.getOptions()), ...this._options };

 if (!options.Vue && !options.app) {
 // eslint-disable-next-line no-console
 console.warn(
 `[@sentry/vue]: Misconfigured SDK. Vue specific errors will not be captured.
Update your \`Sentry.init\` call with an appropriate config option:
\`app\` (Application Instance - Vue 3) or \`Vue\` (Vue Constructor - Vue 2).`,
 );
 return;
 }

 if (options.app) {
 const apps = arrayify(options.app);
 apps.forEach(app => vueInit(app, options));
 } else if (options.Vue) {
 vueInit(options.Vue, options);
 }
 }
}

const vueInit = (app: Vue, options: Options): void => {
 // Check app is not mounted yet - should be mounted _after_ init()!
 // This is _somewhat_ private, but in the case that this doesn't exist we simply ignore it
 // See: https://github.com/vuejs/core/blob/eb2a83283caa9de0a45881d860a3cbd9d0bdd279/packages/runtime-core/src/component.ts#L394
 const appWithInstance = app as Vue & {
 _instance?: {
 isMounted?: boolean;
 };
 };

 const isMounted = appWithInstance._instance && appWithInstance._instance.isMounted;
 if (isMounted === true) {
 // eslint-disable-next-line no-console
 console.warn(
 '[@sentry/vue]: Misconfigured SDK. Vue app is already mounted. Make sure to call `app.mount()` after `Sentry.init()`.',
 );
 }

 attachErrorHandler(app, options);

 if (hasTracingEnabled(options)) {
 app.mixin(
 createTracingMixins({
 ...options,
 ...options.tracingOptions,
 }),
 );
 }
};

94 changes: 16 additions & 78 deletions
packages/vue/src/sdk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,34 +1,7 @@
import { init as browserInit, SDK_VERSION } from '@sentry/browser';
import { hasTracingEnabled } from '@sentry/core';
import { arrayify, GLOBAL_OBJ } from '@sentry/utils';
import { defaultIntegrations, init as browserInit, SDK_VERSION } from '@sentry/browser';

import { DEFAULT_HOOKS } from './constants';
import { attachErrorHandler } from './errorhandler';
import { createTracingMixins } from './tracing';
import type { Options, TracingOptions, Vue } from './types';

const globalWithVue = GLOBAL_OBJ as typeof GLOBAL_OBJ & { Vue: Vue };

const DEFAULT_CONFIG: Options = {
 Vue: globalWithVue.Vue,
 attachProps: true,
 logErrors: true,
 hooks: DEFAULT_HOOKS,
 timeout: 2000,
 trackComponents: false,
 _metadata: {
 sdk: {
 name: 'sentry.javascript.vue',
 packages: [
 {
 name: 'npm:@sentry/vue',
 version: SDK_VERSION,
 },
 ],
 version: SDK_VERSION,
 },
 },
};
import { VueIntegration } from './integration';
import type { Options, TracingOptions } from './types';

/**
 * Inits the Vue SDK
Expand All@@ -37,56 +10,21 @@ export function init(
 config: Partial<Omit<Options, 'tracingOptions'> & { tracingOptions: Partial<TracingOptions> }> = {},
): void {
 const options = {
 ...DEFAULT_CONFIG,
 _metadata: {
 sdk: {
 name: 'sentry.javascript.vue',
 packages: [
 {
 name: 'npm:@sentry/vue',
 version: SDK_VERSION,
 },
 ],
 version: SDK_VERSION,
 },
 },
 defaultIntegrations: [...defaultIntegrations, new VueIntegration()],
 ...config,
 };

 browserInit(options);

 if (!options.Vue && !options.app) {
 // eslint-disable-next-line no-console
 console.warn(
 `[@sentry/vue]: Misconfigured SDK. Vue specific errors will not be captured.
Update your \`Sentry.init\` call with an appropriate config option:
\`app\` (Application Instance - Vue 3) or \`Vue\` (Vue Constructor - Vue 2).`,
 );
 return;
 }

 if (options.app) {
 const apps = arrayify(options.app);
 apps.forEach(app => vueInit(app, options));
 } else if (options.Vue) {
 vueInit(options.Vue, options);
 }
}

const vueInit = (app: Vue, options: Options): void => {
 // Check app is not mounted yet - should be mounted _after_ init()!
 // This is _somewhat_ private, but in the case that this doesn't exist we simply ignore it
 // See: https://github.com/vuejs/core/blob/eb2a83283caa9de0a45881d860a3cbd9d0bdd279/packages/runtime-core/src/component.ts#L394
 const appWithInstance = app as Vue & {
 _instance?: {
 isMounted?: boolean;
 };
 };

 const isMounted = appWithInstance._instance && appWithInstance._instance.isMounted;
 if (isMounted === true) {
 // eslint-disable-next-line no-console
 console.warn(
 '[@sentry/vue]: Misconfigured SDK. Vue app is already mounted. Make sure to call `app.mount()` after `Sentry.init()`.',
 );
 }

 attachErrorHandler(app, options);

 if (hasTracingEnabled(options)) {
 app.mixin(
 createTracingMixins({
 ...options,
 ...options.tracingOptions,
 }),
 );
 }
};

8 changes: 6 additions & 2 deletions
packages/vue/src/types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,11 +25,13 @@ export type ViewModel = {
 };
};

export interface Options extends TracingOptions, BrowserOptions {
export interface VueOptions extends TracingOptions {
 /** Vue constructor to be used inside the integration (as imported by `import Vue from 'vue'` in Vue2) */
 Vue?: Vue;

 /** Vue app instance(s) to be used inside the integration (as generated by `createApp` in Vue3 ) */
 /**
 * Vue app instance(s) to be used inside the integration (as generated by `createApp` in Vue3).
 */
 app?: Vue | Vue[];

 /**
Expand All@@ -48,6 +50,8 @@ export interface Options extends TracingOptions, BrowserOptions {
 tracingOptions?: Partial<TracingOptions>;
}

export interface Options extends BrowserOptions, VueOptions {}

/** Vue specific configuration for Tracing Integration */
export interface TracingOptions {
 /**
Expand Down

68 changes: 68 additions & 0 deletions
packages/vue/test/integration/VueIntegration.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
import { logger } from '@sentry/utils';
import { createApp } from 'vue';

import * as Sentry from '../../src';

const PUBLIC_DSN = 'https://username@domain/123';

describe('Sentry.VueIntegration', () => {
 let loggerWarnings: unknown[] = [];
 let warnings: unknown[] = [];

 beforeEach(() => {
 warnings = [];
 loggerWarnings = [];

 jest.spyOn(logger, 'warn').mockImplementation((message: unknown) => {
 loggerWarnings.push(message);
 });

 jest.spyOn(console, 'warn').mockImplementation((message: unknown) => {
 warnings.push(message);
 });
 });

 afterEach(() => {
 jest.resetAllMocks();
 });

 it('allows to initialize integration later', () => {
 Sentry.init({ dsn: PUBLIC_DSN, defaultIntegrations: false, autoSessionTracking: false });

 const el = document.createElement('div');
 const app = createApp({
 template: '<div>hello</div>',
 });

 // This would normally happen through client.addIntegration()
 const integration = new Sentry.VueIntegration({ app });
 integration['_setupIntegration'](Sentry.getCurrentHub());

 app.mount(el);

 expect(warnings).toEqual([]);
 expect(loggerWarnings).toEqual([]);

 expect(app.config.errorHandler).toBeDefined();
 });

 it('warns when mounting before SDK.VueIntegration', () => {
 Sentry.init({ dsn: PUBLIC_DSN, defaultIntegrations: false, autoSessionTracking: false });

 const el = document.createElement('div');
 const app = createApp({
 template: '<div>hello</div>',
 });

 app.mount(el);

 // This would normally happen through client.addIntegration()
 const integration = new Sentry.VueIntegration({ app });
 integration['_setupIntegration'](Sentry.getCurrentHub());

 expect(warnings).toEqual([
 '[@sentry/vue]: Misconfigured SDK. Vue app is already mounted. Make sure to call `app.mount()` after `Sentry.init()`.',
 ]);
 expect(loggerWarnings).toEqual([]);
 });
});
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
feat(vue): Expose VueIntegration to initialize vue app later#9180

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

mydea
merged 2 commits into

from

Oct 9, 2023
 Merged


feat(vue): Expose VueIntegration to initialize vue app later
#9180
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
b037465

feat(vue): Expose `initVueApp` method to initialize vue app later


mydea Oct 5, 2023
827475d

ref: Refactor to integration


mydea Oct 5, 2023

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


4 changes: 2 additions & 2 deletions
packages/vue/src/errorhandler.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
import { getCurrentHub } from '@sentry/browser';
import { addExceptionMechanism } from '@sentry/utils';

import type { Options, ViewModel, Vue } from './types';
import type { ViewModel, Vue, VueOptions } from './types';
import { formatComponentName, generateComponentTrace } from './vendor/components';

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

export const attachErrorHandler = (app: Vue, options: Options): void => {
export const attachErrorHandler = (app: Vue, options: VueOptions): void => {
 const { errorHandler, warnHandler, silent } = app.config;

 app.config.errorHandler = (error: Error, vm: ViewModel, lifecycleHook: string): void => {
Expand Down

1 change: 1 addition & 0 deletions
packages/vue/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,3 +4,4 @@ export { init } from './sdk';
export { vueRouterInstrumentation } from './router';
export { attachErrorHandler } from './errorhandler';
export { createTracingMixins } from './tracing';
export { VueIntegration } from './integration';

99 changes: 99 additions & 0 deletions
packages/vue/src/integration.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,99 @@
import { hasTracingEnabled } from '@sentry/core';
import type { Hub, Integration } from '@sentry/types';
import { arrayify, GLOBAL_OBJ } from '@sentry/utils';

import { DEFAULT_HOOKS } from './constants';
import { attachErrorHandler } from './errorhandler';
import { createTracingMixins } from './tracing';
import type { Options, Vue, VueOptions } from './types';

const globalWithVue = GLOBAL_OBJ as typeof GLOBAL_OBJ & { Vue: Vue };

const DEFAULT_CONFIG: VueOptions = {
 Vue: globalWithVue.Vue,
 attachProps: true,
 logErrors: true,
 hooks: DEFAULT_HOOKS,
 timeout: 2000,
 trackComponents: false,
};

/**
 * Initialize Vue error & performance tracking.
 */
export class VueIntegration implements Integration {
 /**
 * @inheritDoc
 */
 public static id: string = 'Vue';

 /**
 * @inheritDoc
 */
 public name: string;

 private readonly _options: Partial<VueOptions>;

 public constructor(options: Partial<VueOptions> = {}) {
 this.name = VueIntegration.id;
 this._options = options;
 }

 /** @inheritDoc */
 public setupOnce(_addGlobaleventProcessor: unknown, getCurrentHub: () => Hub): void {
 this._setupIntegration(getCurrentHub());
 }

 /** Just here for easier testing */
 protected _setupIntegration(hub: Hub): void {
 const client = hub.getClient();
 const options: Options = { ...DEFAULT_CONFIG, ...(client && client.getOptions()), ...this._options };

 if (!options.Vue && !options.app) {
 // eslint-disable-next-line no-console
 console.warn(
 `[@sentry/vue]: Misconfigured SDK. Vue specific errors will not be captured.
Update your \`Sentry.init\` call with an appropriate config option:
\`app\` (Application Instance - Vue 3) or \`Vue\` (Vue Constructor - Vue 2).`,
 );
 return;
 }

 if (options.app) {
 const apps = arrayify(options.app);
 apps.forEach(app => vueInit(app, options));
 } else if (options.Vue) {
 vueInit(options.Vue, options);
 }
 }
}

const vueInit = (app: Vue, options: Options): void => {
 // Check app is not mounted yet - should be mounted _after_ init()!
 // This is _somewhat_ private, but in the case that this doesn't exist we simply ignore it
 // See: https://github.com/vuejs/core/blob/eb2a83283caa9de0a45881d860a3cbd9d0bdd279/packages/runtime-core/src/component.ts#L394
 const appWithInstance = app as Vue & {
 _instance?: {
 isMounted?: boolean;
 };
 };

 const isMounted = appWithInstance._instance && appWithInstance._instance.isMounted;
 if (isMounted === true) {
 // eslint-disable-next-line no-console
 console.warn(
 '[@sentry/vue]: Misconfigured SDK. Vue app is already mounted. Make sure to call `app.mount()` after `Sentry.init()`.',
 );
 }

 attachErrorHandler(app, options);

 if (hasTracingEnabled(options)) {
 app.mixin(
 createTracingMixins({
 ...options,
 ...options.tracingOptions,
 }),
 );
 }
};

94 changes: 16 additions & 78 deletions
packages/vue/src/sdk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,34 +1,7 @@
import { init as browserInit, SDK_VERSION } from '@sentry/browser';
import { hasTracingEnabled } from '@sentry/core';
import { arrayify, GLOBAL_OBJ } from '@sentry/utils';
import { defaultIntegrations, init as browserInit, SDK_VERSION } from '@sentry/browser';

import { DEFAULT_HOOKS } from './constants';
import { attachErrorHandler } from './errorhandler';
import { createTracingMixins } from './tracing';
import type { Options, TracingOptions, Vue } from './types';

const globalWithVue = GLOBAL_OBJ as typeof GLOBAL_OBJ & { Vue: Vue };

const DEFAULT_CONFIG: Options = {
 Vue: globalWithVue.Vue,
 attachProps: true,
 logErrors: true,
 hooks: DEFAULT_HOOKS,
 timeout: 2000,
 trackComponents: false,
 _metadata: {
 sdk: {
 name: 'sentry.javascript.vue',
 packages: [
 {
 name: 'npm:@sentry/vue',
 version: SDK_VERSION,
 },
 ],
 version: SDK_VERSION,
 },
 },
};
import { VueIntegration } from './integration';
import type { Options, TracingOptions } from './types';

/**
 * Inits the Vue SDK
Expand All@@ -37,56 +10,21 @@ export function init(
 config: Partial<Omit<Options, 'tracingOptions'> & { tracingOptions: Partial<TracingOptions> }> = {},
): void {
 const options = {
 ...DEFAULT_CONFIG,
 _metadata: {
 sdk: {
 name: 'sentry.javascript.vue',
 packages: [
 {
 name: 'npm:@sentry/vue',
 version: SDK_VERSION,
 },
 ],
 version: SDK_VERSION,
 },
 },
 defaultIntegrations: [...defaultIntegrations, new VueIntegration()],
 ...config,
 };

 browserInit(options);

 if (!options.Vue && !options.app) {
 // eslint-disable-next-line no-console
 console.warn(
 `[@sentry/vue]: Misconfigured SDK. Vue specific errors will not be captured.
Update your \`Sentry.init\` call with an appropriate config option:
\`app\` (Application Instance - Vue 3) or \`Vue\` (Vue Constructor - Vue 2).`,
 );
 return;
 }

 if (options.app) {
 const apps = arrayify(options.app);
 apps.forEach(app => vueInit(app, options));
 } else if (options.Vue) {
 vueInit(options.Vue, options);
 }
}

const vueInit = (app: Vue, options: Options): void => {
 // Check app is not mounted yet - should be mounted _after_ init()!
 // This is _somewhat_ private, but in the case that this doesn't exist we simply ignore it
 // See: https://github.com/vuejs/core/blob/eb2a83283caa9de0a45881d860a3cbd9d0bdd279/packages/runtime-core/src/component.ts#L394
 const appWithInstance = app as Vue & {
 _instance?: {
 isMounted?: boolean;
 };
 };

 const isMounted = appWithInstance._instance && appWithInstance._instance.isMounted;
 if (isMounted === true) {
 // eslint-disable-next-line no-console
 console.warn(
 '[@sentry/vue]: Misconfigured SDK. Vue app is already mounted. Make sure to call `app.mount()` after `Sentry.init()`.',
 );
 }

 attachErrorHandler(app, options);

 if (hasTracingEnabled(options)) {
 app.mixin(
 createTracingMixins({
 ...options,
 ...options.tracingOptions,
 }),
 );
 }
};

8 changes: 6 additions & 2 deletions
packages/vue/src/types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,11 +25,13 @@ export type ViewModel = {
 };
};

export interface Options extends TracingOptions, BrowserOptions {
export interface VueOptions extends TracingOptions {
 /** Vue constructor to be used inside the integration (as imported by `import Vue from 'vue'` in Vue2) */
 Vue?: Vue;

 /** Vue app instance(s) to be used inside the integration (as generated by `createApp` in Vue3 ) */
 /**
 * Vue app instance(s) to be used inside the integration (as generated by `createApp` in Vue3).
 */
 app?: Vue | Vue[];

 /**
Expand All@@ -48,6 +50,8 @@ export interface Options extends TracingOptions, BrowserOptions {
 tracingOptions?: Partial<TracingOptions>;
}

export interface Options extends BrowserOptions, VueOptions {}

/** Vue specific configuration for Tracing Integration */
export interface TracingOptions {
 /**
Expand Down

68 changes: 68 additions & 0 deletions
packages/vue/test/integration/VueIntegration.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
import { logger } from '@sentry/utils';
import { createApp } from 'vue';

import * as Sentry from '../../src';

const PUBLIC_DSN = 'https://username@domain/123';

describe('Sentry.VueIntegration', () => {
 let loggerWarnings: unknown[] = [];
 let warnings: unknown[] = [];

 beforeEach(() => {
 warnings = [];
 loggerWarnings = [];

 jest.spyOn(logger, 'warn').mockImplementation((message: unknown) => {
 loggerWarnings.push(message);
 });

 jest.spyOn(console, 'warn').mockImplementation((message: unknown) => {
 warnings.push(message);
 });
 });

 afterEach(() => {
 jest.resetAllMocks();
 });

 it('allows to initialize integration later', () => {
 Sentry.init({ dsn: PUBLIC_DSN, defaultIntegrations: false, autoSessionTracking: false });

 const el = document.createElement('div');
 const app = createApp({
 template: '<div>hello</div>',
 });

 // This would normally happen through client.addIntegration()
 const integration = new Sentry.VueIntegration({ app });
 integration['_setupIntegration'](Sentry.getCurrentHub());

 app.mount(el);

 expect(warnings).toEqual([]);
 expect(loggerWarnings).toEqual([]);

 expect(app.config.errorHandler).toBeDefined();
 });

 it('warns when mounting before SDK.VueIntegration', () => {
 Sentry.init({ dsn: PUBLIC_DSN, defaultIntegrations: false, autoSessionTracking: false });

 const el = document.createElement('div');
 const app = createApp({
 template: '<div>hello</div>',
 });

 app.mount(el);

 // This would normally happen through client.addIntegration()
 const integration = new Sentry.VueIntegration({ app });
 integration['_setupIntegration'](Sentry.getCurrentHub());

 expect(warnings).toEqual([
 '[@sentry/vue]: Misconfigured SDK. Vue app is already mounted. Make sure to call `app.mount()` after `Sentry.init()`.',
 ]);
 expect(loggerWarnings).toEqual([]);
 });
});
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(vue): Expose VueIntegration to initialize vue app later#9180

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

mydea
merged 2 commits into

from

Oct 9, 2023
 Merged


feat(vue): Expose VueIntegration to initialize vue app later
#9180
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
b037465

feat(vue): Expose `initVueApp` method to initialize vue app later


mydea Oct 5, 2023
827475d

ref: Refactor to integration


mydea Oct 5, 2023

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


4 changes: 2 additions & 2 deletions
packages/vue/src/errorhandler.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
import { getCurrentHub } from '@sentry/browser';
import { addExceptionMechanism } from '@sentry/utils';

import type { Options, ViewModel, Vue } from './types';
import type { ViewModel, Vue, VueOptions } from './types';
import { formatComponentName, generateComponentTrace } from './vendor/components';

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

export const attachErrorHandler = (app: Vue, options: Options): void => {
export const attachErrorHandler = (app: Vue, options: VueOptions): void => {
 const { errorHandler, warnHandler, silent } = app.config;

 app.config.errorHandler = (error: Error, vm: ViewModel, lifecycleHook: string): void => {
Expand Down

1 change: 1 addition & 0 deletions
packages/vue/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,3 +4,4 @@ export { init } from './sdk';
export { vueRouterInstrumentation } from './router';
export { attachErrorHandler } from './errorhandler';
export { createTracingMixins } from './tracing';
export { VueIntegration } from './integration';

99 changes: 99 additions & 0 deletions
packages/vue/src/integration.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,99 @@
import { hasTracingEnabled } from '@sentry/core';
import type { Hub, Integration } from '@sentry/types';
import { arrayify, GLOBAL_OBJ } from '@sentry/utils';

import { DEFAULT_HOOKS } from './constants';
import { attachErrorHandler } from './errorhandler';
import { createTracingMixins } from './tracing';
import type { Options, Vue, VueOptions } from './types';

const globalWithVue = GLOBAL_OBJ as typeof GLOBAL_OBJ & { Vue: Vue };

const DEFAULT_CONFIG: VueOptions = {
 Vue: globalWithVue.Vue,
 attachProps: true,
 logErrors: true,
 hooks: DEFAULT_HOOKS,
 timeout: 2000,
 trackComponents: false,
};

/**
 * Initialize Vue error & performance tracking.
 */
export class VueIntegration implements Integration {
 /**
 * @inheritDoc
 */
 public static id: string = 'Vue';

 /**
 * @inheritDoc
 */
 public name: string;

 private readonly _options: Partial<VueOptions>;

 public constructor(options: Partial<VueOptions> = {}) {
 this.name = VueIntegration.id;
 this._options = options;
 }

 /** @inheritDoc */
 public setupOnce(_addGlobaleventProcessor: unknown, getCurrentHub: () => Hub): void {
 this._setupIntegration(getCurrentHub());
 }

 /** Just here for easier testing */
 protected _setupIntegration(hub: Hub): void {
 const client = hub.getClient();
 const options: Options = { ...DEFAULT_CONFIG, ...(client && client.getOptions()), ...this._options };

 if (!options.Vue && !options.app) {
 // eslint-disable-next-line no-console
 console.warn(
 `[@sentry/vue]: Misconfigured SDK. Vue specific errors will not be captured.
Update your \`Sentry.init\` call with an appropriate config option:
\`app\` (Application Instance - Vue 3) or \`Vue\` (Vue Constructor - Vue 2).`,
 );
 return;
 }

 if (options.app) {
 const apps = arrayify(options.app);
 apps.forEach(app => vueInit(app, options));
 } else if (options.Vue) {
 vueInit(options.Vue, options);
 }
 }
}

const vueInit = (app: Vue, options: Options): void => {
 // Check app is not mounted yet - should be mounted _after_ init()!
 // This is _somewhat_ private, but in the case that this doesn't exist we simply ignore it
 // See: https://github.com/vuejs/core/blob/eb2a83283caa9de0a45881d860a3cbd9d0bdd279/packages/runtime-core/src/component.ts#L394
 const appWithInstance = app as Vue & {
 _instance?: {
 isMounted?: boolean;
 };
 };

 const isMounted = appWithInstance._instance && appWithInstance._instance.isMounted;
 if (isMounted === true) {
 // eslint-disable-next-line no-console
 console.warn(
 '[@sentry/vue]: Misconfigured SDK. Vue app is already mounted. Make sure to call `app.mount()` after `Sentry.init()`.',
 );
 }

 attachErrorHandler(app, options);

 if (hasTracingEnabled(options)) {
 app.mixin(
 createTracingMixins({
 ...options,
 ...options.tracingOptions,
 }),
 );
 }
};

94 changes: 16 additions & 78 deletions
packages/vue/src/sdk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,34 +1,7 @@
import { init as browserInit, SDK_VERSION } from '@sentry/browser';
import { hasTracingEnabled } from '@sentry/core';
import { arrayify, GLOBAL_OBJ } from '@sentry/utils';
import { defaultIntegrations, init as browserInit, SDK_VERSION } from '@sentry/browser';

import { DEFAULT_HOOKS } from './constants';
import { attachErrorHandler } from './errorhandler';
import { createTracingMixins } from './tracing';
import type { Options, TracingOptions, Vue } from './types';

const globalWithVue = GLOBAL_OBJ as typeof GLOBAL_OBJ & { Vue: Vue };

const DEFAULT_CONFIG: Options = {
 Vue: globalWithVue.Vue,
 attachProps: true,
 logErrors: true,
 hooks: DEFAULT_HOOKS,
 timeout: 2000,
 trackComponents: false,
 _metadata: {
 sdk: {
 name: 'sentry.javascript.vue',
 packages: [
 {
 name: 'npm:@sentry/vue',
 version: SDK_VERSION,
 },
 ],
 version: SDK_VERSION,
 },
 },
};
import { VueIntegration } from './integration';
import type { Options, TracingOptions } from './types';

/**
 * Inits the Vue SDK
Expand All@@ -37,56 +10,21 @@ export function init(
 config: Partial<Omit<Options, 'tracingOptions'> & { tracingOptions: Partial<TracingOptions> }> = {},
): void {
 const options = {
 ...DEFAULT_CONFIG,
 _metadata: {
 sdk: {
 name: 'sentry.javascript.vue',
 packages: [
 {
 name: 'npm:@sentry/vue',
 version: SDK_VERSION,
 },
 ],
 version: SDK_VERSION,
 },
 },
 defaultIntegrations: [...defaultIntegrations, new VueIntegration()],
 ...config,
 };

 browserInit(options);

 if (!options.Vue && !options.app) {
 // eslint-disable-next-line no-console
 console.warn(
 `[@sentry/vue]: Misconfigured SDK. Vue specific errors will not be captured.
Update your \`Sentry.init\` call with an appropriate config option:
\`app\` (Application Instance - Vue 3) or \`Vue\` (Vue Constructor - Vue 2).`,
 );
 return;
 }

 if (options.app) {
 const apps = arrayify(options.app);
 apps.forEach(app => vueInit(app, options));
 } else if (options.Vue) {
 vueInit(options.Vue, options);
 }
}

const vueInit = (app: Vue, options: Options): void => {
 // Check app is not mounted yet - should be mounted _after_ init()!
 // This is _somewhat_ private, but in the case that this doesn't exist we simply ignore it
 // See: https://github.com/vuejs/core/blob/eb2a83283caa9de0a45881d860a3cbd9d0bdd279/packages/runtime-core/src/component.ts#L394
 const appWithInstance = app as Vue & {
 _instance?: {
 isMounted?: boolean;
 };
 };

 const isMounted = appWithInstance._instance && appWithInstance._instance.isMounted;
 if (isMounted === true) {
 // eslint-disable-next-line no-console
 console.warn(
 '[@sentry/vue]: Misconfigured SDK. Vue app is already mounted. Make sure to call `app.mount()` after `Sentry.init()`.',
 );
 }

 attachErrorHandler(app, options);

 if (hasTracingEnabled(options)) {
 app.mixin(
 createTracingMixins({
 ...options,
 ...options.tracingOptions,
 }),
 );
 }
};

8 changes: 6 additions & 2 deletions
packages/vue/src/types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,11 +25,13 @@ export type ViewModel = {
 };
};

export interface Options extends TracingOptions, BrowserOptions {
export interface VueOptions extends TracingOptions {
 /** Vue constructor to be used inside the integration (as imported by `import Vue from 'vue'` in Vue2) */
 Vue?: Vue;

 /** Vue app instance(s) to be used inside the integration (as generated by `createApp` in Vue3 ) */
 /**
 * Vue app instance(s) to be used inside the integration (as generated by `createApp` in Vue3).
 */
 app?: Vue | Vue[];

 /**
Expand All@@ -48,6 +50,8 @@ export interface Options extends TracingOptions, BrowserOptions {
 tracingOptions?: Partial<TracingOptions>;
}

export interface Options extends BrowserOptions, VueOptions {}

/** Vue specific configuration for Tracing Integration */
export interface TracingOptions {
 /**
Expand Down

68 changes: 68 additions & 0 deletions
packages/vue/test/integration/VueIntegration.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
import { logger } from '@sentry/utils';
import { createApp } from 'vue';

import * as Sentry from '../../src';

const PUBLIC_DSN = 'https://username@domain/123';

describe('Sentry.VueIntegration', () => {
 let loggerWarnings: unknown[] = [];
 let warnings: unknown[] = [];

 beforeEach(() => {
 warnings = [];
 loggerWarnings = [];

 jest.spyOn(logger, 'warn').mockImplementation((message: unknown) => {
 loggerWarnings.push(message);
 });

 jest.spyOn(console, 'warn').mockImplementation((message: unknown) => {
 warnings.push(message);
 });
 });

 afterEach(() => {
 jest.resetAllMocks();
 });

 it('allows to initialize integration later', () => {
 Sentry.init({ dsn: PUBLIC_DSN, defaultIntegrations: false, autoSessionTracking: false });

 const el = document.createElement('div');
 const app = createApp({
 template: '<div>hello</div>',
 });

 // This would normally happen through client.addIntegration()
 const integration = new Sentry.VueIntegration({ app });
 integration['_setupIntegration'](Sentry.getCurrentHub());

 app.mount(el);

 expect(warnings).toEqual([]);
 expect(loggerWarnings).toEqual([]);

 expect(app.config.errorHandler).toBeDefined();
 });

 it('warns when mounting before SDK.VueIntegration', () => {
 Sentry.init({ dsn: PUBLIC_DSN, defaultIntegrations: false, autoSessionTracking: false });

 const el = document.createElement('div');
 const app = createApp({
 template: '<div>hello</div>',
 });

 app.mount(el);

 // This would normally happen through client.addIntegration()
 const integration = new Sentry.VueIntegration({ app });
 integration['_setupIntegration'](Sentry.getCurrentHub());

 expect(warnings).toEqual([
 '[@sentry/vue]: Misconfigured SDK. Vue app is already mounted. Make sure to call `app.mount()` after `Sentry.init()`.',
 ]);
 expect(loggerWarnings).toEqual([]);
 });
});
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(vue): Expose VueIntegration to initialize vue app later#9180

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

mydea
merged 2 commits into

from

Oct 9, 2023
 Merged


feat(vue): Expose VueIntegration to initialize vue app later
#9180
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
b037465

feat(vue): Expose `initVueApp` method to initialize vue app later


mydea Oct 5, 2023
827475d

ref: Refactor to integration


mydea Oct 5, 2023

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


4 changes: 2 additions & 2 deletions
packages/vue/src/errorhandler.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
import { getCurrentHub } from '@sentry/browser';
import { addExceptionMechanism } from '@sentry/utils';

import type { Options, ViewModel, Vue } from './types';
import type { ViewModel, Vue, VueOptions } from './types';
import { formatComponentName, generateComponentTrace } from './vendor/components';

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

export const attachErrorHandler = (app: Vue, options: Options): void => {
export const attachErrorHandler = (app: Vue, options: VueOptions): void => {
 const { errorHandler, warnHandler, silent } = app.config;

 app.config.errorHandler = (error: Error, vm: ViewModel, lifecycleHook: string): void => {
Expand Down

1 change: 1 addition & 0 deletions
packages/vue/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,3 +4,4 @@ export { init } from './sdk';
export { vueRouterInstrumentation } from './router';
export { attachErrorHandler } from './errorhandler';
export { createTracingMixins } from './tracing';
export { VueIntegration } from './integration';

99 changes: 99 additions & 0 deletions
packages/vue/src/integration.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,99 @@
import { hasTracingEnabled } from '@sentry/core';
import type { Hub, Integration } from '@sentry/types';
import { arrayify, GLOBAL_OBJ } from '@sentry/utils';

import { DEFAULT_HOOKS } from './constants';
import { attachErrorHandler } from './errorhandler';
import { createTracingMixins } from './tracing';
import type { Options, Vue, VueOptions } from './types';

const globalWithVue = GLOBAL_OBJ as typeof GLOBAL_OBJ & { Vue: Vue };

const DEFAULT_CONFIG: VueOptions = {
 Vue: globalWithVue.Vue,
 attachProps: true,
 logErrors: true,
 hooks: DEFAULT_HOOKS,
 timeout: 2000,
 trackComponents: false,
};

/**
 * Initialize Vue error & performance tracking.
 */
export class VueIntegration implements Integration {
 /**
 * @inheritDoc
 */
 public static id: string = 'Vue';

 /**
 * @inheritDoc
 */
 public name: string;

 private readonly _options: Partial<VueOptions>;

 public constructor(options: Partial<VueOptions> = {}) {
 this.name = VueIntegration.id;
 this._options = options;
 }

 /** @inheritDoc */
 public setupOnce(_addGlobaleventProcessor: unknown, getCurrentHub: () => Hub): void {
 this._setupIntegration(getCurrentHub());
 }

 /** Just here for easier testing */
 protected _setupIntegration(hub: Hub): void {
 const client = hub.getClient();
 const options: Options = { ...DEFAULT_CONFIG, ...(client && client.getOptions()), ...this._options };

 if (!options.Vue && !options.app) {
 // eslint-disable-next-line no-console
 console.warn(
 `[@sentry/vue]: Misconfigured SDK. Vue specific errors will not be captured.
Update your \`Sentry.init\` call with an appropriate config option:
\`app\` (Application Instance - Vue 3) or \`Vue\` (Vue Constructor - Vue 2).`,
 );
 return;
 }

 if (options.app) {
 const apps = arrayify(options.app);
 apps.forEach(app => vueInit(app, options));
 } else if (options.Vue) {
 vueInit(options.Vue, options);
 }
 }
}

const vueInit = (app: Vue, options: Options): void => {
 // Check app is not mounted yet - should be mounted _after_ init()!
 // This is _somewhat_ private, but in the case that this doesn't exist we simply ignore it
 // See: https://github.com/vuejs/core/blob/eb2a83283caa9de0a45881d860a3cbd9d0bdd279/packages/runtime-core/src/component.ts#L394
 const appWithInstance = app as Vue & {
 _instance?: {
 isMounted?: boolean;
 };
 };

 const isMounted = appWithInstance._instance && appWithInstance._instance.isMounted;
 if (isMounted === true) {
 // eslint-disable-next-line no-console
 console.warn(
 '[@sentry/vue]: Misconfigured SDK. Vue app is already mounted. Make sure to call `app.mount()` after `Sentry.init()`.',
 );
 }

 attachErrorHandler(app, options);

 if (hasTracingEnabled(options)) {
 app.mixin(
 createTracingMixins({
 ...options,
 ...options.tracingOptions,
 }),
 );
 }
};

94 changes: 16 additions & 78 deletions
packages/vue/src/sdk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,34 +1,7 @@
import { init as browserInit, SDK_VERSION } from '@sentry/browser';
import { hasTracingEnabled } from '@sentry/core';
import { arrayify, GLOBAL_OBJ } from '@sentry/utils';
import { defaultIntegrations, init as browserInit, SDK_VERSION } from '@sentry/browser';

import { DEFAULT_HOOKS } from './constants';
import { attachErrorHandler } from './errorhandler';
import { createTracingMixins } from './tracing';
import type { Options, TracingOptions, Vue } from './types';

const globalWithVue = GLOBAL_OBJ as typeof GLOBAL_OBJ & { Vue: Vue };

const DEFAULT_CONFIG: Options = {
 Vue: globalWithVue.Vue,
 attachProps: true,
 logErrors: true,
 hooks: DEFAULT_HOOKS,
 timeout: 2000,
 trackComponents: false,
 _metadata: {
 sdk: {
 name: 'sentry.javascript.vue',
 packages: [
 {
 name: 'npm:@sentry/vue',
 version: SDK_VERSION,
 },
 ],
 version: SDK_VERSION,
 },
 },
};
import { VueIntegration } from './integration';
import type { Options, TracingOptions } from './types';

/**
 * Inits the Vue SDK
Expand All@@ -37,56 +10,21 @@ export function init(
 config: Partial<Omit<Options, 'tracingOptions'> & { tracingOptions: Partial<TracingOptions> }> = {},
): void {
 const options = {
 ...DEFAULT_CONFIG,
 _metadata: {
 sdk: {
 name: 'sentry.javascript.vue',
 packages: [
 {
 name: 'npm:@sentry/vue',
 version: SDK_VERSION,
 },
 ],
 version: SDK_VERSION,
 },
 },
 defaultIntegrations: [...defaultIntegrations, new VueIntegration()],
 ...config,
 };

 browserInit(options);

 if (!options.Vue && !options.app) {
 // eslint-disable-next-line no-console
 console.warn(
 `[@sentry/vue]: Misconfigured SDK. Vue specific errors will not be captured.
Update your \`Sentry.init\` call with an appropriate config option:
\`app\` (Application Instance - Vue 3) or \`Vue\` (Vue Constructor - Vue 2).`,
 );
 return;
 }

 if (options.app) {
 const apps = arrayify(options.app);
 apps.forEach(app => vueInit(app, options));
 } else if (options.Vue) {
 vueInit(options.Vue, options);
 }
}

const vueInit = (app: Vue, options: Options): void => {
 // Check app is not mounted yet - should be mounted _after_ init()!
 // This is _somewhat_ private, but in the case that this doesn't exist we simply ignore it
 // See: https://github.com/vuejs/core/blob/eb2a83283caa9de0a45881d860a3cbd9d0bdd279/packages/runtime-core/src/component.ts#L394
 const appWithInstance = app as Vue & {
 _instance?: {
 isMounted?: boolean;
 };
 };

 const isMounted = appWithInstance._instance && appWithInstance._instance.isMounted;
 if (isMounted === true) {
 // eslint-disable-next-line no-console
 console.warn(
 '[@sentry/vue]: Misconfigured SDK. Vue app is already mounted. Make sure to call `app.mount()` after `Sentry.init()`.',
 );
 }

 attachErrorHandler(app, options);

 if (hasTracingEnabled(options)) {
 app.mixin(
 createTracingMixins({
 ...options,
 ...options.tracingOptions,
 }),
 );
 }
};

8 changes: 6 additions & 2 deletions
packages/vue/src/types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,11 +25,13 @@ export type ViewModel = {
 };
};

export interface Options extends TracingOptions, BrowserOptions {
export interface VueOptions extends TracingOptions {
 /** Vue constructor to be used inside the integration (as imported by `import Vue from 'vue'` in Vue2) */
 Vue?: Vue;

 /** Vue app instance(s) to be used inside the integration (as generated by `createApp` in Vue3 ) */
 /**
 * Vue app instance(s) to be used inside the integration (as generated by `createApp` in Vue3).
 */
 app?: Vue | Vue[];

 /**
Expand All@@ -48,6 +50,8 @@ export interface Options extends TracingOptions, BrowserOptions {
 tracingOptions?: Partial<TracingOptions>;
}

export interface Options extends BrowserOptions, VueOptions {}

/** Vue specific configuration for Tracing Integration */
export interface TracingOptions {
 /**
Expand Down

68 changes: 68 additions & 0 deletions
packages/vue/test/integration/VueIntegration.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
import { logger } from '@sentry/utils';
import { createApp } from 'vue';

import * as Sentry from '../../src';

const PUBLIC_DSN = 'https://username@domain/123';

describe('Sentry.VueIntegration', () => {
 let loggerWarnings: unknown[] = [];
 let warnings: unknown[] = [];

 beforeEach(() => {
 warnings = [];
 loggerWarnings = [];

 jest.spyOn(logger, 'warn').mockImplementation((message: unknown) => {
 loggerWarnings.push(message);
 });

 jest.spyOn(console, 'warn').mockImplementation((message: unknown) => {
 warnings.push(message);
 });
 });

 afterEach(() => {
 jest.resetAllMocks();
 });

 it('allows to initialize integration later', () => {
 Sentry.init({ dsn: PUBLIC_DSN, defaultIntegrations: false, autoSessionTracking: false });

 const el = document.createElement('div');
 const app = createApp({
 template: '<div>hello</div>',
 });

 // This would normally happen through client.addIntegration()
 const integration = new Sentry.VueIntegration({ app });
 integration['_setupIntegration'](Sentry.getCurrentHub());

 app.mount(el);

 expect(warnings).toEqual([]);
 expect(loggerWarnings).toEqual([]);

 expect(app.config.errorHandler).toBeDefined();
 });

 it('warns when mounting before SDK.VueIntegration', () => {
 Sentry.init({ dsn: PUBLIC_DSN, defaultIntegrations: false, autoSessionTracking: false });

 const el = document.createElement('div');
 const app = createApp({
 template: '<div>hello</div>',
 });

 app.mount(el);

 // This would normally happen through client.addIntegration()
 const integration = new Sentry.VueIntegration({ app });
 integration['_setupIntegration'](Sentry.getCurrentHub());

 expect(warnings).toEqual([
 '[@sentry/vue]: Misconfigured SDK. Vue app is already mounted. Make sure to call `app.mount()` after `Sentry.init()`.',
 ]);
 expect(loggerWarnings).toEqual([]);
 });
});
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
feat(vue): Expose VueIntegration to initialize vue app later#9180

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

mydea
merged 2 commits into

from

Oct 9, 2023
 Merged


feat(vue): Expose VueIntegration to initialize vue app later
#9180
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
b037465

feat(vue): Expose `initVueApp` method to initialize vue app later


mydea Oct 5, 2023
827475d

ref: Refactor to integration


mydea Oct 5, 2023

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


4 changes: 2 additions & 2 deletions
packages/vue/src/errorhandler.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
import { getCurrentHub } from '@sentry/browser';
import { addExceptionMechanism } from '@sentry/utils';

import type { Options, ViewModel, Vue } from './types';
import type { ViewModel, Vue, VueOptions } from './types';
import { formatComponentName, generateComponentTrace } from './vendor/components';

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

export const attachErrorHandler = (app: Vue, options: Options): void => {
export const attachErrorHandler = (app: Vue, options: VueOptions): void => {
 const { errorHandler, warnHandler, silent } = app.config;

 app.config.errorHandler = (error: Error, vm: ViewModel, lifecycleHook: string): void => {
Expand Down

1 change: 1 addition & 0 deletions
packages/vue/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,3 +4,4 @@ export { init } from './sdk';
export { vueRouterInstrumentation } from './router';
export { attachErrorHandler } from './errorhandler';
export { createTracingMixins } from './tracing';
export { VueIntegration } from './integration';

99 changes: 99 additions & 0 deletions
packages/vue/src/integration.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,99 @@
import { hasTracingEnabled } from '@sentry/core';
import type { Hub, Integration } from '@sentry/types';
import { arrayify, GLOBAL_OBJ } from '@sentry/utils';

import { DEFAULT_HOOKS } from './constants';
import { attachErrorHandler } from './errorhandler';
import { createTracingMixins } from './tracing';
import type { Options, Vue, VueOptions } from './types';

const globalWithVue = GLOBAL_OBJ as typeof GLOBAL_OBJ & { Vue: Vue };

const DEFAULT_CONFIG: VueOptions = {
 Vue: globalWithVue.Vue,
 attachProps: true,
 logErrors: true,
 hooks: DEFAULT_HOOKS,
 timeout: 2000,
 trackComponents: false,
};

/**
 * Initialize Vue error & performance tracking.
 */
export class VueIntegration implements Integration {
 /**
 * @inheritDoc
 */
 public static id: string = 'Vue';

 /**
 * @inheritDoc
 */
 public name: string;

 private readonly _options: Partial<VueOptions>;

 public constructor(options: Partial<VueOptions> = {}) {
 this.name = VueIntegration.id;
 this._options = options;
 }

 /** @inheritDoc */
 public setupOnce(_addGlobaleventProcessor: unknown, getCurrentHub: () => Hub): void {
 this._setupIntegration(getCurrentHub());
 }

 /** Just here for easier testing */
 protected _setupIntegration(hub: Hub): void {
 const client = hub.getClient();
 const options: Options = { ...DEFAULT_CONFIG, ...(client && client.getOptions()), ...this._options };

 if (!options.Vue && !options.app) {
 // eslint-disable-next-line no-console
 console.warn(
 `[@sentry/vue]: Misconfigured SDK. Vue specific errors will not be captured.
Update your \`Sentry.init\` call with an appropriate config option:
\`app\` (Application Instance - Vue 3) or \`Vue\` (Vue Constructor - Vue 2).`,
 );
 return;
 }

 if (options.app) {
 const apps = arrayify(options.app);
 apps.forEach(app => vueInit(app, options));
 } else if (options.Vue) {
 vueInit(options.Vue, options);
 }
 }
}

const vueInit = (app: Vue, options: Options): void => {
 // Check app is not mounted yet - should be mounted _after_ init()!
 // This is _somewhat_ private, but in the case that this doesn't exist we simply ignore it
 // See: https://github.com/vuejs/core/blob/eb2a83283caa9de0a45881d860a3cbd9d0bdd279/packages/runtime-core/src/component.ts#L394
 const appWithInstance = app as Vue & {
 _instance?: {
 isMounted?: boolean;
 };
 };

 const isMounted = appWithInstance._instance && appWithInstance._instance.isMounted;
 if (isMounted === true) {
 // eslint-disable-next-line no-console
 console.warn(
 '[@sentry/vue]: Misconfigured SDK. Vue app is already mounted. Make sure to call `app.mount()` after `Sentry.init()`.',
 );
 }

 attachErrorHandler(app, options);

 if (hasTracingEnabled(options)) {
 app.mixin(
 createTracingMixins({
 ...options,
 ...options.tracingOptions,
 }),
 );
 }
};

94 changes: 16 additions & 78 deletions
packages/vue/src/sdk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,34 +1,7 @@
import { init as browserInit, SDK_VERSION } from '@sentry/browser';
import { hasTracingEnabled } from '@sentry/core';
import { arrayify, GLOBAL_OBJ } from '@sentry/utils';
import { defaultIntegrations, init as browserInit, SDK_VERSION } from '@sentry/browser';

import { DEFAULT_HOOKS } from './constants';
import { attachErrorHandler } from './errorhandler';
import { createTracingMixins } from './tracing';
import type { Options, TracingOptions, Vue } from './types';

const globalWithVue = GLOBAL_OBJ as typeof GLOBAL_OBJ & { Vue: Vue };

const DEFAULT_CONFIG: Options = {
 Vue: globalWithVue.Vue,
 attachProps: true,
 logErrors: true,
 hooks: DEFAULT_HOOKS,
 timeout: 2000,
 trackComponents: false,
 _metadata: {
 sdk: {
 name: 'sentry.javascript.vue',
 packages: [
 {
 name: 'npm:@sentry/vue',
 version: SDK_VERSION,
 },
 ],
 version: SDK_VERSION,
 },
 },
};
import { VueIntegration } from './integration';
import type { Options, TracingOptions } from './types';

/**
 * Inits the Vue SDK
Expand All@@ -37,56 +10,21 @@ export function init(
 config: Partial<Omit<Options, 'tracingOptions'> & { tracingOptions: Partial<TracingOptions> }> = {},
): void {
 const options = {
 ...DEFAULT_CONFIG,
 _metadata: {
 sdk: {
 name: 'sentry.javascript.vue',
 packages: [
 {
 name: 'npm:@sentry/vue',
 version: SDK_VERSION,
 },
 ],
 version: SDK_VERSION,
 },
 },
 defaultIntegrations: [...defaultIntegrations, new VueIntegration()],
 ...config,
 };

 browserInit(options);

 if (!options.Vue && !options.app) {
 // eslint-disable-next-line no-console
 console.warn(
 `[@sentry/vue]: Misconfigured SDK. Vue specific errors will not be captured.
Update your \`Sentry.init\` call with an appropriate config option:
\`app\` (Application Instance - Vue 3) or \`Vue\` (Vue Constructor - Vue 2).`,
 );
 return;
 }

 if (options.app) {
 const apps = arrayify(options.app);
 apps.forEach(app => vueInit(app, options));
 } else if (options.Vue) {
 vueInit(options.Vue, options);
 }
}

const vueInit = (app: Vue, options: Options): void => {
 // Check app is not mounted yet - should be mounted _after_ init()!
 // This is _somewhat_ private, but in the case that this doesn't exist we simply ignore it
 // See: https://github.com/vuejs/core/blob/eb2a83283caa9de0a45881d860a3cbd9d0bdd279/packages/runtime-core/src/component.ts#L394
 const appWithInstance = app as Vue & {
 _instance?: {
 isMounted?: boolean;
 };
 };

 const isMounted = appWithInstance._instance && appWithInstance._instance.isMounted;
 if (isMounted === true) {
 // eslint-disable-next-line no-console
 console.warn(
 '[@sentry/vue]: Misconfigured SDK. Vue app is already mounted. Make sure to call `app.mount()` after `Sentry.init()`.',
 );
 }

 attachErrorHandler(app, options);

 if (hasTracingEnabled(options)) {
 app.mixin(
 createTracingMixins({
 ...options,
 ...options.tracingOptions,
 }),
 );
 }
};

8 changes: 6 additions & 2 deletions
packages/vue/src/types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,11 +25,13 @@ export type ViewModel = {
 };
};

export interface Options extends TracingOptions, BrowserOptions {
export interface VueOptions extends TracingOptions {
 /** Vue constructor to be used inside the integration (as imported by `import Vue from 'vue'` in Vue2) */
 Vue?: Vue;

 /** Vue app instance(s) to be used inside the integration (as generated by `createApp` in Vue3 ) */
 /**
 * Vue app instance(s) to be used inside the integration (as generated by `createApp` in Vue3).
 */
 app?: Vue | Vue[];

 /**
Expand All@@ -48,6 +50,8 @@ export interface Options extends TracingOptions, BrowserOptions {
 tracingOptions?: Partial<TracingOptions>;
}

export interface Options extends BrowserOptions, VueOptions {}

/** Vue specific configuration for Tracing Integration */
export interface TracingOptions {
 /**
Expand Down

68 changes: 68 additions & 0 deletions
packages/vue/test/integration/VueIntegration.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
import { logger } from '@sentry/utils';
import { createApp } from 'vue';

import * as Sentry from '../../src';

const PUBLIC_DSN = 'https://username@domain/123';

describe('Sentry.VueIntegration', () => {
 let loggerWarnings: unknown[] = [];
 let warnings: unknown[] = [];

 beforeEach(() => {
 warnings = [];
 loggerWarnings = [];

 jest.spyOn(logger, 'warn').mockImplementation((message: unknown) => {
 loggerWarnings.push(message);
 });

 jest.spyOn(console, 'warn').mockImplementation((message: unknown) => {
 warnings.push(message);
 });
 });

 afterEach(() => {
 jest.resetAllMocks();
 });

 it('allows to initialize integration later', () => {
 Sentry.init({ dsn: PUBLIC_DSN, defaultIntegrations: false, autoSessionTracking: false });

 const el = document.createElement('div');
 const app = createApp({
 template: '<div>hello</div>',
 });

 // This would normally happen through client.addIntegration()
 const integration = new Sentry.VueIntegration({ app });
 integration['_setupIntegration'](Sentry.getCurrentHub());

 app.mount(el);

 expect(warnings).toEqual([]);
 expect(loggerWarnings).toEqual([]);

 expect(app.config.errorHandler).toBeDefined();
 });

 it('warns when mounting before SDK.VueIntegration', () => {
 Sentry.init({ dsn: PUBLIC_DSN, defaultIntegrations: false, autoSessionTracking: false });

 const el = document.createElement('div');
 const app = createApp({
 template: '<div>hello</div>',
 });

 app.mount(el);

 // This would normally happen through client.addIntegration()
 const integration = new Sentry.VueIntegration({ app });
 integration['_setupIntegration'](Sentry.getCurrentHub());

 expect(warnings).toEqual([
 '[@sentry/vue]: Misconfigured SDK. Vue app is already mounted. Make sure to call `app.mount()` after `Sentry.init()`.',
 ]);
 expect(loggerWarnings).toEqual([]);
 });
});
Loading