Fixing indentation in the generated configuration (#1663)#1668
Merged
Aniruddh25 merged 1 commit intorelease/0.8from Aug 29, 2023
Merged
Fixing indentation in the generated configuration (#1663)#1668Aniruddh25 merged 1 commit intorelease/0.8from
Aniruddh25 merged 1 commit intorelease/0.8from
Conversation
## Why make this change? - With the overhaul of the config system using our own Write method while serializing objects, the config that is generated is misaligned with respect to indentation for all the keys under each entity name. For e.g.: In the following picture, the entity name `Todo` is indented with 4 leading spaces, subsequently its child key `source` should have been indented with 6 leading spaces, however its currently indented with only 2 spaces.  - This is a regression in 0.8.44-rc. ## What is this change? - Use the same writer to serialize the subkeys under the entity name so that the depth of indentation is maintained. ## How does this change fix the issue? - `WriteRawValue` writes the json string argument provided as is without doing any additional formatting on it. It doesn't utilize the `_currentDepth` private member of the writer to determine how to indent. - Prior to this change, we were generating the inner json string first then writing the generated inner json "as is". While generating that json on line 29 https://github.com/Azure/data-api-builder/blob/31b754251832ffebf4c4ce36ffcbead9baff6355/src/Config/Converters/RuntimeEntitiesConverter.cs#L29 Line 29 in [31b7542](31b7542) a new writer is being used by the `JsonSerializer.Serialize()` function, effectively resetting the `_currentDepth`. The `_currentDepth` of the writer in context was not getting honored. ## How was this tested? - Manual test, building solution and using `dab add` to simulate automatic writing of an entity to the config file. With the change, the indentation is fixed. 
Aniruddh25
requested review from
JelteF,
Mathos1432,
aaronburtle,
aaronpowell,
abhishekkumams,
ayush3797,
gledis69,
mbhaskar,
milismsft,
ravishetye,
seantleonard,
severussundar and
tarazou9
as code owners
seantleonard
approved these changes
Aug 29, 2023
severussundar
approved these changes
Aug 29, 2023
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
3 participants
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 make this change?
In the following picture, the entity name
Todois indented with 4 leading spaces, subsequently its child keysourceshould have been indented with 6 leading spaces, however its currently indented with only 2 spaces.What is this change?
How does this change fix the issue?
WriteRawValuewrites the json string argument provided as is without doing any additional formatting on it. It doesn't utilize the_currentDepthprivate member of the writer to determine how to indent.Prior to this change, we were generating the inner json string first then writing the generated inner json "as is". While generating that json on line 29
data-api-builder/src/Config/Converters/RuntimeEntitiesConverter.cs
Line 29 in 31b7542
Line 29 in
31b7542
a new writer is being used by the
JsonSerializer.Serialize()function, effectively resetting the_currentDepth. The_currentDepthof the writer in context was not getting honored.How was this tested?
dab addto simulate automatic writing of an entity to the config file. With the change, the indentation is fixed.