fix initialSubscriptionRequestHandlerId not being set

[imolorhe]

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

Fix the handling of subscription request handlers by setting initialSubscriptionRequestHandlerId correctly and removing the deprecated subscriptionProviderId. Update example projects to include necessary type definitions and specify the package manager.

Bug Fixes:

• Fix the issue where initialSubscriptionRequestHandlerId was not being set correctly, ensuring the correct request handler is used for subscriptions.

Enhancements:

• Remove deprecated subscriptionProviderId in favor of subscriptionRequestHandlerId for better clarity and future-proofing.

Build:

• Add @types/express as a development dependency in the express-v4 example package.
• Specify yarn as the package manager in the package.json files for express-v4 and fastify-v5 examples.

[sourcery-ai]

Reviewer's Guide by Sourcery

This PR removes the deprecated subscriptionProviderId field and ensures proper initialization of subscriptionRequestHandlerId. The changes include updating test cases, removing fallback logic, and updating the initial state configuration.

Updated class diagram for QueryState

classDiagram
    class QueryState {
        string editorAlertMessage
        boolean editorAlertSuccess
        string subscriptionConnectionParams
        RequestHandlerIds subscriptionRequestHandlerId
        boolean isSubscribed
        boolean autoscrollResponseList
    }
    note for QueryState "Removed deprecated subscriptionProviderId attribute"

Loading

Updated class diagram for QueryService

classDiagram
    class QueryService {
        +getRequestHandler(window: PerWindowState, isSubscription: boolean)
    }
    note for QueryService "Updated logic to use subscriptionRequestHandlerId instead of subscriptionProviderId"

Loading

File-Level Changes

Change	Details	Files
Remove deprecated subscriptionProviderId field and its related fallback logic	Remove subscriptionProviderId from QueryState interface Remove fallback logic that used subscriptionProviderId in getRequestHandler Remove test case that verified fallback behavior	packages/altair-core/src/types/state/query.interfaces.ts packages/altair-app/src/app/modules/altair/services/query/query.service.ts packages/altair-app/src/app/modules/altair/services/query/query.service.spec.ts
Update references from subscriptionProviderId to subscriptionRequestHandlerId	Replace subscriptionProviderId with subscriptionRequestHandlerId in window service tests Update initial state configuration to use subscriptionRequestHandlerId	packages/altair-app/src/app/modules/altair/services/window.service.spec.ts packages/altair-app/src/app/modules/altair/store/query/query.reducer.ts
Add example configuration for subscription handler	Add initialSubscriptionRequestHandlerId configuration in Express example Update package dependencies and configuration	examples/express-v4/index.ts examples/express-v4/package.json examples/fastify-v5/package.json

Possibly linked issues

• remove .vscode directory and add directory to .gitignore #1: The PR fixes the specific issue of initialSubscriptionRequestHandlerId not being set, related to the issue.
• Autocomplete makes aliasing quite difficult #123: The PR fixes the initialization of subscription handler ID, related to the issue's protocol problem.

---

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 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 861f2d5):

https://altair-gql--pr2741-imolorhe-fix-initial-gwpf6f4y.web.app

_{(expires Sun, 22 Dec 2024 14:13:13 GMT)}

_{🔥 via Firebase Hosting GitHub Action 🌎}

_{Sign: 02d6323d75a99e532a38922862e269d63351a6cf}