Skip to content

refactor(gotrue): Remove unused _currentUser field and update currentUser getter logic. #1168

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

refactor(gotrue): Remove unused _currentUser field and update currentUser getter logic. #1168

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 4 additions & 11 deletions packages/gotrue/lib/src/gotrue_client.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,9 +43,6 @@ class GoTrueClient {
/// Namespace for the GoTrue MFA API methods.
late final GoTrueMFAApi mfa;

/// The currently logged in user or null.
User? _currentUser;

/// The session object for the currently logged in user or null.
Session? _currentSession;

Expand Down Expand Up @@ -140,10 +137,10 @@ class GoTrueClient {
/// Returns the current logged in user, if any;
///
/// Use [currentSession] to determine whether the user has an active session,
/// because [currentUser] can be non-null without an active session, such as
/// because [currentUser] can be null with an active session, such as
/// when the user signed up using email and password but has not confirmed
/// their email address.
User? get currentUser => _currentUser;
User? get currentUser => _currentSession?.user;

/// Returns the current session, if any;
Session? get currentSession => _currentSession;
Expand Down Expand Up @@ -748,8 +745,7 @@ class GoTrueClient {
options: options);
final userResponse = UserResponse.fromJson(response);

_currentUser = userResponse.user;
_currentSession = currentSession?.copyWith(user: userResponse.user);
_currentSession = currentSession!.copyWith(user: userResponse.user);
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

if access token is null, then the code will never reach the bang operator, hence it should be safe to use it here

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wouldn't say so because there is an async request in between, so the current session can be removed during the request.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe im missing something, but that request cant modify the currentSession variable.
If im not wrong, that call would fail if the session or accessToken is not valid and throw an Exception, but never reach the bang operator.
Anyway, the main point of this PR is too delete a variable that is never actually used, we can leave the null-aware operator

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah the request itself doesn't change the currentSession, but while the request is going a signout or something else could happen that sets the currentSession to null

notifyAllSubscribers(AuthChangeEvent.userUpdated);

return userResponse;
Expand Down Expand Up @@ -970,7 +966,6 @@ class GoTrueClient {
}

_currentSession = session;
_currentUser = session.user;
notifyAllSubscribers(AuthChangeEvent.initialSession);
}

Expand All @@ -997,7 +992,7 @@ class GoTrueClient {
}
} else {
final shouldEmitEvent = _currentSession == null ||
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

if current session is null, then the second bang operator in the expression will never reach

_currentSession?.user.id != session.user.id;
_currentSession!.user.id != session.user.id;
_saveSession(session);

if (shouldEmitEvent) {
Expand Down Expand Up @@ -1153,13 +1148,11 @@ class GoTrueClient {
_log.finest('Saving session: $session');
_log.fine('Saving session');
_currentSession = session;
_currentUser = session.user;
}

void _removeSession() {
_log.fine('Removing session');
_currentSession = null;
_currentUser = null;
}

void _mayStartBroadcastChannel() {
Expand Down