[WEB-2868] fix: Handle Hyper Mode toggling better.

[SatishGandham]

Summary by CodeRabbit

• New Features

  • Enhanced storage clearing functionality with a new optional parameter.
  • Introduced a utility function to check if the browser is Chrome.

• Bug Fixes

  • Improved error handling for database queries to prevent runtime errors.

• Chores

  • Updated method calls to utilize the new storage clearing functionality during user sign-out.

[coderabbitai]

Walkthrough

The pull request introduces modifications to storage management and error handling across multiple files in the local database and user store modules. The changes primarily focus on enhancing the clearStorage and clearOPFS functions by adding a force parameter, improving error resilience in database query operations, and introducing a utility function to detect Chrome browsers. These updates aim to provide more flexible and robust storage clearing mechanisms while preventing potential runtime errors during database interactions.

Changes

File	Changes
web/core/local-db/storage.sqlite.ts	- Updated clearStorage method signature to include force parameter - Added optional chaining for this.db.close()
web/core/local-db/utils/load-workspace.ts	- Enhanced error handling for database query result mapping - Added null/undefined checks in sync functions for labels, modules, cycles, states, and members
web/core/local-db/utils/utils.ts	- Modified clearOPFS function to support force parameter - Added isChrome utility function to detect Chrome browser
web/core/store/user/index.ts	- Updated signOut method to call clearStorage(true)

Sequence Diagram

sequenceDiagram
    participant User
    participant UserStore
    participant Persistence
    participant StorageManager
    participant BrowserStorage

    User->>UserStore: signOut()
    UserStore->>Persistence: clearStorage(true)
    Persistence->>StorageManager: clearOPFS(force)
    StorageManager->>BrowserStorage: Remove entries
    Note over StorageManager: Check browser type
    Note over StorageManager: Conditional forced removal

Loading

Poem

🐰 A Rabbit's Ode to Storage Might

Clearing data with a forceful plight,
Chrome and locks, we set things right,
Null checks dancing, errors take flight,
Our database sings with pure delight!

🗂️ Hop, hop, hooray! 🎉

Tip

CodeRabbit's docstrings feature is now available as part of our Early Access Program! Simply use the command @coderabbitai generate docstrings to have CodeRabbit automatically generate docstrings for your pull request. We would love to hear your feedback on Discord.

---

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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 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.

[coderabbitai]

Actionable comments posted: 1

🧹 Nitpick comments (2)

web/core/local-db/utils/utils.ts (1)

168-205: Add error handling for root.values() iteration.

The function handles errors well for individual operations but doesn't catch errors that might occur during the iteration of root.values().

 export const clearOPFS = async (force = false) => {
   const storageManager = window.navigator.storage;
   const root = await storageManager.getDirectory();

   if (force && isChrome()) {
     await (root as any).remove({ recursive: true });
     return;
   }
-  // ts-ignore
-  for await (const entry of root.values()) {
+  try {
+    for await (const entry of root.values()) {
       if (entry.kind === "directory" && entry.name.startsWith(".ahp-")) {
         // ... existing code ...
       } else {
         root.removeEntry(entry.name);
       }
     }
+  } catch (error) {
+    console.error("Error during storage cleanup:", error);
+  }
 };

web/core/local-db/storage.sqlite.ts (1)

62-68: Consider enhancing error handling and return value.

The current error handling is quite generic. Consider these improvements:

1. Return a boolean to indicate success/failure
2. Log specific error types for better debugging
3. Consider throwing specific errors for critical failures that should interrupt the calling flow

-  clearStorage = async (force = false) => {
+  clearStorage = async (force = false): Promise<boolean> => {
     try {
       await this.db?.close();
       await clearOPFS(force);
       this.reset();
+      return true;
     } catch (e) {
-      console.error("Error clearing sqlite sync storage", e);
+      const error = e instanceof Error ? e : new Error('Unknown error');
+      console.error("Error clearing sqlite sync storage:", {
+        error: error.message,
+        type: error.name,
+        stack: error.stack
+      });
+      return false;
     }
   };

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 1a715c9 and d037a6c.

📒 Files selected for processing (4)

• web/core/local-db/storage.sqlite.ts (1 hunks)
• web/core/local-db/utils/load-workspace.ts (5 hunks)
• web/core/local-db/utils/utils.ts (1 hunks)
• web/core/store/user/index.ts (1 hunks)

🔇 Additional comments (4)

web/core/store/user/index.ts (1)

234-234: LGTM! Forcing storage clear during sign out is appropriate.

The change ensures complete cleanup of storage during sign out.

web/core/local-db/utils/load-workspace.ts (1)

112-112: LGTM! Good defensive programming with null checks.

The added null checks before mapping over database results prevent potential runtime errors. This pattern is consistently applied across all sync functions:

• syncLabels
• syncModules
• syncCycles
• syncStates
• syncMembers

Also applies to: 143-143, 170-170, 197-197, 224-224

web/core/local-db/storage.sqlite.ts (2)

64-64: LGTM! Good use of optional chaining.

The addition of optional chaining (?.) for db.close() improves safety by preventing runtime errors when db is null, which can happen after calling reset().

---

62-65: Verify the usage and implementation of force parameter.

The new force parameter affects storage clearing behavior. Let's verify its usage and implementation:

✅ Verification successful

Based on the results, I can now generate the final response as we have sufficient information about both the usage and implementation of the force parameter.

Force parameter implementation is correct and used appropriately

The force parameter is properly implemented and used in specific scenarios:

• Used with true during sign-out operations in web/core/store/user/index.ts
• Default false value used in regular workspace switching in settings.store.ts
• Implementation in clearOPFS shows it performs a complete recursive removal of OPFS storage in Chrome browsers when force is true, while doing selective cleanup otherwise

The implementation aligns with typical storage management patterns where forced cleanup is reserved for complete user session termination.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check usage of clearStorage with force parameter and implementation of clearOPFS

# Check for clearStorage calls with force parameter
echo "Checking clearStorage calls:"
rg -A 2 "clearStorage\(" 

# Check implementation of clearOPFS
echo "Checking clearOPFS implementation:"
rg -A 10 "clearOPFS\s*=\s*async"

Length of output: 1369

[coderabbitai]

🛠️ Refactor suggestion

Consider using feature detection instead of user agent sniffing.

Browser detection through user agent strings is unreliable as they can be spoofed. Consider using feature detection instead.

-export const isChrome = () => {
-  const userAgent = navigator.userAgent;
-  return userAgent.includes("Chrome") && !userAgent.includes("Edg") && !userAgent.includes("OPR");
-};
+export const isChrome = () => {
+  // Feature detection for Chrome-specific features
+  return !!(window.chrome && window.chrome.webstore === undefined && window.chrome.runtime);
+};

📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change

	export const isChrome = () => {
	const userAgent = navigator.userAgent;
	const isChrome = userAgent.includes("Chrome") && !userAgent.includes("Edg") && !userAgent.includes("OPR");
	return userAgent.includes("Chrome") && !userAgent.includes("Edg") && !userAgent.includes("OPR");
	};
	export const isChrome = () => {
	// Feature detection for Chrome-specific features
	return !!(window.chrome && window.chrome.webstore === undefined && window.chrome.runtime);
	};