8000 fix: Change to allow each overlay provider to have a unique ID by jungpaeng · Pull Request #161 · toss/overlay-kit · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

fix: Change to allow each overlay provider to have a unique ID #161

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 3 commits into from
May 8, 2025
Merged

fix: Change to allow each overlay provider to have a unique ID #161

merged 3 commits into from
May 8, 2025

Conversation

jungpaeng
Copy link
Member
@jungpaeng jungpaeng commented May 8, 2025 •
edited
Loading

Description

This change ensures that each overlay provider is assigned a unique event ID.

Previously, event IDs were shared or reused across overlay providers, which led to potential collisions and ambiguity during event handling.

Related Issue: Fixes #160

Changes

  • Introduced a mechanism to generate and assign unique event IDs per overlay provider.
  • Updated the overlay manager logic to utilize the provider-scoped event ID.

Motivation and Context

Event IDs are used for tracking and managing overlay-related events. When multiple providers share the same ID space, there is a risk of event handling conflicts or incorrect state transitions.

This update eliminates such risks by scoping event IDs to the specific provider, enabling more reliable and maintainable event processing in systems with multiple overlays.

How Has This Been Tested?

  • Manually tested multiple overlay providers by triggering event flows concurrently to verify isolation.
const { OverlayProvider: CustomOverlayProvider, overlay: customOverlay } = experimental_createOverlayContext();

export function Demo() {
  return (
    <CustomOverlayProvider>
      <button
        onClick={() => {
          overlay.open(() => <div>OVERLAY</div>);
        }}
      >
        overlay.open
      </button>
      <button
        onClick={() => {
          customOverlay.open(() => <div>CUSTOM_OVERLAY</div>);
        }}
      >
        customOverlay.open
      </button>
    </CustomOverlayProvider>
  );
}

...

ReactDOM.createRoot(document.getElementById('root')!).render(
  <React.StrictMode>
    <OverlayProvider>
      <Demo />
    </OverlayProvider>
  </React.StrictMode>
);

Screenshots (if appropriate):

2025-05-08.12.53.11.mov

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation update

Checklist

  • I have performed a self-review of my own code.
  • My code is commented, particularly in hard-to-understand areas.
  • I have made corresponding changes to the documentation.
  • My changes generate no new warnings.
  • I have added tests that prove my fix is effective or that my feature works.
  • New and existing unit tests pass locally with my changes.
  • Any dependent changes have been merged and published in downstream modules.

Further Comments

@jungpaeng jungpaeng self-assigned this May 8, 2025
@changeset-bot changeset-bot
Copy link
changeset-bot bot commented May 8, 2025 •
edited
Loading

🦋 Changeset detected

Latest commit: df6ad8a

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
overlay-kit Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@vercel Vercel
Copy link
vercel bot commented May 8, 2025 •
edited
Loading

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
overlay-kit ✅ Ready (Inspect) Visit Preview 💬 Add feedback May 8, 2025 4:00am

@jungpaeng jungpaeng changed the title feat: Change to allow each overlay provider to have a unique event ID fix: Change to allow each overlay provider to have a unique event ID May 8, 2025
@jungpaeng jungpaeng changed the title fix: Change to allow each overlay provider to have a unique event ID fix: Change to allow each overlay provider to have a unique ID May 8, 2025
@codecov-commenter
Copy link
codecov-commenter commented May 8, 2025 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 93.87%. Comparing base (07f42a5) to head (df6ad8a).
Report is 1 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main     #161      +/-   ##
==========================================
- Coverage   94.44%   93.87%   -0.57%     
==========================================
  Files          12       12              
  Lines         342      343       +1     
  Branches       86       85       -1     
==========================================
- Hits          323      322       -1     
- Misses         18       20       +2     
  Partials        1        1
Components Coverage Δ
overlay-kit 93.87% <100.00%> (-0.57%) ⬇️
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@jungpaeng jungpaeng merged commit ec07614 into main May 8, 2025
9 of 10 checks passed
@jungpaeng jungpaeng deleted the fix/custom-overlay-provider-sync-issue branch May 8, 2025 03:59
@github-actions github-actions bot mentioned this pull request May 8, 2025
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees

@jungpaeng jungpaeng

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Two overlays are added to the DOM when opening it
2 participants
@jungpaeng @codecov-commenter
0