FlowDelegateUsageDetector.kt
12.6 KB
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
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
@file:Suppress("UnstableApiUsage") // We know that Lint API's aren't final.
/*
* Copyright (C) 2018 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package io.livekit.lint
import com.android.tools.lint.client.api.UElementHandler
import com.android.tools.lint.detector.api.*
import com.intellij.psi.JavaElementVisitor
import com.intellij.psi.PsiElement
import com.intellij.psi.PsiJavaCodeReferenceElement
import com.intellij.psi.PsiMethod
import org.jetbrains.uast.*
import org.jetbrains.uast.kotlin.KotlinUQualifiedReferenceExpression
/** Checks related to DiffUtil computation. */
class FlowDelegateUsageDetector : Detector(), SourceCodeScanner {
override fun visitReference(
context: JavaContext,
visitor: JavaElementVisitor?,
reference: PsiJavaCodeReferenceElement,
referenced: PsiElement
) {
super.visitReference(context, visitor, reference, referenced)
}
override fun visitReference(context: JavaContext, reference: UReferenceExpression, referenced: PsiElement) {
// Check if we're actually trying to access the flow delegate
val referencedMethod = referenced as? PsiMethod ?: return
if (referenced.name != "getFlow" || referencedMethod.containingClass?.qualifiedName != "io.livekit.android.util.FlowObservableKt") {
return
}
// This should get the property we're trying to receive the flow from.
val receiver = ((reference.uastParent as? KotlinUQualifiedReferenceExpression)
?.receiver as? UCallableReferenceExpression)
?: return
// This should get the original class associated with the property.
val className = receiver.qualifierType?.canonicalText
val psiClass = if (className != null) context.evaluator.findClass(className) else null
val psiField = psiClass?.findFieldByName("${receiver.callableName}\$delegate", true)
val isAnnotated = psiField?.hasAnnotation("io.livekit.android.util.FlowObservable") ?: false
if (!isAnnotated) {
val message = DEFAULT_MSG
val location = context.getLocation(reference)
context.report(ISSUE, reference, location, message)
}
}
override fun getApplicableReferenceNames(): List<String>? =
listOf("flow")
override fun visitMethodCall(context: JavaContext, node: UCallExpression, method: PsiMethod) {
super.visitMethodCall(context, node, method)
}
override fun getApplicableUastTypes() =
listOf(
UBinaryExpression::class.java,
UCallExpression::class.java,
UAnnotation::class.java,
UArrayAccessExpression::class.java,
UBinaryExpressionWithType::class.java,
UBlockExpression::class.java,
UBreakExpression::class.java,
UCallableReferenceExpression::class.java,
UCatchClause::class.java,
UClass::class.java,
UClassLiteralExpression::class.java,
UContinueExpression::class.java,
UDeclaration::class.java,
UDoWhileExpression::class.java,
UElement::class.java,
UEnumConstant::class.java,
UExpression::class.java,
UExpressionList::class.java,
UField::class.java,
UFile::class.java,
UForEachExpression::class.java,
UForExpression::class.java,
UIfExpression::class.java,
UImportStatement::class.java,
UClassInitializer::class.java,
ULabeledExpression::class.java,
ULambdaExpression::class.java,
ULiteralExpression::class.java,
ULocalVariable::class.java,
UMethod::class.java,
UObjectLiteralExpression::class.java,
UParameter::class.java,
UParenthesizedExpression::class.java,
UPolyadicExpression::class.java,
UPostfixExpression::class.java,
UPrefixExpression::class.java,
UQualifiedReferenceExpression::class.java,
UReturnExpression::class.java,
USimpleNameReferenceExpression::class.java,
USuperExpression::class.java,
USwitchClauseExpression::class.java,
USwitchExpression::class.java,
UThisExpression::class.java,
UThrowExpression::class.java,
UTryExpression::class.java,
UTypeReferenceExpression::class.java,
UUnaryExpression::class.java,
UVariable::class.java,
UWhileExpression::class.java,
UYieldExpression::class.java,
)
override fun createUastHandler(context: JavaContext): UElementHandler? {
return object : UElementHandler() {
val context = context
override fun visitBinaryExpression(node: UBinaryExpression) {
println(0)
}
override fun visitCallExpression(node: UCallExpression) {
node.classReference
node.methodName
node.methodIdentifier
node.receiverType
node.receiver
node.kind
node.valueArguments
node.valueArgumentCount
node.typeArguments
node.typeArgumentCount
node.returnType
println(1)
}
override fun visitAnnotation(node: UAnnotation) {
println(0)
}
override fun visitArrayAccessExpression(node: UArrayAccessExpression) {
println(0)
}
override fun visitBinaryExpressionWithType(node: UBinaryExpressionWithType) {
println(0)
}
override fun visitBlockExpression(node: UBlockExpression) {
println(0)
}
override fun visitBreakExpression(node: UBreakExpression) {
println(0)
}
override fun visitCallableReferenceExpression(node: UCallableReferenceExpression) {
println(0)
}
override fun visitCatchClause(node: UCatchClause) {
println(0)
}
override fun visitClass(node: UClass) {
println(0)
}
override fun visitClassLiteralExpression(node: UClassLiteralExpression) {
println(0)
}
override fun visitContinueExpression(node: UContinueExpression) {
println(0)
}
override fun visitDeclaration(node: UDeclaration) {
println(0)
}
override fun visitDeclarationsExpression(node: UDeclarationsExpression) {
println(0)
}
override fun visitDoWhileExpression(node: UDoWhileExpression) {
println(0)
}
override fun visitElement(node: UElement) {
println(0)
}
override fun visitEnumConstant(node: UEnumConstant) {
println(0)
}
override fun visitExpression(node: UExpression) {
println(0)
}
override fun visitExpressionList(node: UExpressionList) {
println(0)
}
override fun visitField(node: UField) {
println(0)
}
override fun visitFile(node: UFile) {
println(0)
}
override fun visitForEachExpression(node: UForEachExpression) {
println(0)
}
override fun visitForExpression(node: UForExpression) {
println(0)
}
override fun visitIfExpression(node: UIfExpression) {
println(0)
}
override fun visitImportStatement(node: UImportStatement) {
println(0)
}
override fun visitInitializer(node: UClassInitializer) {
println(0)
}
override fun visitLabeledExpression(node: ULabeledExpression) {
println(0)
}
override fun visitLambdaExpression(node: ULambdaExpression) {
println(0)
}
override fun visitLiteralExpression(node: ULiteralExpression) {
println(0)
}
override fun visitLocalVariable(node: ULocalVariable) {
println(0)
}
override fun visitMethod(node: UMethod) {
println(0)
}
override fun visitObjectLiteralExpression(node: UObjectLiteralExpression) {
println(0)
}
override fun visitParameter(node: UParameter) {
println(0)
}
override fun visitParenthesizedExpression(node: UParenthesizedExpression) {
println(0)
}
override fun visitPolyadicExpression(node: UPolyadicExpression) {
println(0)
}
override fun visitPostfixExpression(node: UPostfixExpression) {
println(0)
}
override fun visitPrefixExpression(node: UPrefixExpression) {
println(0)
}
override fun visitQualifiedReferenceExpression(node: UQualifiedReferenceExpression) {
println(0)
}
override fun visitReturnExpression(node: UReturnExpression) {
println(0)
}
override fun visitSimpleNameReferenceExpression(node: USimpleNameReferenceExpression) {
println(0)
//(((node as KotlinUSimpleReferenceExpression).uastParent as KotlinUQualifiedReferenceExpression).receiver as KotlinUCallableReferenceExpression).qualifierType?.canonicalText
}
override fun visitSuperExpression(node: USuperExpression) {
println(0)
}
override fun visitSwitchClauseExpression(node: USwitchClauseExpression) {
println(0)
}
override fun visitSwitchExpression(node: USwitchExpression) {
println(0)
}
override fun visitThisExpression(node: UThisExpression) {
println(0)
}
override fun visitThrowExpression(node: UThrowExpression) {
println(0)
}
override fun visitTryExpression(node: UTryExpression) {
println(0)
}
override fun visitTypeReferenceExpression(node: UTypeReferenceExpression) {
println(0)
}
override fun visitUnaryExpression(node: UUnaryExpression) {
println(0)
}
override fun visitVariable(node: UVariable) {
println(0)
}
override fun visitWhileExpression(node: UWhileExpression) {
println(0)
}
override fun visitYieldExpression(node: UYieldExpression) {
println(0)
}
}
}
companion object {
private const val MEDIA_STREAM_TRACK = "org.webrtc.MediaStreamTrack"
private const val DEFAULT_MSG =
"Incorrect flow property usage: Only properties marked with the @FlowObservable annotation can be observed using `io.livekit.android.util.flow`."
private val IMPLEMENTATION =
Implementation(FlowDelegateUsageDetector::class.java, Scope.JAVA_FILE_SCOPE)
@JvmField
val ISSUE = Issue.create(
id = "FlowDelegateUsageDetector",
briefDescription = "flow on a non-@FlowObservable property",
explanation = """
Only properties marked with the @FlowObservable annotation can be observed using
`io.livekit.android.util.flow`.
""",
category = Category.CORRECTNESS,
priority = 4,
androidSpecific = true,
moreInfo = "https://issuetracker.google.com/116789824",
severity = Severity.ERROR,
implementation = IMPLEMENTATION
)
}
}