blob: 31d511af0349294ac2a14a690238330f23618403 [file] [log] [blame]
/**
* @license
* Copyright 2022 Google LLC
* SPDX-License-Identifier: Apache-2.0
*/
import {
NumericChangeId,
RepoName,
RevisionPatchSetNum,
BasePatchSetNum,
ChangeInfo,
PatchSetNumber,
} from '../../api/rest-api';
import {Tab} from '../../constants/constants';
import {GerritView} from '../../services/router/router-model';
import {UrlEncodedCommentId} from '../../types/common';
import {toggleSet} from '../../utils/common-util';
import {select} from '../../utils/observable-util';
import {
encodeURL,
getBaseUrl,
getPatchRangeExpression,
} from '../../utils/url-util';
import {AttemptChoice} from '../checks/checks-util';
import {define} from '../dependency';
import {Model} from '../model';
import {ViewState} from './base';
export interface ChangeViewState extends ViewState {
view: GerritView.CHANGE;
changeNum: NumericChangeId;
repo: RepoName;
edit?: boolean;
patchNum?: RevisionPatchSetNum;
basePatchNum?: BasePatchSetNum;
commentId?: UrlEncodedCommentId;
/** This can be a string only for plugin provided tabs. */
tab?: Tab | string;
/** Checks related view state */
/** selected patchset for check runs (undefined=latest) */
checksPatchset?: PatchSetNumber;
/** regular expression for filtering check runs */
filter?: string;
/** selected attempt for check runs (undefined=latest) */
attempt?: AttemptChoice;
/** selected check runs identified by `checkName` */
checksRunsSelected?: Set<string>;
/** regular expression for filtering check results */
checksResultsFilter?: string;
/** State properties that trigger one-time actions */
/** for scrolling a Change Log message into view in gr-change-view */
messageHash?: string;
/** for logging where the user came from */
usp?: string;
/** triggers all change related data to be reloaded */
forceReload?: boolean;
/** triggers opening the reply dialog */
openReplyDialog?: boolean;
}
/**
* This is a convenience type such that you can pass a `ChangeInfo` object
* as the `change` property instead of having to set both the `changeNum` and
* `project` properties explicitly.
*/
export type CreateChangeUrlObject = Omit<
ChangeViewState,
'view' | 'changeNum' | 'repo'
> & {
change: Pick<ChangeInfo, '_number' | 'project'>;
};
export function isCreateChangeUrlObject(
state: CreateChangeUrlObject | Omit<ChangeViewState, 'view'>
): state is CreateChangeUrlObject {
return !!(state as CreateChangeUrlObject).change;
}
export function objToState(
obj: CreateChangeUrlObject | Omit<ChangeViewState, 'view'>
): ChangeViewState {
if (isCreateChangeUrlObject(obj)) {
return {
...obj,
view: GerritView.CHANGE,
changeNum: obj.change._number,
repo: obj.change.project,
};
}
return {...obj, view: GerritView.CHANGE};
}
export function createChangeUrl(
obj: CreateChangeUrlObject | Omit<ChangeViewState, 'view'>
) {
const state: ChangeViewState = objToState(obj);
let range = getPatchRangeExpression(state);
if (range.length) {
range = '/' + range;
}
let suffix = `${range}`;
const queries = [];
if (state.checksPatchset && state.checksPatchset > 0) {
queries.push(`checksPatchset=${state.checksPatchset}`);
}
if (state.attempt) {
if (state.attempt !== 'latest') queries.push(`attempt=${state.attempt}`);
}
if (state.filter) {
queries.push(`filter=${state.filter}`);
}
if (state.checksResultsFilter) {
queries.push(`checksResultsFilter=${state.checksResultsFilter}`);
}
if (state.checksRunsSelected && state.checksRunsSelected.size > 0) {
queries.push(`checksRunsSelected=${[...state.checksRunsSelected].sort()}`);
}
if (state.tab && state.tab !== Tab.FILES) {
queries.push(`tab=${state.tab}`);
}
if (state.forceReload) {
queries.push('forceReload=true');
}
if (state.openReplyDialog) {
queries.push('openReplyDialog=true');
}
if (state.usp) {
queries.push(`usp=${state.usp}`);
}
if (state.edit) {
suffix += ',edit';
}
if (state.commentId) {
suffix = suffix + `/comments/${state.commentId}`;
}
if (queries.length > 0) {
suffix += '?' + queries.join('&');
}
if (state.messageHash) {
suffix += state.messageHash;
}
if (state.repo) {
const encodedProject = encodeURL(state.repo, true);
return `${getBaseUrl()}/c/${encodedProject}/+/${state.changeNum}${suffix}`;
} else {
return `${getBaseUrl()}/c/${state.changeNum}${suffix}`;
}
}
export const changeViewModelToken =
define<ChangeViewModel>('change-view-model');
export class ChangeViewModel extends Model<ChangeViewState | undefined> {
public readonly tab$ = select(this.state$, state => state?.tab);
public readonly checksPatchset$ = select(
this.state$,
state => state?.checksPatchset
);
public readonly attempt$ = select(this.state$, state => state?.attempt);
public readonly filter$ = select(this.state$, state => state?.filter);
public readonly checksResultsFilter$ = select(
this.state$,
state => state?.checksResultsFilter ?? ''
);
public readonly checksRunsSelected$ = select(
this.state$,
state => state?.checksRunsSelected ?? new Set<string>()
);
constructor() {
super(undefined);
this.state$.subscribe(s => {
if (s?.usp || s?.forceReload || s?.openReplyDialog) {
this.updateState({
usp: undefined,
forceReload: undefined,
openReplyDialog: undefined,
});
}
});
}
toggleSelectedCheckRun(checkName: string) {
const current = this.getState()?.checksRunsSelected ?? new Set();
const next = new Set(current);
toggleSet(next, checkName);
this.updateState({checksRunsSelected: next});
}
}