forked from Uniswap/interface
-
Notifications
You must be signed in to change notification settings - Fork 0
/
dangerfile.ts
261 lines (219 loc) · 10.2 KB
/
dangerfile.ts
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
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
import { danger, fail, markdown, message, warn } from 'danger'
function getIndicesOf(searchStr: string, str: string): number[] {
var searchStrLen = searchStr.length;
if (searchStrLen == 0) {
return [];
}
var startIndex = 0, index, indices: number[] = [];
while ((index = str.indexOf(searchStr, startIndex)) > -1) {
indices.push(index);
startIndex = index + searchStrLen;
}
return indices;
}
async function getLinesAddedByFile(files: string[]) {
return await Promise.all(files.flatMap(async (file) => {
const structuredDiff = await danger.git.structuredDiffForFile(file);
return (structuredDiff?.chunks || []).flatMap((chunk) => {
return chunk.changes.filter((change) => change.type === 'add')
})
}))
}
async function processAddChanges() {
const updatedTsFiles = danger.git.modified_files
.concat(danger.git.created_files)
.filter((file) => (file.endsWith('.ts') || file.endsWith('.tsx')) && !file.includes('dangerfile.ts'))
const updatedNonUITsFiles = updatedTsFiles.filter((file) => !file.includes('packages/ui'))
const linesAddedByFile = await getLinesAddedByFile(updatedTsFiles)
const allLinesAdded = linesAddedByFile.flatMap((x) => x)
// Check for non-UI package lines for tamagui imports
const allNonUILinesAddedByFile = await getLinesAddedByFile(updatedNonUITsFiles)
const allNonUILinesAdded = allNonUILinesAddedByFile.flatMap((x) => x)
allNonUILinesAdded.forEach((change) => {
if (change.content.includes(`from 'tamagui`)) {
fail(`Please import any tamagui exports via the ui package. Found an import at ${change.content}`)
}
})
// Checks for any logging and reminds the developer not to log sensitive data
if (allLinesAdded.some((change) => change.content.includes('logMessage') || change.content.includes('logger.'))) {
warn('You are logging data. Please confirm that nothing sensitive is being logged!')
}
// Check for direct logging calls
if (allLinesAdded.some((change) => change.content.includes('analytics.sendEvent'))) {
warn(`You are using the direct analytics call. Please use the typed wrapper for your given surface if possible!`)
}
// Check for UI package imports that are longer than needed
const validLongerImports = [`'ui/src'`, `'ui/src/theme'`, `'ui/src/loading'`, `'ui/src/assets'`]
const longestImportLength = Math.max(...validLongerImports.map((i) => i.length))
allLinesAdded.forEach((change) => {
const indices = getIndicesOf(`from 'ui/src/`, change.content)
indices.forEach((idx) => {
const potentialSubstring = change.content.substring(idx, Math.min(change.content.length, idx + longestImportLength + 6 + 1))
if (!validLongerImports.some((validImport) => potentialSubstring.includes(validImport))) {
const endOfImport = change.content.indexOf(`'`, idx + 6) // skipping the "from '"
warn(`It looks like you have a longer import from 'ui/src' than needed ('${change.content.substring(idx + 6, endOfImport)}'). Please use one of [${validLongerImports.join(', ')}] when possible!`)
}
})
})
linesAddedByFile.forEach((linesAdded) => {
const concatenatedAddedLines = linesAdded.reduce((acc, curr) => acc + curr.content, '')
// In this section we concatenate all the added lines by file in order to account for multiline changes.
// Check for non-recommended sentry usage
if (/logger\.error\(\s*new Error\(/.test(concatenatedAddedLines)) {
warn(`It appears you may be manually logging a Sentry error. Please log the error directly if possible. If you need to use a custom error message, ensure the error object is added to the 'cause' property.`)
}
if (/logger\.error\(\s*['`"]/.test(concatenatedAddedLines)) {
warn(`Please log an error, not a string!`)
}
// Check for incorrect usage of `createSelector`
if (concatenatedAddedLines.includes(`createSelector(`)) {
warn("You've added a new call to `createSelector()`. This is Ok, but please make sure you're using it correctly and you're not creating a new selector on every render. See PR #5172 for details.")
}
if (/(useAppSelector|appSelect|select)\(\s*makeSelect/.test(concatenatedAddedLines)) {
fail(`It appears you may be creating a new selector on every render. See PR #5172 for details on how to fix this.`)
}
})
}
async function checkCocoaPodsVersion() {
const updatedPodFileLock = danger.git.modified_files.find((file) => file.includes('ios/Podfile.lock'))
if (updatedPodFileLock) {
const structuredDiff = await danger.git.structuredDiffForFile(updatedPodFileLock);
const changedLines = (structuredDiff?.chunks || []).flatMap((chunk) => {
return chunk.changes.filter((change) => change.type === 'add')
})
const changedCocoaPodsVersion = changedLines.some((change) => change.content.includes('COCOAPODS: '))
if (changedCocoaPodsVersion) {
warn(`You're changing the Podfile version! Ensure you are using the correct version. If this change is intentional, you should ignore this check and merge anyways.`)
}
}
}
async function checkApostrophes() {
const updatedTranslations = danger.git.modified_files.find((file) => file.includes('en-US.json'))
if (updatedTranslations) {
const structuredDiff = await danger.git.structuredDiffForFile(updatedTranslations);
const changedLines = (structuredDiff?.chunks || []).flatMap((chunk) => {
return chunk.changes.filter((change) => change.type === 'add')
})
changedLines.forEach((line, index) => {
if (line.content.includes("'")) {
fail("You added a string to the translations file using the ' character. Please use the ’ character instead!. Issue in line: " + index)
}
})
}
}
async function checkPRSize() {
// Warn when there is a big PR
const bigPRThreshold = 500
const linesCount = await danger.git.linesOfCode('**/*');
// exclude fixtures and auto generated files
const excludeLinesCount = await danger.git.linesOfCode(
'{**/*.snap}',
)
const totalLinesCount = (linesCount ?? 0) - (excludeLinesCount ?? 0)
if (totalLinesCount > bigPRThreshold) {
warn(':exclamation: Big PR')
markdown(
'> Pull Request size seems relatively large. If PR contains multiple changes, split each into separate PRs for faster, easier reviews.'
)
}
}
/* Warn about storing credentials in GH and uploading env.local to 1Password */
const envChanged = danger.git.modified_files.includes('.env.defaults')
if (envChanged) {
warn(
'Changes were made to .env.defaults. Confirm that no sensitive data is in the .env.defaults file. Sensitive data must go in .env (web) or .env.defaults.local (mobile) and then run `yarn upload-env-local` to store it in 1Password.'
)
}
// Run checks on added changes
processAddChanges()
// Check for cocoapods version change
checkCocoaPodsVersion()
// check translations use the correct apostrophes
checkApostrophes()
// Stories for new components
const createdComponents = danger.git.created_files.filter(
(f) =>
f.includes('components/buttons') ||
f.includes('components/input') ||
f.includes('components/layout/') ||
f.includes('components/text')
)
const hasCreatedComponent = createdComponents.length > 0
const createdStories = createdComponents.filter((filepath) => filepath.includes('stories/'))
const hasCreatedStories = createdStories.length > 0
if (hasCreatedComponent && !hasCreatedStories) {
warn(
'There are new primitive components, but not stories. Consider documenting the new component with Storybook'
)
}
// check the PR size
checkPRSize()
// No PR is too small to warrant a paragraph or two of summary
if (danger.github.pr.body.length < 50) {
warn(
'The PR description is looking sparse. Please consider explaining more about this PRs goal and implementation decisions.'
)
}
// Congratulate when code was deleted
if (danger.github.pr.additions < danger.github.pr.deletions) {
message(
`✂️ Thanks for removing ${danger.github.pr.deletions - danger.github.pr.additions} lines!`
)
}
// Stories congratulations
const stories = danger.git.fileMatch('**/*stories*')
if (stories.edited) {
message('🙌 Thanks for keeping stories up to date!')
}
// GraphQL update warnings
const updatedGraphQLfile = danger.git.modified_files.find((file) =>
file.includes('__generated__/types-and-hooks.ts')
)
if (updatedGraphQLfile) {
warn(
'You have updated the GraphQL schema. Please ensure that the Swift GraphQL Schema generation is valid by running `yarn mobile ios` and rebuilding for iOS. ' +
'You may need to add or remove generated files to the project.pbxproj. For more information see `apps/mobile/ios/WidgetsCore/MobileSchema/README.md`'
)
}
// Migrations + schema warnings
const updatedSchemaFile = danger.git.modified_files.find((file) =>
file.includes('src/app/schema.ts')
)
const updatedMigrationsFile = danger.git.modified_files.find((file) =>
file.includes('src/app/migrations.ts')
)
const updatedMigrationsTestFile = danger.git.modified_files.find((file) =>
file.includes('src/app/migrations.test.ts')
)
const createdSliceFile = danger.git.created_files.find((file) =>
file.toLowerCase().includes('slice')
)
const modifiedSliceFile = danger.git.modified_files.find((file) =>
file.toLowerCase().includes('slice')
)
const deletedSliceFile = danger.git.deleted_files.find((file) =>
file.toLowerCase().includes('slice')
)
if (modifiedSliceFile && (!updatedSchemaFile || !updatedMigrationsFile)) {
warn(
'You modified a slice file. If you added, renamed, or deleted required properties from state, then make sure to define a new schema and a create a migration.'
)
}
if (updatedSchemaFile && !updatedMigrationsFile) {
warn(
'You updated the schema file but not the migrations file. Make sure to also define a migration.'
)
}
if (!updatedSchemaFile && updatedMigrationsFile) {
warn(
'You updated the migrations file but not the schema. Schema always needs to be updated when a new migration is defined.'
)
}
if ((createdSliceFile || deletedSliceFile) && (!updatedSchemaFile || !updatedMigrationsFile)) {
warn('You created or deleted a slice file. Make sure to create check schema and migration is updated if needed.')
}
if (updatedMigrationsFile && !updatedMigrationsTestFile) {
fail(
'You updated the migrations file but did not write any new tests. Each migration must have a test!'
)
}