Skip to content
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.

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

Refactor authentication handling and remove unused token validation l… #2378

Merged
merged 1 commit into from
Jan 15, 2025

Conversation

Mozart299
Copy link
Contributor

@Mozart299 Mozart299 commented Jan 15, 2025

…ogic

Summary of Changes (What does this PR do?)

  • Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.

Status of maturity (all need to be checked before merging):

  • I've tested this locally
  • I consider this code done
  • This change ready to hit production in its current state
  • The title of the PR states what changed and the related issues number (used for the release note).
  • I've included issue number in the "Closes #ISSUE-NUMBER" part of the "What are the relevant tickets?" section to link the issue.
  • I've updated corresponding documentation for the changes in this PR.
  • I have written unit and/or e2e tests for my change(s).

How should this be manually tested?

  • Please include the steps to be done inorder to setup and test this PR.

What are the relevant tickets?

Screenshots (optional)

Summary by CodeRabbit

  • Authentication Flow

    • Simplified authentication process
    • Removed detailed error handling for token retrieval
    • Streamlined navigation between welcome and main screens
  • Deprecation

    • Removed token validation checks

@Mozart299 Mozart299 requested a review from Baalmart January 15, 2025 12:18
Copy link

coderabbitai bot commented Jan 15, 2025

📝 Walkthrough

Walkthrough

The pull request introduces modifications to the authentication flow in the main.dart file. The changes simplify the error handling and token validation process within the Decider widget. The new implementation reduces the complexity of token retrieval, removing specific error handling mechanisms and the isValidToken function. The authentication flow now directly navigates to either the WelcomeScreen or NavPage based on the token's presence, with a more generic approach to handling connection states.

Changes

File Change Summary
mobile-v3/lib/main.dart - Removed detailed error handling in FutureBuilder
- Eliminated isValidToken function
- Simplified navigation logic based on token presence

Suggested labels

ready for review

Suggested reviewers

  • Baalmart

Possibly related PRs

Poem

🚀 Tokens dance, complexity fades away
Error handling takes a lighter sway
From intricate checks to simple flow
Authentication's new, streamlined glow
Code simplified, journey clear and bright 🔑


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai or @coderabbitai title anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 2

🧹 Nitpick comments (1)
mobile-v3/lib/main.dart (1)

169-174: Add logging for authentication flow

The removal of logging makes it harder to debug authentication issues in production.

Consider adding strategic log points:

 if (snapshot.connectionState == ConnectionState.done) {
   if (!snapshot.hasData) {
+    logInfo('No authentication token found, redirecting to welcome screen');
     return WelcomeScreen();
   } else {
+    logInfo('Authentication token found, proceeding to main navigation');
     return NavPage();
   }
 }
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 544b88a and d43052a.

📒 Files selected for processing (1)
  • mobile-v3/lib/main.dart (1 hunks)

Comment on lines +169 to +174
if (snapshot.connectionState == ConnectionState.done) {
if (!snapshot.hasData) {
return WelcomeScreen();
} else {
return NavPage();
}
Copy link

Choose a reason for hiding this comment

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

⚠️ Potential issue

Consider adding token validation before navigation

The simplified authentication flow might expose security vulnerabilities. Currently, any non-null token value will trigger navigation to NavPage without validation.

Consider adding basic token validation:

 if (snapshot.connectionState == ConnectionState.done) {
   if (!snapshot.hasData) {
     return WelcomeScreen();
   } else {
+    final token = snapshot.data!;
+    if (!isJwtValid(token)) {
+      HiveRepository.deleteData('token', HiveBoxNames.authBox);
+      return WelcomeScreen();
+    }
     return NavPage();
   }
 }

Add this helper function:

bool isJwtValid(String token) {
  try {
    final parts = token.split('.');
    if (parts.length != 3) return false;
    
    final payload = json.decode(
      utf8.decode(base64Url.decode(base64Url.normalize(parts[1])))
    );
    
    final expiry = DateTime.fromMillisecondsSinceEpoch(payload['exp'] * 1000);
    return DateTime.now().isBefore(expiry);
  } catch (e) {
    return false;
  }
}

} else {
logInfo('Authentication token found. Navigating to NavPage');
return NavPage();
return Scaffold(body: Center(child: Text('An Error occured.')));
Copy link

Choose a reason for hiding this comment

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

🛠️ Refactor suggestion

Enhance error handling for better user experience

The generic error message provides little context to users and no recovery options.

Consider implementing a more informative error screen:

-return Scaffold(body: Center(child: Text('An Error occured.')));
+return Scaffold(
+  body: Center(
+    child: Column(
+      mainAxisAlignment: MainAxisAlignment.center,
+      children: [
+        Text(
+          'Unable to verify your session',
+          style: Theme.of(context).textTheme.titleLarge,
+        ),
+        const SizedBox(height: 16),
+        ElevatedButton(
+          onPressed: () => setState(() {}),
+          child: Text('Retry'),
+        ),
+        TextButton(
+          onPressed: () {
+            HiveRepository.deleteData('token', HiveBoxNames.authBox);
+            Navigator.of(context).pushReplacement(
+              MaterialPageRoute(builder: (_) => WelcomeScreen()),
+            );
+          },
+          child: Text('Return to Login'),
+        ),
+      ],
+    ),
+  ),
+);

Committable suggestion skipped: line range outside the PR's diff.

@Baalmart Baalmart merged commit 7485e58 into staging Jan 15, 2025
31 checks passed
@Baalmart Baalmart deleted the login-session-fix branch January 15, 2025 12:26
@Baalmart Baalmart mentioned this pull request Jan 15, 2025
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants