wbrawner/Store
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Contain @ExperimentalStdlibApi within relevant scope. (#154)

Browse source 
* Contain @ExperimentalStdlibApi within relevant scope.

The alpha04 release of Store caused the requirement of the @ExperimentalStdlibApi annotation for client code. I looked into it, and the only thing in Store that required the annotation was the Kotlin ArrayDeque used in the BufferImpl class. That class is private in the ChannelManager.kt file, so I opted that file into the annotation and removed all other occurences of the annotation.

Code compiles, all 208 tests pass.

* update to correct git glitch in /build.gradle

* update to address 'needless blank line' linter

* Prepare for release 4.0.0-alpha05

* Prepare for next development version.

Co-authored-by: Dave Parker <davidp@dropbox.com>
This commit is contained in:
Dave Parker 2020-04-19 19:51:50 -04:00 committed by GitHub
parent e6158669d4
commit 8f0625fc70
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
30 changed files with 13 additions and 42 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
CHANGELOG.md
View file

@ -3,6 +3,17 @@ Change Log
The change log for Store version 1.x can be found [here](https://github.com/NYTimes/Store/blob/develop/CHANGELOG.md).
Version 4.0.0-alpha05 *(2020-04-03)*
----------------------------
**Bug Fixes and Stability Improvements**
* Contain @ExperimentalStdlibApi within relevant scope. (#154)
* Use AtomicFu to replace Java's AtomicBoolean and ReentrantLock (#147)
* migrate Multicast to Kotlin Test (#146)
* Remove Collections.unmodifiableMap (#145)
* Update AGP version (#143)
* Remove some unneeded java.util packages (#141)
Version 4.0.0-alpha04 *(2020-04-03)*
----------------------------

2
README.md
View file

@ -29,7 +29,7 @@ Artifacts are hosted on **Maven Central**.
###### Latest version:
```groovy
def store_version = "4.0.0-alpha04"
def store_version = "4.0.0-alpha05"
```
###### Add the dependency to your `build.gradle`:

1
app/src/main/java/com/dropbox/android/sample/ui/stream/StreamFragment.kt
View file

@ -42,7 +42,6 @@ class StreamFragment : Fragment(), CoroutineScope {
}
@ExperimentalTime
@ExperimentalStdlibApi
@InternalCoroutinesApi
@FlowPreview
override fun onViewCreated(view: View, savedInstanceState: Bundle?) {

9
multicast/src/main/kotlin/com/dropbox/flow/multicast/ChannelManager.kt
View file

@ -13,7 +13,7 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
@file:OptIn(ExperimentalStdlibApi::class)
package com.dropbox.flow.multicast
import kotlinx.coroutines.CompletableDeferred
@ -31,7 +31,6 @@ import kotlinx.coroutines.flow.Flow
* is no active upstream and there's at least one downstream that has not received a value.
*
*/
@ExperimentalStdlibApi
@ExperimentalCoroutinesApi
internal class ChannelManager<T>(
/**
@ -84,7 +83,6 @@ internal class ChannelManager<T>(
*/
private inner class Actor : StoreRealActor<Message<T>>(scope) {
@ExperimentalStdlibApi
private val buffer = Buffer<T>(bufferSize)
/**
@ -362,7 +360,6 @@ internal class ChannelManager<T>(
/**
* Buffer implementation for any late arrivals.
*/
@ExperimentalStdlibApi
@ExperimentalCoroutinesApi
private interface Buffer<T> {
fun add(item: ChannelManager.Message.Dispatch.Value<T>)
@ -373,7 +370,6 @@ private interface Buffer<T> {
/**
* Default implementation of buffer which does not buffer anything.
*/
@ExperimentalStdlibApi
@ExperimentalCoroutinesApi
private class NoBuffer<T> : Buffer<T> {
override val items: Collection<ChannelManager.Message.Dispatch.Value<T>>
@ -387,7 +383,6 @@ private class NoBuffer<T> : Buffer<T> {
* Create a new buffer insteance based on the provided limit.
*/
@Suppress("FunctionName")
@ExperimentalStdlibApi
@ExperimentalCoroutinesApi
private fun <T> Buffer(limit: Int): Buffer<T> = if (limit > 0) {
BufferImpl(limit)
@ -398,7 +393,6 @@ private fun <T> Buffer(limit: Int): Buffer<T> = if (limit > 0) {
/**
* A real buffer implementation that has a FIFO queue.
*/
@ExperimentalStdlibApi
@ExperimentalCoroutinesApi
private class BufferImpl<T>(private val limit: Int) :
Buffer<T> {
@ -411,7 +405,6 @@ private class BufferImpl<T>(private val limit: Int) :
}
}
@ExperimentalStdlibApi
@ExperimentalCoroutinesApi
internal fun <T> ChannelManager.Message.Dispatch.Value<T>.markDelivered() =
delivered.complete(Unit)

1
multicast/src/main/kotlin/com/dropbox/flow/multicast/Multicaster.kt
View file

@ -37,7 +37,6 @@ import kotlinx.coroutines.flow.transform
* is empty.
*/
@FlowPreview
@ExperimentalStdlibApi
@ExperimentalCoroutinesApi
class Multicaster<T>(
/**

1
multicast/src/main/kotlin/com/dropbox/flow/multicast/SharedFlowProducer.kt
View file

@ -37,7 +37,6 @@ import kotlinx.coroutines.launch
* Cancellation of the collection might be triggered by both this producer (e.g. upstream completes)
* or the [ChannelManager] (e.g. all active collectors complete).
*/
@ExperimentalStdlibApi
@ExperimentalCoroutinesApi
internal class SharedFlowProducer<T>(
private val scope: CoroutineScope,

1
multicast/src/test/kotlin/com/dropbox/flow/multicast/ChannelManagerTest.kt
View file

@ -37,7 +37,6 @@ import kotlin.test.fail
import kotlin.test.Test
@FlowPreview
@ExperimentalStdlibApi
@ExperimentalCoroutinesApi
class ChannelManagerTest {
private val scope = TestCoroutineScope()

1
multicast/src/test/kotlin/com/dropbox/flow/multicast/InfiniteMulticastTest.kt
View file

@ -37,7 +37,6 @@ import kotlin.test.assertEquals
* values as well.
*/
@FlowPreview
@ExperimentalStdlibApi
@ExperimentalCoroutinesApi
class InfiniteMulticastTest {
private val testScope = TestCoroutineScope()

1
multicast/src/test/kotlin/com/dropbox/flow/multicast/MulticastTest.kt
View file

@ -45,7 +45,6 @@ import kotlin.test.assertTrue
import kotlin.test.assertFailsWith
@FlowPreview
@ExperimentalStdlibApi
@ExperimentalCoroutinesApi
class MulticastTest {
private val testScope = TestCoroutineScope()

5
store-rx2/src/main/kotlin/com/dropbox/store/rx2/RxStore.kt
View file

@ -57,7 +57,6 @@ fun <Key : Any, Output : Any> Store<Key, Output>.observeClearAll(): Completable
* @param fetcher a function for fetching a flow of network records.
*/
@FlowPreview
@ExperimentalStdlibApi
@ExperimentalCoroutinesApi
fun <Key : Any, Output : Any> StoreBuilder.Companion.fromFlowable(
fetcher: (key: Key) -> Flowable<Output>
@ -73,7 +72,6 @@ fun <Key : Any, Output : Any> StoreBuilder.Companion.fromFlowable(
* @param fetcher a function for fetching a [Single] network response for a [Key]
*/
@FlowPreview
@ExperimentalStdlibApi
@ExperimentalCoroutinesApi
fun <Key : Any, Output : Any> StoreBuilder.Companion.fromSingle(
fetcher: (key: Key) -> Single<Output>
@ -85,7 +83,6 @@ fun <Key : Any, Output : Any> StoreBuilder.Companion.fromSingle(
* if a scheduler is not set Store will use [GlobalScope]
*/
@FlowPreview
@ExperimentalStdlibApi
@ExperimentalCoroutinesApi
fun <Key : Any, Output : Any> StoreBuilder<Key, Output>.withScheduler(
scheduler: Scheduler
@ -100,7 +97,6 @@ fun <Key : Any, Output : Any> StoreBuilder<Key, Output>.withScheduler(
* @see com.dropbox.android.external.store4.StoreBuilder.persister
*/
@FlowPreview
@ExperimentalStdlibApi
@ExperimentalCoroutinesApi
fun <Key : Any, Output : Any, NewOutput : Any> StoreBuilder<Key, Output>.withSinglePersister(
reader: (Key) -> Maybe<NewOutput>,
@ -137,7 +133,6 @@ fun <Key : Any, Output : Any, NewOutput : Any> StoreBuilder<Key, Output>.withSin
*
*/
@FlowPreview
@ExperimentalStdlibApi
@ExperimentalCoroutinesApi
fun <Key : Any, Output : Any, NewOutput : Any> StoreBuilder<Key, Output>.withFlowablePersister(
reader: (Key) -> Flowable<NewOutput>,

1
store-rx2/src/test/kotlin/com/dropbox/store/rx2/test/HotRxSingleStoreTest.kt
View file

@ -17,7 +17,6 @@ import org.junit.runners.JUnit4
@RunWith(JUnit4::class)
@FlowPreview
@ExperimentalStdlibApi
@ExperimentalCoroutinesApi
class HotRxSingleStoreTest {
private val testScope = TestCoroutineScope()

1
store-rx2/src/test/kotlin/com/dropbox/store/rx2/test/RxFlowableStoreTest.kt
View file

@ -19,7 +19,6 @@ import java.util.concurrent.atomic.AtomicInteger
@RunWith(JUnit4::class)
@FlowPreview
@ExperimentalStdlibApi
@ExperimentalCoroutinesApi
class RxFlowableStoreTest {
private val atomicInteger = AtomicInteger(0)

1
store-rx2/src/test/kotlin/com/dropbox/store/rx2/test/RxSingleStoreExtensionsTest.kt
View file

@ -18,7 +18,6 @@ import org.junit.runner.RunWith
import org.junit.runners.JUnit4
import java.util.concurrent.atomic.AtomicInteger
@ExperimentalStdlibApi
@ExperimentalStoreApi
@RunWith(JUnit4::class)
@FlowPreview

1
store-rx2/src/test/kotlin/com/dropbox/store/rx2/test/RxSingleStoreTest.kt
View file

@ -22,7 +22,6 @@ import org.junit.runner.RunWith
import org.junit.runners.JUnit4
import java.util.concurrent.atomic.AtomicInteger
@ExperimentalStdlibApi
@ExperimentalStoreApi
@RunWith(JUnit4::class)
@FlowPreview

3
store/src/main/java/com/dropbox/android/external/store4/StoreBuilder.kt vendored
View file

@ -31,7 +31,6 @@ import kotlin.time.ExperimentalTime
* Main entry point for creating a [Store].
*/
@FlowPreview
@ExperimentalStdlibApi
@ExperimentalCoroutinesApi
interface StoreBuilder<Key : Any, Output : Any> {
fun build(): Store<Key, Output>
@ -143,7 +142,6 @@ interface StoreBuilder<Key : Any, Output : Any> {
@FlowPreview
@OptIn(ExperimentalTime::class)
@ExperimentalStdlibApi
@ExperimentalCoroutinesApi
private class BuilderImpl<Key : Any, Output : Any>(
private val fetcher: (key: Key) -> Flow<Output>
@ -246,7 +244,6 @@ private class BuilderImpl<Key : Any, Output : Any>(
@FlowPreview
@OptIn(ExperimentalTime::class)
@ExperimentalStdlibApi
@ExperimentalCoroutinesApi
private class BuilderWithSourceOfTruth<Key : Any, Input : Any, Output : Any>(
private val fetcher: (key: Key) -> Flow<Input>,

1
store/src/main/java/com/dropbox/android/external/store4/impl/FetcherController.kt vendored
View file

@ -36,7 +36,6 @@ import kotlinx.coroutines.flow.map
* request.
*/
@FlowPreview
@ExperimentalStdlibApi
@ExperimentalCoroutinesApi
internal class FetcherController<Key, Input, Output>(
/**

1
store/src/main/java/com/dropbox/android/external/store4/impl/RealStore.kt vendored
View file

@ -39,7 +39,6 @@ import kotlinx.coroutines.flow.withIndex
import kotlin.time.ExperimentalTime
@ExperimentalTime
@ExperimentalStdlibApi
@ExperimentalCoroutinesApi
@FlowPreview
internal class RealStore<Key : Any, Input : Any, Output : Any>(

1
store/src/test/java/com/dropbox/android/external/store3/DontCacheErrorsTest.kt vendored
View file

@ -12,7 +12,6 @@ import org.junit.runner.RunWith
import org.junit.runners.Parameterized
@FlowPreview
@ExperimentalStdlibApi
@ExperimentalCoroutinesApi
@RunWith(Parameterized::class)
class DontCacheErrorsTest(

1
store/src/test/java/com/dropbox/android/external/store3/NoNetworkTest.kt vendored
View file

@ -14,7 +14,6 @@ import org.junit.runner.RunWith
import org.junit.runners.Parameterized
@FlowPreview
@ExperimentalStdlibApi
@ExperimentalCoroutinesApi
@RunWith(Parameterized::class)
class NoNetworkTest(

1
store/src/test/java/com/dropbox/android/external/store3/SequentialTest.kt vendored
View file

@ -13,7 +13,6 @@ import org.junit.runner.RunWith
import org.junit.runners.Parameterized
@FlowPreview
@ExperimentalStdlibApi
@ExperimentalCoroutinesApi
@RunWith(Parameterized::class)
class SequentialTest(

1
store/src/test/java/com/dropbox/android/external/store3/StoreTest.kt vendored
View file

@ -30,7 +30,6 @@ import kotlin.time.ExperimentalTime
@ExperimentalTime
@FlowPreview
@ExperimentalStdlibApi
@ExperimentalCoroutinesApi
@RunWith(Parameterized::class)
class StoreTest(

1
store/src/test/java/com/dropbox/android/external/store3/StoreThrowOnNoItems.kt vendored
View file

@ -18,7 +18,6 @@ import org.junit.runners.Parameterized
import java.util.concurrent.atomic.AtomicInteger
@FlowPreview
@ExperimentalStdlibApi
@ExperimentalCoroutinesApi
@RunWith(Parameterized::class)
class StoreThrowOnNoItems(

1
store/src/test/java/com/dropbox/android/external/store3/StreamOneKeyTest.kt vendored
View file

@ -25,7 +25,6 @@ import org.junit.runner.RunWith
import org.junit.runners.Parameterized
@FlowPreview
@ExperimentalStdlibApi
@ExperimentalCoroutinesApi
@RunWith(Parameterized::class)
class StreamOneKeyTest(

1
store/src/test/java/com/dropbox/android/external/store3/TestStoreBuilder.kt vendored
View file

@ -30,7 +30,6 @@ import kotlinx.coroutines.flow.flow
import kotlin.time.ExperimentalTime
@FlowPreview
@ExperimentalStdlibApi
@ExperimentalCoroutinesApi
data class TestStoreBuilder<Key : Any, Output : Any>(
private val buildStore: () -> Store<Key, Output>

1
store/src/test/java/com/dropbox/android/external/store4/FetcherControllerTest.kt vendored
View file

@ -32,7 +32,6 @@ import org.junit.Test
import org.junit.runner.RunWith
import org.junit.runners.JUnit4
@ExperimentalStdlibApi
@ExperimentalCoroutinesApi
@FlowPreview
@RunWith(JUnit4::class)

1
store/src/test/java/com/dropbox/android/external/store4/impl/ClearAllStoreTest.kt vendored
View file

@ -16,7 +16,6 @@ import org.junit.runner.RunWith
import org.junit.runners.JUnit4
@FlowPreview
@ExperimentalStdlibApi
@ExperimentalCoroutinesApi
@ExperimentalStoreApi
@RunWith(JUnit4::class)

1
store/src/test/java/com/dropbox/android/external/store4/impl/ClearStoreByKeyTest.kt vendored
View file

@ -15,7 +15,6 @@ import org.junit.runner.RunWith
import org.junit.runners.JUnit4
@FlowPreview
@ExperimentalStdlibApi
@ExperimentalCoroutinesApi
@RunWith(JUnit4::class)
class ClearStoreByKeyTest {

1
store/src/test/java/com/dropbox/android/external/store4/impl/FlowStoreTest.kt vendored
View file

@ -47,7 +47,6 @@ import org.junit.Test
import org.junit.runner.RunWith
import org.junit.runners.JUnit4
@ExperimentalStdlibApi
@FlowPreview
@ExperimentalCoroutinesApi
@RunWith(JUnit4::class)

1
store/src/test/java/com/dropbox/android/external/store4/impl/HotFlowStoreTest.kt vendored
View file

@ -16,7 +16,6 @@ import org.junit.Test
import org.junit.runner.RunWith
import org.junit.runners.JUnit4
@ExperimentalStdlibApi
@ExperimentalCoroutinesApi
@FlowPreview
@RunWith(JUnit4::class)

1
store/src/test/java/com/dropbox/android/external/store4/impl/StreamWithoutSourceOfTruthTest.kt vendored
View file

@ -35,7 +35,6 @@ import org.junit.runner.RunWith
import org.junit.runners.Parameterized
@FlowPreview
@ExperimentalStdlibApi
@ExperimentalCoroutinesApi
@RunWith(Parameterized::class)
class StreamWithoutSourceOfTruthTest(