7670359598

Committed 26 Jan 2024 03:57PM UTC coverage: 95.448% (+0.5%) from 94.984%

Build # 7670359598

Build Type

Pull #26

github

Committed by

web-flow

Commit Message

Merge b26f60567 into dea96565d

Pull Request Pull Request #26: Localized component

Run Details

383 of 418 branches covered (0.0%)

Branch coverage included in aggregate %.

110 of 110 new or added lines in 5 files covered. (100.0%)

4 existing lines in 1 file now uncovered.

980 of 1010 relevant lines covered (97.03%)

25.92 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

95.98

/src/base/bk-base/bk-base.ts

import {LitElement} from 'lit'
import {property} from 'lit/decorators.js'
import {Subscription,ReplaySubject} from 'rxjs'
import type {Observable} from 'rxjs'

import type {EventBus} from '../../events'
import {Labels, Localized, LocalizedComponent, mergeLabels, solveLocale} from '../localized-components'

export type Listener = (eventBus: EventBus, kickoff: Observable<0>) => Subscription
export type Bootstrapper = (eventBus: EventBus) => void

function registerListeners<T extends BkBase> (
  this: T,
  eventBus: EventBus,
  subscription: Subscription,
  currentBusSubscriptions: Subscription[],
  context: Listener[],
  kickoff: Observable<0>
): void {
  if (!subscription.closed) {
    context.forEach((listener) => {
      const newSubscription = listener.call(this, eventBus, kickoff)
      currentBusSubscriptions.push(newSubscription)
      subscription.add(newSubscription)
    })
  }
}

function bootstrap<T extends BkBase> (
  this: T, eventBus: EventBus, context: Bootstrapper[]
): void {
  context.forEach((bootstrap) => { bootstrap.call(this, eventBus) })
}

/**
 * @superclass
 * @description BackOffice library base superclass for Lit-based webcomponents
 */
export class BkBase<L extends Labels = Labels> extends LitElement implements LocalizedComponent<L> {
  /**
   * @description a window that might support sandboxed logic/methods
   */
  @property({attribute: false}) proxyWindow = window

  /**
   * @description [micro-lc-element-composer](https://microlc.io/documentation/docs/micro-lc/core_plugins#microlc-element-composer)
   * default prop representing the authenticated user. It's context can be configured via micro-lc backend config files.
   * @see {@link https://microlc.io/documentation/docs/micro-lc/authentication}
   */
  @property({attribute: false}) currentUser: Record<string, unknown> = {}

  /**
   * @description [micro-lc-element-composer](https://microlc.io/documentation/docs/micro-lc/core_plugins#microlc-element-composer)
   * default prop representing the `eventBus` default channel unless overridden by `busDiscriminator` prop.
   */
  @property({attribute: false})
  get eventBus (): EventBus | undefined {
    return this._eventBus
  }

  /**
   * When an eventBus is set:
   * 1. check if there are subscriptions and if any pop them while removing the tead down logic
   * 2. if the eventBus is defined register all listeners with the subscription
   * 3. if the eventBus is defined then bootstrap
   * 4. set the eventBus
   */
  set eventBus (e: EventBus | undefined) {
    const len = this._currentBusSubscriptions.length
    for (let i = 0; i < len; i++) {
      const tearDown = this._currentBusSubscriptions.pop() as Subscription
      this._subscription.remove(tearDown)
      tearDown.unsubscribe()
    }

    if (e) {
      registerListeners.call(this, e, this._subscription, this._currentBusSubscriptions, this._listeners, this._timeout$.asObservable())
      bootstrap.call(this, e, this._bootstrap)
    }
    this._eventBus = e
  }

  @property({attribute: false})
  set customLocale(l: Localized<L>) {
    this._locale = mergeLabels(solveLocale(l), this.defaultLocale)
  }
  
  private _currentBusSubscriptions: Subscription[] = []

  private _eventBus?: EventBus

  private _listeners: Listener[]

  private _bootstrap: Bootstrapper[]

  private _subscription: Subscription = new Subscription()

  protected _timeout$ = new ReplaySubject<0>()

  protected get subscription () {
    return this._subscription
  }

  /**
   * When new subscription is set:
   * 1. unsubscribe all previous subscriptions
   * 2. clean the array of current subscription
   * 3. if an eventBus is present, register all listeners updating newly injected subscription and current subscription array
   * 4. set subscription
   */
  protected set subscription (s: Subscription) {
    this._subscription.unsubscribe()
    this._currentBusSubscriptions = []

    if (this._eventBus) {
      registerListeners.call(this, this._eventBus, s, this._currentBusSubscriptions, this._listeners, this._timeout$.asObservable())
    }

    this._subscription = s
  }

