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

SchemaJSRenderer renders invalid Javascript #5607

Merged
merged 4 commits into from Nov 22, 2017

Conversation

steffann
Copy link
Contributor

@steffann steffann commented Nov 18, 2017

Under Py3 the base64.b64encode() method returns a binary object, which gets rendered as b'...' in schema.js. This results in the output becoming:

var coreJSON = window.atob('b'eyJf...'');

which is invalid Javascript. Because base64 only uses ASCII characters it is safe to decode('ascii') it. Under Py2 this will result in a unicode object, which is fine. Under Py3 it results in a string, which is also fine. This solves the problem and results in a working schema.js output.

refs #5608

Under Py3 the base64.b64encode() method returns a binary object, which gets rendered as `b'...'` in schema.js. This results in the output becoming:

    var coreJSON = window.atob('b'eyJf...'');

which is invalid Javascript. Because base64 only uses ASCII characters it is safe to decode('ascii') it. Under Py2 this will result in a unicode object, which is fine. Under Py3 it results in a string, which is also fine. This solves the problem and results in a working schema.js output.
Copy link
Collaborator

@carltongibson carltongibson left a comment

Hi @steffann. Thanks for the report and the PR here.

Is there any chance you can add a quick unit test catching the bad behaviour here?

@carltongibson carltongibson added this to the v3.7.4 milestone Nov 20, 2017
@steffann
Copy link
Contributor Author

steffann commented Nov 20, 2017

Good point, will do!

@steffann
Copy link
Contributor Author

steffann commented Nov 22, 2017

And done

Copy link
Collaborator

@carltongibson carltongibson left a comment

Looks good. Great!

@carltongibson carltongibson merged commit d71bd57 into encode:master Nov 22, 2017
pchiquet pushed a commit to pchiquet/django-rest-framework that referenced this pull request Nov 17, 2020
* SchemaJSRenderer renders invalid Javascript

Under Py3 the base64.b64encode() method returns a binary object, which gets rendered as `b'...'` in schema.js. This results in the output becoming:

    var coreJSON = window.atob('b'eyJf...'');

which is invalid Javascript. Because base64 only uses ASCII characters it is safe to decode('ascii') it. Under Py2 this will result in a unicode object, which is fine. Under Py3 it results in a string, which is also fine. This solves the problem and results in a working schema.js output.

* Add regression test for encode#5608

* Add regression test for encode#5608

* Apparently the linter on Travis wants the imports in a different order than on my box...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants