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

Bug: [Title] Extra Pop Up After creating new project #399 #407

Closed

Conversation

nickhil-verma
Copy link

@nickhil-verma nickhil-verma commented Jan 15, 2025

Fixes #399

Bug Fix Summary: Extra Pop-Up Issue

  • Before Fix:

    • Two alert boxes appeared when creating a new project:
      • One was the default browser pop-up (from window.onbeforeunload).
      • The other was a custom alert modal popup.
  • After Fix:

    • Removed the window.onbeforeunload function.
    • Added a confirmOption function to prompt user responses.
    • Now, only one popup appears to get user response for creating a new project, eliminating the default browser pop-up.

Screen Recording

2025-01-15.22-31-37.mp4

Summary by CodeRabbit

  • User Interface

    • Enhanced element display in the Elements Panel by adding element names alongside images
    • Improved visual representation of search results and element categories
  • Project Management

    • Removed unsaved changes warning when navigating away from the page
    • Simplified project creation process with updated confirmation logic

Copy link
Contributor

coderabbitai bot commented Jan 15, 2025

Walkthrough

The pull request introduces changes to two files: ElementsPanel.vue and project.ts. In ElementsPanel.vue, new <div> elements are added to display element names within the search results and categories, enhancing the visual representation of elements. In project.ts, modifications are made to the project creation logic, removing the unsaved changes warning and simplifying the new project creation process.

Changes

File Change Summary
src/components/Panels/ElementsPanel/ElementsPanel.vue Added new <div> elements with overflow-hidden text-nowrap position-relative class to display element names in search results and categories
src/simulator/src/data/project.ts Commented out window.onbeforeunload event handler and modified newProject function logic for handling unsaved changes

Assessment against linked issues

Objective Addressed Explanation
Remove Extra Underline from Sign in button [#92] No direct changes related to the sign-in button underline are visible in the provided diff

Poem

🐰 Coding rabbits hop with glee,
Elements now speak, names running free!
Project logic trimmed and neat,
No warnings to make users retreat.
A smoother path through digital space! 🖥️

Finishing Touches

  • 📝 Generate Docstrings (Beta)

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

netlify bot commented Jan 15, 2025

Deploy Preview for circuitverse ready!

Name Link
🔨 Latest commit 9f29538
🔍 Latest deploy log https://app.netlify.com/sites/circuitverse/deploys/6787f2b91c9c3d0008343665
😎 Deploy Preview https://deploy-preview-407--circuitverse.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link
Contributor

@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: 0

🧹 Nitpick comments (2)
src/simulator/src/data/project.ts (2)

158-167: Simplify the complex boolean condition.

The nested boolean conditions are hard to read. Consider extracting the logic into meaningful variables.

-    if (
-        !verify &&
-        (!projectSaved && checkToSave()) &&
-        !(await confirmOption(
-            'What you like to start a new project? Any unsaved changes will be lost.'
-        ))
-    )
+    const hasUnsavedChanges = !projectSaved && checkToSave();
+    const needsConfirmation = !verify && hasUnsavedChanges;
+    if (needsConfirmation && !(await confirmOption(
+        'Would you like to start a new project? Any unsaved changes will be lost.'
+    )))

Also, there's a typo in the confirmation message: "What you like" should be "Would you like".


173-174: Consider using router navigation instead of location.assign.

Using window.location.assign causes a full page reload. Consider using the Vue router for a smoother user experience.

// Example using Vue Router
router.push('/simulatorvue/')
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 6eae6ed and 9f29538.

📒 Files selected for processing (2)
  • src/components/Panels/ElementsPanel/ElementsPanel.vue (3 hunks)
  • src/simulator/src/data/project.ts (2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: Redirect rules - circuitverse
  • GitHub Check: Header rules - circuitverse
  • GitHub Check: Pages changed - circuitverse
🔇 Additional comments (3)
src/simulator/src/data/project.ts (2)

Line range hint 123-178: Implementation successfully addresses the double popup issue.

The changes effectively solve the problem by removing the default browser popup while maintaining the custom confirmation dialog for unsaved changes.


123-139: 🛠️ Refactor suggestion

Remove commented code instead of keeping it.

The commented-out window.onbeforeunload handler should be removed rather than left as comments. If needed, the code history can be referenced through version control.

Verify data loss prevention.

With the removal of the onbeforeunload handler, ensure there are other mechanisms in place to prevent accidental data loss when users navigate away with unsaved changes.

Run this script to check for other data preservation mechanisms:

✅ Verification successful

Removal of commented code is safe - other data preservation mechanisms are active

The codebase has multiple active data preservation mechanisms:

  • User confirmations before destructive actions using checkToSave()
  • Project recovery functionality through recoverProject()
  • Explicit warnings for unsaved changes when starting new projects

You can safely remove the commented-out code as it was causing duplicate warnings.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for other data saving/recovery mechanisms
rg -A 3 "localStorage.setItem.*recover" 
rg "unsaved.*changes"

Length of output: 1619


Script:

#!/bin/bash
# Check for active data preservation mechanisms
ast-grep --pattern 'function checkToSave() { $$$ }'
ast-grep --pattern 'function recoverProject() { $$$ }'
rg -B 2 -A 5 "What you like to start a new project\? Any unsaved changes will be lost\."

Length of output: 2099

src/components/Panels/ElementsPanel/ElementsPanel.vue (1)

128-131: Consider moving UI enhancements to a separate PR.

While the UI improvements are valuable, they are unrelated to the popup issue fix. Consider submitting these changes in a separate PR for better change tracking and review focus.

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.

🐞 Bug: [Title] Extra Pop Up After creating new project
1 participant