Migration to Lit/Typescript of Code Owners
Also show shortened directory names in code-owners
Google-Bug-Id: b/237256547,b/241905566
Release-Notes: skip
Change-Id: I4d4b3bac9247f34e8710888275a71f85cfb638e4
diff --git a/web/owner-status-column.ts b/web/owner-status-column.ts
new file mode 100644
index 0000000..4b6f44d
--- /dev/null
+++ b/web/owner-status-column.ts
@@ -0,0 +1,259 @@
+/**
+ * @license
+ * Copyright (C) 2020 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 {
+ BasePatchSetNum,
+ RevisionPatchSetNum,
+} from '@gerritcodereview/typescript-api/rest-api';
+import {css, html, LitElement, nothing, PropertyValues} from 'lit';
+import {customElement, property} from 'lit/decorators';
+import {OwnerStatus} from './code-owners-api';
+import {FileStatus} from './code-owners-model';
+import {CodeOwnersModelMixin} from './code-owners-model-mixin';
+
+// TODO: Extend the API for plugins.
+export interface PatchRange {
+ patchNum: RevisionPatchSetNum;
+ basePatchNum: BasePatchSetNum;
+}
+
+const MAGIC_FILES = ['/COMMIT_MSG', '/MERGE_LIST', '/PATCHSET_LEVEL'];
+const STATUS_CODE = {
+ PENDING: 'pending',
+ PENDING_OLD_PATH: 'pending-old-path',
+ MISSING: 'missing',
+ MISSING_OLD_PATH: 'missing-old-path',
+ APPROVED: 'approved',
+ ERROR: 'error',
+ ERROR_OLD_PATH: 'error-old-path',
+};
+
+const STATUS_PRIORITY_ORDER = [
+ STATUS_CODE.ERROR,
+ STATUS_CODE.ERROR_OLD_PATH,
+ STATUS_CODE.MISSING,
+ STATUS_CODE.PENDING,
+ STATUS_CODE.MISSING_OLD_PATH,
+ STATUS_CODE.PENDING_OLD_PATH,
+ STATUS_CODE.APPROVED,
+];
+
+const STATUS_ICON = {
+ [STATUS_CODE.PENDING]: 'schedule',
+ [STATUS_CODE.MISSING]: 'close',
+ [STATUS_CODE.PENDING_OLD_PATH]: 'schedule',
+ [STATUS_CODE.MISSING_OLD_PATH]: ':close',
+ [STATUS_CODE.APPROVED]: 'check',
+ [STATUS_CODE.ERROR]: 'info',
+};
+
+const STATUS_TOOLTIP = {
+ [STATUS_CODE.PENDING]: 'Pending code owner approval',
+ [STATUS_CODE.MISSING]: 'Missing code owner approval',
+ [STATUS_CODE.PENDING_OLD_PATH]:
+ 'Pending code owner approval on pre-renamed file',
+ [STATUS_CODE.MISSING_OLD_PATH]:
+ 'Missing code owner approval on pre-renamed file',
+ [STATUS_CODE.APPROVED]: 'Approved by code owner',
+ [STATUS_CODE.ERROR]: 'Failed to fetch code owner status',
+ [STATUS_CODE.ERROR_OLD_PATH]: 'Failed to fetch code owner status',
+};
+
+const base = CodeOwnersModelMixin(LitElement);
+
+class BaseEl extends base {
+ @property({type: Object})
+ patchRange?: PatchRange;
+
+ computeHidden() {
+ const newerPatchsetUploaded = this.status?.newerPatchsetUploaded;
+ if (
+ this.change === undefined ||
+ this.patchRange === undefined ||
+ newerPatchsetUploaded === undefined
+ ) {
+ return true;
+ }
+ // if code-owners is not a submit requirement, don't show status column
+ if (
+ this.change.requirements &&
+ !this.change.requirements.find(r => r.type === 'code-owners')
+ ) {
+ return true;
+ }
+
+ if (newerPatchsetUploaded) return true;
+
+ const latestPatchset =
+ this.change.revisions![this.change.current_revision!];
+ // Note: in some special cases, patchNum is undefined on latest patchset
+ // like after publishing the edit, still show for them
+ // TODO: this should be fixed in Gerrit
+ if (this.patchRange?.patchNum === undefined) return false;
+ // only show if its latest patchset
+ if (`${this.patchRange.patchNum}` !== `${latestPatchset._number}`)
+ return true;
+ return false;
+ }
+}
+
+export const OWNERS_STATUS_COLUMN_HEADER = 'owner-status-column-header';
+/**
+ * Column header element for owner status.
+ */
+@customElement(OWNERS_STATUS_COLUMN_HEADER)
+export class OwnerStatusColumnHeader extends BaseEl {
+ static override get styles() {
+ return [
+ css`
+ :host() {
+ display: block;
+ padding-right: var(--spacing-m);
+ width: 3em;
+ }
+ `,
+ ];
+ }
+
+ override render() {
+ if (this.computeHidden()) return nothing;
+ return html`<div></div>`;
+ }
+}
+
+export const OWNER_STATUS_COLUMN_CONTENT = 'owner-status-column-content';
+/**
+ * Row content element for owner status.
+ */
+@customElement(OWNER_STATUS_COLUMN_CONTENT)
+export class OwnerStatusColumnContent extends BaseEl {
+ @property({type: String})
+ path?: string;
+
+ @property({type: String})
+ oldPath?: string;
+
+ @property({type: Array})
+ cleanlyMergedPaths?: Array<string>;
+
+ @property({type: Array})
+ cleanlyMergedOldPaths?: Array<string>;
+
+ @property({type: String, reflect: true, attribute: 'owner-status'})
+ ownerStatus?: string;
+
+ static override get styles() {
+ return [
+ css`
+ :host {
+ display: block;
+ padding-right: var(--spacing-m);
+ width: 3em;
+ text-align: center;
+ }
+ iron-icon {
+ padding: var(--spacing-xs) 0px;
+ }
+ :host([owner-status='approved']) iron-icon {
+ color: var(--positive-green-text-color);
+ }
+ :host([owner-status='pending']) iron-icon {
+ color: #ffa62f;
+ }
+ :host([owner-status='missing']) iron-icon,
+ :host([owner-status='error']) iron-icon {
+ color: var(--negative-red-text-color);
+ }
+ `,
+ ];
+ }
+
+ protected override willUpdate(changedProperties: PropertyValues): void {
+ super.willUpdate(changedProperties);
+ this.computeStatus();
+ }
+
+ override render() {
+ if (this.computeHidden() || this.status === undefined) return nothing;
+
+ const statusInfo = this.computeTooltip();
+ const statusIcon = this.computeIcon();
+ return html`
+ <gr-tooltip-content title=${statusInfo} has-tooltip>
+ <gr-icon icon=${statusIcon}></gr-icon>
+ </gr-tooltip-content>
+ `;
+ }
+
+ override loadPropertiesAfterModelChanged() {
+ super.loadPropertiesAfterModelChanged();
+ this.modelLoader?.loadStatus();
+ }
+
+ private computeStatus() {
+ if (
+ this.status === undefined ||
+ (this.cleanlyMergedPaths === undefined &&
+ (this.path === undefined || this.oldPath === undefined))
+ ) {
+ return;
+ }
+
+ const codeOwnerStatusMap = this.status.codeOwnerStatusMap;
+ const paths =
+ this.path === undefined ? this.cleanlyMergedPaths : [this.path];
+ const oldPaths =
+ this.oldPath === undefined ? this.cleanlyMergedOldPaths : [this.oldPath];
+
+ const statuses = (paths ?? [])
+ .filter(path => !MAGIC_FILES.includes(path))
+ .map(path => this.extractStatus(codeOwnerStatusMap.get(path)!, false));
+ // oldPath may contain null, so filter that as well.
+ const oldStatuses = (oldPaths ?? [])
+ .filter(path => !MAGIC_FILES.includes(path) && !!path)
+ .map(path => this.extractStatus(codeOwnerStatusMap.get(path)!, true));
+ const allStatuses = statuses.concat(oldStatuses);
+ if (allStatuses.length === 0) {
+ return;
+ }
+ this.ownerStatus = allStatuses.reduce((a, b) =>
+ STATUS_PRIORITY_ORDER.indexOf(a) < STATUS_PRIORITY_ORDER.indexOf(b)
+ ? a
+ : b
+ );
+ }
+
+ private computeIcon() {
+ return STATUS_ICON[this.ownerStatus!];
+ }
+
+ private computeTooltip() {
+ return STATUS_TOOLTIP[this.ownerStatus!];
+ }
+
+ private extractStatus(statusItem: FileStatus, oldPath: boolean) {
+ if (statusItem === undefined) {
+ return oldPath ? STATUS_CODE.ERROR_OLD_PATH : STATUS_CODE.ERROR;
+ } else if (statusItem.status === OwnerStatus.INSUFFICIENT_REVIEWERS) {
+ return oldPath ? STATUS_CODE.MISSING_OLD_PATH : STATUS_CODE.MISSING;
+ } else if (statusItem.status === OwnerStatus.PENDING) {
+ return oldPath ? STATUS_CODE.PENDING_OLD_PATH : STATUS_CODE.PENDING;
+ } else {
+ return STATUS_CODE.APPROVED;
+ }
+ }
+}
