Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Escape " in JSON generation. #8579

Merged
merged 1 commit into from Nov 3, 2021

Conversation

rtibbles
Copy link
Member

@rtibbles rtibbles commented Nov 2, 2021

Summary

  • Fixes a bug in ancestor JSON generation where any title with " in it would cause invalid JSON to be generated
  • Escapes any textual " during JSON generation
  • Adds test for regression

References

Fixes issue detailed here: #8570 (review)

Reviewer guidance

Rerun ancestor generation in kolibri shell:

from kolibri.core.content.upgrade import metadata_annotation_update
metadata_annotation_update()

Check that the error no longer occurs.


Testing checklist

  • Contributor has fully tested the PR manually
  • If there are any front-end changes, before/after screenshots are included
  • Critical user journeys are covered by Gherkin stories
  • Critical and brittle code paths are covered by unit tests

PR process

  • PR has the correct target branch and milestone
  • PR has 'needs review' or 'work-in-progress' label
  • If PR is ready for review, a reviewer has been added. (Don't use 'Assignees')
  • If this is an important user-facing change, PR or related issue has a 'changelog' label
  • If this includes an internal dependency change, a link to the diff is provided

Reviewer checklist

  • Automated test coverage is satisfactory
  • PR is fully functional
  • PR has been tested for accessibility regressions
  • External dependency files were updated if necessary (yarn and pip)
  • Documentation is updated
  • Contributor is in AUTHORS.md

@rtibbles rtibbles added the TODO: needs review Waiting for review label Nov 2, 2021
@rtibbles rtibbles added this to the 0.15.0 milestone Nov 2, 2021
@rtibbles rtibbles mentioned this pull request Nov 2, 2021
9 tasks
Copy link
Member

@nucleogenesis nucleogenesis left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I found nothing worthwhile that breaks this. Just things like " and """" (but not "" or """...)

The stuff I mentioned in #8570 works just fine.

LGTM!

@rtibbles rtibbles merged commit 7614857 into learningequality:release-v0.15.x Nov 3, 2021
@rtibbles rtibbles deleted the ancestors_fix branch November 3, 2021 00:05
@indirectlylit
Copy link
Contributor

I don't have a specific test case to break this, but just flagging that doing this kind of search/replace may not always work. Is there any risk of a situation similar to this?

#5981

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
TODO: needs review Waiting for review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants