Fixed neighborhood name commas breaking csv formatting #3392
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
misaugstad
reviewed
Sep 29, 2023
| @@ -147,7 +147,9 @@ class ProjectSidewalkAPIController @Inject()(implicit val env: Environment[User, | |||
| writer.println(header) | |||
| // Write each row in the CSV. | |||
| for (current <- GlobalAttributeTable.getGlobalAttributesWithLabelsInBoundingBox(minLat, minLng, maxLat, maxLng, severity)) { | |||
| writer.println(current.attributesToArray.mkString(",")) | |||
| val rowArr: Array[String] = current.attributesToArray | |||
| rowArr(6) = "\"" + rowArr(6) + "\"" | |||
There was a problem hiding this comment.
Let's try our best not to rely on knowing which index in the array to use for the neighborhood name. Is there a more programmatic way that we can do it, like adding the quotes in the attributesToArray method?
|
@misaugstad Adjusted the commit to add quotes through the attributesToArray methods, everything's been tested again the same way! |
Merged
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.
Resolves #3390
Neighborhood names containing commas would break the CSV file formatting, acting as an unintended delimiter. This PR adds double quotes around each instance of neighborhood names being referenced in CSV files, namely in these API calls:
Before/After screenshots (if applicable)
Before:
After:
Testing instructions
localhost:9000/v2/access/attributes?lat1=<x1>&lng1=<y1>&lat2=<x2>&lng2=<y2>&filetype=csvlocalhost:9000/v2/access/attributesWithLabels?lat1=<x1>&lng1=<y1>&lat2=<x2>&lng2=<y2>&filetype=csvlocalhost:9000/v2/access/score/neighborhoods?lat1=<x1>&lng1=<y1>&lat2=<x2>&lng2=<y2>&filetype=csva. If you have coordinates with a known neighborhood with commas in the name, use that instead! (i.e. https://sidewalk-chicago.cs.washington.edu/v2/access/attributes?lat1=41.863085&lng1=-87.661878&lat2=41.874468&lng2=-87.646729&filetype=csv on the Chicago database)
Things to check before submitting the PR