implement app state getter for web #509

navaronbracke · 2025-02-11T12:01:35Z

Fixes #486
Replaces #485 (I had an issue with signing the commits during the interactive rebase, so I started over)

All new/changed/fixed functionality is covered by tests (or N/A)
I have added documentation for all new/changed functionality (or N/A)

📋 Changes

This PR adds support for the appState parameter to loginWithRedirect() for the web.
See https://github.com/auth0/auth0-spa-js/blob/f2e566849efa398ca599daf9ebdfbbd62fcb1894/src/global.ts#L298

There is prior art in auth0/auth0-angular#168

🎯 Testing

Added several unit tests. This can be tested end-to-end by setting up a login with redirect, that uses the app state argument as parameter, and then validating that the app state is returned when the user is redirected back.
I did verify end-to-end using an internal application that uses the SDK integration.

To run the unit tests locally, use flutter test test/web/auth0_flutter_web_test.dart --platform=chrome

navaronbracke · 2025-02-11T12:02:49Z

@Widcket Apologies, I had an issue during the interactive rebase when trying to fix the commit signing, so I had to start over. I also applied your comments from the previous PR into this one.

navaronbracke · 2025-02-11T12:03:26Z

auth0_flutter/lib/auth0_flutter_web.dart

+  /// Get the app state that was provided during a previous call
+  /// to [loginWithRedirect].
+  ///
+  /// This method should be called after calling [onLoad].


The note about second access returning null is now removed.

navaronbracke · 2025-02-11T12:04:04Z

auth0_flutter/lib/src/web/auth0_flutter_plugin_real.dart

+  /// Thus clearing this object is not needed,
+  /// as the actual state is managed across reloads,
+  /// using the transaction manager.
+  // TODO: move the `appState` to the result of `onLoad/initialize`


Please let me know if I need to update this new TODO

navaronbracke · 2025-02-11T12:06:41Z

auth0_flutter/lib/src/web/auth0_flutter_plugin_real.dart

+  Object? _appState;
+
+  @override
+  Future<Object?> get appState => Future<Object?>.value(_appState);


Per your request, the getter now returns the value as-is

navaronbracke · 2025-02-11T12:07:35Z

auth0_flutter/pubspec.yaml

@@ -21,6 +21,7 @@ dependency_overrides:

 dev_dependencies:
  build_runner: ^2.1.8
+  collection: ^1.18.0


This is for the MapEquality in tests.

navaronbracke · 2025-02-11T12:08:54Z

auth0_flutter_platform_interface/lib/src/auth0_flutter_web_platform.dart

@@ -15,6 +15,10 @@ abstract class Auth0FlutterWebPlatform extends PlatformInterface {
    _instance = instance;
  }

