only use local sandbox if same origin

[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

Bug Fixes:

• Ensure local sandbox is used only if the document's base URI has the same origin as the window location.

[sourcery-ai]

Reviewer's Guide by Sourcery

This PR modifies the sandbox URL handling in Altair to only use a local sandbox when the base URI has the same origin as the current window location. It introduces a new URL parsing utility function to safely handle URL parsing operations.

Updated class diagram for AltairConfig

classDiagram
    class AltairConfig {
        - localSandboxUrl: string | undefined
        - useLocalSandboxUrl: boolean
        + getPossibleLocalSandBoxUrl() URL
    }
    class AltairConfig {
        + parseUrl(url: string) URL | undefined
    }
    note for AltairConfig "parseUrl is a new utility function for safe URL parsing."

Loading

File-Level Changes

Change	Details	Files
Added URL parsing utility function for safe URL handling	Implemented a new parseUrl helper function that safely returns undefined for invalid URLs Function uses try-catch block to handle potential URL parsing errors	packages/altair-core/src/config/index.ts
Modified local sandbox URL resolution logic to check for same-origin	Added origin comparison between document.baseURI and window.location Only returns local sandbox URL if origins match	packages/altair-core/src/config/index.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.
• 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 fill out the PR description with the issue being fixed and explanation of the changes being made.
• Ensure you've completed the PR checklist items (running tests, updating documentation, etc).

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

https://altair-gql--pr2684-imolorhe-only-use-lo-zx07rq8u.web.app

_{(expires Sun, 03 Nov 2024 05:51:52 GMT)}

_{🔥 via Firebase Hosting GitHub Action 🌎}

_{Sign: 02d6323d75a99e532a38922862e269d63351a6cf}