Add action list to cards with callback (#1392)

- Add the ActionDescriptor functionality. This is a table of information with actionable links
- Also add optional status indicator which shows a color. In the future, would like to extend to have icon in this space as an alternative.
- Fixed 1 issue with account management UI throwing an error on cancel

src/sql/parts/dashboard/common/dashboardPanelStyles.ts

@@ -71,12 +71,12 @@ registerThemingParticipant((theme: ITheme, collector: ICssStyleCollector) => {
 	}
 
 	// Panel title background
-	const tabBoarder = theme.getColor(TAB_BORDER);
-	if (tabBoarder) {
+	const tabBorder = theme.getColor(TAB_BORDER);
+	if (tabBorder) {
 		collector.addRule(`
 			panel.dashboard-panel > .tabbedPanel > .title .tabList .tab-header {
-				border-right-color: ${tabBoarder};
-				border-bottom-color: ${tabBoarder};
+				border-right-color: ${tabBorder};
+				border-bottom-color: ${tabBorder};
 			}
 		`);
 	}
@@ -86,13 +86,13 @@ registerThemingParticipant((theme: ITheme, collector: ICssStyleCollector) => {
 	if (outline) {
 		collector.addRule(`
 			panel.dashboard-panel > .tabbedPanel > .title {
-				border-bottom-color: ${tabBoarder};
+				border-bottom-color: ${tabBorder};
 				border-bottom-width: 1px;
 				border-bottom-style: solid;
 			}
 
 			panel.dashboard-panel > .tabbedPanel.vertical > .title {
-				border-right-color: ${tabBoarder};
+				border-right-color: ${tabBorder};
 				border-right-width: 1px;
 				border-right-style: solid;
 			}

src/sql/parts/modelComponents/card.component.html

@@ -0,0 +1,19 @@
+<div *ngIf="label" class="model-card">
+	<span *ngIf="hasStatus" class="card-status">
+		<div class="status-content" [style.backgroundColor]="statusColor"></div>
+	</span>
+	<div class="card-content">
+		<h4 class="card-label">{{label}}</h4>
+		<p class="card-value">{{value}}</p>
+		<span *ngIf="actions">
+			<table class="model-table">
+				<tr *ngFor="let action of actions">
+					<td class="table-row">{{action.label}}</td>
+					<td *ngIf="action.actionTitle" class="table-row">
+						<a class="pointer prominent" (click)="onDidActionClick(action)">{{action.actionTitle}}</a>
+					</td>
+				</tr>
+			</table>
+		</span>
+	</div>
+</div>

src/sql/parts/modelComponents/card.component.ts

@@ -9,29 +9,37 @@ import { Component, Input, Inject, ChangeDetectorRef, forwardRef, ComponentFacto
 } from '@angular/core';
 
 import * as sqlops from 'sqlops';
+import { ITheme, ICssStyleCollector } from 'vs/platform/theme/common/themeService';
+import * as colors from 'vs/platform/theme/common/colorRegistry';
 
 import { DashboardServiceInterface } from 'sql/parts/dashboard/services/dashboardServiceInterface.service';
 import { ComponentBase } from 'sql/parts/modelComponents/componentBase';
-import { IComponent, IComponentDescriptor, IModelStore } from 'sql/parts/modelComponents/interfaces';
+import { IComponent, IComponentDescriptor, IModelStore, ComponentEventType } from 'sql/parts/modelComponents/interfaces';
+import { BOOTSTRAP_SERVICE_ID, IBootstrapService } from 'sql/services/bootstrap/bootstrapService';
+import { IColorTheme } from 'vs/workbench/services/themes/common/workbenchThemeService';
+import { StatusIndicator, CardProperties, ActionDescriptor } from 'sql/workbench/api/common/sqlExtHostTypes';
 
 @Component({
-	template: `
-		<div *ngIf="label" class="model-card" >
-			<h4 class="card-label">{{label}}</h4>
-			<p class="card-value">{{value}}</p>
-		</div>
-	`
+	templateUrl: decodeURI(require.toUrl('sql/parts/modelComponents/card.component.html'))
 })
 export default class CardComponent extends ComponentBase implements IComponent, OnDestroy {
 	@Input() descriptor: IComponentDescriptor;
 	@Input() modelStore: IModelStore;
 
-	constructor(@Inject(forwardRef(() => ChangeDetectorRef)) changeRef: ChangeDetectorRef) {
+	private backgroundColor: string;
+
+	constructor(@Inject(forwardRef(() => ChangeDetectorRef)) changeRef: ChangeDetectorRef,
+		@Inject(forwardRef(() => ElementRef)) private _el: ElementRef,
+		@Inject(BOOTSTRAP_SERVICE_ID) private _bootstrapService: IBootstrapService
+	) {
 		super(changeRef);
 	}
 
 	ngOnInit(): void {
 		this.baseInit();
+		this._register(this._bootstrapService.themeService.onDidColorThemeChange(this.updateTheme, this));
+		this.updateTheme(this._bootstrapService.themeService.getColorTheme());
+
 	}
 
 	ngOnDestroy(): void {
@@ -52,15 +60,45 @@ export default class CardComponent extends ComponentBase implements IComponent,
 	// CSS-bound properties
 
 	public get label(): string {
-		return this.getPropertyOrDefault<sqlops.CardProperties, string>((props) => props.label, '');
+		return this.getPropertyOrDefault<CardProperties, string>((props) => props.label, '');
 	}
 
 	public get value(): string {
-		return this.getPropertyOrDefault<sqlops.CardProperties, string>((props) => props.value, '');
+		return this.getPropertyOrDefault<CardProperties, string>((props) => props.value, '');
 	}
 
-	public get actions(): sqlops.ActionDescriptor[] {
-		return this.getPropertyOrDefault<sqlops.CardProperties, sqlops.ActionDescriptor[]>((props) => props.actions, []);
+	public get actions(): ActionDescriptor[] {
+		return this.getPropertyOrDefault<CardProperties, ActionDescriptor[]>((props) => props.actions, []);
 	}
 
+	public hasStatus(): boolean {
+		let status = this.getPropertyOrDefault<CardProperties, StatusIndicator>((props) => props.status, StatusIndicator.None);
+		return status !== StatusIndicator.None;
+	}
+
+	public get statusColor(): string {
+		let status = this.getPropertyOrDefault<CardProperties, StatusIndicator>((props) => props.status, StatusIndicator.None);
+		switch(status) {
+			case StatusIndicator.Ok:
+				return 'green';
+			case StatusIndicator.Warning:
+				return 'orange';
+			case StatusIndicator.Error:
+				return 'red';
+			default:
+				return this.backgroundColor;
+		}
+	}
+
+	private updateTheme(theme: IColorTheme) {
+		this.backgroundColor = theme.getColor(colors.editorBackground, true).toString();
+	}
+
+	private onDidActionClick(action: ActionDescriptor): void {
+		this._onEventEmitter.fire({
+			eventType: ComponentEventType.onDidClick,
+			args: action
+		});
+
+	}
 }

src/sql/parts/modelComponents/card.css

@@ -2,12 +2,9 @@
 .model-card {
 	position: relative;
 	display: inline-block;
-	height: auto;
+	height: 90%;
 	width: auto;
 	margin: 15px;
-	padding: 10px 45px 20px 45px;
-	min-height: 30px;
-	min-width: 30px;
 	border-width: 1px;
     border-style: solid;
     border-color: rgb(214, 214, 214);
@@ -16,6 +13,16 @@
     box-shadow: rgba(120, 120, 120, 0.75) 0px 0px 6px;
 }
 
+.model-card .card-content {
+	position: relative;
+	display: inline-block;
+	height: auto;
+	width: auto;
+	padding: 10px 45px 20px 45px;
+	min-height: 30px;
+	min-width: 30px;
+}
+
 .model-card .card-label {
 	font-size: 12px;
 	font-weight: bold;
@@ -24,4 +31,42 @@
 .model-card .card-value {
 	font-size: 12px;
 	line-height: 18px;
-}
+}
+
+.model-card .card-status {
+	position: absolute;
+	top: 7px;
+	left: 5px;
+	overflow: hidden;
+	width: 22px;
+	height: 22px;
+}
+
+.model-card .status-content {
+	position: absolute;
+	top: 0px;
+	right: 0px;
+	min-width: 16px;
+	height: 16px;
+	border-radius: 8px;
+	text-align: center;
+}
+
+.model-card .model-table {
+	border-spacing: 5px;
+}
+
+.model-table .table-row {
+		width: auto;
+		clear: both;
+}
+
+.model-table .table-cell {
+		vertical-align: top;
+		padding: 7px;
+}
+
+.model-table a {
+	cursor: pointer;
+	text-decoration: underline
+}

src/sql/services/accountManagement/accountManagementService.ts

@@ -142,7 +142,7 @@ export class AccountManagementService implements IAccountManagementService {
 				})
 				.then(null, err => {
 					// On error, check to see if the error is because the user cancelled. If so, just ignore
-					if ('userCancelledSignIn' in err) {
+					if (err && 'userCancelledSignIn' in err) {
 						return Promise.resolve();
 					}
 					return Promise.reject(err);

src/sql/sqlops.proposed.d.ts

@@ -188,10 +188,24 @@ declare module 'sqlops' {
 		 */
 		label: string;
 		/**
-		 * ID of the task to be called when this is clicked on.
-		 * These should be registered using the {tasks.registerTask} API.
+		 * Name of the clickable action. If not defined then no action will be shown
 		 */
-		taskId: string;
+		actionTitle?: string;
+		/**
+		 * Data sent on callback being run.
+		 */
+		callbackData?: string;
+	}
+
+	/**
+	 * Defines status indicators that can be shown to the user as part of
+	 * components such as the Card UI
+	 */
+	export enum StatusIndicator {
+		None = 0,
+		Ok = 1,
+		Warning = 2,
+		Error = 3
 	}
 
 	/**
@@ -202,6 +216,7 @@ declare module 'sqlops' {
 		label: string;
 		value?: string;
 		actions?: ActionDescriptor[];
+		status?: StatusIndicator;
 	}
 
 	export interface InputBoxProperties {
@@ -230,6 +245,7 @@ declare module 'sqlops' {
 		label: string;
 		value: string;
 		actions?: ActionDescriptor[];
+		onDidActionClick: vscode.Event<ActionDescriptor>;
 	}
 
 	export interface InputBoxComponent extends Component, InputBoxProperties {

src/sql/workbench/api/common/sqlExtHostTypes.ts

@@ -118,3 +118,26 @@ export interface IModelViewButtonDetails {
 	enabled: boolean;
 	hidden: boolean;
 }
+
+/// Card-related APIs that need to be here to avoid early load issues
+// with enums causing requiring of sqlops API to fail.
+export enum StatusIndicator {
+	None = 0,
+	Ok = 1,
+	Warning = 2,
+	Error = 3
+}
+
+export interface CardProperties {
+	label: string;
+	value?: string;
+	actions?: ActionDescriptor[];
+	status?: StatusIndicator;
+}
+
+export interface ActionDescriptor {
+	label: string;
+	actionTitle?: string;
+	callbackData?: string;
+}
+

src/sql/workbench/api/node/extHostModelView.ts

@@ -14,6 +14,7 @@ import * as sqlops from 'sqlops';
 
 import { SqlMainContext, ExtHostModelViewShape, MainThreadModelViewShape } from 'sql/workbench/api/node/sqlExtHost.protocol';
 import { IItemConfig, ModelComponentTypes, IComponentShape, IComponentEventArgs, ComponentEventType } from 'sql/workbench/api/common/sqlExtHostTypes';
+import { IActionDescriptor } from 'vs/editor/standalone/browser/standaloneCodeEditor';
 
 class ModelBuilderImpl implements sqlops.ModelBuilder {
 	private nextComponentId: number;
@@ -306,7 +307,7 @@ class ComponentWrapper implements sqlops.Component {
 		} else if (eventArgs) {
 			let emitter = this._emitterMap.get(eventArgs.eventType);
 			if (emitter) {
-				emitter.fire();
+				emitter.fire(eventArgs.args);
 			}
 		}
 	}
@@ -362,6 +363,7 @@ class CardWrapper extends ComponentWrapper implements sqlops.CardComponent {
 	constructor(proxy: MainThreadModelViewShape, handle: number, id: string) {
 		super(proxy, handle, ModelComponentTypes.Card, id);
 		this.properties = {};
+		this._emitterMap.set(ComponentEventType.onDidClick, new Emitter<any>());
 	}
 
 	public get label(): string {
@@ -382,6 +384,11 @@ class CardWrapper extends ComponentWrapper implements sqlops.CardComponent {
 	public set actions(a: sqlops.ActionDescriptor[]) {
 		this.setProperty('actions', a);
 	}
+
+	public get onDidActionClick(): vscode.Event<sqlops.ActionDescriptor> {
+		let emitter = this._emitterMap.get(ComponentEventType.onDidClick);
+		return emitter && emitter.event;
+	}
 }
 
 class InputBoxWrapper extends ComponentWrapper implements sqlops.InputBoxComponent {

src/sql/workbench/api/node/sqlExtHost.api.impl.ts

@@ -365,7 +365,8 @@ export function createApiFactory(
 				dashboard,
 				workspace,
 				queryeditor: queryEditor,
-				ui: ui
+				ui: ui,
+				StatusIndicator: sqlExtHostTypes.StatusIndicator
 			};
 		}
 	};