+  Future<Object?> get appState {


Previously there was also an @override that duplicated this implementation. I removed that one.
Maybe that is why the code coverage report was reporting the uncovered lines?

navaronbracke · 2025-02-11T12:09:42Z

auth0_flutter/test/web/auth0_flutter_web_test.dart

+
+    when(mockClientProxy.isAuthenticated())
+        .thenAnswer((final _) => Future.value(false));
+    when(mockClientProxy.handleRedirectCallback())


This test was updated to verify the redirect callback as well. (since it now returns a value)

navaronbracke · 2025-02-11T12:11:02Z

auth0_flutter/test/web/auth0_flutter_web_test.dart

+    );
+  });
+
+  test('appState getter returns value when accessed more than once', () async {


This test was added to prevent regressing the behavior of the new getter. (it should always return the same value)

codecov · 2025-02-11T12:18:13Z

Codecov Report

Attention: Patch coverage is 80.00000% with 1 line in your changes missing coverage. Please review.

Project coverage is 83.97%. Comparing base (253209a) to head (a093e15).
Report is 131 commits behind head on main.

Files with missing lines	Patch %	Lines
...PI/AuthAPIPhoneNumberPasswordlessLoginMethod.swift	0.00%	1 Missing ⚠️

Additional details and impacted files

@@              Coverage Diff              @@
##               main     #509       +/-   ##
=============================================
- Coverage     96.08%   83.97%   -12.12%     
=============================================
  Files            97      108       +11     
  Lines          1611     1884      +273     
  Branches        331      424       +93     
=============================================
+ Hits           1548     1582       +34     
- Misses           49      289      +240     
+ Partials         14       13        -1

Flag	Coverage Δ
auth0_flutter	`91.72% <ø> (-8.28%)`	⬇️
auth0_flutter_android	`80.65% <ø> (-15.91%)`	⬇️
auth0_flutter_ios	`83.78% <0.00%> (-16.07%)`	⬇️
auth0_flutter_platform_interface	`86.20% <100.00%> (-0.83%)`	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

navaronbracke · 2025-02-11T13:26:35Z

I don't understand why the Sentry report might still be reporting the getter as uncovered?
The Auth0FlutterWebPlatform class in which it is defined is abstract, so cannot be instantiated.
The StubAuth0FlutterWeb class, which implements Auth0FlutterWebPlatform tests the getter in
https://github.com/auth0/auth0-flutter/pull/509/files#diff-b6191cf5b6dc7f251d6af466701eb8de71f4bb8fdebb1bfb2cfdbbf865bec83eR121

navaronbracke · 2025-02-12T07:20:59Z

It seems that the upstream iOS & MacOS tests are broken currently? This prevents new test reports from being made.

navaronbracke · 2025-03-05T15:35:05Z

auth0_flutter/analysis_options.yaml

@@ -32,7 +32,6 @@ linter:
    test_types_in_equals: true
    throw_in_finally: true
    unnecessary_statements: true
-    unsafe_html: true


unsafe_html is removed in Dart 3.7. The project had no ignores, so this can be removed.

navaronbracke · 2025-03-05T15:35:44Z

auth0_flutter/analysis_options.yaml

@@ -91,4 +90,4 @@ linter:
    sort_pub_dependencies: true

    # Specific rules
-    package_api_docs: true
+    package_api_docs: true # TODO: replace with public_member_api_docs


This lint is removed in Dart 3.7, I added a TODO for the most likely replacement.
Enabling that lint is more work, though.

navaronbracke · 2025-03-05T15:37:02Z

auth0_flutter/lib/src/web/js_interop_utils.dart

+  external int get arrayLength;
+
+  @JS('at')
+  external JSFunction get elementAt;


Overriding operator[] didn't help, because then I still get a warning.

Can this be moved to the js_interop file ?

navaronbracke · 2025-03-05T15:38:13Z

auth0_flutter/test/web/js_interop_utils_test.dart

@@ -27,4 +30,22 @@ void main() {
      expect((output as dynamic).custom_param, null);
    });
  });
