Skip to content
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

Integration(Spotlight): Integration Request for Spotlight. #40

Open
Shubhdeep12 opened this issue Jan 28, 2024 · 3 comments
Open

Integration(Spotlight): Integration Request for Spotlight. #40

Shubhdeep12 opened this issue Jan 28, 2024 · 3 comments

Comments

@Shubhdeep12
Copy link
Contributor

Hi,

I'd like to request the addition of integration support with Spotlightjs (https://spotlightjs.com/about/).

This enhancement would allow users to seamlessly view the Hydration error Overlay directly within the Spotlight overlay after integrating the hydration-overlay with the Spotlight.

Here is the associated GitHub issue for your reference: Link to GitHub Issue

We've also provided a proposed approach in the comments: Link to Comment

I would greatly appreciate your consideration and feedback on this feature request.

Thanks

@Shubhdeep12
Copy link
Contributor Author

I've added the integration support here in this branch - https://github.com/Shubhdeep12/hydration-overlay/tree/feat/spotlight-integration
Let me know your feedback.
Thanks

@samijaber
Copy link
Contributor

Thanks for this attempt! I want to integrate with as many tools as possible.

Looking at your code, there are a few small things that need to happen to merge this code:

  • we can't have spotlight in dependencies. It needs to be a peerDependencies entry, or else everyone will be installing spotlight despite them not needing it
  • Because of that, you can't have a top-level import of @spotlightjs/spotlight: it needs to become a dynamic import in the component.
  • I would like a new integration test added in tests/* that showcases the library working with spotlightjs to make sure everything works well.

If you make these changes, I think we should be good to go!

@Shubhdeep12
Copy link
Contributor Author

On it @samijaber
Thanks for the feedback

samijaber pushed a commit that referenced this issue Jul 30, 2024
Feature Addition: Spotlight Integration in Hydration-Overlay

This pull request introduces an integration of Spotlight into the
hydration-overlay module.

Key Highlights:
- Addressed all necessary conditions outlined in the discussion
[here](#40 (comment)).
- Note: Current integration and tests may not function as expected due
to pending integration support in Spotlight. The implementation is
primed for action once the necessary changes are merged.

Next Steps:
- Track the progress of Hydration-overlay integration in Spotlight
[here](getsentry/spotlight#343).
- Upon completion of Spotlight integration, a simple version update for
the Spotlight package in this repository is all that's needed.
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

No branches or pull requests

2 participants