fix(utils): Prevent iterating over VueViewModel#8981

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
Lms24 merged 4 commits into from
Sep 13, 2023
Merged

fix(utils): Prevent iterating over VueViewModel #8981

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
45f9f4c
fix(utils): Prevent iterating over VueViewModel
Duncanxyz Sep 8, 2023
c92da7a
fix(utils): Prevent iterating over VueViewModel fro Vue 3
Duncanxyz Sep 12, 2023
ada46f4
perf(utils): Optimize special handling arguments for Vue in consoleBr…
Duncanxyz Sep 12, 2023
bae8c65
fix(utils): Streamline testing for isVueViewModel
Duncanxyz Sep 12, 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
12 changes: 0 additions & 12 deletions packages/browser/src/integrations/breadcrumbs.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -183,18 +183,6 @@ function _domBreadcrumb(dom: BreadcrumbsOptions['dom']): (handlerData: HandlerDa
* Creates breadcrumbs from console API calls
*/
function _consoleBreadcrumb(handlerData: HandlerData & { args: unknown[]; level: string }): void {
// This is a hack to fix a Vue3-specific bug that causes an infinite loop of
// console warnings. This happens when a Vue template is rendered with
// an undeclared variable, which we try to stringify, ultimately causing
// Vue to issue another warning which repeats indefinitely.
// see: https://github.com/getsentry/sentry-javascript/pull/6010
// see: https://github.com/getsentry/sentry-javascript/issues/5916
for (let i = 0; i < handlerData.args.length; i++) {
if (handlerData.args[i] === 'ref=Ref<') {
handlerData.args[i + 1] = 'viewRef';
break;
}
}
const breadcrumb = {
category: 'console',
data: {
Expand Down
17 changes: 17 additions & 0 deletions packages/utils/src/is.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -179,3 +179,20 @@ export function isInstanceOf(wat: any, base: any): boolean {
return false;
}
}

interface VueViewModel {
// Vue3
__isVue?: boolean;
// Vue2
_isVue?: boolean;
}
/**
* Checks whether given value's type is a Vue ViewModel.
*
* @param wat A value to be checked.
* @returns A boolean representing the result.
*/
export function isVueViewModel(wat: unknown): boolean {
// Not using Object.prototype.toString because in Vue 3 it would read the instance's Symbol(Symbol.toStringTag) property.
return !!(typeof wat === 'object' && wat !== null && ((wat as VueViewModel).__isVue || (wat as VueViewModel)._isVue));
}
6 changes: 5 additions & 1 deletion packages/utils/src/normalize.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
import type { Primitive } from '@sentry/types';

import { isNaN, isSyntheticEvent } from './is';
import { isNaN, isSyntheticEvent, isVueViewModel } from './is';
import type { MemoFunc } from './memo';
import { memoBuilder } from './memo';
import { convertToPlainObject } from './object';
Expand DownExpand Up@@ -214,6 +214,10 @@ function stringifyValue(
return '[Document]';
}

if (isVueViewModel(value)) {
return '[VueViewModel]';
}

// React's SyntheticEvent thingy
if (isSyntheticEvent(value)) {
return '[SyntheticEvent]';
Comment on lines +220 to 223

@Lms24Lms24Sep 8, 2023

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

well I guess there's precedence for handling this stuff like this in a general package of ours 😅

@AbhiPrasadAbhiPrasadSep 8, 2023

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

the tricky thing is that some people end up just using @sentry/browser even when using a framework like React or Vue.

but I think we should re-examine this in v8 and see if we can somehow inject in framework specific processing.

Expand Down
13 changes: 11 additions & 2 deletions packages/utils/src/string.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { isRegExp, isString } from './is';
import { isRegExp, isString, isVueViewModel } from './is';

export { escapeStringForRegex } from './vendor/escapeStringForRegex';

Expand DownExpand Up@@ -76,7 +76,16 @@ export function safeJoin(input: any[], delimiter?: string): string {
for (let i = 0; i < input.length; i++) {
const value = input[i];
try {
output.push(String(value));
// This is a hack to fix a Vue3-specific bug that causes an infinite loop of
// console warnings. This happens when a Vue template is rendered with
// an undeclared variable, which we try to stringify, ultimately causing
// Vue to issue another warning which repeats indefinitely.
// see: https://github.com/getsentry/sentry-javascript/pull/8981
if (isVueViewModel(value)) {
output.push('[VueViewModel]');
} else {
output.push(String(value));
}
} catch (e) {
output.push('[value cannot be serialized]');
}
Expand Down
10 changes: 10 additions & 0 deletions packages/utils/test/is.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,7 @@ import {
isNaN,
isPrimitive,
isThenable,
isVueViewModel,
} from '../src/is';
import { supportsDOMError, supportsDOMException, supportsErrorEvent } from '../src/supports';
import { resolvedSyncPromise } from '../src/syncpromise';
Expand DownExpand Up@@ -134,3 +135,12 @@ describe('isNaN()', () => {
expect(isNaN(new Date())).toEqual(false);
});
});

describe('isVueViewModel()', () => {
test('should work as advertised', () => {
expect(isVueViewModel({ _isVue: true })).toEqual(true);
expect(isVueViewModel({ __isVue: true })).toEqual(true);
Comment thread
Duncanxyz marked this conversation as resolved.

expect(isVueViewModel({ foo: true })).toEqual(false);
});
});
29 changes: 29 additions & 0 deletions packages/utils/test/normalize.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -476,6 +476,17 @@ describe('normalize()', () => {
foo: '[SyntheticEvent]',
});
});

test('known classes like `VueViewModel`', () => {
const obj = {
foo: {
_isVue: true,
},
};
expect(normalize(obj)).toEqual({
foo: '[VueViewModel]',
});
});
});

describe('can limit object to depth', () => {
Expand DownExpand Up@@ -618,6 +629,24 @@ describe('normalize()', () => {
});
});

test('normalizes value on every iteration of decycle and takes care of things like `VueViewModel`', () => {
const obj = {
foo: {
_isVue: true,
},
baz: NaN,
qux: function qux(): void {
/* no-empty */
},
};
const result = normalize(obj);
expect(result).toEqual({
foo: '[VueViewModel]',
baz: '[NaN]',
qux: '[Function: qux]',
});
});

