Move render only properties to RenderPreferences
Certain preferences cannot be changes by the users and are only
meant to determine the rendering of diff.
Move these properties to RenderPreferences.
Once other users of gr-diff have migrated, we can remove these
properties from DiffPreferencesInfo.
Change-Id: I80b92b8ae74877558321899f2426c36d244c12eb
diff --git a/polygerrit-ui/app/api/diff.ts b/polygerrit-ui/app/api/diff.ts
index 39a4441..2afdca5 100644
--- a/polygerrit-ui/app/api/diff.ts
+++ b/polygerrit-ui/app/api/diff.ts
@@ -179,6 +179,7 @@
export declare interface RenderPreferences {
hide_left_side?: boolean;
disable_context_control_buttons?: boolean;
+ show_file_comment_button?: boolean;
}
/**
diff --git a/polygerrit-ui/app/elements/diff/gr-diff-builder/gr-diff-builder-element.ts b/polygerrit-ui/app/elements/diff/gr-diff-builder/gr-diff-builder-element.ts
index de68554..a506462 100644
--- a/polygerrit-ui/app/elements/diff/gr-diff-builder/gr-diff-builder-element.ts
+++ b/polygerrit-ui/app/elements/diff/gr-diff-builder/gr-diff-builder-element.ts
@@ -43,7 +43,7 @@
GrRangedCommentLayer,
} from '../gr-ranged-comment-layer/gr-ranged-comment-layer';
import {GrCoverageLayer} from '../gr-coverage-layer/gr-coverage-layer';
-import {DiffViewMode} from '../../../api/diff';
+import {DiffViewMode, RenderPreferences} from '../../../api/diff';
import {Side} from '../../../constants/constants';
import {GrDiffLine, LineNumber} from '../gr-diff/gr-diff-line';
import {GrDiffGroup} from '../gr-diff/gr-diff-group';
@@ -183,7 +183,11 @@
return coverageRanges.filter(range => range && range.side === 'right');
}
- render(keyLocations: KeyLocations, prefs: DiffPreferencesInfo) {
+ render(
+ keyLocations: KeyLocations,
+ prefs: DiffPreferencesInfo,
+ renderPrefs?: RenderPreferences
+ ) {
// Setting up annotation layers must happen after plugins are
// installed, and |render| satisfies the requirement, however,
// |attached| doesn't because in the diff view page, the element is
@@ -202,7 +206,7 @@
if (!this.diff) {
throw Error('Cannot render a diff without DiffInfo.');
}
- this._builder = this._getDiffBuilder(this.diff, prefs);
+ this._builder = this._getDiffBuilder(this.diff, prefs, renderPrefs);
this.$.processor.context = prefs.context;
this.$.processor.keyLocations = keyLocations;
@@ -344,7 +348,11 @@
throw Error(`Invalid preference value: ${pref}`);
}
- _getDiffBuilder(diff: DiffInfo, prefs: DiffPreferencesInfo): GrDiffBuilder {
+ _getDiffBuilder(
+ diff: DiffInfo,
+ prefs: DiffPreferencesInfo,
+ renderPrefs?: RenderPreferences
+ ): GrDiffBuilder {
if (isNaN(prefs.tab_size) || prefs.tab_size <= 0) {
this._handlePreferenceError('tab size');
}
@@ -367,7 +375,8 @@
localPrefs,
this.diffElement,
this.baseImage,
- this.revisionImage
+ this.revisionImage,
+ renderPrefs
);
} else if (diff.binary) {
// If the diff is binary, but not an image.
@@ -377,14 +386,16 @@
diff,
localPrefs,
this.diffElement,
- this._layers
+ this._layers,
+ renderPrefs
);
} else if (this.viewMode === DiffViewMode.UNIFIED) {
builder = new GrDiffBuilderUnified(
diff,
localPrefs,
this.diffElement,
- this._layers
+ this._layers,
+ renderPrefs
);
}
if (!builder) {
diff --git a/polygerrit-ui/app/elements/diff/gr-diff-builder/gr-diff-builder-image.ts b/polygerrit-ui/app/elements/diff/gr-diff-builder/gr-diff-builder-image.ts
index 5b3f225..fb37349 100644
--- a/polygerrit-ui/app/elements/diff/gr-diff-builder/gr-diff-builder-image.ts
+++ b/polygerrit-ui/app/elements/diff/gr-diff-builder/gr-diff-builder-image.ts
@@ -19,6 +19,7 @@
import {ImageInfo} from '../../../types/common';
import {DiffInfo, DiffPreferencesInfo} from '../../../types/diff';
import {GrEndpointParam} from '../../plugins/gr-endpoint-param/gr-endpoint-param';
+import {RenderPreferences} from '../../../api/diff';
// MIME types for images we allow showing. Do not include SVG, it can contain
// arbitrary JavaScript.
@@ -30,9 +31,10 @@
prefs: DiffPreferencesInfo,
outputEl: HTMLElement,
private readonly _baseImage: ImageInfo | null,
- private readonly _revisionImage: ImageInfo | null
+ private readonly _revisionImage: ImageInfo | null,
+ renderPrefs?: RenderPreferences
) {
- super(diff, prefs, outputEl, []);
+ super(diff, prefs, outputEl, [], renderPrefs);
}
public renderDiff() {
diff --git a/polygerrit-ui/app/elements/diff/gr-diff-builder/gr-diff-builder-side-by-side.ts b/polygerrit-ui/app/elements/diff/gr-diff-builder/gr-diff-builder-side-by-side.ts
index 2025732..51b8135 100644
--- a/polygerrit-ui/app/elements/diff/gr-diff-builder/gr-diff-builder-side-by-side.ts
+++ b/polygerrit-ui/app/elements/diff/gr-diff-builder/gr-diff-builder-side-by-side.ts
@@ -21,15 +21,17 @@
import {GrDiffLine, LineNumber} from '../gr-diff/gr-diff-line';
import {DiffViewMode, Side} from '../../../constants/constants';
import {DiffLayer} from '../../../types/types';
+import {RenderPreferences} from '../../../api/diff';
export class GrDiffBuilderSideBySide extends GrDiffBuilder {
constructor(
diff: DiffInfo,
prefs: DiffPreferencesInfo,
outputEl: HTMLElement,
- readonly layers: DiffLayer[] = []
+ readonly layers: DiffLayer[] = [],
+ renderPrefs?: RenderPreferences
) {
- super(diff, prefs, outputEl, layers);
+ super(diff, prefs, outputEl, layers, renderPrefs);
}
_getMoveControlsConfig() {
diff --git a/polygerrit-ui/app/elements/diff/gr-diff-builder/gr-diff-builder-unified.ts b/polygerrit-ui/app/elements/diff/gr-diff-builder/gr-diff-builder-unified.ts
index 1bf3d69..e927fdf 100644
--- a/polygerrit-ui/app/elements/diff/gr-diff-builder/gr-diff-builder-unified.ts
+++ b/polygerrit-ui/app/elements/diff/gr-diff-builder/gr-diff-builder-unified.ts
@@ -20,15 +20,17 @@
import {DiffInfo, DiffPreferencesInfo} from '../../../types/diff';
import {DiffViewMode, Side} from '../../../constants/constants';
import {DiffLayer} from '../../../types/types';
+import {RenderPreferences} from '../../../api/diff';
export class GrDiffBuilderUnified extends GrDiffBuilder {
constructor(
diff: DiffInfo,
prefs: DiffPreferencesInfo,
outputEl: HTMLElement,
- readonly layers: DiffLayer[] = []
+ readonly layers: DiffLayer[] = [],
+ renderPrefs?: RenderPreferences
) {
- super(diff, prefs, outputEl, layers);
+ super(diff, prefs, outputEl, layers, renderPrefs);
}
_getMoveControlsConfig() {
diff --git a/polygerrit-ui/app/elements/diff/gr-diff-builder/gr-diff-builder.ts b/polygerrit-ui/app/elements/diff/gr-diff-builder/gr-diff-builder.ts
index da1b928..1da2051 100644
--- a/polygerrit-ui/app/elements/diff/gr-diff-builder/gr-diff-builder.ts
+++ b/polygerrit-ui/app/elements/diff/gr-diff-builder/gr-diff-builder.ts
@@ -17,6 +17,7 @@
import {
ContentLoadNeededEventDetail,
MovedLinkClickedEventDetail,
+ RenderPreferences,
} from '../../../api/diff';
import {getBaseUrl} from '../../../utils/url-util';
import {GrDiffLine, GrDiffLineType, LineNumber} from '../gr-diff/gr-diff-line';
@@ -76,6 +77,8 @@
private readonly _prefs: DiffPreferencesInfo;
+ private readonly _renderPrefs?: RenderPreferences;
+
protected readonly _outputEl: HTMLElement;
readonly groups: GrDiffGroup[];
@@ -92,7 +95,8 @@
diff: DiffInfo,
prefs: DiffPreferencesInfo,
outputEl: HTMLElement,
- readonly layers: DiffLayer[] = []
+ readonly layers: DiffLayer[] = [],
+ renderPrefs?: RenderPreferences
) {
this._diff = diff;
this._numLinesLeft = this._diff.content
@@ -102,6 +106,7 @@
}, 0)
: 0;
this._prefs = prefs;
+ this._renderPrefs = renderPrefs;
this._outputEl = outputEl;
this.groups = [];
this._blameInfo = null;
@@ -542,7 +547,9 @@
td.dataset['value'] = number.toString();
if (
- (this._prefs.show_file_comment_button === false && number === 'FILE') ||
+ ((this._prefs.show_file_comment_button === false ||
+ this._renderPrefs?.show_file_comment_button) === false &&
+ number === 'FILE') ||
number === 'LOST'
) {
return td;
diff --git a/polygerrit-ui/app/elements/diff/gr-diff/gr-diff.ts b/polygerrit-ui/app/elements/diff/gr-diff/gr-diff.ts
index 3fb1a50..f4f0ce0 100644
--- a/polygerrit-ui/app/elements/diff/gr-diff/gr-diff.ts
+++ b/polygerrit-ui/app/elements/diff/gr-diff/gr-diff.ts
@@ -800,15 +800,17 @@
const keyLocations = this._computeKeyLocations();
const bypassPrefs = this._getBypassPrefs(this.prefs);
- this.$.diffBuilder.render(keyLocations, bypassPrefs).then(() => {
- this.dispatchEvent(
- new CustomEvent('render', {
- bubbles: true,
- composed: true,
- detail: {contentRendered: true},
- })
- );
- });
+ this.$.diffBuilder
+ .render(keyLocations, bypassPrefs, this.renderPrefs)
+ .then(() => {
+ this.dispatchEvent(
+ new CustomEvent('render', {
+ bubbles: true,
+ composed: true,
+ detail: {contentRendered: true},
+ })
+ );
+ });
}
_handleRenderContent() {
