Reload schema on environment change

[imolorhe]

Fixes

#2733

Checks

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

Changes proposed in this pull request:

Summary by Sourcery

Implement automatic schema reloading when the environment changes by adding a new setting 'schema.reload.onEnvChange'. Update the test-server package.json to specify yarn as the package manager.

New Features:

• Introduce a feature to reload the schema automatically when the environment changes.

Enhancements:

• Add a new setting 'schema.reload.onEnvChange' to control schema reloading on environment change.

Build:

• Update test-server package.json to specify yarn as the package manager.

[sourcery-ai]

Reviewer's Guide by Sourcery

This PR implements automatic schema reloading when switching environments. The implementation adds a new setting 'schema.reload.onEnvChange' and uses Redux selectors to trigger schema reloads when the environment changes and the setting is enabled.

Sequence diagram for schema reload on environment change

sequenceDiagram
    participant User
    participant Store
    participant WindowComponent
    participant ReduxSelector

    User->>Store: Change environment
    Store->>ReduxSelector: Check 'schema.reload.onEnvChange' setting
    ReduxSelector-->>WindowComponent: Return activeEnvironment if reloadOnChange is true
    alt activeEnvironment is not null
        WindowComponent->>WindowComponent: reloadDocs()
    end

Loading

Updated class diagram for SettingsState interface

classDiagram
    class SettingsState {
        +boolean schema.reloadOnStart
        +boolean schema.reload.onEnvChange
        +boolean disableUpdateNotification
    }
    note for SettingsState "Added 'schema.reload.onEnvChange' attribute"

Loading

File-Level Changes

Change	Details	Files
Added new setting for schema reload on environment change	Added new boolean setting 'schema.reload.onEnvChange' to control schema reload behavior Setting is optional and typed in the SettingsState interface	packages/altair-core/src/types/state/settings.interfaces.ts
Implemented schema reload logic on environment changes	Added new Redux selector to monitor environment and setting changes Added subscription to trigger schema reload when environment changes and setting is enabled Integrated with existing reloadDocs() functionality	packages/altair-app/src/app/modules/altair/containers/window/window.component.ts
Updated test server configuration	Added package manager specification for yarn	test-server/package.json test-server/yarn.lock

Possibly linked issues

• Reload schema on environment change #2733: The PR implements schema reload on environment change, directly addressing the issue's request.

---

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.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a 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. You can also use
  this command to specify where the summary should be inserted.

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 - here's some feedback:

Overall Comments:

• Please update the documentation to describe the new schema.reload.onEnvChange setting and its functionality.

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 f0d911b):

https://altair-gql--pr2742-imolorhe-reload-sche-jvvz7alr.web.app

_{(expires Sun, 22 Dec 2024 18:07:31 GMT)}

_{🔥 via Firebase Hosting GitHub Action 🌎}

_{Sign: 02d6323d75a99e532a38922862e269d63351a6cf}