Several minor improvements to the app

[imolorhe]

Addressing improvements from user feedback

• Compute the window-in-collection state instead of storing in store
• Only save current window to collection and don't overwrite other unsaved windows
• Stop toggling variable dialog when saving to collection

Fixes

Checks

• Ran yarn test-build
• Updated relevant documentations
• Updated matching config options in altair-static

Changes proposed in this pull request:

Summary by Sourcery

Improve the window management by dynamically computing the window-in-collection state, preventing unnecessary toggling of the variable dialog, and ensuring only the current window is saved to the collection. Introduce a feature to detect unsaved changes in windows.

New Features:

• Introduce a method to check if a window has unsaved changes by comparing the current state with the saved state in the collection.

Bug Fixes:

• Fix the issue where the variable dialog was toggled unnecessarily when saving to a collection.

Enhancements:

• Compute the window-in-collection state dynamically instead of storing it in the store.
• Ensure only the current window is saved to the collection without overwriting other unsaved windows.

[sourcery-ai]

Reviewer's Guide by Sourcery

This pull request refactors the handling of window states in the Altair app by computing the window-in-collection state dynamically, removing unnecessary dialog toggles, and ensuring only the current window is saved to the collection. It also introduces a utility function to check for unsaved changes and updates the UI components to reflect these changes.

Updated class diagram for WindowService and related components

classDiagram
    class WindowService {
        +setupWindow(windowId: string)
        -isWindowInCollection(windowId: string)
        -windowHasUnsavedChanges(windowId: string)
    }
    class WindowSwitcherComponent {
        +isWindowInCollection(windowId: string)
        +windowHasUnsavedChanges(windowId: string)
    }
    class HeaderComponent {
        +collections: IQueryCollection[]
    }
    class WindowsEffects {
        +windowHasUnsavedChanges(windowState: PerWindowState, collections: IQueryCollection[]): boolean
    }
    class QueryCollectionEffects {
        +LoadCollectionsAction()
    }
    WindowService --> WindowSwitcherComponent : uses
    WindowService --> WindowsEffects : uses
    WindowSwitcherComponent --> HeaderComponent : uses
    WindowsEffects --> QueryCollectionEffects : uses
    note for WindowService "Removed ToggleVariableDialogAction and collection validation logic"
    note for WindowSwitcherComponent "Added methods to check window collection state and unsaved changes"
    note for HeaderComponent "Added collections input"
    note for WindowsEffects "Refactored to use windowHasUnsavedChanges utility"
    note for QueryCollectionEffects "Added LoadCollectionsAction"

Loading

File-Level Changes

Change	Details	Files
Refactor window state management to compute window-in-collection state dynamically.	Removed logic that validated if a query is in an existing collection from the setupWindow method. Introduced a new method isWindowInCollection to check if a window is part of a collection. Updated the window-switcher component to use the new isWindowInCollection method.	packages/altair-app/src/app/modules/altair/services/window.service.ts packages/altair-app/src/app/modules/altair/components/window-switcher/window-switcher.component.ts packages/altair-app/src/app/modules/altair/components/window-switcher/window-switcher.component.html
Remove unnecessary toggling of the variable dialog when saving to a collection.	Deleted the dispatch of ToggleVariableDialogAction from the window service.	packages/altair-app/src/app/modules/altair/services/window.service.ts
Ensure only the current window is saved to the collection without overwriting other unsaved windows.	Added a utility function windowHasUnsavedChanges to check for unsaved changes in a window. Refactored the selectHasUnsavedChanges selector to use the new utility function. Updated the WindowsEffects to prevent overwriting unsaved windows.	packages/altair-app/src/app/modules/altair/store/windows/selectors.ts packages/altair-app/src/app/modules/altair/store/index.ts packages/altair-app/src/app/modules/altair/effects/windows.effect.ts
Update UI components to reflect changes in window state management.	Added collections as an input to the header and window-switcher components. Updated the header component HTML to pass collections to the window-switcher. Added an unsaved changes indicator in the window-switcher component.	packages/altair-app/src/app/modules/altair/components/header/header.component.html packages/altair-app/src/app/modules/altair/components/window-switcher/window-switcher.component.html packages/altair-app/src/app/modules/altair/containers/altair/altair.component.html packages/altair-app/src/app/modules/altair/components/header/header.component.ts

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it. You can also reply to a
  review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time. You can also comment
  @sourcery-ai title on the pull request to (re-)generate the title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time exactly where you
  want it. You can also comment @sourcery-ai summary on the pull request to
  (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull
  request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
  pull request to resolve all Sourcery comments. Useful if you've already
  addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
  request to dismiss all existing Sourcery reviews. Especially useful if you
  want to start fresh with a new review - don't forget to comment
  @sourcery-ai review to trigger a new review!
• Generate a plan of action for an issue: Comment @sourcery-ai plan on
  an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[sourcery-ai]

Hey @imolorhe - I've reviewed your changes and they look great!

Here's what I looked at during the review

• 🟢 General issues: all looks good
• 🟢 Security: all looks good
• 🟢 Testing: all looks good
• 🟢 Complexity: all looks good
• 🟢 Documentation: all looks good

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}

[github-actions]

Visit the preview URL for this PR (updated for commit d87425c):

https://altair-gql--pr2770-imolorhe-several-imp-tfk3t54o.web.app

_{(expires Thu, 27 Feb 2025 00:21:27 GMT)}

_{🔥 via Firebase Hosting GitHub Action 🌎}

_{Sign: 02d6323d75a99e532a38922862e269d63351a6cf}