feat: Add cleanup effect for unmounting

jungpaeng commented 4 months ago

This commit adds a useEffect cleanup function to the OverlayProvider component that dispatches a ‘REMOVE_ALL’ action upon unmounting. This ensures that overlays are properly cleaned up during testing scenarios, preventing state leakage and side effects from persistent overlays.

Description

This commit introduces a useEffect cleanup function in the OverlayProvider component that dispatches a 'REMOVE_ALL' action when the component unmounts. This change ensures that all overlays are properly cleaned up during testing scenarios, preventing state leakage and side effects from persistent overlays.

Related Issue: Fixes #63

Changes

Added a useEffect cleanup function in OverlayProvider to dispatch 'REMOVE_ALL' on unmount.

Motivation and Context

This change is necessary to enhance the testability of the OverlayProvider by ensuring overlays do not persist state across tests, which can lead to unpredictable behavior and flaky tests.

How Has This Been Tested?

Screenshots (if appropriate):

Types of changes

[x] 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

[x] 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.
[x] My changes generate no new warnings.
[x] I have added tests that prove my fix is effective or that my feature works.
[x] New and existing unit tests pass locally with my changes.
[ ] Any dependent changes have been merged and published in downstream modules.

Further Comments

vercel[bot] commented 4 months ago

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	Jul 17, 2024 4:39pm

changeset-bot[bot] commented 4 months ago

🦋 Changeset detected

Latest commit: 6ba184eeec88a58056c2cba8af1f64ec344dfcbe

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

This PR includes changesets to release 2 packages

| Name | Type | | -------------------------- | ----- | | overlay-kit | Patch | | @overlay-kit/framer-motion | 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

toss / overlay-kit