JS: Remove dead state transition validation code #1771
Merged
Conversation
This file contains 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
Soooo, because `this.state` was initialised to `null` and not 'start', this code was always actually dead. `validateStateTransition` had no branch for `oldState` being null, so always returned `false`. This meant `this.state` was *never* set to current state, and so in all callbacks, `oldState` was always `null`! I validated this again by console.logging `oldState` and `newState` inside `validateStateTransition`. Here's the output for when a full build is performed: ``` null -> waiting null -> fetching null -> unknown null -> building null -> failed null -> built null -> launching ``` And for when launching a previously built image ``` null -> launching null -> ready ``` I also put one just above where `this.state` is set, and that code was never called. I was hoping to remove all this code anyway, as it doesn't actually validate nor test anything - that's really done by unit tests and integration tests. I thought this would hide bugs - but turns out, it was a bug itself, and hid nothing. This also changes the signature of the callback for `onChangeState`, dropping `oldState` and `newState`. `oldState` was always `null`, and in our code, we actually don't use `newState` *at all*. The one place that was conditional on `oldState` being null is now unconditional, because `oldState` was always `null`. Ref jupyterhub#774
|
This is one way to get to 100% unit test coverage - just find code that was never used and get rid of it :) |
consideRatio
approved these changes
Oct 9, 2023
consideRatio
added
maintenance
|
Wieee thank you for working this @yuvipanda! |
consideRatio
pushed a commit
to jupyterhub/helm-chart
that referenced
this pull request
Oct 9, 2023
jupyterhub/binderhub#1771 Merge pull request #1771 from yuvipanda/dead-code
manics
reviewed
Oct 9, 2023
| } | ||
| image.onStateChange('built', function() { | ||
| $('#phase-already-built').removeClass('hidden'); | ||
| $('#phase-launching').removeClass('hidden'); | ||
| $('#phase-launching').removeClass('hidden'); |
This was referenced Oct 10, 2023
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.
Soooo, because
this.statewas initialised tonulland not 'start', this code was always actually dead.validateStateTransitionhad no branch foroldStatebeing null, so always returnedfalse. This meantthis.statewas never set to current state, and so in all callbacks,oldStatewas alwaysnull!I validated this again by console.logging
oldStateandnewStateinsidevalidateStateTransition. Here's the output for when a full build is performed:And for when launching a previously built image
I also put one just above where
this.stateis set, and that code was never called.I was hoping to remove all this code anyway, as it doesn't actually validate nor test anything - that's really done by unit tests and integration tests. I thought this would hide bugs - but turns out, it was a bug itself, and hid nothing.
This also changes the signature of the callback for
onChangeState, droppingoldStateandnewState.oldStatewas alwaysnull, and in our code, we actually don't usenewStateat all. The one place that was conditional onoldStatebeing null is now unconditional, becauseoldStatewas alwaysnull.Ref #774