Becky Siegel 7fe6a3b4cc Don't show binary image content & fix image label
Previously there were times when binary data from an image diff would
display. This change adds a check in the diff processor for image diffs
and does not display anything other than the file line in that case.

This change also addresses an issue where the label is calculated too
soon. The image size (if it exists) is supposed to be included as part
of the label, but often this was calculated before the image was done
rendering, so it didn't display.

Bug: Issue 5887
Change-Id: I9cd1ad0c3f2603492d7d84892147bd6852bbae29
2017-03-31 10:11:16 -07:00

781 lines
27 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html>
<!--
Copyright (C) 2015 The Android Open Source Project
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
<meta name="viewport" content="width=device-width, minimum-scale=1.0, initial-scale=1.0, user-scalable=yes">
<title>gr-diff</title>
<script src="../../../bower_components/webcomponentsjs/webcomponents-lite.min.js"></script>
<script src="../../../bower_components/web-component-tester/browser.js"></script>
<script src="../../../scripts/util.js"></script>
<link rel="import" href="../../../bower_components/iron-test-helpers/iron-test-helpers.html">
<link rel="import" href="../../shared/gr-rest-api-interface/mock-diff-response_test.html">
<link rel="import" href="gr-diff.html">
<script>void(0);</script>
<test-fixture id="basic">
<template>
<gr-diff></gr-diff>
</template>
</test-fixture>
<script>
suite('gr-diff tests', function() {
var element;
var sandbox;
setup(function() {
sandbox = sinon.sandbox.create();
});
teardown(function() {
sandbox.restore();
});
suite('not logged in', function() {
setup(function() {
stub('gr-rest-api-interface', {
getLoggedIn: function() { return Promise.resolve(false); },
});
element = fixture('basic');
});
test('toggleLeftDiff', function() {
element.toggleLeftDiff();
assert.isTrue(element.classList.contains('no-left'));
element.toggleLeftDiff();
assert.isFalse(element.classList.contains('no-left'));
});
test('addDraftAtLine', function(done) {
sandbox.stub(element, '_selectLine');
var loggedInErrorSpy = sandbox.spy();
element.addEventListener('show-auth-required', loggedInErrorSpy);
element.addDraftAtLine();
flush(function() {
assert.isTrue(loggedInErrorSpy.called);
done();
});
});
test('view does not start with displayLine classList', function() {
assert.isFalse(
element.$$('.diffContainer').classList.contains('displayLine'));
});
test('displayLine class added called when displayLine is true',
function() {
var spy = sandbox.spy(element, '_computeContainerClass');
element.displayLine = true;
assert.isTrue(spy.called);
assert.isTrue(
element.$$('.diffContainer').classList.contains('displayLine'));
});
test('get drafts', function(done) {
element.patchRange = {basePatchNum: 0, patchNum: 0};
var getDraftsStub = sandbox.stub(element.$.restAPI, 'getDiffDrafts');
element._getDiffDrafts().then(function(result) {
assert.deepEqual(result, {baseComments: [], comments: []});
sinon.assert.notCalled(getDraftsStub);
done();
});
});
test('get robot comments', function(done) {
element.patchRange = {basePatchNum: 0, patchNum: 0};
var getDraftsStub = sandbox.stub(element.$.restAPI,
'getDiffRobotComments');
element._getDiffDrafts().then(function(result) {
assert.deepEqual(result, {baseComments: [], comments: []});
sinon.assert.notCalled(getDraftsStub);
done();
});
});
test('loads files weblinks', function(done) {
var diffStub = sandbox.stub(element.$.restAPI, 'getDiff').returns(
Promise.resolve({
meta_a: {
web_links: 'foo',
},
meta_b: {
web_links: 'bar',
},
}));
element.patchRange = {};
element._getDiff().then(function() {
assert.deepEqual(element.filesWeblinks, {
meta_a: 'foo',
meta_b: 'bar',
});
done();
});
});
test('remove comment', function() {
element._comments = {
meta: {
changeNum: '42',
patchRange: {
basePatchNum: 'PARENT',
patchNum: 3,
},
path: '/path/to/foo',
projectConfig: {foo: 'bar'},
},
left: [
{id: 'bc1', side: 'PARENT', __commentSide: 'left'},
{id: 'bc2', side: 'PARENT', __commentSide: 'left'},
{id: 'bd1', __draft: true, side: 'PARENT', __commentSide: 'left'},
{id: 'bd2', __draft: true, side: 'PARENT', __commentSide: 'left'},
],
right: [
{id: 'c1', __commentSide: 'right'},
{id: 'c2', __commentSide: 'right'},
{id: 'd1', __draft: true, __commentSide: 'right'},
{id: 'd2', __draft: true, __commentSide: 'right'},
],
};
element._removeComment({});
// Using JSON.stringify because Safari 9.1 (11601.5.17.1) doesnt seem
// to believe that one object deepEquals another even when they do :-/.
assert.equal(JSON.stringify(element._comments), JSON.stringify({
meta: {
changeNum: '42',
patchRange: {
basePatchNum: 'PARENT',
patchNum: 3,
},
path: '/path/to/foo',
projectConfig: {foo: 'bar'},
},
left: [
{id: 'bc1', side: 'PARENT', __commentSide: 'left'},
{id: 'bc2', side: 'PARENT', __commentSide: 'left'},
{id: 'bd1', __draft: true, side: 'PARENT', __commentSide: 'left'},
{id: 'bd2', __draft: true, side: 'PARENT', __commentSide: 'left'},
],
right: [
{id: 'c1', __commentSide: 'right'},
{id: 'c2', __commentSide: 'right'},
{id: 'd1', __draft: true, __commentSide: 'right'},
{id: 'd2', __draft: true, __commentSide: 'right'},
],
}));
element._removeComment({id: 'bc2', side: 'PARENT',
__commentSide: 'left'});
assert.deepEqual(element._comments, {
meta: {
changeNum: '42',
patchRange: {
basePatchNum: 'PARENT',
patchNum: 3,
},
path: '/path/to/foo',
projectConfig: {foo: 'bar'},
},
left: [
{id: 'bc1', side: 'PARENT', __commentSide: 'left'},
{id: 'bd1', __draft: true, side: 'PARENT', __commentSide: 'left'},
{id: 'bd2', __draft: true, side: 'PARENT', __commentSide: 'left'},
],
right: [
{id: 'c1', __commentSide: 'right'},
{id: 'c2', __commentSide: 'right'},
{id: 'd1', __draft: true, __commentSide: 'right'},
{id: 'd2', __draft: true, __commentSide: 'right'},
],
});
element._removeComment({id: 'd2', __commentSide: 'right'});
assert.deepEqual(element._comments, {
meta: {
changeNum: '42',
patchRange: {
basePatchNum: 'PARENT',
patchNum: 3,
},
path: '/path/to/foo',
projectConfig: {foo: 'bar'},
},
left: [
{id: 'bc1', side: 'PARENT', __commentSide: 'left'},
{id: 'bd1', __draft: true, side: 'PARENT', __commentSide: 'left'},
{id: 'bd2', __draft: true, side: 'PARENT', __commentSide: 'left'},
],
right: [
{id: 'c1', __commentSide: 'right'},
{id: 'c2', __commentSide: 'right'},
{id: 'd1', __draft: true, __commentSide: 'right'},
],
});
});
test('thread groups', function() {
var contentEl = document.createElement('div');
var rangeToCheck = 'line-left';
var commentSide = 'left';
var patchNum = 1;
var side = 'PARENT';
var range = {
startLine: 1,
startChar: 1,
endLine: 1,
endChar: 2,
};
element.changeNum = 123;
element.patchRange = {basePatchNum: 1, patchNum: 2};
element.path = 'file.txt';
sandbox.stub(element.$.diffBuilder, 'createCommentThreadGroup',
function() {
var threadGroup =
document.createElement('gr-diff-comment-thread-group');
threadGroup.patchForNewThreads = 1;
return threadGroup;
});
// No thread groups.
assert.isNotOk(element._getThreadGroupForLine(contentEl));
// A thread group gets created.
assert.isOk(element._getOrCreateThreadAtLineRange(contentEl,
patchNum, commentSide, side));
// Try to fetch a thread with a different range.
range = {
startLine: 1,
startChar: 1,
endLine: 1,
endChar: 3,
};
assert.isOk(element._getOrCreateThreadAtLineRange(
contentEl, patchNum, commentSide, side, range));
// The new thread group can be fetched.
assert.isOk(element._getThreadGroupForLine(contentEl));
assert.equal(contentEl.querySelectorAll(
'gr-diff-comment-thread-group').length, 1);
var threadGroup = contentEl.querySelector(
'gr-diff-comment-thread-group');
var threadLength = Polymer.dom(threadGroup.root).
querySelectorAll('gr-diff-comment-thread').length;
assert.equal(threadLength, 2);
});
suite('image diffs', function() {
var mockFile1;
var mockFile2;
var stubs = [];
setup(function() {
mockFile1 = {
body: 'Qk06AAAAAAAAADYAAAAoAAAAAQAAAP////8BACAAAAAAAAAAAAATCwAAE' +
'wsAAAAAAAAAAAAAAAAA/w==',
type: 'image/bmp',
};
mockFile2 = {
body: 'Qk06AAAAAAAAADYAAAAoAAAAAQAAAP////8BACAAAAAAAAAAAAATCwAAE' +
'wsAAAAAAAAAAAAA/////w==',
type: 'image/bmp'
};
var mockCommit = {
commit: '9a1a1d10baece5efbba10bc4ccf808a67a50ac0a',
parents: [{
commit: '7338aa9adfe57909f1fdaf88975cdea467d3382f',
subject: 'Added a carrot',
}],
author: {
name: 'Wyatt Allen',
email: 'wyatta@google.com',
date: '2016-05-23 21:44:51.000000000',
tz: -420,
},
committer: {
name: 'Wyatt Allen',
email: 'wyatta@google.com',
date: '2016-05-25 00:25:41.000000000',
tz: -420,
},
subject: 'Updated the carrot',
message: 'Updated the carrot\n\nChange-Id: Iabcd123\n',
};
var mockComments = {baseComments: [], comments: []};
stubs.push(sandbox.stub(element.$.restAPI, 'getCommitInfo',
function() { return Promise.resolve(mockCommit); }));
stubs.push(sandbox.stub(element.$.restAPI,
'getCommitFileContents',
function() { return Promise.resolve(mockFile1); }));
stubs.push(sandbox.stub(element.$.restAPI,
'getChangeFileContents',
function() { return Promise.resolve(mockFile2); }));
stubs.push(sandbox.stub(element.$.restAPI, '_getDiffComments',
function() { return Promise.resolve(mockComments); }));
stubs.push(sandbox.stub(element.$.restAPI, 'getDiffDrafts',
function() { return Promise.resolve(mockComments); }));
element.patchRange = {basePatchNum: 'PARENT', patchNum: 1};
});
test('renders image diffs with same file name', function(done) {
var mockDiff = {
meta_a: {name: 'carrot.jpg', content_type: 'image/jpeg', lines: 66},
meta_b: {name: 'carrot.jpg', content_type: 'image/jpeg',
lines: 560},
intraline_status: 'OK',
change_type: 'MODIFIED',
diff_header: [
'diff --git a/carrot.jpg b/carrot.jpg',
'index 2adc47d..f9c2f2c 100644',
'--- a/carrot.jpg',
'+++ b/carrot.jpg',
'Binary files differ',
],
content: [{skip: 66}],
binary: true,
};
stubs.push(sandbox.stub(element, '_getDiff',
function() { return Promise.resolve(mockDiff); }));
var rendered = function() {
// Recognizes that it should be an image diff.
assert.isTrue(element.isImageDiff);
assert.instanceOf(
element.$.diffBuilder._builder, GrDiffBuilderImage);
// Left image rendered with the parent commit's version of the file.
var leftImage = element.$.diffTable.querySelector('td.left img');
var leftLabel = element.$.diffTable.querySelector('td.left label');
var leftLabelContent = leftLabel.querySelector('.label');
var leftLabelName = leftLabel.querySelector('.name');
var rightImage = element.$.diffTable.querySelector('td.right img');
var rightLabel = element.$.diffTable.querySelector(
'td.right label');
var rightLabelContent = rightLabel.querySelector('.label');
var rightLabelName = rightLabel.querySelector('.name');
assert.isNotOk(rightLabelName);
assert.isNotOk(leftLabelName);
var leftLoaded = false;
var rightLoaded = false;
leftImage.addEventListener('load', function() {
assert.isOk(leftImage);
assert.equal(leftImage.getAttribute('src'),
'data:image/bmp;base64, ' + mockFile1.body);
assert.equal(leftLabelContent.textContent, '1⨉1 image/bmp');
leftLoaded = true;
if (rightLoaded) {
element.removeEventListener('render', rendered);
done();
}
});
rightImage.addEventListener('load', function() {
assert.isOk(rightImage);
assert.equal(rightImage.getAttribute('src'),
'data:image/bmp;base64, ' + mockFile2.body);
assert.equal(rightLabelContent.textContent, '1⨉1 image/bmp');
rightLoaded = true;
if (leftLoaded) {
element.removeEventListener('render', rendered);
done();
}
});
};
element.addEventListener('render', rendered);
element.$.restAPI.getDiffPreferences().then(function(prefs) {
element.prefs = prefs;
element.reload();
});
});
test('renders image diffs with a different file name', function(done) {
var mockDiff = {
meta_a: {name: 'carrot.jpg', content_type: 'image/jpeg', lines: 66},
meta_b: {name: 'carrot2.jpg', content_type: 'image/jpeg',
lines: 560},
intraline_status: 'OK',
change_type: 'MODIFIED',
diff_header: [
'diff --git a/carrot.jpg b/carrot2.jpg',
'index 2adc47d..f9c2f2c 100644',
'--- a/carrot.jpg',
'+++ b/carrot2.jpg',
'Binary files differ',
],
content: [{skip: 66}],
binary: true,
};
stubs.push(sandbox.stub(element, '_getDiff',
function() { return Promise.resolve(mockDiff); }));
var rendered = function() {
// Recognizes that it should be an image diff.
assert.isTrue(element.isImageDiff);
assert.instanceOf(
element.$.diffBuilder._builder, GrDiffBuilderImage);
// Left image rendered with the parent commit's version of the file.
var leftImage = element.$.diffTable.querySelector('td.left img');
var leftLabel = element.$.diffTable.querySelector('td.left label');
var leftLabelContent = leftLabel.querySelector('.label');
var leftLabelName = leftLabel.querySelector('.name');
var rightImage = element.$.diffTable.querySelector('td.right img');
var rightLabel = element.$.diffTable.querySelector(
'td.right label');
var rightLabelContent = rightLabel.querySelector('.label');
var rightLabelName = rightLabel.querySelector('.name');
assert.isOk(rightLabelName);
assert.isOk(leftLabelName);
assert.equal(leftLabelName.textContent, mockDiff.meta_a.name);
assert.equal(rightLabelName.textContent, mockDiff.meta_b.name);
var leftLoaded = false;
var rightLoaded = false;
leftImage.addEventListener('load', function() {
assert.isOk(leftImage);
assert.equal(leftImage.getAttribute('src'),
'data:image/bmp;base64, ' + mockFile1.body);
assert.equal(leftLabelContent.textContent, '1⨉1 image/bmp');
leftLoaded = true;
if (rightLoaded) {
element.removeEventListener('render', rendered);
done();
}
});
rightImage.addEventListener('load', function() {
assert.isOk(rightImage);
assert.equal(rightImage.getAttribute('src'),
'data:image/bmp;base64, ' + mockFile2.body);
assert.equal(rightLabelContent.textContent, '1⨉1 image/bmp');
rightLoaded = true;
if (leftLoaded) {
element.removeEventListener('render', rendered);
done();
}
});
};
element.addEventListener('render', rendered);
element.$.restAPI.getDiffPreferences().then(function(prefs) {
element.prefs = prefs;
element.reload();
});
});
});
test('_handleTap lineNum', function(done) {
var addDraftStub = sinon.stub(element, 'addDraftAtLine');
var el = document.createElement('div');
el.className = 'lineNum';
el.addEventListener('click', function(e) {
element._handleTap(e);
assert.isTrue(addDraftStub.called);
assert.equal(addDraftStub.lastCall.args[0], el);
done();
});
el.click();
});
test('_handleTap context', function(done) {
var showContextStub = sinon.stub(element.$.diffBuilder, 'showContext');
var el = document.createElement('div');
el.className = 'showContext';
el.addEventListener('click', function(e) {
element._handleTap(e);
assert.isTrue(showContextStub.called);
done();
});
el.click();
});
test('_handleTap content', function(done) {
var content = document.createElement('div');
var lineEl = document.createElement('div');
var selectStub = sandbox.stub(element, '_selectLine');
var getLineStub = sandbox.stub(element.$.diffBuilder,
'getLineElByChild', function() { return lineEl; });
content.className = 'content';
content.addEventListener('click', function(e) {
element._handleTap(e);
assert.isTrue(selectStub.called);
assert.equal(selectStub.lastCall.args[0], lineEl);
done();
});
content.click();
});
test('_getDiff handles null diff responses', function(done) {
stub('gr-rest-api-interface', {
getDiff: function() { return Promise.resolve(null); },
});
element.changeNum = 123;
element.patchRange = {basePatchNum: 1, patchNum: 2};
element.path = 'file.txt';
element._getDiff().then(done);
});
suite('getCursorStops', function() {
var setupDiff = function() {
var mock = document.createElement('mock-diff-response');
element._diff = mock.diffResponse;
element._comments = {
left: [],
right: [],
};
element.prefs = {
context: 10,
tab_size: 8,
font_size: 12,
line_length: 100,
cursor_blink_rate: 0,
line_wrapping: false,
intraline_difference: true,
show_line_endings: true,
show_tabs: true,
show_whitespace_errors: true,
syntax_highlighting: true,
auto_hide_diff_table_header: true,
theme: 'DEFAULT',
ignore_whitespace: 'IGNORE_NONE',
};
element._renderDiffTable();
flushAsynchronousOperations();
};
test('getCursorStops returns [] when hidden and noAutoRender are true',
function() {
element.noAutoRender = true;
setupDiff();
element.hidden = true;
assert.equal(element.getCursorStops().length, 0);
});
test('getCursorStops', function() {
setupDiff();
assert.equal(element.getCursorStops().length, 50);
});
});
});
suite('logged in', function() {
setup(function() {
stub('gr-rest-api-interface', {
getLoggedIn: function() { return Promise.resolve(true); },
getPreferences: function() {
return Promise.resolve({time_format: 'HHMM_12'});
},
});
element = fixture('basic');
});
test('get drafts', function(done) {
element.patchRange = {basePatchNum: 0, patchNum: 0};
var draftsResponse = {
baseComments: [{id: 'foo'}],
comments: [{id: 'bar'}],
};
var getDraftsStub = sandbox.stub(element.$.restAPI, 'getDiffDrafts',
function() { return Promise.resolve(draftsResponse); });
element._getDiffDrafts().then(function(result) {
assert.deepEqual(result, draftsResponse);
done();
});
});
test('get comments and drafts', function(done) {
var comments = {
baseComments: [
{id: 'bc1', __commentSide: 'left'},
{id: 'bc2', __commentSide: 'left'},
],
comments: [
{id: 'c1', __commentSide: 'right'},
{id: 'c2', __commentSide: 'right'},
],
};
var diffCommentsStub = sandbox.stub(element, '_getDiffComments',
function() { return Promise.resolve(comments); });
var drafts = {
baseComments: [
{id: 'bd1', __commentSide: 'left'},
{id: 'bd2', __commentSide: 'left'},
],
comments: [
{id: 'd1', __commentSide: 'right'},
{id: 'd2', __commentSide: 'right'},
],
};
var diffDraftsStub = sandbox.stub(element, '_getDiffDrafts',
function() { return Promise.resolve(drafts); });
var robotComments = {
baseComments: [
{id: 'br1', __commentSide: 'left'},
{id: 'br2', __commentSide: 'left'},
],
comments: [
{id: 'r1', __commentSide: 'right'},
{id: 'r2', __commentSide: 'right'},
],
};
var diffRobotCommentStub = sandbox.stub(element,
'_getDiffRobotComments', function() {
return Promise.resolve(robotComments); });
element.changeNum = '42';
element.patchRange = {
basePatchNum: 'PARENT',
patchNum: 3,
};
element.path = '/path/to/foo';
element.projectConfig = {foo: 'bar'};
element._getDiffCommentsAndDrafts().then(function(result) {
assert.deepEqual(result, {
meta: {
changeNum: '42',
patchRange: {
basePatchNum: 'PARENT',
patchNum: 3,
},
path: '/path/to/foo',
projectConfig: {foo: 'bar'},
},
left: [
{id: 'bc1', __commentSide: 'left'},
{id: 'bc2', __commentSide: 'left'},
{id: 'bd1', __draft: true, __commentSide: 'left'},
{id: 'bd2', __draft: true, __commentSide: 'left'},
{id: 'br1', __commentSide: 'left'},
{id: 'br2', __commentSide: 'left'},
],
right: [
{id: 'c1', __commentSide: 'right'},
{id: 'c2', __commentSide: 'right'},
{id: 'd1', __draft: true, __commentSide: 'right'},
{id: 'd2', __draft: true, __commentSide: 'right'},
{id: 'r1', __commentSide: 'right'},
{id: 'r2', __commentSide: 'right'},
],
});
done();
});
});
test('addDraftAtLine', function(done) {
var fakeLineEl = {getAttribute: sandbox.stub().returns(42)};
sandbox.stub(element, '_selectLine');
sandbox.stub(element, '_addDraft');
var loggedInErrorSpy = sandbox.spy();
element.addEventListener('show-auth-required', loggedInErrorSpy);
element.addDraftAtLine(fakeLineEl);
flush(function() {
assert.isFalse(loggedInErrorSpy.called);
assert.isTrue(element._addDraft.calledWithExactly(fakeLineEl, 42));
done();
});
});
suite('handle comment-update', function() {
setup(function() {
element._comments = {
meta: {
changeNum: '42',
patchRange: {
basePatchNum: 'PARENT',
patchNum: 3,
},
path: '/path/to/foo',
projectConfig: {foo: 'bar'},
},
left: [
{id: 'bc1', side: 'PARENT', __commentSide: 'left'},
{id: 'bc2', side: 'PARENT', __commentSide: 'left'},
{id: 'bd1', __draft: true, side: 'PARENT', __commentSide: 'left'},
{id: 'bd2', __draft: true, side: 'PARENT', __commentSide: 'left'},
],
right: [
{id: 'c1', __commentSide: 'right'},
{id: 'c2', __commentSide: 'right'},
{id: 'd1', __draft: true, __commentSide: 'right'},
{id: 'd2', __draft: true, __commentSide: 'right'},
],
};
});
test('creating a draft', function() {
var comment = {__draft: true, __draftID: 'tempID', side: 'PARENT',
__commentSide: 'left'};
element.fire('comment-update', {comment: comment});
assert.include(element._comments.left, comment);
});
test('saving a draft', function() {
var draftID = 'tempID';
var id = 'savedID';
element._comments.left.push(
{__draft: true, __draftID: draftID, side: 'PARENT',
__commentSide: 'left'});
element.fire('comment-update', {comment:
{id: id, __draft: true, __draftID: draftID, side: 'PARENT',
__commentSide: 'left'},
});
var drafts = element._comments.left.filter(function(item) {
return item.__draftID === draftID;
});
assert.equal(drafts.length, 1);
assert.equal(drafts[0].id, id);
});
});
});
});
</script>