Skip to content

Escaping fix broke a number of things (#14145) #14154

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.

Sign up for GitHub

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

Merged
Rich Chiodo (rchiodo) merged 1 commit into from
Sep 29, 2020
Merged

Escaping fix broke a number of things (#14145) #14154

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Escaping fix broke a number of things (#14145) 
* Fixes for escaping

* Push a comment ot start PR again

* Cache task is failing

* Remove cache task

* Not fixing so just put back cache task
  • Loading branch information
@rchiodo
rchiodo committed Sep 29, 2020
commit a520fb71d1cae446ab550c283627dd08f1815479
6 changes: 5 additions & 1 deletion src/client/datascience/jupyter/jupyterDebugger.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@
'use strict';
import type { nbformat } from '@jupyterlab/coreutils';
import { inject, injectable, named } from 'inversify';
// tslint:disable-next-line: no-require-imports
import unescape = require('lodash/unescape');
import * as path from 'path';
import * as uuid from 'uuid/v4';
import { DebugConfiguration, Disposable } from 'vscode';
Expand Down Expand Up @@ -473,8 +475,10 @@ export class JupyterDebugger implements IJupyterDebugger, ICellHashListener {
if (outputs.length > 0) {
const data = outputs[0].data;
if (data && data.hasOwnProperty('text/plain')) {
// Plain text should be escaped by our execution engine. Unescape it so
// we can parse it.
// tslint:disable-next-line:no-any
return (data as any)['text/plain'];
return unescape((data as any)['text/plain']);
}
if (outputs[0].output_type === 'stream') {
const stream = outputs[0] as nbformat.IStream;
Expand Down
7 changes: 6 additions & 1 deletion src/datascience-ui/interactive-common/cellOutput.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -314,7 +314,12 @@ export class CellOutput extends React.Component<ICellOutputProps> {
input = JSON.stringify(output.data);
renderWithScrollbars = true;
isText = true;
} else if (output.output_type === 'execute_result' && input && input.hasOwnProperty('text/plain')) {
} else if (
output.output_type === 'execute_result' &&
input &&
input.hasOwnProperty('text/plain') &&
!input.hasOwnProperty('text/html')
) {
// Plain text should actually be shown as html so that escaped HTML shows up correctly
mimeType = 'text/html';
isText = true;
Expand Down
6 changes: 3 additions & 3 deletions src/test/datascience/notebook.functional.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -182,7 +182,7 @@ suite('DataScience notebook tests', () => {
const error = cell.outputs[0].evalue;
if (error) {
assert.ok(error, 'Error not found when expected');
assert.equal(error, errorString, 'Unexpected error found');
assert.ok(error.toString().includes(errorString), 'Unexpected error found');
}
}

Expand Down Expand Up @@ -757,7 +757,7 @@ suite('DataScience notebook tests', () => {
await server!.waitForIdle(10000);

console.log('Verifying restart');
await verifyError(server, 'a', `name 'a' is not defined`);
await verifyError(server, 'a', `is not defined`);
} catch (exc) {
assert.ok(
exc instanceof JupyterKernelPromiseFailedError,
Expand Down Expand Up @@ -1031,7 +1031,7 @@ a`,
mimeType: 'text/plain',
cellType: 'code',
result: `<a href=f>`,
verifyValue: (d) => assert.equal(d, escape(`<a href=f>`), 'XML not escaped')
verifyValue: (d) => assert.ok(d.includes(escape(`<a href=f>`)), 'XML not escaped')
},
{
markdownRegEx: undefined,
Expand Down