feat(studio): warn if studio is imported but not initialized - #525
Open
0xTHAC0 wants to merge 1 commit into
Open
feat(studio): warn if studio is imported but not initialized#5250xTHAC0 wants to merge 1 commit into
0xTHAC0 wants to merge 1 commit into
Conversation
Addresses theatre-js#21 — warn when @theatre/studio is imported but studio.initialize() is not called. Changes: - Extract initialization warning logic into InitWarning class for testability - Increase timeout from 100ms to 5s to allow framework setup time - Use console.warn instead of console.error (it's a warning, not an error) - Clear the timer when initialize() is called (previously only checked a flag) - Add 5 unit tests covering: warning fires, warning suppressed by initialize(), timer cleared, late initialization warning, and idempotent initialize() Co-Authored-By: Paperclip <noreply@paperclip.ing>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Addresses #21 — adds a helpful
console.warnwhen@theatre/studiois imported butstudio.initialize()is never called within 5 seconds.What changed
InitWarningclass (initWarning.ts) for testabilityconsole.error→console.warnsince this is a warning, not an errorclearTimeout()wheninitialize()is called (previously only checked a boolean flag)initialize()is called before timeoutinitialize()initialize()is called after timeoutinitialize()is idempotent (returns false on second call)Behavior
@theatre/studiois imported, a 5-second timer startsstudio.initialize()is called before the timer fires, the timer is cleared — no warninginitialize()being called, aconsole.warnexplains how to fix itinitialize()is called after the warning, a second message notes the late initializationTest plan
yarn test— all existing tests pass (18 suites, 242 tests)