Skip to content

Table use local storage for columns #1265

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Nov 18, 2021
Merged

Table use local storage for columns #1265

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
2998111
feat: use local storage to persist table columns
jake-bassett Nov 16, 2021
0c307dc
fix: typo
jake-bassett Nov 16, 2021
1399118
style: lint
jake-bassett Nov 17, 2021
8063982
style: prettier
jake-bassett Nov 17, 2021
cb94b05
Merge branch 'main' into table-use-local-storage-for-columns
jake-bassett Nov 18, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
58 changes: 34 additions & 24 deletions projects/observability/src/shared/dashboard/widgets/table/table-widget-renderer.component.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -124,11 +124,6 @@ import { TableWidgetModel } from './table-widget.model';
export class TableWidgetRendererComponent
extends WidgetRenderer<TableWidgetBaseModel, TableDataSource<TableRow> | undefined>
implements OnInit {
private static readonly DEFAULT_PREFERENCES: TableWidgetPreferences = {
columns: [],
checkboxes: []
};

private static readonly DEFAULT_TAB_INDEX: number = 0;

public viewItems: ToggleItem<string>[] = [];
Expand Down Expand Up @@ -228,7 +223,7 @@ export class TableWidgetRendererComponent
}

private getSelectControls(changed?: TableSelectControl): Observable<TableSelectControl[]> {
return this.getPreferences().pipe(
return this.getSessionPreferences().pipe(
take(1),
switchMap(preferences =>
forkJoinSafeEmpty(
Expand Down Expand Up @@ -300,7 +295,7 @@ export class TableWidgetRendererComponent
}

private getColumnConfigs(): Observable<TableColumnConfig[]> {
return this.getPreferences().pipe(
return this.getLocalPreferences().pipe(
switchMap(preferences =>
combineLatest([this.getScope(), this.api.change$.pipe(mapTo(true), startWith(true))]).pipe(
switchMap(([scope]) => this.model.getColumns(scope)),
Expand Down Expand Up @@ -366,8 +361,8 @@ export class TableWidgetRendererComponent

private updateSelectionPreferences(tableSelectControls: TableSelectControl[]): void {
if (isNonEmptyString(this.model.getId())) {
this.getPreferences().subscribe(preferences =>
this.setPreferences({
this.getSessionPreferences().subscribe(preferences =>
this.setSessionPreferences({
...preferences,
selections: tableSelectControls
})
Expand Down Expand Up @@ -401,8 +396,8 @@ export class TableWidgetRendererComponent

private updateCheckboxPreferences(tableCheckboxControls: TableCheckboxControl[]): void {
if (isNonEmptyString(this.model.getId())) {
this.getPreferences().subscribe(preferences =>
this.setPreferences({
this.getSessionPreferences().subscribe(preferences =>
this.setSessionPreferences({
...preferences,
checkboxes: tableCheckboxControls
})
Expand All @@ -411,7 +406,7 @@ export class TableWidgetRendererComponent
}

private getCheckboxControls(changed?: TableCheckboxChange): Observable<TableCheckboxControl[]> {
return this.getPreferences().pipe(
return this.getSessionPreferences().pipe(
switchMap(preferences =>
forkJoinSafeEmpty(
this.model
Expand Down Expand Up @@ -484,8 +479,8 @@ export class TableWidgetRendererComponent

public onColumnsChange(columns: TableColumnConfig[]): void {
if (isNonEmptyString(this.model.getId())) {
this.getPreferences().subscribe(preferences =>
this.setPreferences({
this.getLocalPreferences().subscribe(preferences =>
this.setLocalPreferences({
...preferences,
columns: columns.map(column => this.dehydratePersistedColumnConfig(column))
})
Expand All @@ -500,7 +495,7 @@ export class TableWidgetRendererComponent
public onRowSelection(selections: StatefulTableRow[]): void {
this.selectedRows = selections;
/**
* Todo: Stich this with selection handlers
* Todo: Stitch this with selection handlers
*/
}

Expand Down Expand Up @@ -552,27 +547,39 @@ export class TableWidgetRendererComponent

private getViewPreferences(): Observable<TableWidgetViewPreferences> {
return isNonEmptyString(this.model.viewId)
? this.preferenceService.get<TableWidgetViewPreferences>(this.model.viewId, {}, StorageType.Session).pipe(first())
? this.preferenceService.get<TableWidgetViewPreferences>(this.model.viewId, {}, StorageType.Local).pipe(first())
: of({});
}

private setViewPreferences(preferences: TableWidgetViewPreferences): void {
if (isNonEmptyString(this.model.viewId)) {
this.preferenceService.set(this.model.viewId, preferences, StorageType.Session);
this.preferenceService.set(this.model.viewId, preferences, StorageType.Local);
}
}

private getLocalPreferences(): Observable<TableWidgetLocalPreferences> {
return isNonEmptyString(this.model.getId())
? this.preferenceService
.get<TableWidgetLocalPreferences>(this.model.getId()!, {}, StorageType.Local)
.pipe(first())
: of({});
}

private setLocalPreferences(preferences: TableWidgetLocalPreferences): void {
if (isNonEmptyString(this.model.getId())) {
this.preferenceService.set(this.model.getId()!, preferences, StorageType.Local);
}
}

private getPreferences(
defaultPreferences: TableWidgetPreferences = TableWidgetRendererComponent.DEFAULT_PREFERENCES
): Observable<TableWidgetPreferences> {
private getSessionPreferences(): Observable<TableWidgetSessionPreferences> {
return isNonEmptyString(this.model.getId())
? this.preferenceService
.get<TableWidgetPreferences>(this.model.getId()!, defaultPreferences, StorageType.Session)
.get<TableWidgetSessionPreferences>(this.model.getId()!, {}, StorageType.Session)
.pipe(first())
: of(defaultPreferences);
: of({});
}

private setPreferences(preferences: TableWidgetPreferences): void {
private setSessionPreferences(preferences: TableWidgetSessionPreferences): void {
if (isNonEmptyString(this.model.getId())) {
this.preferenceService.set(this.model.getId()!, preferences, StorageType.Session);
}
Expand Down Expand Up @@ -607,8 +614,11 @@ interface TableWidgetViewPreferences {
activeView?: string;
}

interface TableWidgetPreferences {
interface TableWidgetLocalPreferences {
columns?: PersistedTableColumnConfig[];
}

interface TableWidgetSessionPreferences {
checkboxes?: TableCheckboxControl[];
selections?: TableSelectControl[];
}
Expand Down