mirror of https://github.com/grafana/grafana
Registry: add a reusable function registry (#17047)
Ryan McKinley
6 years ago
committed by
GitHub
parent
5151b8ce07
commit
c194ae1ba5
@ -0,0 +1,10 @@ |
||||
/** |
||||
* Used in select elements |
||||
*/ |
||||
export interface SelectableValue<T = any> { |
||||
label?: string; |
||||
value?: T; |
||||
imgUrl?: string; |
||||
description?: string; |
||||
[key: string]: any; |
||||
} |
||||
@ -0,0 +1,134 @@ |
||||
import { SelectableValue } from '../types/select'; |
||||
|
||||
export interface RegistryItem { |
||||
id: string; // Unique Key -- saved in configs
|
||||
name: string; // Display Name, can change without breaking configs
|
||||
description: string; |
||||
aliasIds?: string[]; // when the ID changes, we may want backwards compatibility ('current' => 'last')
|
||||
|
||||
/** |
||||
* Some extensions should not be user selectable |
||||
* like: 'all' and 'any' matchers; |
||||
*/ |
||||
excludeFromPicker?: boolean; |
||||
} |
||||
|
||||
interface RegistrySelectInfo { |
||||
options: Array<SelectableValue<string>>; |
||||
current: Array<SelectableValue<string>>; |
||||
} |
||||
|
||||
export class Registry<T extends RegistryItem> { |
||||
private ordered: T[] = []; |
||||
private byId = new Map<string, T>(); |
||||
private initalized = false; |
||||
|
||||
constructor(private init?: () => T[]) {} |
||||
|
||||
getIfExists(id: string | undefined): T | undefined { |
||||
if (!this.initalized) { |
||||
if (this.init) { |
||||
for (const ext of this.init()) { |
||||
this.register(ext); |
||||
} |
||||
} |
||||
this.sort(); |
||||
this.initalized = true; |
||||
} |
||||
if (id) { |
||||
return this.byId.get(id); |
||||
} |
||||
return undefined; |
||||
} |
||||
|
||||
get(id: string): T { |
||||
const v = this.getIfExists(id); |
||||
if (!v) { |
||||
throw new Error('Undefined: ' + id); |
||||
} |
||||
return v; |
||||
} |
||||
|
||||
selectOptions(current?: string[], filter?: (ext: T) => boolean): RegistrySelectInfo { |
||||
if (!this.initalized) { |
||||
this.getIfExists('xxx'); // will trigger init
|
||||
} |
||||
|
||||
const select = { |
||||
options: [], |
||||
current: [], |
||||
} as RegistrySelectInfo; |
||||
|
||||
const currentIds: any = {}; |
||||
if (current) { |
||||
for (const id of current) { |
||||
currentIds[id] = true; |
||||
} |
||||
} |
||||
|
||||
for (const ext of this.ordered) { |
||||
if (ext.excludeFromPicker) { |
||||
continue; |
||||
} |
||||
if (filter && !filter(ext)) { |
||||
continue; |
||||
} |
||||
|
||||
const option = { |
||||
value: ext.id, |
||||
label: ext.name, |
||||
description: ext.description, |
||||
}; |
||||
|
||||
select.options.push(option); |
||||
if (currentIds[ext.id]) { |
||||
select.current.push(option); |
||||
} |
||||
} |
||||
return select; |
||||
} |
||||
|
||||
/** |
||||
* Return a list of values by ID, or all values if not specified |
||||
*/ |
||||
list(ids?: any[]): T[] { |
||||
if (ids) { |
||||
const found: T[] = []; |
||||
for (const id of ids) { |
||||
const v = this.getIfExists(id); |
||||
if (v) { |
||||
found.push(v); |
||||
} |
||||
} |
||||
return found; |
||||
} |
||||
if (!this.initalized) { |
||||
this.getIfExists('xxx'); // will trigger init
|
||||
} |
||||
return [...this.ordered]; // copy of everythign just in case
|
||||
} |
||||
|
||||
register(ext: T) { |
||||
if (this.byId.has(ext.id)) { |
||||
throw new Error('Duplicate Key:' + ext.id); |
||||
} |
||||
this.byId.set(ext.id, ext); |
||||
this.ordered.push(ext); |
||||
|
||||
if (ext.aliasIds) { |
||||
for (const alias of ext.aliasIds) { |
||||
if (!this.byId.has(alias)) { |
||||
this.byId.set(alias, ext); |
||||
} |
||||
} |
||||
} |
||||
|
||||
if (this.initalized) { |
||||
this.sort(); |
||||
} |
||||
} |
||||
|
||||
private sort() { |
||||
// TODO sort the list
|
||||
} |
||||
} |
||||
Loading…
Reference in new issue