fix(export platform): fixing infinite loop when there are reference errors #531
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
chazzmoney
reviewed
Feb 2, 2021
lib/exportPlatform.js
Outdated
| const transformed = transformObject(exportableResult, platformConfig, transformationContext); | ||
|
|
||
| // referenced values, that have not (yet) been transformed should be excluded from resolving | ||
| const ignorePathsToResolve = deferredPropValueTransforms.map(p => getName([p, 'value'])); | ||
| exportableResult = resolveObject(transformed, {ignorePaths: ignorePathsToResolve}); | ||
|
|
||
| console.log(transformationsCountBefore, transformedPropRefs.length, deferredPropValueTransforms.length); |
There was a problem hiding this comment.
I think this was an accidental include of some debug code?
There was a problem hiding this comment.
Right you are. This is why I need my code to be reviewed.
chazzmoney
reviewed
Feb 2, 2021
lib/exportPlatform.js
Outdated
Comment on lines
104
to
111
| if ( | ||
| // if there is no deferred value transforms left we are done | ||
| deferredPropValueTransforms.length === 0 || | ||
| // or if we didn't transform anything since the last loop. | ||
| // This would happen if a token reference is not found or is circular | ||
| // because we keep the broken reference | ||
| transformedPropRefs.length === transformationsCountBefore | ||
| ) { |
There was a problem hiding this comment.
I trust your logic, and it makes sense... but it seems unintuitive to me that this is a solid "or".
chazzmoney
reviewed
Feb 2, 2021
|
Do you think we need to add something to our release notes about the change in output if you have a broken reference? Otherwise, LGTM! |
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.
Issue #, if available: #524
Description of changes: When there were property reference errors (could not find reference or circular reference) Style Dictionary would get caught in an infinite loop. This fixes that by changing the logic of when loop within exportPlatform finishes by checking if it performed any transformations. This is because we keep the reference in the dictionary object when it is erroneous so it would keep thinking there is a deferred transform.
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.