FlowDelegateUsageDetectorTest.kt
8.1 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
@file:Suppress("UnstableApiUsage", "NewObjectEquality")
package io.livekit.lint
import com.android.tools.lint.checks.infrastructure.TestFile
import com.android.tools.lint.checks.infrastructure.TestFiles.kotlin
import com.android.tools.lint.checks.infrastructure.TestLintTask.lint
import org.junit.Test
class FlowDelegateUsageDetectorTest {
@Test
fun normalFlowAccess() {
lint()
.allowMissingSdk()
.files(
flowAccess(),
stateFlow(),
kotlin(
"""
package foo
import io.livekit.android.util.FlowObservable
import io.livekit.android.util.flow
import io.livekit.android.util.flowDelegate
class Example {
@FlowObservable
@get:FlowObservable
val value: Int by flowDelegate(0)
fun foo() {
::value.flow
return
}
}"""
).indented()
)
.issues(FlowDelegateUsageDetector.ISSUE)
.run()
.expectClean()
}
@Test
fun thisColonAccess() {
lint()
.allowMissingSdk()
.files(
flowAccess(),
stateFlow(),
kotlin(
"""
package foo
import io.livekit.android.util.FlowObservable
import io.livekit.android.util.flow
import io.livekit.android.util.flowDelegate
class Example {
@FlowObservable
@get:FlowObservable
val value: Int by flowDelegate(0)
fun foo() {
this::value.flow
return
}
}"""
).indented()
)
.issues(FlowDelegateUsageDetector.ISSUE)
.run()
.expectClean()
}
@Test
fun otherClassAccess() {
lint()
.allowMissingSdk()
.files(
flowAccess(),
stateFlow(),
kotlin(
"""
package foo
import io.livekit.android.util.FlowObservable
import io.livekit.android.util.flow
import io.livekit.android.util.flowDelegate
class FlowContainer {
@FlowObservable
@get:FlowObservable
val value: Int by flowDelegate(0)
}
class Example {
fun foo() {
val container = FlowContainer()
container::value.flow
return
}
}"""
).indented()
)
.issues(FlowDelegateUsageDetector.ISSUE)
.run()
.expectClean()
}
@Test
fun parenthesesClassAccess() {
lint()
.allowMissingSdk()
.files(
flowAccess(),
stateFlow(),
kotlin(
"""
package foo
import io.livekit.android.util.FlowObservable
import io.livekit.android.util.flow
import io.livekit.android.util.flowDelegate
class FlowContainer {
@FlowObservable
@get:FlowObservable
val value: Int by flowDelegate(0)
}
class Example {
fun foo() {
val container = FlowContainer()
(container)::value.flow
return
}
}"""
).indented()
)
.issues(FlowDelegateUsageDetector.ISSUE)
.run()
.expectClean()
}
@Test
fun roundaboutAccess() {
lint()
.allowMissingSdk()
.files(
flowAccess(),
stateFlow(),
kotlin(
"""
package foo
import io.livekit.android.util.FlowObservable
import io.livekit.android.util.flow
import io.livekit.android.util.flowDelegate
class FlowContainer {
var value: Int by flowDelegate(0)
@FlowObservable
@get:FlowObservable
val otherValue: Int
get() = value
}
class Example {
fun foo() {
val container = FlowContainer()
container::otherValue.flow
return
}
}"""
).indented()
)
.issues(FlowDelegateUsageDetector.ISSUE)
.run()
.expectClean()
}
@Test
fun nonAnnotatedFlowAccess() {
lint()
.allowMissingSdk()
.files(
flowAccess(),
stateFlow(),
kotlin(
"""
package foo
import io.livekit.android.util.FlowObservable
import io.livekit.android.util.flow
import io.livekit.android.util.flowDelegate
class Example {
val value: Int = 0
fun foo() {
this::value.flow
return
}
}"""
).indented()
)
.issues(FlowDelegateUsageDetector.ISSUE)
.run()
.expectErrorCount(1)
}
}
fun flowAccess(): TestFile {
return kotlin(
"io/livekit/android/util/FlowDelegate.kt",
"""
package io.livekit.android.util
import kotlin.reflect.KProperty
import kotlin.reflect.KProperty0
import kotlinx.coroutines.flow.StateFlow
import kotlinx.coroutines.flow.MutableStateFlow
internal val <T> KProperty0<T>.delegate: Any?
get() { getDelegate() }
@Suppress("UNCHECKED_CAST")
val <T> KProperty0<T>.flow: StateFlow<T>
get() = delegate as StateFlow<T>
@Target(AnnotationTarget.PROPERTY, AnnotationTarget.PROPERTY_GETTER)
@Retention(AnnotationRetention.SOURCE)
@MustBeDocumented
annotation class FlowObservable
@FlowObservable
class MutableStateFlowDelegate<T>
internal constructor(
private val flow: MutableStateFlow<T>,
private val onSetValue: ((newValue: T, oldValue: T) -> Unit)? = null
) : MutableStateFlow<T> by flow {
operator fun getValue(thisRef: Any?, property: KProperty<*>): T {
return flow.value
}
operator fun setValue(thisRef: Any?, property: KProperty<*>, value: T) {
val oldValue = flow.value
flow.value = value
onSetValue?.invoke(value, oldValue)
}
}
public fun <T> flowDelegate(
initialValue: T,
onSetValue: ((newValue: T, oldValue: T) -> Unit)? = null
): MutableStateFlowDelegate<T> {
return MutableStateFlowDelegate(MutableStateFlow(initialValue), onSetValue)
}
"""
).indented()
.within("src")
}
fun stateFlow(): TestFile {
return kotlin(
"""
package kotlinx.coroutines.flow
interface StateFlow<out T> {
val value: T
}
class MutableStateFlow<T>(override var value: T) : StateFlow<T>
"""
).indented()
}