opendev/gerrit
Code Issues Proposed changes

Merge changes from topic "gr-confirm-rebase-dialog-to-ts"

Browse Source 
* changes:
  Convert gr-confirm-rebase-dialog to typescript
  Rename files to preserve history
This commit is contained in:
Dmitrii Filippov
2020-08-26 09:45:40 +00:00
committed by Gerrit Code Review
parent 3505ee1fd9 14394f277c
commit 8f96a8711d
2 changed files with 239 additions and 177 deletions
Download Patch File Download Diff File Expand all files Collapse all files

177
polygerrit-ui/app/elements/change/gr-confirm-rebase-dialog/gr-confirm-rebase-dialog.js
View File

@@ -1,177 +0,0 @@
/**
* @license
* Copyright (C) 2016 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.
*/
import '../../shared/gr-autocomplete/gr-autocomplete.js';
import '../../shared/gr-dialog/gr-dialog.js';
import '../../shared/gr-rest-api-interface/gr-rest-api-interface.js';
import '../../../styles/shared-styles.js';
import {GestureEventListeners} from '@polymer/polymer/lib/mixins/gesture-event-listeners.js';
import {LegacyElementMixin} from '@polymer/polymer/lib/legacy/legacy-element-mixin.js';
import {PolymerElement} from '@polymer/polymer/polymer-element.js';
import {htmlTemplate} from './gr-confirm-rebase-dialog_html.js';
/** @extends PolymerElement */
class GrConfirmRebaseDialog extends GestureEventListeners(
LegacyElementMixin(
PolymerElement)) {
static get template() { return htmlTemplate; }
static get is() { return 'gr-confirm-rebase-dialog'; }
/**
* Fired when the confirm button is pressed.
*
* @event confirm
*/
/**
* Fired when the cancel button is pressed.
*
* @event cancel
*/
static get properties() {
return {
branch: String,
changeNumber: Number,
hasParent: Boolean,
rebaseOnCurrent: Boolean,
_text: String,
_query: {
type: Function,
value() {
return this._getChangeSuggestions.bind(this);
},
},
_recentChanges: Array,
};
}
static get observers() {
return [
'_updateSelectedOption(rebaseOnCurrent, hasParent)',
];
}
// This is called by gr-change-actions every time the rebase dialog is
// re-opened. Unlike other autocompletes that make a request with each
// updated input, this one gets all recent changes once and then filters
// them by the input. The query is re-run each time the dialog is opened
// in case there are new/updated changes in the generic query since the
// last time it was run.
fetchRecentChanges() {
return this.$.restAPI.getChanges(null, `is:open -age:90d`)
.then(response => {
const changes = [];
for (const key in response) {
if (!response.hasOwnProperty(key)) { continue; }
changes.push({
name: `${response[key]._number}: ${response[key].subject}`,
value: response[key]._number,
});
}
this._recentChanges = changes;
return this._recentChanges;
});
}
_getRecentChanges() {
if (this._recentChanges) {
return Promise.resolve(this._recentChanges);
}
return this.fetchRecentChanges();
}
_getChangeSuggestions(input) {
return this._getRecentChanges().then(changes =>
this._filterChanges(input, changes));
}
_filterChanges(input, changes) {
return changes.filter(change => change.name.includes(input) &&
change.value !== this.changeNumber);
}
_displayParentOption(rebaseOnCurrent, hasParent) {
return hasParent && rebaseOnCurrent;
}
_displayParentUpToDateMsg(rebaseOnCurrent, hasParent) {
return hasParent && !rebaseOnCurrent;
}
_displayTipOption(rebaseOnCurrent, hasParent) {
return !(!rebaseOnCurrent && !hasParent);
}
/**
* There is a subtle but important difference between setting the base to an
* empty string and omitting it entirely from the payload. An empty string
* implies that the parent should be cleared and the change should be
* rebased on top of the target branch. Leaving out the base implies that it
* should be rebased on top of its current parent.
*/
_getSelectedBase() {
if (this.$.rebaseOnParentInput.checked) { return null; }
if (this.$.rebaseOnTipInput.checked) { return ''; }
// Change numbers will have their description appended by the
// autocomplete.
return this._text.split(':')[0];
}
_handleConfirmTap(e) {
e.preventDefault();
e.stopPropagation();
this.dispatchEvent(new CustomEvent('confirm',
{detail: {base: this._getSelectedBase()}}));
this._text = '';
}
_handleCancelTap(e) {
e.preventDefault();
e.stopPropagation();
this.dispatchEvent(new CustomEvent('cancel'));
this._text = '';
}
_handleRebaseOnOther() {
this.$.parentInput.focus();
}
_handleEnterChangeNumberClick() {
this.$.rebaseOnOtherInput.checked = true;
}
/**
* Sets the default radio button based on the state of the app and
* the corresponding value to be submitted.
*/
_updateSelectedOption(rebaseOnCurrent, hasParent) {
// Polymer 2: check for undefined
if ([rebaseOnCurrent, hasParent].includes(undefined)) {
return;
}
if (this._displayParentOption(rebaseOnCurrent, hasParent)) {
this.$.rebaseOnParentInput.checked = true;
} else if (this._displayTipOption(rebaseOnCurrent, hasParent)) {
this.$.rebaseOnTipInput.checked = true;
} else {
this.$.rebaseOnOtherInput.checked = true;
}
}
}
customElements.define(GrConfirmRebaseDialog.is, GrConfirmRebaseDialog);

