Discharge7443/fleet
1
0
Fork 0
Code Issues Pull Requests Actions 21 Packages Projects Releases Wiki Activity

Updated custom lint rules to include Android datastore. (#26722)

Browse Source 
For #26218 

### Observations
The custom lint rules don't catch many issues. For example: this checks
for an illegal use of reader/writer in a function
(`containsIllegal(m["fn"]))`), but if the reader/writer code is
refactored into a different function, then this check will not fail.

Also, the rules lack tests, making them hard to maintain and potentially
irrelevant after code is refactored.
This commit is contained in:
Victor Lyuboslavsky
2025-02-28 15:08:39 -06:00
committed by GitHub
parent b21f54d648
commit ac6885a865
1 changed files with 4 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files
tools/ci/rules.go
+4 -2
View File
@@ -24,6 +24,7 @@ func createHttpClient(m dsl.Matcher) {
func txCheck(m dsl.Matcher) {
m.Import("github.com/fleetdm/fleet/v4/server/datastore/mysql")
m.Import("github.com/fleetdm/fleet/v4/server/mdm/android/mysql")
m.Import("github.com/jmoiron/sqlx")
isDatastoreType := func(v dsl.Var) bool {
@@ -31,14 +32,15 @@ func txCheck(m dsl.Matcher) {
}
containsIllegal := func(v dsl.Var) bool {
return v.Contains(`$ds.writer`) || v.Contains(`$ds.reader`)
return v.Contains(`$ds.writer`) || v.Contains(`$ds.reader`) ||
v.Contains(`$ds.Writer`) || v.Contains(`$ds.Reader`)
}
isSqlxIface := func(v dsl.Var) bool {
return (v.Type.Is(`sqlx.ExtContext`) || v.Type.Is(`sqlx.ExecContext`))
}
m.Match(`$ds.withTx($_, $fn)`, `$ds.withRetryTxx($_, $fn)`).
m.Match(`$ds.withTx($_, $fn)`, `$ds.withRetryTxx($_, $fn)`, `$ds.WithRetryTxx($_, $fn)`).
Where(isDatastoreType(m["ds"]) && containsIllegal(m["fn"])).
Report("improper use of ds.reader or ds.writer in a transaction")