describe('skips normalizing objects marked with a non-enumerable property __sentry_skip_normalization__', () => {
test('by leaving non-serializable values intact', () => {
const someFun = () => undefined;
Expand Down
, '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
fix(utils): Prevent iterating over VueViewModel#8981

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

Lms24
merged 4 commits into

from

Sep 13, 2023
 Merged


fix(utils): Prevent iterating over VueViewModel
#8981
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
45f9f4c

fix(utils): Prevent iterating over VueViewModel


Duncanxyz Sep 8, 2023
c92da7a

fix(utils): Prevent iterating over VueViewModel fro Vue 3


Duncanxyz Sep 12, 2023
ada46f4

perf(utils): Optimize special handling arguments for Vue in consoleBr…


Duncanxyz Sep 12, 2023
bae8c65

fix(utils): Streamline testing for isVueViewModel


Duncanxyz Sep 12, 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


12 changes: 0 additions & 12 deletions
packages/browser/src/integrations/breadcrumbs.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -183,18 +183,6 @@ function _domBreadcrumb(dom: BreadcrumbsOptions['dom']): (handlerData: HandlerDa
 * Creates breadcrumbs from console API calls
 */
function _consoleBreadcrumb(handlerData: HandlerData & { args: unknown[]; level: string }): void {
 // This is a hack to fix a Vue3-specific bug that causes an infinite loop of
 // console warnings. This happens when a Vue template is rendered with
 // an undeclared variable, which we try to stringify, ultimately causing
 // Vue to issue another warning which repeats indefinitely.
 // see: https://github.com/getsentry/sentry-javascript/pull/6010
 // see: https://github.com/getsentry/sentry-javascript/issues/5916
 for (let i = 0; i < handlerData.args.length; i++) {
 if (handlerData.args[i] === 'ref=Ref<') {
 handlerData.args[i + 1] = 'viewRef';
 break;
 }
 }
 const breadcrumb = {
 category: 'console',
 data: {
Expand Down

17 changes: 17 additions & 0 deletions
packages/utils/src/is.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -179,3 +179,20 @@ export function isInstanceOf(wat: any, base: any): boolean {
 return false;
 }
}

interface VueViewModel {
 // Vue3
 __isVue?: boolean;
 // Vue2
 _isVue?: boolean;
}
/**
 * Checks whether given value's type is a Vue ViewModel.
 *
 * @param wat A value to be checked.
 * @returns A boolean representing the result.
 */
export function isVueViewModel(wat: unknown): boolean {
 // Not using Object.prototype.toString because in Vue 3 it would read the instance's Symbol(Symbol.toStringTag) property.
 return !!(typeof wat === 'object' && wat !== null && ((wat as VueViewModel).__isVue || (wat as VueViewModel)._isVue));
}

6 changes: 5 additions & 1 deletion
packages/utils/src/normalize.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
import type { Primitive } from '@sentry/types';

import { isNaN, isSyntheticEvent } from './is';
import { isNaN, isSyntheticEvent, isVueViewModel } from './is';
import type { MemoFunc } from './memo';
import { memoBuilder } from './memo';
import { convertToPlainObject } from './object';
Expand DownExpand Up@@ -214,6 +214,10 @@ function stringifyValue(
 return '[Document]';
 }

 if (isVueViewModel(value)) {
 return '[VueViewModel]';
 }

 // React's SyntheticEvent thingy
 if (isSyntheticEvent(value)) {
 return '[SyntheticEvent]';

Comment on lines

+220
 to 
223

@Lms24Lms24Sep 8, 2023

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

well I guess there's precedence for handling this stuff like this in a general package of ours 😅
@AbhiPrasadAbhiPrasadSep 8, 2023

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

the tricky thing is that some people end up just using @sentry/browser even when using a framework like React or Vue.
but I think we should re-examine this in v8 and see if we can somehow inject in framework specific processing.
Expand Down

13 changes: 11 additions & 2 deletions
packages/utils/src/string.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { isRegExp, isString } from './is';
import { isRegExp, isString, isVueViewModel } from './is';

export { escapeStringForRegex } from './vendor/escapeStringForRegex';

Expand DownExpand Up@@ -76,7 +76,16 @@ export function safeJoin(input: any[], delimiter?: string): string {
 for (let i = 0; i < input.length; i++) {
 const value = input[i];
 try {
 output.push(String(value));
 // This is a hack to fix a Vue3-specific bug that causes an infinite loop of
 // console warnings. This happens when a Vue template is rendered with
 // an undeclared variable, which we try to stringify, ultimately causing
 // Vue to issue another warning which repeats indefinitely.
 // see: https://github.com/getsentry/sentry-javascript/pull/8981
 if (isVueViewModel(value)) {
 output.push('[VueViewModel]');
 } else {
 output.push(String(value));
 }
 } catch (e) {
 output.push('[value cannot be serialized]');
 }
Expand Down

10 changes: 10 additions & 0 deletions
packages/utils/test/is.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,7 @@ import {
 isNaN,
 isPrimitive,
 isThenable,
 isVueViewModel,
} from '../src/is';
import { supportsDOMError, supportsDOMException, supportsErrorEvent } from '../src/supports';
import { resolvedSyncPromise } from '../src/syncpromise';
Expand DownExpand Up@@ -134,3 +135,12 @@ describe('isNaN()', () => {
 expect(isNaN(new Date())).toEqual(false);
 });
});

describe('isVueViewModel()', () => {
 test('should work as advertised', () => {
 expect(isVueViewModel({ _isVue: true })).toEqual(true);
 expect(isVueViewModel({ __isVue: true })).toEqual(true);
Comment thread
Duncanxyz marked this conversation as resolved.


 expect(isVueViewModel({ foo: true })).toEqual(false);
 });
});

29 changes: 29 additions & 0 deletions
packages/utils/test/normalize.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -476,6 +476,17 @@ describe('normalize()', () => {
 foo: '[SyntheticEvent]',
 });
 });

 test('known classes like `VueViewModel`', () => {
 const obj = {
 foo: {
 _isVue: true,
 },
 };
 expect(normalize(obj)).toEqual({
 foo: '[VueViewModel]',
 });
 });
 });

 describe('can limit object to depth', () => {
Expand DownExpand Up@@ -618,6 +629,24 @@ describe('normalize()', () => {
 });
 });

 test('normalizes value on every iteration of decycle and takes care of things like `VueViewModel`', () => {
 const obj = {
 foo: {
 _isVue: true,
 },
 baz: NaN,
 qux: function qux(): void {
 /* no-empty */
 },
 };
 const result = normalize(obj);
 expect(result).toEqual({
 foo: '[VueViewModel]',
 baz: '[NaN]',
 qux: '[Function: qux]',
 });
 });

 describe('skips normalizing objects marked with a non-enumerable property __sentry_skip_normalization__', () => {
 test('by leaving non-serializable values intact', () => {
 const someFun = () => undefined;
Expand Down

, '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
fix(utils): Prevent iterating over VueViewModel#8981

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

Lms24
merged 4 commits into

from

Sep 13, 2023
 Merged


fix(utils): Prevent iterating over VueViewModel
#8981
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
45f9f4c

fix(utils): Prevent iterating over VueViewModel


Duncanxyz Sep 8, 2023
c92da7a

fix(utils): Prevent iterating over VueViewModel fro Vue 3


Duncanxyz Sep 12, 2023
ada46f4

perf(utils): Optimize special handling arguments for Vue in consoleBr…


Duncanxyz Sep 12, 2023
bae8c65

fix(utils): Streamline testing for isVueViewModel


Duncanxyz Sep 12, 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


12 changes: 0 additions & 12 deletions
packages/browser/src/integrations/breadcrumbs.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -183,18 +183,6 @@ function _domBreadcrumb(dom: BreadcrumbsOptions['dom']): (handlerData: HandlerDa
 * Creates breadcrumbs from console API calls
 */
function _consoleBreadcrumb(handlerData: HandlerData & { args: unknown[]; level: string }): void {
 // This is a hack to fix a Vue3-specific bug that causes an infinite loop of
 // console warnings. This happens when a Vue template is rendered with
 // an undeclared variable, which we try to stringify, ultimately causing
 // Vue to issue another warning which repeats indefinitely.
 // see: https://github.com/getsentry/sentry-javascript/pull/6010
 // see: https://github.com/getsentry/sentry-javascript/issues/5916
 for (let i = 0; i < handlerData.args.length; i++) {
 if (handlerData.args[i] === 'ref=Ref<') {
 handlerData.args[i + 1] = 'viewRef';
 break;
 }
 }
 const breadcrumb = {
 category: 'console',
 data: {
Expand Down

17 changes: 17 additions & 0 deletions
packages/utils/src/is.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -179,3 +179,20 @@ export function isInstanceOf(wat: any, base: any): boolean {
 return false;
 }
}

interface VueViewModel {
 // Vue3
 __isVue?: boolean;
 // Vue2
 _isVue?: boolean;
}
/**
 * Checks whether given value's type is a Vue ViewModel.
 *
 * @param wat A value to be checked.
 * @returns A boolean representing the result.
 */
export function isVueViewModel(wat: unknown): boolean {
 // Not using Object.prototype.toString because in Vue 3 it would read the instance's Symbol(Symbol.toStringTag) property.
 return !!(typeof wat === 'object' && wat !== null && ((wat as VueViewModel).__isVue || (wat as VueViewModel)._isVue));
}

6 changes: 5 additions & 1 deletion
packages/utils/src/normalize.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
import type { Primitive } from '@sentry/types';

import { isNaN, isSyntheticEvent } from './is';
import { isNaN, isSyntheticEvent, isVueViewModel } from './is';
import type { MemoFunc } from './memo';
import { memoBuilder } from './memo';
import { convertToPlainObject } from './object';
Expand DownExpand Up@@ -214,6 +214,10 @@ function stringifyValue(
 return '[Document]';
 }

 if (isVueViewModel(value)) {
 return '[VueViewModel]';
 }

 // React's SyntheticEvent thingy
 if (isSyntheticEvent(value)) {
 return '[SyntheticEvent]';

Comment on lines

+220
 to 
223

@Lms24Lms24Sep 8, 2023

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

well I guess there's precedence for handling this stuff like this in a general package of ours 😅
@AbhiPrasadAbhiPrasadSep 8, 2023

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

the tricky thing is that some people end up just using @sentry/browser even when using a framework like React or Vue.
but I think we should re-examine this in v8 and see if we can somehow inject in framework specific processing.
Expand Down

13 changes: 11 additions & 2 deletions
packages/utils/src/string.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { isRegExp, isString } from './is';
import { isRegExp, isString, isVueViewModel } from './is';

export { escapeStringForRegex } from './vendor/escapeStringForRegex';

Expand DownExpand Up@@ -76,7 +76,16 @@ export function safeJoin(input: any[], delimiter?: string): string {
 for (let i = 0; i < input.length; i++) {
 const value = input[i];
 try {
 output.push(String(value));
 // This is a hack to fix a Vue3-specific bug that causes an infinite loop of
 // console warnings. This happens when a Vue template is rendered with
 // an undeclared variable, which we try to stringify, ultimately causing
 // Vue to issue another warning which repeats indefinitely.
 // see: https://github.com/getsentry/sentry-javascript/pull/8981
 if (isVueViewModel(value)) {
 output.push('[VueViewModel]');
 } else {
 output.push(String(value));
 }
 } catch (e) {
 output.push('[value cannot be serialized]');
 }
Expand Down

10 changes: 10 additions & 0 deletions
packages/utils/test/is.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,7 @@ import {
 isNaN,
 isPrimitive,
 isThenable,
 isVueViewModel,
} from '../src/is';
import { supportsDOMError, supportsDOMException, supportsErrorEvent } from '../src/supports';
import { resolvedSyncPromise } from '../src/syncpromise';
Expand DownExpand Up@@ -134,3 +135,12 @@ describe('isNaN()', () => {
 expect(isNaN(new Date())).toEqual(false);
 });
});

describe('isVueViewModel()', () => {
 test('should work as advertised', () => {
 expect(isVueViewModel({ _isVue: true })).toEqual(true);
 expect(isVueViewModel({ __isVue: true })).toEqual(true);
Comment thread
Duncanxyz marked this conversation as resolved.


 expect(isVueViewModel({ foo: true })).toEqual(false);
 });
});

29 changes: 29 additions & 0 deletions
packages/utils/test/normalize.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -476,6 +476,17 @@ describe('normalize()', () => {
 foo: '[SyntheticEvent]',
 });
 });

 test('known classes like `VueViewModel`', () => {
 const obj = {
 foo: {
 _isVue: true,
 },
 };
 expect(normalize(obj)).toEqual({
 foo: '[VueViewModel]',
 });
 });
 });

 describe('can limit object to depth', () => {
Expand DownExpand Up@@ -618,6 +629,24 @@ describe('normalize()', () => {
 });
 });

 test('normalizes value on every iteration of decycle and takes care of things like `VueViewModel`', () => {
 const obj = {
 foo: {
 _isVue: true,
 },
 baz: NaN,
 qux: function qux(): void {
 /* no-empty */
 },
 };
 const result = normalize(obj);
 expect(result).toEqual({
 foo: '[VueViewModel]',
 baz: '[NaN]',
 qux: '[Function: qux]',
 });
 });

 describe('skips normalizing objects marked with a non-enumerable property __sentry_skip_normalization__', () => {
 test('by leaving non-serializable values intact', () => {
 const someFun = () => undefined;
Expand Down

, '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
fix(utils): Prevent iterating over VueViewModel#8981

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

Lms24
merged 4 commits into

from

Sep 13, 2023
 Merged


fix(utils): Prevent iterating over VueViewModel
#8981
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
45f9f4c

fix(utils): Prevent iterating over VueViewModel


Duncanxyz Sep 8, 2023
c92da7a

fix(utils): Prevent iterating over VueViewModel fro Vue 3


Duncanxyz Sep 12, 2023
ada46f4

perf(utils): Optimize special handling arguments for Vue in consoleBr…


Duncanxyz Sep 12, 2023
bae8c65

fix(utils): Streamline testing for isVueViewModel


Duncanxyz Sep 12, 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


12 changes: 0 additions & 12 deletions
packages/browser/src/integrations/breadcrumbs.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -183,18 +183,6 @@ function _domBreadcrumb(dom: BreadcrumbsOptions['dom']): (handlerData: HandlerDa
 * Creates breadcrumbs from console API calls
 */
function _consoleBreadcrumb(handlerData: HandlerData & { args: unknown[]; level: string }): void {
 // This is a hack to fix a Vue3-specific bug that causes an infinite loop of
 // console warnings. This happens when a Vue template is rendered with
 // an undeclared variable, which we try to stringify, ultimately causing
 // Vue to issue another warning which repeats indefinitely.
 // see: https://github.com/getsentry/sentry-javascript/pull/6010
 // see: https://github.com/getsentry/sentry-javascript/issues/5916
 for (let i = 0; i < handlerData.args.length; i++) {
 if (handlerData.args[i] === 'ref=Ref<') {
 handlerData.args[i + 1] = 'viewRef';
 break;
 }
 }
 const breadcrumb = {
 category: 'console',
 data: {
Expand Down

17 changes: 17 additions & 0 deletions
packages/utils/src/is.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -179,3 +179,20 @@ export function isInstanceOf(wat: any, base: any): boolean {
 return false;
 }
}

interface VueViewModel {
 // Vue3
 __isVue?: boolean;
 // Vue2
 _isVue?: boolean;
}
/**
 * Checks whether given value's type is a Vue ViewModel.
 *
 * @param wat A value to be checked.
 * @returns A boolean representing the result.
 */
export function isVueViewModel(wat: unknown): boolean {
 // Not using Object.prototype.toString because in Vue 3 it would read the instance's Symbol(Symbol.toStringTag) property.
 return !!(typeof wat === 'object' && wat !== null && ((wat as VueViewModel).__isVue || (wat as VueViewModel)._isVue));
}

6 changes: 5 additions & 1 deletion
packages/utils/src/normalize.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
import type { Primitive } from '@sentry/types';

import { isNaN, isSyntheticEvent } from './is';
import { isNaN, isSyntheticEvent, isVueViewModel } from './is';
import type { MemoFunc } from './memo';
import { memoBuilder } from './memo';
import { convertToPlainObject } from './object';
Expand DownExpand Up@@ -214,6 +214,10 @@ function stringifyValue(
 return '[Document]';
 }

 if (isVueViewModel(value)) {
 return '[VueViewModel]';
 }

 // React's SyntheticEvent thingy
 if (isSyntheticEvent(value)) {
 return '[SyntheticEvent]';

Comment on lines

+220
 to 
223

@Lms24Lms24Sep 8, 2023

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

well I guess there's precedence for handling this stuff like this in a general package of ours 😅
@AbhiPrasadAbhiPrasadSep 8, 2023

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

the tricky thing is that some people end up just using @sentry/browser even when using a framework like React or Vue.
but I think we should re-examine this in v8 and see if we can somehow inject in framework specific processing.
Expand Down

13 changes: 11 additions & 2 deletions
packages/utils/src/string.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { isRegExp, isString } from './is';
import { isRegExp, isString, isVueViewModel } from './is';

export { escapeStringForRegex } from './vendor/escapeStringForRegex';

Expand DownExpand Up@@ -76,7 +76,16 @@ export function safeJoin(input: any[], delimiter?: string): string {
 for (let i = 0; i < input.length; i++) {
 const value = input[i];
 try {
 output.push(String(value));
 // This is a hack to fix a Vue3-specific bug that causes an infinite loop of
 // console warnings. This happens when a Vue template is rendered with
 // an undeclared variable, which we try to stringify, ultimately causing
 // Vue to issue another warning which repeats indefinitely.
 // see: https://github.com/getsentry/sentry-javascript/pull/8981
 if (isVueViewModel(value)) {
 output.push('[VueViewModel]');
 } else {
 output.push(String(value));
 }
 } catch (e) {
 output.push('[value cannot be serialized]');
 }
Expand Down

10 changes: 10 additions & 0 deletions
packages/utils/test/is.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,7 @@ import {
 isNaN,
 isPrimitive,
 isThenable,
 isVueViewModel,
} from '../src/is';
import { supportsDOMError, supportsDOMException, supportsErrorEvent } from '../src/supports';
import { resolvedSyncPromise } from '../src/syncpromise';
Expand DownExpand Up@@ -134,3 +135,12 @@ describe('isNaN()', () => {
 expect(isNaN(new Date())).toEqual(false);
 });
});

describe('isVueViewModel()', () => {
 test('should work as advertised', () => {
 expect(isVueViewModel({ _isVue: true })).toEqual(true);
 expect(isVueViewModel({ __isVue: true })).toEqual(true);
Comment thread
Duncanxyz marked this conversation as resolved.


 expect(isVueViewModel({ foo: true })).toEqual(false);
 });
});

29 changes: 29 additions & 0 deletions
packages/utils/test/normalize.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -476,6 +476,17 @@ describe('normalize()', () => {
 foo: '[SyntheticEvent]',
 });
 });

 test('known classes like `VueViewModel`', () => {
 const obj = {
 foo: {
 _isVue: true,
 },
 };
 expect(normalize(obj)).toEqual({
 foo: '[VueViewModel]',
 });
 });
 });

 describe('can limit object to depth', () => {
Expand DownExpand Up@@ -618,6 +629,24 @@ describe('normalize()', () => {
 });
 });

 test('normalizes value on every iteration of decycle and takes care of things like `VueViewModel`', () => {
 const obj = {
 foo: {
 _isVue: true,
 },
 baz: NaN,
 qux: function qux(): void {
 /* no-empty */
 },
 };
 const result = normalize(obj);
 expect(result).toEqual({
 foo: '[VueViewModel]',
 baz: '[NaN]',
 qux: '[Function: qux]',
 });
 });

 describe('skips normalizing objects marked with a non-enumerable property __sentry_skip_normalization__', () => {
 test('by leaving non-serializable values intact', () => {
 const someFun = () => undefined;
Expand Down

, '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
fix(utils): Prevent iterating over VueViewModel#8981

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

Lms24
merged 4 commits into

from

Sep 13, 2023
 Merged


fix(utils): Prevent iterating over VueViewModel
#8981
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
45f9f4c

fix(utils): Prevent iterating over VueViewModel


Duncanxyz Sep 8, 2023
c92da7a

fix(utils): Prevent iterating over VueViewModel fro Vue 3


Duncanxyz Sep 12, 2023
ada46f4

perf(utils): Optimize special handling arguments for Vue in consoleBr…


Duncanxyz Sep 12, 2023
bae8c65

fix(utils): Streamline testing for isVueViewModel


Duncanxyz Sep 12, 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


12 changes: 0 additions & 12 deletions
packages/browser/src/integrations/breadcrumbs.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -183,18 +183,6 @@ function _domBreadcrumb(dom: BreadcrumbsOptions['dom']): (handlerData: HandlerDa
 * Creates breadcrumbs from console API calls
 */
function _consoleBreadcrumb(handlerData: HandlerData & { args: unknown[]; level: string }): void {
 // This is a hack to fix a Vue3-specific bug that causes an infinite loop of
 // console warnings. This happens when a Vue template is rendered with
 // an undeclared variable, which we try to stringify, ultimately causing
 // Vue to issue another warning which repeats indefinitely.
 // see: https://github.com/getsentry/sentry-javascript/pull/6010
 // see: https://github.com/getsentry/sentry-javascript/issues/5916
 for (let i = 0; i < handlerData.args.length; i++) {
 if (handlerData.args[i] === 'ref=Ref<') {
 handlerData.args[i + 1] = 'viewRef';
 break;
 }
 }
 const breadcrumb = {
 category: 'console',
 data: {
Expand Down

17 changes: 17 additions & 0 deletions
packages/utils/src/is.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -179,3 +179,20 @@ export function isInstanceOf(wat: any, base: any): boolean {
 return false;
 }
}

interface VueViewModel {
 // Vue3
 __isVue?: boolean;
 // Vue2
 _isVue?: boolean;
}
/**
 * Checks whether given value's type is a Vue ViewModel.
 *
 * @param wat A value to be checked.
 * @returns A boolean representing the result.
 */
export function isVueViewModel(wat: unknown): boolean {
 // Not using Object.prototype.toString because in Vue 3 it would read the instance's Symbol(Symbol.toStringTag) property.
 return !!(typeof wat === 'object' && wat !== null && ((wat as VueViewModel).__isVue || (wat as VueViewModel)._isVue));
}

6 changes: 5 additions & 1 deletion
packages/utils/src/normalize.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
import type { Primitive } from '@sentry/types';

import { isNaN, isSyntheticEvent } from './is';
import { isNaN, isSyntheticEvent, isVueViewModel } from './is';
import type { MemoFunc } from './memo';
import { memoBuilder } from './memo';
import { convertToPlainObject } from './object';
Expand DownExpand Up@@ -214,6 +214,10 @@ function stringifyValue(
 return '[Document]';
 }

 if (isVueViewModel(value)) {
 return '[VueViewModel]';
 }

 // React's SyntheticEvent thingy
 if (isSyntheticEvent(value)) {
 return '[SyntheticEvent]';

Comment on lines

+220
 to 
223

@Lms24Lms24Sep 8, 2023

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

well I guess there's precedence for handling this stuff like this in a general package of ours 😅
@AbhiPrasadAbhiPrasadSep 8, 2023

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

the tricky thing is that some people end up just using @sentry/browser even when using a framework like React or Vue.
but I think we should re-examine this in v8 and see if we can somehow inject in framework specific processing.
Expand Down

13 changes: 11 additions & 2 deletions
packages/utils/src/string.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { isRegExp, isString } from './is';
import { isRegExp, isString, isVueViewModel } from './is';

export { escapeStringForRegex } from './vendor/escapeStringForRegex';

Expand DownExpand Up@@ -76,7 +76,16 @@ export function safeJoin(input: any[], delimiter?: string): string {
 for (let i = 0; i < input.length; i++) {
 const value = input[i];
 try {
 output.push(String(value));
 // This is a hack to fix a Vue3-specific bug that causes an infinite loop of
 // console warnings. This happens when a Vue template is rendered with
 // an undeclared variable, which we try to stringify, ultimately causing
 // Vue to issue another warning which repeats indefinitely.
 // see: https://github.com/getsentry/sentry-javascript/pull/8981
 if (isVueViewModel(value)) {
 output.push('[VueViewModel]');
 } else {
 output.push(String(value));
 }
 } catch (e) {
 output.push('[value cannot be serialized]');
 }
Expand Down

10 changes: 10 additions & 0 deletions
packages/utils/test/is.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,7 @@ import {
 isNaN,
 isPrimitive,
 isThenable,
 isVueViewModel,
} from '../src/is';
import { supportsDOMError, supportsDOMException, supportsErrorEvent } from '../src/supports';
import { resolvedSyncPromise } from '../src/syncpromise';
Expand DownExpand Up@@ -134,3 +135,12 @@ describe('isNaN()', () => {
 expect(isNaN(new Date())).toEqual(false);
 });
});

describe('isVueViewModel()', () => {
 test('should work as advertised', () => {
 expect(isVueViewModel({ _isVue: true })).toEqual(true);
 expect(isVueViewModel({ __isVue: true })).toEqual(true);
Comment thread
Duncanxyz marked this conversation as resolved.


 expect(isVueViewModel({ foo: true })).toEqual(false);
 });
});

29 changes: 29 additions & 0 deletions
packages/utils/test/normalize.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -476,6 +476,17 @@ describe('normalize()', () => {
 foo: '[SyntheticEvent]',
 });
 });

 test('known classes like `VueViewModel`', () => {
 const obj = {
 foo: {
 _isVue: true,
 },
 };
 expect(normalize(obj)).toEqual({
 foo: '[VueViewModel]',
 });
 });
 });

 describe('can limit object to depth', () => {
Expand DownExpand Up@@ -618,6 +629,24 @@ describe('normalize()', () => {
 });
 });

 test('normalizes value on every iteration of decycle and takes care of things like `VueViewModel`', () => {
 const obj = {
 foo: {
 _isVue: true,
 },
 baz: NaN,
 qux: function qux(): void {
 /* no-empty */
 },
 };
 const result = normalize(obj);
 expect(result).toEqual({
 foo: '[VueViewModel]',
 baz: '[NaN]',
 qux: '[Function: qux]',
 });
 });

 describe('skips normalizing objects marked with a non-enumerable property __sentry_skip_normalization__', () => {
 test('by leaving non-serializable values intact', () => {
 const someFun = () => undefined;
Expand Down

, '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
fix(utils): Prevent iterating over VueViewModel#8981

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

Lms24
merged 4 commits into

from

Sep 13, 2023
 Merged


fix(utils): Prevent iterating over VueViewModel
#8981
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
45f9f4c

fix(utils): Prevent iterating over VueViewModel


Duncanxyz Sep 8, 2023
c92da7a

fix(utils): Prevent iterating over VueViewModel fro Vue 3


Duncanxyz Sep 12, 2023
ada46f4

perf(utils): Optimize special handling arguments for Vue in consoleBr…


Duncanxyz Sep 12, 2023
bae8c65

fix(utils): Streamline testing for isVueViewModel


Duncanxyz Sep 12, 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


12 changes: 0 additions & 12 deletions
packages/browser/src/integrations/breadcrumbs.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -183,18 +183,6 @@ function _domBreadcrumb(dom: BreadcrumbsOptions['dom']): (handlerData: HandlerDa
 * Creates breadcrumbs from console API calls
 */
function _consoleBreadcrumb(handlerData: HandlerData & { args: unknown[]; level: string }): void {
 // This is a hack to fix a Vue3-specific bug that causes an infinite loop of
 // console warnings. This happens when a Vue template is rendered with
 // an undeclared variable, which we try to stringify, ultimately causing
 // Vue to issue another warning which repeats indefinitely.
 // see: https://github.com/getsentry/sentry-javascript/pull/6010
 // see: https://github.com/getsentry/sentry-javascript/issues/5916
 for (let i = 0; i < handlerData.args.length; i++) {
 if (handlerData.args[i] === 'ref=Ref<') {
 handlerData.args[i + 1] = 'viewRef';
 break;
 }
 }
 const breadcrumb = {
 category: 'console',
 data: {
Expand Down

17 changes: 17 additions & 0 deletions
packages/utils/src/is.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -179,3 +179,20 @@ export function isInstanceOf(wat: any, base: any): boolean {
 return false;
 }
}

interface VueViewModel {
 // Vue3
 __isVue?: boolean;
 // Vue2
 _isVue?: boolean;
}
/**
 * Checks whether given value's type is a Vue ViewModel.
 *
 * @param wat A value to be checked.
 * @returns A boolean representing the result.
 */
export function isVueViewModel(wat: unknown): boolean {
 // Not using Object.prototype.toString because in Vue 3 it would read the instance's Symbol(Symbol.toStringTag) property.
 return !!(typeof wat === 'object' && wat !== null && ((wat as VueViewModel).__isVue || (wat as VueViewModel)._isVue));
}

6 changes: 5 additions & 1 deletion
packages/utils/src/normalize.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
import type { Primitive } from '@sentry/types';

import { isNaN, isSyntheticEvent } from './is';
import { isNaN, isSyntheticEvent, isVueViewModel } from './is';
import type { MemoFunc } from './memo';
import { memoBuilder } from './memo';
import { convertToPlainObject } from './object';
Expand DownExpand Up@@ -214,6 +214,10 @@ function stringifyValue(
 return '[Document]';
 }

 if (isVueViewModel(value)) {
 return '[VueViewModel]';
 }

 // React's SyntheticEvent thingy
 if (isSyntheticEvent(value)) {
 return '[SyntheticEvent]';

Comment on lines

+220
 to 
223

@Lms24Lms24Sep 8, 2023

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

well I guess there's precedence for handling this stuff like this in a general package of ours 😅
@AbhiPrasadAbhiPrasadSep 8, 2023

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

the tricky thing is that some people end up just using @sentry/browser even when using a framework like React or Vue.
but I think we should re-examine this in v8 and see if we can somehow inject in framework specific processing.
Expand Down

13 changes: 11 additions & 2 deletions
packages/utils/src/string.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { isRegExp, isString } from './is';
import { isRegExp, isString, isVueViewModel } from './is';

export { escapeStringForRegex } from './vendor/escapeStringForRegex';

Expand DownExpand Up@@ -76,7 +76,16 @@ export function safeJoin(input: any[], delimiter?: string): string {
 for (let i = 0; i < input.length; i++) {
 const value = input[i];
 try {
 output.push(String(value));
 // This is a hack to fix a Vue3-specific bug that causes an infinite loop of
 // console warnings. This happens when a Vue template is rendered with
 // an undeclared variable, which we try to stringify, ultimately causing
 // Vue to issue another warning which repeats indefinitely.
 // see: https://github.com/getsentry/sentry-javascript/pull/8981
 if (isVueViewModel(value)) {
 output.push('[VueViewModel]');
 } else {
 output.push(String(value));
 }
 } catch (e) {
 output.push('[value cannot be serialized]');
 }
Expand Down

10 changes: 10 additions & 0 deletions
packages/utils/test/is.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,7 @@ import {
 isNaN,
 isPrimitive,
 isThenable,
 isVueViewModel,
} from '../src/is';
import { supportsDOMError, supportsDOMException, supportsErrorEvent } from '../src/supports';
import { resolvedSyncPromise } from '../src/syncpromise';
Expand DownExpand Up@@ -134,3 +135,12 @@ describe('isNaN()', () => {
 expect(isNaN(new Date())).toEqual(false);
 });
});

describe('isVueViewModel()', () => {
 test('should work as advertised', () => {
 expect(isVueViewModel({ _isVue: true })).toEqual(true);
 expect(isVueViewModel({ __isVue: true })).toEqual(true);
Comment thread
Duncanxyz marked this conversation as resolved.


 expect(isVueViewModel({ foo: true })).toEqual(false);
 });
});

29 changes: 29 additions & 0 deletions
packages/utils/test/normalize.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -476,6 +476,17 @@ describe('normalize()', () => {
 foo: '[SyntheticEvent]',
 });
 });

 test('known classes like `VueViewModel`', () => {
 const obj = {
 foo: {
 _isVue: true,
 },
 };
 expect(normalize(obj)).toEqual({
 foo: '[VueViewModel]',
 });
 });
 });

 describe('can limit object to depth', () => {
Expand DownExpand Up@@ -618,6 +629,24 @@ describe('normalize()', () => {
 });
 });

 test('normalizes value on every iteration of decycle and takes care of things like `VueViewModel`', () => {
 const obj = {
 foo: {
 _isVue: true,
 },
 baz: NaN,
 qux: function qux(): void {
 /* no-empty */
 },
 };
 const result = normalize(obj);
 expect(result).toEqual({
 foo: '[VueViewModel]',
 baz: '[NaN]',
 qux: '[Function: qux]',
 });
 });

 describe('skips normalizing objects marked with a non-enumerable property __sentry_skip_normalization__', () => {
 test('by leaving non-serializable values intact', () => {
 const someFun = () => undefined;
Expand Down

, '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
fix(utils): Prevent iterating over VueViewModel#8981

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

Lms24
merged 4 commits into

from

Sep 13, 2023
 Merged


fix(utils): Prevent iterating over VueViewModel
#8981
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
45f9f4c

fix(utils): Prevent iterating over VueViewModel


Duncanxyz Sep 8, 2023
c92da7a

fix(utils): Prevent iterating over VueViewModel fro Vue 3


Duncanxyz Sep 12, 2023
ada46f4

perf(utils): Optimize special handling arguments for Vue in consoleBr…


Duncanxyz Sep 12, 2023
bae8c65

fix(utils): Streamline testing for isVueViewModel


Duncanxyz Sep 12, 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


12 changes: 0 additions & 12 deletions
packages/browser/src/integrations/breadcrumbs.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -183,18 +183,6 @@ function _domBreadcrumb(dom: BreadcrumbsOptions['dom']): (handlerData: HandlerDa
 * Creates breadcrumbs from console API calls
 */
function _consoleBreadcrumb(handlerData: HandlerData & { args: unknown[]; level: string }): void {
 // This is a hack to fix a Vue3-specific bug that causes an infinite loop of
 // console warnings. This happens when a Vue template is rendered with
 // an undeclared variable, which we try to stringify, ultimately causing
 // Vue to issue another warning which repeats indefinitely.
 // see: https://github.com/getsentry/sentry-javascript/pull/6010
 // see: https://github.com/getsentry/sentry-javascript/issues/5916
 for (let i = 0; i < handlerData.args.length; i++) {
 if (handlerData.args[i] === 'ref=Ref<') {
 handlerData.args[i + 1] = 'viewRef';
 break;
 }
 }
 const breadcrumb = {
 category: 'console',
 data: {
Expand Down

17 changes: 17 additions & 0 deletions
packages/utils/src/is.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -179,3 +179,20 @@ export function isInstanceOf(wat: any, base: any): boolean {
 return false;
 }
}

interface VueViewModel {
 // Vue3
 __isVue?: boolean;
 // Vue2
 _isVue?: boolean;
}
/**
 * Checks whether given value's type is a Vue ViewModel.
 *
 * @param wat A value to be checked.
 * @returns A boolean representing the result.
 */
export function isVueViewModel(wat: unknown): boolean {
 // Not using Object.prototype.toString because in Vue 3 it would read the instance's Symbol(Symbol.toStringTag) property.
 return !!(typeof wat === 'object' && wat !== null && ((wat as VueViewModel).__isVue || (wat as VueViewModel)._isVue));
}

6 changes: 5 additions & 1 deletion
packages/utils/src/normalize.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
import type { Primitive } from '@sentry/types';

import { isNaN, isSyntheticEvent } from './is';
import { isNaN, isSyntheticEvent, isVueViewModel } from './is';
import type { MemoFunc } from './memo';
import { memoBuilder } from './memo';
import { convertToPlainObject } from './object';
Expand DownExpand Up@@ -214,6 +214,10 @@ function stringifyValue(
 return '[Document]';
 }

 if (isVueViewModel(value)) {
 return '[VueViewModel]';
 }

 // React's SyntheticEvent thingy
 if (isSyntheticEvent(value)) {
 return '[SyntheticEvent]';

Comment on lines

+220
 to 
223

@Lms24Lms24Sep 8, 2023

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

well I guess there's precedence for handling this stuff like this in a general package of ours 😅
@AbhiPrasadAbhiPrasadSep 8, 2023

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

the tricky thing is that some people end up just using @sentry/browser even when using a framework like React or Vue.
but I think we should re-examine this in v8 and see if we can somehow inject in framework specific processing.
Expand Down

13 changes: 11 additions & 2 deletions
packages/utils/src/string.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { isRegExp, isString } from './is';
import { isRegExp, isString, isVueViewModel } from './is';

export { escapeStringForRegex } from './vendor/escapeStringForRegex';

Expand DownExpand Up@@ -76,7 +76,16 @@ export function safeJoin(input: any[], delimiter?: string): string {
 for (let i = 0; i < input.length; i++) {
 const value = input[i];
 try {
 output.push(String(value));
 // This is a hack to fix a Vue3-specific bug that causes an infinite loop of
 // console warnings. This happens when a Vue template is rendered with
 // an undeclared variable, which we try to stringify, ultimately causing
 // Vue to issue another warning which repeats indefinitely.
 // see: https://github.com/getsentry/sentry-javascript/pull/8981
 if (isVueViewModel(value)) {
 output.push('[VueViewModel]');
 } else {
 output.push(String(value));
 }
 } catch (e) {
 output.push('[value cannot be serialized]');
 }
Expand Down

10 changes: 10 additions & 0 deletions
packages/utils/test/is.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,7 @@ import {
 isNaN,
 isPrimitive,
 isThenable,
 isVueViewModel,
} from '../src/is';
import { supportsDOMError, supportsDOMException, supportsErrorEvent } from '../src/supports';
import { resolvedSyncPromise } from '../src/syncpromise';
Expand DownExpand Up@@ -134,3 +135,12 @@ describe('isNaN()', () => {
 expect(isNaN(new Date())).toEqual(false);
 });
});

describe('isVueViewModel()', () => {
 test('should work as advertised', () => {
 expect(isVueViewModel({ _isVue: true })).toEqual(true);
 expect(isVueViewModel({ __isVue: true })).toEqual(true);
Comment thread
Duncanxyz marked this conversation as resolved.


 expect(isVueViewModel({ foo: true })).toEqual(false);
 });
});

29 changes: 29 additions & 0 deletions
packages/utils/test/normalize.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -476,6 +476,17 @@ describe('normalize()', () => {
 foo: '[SyntheticEvent]',
 });
 });

 test('known classes like `VueViewModel`', () => {
 const obj = {
 foo: {
 _isVue: true,
 },
 };
 expect(normalize(obj)).toEqual({
 foo: '[VueViewModel]',
 });
 });
 });

 describe('can limit object to depth', () => {
Expand DownExpand Up@@ -618,6 +629,24 @@ describe('normalize()', () => {
 });
 });

 test('normalizes value on every iteration of decycle and takes care of things like `VueViewModel`', () => {
 const obj = {
 foo: {
 _isVue: true,
 },
 baz: NaN,
 qux: function qux(): void {
 /* no-empty */
 },
 };
 const result = normalize(obj);
 expect(result).toEqual({
 foo: '[VueViewModel]',
 baz: '[NaN]',
 qux: '[Function: qux]',
 });
 });

 describe('skips normalizing objects marked with a non-enumerable property __sentry_skip_normalization__', () => {
 test('by leaving non-serializable values intact', () => {
 const someFun = () => undefined;
Expand Down

, '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
fix(utils): Prevent iterating over VueViewModel#8981

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

Lms24
merged 4 commits into

from

Sep 13, 2023
 Merged


fix(utils): Prevent iterating over VueViewModel
#8981
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
45f9f4c

fix(utils): Prevent iterating over VueViewModel


Duncanxyz Sep 8, 2023
c92da7a

fix(utils): Prevent iterating over VueViewModel fro Vue 3


Duncanxyz Sep 12, 2023
ada46f4

perf(utils): Optimize special handling arguments for Vue in consoleBr…


Duncanxyz Sep 12, 2023
bae8c65

fix(utils): Streamline testing for isVueViewModel


Duncanxyz Sep 12, 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


12 changes: 0 additions & 12 deletions
packages/browser/src/integrations/breadcrumbs.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -183,18 +183,6 @@ function _domBreadcrumb(dom: BreadcrumbsOptions['dom']): (handlerData: HandlerDa
 * Creates breadcrumbs from console API calls
 */
function _consoleBreadcrumb(handlerData: HandlerData & { args: unknown[]; level: string }): void {
 // This is a hack to fix a Vue3-specific bug that causes an infinite loop of
 // console warnings. This happens when a Vue template is rendered with
 // an undeclared variable, which we try to stringify, ultimately causing
 // Vue to issue another warning which repeats indefinitely.
 // see: https://github.com/getsentry/sentry-javascript/pull/6010
 // see: https://github.com/getsentry/sentry-javascript/issues/5916
 for (let i = 0; i < handlerData.args.length; i++) {
 if (handlerData.args[i] === 'ref=Ref<') {
 handlerData.args[i + 1] = 'viewRef';
 break;
 }
 }
 const breadcrumb = {
 category: 'console',
 data: {
Expand Down

17 changes: 17 additions & 0 deletions
packages/utils/src/is.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -179,3 +179,20 @@ export function isInstanceOf(wat: any, base: any): boolean {
 return false;
 }
}

interface VueViewModel {
 // Vue3
 __isVue?: boolean;
 // Vue2
 _isVue?: boolean;
}
/**
 * Checks whether given value's type is a Vue ViewModel.
 *
 * @param wat A value to be checked.
 * @returns A boolean representing the result.
 */
export function isVueViewModel(wat: unknown): boolean {
 // Not using Object.prototype.toString because in Vue 3 it would read the instance's Symbol(Symbol.toStringTag) property.
 return !!(typeof wat === 'object' && wat !== null && ((wat as VueViewModel).__isVue || (wat as VueViewModel)._isVue));
}

6 changes: 5 additions & 1 deletion
packages/utils/src/normalize.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
import type { Primitive } from '@sentry/types';

import { isNaN, isSyntheticEvent } from './is';
import { isNaN, isSyntheticEvent, isVueViewModel } from './is';
import type { MemoFunc } from './memo';
import { memoBuilder } from './memo';
import { convertToPlainObject } from './object';
Expand DownExpand Up@@ -214,6 +214,10 @@ function stringifyValue(
 return '[Document]';
 }

 if (isVueViewModel(value)) {
 return '[VueViewModel]';
 }

 // React's SyntheticEvent thingy
 if (isSyntheticEvent(value)) {
 return '[SyntheticEvent]';

Comment on lines

+220
 to 
223

@Lms24Lms24Sep 8, 2023

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

well I guess there's precedence for handling this stuff like this in a general package of ours 😅
@AbhiPrasadAbhiPrasadSep 8, 2023

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

the tricky thing is that some people end up just using @sentry/browser even when using a framework like React or Vue.
but I think we should re-examine this in v8 and see if we can somehow inject in framework specific processing.
Expand Down

13 changes: 11 additions & 2 deletions
packages/utils/src/string.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { isRegExp, isString } from './is';
import { isRegExp, isString, isVueViewModel } from './is';

export { escapeStringForRegex } from './vendor/escapeStringForRegex';

Expand DownExpand Up@@ -76,7 +76,16 @@ export function safeJoin(input: any[], delimiter?: string): string {
 for (let i = 0; i < input.length; i++) {
 const value = input[i];
 try {
 output.push(String(value));
 // This is a hack to fix a Vue3-specific bug that causes an infinite loop of
 // console warnings. This happens when a Vue template is rendered with
 // an undeclared variable, which we try to stringify, ultimately causing
 // Vue to issue another warning which repeats indefinitely.
 // see: https://github.com/getsentry/sentry-javascript/pull/8981
 if (isVueViewModel(value)) {
 output.push('[VueViewModel]');
 } else {
 output.push(String(value));
 }
 } catch (e) {
 output.push('[value cannot be serialized]');
 }
Expand Down

10 changes: 10 additions & 0 deletions
packages/utils/test/is.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,7 @@ import {
 isNaN,
 isPrimitive,
 isThenable,
 isVueViewModel,
} from '../src/is';
import { supportsDOMError, supportsDOMException, supportsErrorEvent } from '../src/supports';
import { resolvedSyncPromise } from '../src/syncpromise';
Expand DownExpand Up@@ -134,3 +135,12 @@ describe('isNaN()', () => {
 expect(isNaN(new Date())).toEqual(false);
 });
});

describe('isVueViewModel()', () => {
 test('should work as advertised', () => {
 expect(isVueViewModel({ _isVue: true })).toEqual(true);
 expect(isVueViewModel({ __isVue: true })).toEqual(true);
Comment thread
Duncanxyz marked this conversation as resolved.


 expect(isVueViewModel({ foo: true })).toEqual(false);
 });
});

29 changes: 29 additions & 0 deletions
packages/utils/test/normalize.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -476,6 +476,17 @@ describe('normalize()', () => {
 foo: '[SyntheticEvent]',
 });
 });

 test('known classes like `VueViewModel`', () => {
 const obj = {
 foo: {
 _isVue: true,
 },
 };
 expect(normalize(obj)).toEqual({
 foo: '[VueViewModel]',
 });
 });
 });

 describe('can limit object to depth', () => {
Expand DownExpand Up@@ -618,6 +629,24 @@ describe('normalize()', () => {
 });
 });

 test('normalizes value on every iteration of decycle and takes care of things like `VueViewModel`', () => {
 const obj = {
 foo: {
 _isVue: true,
 },
 baz: NaN,
 qux: function qux(): void {
 /* no-empty */
 },
 };
 const result = normalize(obj);
 expect(result).toEqual({
 foo: '[VueViewModel]',
 baz: '[NaN]',
 qux: '[Function: qux]',
 });
 });

 describe('skips normalizing objects marked with a non-enumerable property __sentry_skip_normalization__', () => {
 test('by leaving non-serializable values intact', () => {
 const someFun = () => undefined;
Expand Down