NIAD-2851: Remove unexplained call to handleObservationStatement #722
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
adrianclay
force-pushed
the
NIAD-2851-remove-duplicate-iteration-over-observation-statements
branch
3 times, most recently
from
68e90f5 to
ece7b75
Compare
adrianclay
changed the title
adrianclay
force-pushed
the
NIAD-2851-remove-duplicate-iteration-over-observation-statements
branch
from
ece7b75 to
95135d6
Compare
A BATTERY CompoundStatement can only have two types of component inside it according to the GP2GP specification. These are: - A CLUSTER CompoundStatement - An ObservationStatement The existing code within handleBatteryCompoundStatement deals with each of those cases already. The additional code removed in this change appears to deal with any type of CompoundStatement. Given that the only CompoundStatement which is valid to appear here is a CLUSTER, and the code for handleClusterCompoundStatement already calls handleObservationStatement, there is no point to this code. By removing this duplicate call to handleObservationStatement we also fix the issue where Observations are being generated with two identical "category" values of "Laboratory". Furthermore, this code is completely untested. It is a liability in its current state, so the removal of it reduces the chance of it breaking and introducing more unwelcome unintended side-effects.
adrianclay
force-pushed
the
NIAD-2851-remove-duplicate-iteration-over-observation-statements
branch
from
95135d6 to
74b1352
Compare
ole4ryb
approved these changes
Jul 25, 2024
adrianclay
deleted the
NIAD-2851-remove-duplicate-iteration-over-observation-statements
branch
6 tasks
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.
Why
A BATTERY CompoundStatement can only have two types of component inside it according to the GP2GP specification. These are:
The existing code within handleBatteryCompoundStatement deals with each of those cases already. The additional code removed in this change appears to deal with any type of CompoundStatement. Given that the only CompoundStatement which is valid to appear here is a CLUSTER, and the code for handleClusterCompoundStatement already calls handleObservationStatement, there is no point to this code.
By removing this duplicate call to handleObservationStatement we also fix the issue where Observations are being generated with two identical "category" values of "Laboratory".
Furthermore, this code is completely untested. It is a liability in its current state, so the removal of it reduces the chance of it breaking and introducing more unwelcome unintended side-effects.
Type of change
Bug fix (non-breaking change which fixes an issue)
Checklist: