Use ReadonlyArray for IContextMenuDelegate and IActionProvider and DropdownMenu

mjbvz · mjbvz · commit 1ef28f78ea14 · 2019-06-06T22:26:37.000-07:00
These classes do not (and should not) modify the input actions array. Use `ReadonlyArray` to enforce this
diff --git a/src/vs/base/browser/contextmenu.ts b/src/vs/base/browser/contextmenu.ts
@@ -24,7 +24,7 @@ export class ContextSubMenu extends SubmenuAction {
 
 export interface IContextMenuDelegate {
 	getAnchor(): HTMLElement | { x: number; y: number; width?: number; height?: number; };
-	getActions(): Array<IAction | ContextSubMenu>;
+	getActions(): ReadonlyArray<IAction | ContextSubMenu>;
 	getActionViewItem?(action: IAction): IActionViewItem | undefined;
 	getActionsContext?(event?: IContextMenuEvent): any;
 	getKeyBinding?(action: IAction): ResolvedKeybinding | undefined;
diff --git a/src/vs/base/browser/ui/actionbar/actionbar.ts b/src/vs/base/browser/ui/actionbar/actionbar.ts
@@ -16,7 +16,6 @@ import { StandardKeyboardEvent } from 'vs/base/browser/keyboardEvent';
 import { KeyCode, KeyMod } from 'vs/base/common/keyCodes';
 import { IContextViewProvider } from 'vs/base/browser/ui/contextview/contextview';
 import { Event, Emitter } from 'vs/base/common/event';
-import { asArray } from 'vs/base/common/arrays';
 
 export interface IActionViewItem {
 	actionRunner: IActionRunner;
@@ -596,8 +595,8 @@ export class ActionBar extends Disposable implements IActionRunner {
 		return this.domNode;
 	}
 
-	push(arg: IAction | IAction[], options: IActionOptions = {}): void {
-		const actions: IAction[] = asArray(arg);
+	push(arg: IAction | ReadonlyArray<IAction>, options: IActionOptions = {}): void {
+		const actions: ReadonlyArray<IAction> = Array.isArray(arg) ? arg : [arg];
 
 		let index = types.isNumber(options.index) ? options.index : null;
 
diff --git a/src/vs/base/browser/ui/dropdown/dropdown.ts b/src/vs/base/browser/ui/dropdown/dropdown.ts
@@ -192,20 +192,20 @@ export interface IContextMenuProvider {
 }
 
 export interface IActionProvider {
-	getActions(): IAction[];
+	getActions(): ReadonlyArray<IAction>;
 }
 
 export interface IDropdownMenuOptions extends IBaseDropdownOptions {
 	contextMenuProvider: IContextMenuProvider;
-	actions?: IAction[];
+	actions?: ReadonlyArray<IAction>;
 	actionProvider?: IActionProvider;
 	menuClassName?: string;
 }
 
 export class DropdownMenu extends BaseDropdown {
 	private _contextMenuProvider: IContextMenuProvider;
 	private _menuOptions: IMenuOptions;
-	private _actions: IAction[];
+	private _actions: ReadonlyArray<IAction>;
 	private actionProvider?: IActionProvider;
 	private menuClassName: string;
 
@@ -226,15 +226,15 @@ export class DropdownMenu extends BaseDropdown {
 		return this._menuOptions;
 	}
 
-	private get actions(): IAction[] {
+	private get actions(): ReadonlyArray<IAction> {
 		if (this.actionProvider) {
 			return this.actionProvider.getActions();
 		}
 
 		return this._actions;
 	}
 
-	private set actions(actions: IAction[]) {
+	private set actions(actions: ReadonlyArray<IAction>) {
 		this._actions = actions;
 	}
 
diff --git a/src/vs/base/browser/ui/menu/menu.ts b/src/vs/base/browser/ui/menu/menu.ts
@@ -78,7 +78,7 @@ export class Menu extends ActionBar {
 
 	private readonly _onScroll: Emitter<void>;
 
-	constructor(container: HTMLElement, actions: IAction[], options: IMenuOptions = {}) {
+	constructor(container: HTMLElement, actions: ReadonlyArray<IAction>, options: IMenuOptions = {}) {
 		addClass(container, 'monaco-menu-container');
 		container.setAttribute('role', 'presentation');
 		const menuElement = document.createElement('div');
diff --git a/src/vs/workbench/services/contextmenu/electron-browser/contextmenuService.ts b/src/vs/workbench/services/contextmenu/electron-browser/contextmenuService.ts
@@ -115,7 +115,7 @@ class NativeContextMenuService extends Disposable implements IContextMenuService
 		}
 	}
 
-	private createMenu(delegate: IContextMenuDelegate, entries: Array<IAction | ContextSubMenu>, onHide: () => void): IContextMenuItem[] {
+	private createMenu(delegate: IContextMenuDelegate, entries: ReadonlyArray<IAction | ContextSubMenu>, onHide: () => void): IContextMenuItem[] {
 		const actionRunner = delegate.actionRunner || new ActionRunner();
 
 		return entries.map(entry => this.createMenuItem(delegate, entry, actionRunner, onHide));

Original file line number	Diff line number	Diff line change
`@@ -192,20 +192,20 @@ export interface IContextMenuProvider {`
`192`	`192`	`}`
`193`	`193`
`194`	`194`	`export interface IActionProvider {`
`195`		`- getActions(): IAction[];`
	`195`	`+ getActions(): ReadonlyArray<IAction>;`
`196`	`196`	`}`
`197`	`197`
`198`	`198`	`export interface IDropdownMenuOptions extends IBaseDropdownOptions {`
`199`	`199`	`contextMenuProvider: IContextMenuProvider;`
`200`		`- actions?: IAction[];`
	`200`	`+ actions?: ReadonlyArray<IAction>;`
`201`	`201`	`actionProvider?: IActionProvider;`
`202`	`202`	`menuClassName?: string;`
`203`	`203`	`}`
`204`	`204`
`205`	`205`	`export class DropdownMenu extends BaseDropdown {`
`206`	`206`	`private _contextMenuProvider: IContextMenuProvider;`
`207`	`207`	`private _menuOptions: IMenuOptions;`
`208`		`- private _actions: IAction[];`
	`208`	`+ private _actions: ReadonlyArray<IAction>;`
`209`	`209`	`private actionProvider?: IActionProvider;`
`210`	`210`	`private menuClassName: string;`
`211`	`211`
`@@ -226,15 +226,15 @@ export class DropdownMenu extends BaseDropdown {`
`226`	`226`	`return this._menuOptions;`
`227`	`227`	`}`
`228`	`228`
`229`		`- private get actions(): IAction[] {`
	`229`	`+ private get actions(): ReadonlyArray<IAction> {`
`230`	`230`	`if (this.actionProvider) {`
`231`	`231`	`return this.actionProvider.getActions();`
`232`	`232`	`}`
`233`	`233`
`234`	`234`	`return this._actions;`
`235`	`235`	`}`
`236`	`236`
`237`		`- private set actions(actions: IAction[]) {`
	`237`	`+ private set actions(actions: ReadonlyArray<IAction>) {`
`238`	`238`	`this._actions = actions;`
`239`	`239`	`}`
`240`	`240`
Original file line number	Diff line number	Diff line change
`@@ -115,7 +115,7 @@ class NativeContextMenuService extends Disposable implements IContextMenuService`
`115`	`115`	`}`
`116`	`116`	`}`
`117`	`117`
`118`		`- private createMenu(delegate: IContextMenuDelegate, entries: Array<IAction \| ContextSubMenu>, onHide: () => void): IContextMenuItem[] {`
	`118`	`+ private createMenu(delegate: IContextMenuDelegate, entries: ReadonlyArray<IAction \| ContextSubMenu>, onHide: () => void): IContextMenuItem[] {`
`119`	`119`	`const actionRunner = delegate.actionRunner \|\| new ActionRunner();`
`120`	`120`
`121`	`121`	`return entries.map(entry => this.createMenuItem(delegate, entry, actionRunner, onHide));`