Skip to content

Refactor: Replace jQuery with Vue reactivity in OpenOffline.vue #487

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

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

Conversation

Jay2006sawant
Copy link

@Jay2006sawant Jay2006sawant commented Feb 20, 2025

Fixes #433

cc : @Arnabdaz @JoshVarga


Note: Please check Allow edits from maintainers. if you would like us to assist in the PR.

Summary by CodeRabbit

  • Refactor
    • Enhanced the offline projects dialog for a smoother closing experience.
    • Now displays accurate status messages and button options based on project availability.
    • Ensured the project list refreshes automatically when the dialog opens, providing users with up-to-date information.

Copy link
Contributor

coderabbitai bot commented Feb 20, 2025

Walkthrough

This pull request refactors the close functionality in the OpenOffline.vue component by introducing a dedicated closeDialog function. It updates conditional checks for empty project lists by replacing JSON-based checks with Object.keys methods. The lifecycle hooks (onMounted and onUpdated) have been replaced with a watchEffect to refresh the project list whenever the dialog is opened. Additionally, the deleteOfflineProject function is simplified by directly using projectId, and both openProjectOffline and OpenImportProjectDialog now call closeDialog to centralize close behavior.

Changes

File(s) Change Summary
src/components/DialogBox/OpenOffline.vue - Added a dedicated closeDialog function and updated openProjectOffline & OpenImportProjectDialog to invoke it.
- Updated empty checks from JSON.stringify to Object.keys methods.
- Replaced onMounted/onUpdated with watchEffect for project list updates.
- Simplified deleteOfflineProject by using projectId directly.

Sequence Diagram(s)

sequenceDiagram
    participant User as User
    participant Component as OpenOffline.vue
    participant State as SimulatorState

    User->>Component: Click "Open Project" / "Import Project" button
    Component->>Component: Execute openProjectOffline() / OpenImportProjectDialog()
    Component->>Component: Invoke closeDialog()
    Component->>State: Set dialogBox.open_project_dialog = false
    Note over Component: watchEffect refreshes projectList when dialog opens
Loading

Possibly related PRs

  • Combining Vue Simulator Versioning PRs #337: Addresses similar modifications in the OpenOffline.vue component, specifically in the openProjectOffline and OpenImportProjectDialog functions, ensuring consistent dialog close behavior.

Suggested labels

GSOC'24

Poem

I'm a hopping rabbit, leaping with glee,
Refactoring code by the light of the tree.
The dialog now closes in a swift, neat twist,
While project lists update, like a digital tryst.
With twitchy nose and a joyful heart so free,
I celebrate these changes, happy as can be!


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 Feb 20, 2025

Deploy Preview for circuitverse ready!

Name Link
🔨 Latest commit f9cf2a7
🔍 Latest deploy log https://app.netlify.com/sites/circuitverse/deploys/67b7138b6da788000827404b
😎 Deploy Preview https://deploy-preview-487--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/components/DialogBox/OpenOffline.vue (2)

100-100: Consider consistent function naming.

The function OpenImportProjectDialog should follow camelCase naming convention to be consistent with other functions like openProjectOffline.

-function OpenImportProjectDialog() {
+function openImportProjectDialog() {

81-88: Consider adding type safety improvements.

The functions could benefit from explicit return types and error handling for localStorage operations.

-function deleteOfflineProject(id: string) {
+function deleteOfflineProject(id: string): void {
   try {
     localStorage.removeItem(id)
     const data = localStorage.getItem('projectList')
     const temp = data ? JSON.parse(data) : {}
     delete temp[id]
     projectList.value = temp
     localStorage.setItem('projectList', JSON.stringify(temp))
+  } catch (error) {
+    console.error('Failed to delete offline project:', error)
+  }
 }

-function openProjectOffline() {
+function openProjectOffline(): void {
   closeDialog();
   if (!selectedProjectId.value) return
+  try {
     const projectData = localStorage.getItem(selectedProjectId.value)
     if (projectData) {
       load(JSON.parse(projectData))
       window.projectId = selectedProjectId.value
     }
+  } catch (error) {
+    console.error('Failed to open offline project:', error)
+  }
 }

Also applies to: 90-98

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 1ea73f2 and f9cf2a7.

📒 Files selected for processing (1)
  • src/components/DialogBox/OpenOffline.vue (5 hunks)
🔇 Additional comments (4)
src/components/DialogBox/OpenOffline.vue (4)

13-13: LGTM! Improved dialog close handling.

Centralizing the close logic in a dedicated function improves code maintainability.


35-35: LGTM! Better empty object checks.

Using Object.keys(projectList).length is a more idiomatic and performant way to check for empty objects compared to JSON string comparison.

Also applies to: 43-43


71-76: LGTM! Improved reactivity with watchEffect.

Using watchEffect to update the project list when the dialog opens is a more elegant solution than using lifecycle hooks. This ensures the list is always fresh when needed.


77-79: LGTM! Clean function implementation.

The closeDialog function follows the single responsibility principle and centralizes the dialog closing logic.

@Jay2006sawant Jay2006sawant changed the title Refactor: Replace jQuery with Vue reactivity Refactor: Replace jQuery with Vue reactivity in openOffline.vue Feb 20, 2025
@Jay2006sawant Jay2006sawant changed the title Refactor: Replace jQuery with Vue reactivity in openOffline.vue Refactor: Replace jQuery with Vue reactivity in OpenOffline.vue Feb 20, 2025
@Jay2006sawant
Copy link
Author

@JoshVarga @Arnabdaz PTAL

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.

Removal of JQuery to Vue's reactives
1 participant