blob: c65371b7189ef33ed1f330cf2d537677eef1ffc6 [file] [log] [blame]
/**
* @license
* Copyright 2022 Google LLC
* SPDX-License-Identifier: Apache-2.0
*/
import '../../../test/common-test-setup';
import {GrChangeListBulkVoteFlow} from './gr-change-list-bulk-vote-flow';
import {
BulkActionsModel,
bulkActionsModelToken,
LoadingState,
} from '../../../models/bulk-actions/bulk-actions-model';
import {
waitUntilObserved,
stubRestApi,
queryAndAssert,
query,
mockPromise,
queryAll,
stubReporting,
waitEventLoop,
} from '../../../test/test-utils';
import {ChangeInfo, NumericChangeId, LabelInfo} from '../../../api/rest-api';
import {getAppContext} from '../../../services/app-context';
import {fixture, waitUntil, assert} from '@open-wc/testing';
import {wrapInProvider} from '../../../models/di-provider-element';
import {html} from 'lit';
import {SinonStubbedMember} from 'sinon';
import {RestApiService} from '../../../services/gr-rest-api/gr-rest-api';
import {
createChange,
createDetailedLabelInfo,
createSubmitRequirementResultInfo,
} from '../../../test/test-data-generators';
import './gr-change-list-bulk-vote-flow';
import {GrButton} from '../../shared/gr-button/gr-button';
import {ProgressStatus} from '../../../constants/constants';
import {StandardLabels} from '../../../utils/label-util';
import {ReportingService} from '../../../services/gr-reporting/gr-reporting';
import {ReviewResult} from '../../../types/common';
const change1: ChangeInfo = {
...createChange(),
_number: 1 as NumericChangeId,
permitted_labels: {
[StandardLabels.CODE_REVIEW]: ['-1', '0', '+1', '+2'],
A: ['-1', '0', '+1', '+2'],
B: ['-1', '0'],
C: ['-1', '0'],
change1OnlyLabelD: ['0'], // Does not exist on change2
change1OnlyTriggerLabelE: ['0'], // Does not exist on change2
},
labels: {
[StandardLabels.CODE_REVIEW]: {value: null} as LabelInfo,
A: {value: null} as LabelInfo,
B: {value: null} as LabelInfo,
C: {value: null} as LabelInfo,
change1OnlyLabelD: {value: null} as LabelInfo,
change1OnlyTriggerLabelE: {value: null} as LabelInfo,
},
submit_requirements: [
createSubmitRequirementResultInfo(
`label:${StandardLabels.CODE_REVIEW}=MAX`
),
createSubmitRequirementResultInfo('label:A=MAX'),
createSubmitRequirementResultInfo('label:B=MAX'),
createSubmitRequirementResultInfo('label:C=MAX'),
createSubmitRequirementResultInfo('label:change1OnlyLabelD=MAX'),
],
};
const change2: ChangeInfo = {
...createChange(),
_number: 2 as NumericChangeId,
permitted_labels: {
[StandardLabels.CODE_REVIEW]: ['-1', '0', '+1', '+2'],
A: ['-1', '0', '+1', '+2'], // Intersects fully with change1
B: ['0', ' +1'], // Intersects with change1 on 0
C: ['+1', '+2'], // Does not intersect with change1 at all
},
labels: {
[StandardLabels.CODE_REVIEW]: {value: null} as LabelInfo,
A: {value: null} as LabelInfo,
B: {value: null} as LabelInfo,
C: {value: null} as LabelInfo,
},
submit_requirements: [
createSubmitRequirementResultInfo(
`label:${StandardLabels.CODE_REVIEW}=MAX`
),
createSubmitRequirementResultInfo('label:A=MAX'),
createSubmitRequirementResultInfo('label:B=MAX'),
createSubmitRequirementResultInfo('label:C=MAX'),
],
};
suite('gr-change-list-bulk-vote-flow tests', () => {
let element: GrChangeListBulkVoteFlow;
let model: BulkActionsModel;
let dispatchEventStub: sinon.SinonStub;
let getChangesStub: SinonStubbedMember<
RestApiService['getDetailedChangesWithActions']
>;
let reportingStub: SinonStubbedMember<ReportingService['reportInteraction']>;
async function selectChange(change: ChangeInfo) {
model.addSelectedChangeNum(change._number);
await waitUntilObserved(model.selectedChangeNums$, selectedChangeNums =>
selectedChangeNums.includes(change._number)
);
await element.updateComplete;
}
setup(async () => {
model = new BulkActionsModel(getAppContext().restApiService);
getChangesStub = stubRestApi('getDetailedChangesWithActions');
reportingStub = stubReporting('reportInteraction');
element = (
await fixture(
wrapInProvider(
html`<gr-change-list-bulk-vote-flow></gr-change-list-bulk-vote-flow>`,
bulkActionsModelToken,
model
)
)
).querySelector('gr-change-list-bulk-vote-flow')!;
await element.updateComplete;
dispatchEventStub = sinon.stub(element, 'dispatchEvent');
});
test('renders', async () => {
const changes: ChangeInfo[] = [change1];
getChangesStub.returns(Promise.resolve(changes));
model.sync(changes);
await waitUntilObserved(
model.loadingState$,
state => state === LoadingState.LOADED
);
await selectChange(change1);
await element.updateComplete;
assert.shadowDom.equal(
element,
`<gr-button
aria-disabled="false"
flatten=""
id="voteFlowButton"
role="button"
tabindex="0"
>
Vote
</gr-button>
<dialog
id="actionModal"
tabindex="-1"
>
<gr-dialog role="dialog">
<div slot="header">
<span class="main-heading"> Vote on selected changes </span>
</div>
<div slot="main">
<div class="newSubmitRequirements scoresTable">
<h3 class="heading-4 vote-type">Submit requirements votes</h3>
<div class="code-review-message-container">
<div class="code-review-message-layout-container">
<div>
<gr-icon icon="info" aria-label="Information" role="img"></gr-icon>
<span class="warning-text">
Code Review vote is only available on the individual change page
</span>
</div>
<div class="flex-space"></div>
<div>
<gr-button
aria-disabled="false"
flatten=""
link=""
role="button"
aria-label="Open 1 change in different tabs"
tabindex="0"
>
Open 1 change
</gr-button>
</div>
</div>
</div>
<gr-label-score-row name="A"> </gr-label-score-row>
<gr-label-score-row name="B"> </gr-label-score-row>
<gr-label-score-row name="C"> </gr-label-score-row>
<gr-label-score-row name="change1OnlyLabelD">
</gr-label-score-row>
</div>
<div class="newSubmitRequirements scoresTable">
<h3 class="heading-4 vote-type">Trigger Votes</h3>
<gr-label-score-row name="change1OnlyTriggerLabelE">
</gr-label-score-row>
</div>
</div>
</gr-dialog>
</dialog> `
);
});
test('renders with errors', async () => {
const changes: ChangeInfo[] = [change1];
getChangesStub.returns(Promise.resolve(changes));
model.sync(changes);
await waitUntilObserved(
model.loadingState$,
state => state === LoadingState.LOADED
);
stubRestApi('saveChangeReview').callsFake(
(_changeNum, _patchNum, _review, errFn) =>
Promise.resolve(undefined).then(res => {
errFn && errFn();
return res;
})
);
await selectChange(change1);
await element.updateComplete;
queryAndAssert<GrButton>(query(element, 'gr-dialog'), '#confirm').click();
await waitUntil(
() =>
element.progressByChange.get(1 as NumericChangeId) ===
ProgressStatus.FAILED
);
assert.shadowDom.equal(
element,
`<gr-button
aria-disabled="false"
flatten=""
id="voteFlowButton"
role="button"
tabindex="0"
>
Vote
</gr-button>
<dialog
id="actionModal"
tabindex="-1"
>
<gr-dialog role="dialog">
<div slot="header">
<span class="main-heading"> Vote on selected changes </span>
</div>
<div slot="main">
<div class="newSubmitRequirements scoresTable">
<h3 class="heading-4 vote-type">Submit requirements votes</h3>
<div class="code-review-message-container">
<div class="code-review-message-layout-container">
<div>
<gr-icon icon="info" aria-label="Information" role="img"></gr-icon>
<span class="warning-text">
Code Review vote is only available on the individual change page
</span>
</div>
<div class="flex-space"></div>
<div>
<gr-button
aria-disabled="false"
flatten=""
link=""
role="button"
aria-label="Open 1 change in different tabs"
tabindex="0"
>
Open 1 change
</gr-button>
</div>
</div>
</div>
<gr-label-score-row name="A"> </gr-label-score-row>
<gr-label-score-row name="B"> </gr-label-score-row>
<gr-label-score-row name="C"> </gr-label-score-row>
<gr-label-score-row name="change1OnlyLabelD">
</gr-label-score-row>
</div>
<div class="newSubmitRequirements scoresTable">
<h3 class="heading-4 vote-type">Trigger Votes</h3>
<gr-label-score-row name="change1OnlyTriggerLabelE">
</gr-label-score-row>
</div>
<div class="error-container">
<gr-icon icon="error" filled role="img" aria-label="Error"></gr-icon>
<span class="error-text"> Failed to vote on 1 change </span>
</div>
</div>
</gr-dialog>
</dialog> `
);
});
test('button state updates as changes are updated', async () => {
const changes: ChangeInfo[] = [change1];
getChangesStub.returns(Promise.resolve(changes));
model.sync(changes);
await waitUntilObserved(
model.loadingState$,
state => state === LoadingState.LOADED
);
await selectChange(change1);
await element.updateComplete;
await waitEventLoop();
assert.isNotOk(
queryAndAssert<GrButton>(element, '#voteFlowButton').disabled
);
// No common label with change1 so button is disabled
const c2 = {...change2}; // create copy so other tests are not affected
c2.labels = {
x: {value: null} as LabelInfo,
y: {value: null} as LabelInfo,
z: {value: null} as LabelInfo,
};
c2.submit_requirements = [
createSubmitRequirementResultInfo('label:x=MAX'),
createSubmitRequirementResultInfo('label:y=MAX'),
createSubmitRequirementResultInfo('label:z=MAX'),
];
changes.push({...c2});
getChangesStub.restore();
getChangesStub.returns(Promise.resolve(changes));
model.sync(changes);
await waitUntilObserved(
model.loadingState$,
state => state === LoadingState.LOADED
);
await selectChange(change2);
await element.updateComplete;
assert.isNotOk(
queryAndAssert<GrButton>(element, '#voteFlowButton').disabled
);
});
test('progress updates as request is resolved', async () => {
const change = {
...change1,
labels: {
...change1.labels,
C: {
...createDetailedLabelInfo(),
all: [
{
...element.account!,
value: -1,
},
],
},
},
};
const changes: ChangeInfo[] = [{...change}];
getChangesStub.returns(Promise.resolve(changes));
model.sync(changes);
await waitUntilObserved(
model.loadingState$,
state => state === LoadingState.LOADED
);
await selectChange(change);
await element.updateComplete;
const saveChangeReview = mockPromise<ReviewResult>();
stubRestApi('saveChangeReview').returns(saveChangeReview);
queryAndAssert<GrButton>(element, '#voteFlowButton').click();
await element.updateComplete;
assert.isNotOk(
queryAndAssert<GrButton>(query(element, 'gr-dialog'), '#confirm').disabled
);
assert.isNotOk(
queryAndAssert<GrButton>(query(element, 'gr-dialog'), '#cancel').disabled
);
const scores = queryAll(element, 'gr-label-score-row');
queryAndAssert<GrButton>(scores[0], 'gr-button[data-value="+1"]').click();
queryAndAssert<GrButton>(scores[1], 'gr-button[data-value="-1"]').click();
queryAndAssert<GrButton>(scores[2], 'gr-button[data-value="0"]').click();
await element.updateComplete;
assert.deepEqual(
element.getLabelValues(
element.computeCommonPermittedLabels(element.computePermittedLabels())
),
{
A: 1,
B: -1,
C: 0,
}
);
queryAndAssert<GrButton>(query(element, 'gr-dialog'), '#confirm').click();
await element.updateComplete;
assert.isTrue(
queryAndAssert<GrButton>(query(element, 'gr-dialog'), '#confirm').disabled
);
assert.isTrue(
queryAndAssert<GrButton>(query(element, 'gr-dialog'), '#cancel').disabled
);
assert.deepEqual(reportingStub.lastCall.args[1], {
type: 'vote',
selectedChangeCount: 1,
});
assert.equal(
element.progressByChange.get(1 as NumericChangeId),
ProgressStatus.RUNNING
);
saveChangeReview.resolve({});
await waitUntil(
() =>
element.progressByChange.get(1 as NumericChangeId) ===
ProgressStatus.SUCCESSFUL
);
assert.isTrue(
queryAndAssert<GrButton>(query(element, 'gr-dialog'), '#confirm').disabled
);
assert.isNotOk(
queryAndAssert<GrButton>(query(element, 'gr-dialog'), '#cancel').disabled
);
assert.equal(
element.progressByChange.get(1 as NumericChangeId),
ProgressStatus.SUCCESSFUL
);
// reload event is fired automatically when all requests succeed
assert.equal(dispatchEventStub.lastCall.args[0].type, 'reload');
assert.equal(
dispatchEventStub.firstCall.args[0].detail.message,
'Votes added'
);
});
suite('closing dialog triggers reloads', () => {
test('closing dialog triggers a reload', async () => {
const changes: ChangeInfo[] = [change1, change2];
getChangesStub.returns(Promise.resolve(changes));
stubRestApi('saveChangeReview').callsFake(
(_changeNum, _patchNum, _review, errFn) =>
Promise.resolve({}).then(res => {
errFn && errFn();
return res;
})
);
model.sync(changes);
await waitUntilObserved(
model.loadingState$,
state => state === LoadingState.LOADED
);
await selectChange(change1);
await selectChange(change2);
await element.updateComplete;
queryAndAssert<GrButton>(query(element, 'gr-dialog'), '#confirm').click();
await waitUntil(
() =>
element.progressByChange.get(2 as NumericChangeId) ===
ProgressStatus.FAILED
);
// Dialog does not autoclose and fire reload event if some request fails
assert.isFalse(dispatchEventStub.called);
assert.deepEqual(reportingStub.lastCall.args, [
'bulk-action-failure',
{
type: 'vote',
count: 2,
},
]);
queryAndAssert<GrButton>(query(element, 'gr-dialog'), '#cancel').click();
await waitUntil(() => dispatchEventStub.called);
assert.equal(dispatchEventStub.lastCall.args[0].type, 'reload');
});
test('button is disabled if no votes are possible', async () => {
const c2 = {...change2}; // create copy so other tests are not affected
c2.labels = {
x: {value: null} as LabelInfo,
y: {value: null} as LabelInfo,
z: {value: null} as LabelInfo,
};
c2.submit_requirements = [
createSubmitRequirementResultInfo('label:x=MAX'),
createSubmitRequirementResultInfo('label:y=MAX'),
createSubmitRequirementResultInfo('label:z=MAX'),
];
const changes: ChangeInfo[] = [change1, c2];
getChangesStub.returns(Promise.resolve(changes));
stubRestApi('saveChangeReview').callsFake(
(_changeNum, _patchNum, _review, errFn) =>
Promise.resolve(undefined).then(res => {
errFn && errFn();
return res;
})
);
model.sync(changes);
await waitUntilObserved(
model.loadingState$,
state => state === LoadingState.LOADED
);
await selectChange(change1);
await selectChange(c2);
await element.updateComplete;
assert.isTrue(
queryAndAssert<GrButton>(query(element, 'gr-dialog'), '#confirm')
.disabled
);
});
test('closing dialog does not trigger reload if no request made', async () => {
const changes: ChangeInfo[] = [change1, change2];
getChangesStub.returns(Promise.resolve(changes));
model.sync(changes);
await waitUntilObserved(
model.loadingState$,
state => state === LoadingState.LOADED
);
await selectChange(change1);
await selectChange(change2);
await element.updateComplete;
queryAndAssert<GrButton>(query(element, 'gr-dialog'), '#cancel').click();
assert.isFalse(dispatchEventStub.called);
});
});
test('computePermittedLabels', async () => {
// {} if no change is selected
assert.deepEqual(element.computePermittedLabels(), {});
const changes: ChangeInfo[] = [change1];
getChangesStub.returns(Promise.resolve(changes));
model.sync(changes);
await waitUntilObserved(
model.loadingState$,
state => state === LoadingState.LOADED
);
await selectChange(change1);
await element.updateComplete;
assert.deepEqual(element.computePermittedLabels(), {
A: ['-1', '0', '+1', '+2'],
B: ['-1', '0'],
C: ['-1', '0'],
change1OnlyLabelD: ['0'],
change1OnlyTriggerLabelE: ['0'],
});
changes.push(change2);
getChangesStub.returns(Promise.resolve(changes));
model.sync(changes);
await waitUntilObserved(
model.loadingState$,
state => state === LoadingState.LOADED
);
await selectChange(change2);
await element.updateComplete;
assert.deepEqual(element.computePermittedLabels(), {
A: ['-1', '0', '+1', '+2'],
B: ['0'],
C: [],
});
});
test('computeCommonPermittedLabels', async () => {
const createChangeWithLabels = (
num: NumericChangeId,
labelNames: string[],
triggerLabels?: string[]
) => {
const change = createChange();
change._number = num;
change.submit_requirements = [];
change.labels = {};
change.permitted_labels = {};
for (const label of labelNames) {
change.labels[label] = {value: null} as LabelInfo;
if (!triggerLabels?.includes(label)) {
change.submit_requirements.push(
createSubmitRequirementResultInfo(`label:${label}=MAX`)
);
}
change.permitted_labels[label] = ['0'];
}
return change;
};
const changes: ChangeInfo[] = [
createChangeWithLabels(
1 as NumericChangeId,
['a', 'triggerLabelB', 'c'],
['triggerLabelB']
),
createChangeWithLabels(
2 as NumericChangeId,
['triggerLabelB', 'c', 'd'],
['triggerLabelB']
),
createChangeWithLabels(3 as NumericChangeId, ['c', 'd', 'e']),
createChangeWithLabels(4 as NumericChangeId, ['x', 'y', 'z']),
];
// Labels for each change are [a,b,c] [b,c,d] [c,d,e] [x,y,z]
getChangesStub.returns(Promise.resolve(changes));
model.sync(changes);
await waitUntilObserved(
model.loadingState$,
state => state === LoadingState.LOADED
);
await selectChange(
createChangeWithLabels(1 as NumericChangeId, ['a', 'triggerLabelB', 'c'])
);
await element.updateComplete;
// Code-Review is not a common permitted label
assert.deepEqual(
element.computeCommonPermittedLabels(element.computePermittedLabels()),
[
{name: 'a', value: null},
{name: 'c', value: null},
{name: 'triggerLabelB', value: null},
]
);
await selectChange(
createChangeWithLabels(2 as NumericChangeId, ['triggerLabelB', 'c', 'd'])
);
assert.deepEqual(
element.computeCommonTriggerLabels(element.computePermittedLabels()),
[{name: 'triggerLabelB', value: null}]
);
await element.updateComplete;
// Intersection of [CR, 'a', 'triggerLabelB', 'c']
// [CR, 'triggerLabelB', 'c', 'd'] is [triggerLabelB,c]
// Code-Review is not a common permitted label
assert.deepEqual(
element.computeCommonPermittedLabels(element.computePermittedLabels()),
[
{name: 'c', value: null},
{name: 'triggerLabelB', value: null},
]
);
assert.deepEqual(
element.computeCommonTriggerLabels(element.computePermittedLabels()),
[{name: 'triggerLabelB', value: null}]
);
await selectChange(
createChangeWithLabels(3 as NumericChangeId, ['c', 'd', 'e'])
);
await element.updateComplete;
// Intersection of [a,triggerLabelB,c] [triggerLabelB,c,d] [c,d,e] is [c]
assert.deepEqual(
element.computeCommonPermittedLabels(element.computePermittedLabels()),
[{name: 'c', value: null}]
);
assert.deepEqual(
element.computeCommonTriggerLabels(element.computePermittedLabels()),
[]
);
await selectChange(
createChangeWithLabels(4 as NumericChangeId, ['x', 'y', 'z'])
);
assert.deepEqual(
element.computeCommonTriggerLabels(element.computePermittedLabels()),
[]
);
await element.updateComplete;
// Intersection of [a,triggerLabelB,c] [triggerLabelB,c,d] [c,d,e] [x,y,z]
// is []
assert.deepEqual(
element.computeCommonPermittedLabels(element.computePermittedLabels()),
[]
);
});
});