Skip to content
Source
Sign inSign up
TanStack/devtools
Open History to see the last commit

utils.test.ts

184 lines6.1 KB

1import { describe, expect, test } from 'vitest'
2import { parseOpenSourceParam, stripEnhancedLogPrefix } from './utils'
3​
4describe('parseOpenSourceParam', () => {
5 test('parses simple file:line:column format', () => {
6 const result = parseOpenSourceParam('src/file.tsx:26:13')
7 expect(result).toEqual({ file: 'src/file.tsx', line: '26', column: '13' })
8 })
9​
10 test('parses file path with multiple slashes', () => {
11 const result = parseOpenSourceParam('src/components/Header.tsx:100:5')
12 expect(result).toEqual({
13 file: 'src/components/Header.tsx',
14 line: '100',
15 column: '5',
16 })
17 })
18​
19 test('parses file path with colons in filename (Windows-style)', () => {
20 const result = parseOpenSourceParam('C:/Users/test/file.tsx:10:20')
21 expect(result).toEqual({
22 file: 'C:/Users/test/file.tsx',
23 line: '10',
24 column: '20',
25 })
26 })
27​
28 test('returns null for invalid format without line/column', () => {
29 const result = parseOpenSourceParam('src/file.tsx')
30 expect(result).toBeNull()
31 })
32​
33 test('returns null for invalid format with only one number', () => {
34 const result = parseOpenSourceParam('src/file.tsx:26')
35 expect(result).toBeNull()
36 })
37})
38​
39describe('stripEnhancedLogPrefix', () => {
40 test('returns empty array for empty input', () => {
41 const result = stripEnhancedLogPrefix([])
42 expect(result).toEqual([])
43 })
44​
45 test('returns args unchanged when no enhanced log URL is present', () => {
46 const args = ['hello', 'world', 123]
47 const result = stripEnhancedLogPrefix(args)
48 expect(result).toEqual(args)
49 })
50​
51 test('extracts source location and user args from enhanced log format', () => {
52 // Simulated enhanced log format:
53 // ['%cLOG%c %cGo to Source: http://localhost:3000/__tsd/open-source?source=%2Fsrc%2Ffile.tsx%3A26%3A13%c \n β†’ ', 'style1', 'style2', 'style3', 'style4', 'user message']
54 const args = [
55 '%cLOG%c %cGo to Source: http://localhost:3000/__tsd/open-source?source=%2Fsrc%2Ffile.tsx%3A26%3A13%c \n β†’ ',
56 'color: blue',
57 'color: reset',
58 'color: green',
59 'color: reset',
60 'user message',
61 ]
62 const result = stripEnhancedLogPrefix(args)
63 expect(result).toEqual(['src/file.tsx:26:13', 'user message'])
64 })
65​
66 test('handles multiple user args after enhanced log prefix', () => {
67 const args = [
68 '%cLOG%c %cGo to Source: http://localhost:3000/__tsd/open-source?source=%2Fsrc%2Fcomponents%2FHeader.tsx%3A100%3A5%c \n β†’ ',
69 'style1',
70 'style2',
71 'style3',
72 'style4',
73 'message 1',
74 { key: 'value' },
75 42,
76 ]
77 const result = stripEnhancedLogPrefix(args)
78 expect(result).toEqual([
79 'src/components/Header.tsx:100:5',
80 'message 1',
81 { key: 'value' },
82 42,
83 ])
84 })
85​
86 test('handles source location with leading slash by removing it', () => {
87 const args = [
88 '%cINFO%c %cGo to Source: http://localhost:3000/__tsd/open-source?source=%2Fapp%2Fpage.tsx%3A10%3A1%c \n β†’ ',
89 's1',
90 's2',
91 's3',
92 's4',
93 'info log',
94 ]
95 const result = stripEnhancedLogPrefix(args)
96 // Leading slash is removed
97 expect(result).toEqual(['app/page.tsx:10:1', 'info log'])
98 })
99​
100 test('applies custom formatter to source location', () => {
101 const args = [
102 '%cWARN%c %cGo to Source: http://localhost:3000/__tsd/open-source?source=%2Fsrc%2Findex.ts%3A5%3A2%c \n β†’ ',
103 's1',
104 's2',
105 's3',
106 's4',
107 'warning message',
108 ]
109 const customFormatter = (loc: string) => `[${loc}]`
110 const result = stripEnhancedLogPrefix(args, customFormatter)
111 expect(result).toEqual(['[src/index.ts:5:2]', 'warning message'])
112 })
113​
114 test('handles ANSI prefix format (second variant)', () => {
115 // Format: ['\x1b[...]%s\x1b[...]', '%cLOG%c %cGo to Source: ...%c \n β†’ ', 'style...', ..., 'message']
116 const args = [
117 '\x1b[90m%s\x1b[0m',
118 '%cDEBUG%c %cGo to Source: http://localhost:3000/__tsd/open-source?source=%2Fsrc%2Fdebug.ts%3A1%3A1%c \n β†’ ',
119 's1',
120 's2',
121 's3',
122 's4',
123 'debug output',
124 ]
125 const result = stripEnhancedLogPrefix(args)
126 // The source URL is in index 1, so source location should be extracted from there
127 expect(result).toEqual(['src/debug.ts:1:1', 'debug output'])
128 })
129​
130 test('returns original args when source URL decoding fails', () => {
131 const args = [
132 '%cLOG%c %cGo to Source: http://localhost:3000/__tsd/open-source?source=%INVALID%c \n β†’ ',
133 's1',
134 's2',
135 's3',
136 's4',
137 'message',
138 ]
139 // Should gracefully handle decoding error and return user args without source
140 const result = stripEnhancedLogPrefix(args)
141 // Since decoding fails, sourceLocation will be empty, so result should just have user args
142 expect(result).toEqual(['message'])
143 })
144​
145 test('handles enhanced log with no user args after style markers', () => {
146 const args = [
147 'Go to Source: http://localhost:3000/__tsd/open-source?source=%2Fsrc%2Ftest.ts%3A1%3A1%c',
148 'style-arg', // This is consumed as a style arg due to %c marker
149 ]
150 const result = stripEnhancedLogPrefix(args)
151 // One %c marker means one style arg follows the source arg, leaving no user args
152 expect(result).toEqual(['src/test.ts:1:1'])
153 })
154​
155 test('handles enhanced log at non-zero index in args array', () => {
156 const args = [
157 'some prefix',
158 '%cERROR%c %cGo to Source: http://localhost:3000/__tsd/open-source?source=%2Fsrc%2Ferror.ts%3A50%3A10%c \n β†’ ',
159 's1',
160 's2',
161 's3',
162 's4',
163 'error details',
164 ]
165 const result = stripEnhancedLogPrefix(args)
166 expect(result).toEqual(['src/error.ts:50:10', 'error details'])
167 })
168​
169 test('handles deeply nested path in source location', () => {
170 const args = [
171 '%cLOG%c %cGo to Source: http://localhost:5173/__tsd/open-source?source=%2Fpackages%2Fdevtools-vite%2Fsrc%2Fplugin.ts%3A123%3A45%c \n β†’ ',
172 's1',
173 's2',
174 's3',
175 's4',
176 'deep path log',
177 ]
178 const result = stripEnhancedLogPrefix(args)
179 expect(result).toEqual([
180 'packages/devtools-vite/src/plugin.ts:123:45',
181 'deep path log',
182 ])
183 })
184})