Sulkta-Coop/element-x-ada
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Improve asXId and make tests pass in release and debug mode.

Browse source
This commit is contained in:
Benoit Marty 2023-04-12 09:14:55 +02:00 • committed by Benoit Marty
parent b081ecfb6a
commit eb6276e09d
15 changed files with 121 additions and 25 deletions
Download patch file Download diff file Expand all files Collapse all files

8
libraries/matrix/api/src/main/kotlin/io/element/android/libraries/matrix/api/core/EventId.kt
View file

@ -22,8 +22,12 @@ import java.io.Serializable
@JvmInline
value class EventId(val value: String) : Serializable
fun String.asEventId() = EventId(this).also {
if (BuildConfig.DEBUG && !MatrixPatterns.isEventId(this)) {
fun String.asEventId() = if (MatrixPatterns.isEventId(this)) {
EventId(this)
} else {
if (BuildConfig.DEBUG) {
error("`$this` is not a valid event Id")
} else {
null
}
}

8
libraries/matrix/api/src/main/kotlin/io/element/android/libraries/matrix/api/core/RoomId.kt
View file

@ -22,8 +22,12 @@ import java.io.Serializable
@JvmInline
value class RoomId(val value: String) : Serializable
fun String.asRoomId() = RoomId(this).also {
if (BuildConfig.DEBUG && !MatrixPatterns.isRoomId(this)) {
fun String.asRoomId() = if (MatrixPatterns.isRoomId(this)) {
RoomId(this)
} else {
if (BuildConfig.DEBUG) {
error("`$this` is not a valid room Id")
} else {
null
}
}

8
libraries/matrix/api/src/main/kotlin/io/element/android/libraries/matrix/api/core/SessionId.kt
View file

@ -20,8 +20,12 @@ import io.element.android.libraries.matrix.api.BuildConfig
typealias SessionId = UserId
fun String.asSessionId() = SessionId(this).also {
if (BuildConfig.DEBUG && !MatrixPatterns.isSessionId(this)) {
fun String.asSessionId() = if (MatrixPatterns.isSessionId(this)) {
SessionId(this)
} else {
if (BuildConfig.DEBUG) {
error("`$this` is not a valid session Id")
} else {
null
}
}

8
libraries/matrix/api/src/main/kotlin/io/element/android/libraries/matrix/api/core/SpaceId.kt
View file

@ -27,8 +27,12 @@ value class SpaceId(val value: String) : Serializable
*/
val MAIN_SPACE = SpaceId("!mainSpace")
fun String.asSpaceId() = SpaceId(this).also {
if (BuildConfig.DEBUG && !MatrixPatterns.isSpaceId(this)) {
fun String.asSpaceId() = if (MatrixPatterns.isSpaceId(this)) {
SpaceId(this)
} else {
if (BuildConfig.DEBUG) {
error("`$this` is not a valid space Id")
} else {
null
}
}

10
libraries/matrix/api/src/main/kotlin/io/element/android/libraries/matrix/api/core/ThreadId.kt
View file

@ -22,8 +22,12 @@ import java.io.Serializable
@JvmInline
value class ThreadId(val value: String) : Serializable
fun String.asThreadId() = ThreadId(this).also {
if (BuildConfig.DEBUG && !MatrixPatterns.isThreadId(this)) {
error("`$this` is not a valid Thread Id")
fun String.asThreadId() = if (MatrixPatterns.isThreadId(this)) {
ThreadId(this)
} else {
if (BuildConfig.DEBUG) {
error("`$this` is not a valid thread Id")
} else {
null
}
}

8
libraries/matrix/api/src/main/kotlin/io/element/android/libraries/matrix/api/core/UserId.kt
View file

@ -22,8 +22,12 @@ import java.io.Serializable
@JvmInline
value class UserId(val value: String) : Serializable
fun String.asUserId() = UserId(this).also {
if (BuildConfig.DEBUG && !MatrixPatterns.isUserId(this)) {
fun String.asUserId() = if (MatrixPatterns.isUserId(this)) {
UserId(this)
} else {
if (BuildConfig.DEBUG) {
error("`$this` is not a valid user Id")
} else {
null
}
}

1
libraries/pushproviders/firebase/build.gradle.kts
View file

@ -45,4 +45,5 @@ dependencies {
testImplementation(libs.test.junit)
testImplementation(libs.test.truth)
testImplementation(projects.libraries.matrix.test)
testImplementation(projects.tests.testutils)
}

2
libraries/pushproviders/firebase/src/main/kotlin/io/element/android/libraries/push/providers/firebase/FirebaseNewTokenHandler.kt
View file

@ -42,7 +42,7 @@ class FirebaseNewTokenHandler @Inject constructor(
firebaseStore.storeFcmToken(firebaseToken)
// Register the pusher for all the sessions
sessionStore.getAllSessions().toUserList()
.map { it.asSessionId() }
.mapNotNull { it.asSessionId() }
.forEach { userId ->
val userDataStore = userPushStoreFactory.create(userId)
if (userDataStore.getPushProviderName() == FirebaseConfig.name) {

10
libraries/pushproviders/firebase/src/test/kotlin/io/element/android/libraries/push/providers/firebase/FirebasePushParserTest.kt
View file

@ -20,7 +20,7 @@ import com.google.common.truth.Truth.assertThat
import io.element.android.libraries.matrix.test.AN_EVENT_ID
import io.element.android.libraries.matrix.test.A_ROOM_ID
import io.element.android.libraries.push.providers.api.PushData
import org.junit.Assert.assertThrows
import io.element.android.tests.testutils.assertNullOrThrow
import org.junit.Test
class FirebasePushParserTest {
@ -52,26 +52,26 @@ class FirebasePushParserTest {
fun `test empty roomId`() {
val pushParser = FirebasePushParser()
assertThat(pushParser.parse(FIREBASE_PUSH_DATA.mutate("room_id", null))).isNull()
assertThrows(IllegalStateException::class.java) { pushParser.parse(FIREBASE_PUSH_DATA.mutate("room_id", "")) }
assertNullOrThrow { pushParser.parse(FIREBASE_PUSH_DATA.mutate("room_id", "")) }
}
@Test
fun `test invalid roomId`() {
val pushParser = FirebasePushParser()
assertThrows(IllegalStateException::class.java) { pushParser.parse(FIREBASE_PUSH_DATA.mutate("room_id", "aRoomId:domain")) }
assertNullOrThrow { pushParser.parse(FIREBASE_PUSH_DATA.mutate("room_id", "aRoomId:domain")) }
}
@Test
fun `test empty eventId`() {
val pushParser = FirebasePushParser()
assertThat(pushParser.parse(FIREBASE_PUSH_DATA.mutate("event_id", null))).isNull()
assertThrows(IllegalStateException::class.java) { pushParser.parse(FIREBASE_PUSH_DATA.mutate("event_id", "")) }
assertNullOrThrow { pushParser.parse(FIREBASE_PUSH_DATA.mutate("event_id", "")) }
}
@Test
fun `test invalid eventId`() {
val pushParser = FirebasePushParser()
assertThrows(IllegalStateException::class.java) { pushParser.parse(FIREBASE_PUSH_DATA.mutate("event_id", "anEventId")) }
assertNullOrThrow { pushParser.parse(FIREBASE_PUSH_DATA.mutate("event_id", "anEventId")) }
}
companion object {

1
libraries/pushproviders/unifiedpush/build.gradle.kts
View file

@ -53,4 +53,5 @@ dependencies {
testImplementation(libs.test.junit)
testImplementation(libs.test.truth)
testImplementation(projects.libraries.matrix.test)
testImplementation(projects.tests.testutils)
}

10
libraries/pushproviders/unifiedpush/src/test/kotlin/io/element/android/libraries/push/providers/unifiedpush/UnifiedPushParserTest.kt
View file

@ -20,7 +20,7 @@ import com.google.common.truth.Truth.assertThat
import io.element.android.libraries.matrix.test.AN_EVENT_ID
import io.element.android.libraries.matrix.test.A_ROOM_ID
import io.element.android.libraries.push.providers.api.PushData
import org.junit.Assert.assertThrows
import io.element.android.tests.testutils.assertNullOrThrow
import org.junit.Test
class UnifiedPushParserTest {
@ -52,7 +52,7 @@ class UnifiedPushParserTest {
@Test
fun `test empty roomId`() {
val pushParser = UnifiedPushParser()
assertThrows(IllegalStateException::class.java) {
assertNullOrThrow {
pushParser.parse(UNIFIED_PUSH_DATA.replace(A_ROOM_ID.value, "").toByteArray(), aClientSecret)
}
}
@ -60,7 +60,7 @@ class UnifiedPushParserTest {
@Test
fun `test invalid roomId`() {
val pushParser = UnifiedPushParser()
assertThrows(IllegalStateException::class.java) {
assertNullOrThrow {
pushParser.parse(UNIFIED_PUSH_DATA.mutate(A_ROOM_ID.value, "aRoomId:domain"), aClientSecret)
}
}
@ -68,7 +68,7 @@ class UnifiedPushParserTest {
@Test
fun `test empty eventId`() {
val pushParser = UnifiedPushParser()
assertThrows(IllegalStateException::class.java) {
assertNullOrThrow {
pushParser.parse(UNIFIED_PUSH_DATA.mutate(AN_EVENT_ID.value, ""), aClientSecret)
}
}
@ -76,7 +76,7 @@ class UnifiedPushParserTest {
@Test
fun `test invalid eventId`() {
val pushParser = UnifiedPushParser()
assertThrows(IllegalStateException::class.java) {
assertNullOrThrow {
pushParser.parse(UNIFIED_PUSH_DATA.mutate(AN_EVENT_ID.value, "anEventId"), aClientSecret)
}
}

2
libraries/pushstore/impl/src/main/kotlin/io/element/android/libraries/pushstore/impl/DefaultUserPushStoreFactory.kt
View file

@ -60,6 +60,6 @@ class DefaultUserPushStoreFactory @Inject constructor(
override suspend fun onSessionDeleted(userId: String) {
// Delete the store
create(userId.asSessionId()).reset()
userId.asSessionId()?.let { create(it).reset() }
}
}

1
settings.gradle.kts
View file

@ -49,6 +49,7 @@ rootProject.name = "ElementX"
include(":app")
include(":appnav")
include(":tests:uitests")
include(":tests:testutils")
include(":anvilannotations")
include(":anvilcodegen")

36
tests/testutils/build.gradle.kts Normal file
View file

@ -0,0 +1,36 @@
/*
* Copyright (c) 2023 New Vector Ltd
*
* 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.
*/
// TODO: Remove once https://youtrack.jetbrains.com/issue/KTIJ-19369 is fixed
@Suppress("DSL_SCOPE_VIOLATION")
plugins {
id("io.element.android-library")
alias(libs.plugins.ksp)
}
android {
namespace = "io.element.android.tests.testutils"
}
dependencies {
implementation(libs.test.junit)
implementation(libs.test.mockk)
implementation(libs.test.truth)
implementation(libs.test.turbine)
implementation(libs.coroutines.test)
implementation(projects.libraries.matrix.test)
implementation(projects.services.appnavstate.test)
}

33
tests/testutils/src/main/kotlin/io/element/android/tests/testutils/NullOrThrow.kt Normal file
View file

@ -0,0 +1,33 @@
/*
* Copyright (c) 2023 New Vector Ltd
*
* 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.element.android.tests.testutils
import com.google.common.truth.Truth.assertThat
import org.junit.Assert.assertThrows
/**
* Assert that the lambda throws on debug and returns null on release.
*/
fun assertNullOrThrow(lambda: () -> Any?) {
if (BuildConfig.DEBUG) {
assertThrows(IllegalStateException::class.java) {
lambda()
}
} else {
assertThat(lambda()).isNull()
}
}