feat: Add support for browser-based logins #45

xitij2000 · 2023-09-05T14:52:51Z

For sites that only support logging in using a third-party login provider, allow logging in via a browser.
This new flow will open a custom tab where a user can log in using the supported mechanisms of the site,
then have the client id redirect back to to the app using a callback URL.

The auth code returned by the callback URL can then be used instead of a username and password to log in.

This change adds support for specifying an alternative resource directory, allowing resources to be overridden without needing to fork the repository.

This change makes it possible to specify an alternative location for the config.yaml file using an environment variable. This allows the developers to override all important data without messing up any files that can be committed to the repository.

For sites that only support logging in using a third-party login provider, allow logging in via a browser. This new flow will open a custom tab where a user can log in using the supported mechanisms of the site, then have the client id redirect back to to the app using a callback URL. The auth code returned by the callback URL can then be used instead of a username and password to log in.

xitij2000 · 2023-09-13T05:19:57Z

app/build.gradle

 android {
    compileSdk 34

    defaultConfig {
-        applicationId "org.openedx.app"
+        applicationId config?.application_id ?: "org.openedx.app"


Allow customising the applicationId via the config file, but fall back to org.openedx.app as before.

xitij2000

I've added some comments to help the reviewer at OpenCraft work on this PR during my leave.

xitij2000 · 2023-09-13T05:20:29Z

app/build.gradle

+            applicationIdSuffix '.dev'
        }
        stage {
            dimension 'env'
+            applicationIdSuffix '.stage'


Added suffixes for each environment since AFAIK this is also done for iOS.

xitij2000 · 2023-09-13T05:21:29Z

app/src/main/AndroidManifest.xml

+            <intent-filter>
+                <action android:name="android.intent.action.VIEW" />
+                <category android:name="android.intent.category.DEFAULT" />
+                <category android:name="android.intent.category.BROWSABLE" />
+                <data android:scheme="${applicationId}"  />
+            </intent-filter>


This will have the app handle the scheme matching the applicationId.

i.e. if the application id is "org.openedx.app" then this will handle: com.openedx.app://

xitij2000 · 2023-09-13T05:22:36Z

app/src/main/java/org/openedx/app/AppActivity.kt

+    private val authCode: String?
+        get() {
+            val data = intent?.data
+            if (data is Uri && data.scheme == BuildConfig.APPLICATION_ID && data.host == "oauth2Callback") {
+                return data.getQueryParameter("code")
+            }
+            return null
+        }
+


If the application was opened using the auth intent filter,
<applicationid>://oauth2Callback?code=<some_code> it will get the code out of the URL and return that.

xitij2000 · 2023-09-13T05:22:55Z

app/src/main/java/org/openedx/app/AppActivity.kt

+                val fragment = SignInFragment()
+                val bundle = Bundle()
+                bundle.putString("auth_code", authCode)
+                fragment.arguments = bundle
                supportFragmentManager.beginTransaction()
-                    .add(R.id.container, SignInFragment())
+                    .add(R.id.container, fragment)


Pass the code to the login fragment if available.

xitij2000 · 2023-09-13T05:23:43Z

auth/src/main/java/org/openedx/auth/data/repository/AuthRepository.kt

+    private suspend fun processAuthResponse(authResponse: AuthResponse) {
+        if (authResponse.error != null) {
+            throw EdxError.UnknownException(authResponse.error!!)
+        }
+        preferencesManager.accessToken = authResponse.accessToken ?: ""
+        preferencesManager.refreshToken = authResponse.refreshToken ?: ""
+        val user = api.getProfile().mapToDomain()
+        preferencesManager.user = user
+    }


Extracted out the common code since both login functions only have a slightly different API call but the same response.

xitij2000 · 2023-09-13T05:24:15Z

auth/src/main/java/org/openedx/auth/presentation/signin/SignInFragment.kt

+        val authCode = arguments?.getString("auth_code")
+        if (authCode is String) {
+            viewModel.login(authCode)
+        }


If this view was passed the auth_code then we can just log in straight away.

xitij2000 · 2023-09-13T05:25:08Z

auth/src/main/java/org/openedx/auth/presentation/signin/SignInFragment.kt

+                        val intent = CustomTabsIntent.Builder()
+                            .setUrlBarHidingEnabled(true)
+                            .setShowTitle(true)
+                            .build()
+                        intent.launchUrl(context, uri)


Using the custom tab mechanism allows any browser to handle this AFAIK and that can use the users saved password etc.

xitij2000 · 2023-09-13T05:26:02Z

build.gradle

@@ -33,7 +33,7 @@ ext {
    firebase_version = "32.1.0"

    retrofit_version = '2.9.0'
-    logginginterceptor_version = '4.9.1'
+    logginginterceptor_version = '4.11.0'


This gets rids of some errors

xitij2000 · 2023-09-13T05:26:41Z

settings.gradle

+    buildscript {
+        repositories {
+            mavenCentral()
+            maven {
+                url = uri("https://storage.googleapis.com/r8-releases/raw")
+            }
+        }
+        dependencies {
+            classpath("com.android.tools:r8:8.2.24")
+        }
+    }


This was suggested somewhere on StackOverflow for an error I was getting.

openedx-webhooks · 2023-10-12T08:15:37Z

Thanks for the pull request, @xitij2000! Please note that it may take us up to several weeks or months to complete a review and merge your PR.

Feel free to add as much of the following information to the ticket as you can:

supporting documentation
Open edX discussion forum threads
timeline information ("this must be merged by XX date", and why that is)
partner information ("this is a course on edx.org")
any other information that can help Product understand the context for the PR

All technical communication about the code itself will be done via the GitHub pull request interface. As a reminder, our process documentation is here.

This is currently a draft pull request. When it is ready for our review and all tests are green, click "Ready for Review", or remove "WIP" from the title, as appropriate.

e0d · 2023-11-21T14:14:43Z

@xitij2000 was a product ticket created for this work? We're pushing to have all PRs tie back to a product ticket that is, ideally, prioritized before the development happens.

xitij2000 · 2023-11-23T04:32:09Z

@xitij2000 was a product ticket created for this work? We're pushing to have all PRs tie back to a product ticket that is, ideally, prioritized before the development happens.

I think this PR predates the move to the openedx org. Can a ticket be created now?

mphilbrick211 · 2023-12-11T20:21:20Z

@xitij2000 was a product ticket created for this work? We're pushing to have all PRs tie back to a product ticket that is, ideally, prioritized before the development happens.

I think this PR predates the move to the openedx org. Can a ticket be created now?

@e0d - flagging this

xitij2000 · 2024-01-30T15:09:43Z

Replaced by #190

openedx-webhooks · 2024-01-30T15:09:47Z

@xitij2000 Even though your pull request wasn’t merged, please take a moment to answer a two question survey so we can improve your experience in the future.

We were incorrectly sending custom or track events as page events. This update corrects them back to the appropriate event types.

xitij2000 added 4 commits August 31, 2023 15:07

feat: add support for providing alternate resource directory

dd3eb56

This change adds support for specifying an alternative resource directory, allowing resources to be overridden without needing to fork the repository.

docs: Update documentation

9f8c4f1

feat: Add support for specifying application id in the config file

a78857b

xitij2000 changed the base branch from main to develop September 5, 2023 14:53

xitij2000 changed the title ~~kshitij/custom auth~~ feat: Add support for browser-based logins Sep 5, 2023

xitij2000 force-pushed the kshitij/custom-auth branch from 901f23f to 91df854 Compare September 7, 2023 13:49

temp: potential build fix

c54b897

xitij2000 commented Sep 13, 2023

View reviewed changes

yusuf-musleh and others added 2 commits October 2, 2023 14:01

fix: Add various configs to build prodRelease

44ffa16

feat: logout via browser as well.

3915e96

openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Oct 12, 2023

xitij2000 closed this Jan 30, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Add support for browser-based logins #45

feat: Add support for browser-based logins #45

xitij2000 commented Sep 5, 2023 •

edited

Loading

xitij2000 Sep 13, 2023

xitij2000 left a comment

xitij2000 Sep 13, 2023

xitij2000 Sep 13, 2023

xitij2000 Sep 13, 2023

xitij2000 Sep 13, 2023

xitij2000 Sep 13, 2023

xitij2000 Sep 13, 2023

xitij2000 Sep 13, 2023

xitij2000 Sep 13, 2023

xitij2000 Sep 13, 2023

openedx-webhooks commented Oct 12, 2023 •

edited

Loading

e0d commented Nov 21, 2023

xitij2000 commented Nov 23, 2023

mphilbrick211 commented Dec 11, 2023

xitij2000 commented Jan 30, 2024

openedx-webhooks commented Jan 30, 2024

feat: Add support for browser-based logins #45

feat: Add support for browser-based logins #45

Conversation

xitij2000 commented Sep 5, 2023 • edited Loading

Choose a reason for hiding this comment

xitij2000 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

openedx-webhooks commented Oct 12, 2023 • edited Loading

e0d commented Nov 21, 2023

xitij2000 commented Nov 23, 2023

mphilbrick211 commented Dec 11, 2023

xitij2000 commented Jan 30, 2024

openedx-webhooks commented Jan 30, 2024

xitij2000 commented Sep 5, 2023 •

edited

Loading

openedx-webhooks commented Oct 12, 2023 •

edited

Loading