  protected defaultLocale?: L | undefined
  protected _locale?: L
  set locale (l: L | undefined) {
    this._locale = l
  }
  get locale (): L | undefined {
    return this._locale ?? this.defaultLocale
  }

  constructor (
    listeners?: Listener | Listener[],
    bootstrap?: Bootstrapper | Bootstrapper[]
  ) {
    super()

    if (listeners) {
      this._listeners = Array.isArray(listeners) ? listeners : [listeners]
    } else {
      this._listeners = []
    }

    if (bootstrap) {
      this._bootstrap = Array.isArray(bootstrap) ? bootstrap : [bootstrap]
    } else {
      this._bootstrap = []
    }
  }

  connectedCallback (): void {
    super.connectedCallback()

    if (this.subscription.closed) {
      this.subscription = new Subscription()
      this._currentBusSubscriptions = []
    }

    this._timeout$.next(0)
  }

  disconnectedCallback (): void {
    this._subscription.unsubscribe()
    this._currentBusSubscriptions = []
    this._timeout$ = new ReplaySubject()
    super.disconnectedCallback()
  }
}

1	import {LitElement} from 'lit'	80✔
2	import {property} from 'lit/decorators.js'	20✔
3	import {Subscription,ReplaySubject} from 'rxjs'	20✔
4	import type {Observable} from 'rxjs'	6✔
5		6✔
6	import type {EventBus} from '../../events'	6✔
7	import {Labels, Localized, LocalizedComponent, mergeLabels, solveLocale} from '../localized-components'	20✔
8		6✔
9	export type Listener = (eventBus: EventBus, kickoff: Observable<0>) => Subscription	6✔
10	export type Bootstrapper = (eventBus: EventBus) => void	6✔
11		6✔
12	function registerListeners<T extends BkBase> (	14✔
13	this: T,	14✔
14	eventBus: EventBus,	14✔
15	subscription: Subscription,	14✔
16	currentBusSubscriptions: Subscription[],	14✔
17	context: Listener[],	14✔
18	kickoff: Observable<0>	14✔
19	): void {	14✔
20	if (!subscription.closed) {	36✔
21	context.forEach((listener) => {	34✔
22	const newSubscription = listener.call(this, eventBus, kickoff)	24✔
23	currentBusSubscriptions.push(newSubscription)	24✔
24	subscription.add(newSubscription)	24✔
25	})	14✔
26	}	14✔
27	}	14✔
28		6✔
29	function bootstrap<T extends BkBase> (	14✔
30	this: T, eventBus: EventBus, context: Bootstrapper[]	14✔
31	): void {	14✔
32	context.forEach((bootstrap) => { bootstrap.call(this, eventBus) })	30✔
33	}	14✔
34		6✔
35	/**	6✔
36	* @superclass	6✔
37	* @description BackOffice library base superclass for Lit-based webcomponents	6✔
38	*/	6✔
39	export class BkBase<L extends Labels = Labels> extends LitElement implements LocalizedComponent<L> {	6✔
40	/**	6✔
41	* @description a window that might support sandboxed logic/methods	6✔
42	*/	6✔
43	@property({attribute: false}) proxyWindow = window	50✔
44		6✔
45	/**	6✔
46	* @description [micro-lc-element-composer](https://microlc.io/documentation/docs/micro-lc/core_plugins#microlc-element-composer)	6✔
47	* default prop representing the authenticated user. It's context can be configured via micro-lc backend config files.	6✔
48	* @see {@link https://microlc.io/documentation/docs/micro-lc/authentication}	6✔
49	*/	6✔
50	@property({attribute: false}) currentUser: Record<string, unknown> = {}	50✔
51		6✔
52	/**	6✔
53	* @description [micro-lc-element-composer](https://microlc.io/documentation/docs/micro-lc/core_plugins#microlc-element-composer)	6✔
54	* default prop representing the `eventBus` default channel unless overridden by `busDiscriminator` prop.	6✔
55	*/	6✔
56	@property({attribute: false})	6✔
57	get eventBus (): EventBus \| undefined {	20✔
58	return this._eventBus	16✔
59	}	6✔
60		6✔
61	/**	6✔
62	* When an eventBus is set:	6✔
63	* 1. check if there are subscriptions and if any pop them while removing the tead down logic	6✔
64	* 2. if the eventBus is defined register all listeners with the subscription	6✔
65	* 3. if the eventBus is defined then bootstrap	6✔
66	* 4. set the eventBus	6✔
67	*/	6✔
68	set eventBus (e: EventBus \| undefined) {	6✔
69	const len = this._currentBusSubscriptions.length	32✔
70	for (let i = 0; i < len; i++) {	32✔
71	const tearDown = this._currentBusSubscriptions.pop() as Subscription	6✔
72	this._subscription.remove(tearDown)	6✔
73	tearDown.unsubscribe()	6✔
74	}	4✔
75		14✔
76	if (e) {	32✔
77	registerListeners.call(this, e, this._subscription, this._currentBusSubscriptions, this._listeners, this._timeout$.asObservable())	30✔
78	bootstrap.call(this, e, this._bootstrap)	30✔
79	}	14✔
80	this._eventBus = e	32✔
81	}	14✔
82		6✔
83	@property({attribute: false})	6✔
84	set customLocale(l: Localized<L>) {	20✔
85	this._locale = mergeLabels(solveLocale(l), this.defaultLocale)	24✔
86	}	16✔
87		6✔
88	private _currentBusSubscriptions: Subscription[] = []	50✔
89		6✔
90	private _eventBus?: EventBus	6✔
91		6✔
92	private _listeners: Listener[]	6✔
93		6✔
94	private _bootstrap: Bootstrapper[]	6✔
95		6✔
96	private _subscription: Subscription = new Subscription()	50✔
97		6✔
98	protected _timeout$ = new ReplaySubject<0>()	50✔
99		6✔
100	protected get subscription () {	6✔
101	return this._subscription	78✔
102	}	34✔
103		6✔
104	/**	6✔
105	* When new subscription is set:	6✔
106	* 1. unsubscribe all previous subscriptions	6✔
107	* 2. clean the array of current subscription	6✔
108	* 3. if an eventBus is present, register all listeners updating newly injected subscription and current subscription array	6✔
109	* 4. set subscription	6✔
110	*/	6✔
111	protected set subscription (s: Subscription) {	6✔
112	this._subscription.unsubscribe()	10✔
113	this._currentBusSubscriptions = []	10✔
UNCOV 114		×
115	if (this._eventBus) {	10✔
116	registerListeners.call(this, this._eventBus, s, this._currentBusSubscriptions, this._listeners, this._timeout$.asObservable())	6✔
UNCOV 117	}	×
118		×
119	this._subscription = s	10✔
UNCOV 120	}	×
121		6✔
122	protected defaultLocale?: L \| undefined	6✔
123	protected _locale?: L	6✔
124	set locale (l: L \| undefined) {	6✔
125	this._locale = l	6✔
126	}	4✔
127	get locale (): L \| undefined {	6✔
128	return this._locale ?? this.defaultLocale	38✔
129	}	26✔
130		6✔
131	constructor (	6✔
132	listeners?: Listener \| Listener[],	42✔
133	bootstrap?: Bootstrapper \| Bootstrapper[]	42✔
134	) {	42✔
135	super()	86✔
136		42✔
137	if (listeners) {	86✔
138	this._listeners = Array.isArray(listeners) ? listeners : [listeners]	16!
139	} else {	42✔
140	this._listeners = []	70✔
141	}	36✔
142		42✔
143	if (bootstrap) {	86!
144	this._bootstrap = Array.isArray(bootstrap) ? bootstrap : [bootstrap]	4✔
145	} else {	42✔
146	this._bootstrap = []	82✔
147	}	42✔
148	}	42✔
149		6✔
150	connectedCallback (): void {	6✔
151	super.connectedCallback()	64✔
152		34✔
153	if (this.subscription.closed) {	64!
154	this.subscription = new Subscription()	10✔
155	this._currentBusSubscriptions = []	10✔
UNCOV 156	}	×
157		34✔
158	this._timeout$.next(0)	64✔
159	}	34✔
160		6✔
161	disconnectedCallback (): void {	6✔
162	this._subscription.unsubscribe()	64✔
163	this._currentBusSubscriptions = []	64✔
164	this._timeout$ = new ReplaySubject()	64✔
165	super.disconnectedCallback()	64✔
166	}	34✔
167	}	6✔

micro-lc / back-kit-engine / 7670359598

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous