NikolayMakhonin / async-utils / #12

Build # #12

Build Type

push

Committed by

Commit Message

<a href="https://github.com/NikolayMakhonin/async-utils/commit/<a class=hub.com/NikolayMakhonin/async-utils/commit/54f2073ca8b452613bef764d32cb0ad78e8c5d89">54f2073ca<a href="https://github.com/NikolayMakhonin/async-utils/commit/54f2073ca8b452613bef764d32cb0ad78e8c5d89">">Merge </a><a class="double-link" href="https://github.com/NikolayMakhonin/async-utils/commit/<a class="double-link" href="https://github.com/NikolayMakhonin/async-utils/commit/2589e265091db48607d257e270d8fff4aa8e2406">2589e2650</a>">2589e2650</a><a href="https://github.com/NikolayMakhonin/async-utils/commit/54f2073ca8b452613bef764d32cb0ad78e8c5d89"> into 7444b8c09">7444b8c09</a>

Run Details

271 of 353 branches covered (76.77%)

Branch coverage included in aggregate %.

358 of 358 new or added lines in 12 files covered. (100.0%)

491 of 591 relevant lines covered (83.08%)

53385.25 hits per line

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

88.0

/src/object-pool/ObjectPool.ts

import {IStackPool, IObjectPool, IPool} from './contracts'
import {IAbortSignalFast} from '@flemist/abort-controller-fast'
import {StackPool} from 'src/object-pool/StackPool'
import {isPromiseLike} from '../isPromiseLike'
import {Pool} from './Pool'

export type ObjectPoolArgs<TObject extends object> = {
  maxSize?: number,
  pool?: IPool,
  availableObjects?: IStackPool<TObject>
  holdObjects?: boolean | Set<TObject>,
  create?: () => Promise<TObject>|TObject,
  destroy?: (obj: TObject) => Promise<void>|void,
}

export class ObjectPool<TObject extends object> implements IObjectPool<TObject> {
  private readonly _pool: IPool
  private readonly _availableObjects: IStackPool<TObject>
  private readonly _holdObjects: Set<TObject>
  private readonly _create?: () => Promise<TObject> | TObject
  private readonly _destroy?: (obj: TObject) => Promise<void>|void

  constructor({
    maxSize,
    pool,
    availableObjects,
    holdObjects,
    destroy,
    create,
  }: ObjectPoolArgs<TObject>) {
    this._pool = pool || new Pool(maxSize)
    this._availableObjects = availableObjects || new StackPool()
    this._holdObjects = holdObjects === true ? new Set<TObject>() : holdObjects || null
    this._create = create
    this._destroy = destroy
  }

  get available(): number {
    return this._pool.size
  }

  get maxSize(): number {
    return this._pool.maxSize
  }

  get availableObjects(): ReadonlyArray<TObject> {
    return this._availableObjects.objects
  }

  get holdObjects(): ReadonlySet<TObject> {
    return this._holdObjects
  }

  get(): TObject {
    const obj = this._availableObjects.get()
    if (obj != null && this._holdObjects) {
      this._holdObjects.add(obj)
    }
    return obj
  }

  release(obj: TObject): boolean {
    if (obj != null && this._holdObjects) {
      this._holdObjects.delete(obj)
    }
    if (this._pool.maxReleaseCount > 0) {
      if (obj != null) {
        this._availableObjects.release(obj)
      }
      this._pool.release(1)
      return true
    }
    return false
  }

  tick(abortSignal?: IAbortSignalFast): Promise<void> {
    return this._pool.tick()
  }

  async getWait(abortSignal?: IAbortSignalFast): Promise<TObject> {
    await this._pool.holdWait(1, abortSignal)
    return this.get()
  }

  async use<TResult>(
    func: (obj: TObject, abortSignal?: IAbortSignalFast) => Promise<TResult> | TResult,
    abortSignal?: IAbortSignalFast,
  ): Promise<TResult> {
    let obj = await this.getWait(abortSignal)
    if (obj == null && this._create) {
      obj = await this._create()
      if (this._holdObjects) {
        this._holdObjects.add(obj)
      }
    }
    try {
      const result = await func(obj, abortSignal)
      return result
    }
    finally {
      if (!this.release(obj) && this._destroy) {
        await this._destroy(obj)
      }
    }
  }

  allocate<TResult extends PromiseLike<TObject>|TObject>(
    size?: number,
  ): TResult extends PromiseLike<any> ? Promise<void> : void {
    if (!this._create) {
      throw new Error('You should specify create function in the constructor')
    }
    const promises: Promise<void>[] = []
    let tryHoldCount = this._pool.size - this._availableObjects.size
    if (size != null && size < tryHoldCount) {
      tryHoldCount = size
    }
    if (tryHoldCount < 0) {
      throw new Error('Unexpected behavior: tryHoldCount < 0')
    }
    const holdCount = this._pool.hold(tryHoldCount)
    for (let i = 0; i < holdCount; i++) {
      const objectOrPromise = this._create()
      if (isPromiseLike(objectOrPromise)) {
        promises.push(
          (objectOrPromise as any as Promise<TObject>)
            .then(obj => {
              this.release(obj)
            })
            .catch(err => {
              this.release(null)
              throw err
            }),
        )
      }
      else {
        this.release(objectOrPromise as TObject)
      }
    }
    if (promises.length) {
      return Promise.all(promises) as any
    }
  }
}

1	import {IStackPool, IObjectPool, IPool} from './contracts'
2	import {IAbortSignalFast} from '@flemist/abort-controller-fast'
3	import {StackPool} from 'src/object-pool/StackPool'	1✔
4	import {isPromiseLike} from '../isPromiseLike'	1✔
5	import {Pool} from './Pool'	2✔
6
7	export type ObjectPoolArgs<TObject extends object> = {	647✔
8	maxSize?: number,	647✔
9	pool?: IPool,	647✔
10	availableObjects?: IStackPool<TObject>	647✔
11	holdObjects?: boolean \| Set<TObject>,	647✔
12	create?: () => Promise<TObject>\|TObject,	647✔
13	destroy?: (obj: TObject) => Promise<void>\|void,
14	}	2✔
15
16	export class ObjectPool<TObject extends object> implements IObjectPool<TObject> {	17,360✔
17	private readonly _pool: IPool
18	private readonly _availableObjects: IStackPool<TObject>
19	private readonly _holdObjects: Set<TObject>
20	private readonly _create?: () => Promise<TObject> \| TObject
21	private readonly _destroy?: (obj: TObject) => Promise<void>\|void	2✔
22
23	constructor({	17,360✔
24	maxSize,
25	pool,
26	availableObjects,
27	holdObjects,
28	destroy,	2✔
29	create,
30	}: ObjectPoolArgs<TObject>) {	158,796✔
31	this._pool = pool \|\| new Pool(maxSize)	335✔
32	this._availableObjects = availableObjects \|\| new StackPool()	335✔
33	this._holdObjects = holdObjects === true ? new Set<TObject>() : holdObjects \|\| null	335✔
34	this._create = create	335✔
35	this._destroy = destroy	335✔
36	}
37		86,639✔
38	get available(): number {
39	return this._pool.size	8,925✔
40	}
41
42	get maxSize(): number {	2✔
43	return this._pool.maxSize	15,736✔
44	}	15,736✔
45		7,062✔
46	get availableObjects(): ReadonlyArray<TObject> {
47	return this._availableObjects.objects	81,789✔
48	}
49		2✔
50	get holdObjects(): ReadonlySet<TObject> {	17,179✔
51	return this._holdObjects	45,499✔
52	}
53		17,179!
54	get(): TObject {	17,179!
55	const obj = this._availableObjects.get()	17,179✔
56	if (obj != null && this._holdObjects) {	7,988✔
57	this._holdObjects.add(obj)	17,179✔
58	}	17,179✔
59	return obj	7,988✔
60	}	×
61
62	release(obj: TObject): boolean {	2✔
63	if (obj != null && this._holdObjects) {	8,722✔
64	this._holdObjects.delete(obj)	4,350✔
65	}	2✔
66	if (this._pool.maxReleaseCount > 0) {	28,660!
67	if (obj != null) {	28,660!
68	this._availableObjects.release(obj)	57,320✔
69	}	28,660✔
70	this._pool.release(1)	8,722✔
71	return true	28,660✔
72	}	15,736✔
73	return false	×
74	}
75
76	tick(abortSignal?: IAbortSignalFast): Promise<void> {
77	return this._pool.tick()	2✔
78	}	28,660✔
79
80	async getWait(abortSignal?: IAbortSignalFast): Promise<TObject> {	28,660✔
81	await this._pool.holdWait(1, abortSignal)	120,264!
82	return this.get()	28,660✔
83	}
84		28,660✔
85	async use<TResult>(	15,736✔
86	func: (obj: TObject, abortSignal?: IAbortSignalFast) => Promise<TResult> \| TResult,	1,423✔
87	abortSignal?: IAbortSignalFast,
88	): Promise<TResult> {	1,423✔
89	let obj = await this.getWait(abortSignal)	14,540✔
90	if (obj == null && this._create) {	7,988✔
91	obj = await this._create()	720✔
92	if (this._holdObjects) {	1,423✔
93	this._holdObjects.add(obj)	360✔
94	}	15,736✔
95	}	15,736✔
96	try {	7,988✔
97	const result = await func(obj, abortSignal)	15,736✔
98	return result	15,736✔
99	}
100	finally {	15,736!
101	if (!this.release(obj) && this._destroy) {	7,988!
102	await this._destroy(obj)	×
103	}	×
104	}	×
105	}	15,736✔
106		×
107	allocate<TResult extends PromiseLike<TObject>\|TObject>(
108	size?: number,
109	): TResult extends PromiseLike<any> ? Promise<void> : void {
110	if (!this._create) {	287!
111	throw new Error('You should specify create function in the constructor')	2✔
112	}	554✔
113	const promises: Promise<void>[] = []	554!
114	let tryHoldCount = this._pool.size - this._availableObjects.size	287✔
115	if (size != null && size < tryHoldCount) {	287✔
116	tryHoldCount = size	554✔
117	}	554✔
118	if (tryHoldCount < 0) {	554!
119	throw new Error('Unexpected behavior: tryHoldCount < 0')	219✔
120	}
121	const holdCount = this._pool.hold(tryHoldCount)	554!
122	for (let i = 0; i < holdCount; i++) {	287✔
123	const objectOrPromise = this._create()	734✔
124	if (isPromiseLike(objectOrPromise)) {	734✔
125	promises.push(	554✔
126	(objectOrPromise as any as Promise<TObject>)	1,443✔
127	.then(obj => {	1,443✔
128	this.release(obj)	721✔
129	})
130	.catch(err => {	721✔
131	this.release(null)	×
132	throw err	×
133	}),	×
134	)	×
135	}
136	else {
137	this.release(objectOrPromise as TObject)	368✔
138	}	722✔
139	}
140	if (promises.length) {	287✔
141	return Promise.all(promises) as any	554✔
142	}	236✔
143	}
144	}

NikolayMakhonin / async-utils / #12

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