239
polygerrit-ui/app/elements/change/gr-confirm-rebase-dialog/gr-confirm-rebase-dialog.ts Normal file
View File

@@ -0,0 +1,239 @@
/**
* @license
* Copyright (C) 2016 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.
*/
import '../../shared/gr-autocomplete/gr-autocomplete';
import '../../shared/gr-dialog/gr-dialog';
import '../../shared/gr-rest-api-interface/gr-rest-api-interface';
import '../../../styles/shared-styles';
import {GestureEventListeners} from '@polymer/polymer/lib/mixins/gesture-event-listeners';
import {LegacyElementMixin} from '@polymer/polymer/lib/legacy/legacy-element-mixin';
import {PolymerElement} from '@polymer/polymer/polymer-element';
import {htmlTemplate} from './gr-confirm-rebase-dialog_html';
import {customElement, property, observe} from '@polymer/decorators';
import {
GrRestApiInterface,
ChangeNum,
} from '../../shared/gr-rest-api-interface/gr-rest-api-interface';
import {hasOwnProperty} from '../../../utils/common-util';
import {LegacyChangeId, BranchName} from '../../../types/common';
import {
GrAutocomplete,
AutocompleteQuery,
AutocompleteSuggestion,
} from '../../shared/gr-autocomplete/gr-autocomplete';
interface RebaseChange {
name: string;
value: LegacyChangeId;
}
export interface GrConfirmRebaseDialog {
$: {
restAPI: GrRestApiInterface;
parentInput: GrAutocomplete;
rebaseOnParentInput: HTMLInputElement;
rebaseOnOtherInput: HTMLInputElement;
rebaseOnTipInput: HTMLInputElement;
};
}
@customElement('gr-confirm-rebase-dialog')
export class GrConfirmRebaseDialog extends GestureEventListeners(
LegacyElementMixin(PolymerElement)
) {
static get template() {
return htmlTemplate;
}
/**
* Fired when the confirm button is pressed.
*
* @event confirm
*/
/**
* Fired when the cancel button is pressed.
*
* @event cancel
*/
@property({type: String})
branch?: BranchName;
@property({type: Number})
changeNumber?: ChangeNum;
@property({type: Boolean})
hasParent?: boolean;
@property({type: Boolean})
rebaseOnCurrent?: boolean;
@property({type: String})
_text?: string;
@property({type: Object})
_query?: AutocompleteQuery;
@property({type: Array})
_recentChanges?: RebaseChange[];
constructor() {
super();
this._query = input => this._getChangeSuggestions(input);
}
// This is called by gr-change-actions every time the rebase dialog is
// re-opened. Unlike other autocompletes that make a request with each
// updated input, this one gets all recent changes once and then filters
// them by the input. The query is re-run each time the dialog is opened
// in case there are new/updated changes in the generic query since the
// last time it was run.
fetchRecentChanges() {
return this.$.restAPI
.getChanges(undefined, 'is:open -age:90d')
.then(response => {
if (!response) return [];
const changes: RebaseChange[] = [];
for (const key in response) {
if (!hasOwnProperty(response, key)) {
continue;
}
changes.push({
name: `${response[key]._number}: ${response[key].subject}`,
value: response[key]._number,
});
}
this._recentChanges = changes;
return this._recentChanges;
});
}
_getRecentChanges() {
if (this._recentChanges) {
return Promise.resolve(this._recentChanges);
}
return this.fetchRecentChanges();
}
_getChangeSuggestions(input: string) {
return this._getRecentChanges().then(changes =>
this._filterChanges(input, changes)
);
}
_filterChanges(
input: string,
changes: RebaseChange[]
): AutocompleteSuggestion[] {
return changes
.filter(
change =>
change.name.includes(input) && change.value !== this.changeNumber
)
.map(
change =>
({
name: change.name,
value: `${change.value}`,
} as AutocompleteSuggestion)
);
}
_displayParentOption(rebaseOnCurrent: boolean, hasParent: boolean) {
return hasParent && rebaseOnCurrent;
}
_displayParentUpToDateMsg(rebaseOnCurrent: boolean, hasParent: boolean) {
return hasParent && !rebaseOnCurrent;
}
_displayTipOption(rebaseOnCurrent: boolean, hasParent: boolean) {
return !(!rebaseOnCurrent && !hasParent);
}
/**
* There is a subtle but important difference between setting the base to an
* empty string and omitting it entirely from the payload. An empty string
* implies that the parent should be cleared and the change should be
* rebased on top of the target branch. Leaving out the base implies that it
* should be rebased on top of its current parent.
*/
_getSelectedBase() {
if (this.$.rebaseOnParentInput.checked) {
return null;
}
if (this.$.rebaseOnTipInput.checked) {
return '';
}
if (!this._text) {
return '';
}
// Change numbers will have their description appended by the
// autocomplete.
return this._text.split(':')[0];
}
_handleConfirmTap(e: Event) {
e.preventDefault();
e.stopPropagation();
this.dispatchEvent(
new CustomEvent('confirm', {detail: {base: this._getSelectedBase()}})
);
this._text = '';
}
_handleCancelTap(e: Event) {
e.preventDefault();
e.stopPropagation();
this.dispatchEvent(new CustomEvent('cancel'));
this._text = '';
}
_handleRebaseOnOther() {
this.$.parentInput.focus();
}
_handleEnterChangeNumberClick() {
this.$.rebaseOnOtherInput.checked = true;
}
/**
* Sets the default radio button based on the state of the app and
* the corresponding value to be submitted.
*/
@observe('rebaseOnCurrent', 'hasParent')
_updateSelectedOption(rebaseOnCurrent?: boolean, hasParent?: boolean) {
// Polymer 2: check for undefined
if (rebaseOnCurrent === undefined || hasParent === undefined) {
return;
}
if (this._displayParentOption(rebaseOnCurrent, hasParent)) {
this.$.rebaseOnParentInput.checked = true;
} else if (this._displayTipOption(rebaseOnCurrent, hasParent)) {
this.$.rebaseOnTipInput.checked = true;
} else {
this.$.rebaseOnOtherInput.checked = true;
}
}
}
declare global {
interface HTMLElementTagNameMap {
'gr-confirm-rebase-dialog': GrConfirmRebaseDialog;
}
}