FazBrowse GitHub Viewer
|
Trending
|
URL:
|
Home
Tools:
[Download Repo ZIP]
[View Raw Code]
[Original HTTPS Page]
angular-cli/scripts/validate-user-analytics.mts at main · angular/angular-cli · GitHub
Uh oh!
There was an error while loading.
Please reload this page
.
angular
/
angular-cli
Public
Notifications
You must be signed in to change notification settings
Fork
11.8k
Star
27k
Code
Issues
253
Pull requests
27
Actions
Security and quality
5
Insights
Additional navigation options
Code
Issues
Pull requests
Actions
Security and quality
Insights
Expand file tree
Breadcrumbs
angular-cli
/
scripts
/
validate-user-analytics.mts
Copy path
More file actions
More file actions
Latest commit
History
History
History
194 lines (163 loc) · 6.12 KB
Breadcrumbs
angular-cli
/
scripts
/
validate-user-analytics.mts
Copy path
File metadata and controls
194 lines (163 loc) · 6.12 KB
Raw
Copy raw file
Download raw file
Open symbols panel
Edit and raw actions
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
/**
*
@license
* Copyright Google LLC All Rights Reserved.
*
* Use of this source code is governed by an MIT-style license that can be
* found in the LICENSE file at https://angular.dev/license
*/
import
glob
from
'fast-glob'
;
import
lodash
from
'lodash'
;
import
assert
from
'node:assert'
;
import
*
as
fs
from
'node:fs'
;
import
*
as
path
from
'node:path'
;
import
{
EventCustomDimension
,
EventCustomMetric
,
UserCustomDimension
,
}
from
'../packages/angular/cli/src/analytics/analytics-parameters.ts'
;
const
__dirname
=
import
.
meta
.
dirname
;
const
userAnalyticsTable
=
lodash
.
template
(
fs
.
readFileSync
(
path
.
join
(
__dirname
,
'./templates/user-analytics-table.ejs'
)
,
'utf-8'
)
,
)
;
const
dimensionsTableRe
=
/
<
!
-
-
D
I
M
E
N
S
I
O
N
S
_
T
A
B
L
E
_
B
E
G
I
N
-
-
>
(
[
\s
\S
]
*
)
<
!
-
-
D
I
M
E
N
S
I
O
N
S
_
T
A
B
L
E
_
E
N
D
-
-
>
/
m
;
const
userDimensionsTableRe
=
/
<
!
-
-
U
S
E
R
_
D
I
M
E
N
S
I
O
N
S
_
T
A
B
L
E
_
B
E
G
I
N
-
-
>
(
[
\s
\S
]
*
)
<
!
-
-
U
S
E
R
_
D
I
M
E
N
S
I
O
N
S
_
T
A
B
L
E
_
E
N
D
-
-
>
/
m
;
const
metricsTableRe
=
/
<
!
-
-
M
E
T
R
I
C
S
_
T
A
B
L
E
_
B
E
G
I
N
-
-
>
(
[
\s
\S
]
*
)
<
!
-
-
M
E
T
R
I
C
S
_
T
A
B
L
E
_
E
N
D
-
-
>
/
m
;
async
function
_checkUserDimensions
(
dimensionsTable
:
string
)
{
console
.
info
(
'Gathering user dimensions from @angular/cli...'
)
;
const
data
=
Object
.
entries
(
UserCustomDimension
)
.
map
(
(
[
key
,
value
]
)
=>
(
{
parameter
:
value
,
name
:
key
,
type
:
value
.
charAt
(
2
)
===
'n'
?
'number'
:
'string'
,
}
)
)
;
if
(
data
.
length
>
25
)
{
throw
new
Error
(
'GA has a limit of 25 custom user dimensions. Delete and archive the ones that are not needed.'
,
)
;
}
for
(
const
{
parameter
}
of
data
)
{
const
param
=
parameter
.
split
(
'.'
)
[
1
]
;
if
(
param
.
length
>
24
)
{
throw
new
Error
(
`User dimension parameter
${
param
}
is more than 24 characters.`
)
;
}
}
const
generatedTable
=
userAnalyticsTable
(
{
data
}
)
.
trim
(
)
;
if
(
dimensionsTable
!==
generatedTable
)
{
console
.
error
(
'Expected user dimensions table to be the same as generated. Copy the lines below:'
,
)
;
console
.
error
(
generatedTable
)
;
return
3
;
}
return
0
;
}
async
function
_checkDimensions
(
dimensionsTable
:
string
)
{
console
.
info
(
'Gathering event dimensions from @angular/cli...'
)
;
const
eventCustomDimensionValues
=
new
Set
(
Object
.
values
(
EventCustomDimension
)
)
;
console
.
info
(
'Gathering options for user-analytics...'
)
;
const
schemaUserAnalyticsValidator
=
(
obj
:
object
)
=>
{
for
(
const
value
of
Object
.
values
(
obj
)
)
{
if
(
value
&&
typeof
value
===
'object'
)
{
const
userAnalytics
=
value
[
'x-user-analytics'
]
;
if
(
userAnalytics
&&
!
eventCustomDimensionValues
.
has
(
userAnalytics
)
)
{
throw
new
Error
(
`Invalid value found in enum AnalyticsDimensions:
${
JSON
.
stringify
(
userAnalytics
)
}
`
,
)
;
}
else
{
schemaUserAnalyticsValidator
(
value
)
;
}
}
}
}
;
// Find all the schemas
const
{
packages
}
=
await
import
(
'./packages.mts'
)
;
const
packagesPaths
=
packages
.
map
(
(
{
root
}
)
=>
root
)
;
for
(
const
packagePath
of
packagesPaths
)
{
const
schemasPaths
=
await
glob
(
'**/schema.json'
,
{
cwd
:
packagePath
}
)
;
for
(
const
schemaPath
of
schemasPaths
)
{
const
schema
=
await
fs
.
promises
.
readFile
(
path
.
join
(
packagePath
,
schemaPath
)
,
'utf8'
)
;
schemaUserAnalyticsValidator
(
JSON
.
parse
(
schema
)
)
;
}
}
const
data
=
Object
.
entries
(
EventCustomDimension
)
.
map
(
(
[
key
,
value
]
)
=>
(
{
parameter
:
value
,
name
:
key
,
type
:
value
.
charAt
(
2
)
===
'n'
?
'number'
:
'string'
,
}
)
)
;
if
(
data
.
length
>
50
)
{
throw
new
Error
(
'GA has a limit of 50 custom event dimensions. Delete and archive the ones that are not needed.'
,
)
;
}
for
(
const
{
parameter
}
of
data
)
{
const
param
=
parameter
.
split
(
'.'
)
[
1
]
;
if
(
param
.
length
>
40
)
{
throw
new
Error
(
`Event dimension parameter
${
param
}
is more than 40 characters.`
)
;
}
}
const
generatedTable
=
userAnalyticsTable
(
{
data
}
)
.
trim
(
)
;
if
(
dimensionsTable
!==
generatedTable
)
{
console
.
error
(
'Expected event dimensions table to be the same as generated. Copy the lines below:'
,
)
;
console
.
error
(
generatedTable
)
;
return
3
;
}
return
0
;
}
async
function
_checkMetrics
(
metricsTable
:
string
)
{
console
.
info
(
'Gathering metrics from @angular/cli...'
)
;
const
data
=
Object
.
entries
(
EventCustomMetric
)
.
map
(
(
[
key
,
value
]
)
=>
(
{
parameter
:
value
,
name
:
key
,
type
:
value
.
charAt
(
2
)
===
'n'
?
'number'
:
'string'
,
}
)
)
;
if
(
data
.
length
>
50
)
{
throw
new
Error
(
'GA has a limit of 50 custom metrics. Delete and archive the ones that are not needed.'
,
)
;
}
for
(
const
{
parameter
}
of
data
)
{
const
param
=
parameter
.
split
(
'.'
)
[
1
]
;
if
(
param
.
length
>
40
)
{
throw
new
Error
(
`Event metric parameter
${
param
}
is more than 40 characters.`
)
;
}
}
const
generatedTable
=
userAnalyticsTable
(
{
data
}
)
.
trim
(
)
;
if
(
metricsTable
!==
generatedTable
)
{
console
.
error
(
'Expected metrics table to be the same as generated. Copy the lines below:'
)
;
console
.
error
(
generatedTable
)
;
return
4
;
}
return
0
;
}
/**
* Validate that the table of analytics from the analytics.md document is the same as expected /
* generated.
*/
export
default
async
function
(
_options
:
{
}
)
:
Promise
<
number
>
{
const
analyticsMarkdownPath
=
path
.
join
(
__dirname
,
'../docs/design/analytics.md'
)
;
const
analyticsMarkdown
=
fs
.
readFileSync
(
analyticsMarkdownPath
,
'utf8'
)
;
const
dimensionsMatch
=
analyticsMarkdown
.
match
(
dimensionsTableRe
)
;
const
userDimensionsMatch
=
analyticsMarkdown
.
match
(
userDimensionsTableRe
)
;
const
metricsMatch
=
analyticsMarkdown
.
match
(
metricsTableRe
)
;
assert
.
ok
(
dimensionsMatch
,
'Event dimensions table not found in analytics.md'
)
;
assert
.
ok
(
userDimensionsMatch
,
'User dimensions table not found in analytics.md'
)
;
assert
.
ok
(
metricsMatch
,
'Metrics table not found in analytics.md'
)
;
const
userDimensionsTable
=
userDimensionsMatch
[
1
]
.
trim
(
)
;
let
maybeError
=
await
_checkUserDimensions
(
userDimensionsTable
)
;
if
(
maybeError
)
{
return
maybeError
;
}
const
metricsTable
=
metricsMatch
[
1
]
.
trim
(
)
;
maybeError
=
await
_checkMetrics
(
metricsTable
)
;
if
(
maybeError
)
{
return
maybeError
;
}
const
dimensionsTable
=
dimensionsMatch
[
1
]
.
trim
(
)
;
maybeError
=
await
_checkDimensions
(
dimensionsTable
)
;
if
(
maybeError
)
{
return
maybeError
;
}
return
0
;
}
Back
|
FazBrowse Home
|
New Git URL