+
+  group('stripNulls', () {
+    test('removes null values from an object', () {


Regression test for the change in stripNulls.

pmathew92 · 2025-03-06T09:13:40Z

auth0_flutter/lib/auth0_flutter_web.dart

+  ///
+  /// See https://api.dart.dev/dart-js_interop/NullableObjectUtilExtension/jsify.html
+  Future<void> loginWithRedirect({
+    final Object? appState,


I think it will be easier if appState is passed as the last option with a default value so it doesn't break for any existing users

These are named parameters, so the position of the parameter does not matter (you need to specify it as loginWithRedirect(appState: myStateObject))

Since this is already nullable, this does not need a default value (the default is null)

pmathew92 · 2025-03-06T09:14:29Z

auth0_flutter/lib/auth0_flutter_web.dart

+  }) =>
+      Auth0FlutterWebPlatform.instance.loginWithRedirect(
+        LoginOptions(
+          appState: appState,


Same as above . Can we move this as an optional parameter with a default value

LoginOptions.appState is already a named nullable argument, so the position is irrelevant and it has a default (null).

pmathew92 · 2025-03-06T09:19:07Z

auth0_flutter/lib/src/web/auth0_flutter_plugin_real.dart

+
+        _appState = JsInteropUtils.dartifyObject(result.appState);
+
+        return;


Shouldn't the result be returned here and the return type be Future ?

That would be a breaking change for the Auth0Web interface. See also the TODO I added on line 36 in this file.
For now users can keep calling initialize(), while retrieving the value using the getter.

pmathew92 · 2025-03-06T09:25:32Z

auth0_flutter/lib/src/web/js_interop.dart

-  external factory RedirectLoginOptions(
-      {final AuthorizationParams authorizationParams, final String fragment});
+  external factory RedirectLoginOptions({
+    final JSAny? appState,


This is optional right ? Would it be easier if we have a secondary constructor so no existing implementation breaks and users can easily migrate ?

The RedirectLoginOptions is a JS interop type and is an implementation detail that is not directly used by users.

pmathew92 · 2025-03-06T09:29:30Z

auth0_flutter/lib/src/web/js_interop_utils.dart

-      final key = objKeys[i];
+    for (var i = 0; i < objKeys.arrayLength; i++) {
+      // TODO: replace w/ `final key = objKeys[i];` when updating to Dart 3.6.0
+      final key = objKeys.elementAt.callAsFunction(objKeys, i.toJS)!;


why do we need this change ?

The [] operator and the length getter on JSArray are only available from Dart 3.6.0 onwards.
However, requiring to go from Dart 3.5.0 to Dart 3.6.0 would imply a switch from Flutter 3.24 to 3.27.
Therefor I opted to use a backwards compatible fix for now.

pmathew92 · 2025-03-06T09:38:35Z

auth0_flutter/lib/src/web/js_interop_utils.dart

+  /// that do not fit into a static interop definition.
+  ///
+  /// See https://api.dart.dev/dart-js_interop/NullableObjectUtilExtension/jsify.html
+  static JSAny? jsifyObject(final Object? obj) => obj.jsify();


@navaronbracke Do we need these helper methods ? Wouldn't be much easier if we call .jsify() and .dartify() directly on the corresponding objects

navaronbracke · 2025-03-06T13:41:08Z

@pmathew92 PTAL. I updated the JS interop to call dartify/jsify directly and moved the polyfill for JSArray to the correct file.

As for the appState argument, I think that that is working as intended? Named arguments can be written anywhere in the argument list of a function call. (as opposed to positional arguments, which do have a fixed order). And since the appState is nullable users can just omit the argument if it is not needed.

For the switch to Dart 3.6.0, that is up to you, as this would mean that users that are on Flutter 3.24 (for WASM support) will need to migrate to Flutter 3.27 for this change.

pmathew92 · 2025-03-07T10:40:14Z

Thankyou @navaronbracke

navaronbracke · 2025-03-07T13:08:10Z

Any ideas why the code coverage check is failing? The indirect diff seems to be unrelated to this PR?

implement app state getter for web

c858986

navaronbracke requested a review from a team as a code owner February 11, 2025 12:01

navaronbracke commented Feb 11, 2025

View reviewed changes

navaronbracke had a problem deploying to external February 11, 2025 12:05 — with GitHub Actions Failure

navaronbracke temporarily deployed to external February 11, 2025 12:05 — with GitHub Actions Inactive

navaronbracke commented Feb 11, 2025

View reviewed changes

navaronbracke added 2 commits February 11, 2025 14:09

adjust test

b9b93dd

Merge branch 'main' into app_state_argument_addition

99b9960

navaronbracke temporarily deployed to external February 11, 2025 23:57 — with GitHub Actions Inactive

navaronbracke had a problem deploying to external February 11, 2025 23:57 — with GitHub Actions Failure

navaronbracke temporarily deployed to external February 11, 2025 23:57 — with GitHub Actions Inactive

navaronbracke had a problem deploying to external February 11, 2025 23:57 — with GitHub Actions Failure

navaronbracke temporarily deployed to external February 12, 2025 07:58 — with GitHub Actions Inactive

Merge branch 'main' into app_state_argument_addition

75b894d

navaronbracke had a problem deploying to external February 21, 2025 00:31 — with GitHub Actions Failure

navaronbracke temporarily deployed to external February 21, 2025 00:31 — with GitHub Actions Inactive

add polyfill for length & operator[]

a3c2f35

navaronbracke commented Mar 5, 2025

View reviewed changes

navaronbracke temporarily deployed to external March 5, 2025 16:50 — with GitHub Actions Inactive

navaronbracke had a problem deploying to external March 5, 2025 16:50 — with GitHub Actions Failure

navaronbracke temporarily deployed to external March 5, 2025 16:50 — with GitHub Actions Inactive

navaronbracke had a problem deploying to external March 5, 2025 16:50 — with GitHub Actions Failure

navaronbracke temporarily deployed to external March 5, 2025 16:50 — with GitHub Actions Inactive

pmathew92 reviewed Mar 6, 2025

View reviewed changes

navaronbracke added 2 commits March 6, 2025 14:33

use dartify/jsify directly

fc2e584

move extension to correct file

b285835

navaronbracke requested a review from pmathew92 March 6, 2025 13:41

Merge branch 'main' into app_state_argument_addition

a093e15

navaronbracke had a problem deploying to external March 7, 2025 06:36 — with GitHub Actions Failure

navaronbracke temporarily deployed to external March 7, 2025 06:36 — with GitHub Actions Inactive

Widcket had a problem deploying to external March 7, 2025 10:40 — with GitHub Actions Failure

Widcket temporarily deployed to external March 7, 2025 10:40 — with GitHub Actions Inactive

Widcket deployed to external March 7, 2025 10:40 — with GitHub Actions Active

Widcket had a problem deploying to external March 7, 2025 10:40 — with GitHub Actions Failure

Widcket temporarily deployed to external March 7, 2025 10:40 — with GitHub Actions Inactive

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

implement app state getter for web #509

implement app state getter for web #509

navaronbracke commented Feb 11, 2025

navaronbracke commented Feb 11, 2025

navaronbracke Feb 11, 2025

navaronbracke Feb 11, 2025

navaronbracke Feb 11, 2025

navaronbracke Feb 11, 2025

navaronbracke Feb 11, 2025

navaronbracke Feb 11, 2025 •

edited

Loading

navaronbracke Feb 11, 2025

codecov bot commented Feb 11, 2025 •

edited

Loading

navaronbracke commented Feb 11, 2025

navaronbracke commented Feb 12, 2025

navaronbracke Mar 5, 2025

navaronbracke Mar 5, 2025

navaronbracke Mar 5, 2025

pmathew92 Mar 6, 2025

navaronbracke Mar 5, 2025

pmathew92 Mar 6, 2025

navaronbracke Mar 6, 2025

pmathew92 Mar 6, 2025

navaronbracke Mar 6, 2025

pmathew92 Mar 6, 2025 •

edited

Loading

navaronbracke Mar 6, 2025 •

edited

Loading

pmathew92 Mar 6, 2025

navaronbracke Mar 6, 2025

pmathew92 Mar 6, 2025 •

edited

Loading

navaronbracke Mar 6, 2025

pmathew92 Mar 6, 2025 •

edited

Loading

navaronbracke Mar 6, 2025

navaronbracke commented Mar 6, 2025

pmathew92 commented Mar 7, 2025

navaronbracke commented Mar 7, 2025


		_appState = JsInteropUtils.dartifyObject(result.appState);

		return;

implement app state getter for web #509

Are you sure you want to change the base?

implement app state getter for web #509

Conversation

navaronbracke commented Feb 11, 2025

📋 Changes

🎯 Testing

navaronbracke commented Feb 11, 2025

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

navaronbracke Feb 11, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

codecov bot commented Feb 11, 2025 • edited Loading

Codecov Report

navaronbracke commented Feb 11, 2025

navaronbracke commented Feb 12, 2025

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

pmathew92 Mar 6, 2025 • edited Loading

Choose a reason for hiding this comment

navaronbracke Mar 6, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

pmathew92 Mar 6, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

pmathew92 Mar 6, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

navaronbracke commented Mar 6, 2025

pmathew92 commented Mar 7, 2025

navaronbracke commented Mar 7, 2025

navaronbracke Feb 11, 2025 •

edited

Loading

codecov bot commented Feb 11, 2025 •

edited

Loading

pmathew92 Mar 6, 2025 •

edited

Loading

navaronbracke Mar 6, 2025 •

edited

Loading

pmathew92 Mar 6, 2025 •

edited

Loading

pmathew92 Mar 6, 2025 •

edited

Loading