Sign in with QR code #2793
+4,421
−326
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -15,6 +15,7 @@ | |
| */ | ||
| plugins { | ||
| id("io.element.android-library") | ||
| id("kotlin-parcelize") | ||
| } | ||
|
|
||
| android { | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| /* | ||
| * Copyright (c) 2024 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.features.login.impl.di | ||
|
|
||
| import com.squareup.anvil.annotations.ContributesTo | ||
| import io.element.android.features.login.impl.qrcode.QrCodeLoginManager | ||
|
|
||
| @ContributesTo(QrCodeLoginScope::class) | ||
| interface QrCodeLoginBindings { | ||
| fun qrCodeLoginManager(): QrCodeLoginManager | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,38 @@ | ||
| /* | ||
| * Copyright (c) 2024 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.features.login.impl.di | ||
|
|
||
| import com.squareup.anvil.annotations.ContributesTo | ||
| import com.squareup.anvil.annotations.MergeSubcomponent | ||
| import dagger.Subcomponent | ||
| import io.element.android.libraries.architecture.NodeFactoriesBindings | ||
| import io.element.android.libraries.di.AppScope | ||
| import io.element.android.libraries.di.SingleIn | ||
|
|
||
| @SingleIn(QrCodeLoginScope::class) | ||
| @MergeSubcomponent(QrCodeLoginScope::class) | ||
| interface QrCodeLoginComponent : NodeFactoriesBindings { | ||
| @Subcomponent.Builder | ||
| interface Builder { | ||
| fun build(): QrCodeLoginComponent | ||
| } | ||
|
|
||
| @ContributesTo(AppScope::class) | ||
| interface ParentBindings { | ||
| fun qrCodeLoginComponentBuilder(): Builder | ||
| } | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,19 @@ | ||
| /* | ||
| * Copyright (c) 2024 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.features.login.impl.di | ||
|
|
||
| abstract class QrCodeLoginScope private constructor() | ||
|
Check warning on line 19 in features/login/impl/src/main/kotlin/io/element/android/features/login/impl/di/QrCodeLoginScope.kt
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,54 @@ | ||
| /* | ||
| * Copyright (c) 2024 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.features.login.impl.qrcode | ||
|
|
||
| import com.squareup.anvil.annotations.ContributesBinding | ||
| import io.element.android.features.login.impl.di.QrCodeLoginScope | ||
| import io.element.android.libraries.di.SingleIn | ||
| import io.element.android.libraries.matrix.api.auth.MatrixAuthenticationService | ||
| import io.element.android.libraries.matrix.api.auth.qrlogin.MatrixQrCodeLoginData | ||
| import io.element.android.libraries.matrix.api.auth.qrlogin.QrCodeLoginStep | ||
| import io.element.android.libraries.matrix.api.auth.qrlogin.QrLoginException | ||
| import io.element.android.libraries.matrix.api.core.SessionId | ||
| import kotlinx.coroutines.flow.MutableStateFlow | ||
| import kotlinx.coroutines.flow.StateFlow | ||
| import javax.inject.Inject | ||
|
|
||
| @SingleIn(QrCodeLoginScope::class) | ||
| @ContributesBinding(QrCodeLoginScope::class) | ||
| class DefaultQrCodeLoginManager @Inject constructor( | ||
| private val authenticationService: MatrixAuthenticationService, | ||
| ) : QrCodeLoginManager { | ||
| private val _currentLoginStep = MutableStateFlow<QrCodeLoginStep>(QrCodeLoginStep.Uninitialized) | ||
| override val currentLoginStep: StateFlow<QrCodeLoginStep> = _currentLoginStep | ||
|
|
||
| override suspend fun authenticate(qrCodeLoginData: MatrixQrCodeLoginData): Result<SessionId> { | ||
| reset() | ||
|
|
||
| return authenticationService.loginWithQrCode(qrCodeLoginData) { step -> | ||
| _currentLoginStep.value = step | ||
| }.onFailure { throwable -> | ||
| if (throwable is QrLoginException) { | ||
| _currentLoginStep.value = QrCodeLoginStep.Failed(throwable) | ||
|
Check warning on line 46 in features/login/impl/src/main/kotlin/io/element/android/features/login/impl/qrcode/DefaultQrCodeLoginManager.kt
|
||
| } | ||
| } | ||
| } | ||
|
|
||
| override fun reset() { | ||
| _currentLoginStep.value = QrCodeLoginStep.Uninitialized | ||
| } | ||
| } | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do we really need a separate component and scope for this? This is just to keep the
StateFlow<QrCodeLoginStep>?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The problem here is
QrCodeLoginManagerhad to be shared by several components (QrCodeLofingFlowNode,QrCodeScanPresenter) and for that I needed a singleton if I'm not mistaken. But having a singleton can be troublesome if you aren't super careful with cleaning up its state once you're done working with it, so I created a new component to hold it that will be created when the QR code flow starts and discarded once it's finished.This should ensure the object is shared but can't be leaked in any way, although it's more complex than I intended it to be.