Compare commits
No commits in common. "master" and "v6.0.8" have entirely different histories.
changelog.mdnpmextra.jsonpackage.jsonpnpm-lock.yamlreadme.hints.mdreadme.md
test
test.asyncexecutionstack.both.tstest.fastmap.both.tstest.interestmap.both.tstest.limitedarray.both.tstest.looptracker.both.tstest.objectmap.both.tstest.stringmap.both.tstest.timedaggregator.both.tstest.tree.both.ts
ts
00_commitinfo_data.tsbackpressuredarray.tsindex.tslik.asyncexecutionstack.tslik.fastmap.tslik.interestmap.interest.tslik.interestmap.tslik.limitedarray.tslik.looptracker.tslik.objectmap.tslik.plugins.tslik.stringmap.tslik.timedaggregator.tslik.tree.ts
tsconfig.json
76
changelog.md
76
changelog.md
@ -1,76 +0,0 @@
|
||||
# Changelog
|
||||
|
||||
## 2025-04-25 - 6.2.2 - fix(docs)
|
||||
Update @push.rocks/tapbundle dependency and refine AsyncExecutionStack documentation examples
|
||||
|
||||
- Bump @push.rocks/tapbundle from ^5.0.8 to ^5.5.6 in package.json
|
||||
- Improve README documentation for AsyncExecutionStack with clearer examples for exclusive and non-exclusive task execution
|
||||
- Demonstrate usage of concurrency controls in AsyncExecutionStack
|
||||
|
||||
## 2025-04-25 - 6.2.1 - fix(AsyncExecutionStack tests)
|
||||
Refactor AsyncExecutionStack tests: update non-exclusive concurrency assertions and clean up test logic
|
||||
|
||||
- Replace 'toBe' with 'toEqual' for active and pending counts to ensure consistency
|
||||
- Simplify default non-exclusive concurrency test by asserting Infinity is non-finite using toBeFalse
|
||||
- Adjust test comments and scheduling for clarity in concurrency behavior
|
||||
|
||||
## 2025-04-25 - 6.2.0 - feat(AsyncExecutionStack)
|
||||
Improve non-exclusive task management with concurrency limit controls and enhanced monitoring in AsyncExecutionStack.
|
||||
|
||||
- Added methods to set and get non-exclusive concurrency limits and statistics (setNonExclusiveMaxConcurrency, getActiveNonExclusiveCount, getPendingNonExclusiveCount, and getNonExclusiveMaxConcurrency).
|
||||
- Integrated proper waiting and release mechanisms for non-exclusive slots.
|
||||
- Extended test coverage to validate concurrency limits and ensure correct behavior.
|
||||
|
||||
## 2024-10-13 - 6.1.0 - feat(BackpressuredArray)
|
||||
Add method to check if items are present in BackpressuredArray
|
||||
|
||||
- Implemented a new method `checkHasItems` in the BackpressuredArray class to determine if the array contains any items.
|
||||
|
||||
## 2024-05-29 to 2024-04-18 - 6.0.15
|
||||
Minor updates were made to documentation and descriptions.
|
||||
|
||||
- Update project description
|
||||
|
||||
## 2024-04-18 to 2024-02-25 - 6.0.14
|
||||
Several updates were made to configurations and json files.
|
||||
|
||||
- Updated core components in the codebase
|
||||
- Modified tsconfig settings
|
||||
- Revised npmextra.json with githost configurations
|
||||
|
||||
## 2024-02-25 to 2024-02-23 - 6.0.13
|
||||
No relevant changes.
|
||||
|
||||
## 2024-02-23 to 2023-11-13 - 6.0.12 to 6.0.8
|
||||
Multiple core updates were performed to ensure stability and performance.
|
||||
|
||||
- Fixed various issues in core components
|
||||
|
||||
## 2023-11-13 to 2023-08-14 - 6.0.7 to 6.0.3
|
||||
Minor internal core updates.
|
||||
|
||||
## 2023-08-14 to 2023-07-12 - 6.0.2
|
||||
Implemented a switch to a new organizational scheme.
|
||||
|
||||
## 2023-01-18 to 2022-05-27 - 6.0.0
|
||||
Updated core functionalities; introduced breaking changes for compatibility with ECMAScript modules.
|
||||
|
||||
- Core updates
|
||||
- Switching from CommonJS to ECMAScript modules
|
||||
|
||||
## 2022-05-27 to 2022-05-27 - 5.0.6 to 5.0.0
|
||||
Minor updates and a significant change in `objectmap` behavior to support async operations.
|
||||
|
||||
- Included async behaviors in objectmap as a breaking change
|
||||
|
||||
## 2020-05-04 to 2020-02-17 - 4.0.0
|
||||
Refactored ObjectMap; introduced new features.
|
||||
|
||||
- Refactored ObjectMap with concat functionality as a breaking change
|
||||
- Added .clean() to FastMap
|
||||
|
||||
## 2020-02-17 to 2020-02-06 - 3.0.19 to 3.0.15
|
||||
Enhancements and new functionality in ObjectMap.
|
||||
|
||||
- Added object mapping enhancements
|
||||
- Introduced object map with unique keys
|
||||
@ -6,28 +6,12 @@
|
||||
"gitzone": {
|
||||
"projectType": "npm",
|
||||
"module": {
|
||||
"githost": "code.foss.global",
|
||||
"githost": "gitlab.com",
|
||||
"gitscope": "push.rocks",
|
||||
"gitrepo": "lik",
|
||||
"description": "Provides a collection of lightweight helpers and utilities for Node.js projects.",
|
||||
"description": "light little helpers for node",
|
||||
"npmPackagename": "@push.rocks/lik",
|
||||
"license": "MIT",
|
||||
"keywords": [
|
||||
"Utilities",
|
||||
"Helpers",
|
||||
"Typescript",
|
||||
"Node.js",
|
||||
"String manipulation",
|
||||
"Object management",
|
||||
"Execution control",
|
||||
"Data structures",
|
||||
"Asynchronous programming",
|
||||
"Event handling",
|
||||
"Data aggregation"
|
||||
]
|
||||
"license": "MIT"
|
||||
}
|
||||
},
|
||||
"tsdoc": {
|
||||
"legal": "\n## License and Legal Information\n\nThis repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository. \n\n**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.\n\n### Trademarks\n\nThis project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH and are not included within the scope of the MIT license granted herein. Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines, and any usage must be approved in writing by Task Venture Capital GmbH.\n\n### Company Information\n\nTask Venture Capital GmbH \nRegistered at District court Bremen HRB 35230 HB, Germany\n\nFor any legal inquiries or if you require further information, please contact us via email at hello@task.vc.\n\nBy using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.\n"
|
||||
}
|
||||
}
|
||||
39
package.json
39
package.json
@ -1,8 +1,8 @@
|
||||
{
|
||||
"name": "@push.rocks/lik",
|
||||
"version": "6.2.2",
|
||||
"version": "6.0.8",
|
||||
"private": false,
|
||||
"description": "Provides a collection of lightweight helpers and utilities for Node.js projects.",
|
||||
"description": "light little helpers for node",
|
||||
"main": "dist_ts/index.js",
|
||||
"typings": "dist_ts/index.d.ts",
|
||||
"type": "module",
|
||||
@ -13,21 +13,21 @@
|
||||
},
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "https://code.foss.global/push.rocks/lik.git"
|
||||
"url": "git+ssh://git@gitlab.com/pushrocks/lik.git"
|
||||
},
|
||||
"author": "Lossless GmbH",
|
||||
"license": "MIT",
|
||||
"bugs": {
|
||||
"url": "https://gitlab.com/pushrocks/lik/issues"
|
||||
},
|
||||
"homepage": "https://code.foss.global/push.rocks/lik",
|
||||
"homepage": "https://gitlab.com/pushrocks/lik#README",
|
||||
"devDependencies": {
|
||||
"@git.zone/tsbuild": "^2.1.72",
|
||||
"@git.zone/tsbundle": "^2.0.15",
|
||||
"@git.zone/tsbuild": "^2.1.66",
|
||||
"@git.zone/tsbundle": "^2.0.8",
|
||||
"@git.zone/tsrun": "^1.2.44",
|
||||
"@git.zone/tstest": "^1.0.90",
|
||||
"@push.rocks/tapbundle": "^5.5.6",
|
||||
"@types/node": "^22.13.9"
|
||||
"@git.zone/tstest": "^1.0.77",
|
||||
"@pushrocks/tapbundle": "^5.0.8",
|
||||
"@types/node": "^20.9.0"
|
||||
},
|
||||
"dependencies": {
|
||||
"@push.rocks/smartdelay": "^3.0.5",
|
||||
@ -53,26 +53,5 @@
|
||||
],
|
||||
"browserslist": [
|
||||
"last 1 chrome versions"
|
||||
],
|
||||
"keywords": [
|
||||
"Utilities",
|
||||
"Helpers",
|
||||
"Typescript",
|
||||
"Node.js",
|
||||
"String manipulation",
|
||||
"Object management",
|
||||
"Execution control",
|
||||
"Data structures",
|
||||
"Asynchronous programming",
|
||||
"Event handling",
|
||||
"Data aggregation"
|
||||
],
|
||||
"pnpm": {
|
||||
"onlyBuiltDependencies": [
|
||||
"esbuild",
|
||||
"mongodb-memory-server",
|
||||
"puppeteer"
|
||||
]
|
||||
},
|
||||
"packageManager": "pnpm@10.7.0+sha512.6b865ad4b62a1d9842b61d674a393903b871d9244954f652b8842c2b553c72176b278f64c463e52d40fff8aba385c235c8c9ecf5cc7de4fd78b8bb6d49633ab6"
|
||||
}
|
||||
|
||||
12331
pnpm-lock.yaml
generated
12331
pnpm-lock.yaml
generated
File diff suppressed because it is too large
Load Diff
@ -1 +0,0 @@
|
||||
|
||||
251
readme.md
251
readme.md
@ -1,235 +1,52 @@
|
||||
# @push.rocks/lik
|
||||
light little helpers for node
|
||||
|
||||
## Install
|
||||
## Availabililty and Links
|
||||
* [npmjs.org (npm package)](https://www.npmjs.com/package/@push.rocks/lik)
|
||||
* [gitlab.com (source)](https://gitlab.com/push.rocks/lik)
|
||||
* [github.com (source mirror)](https://github.com/push.rocks/lik)
|
||||
* [docs (typedoc)](https://push.rocks.gitlab.io/lik/)
|
||||
|
||||
To install `@push.rocks/lik`, you can use npm (Node Package Manager). Simply run the following command in your terminal:
|
||||
## Status for master
|
||||
|
||||
```bash
|
||||
npm install @push.rocks/lik --save
|
||||
```
|
||||
|
||||
This will download `@push.rocks/lik` and add it to your project's `package.json` dependencies.
|
||||
Status Category | Status Badge
|
||||
-- | --
|
||||
GitLab Pipelines | [](https://lossless.cloud)
|
||||
GitLab Pipline Test Coverage | [](https://lossless.cloud)
|
||||
npm | [](https://lossless.cloud)
|
||||
Snyk | [](https://lossless.cloud)
|
||||
TypeScript Support | [](https://lossless.cloud)
|
||||
node Support | [](https://nodejs.org/dist/latest-v10.x/docs/api/)
|
||||
Code Style | [](https://lossless.cloud)
|
||||
PackagePhobia (total standalone install weight) | [](https://lossless.cloud)
|
||||
PackagePhobia (package size on registry) | [](https://lossless.cloud)
|
||||
BundlePhobia (total size when bundled) | [](https://lossless.cloud)
|
||||
|
||||
## Usage
|
||||
|
||||
`@push.rocks/lik` is a versatile package offering a variety of helper classes designed to simplify common tasks in Node.js development. From managing asynchronous operations to handling collections efficiently, this library provides lightweight solutions to enhance your coding workflow. Below, we explore several key features of `@push.rocks/lik`, presenting TypeScript examples to demonstrate their practical application in real-world scenarios.
|
||||
Use TypeScript for best in class instellisense.
|
||||
|
||||
### AsyncExecutionStack
|
||||
|
||||
`AsyncExecutionStack` provides controlled execution of asynchronous tasks in two modes:
|
||||
|
||||
- **Exclusive tasks**: run one at a time in insertion order, blocking all other tasks until complete.
|
||||
- **Non-exclusive tasks**: run in parallel, up to an optional concurrency limit.
|
||||
|
||||
Create a stack:
|
||||
|
||||
```typescript
|
||||
import { AsyncExecutionStack } from '@push.rocks/lik';
|
||||
|
||||
const stack = new AsyncExecutionStack();
|
||||
```javascript
|
||||
// import any tool that you need from lik
|
||||
import { Stringmap, Objectmap, Observablemap } from 'lik';
|
||||
```
|
||||
|
||||
Exclusive tasks execute sequentially and block subsequent tasks (with an optional timeout):
|
||||
### class Stringmap
|
||||
|
||||
```typescript
|
||||
await stack.getExclusiveExecutionSlot(
|
||||
async () => {
|
||||
// exclusive work
|
||||
},
|
||||
5000 // optional timeout in milliseconds
|
||||
);
|
||||
```
|
||||
Stringmap allows you to keep track of strings. It allows you to register triggers for certain events
|
||||
like when a certain string is removed or added to the map
|
||||
|
||||
Non-exclusive tasks run in parallel up to the concurrency limit (default: unlimited). Each call returns a promise you can await:
|
||||
### class Objectmap
|
||||
|
||||
```typescript
|
||||
const p1 = stack.getNonExclusiveExecutionSlot(async () => {
|
||||
// work 1
|
||||
}, 2000);
|
||||
Sometimes you need to keep track of objects, but implementing logic for removing, finding or updating is tedious.
|
||||
Objectmap takes care of keeping track of objects for you.
|
||||
|
||||
const p2 = stack.getNonExclusiveExecutionSlot(async () => {
|
||||
// work 2
|
||||
}, 2000);
|
||||
## Contribution
|
||||
|
||||
await Promise.all([p1, p2]);
|
||||
```
|
||||
We are always happy for code contributions. If you are not the code contributing type that is ok. Still, maintaining Open Source repositories takes considerable time and thought. If you like the quality of what we do and our modules are useful to you we would appreciate a little monthly contribution: You can [contribute one time](https://lossless.link/contribute-onetime) or [contribute monthly](https://lossless.link/contribute). :)
|
||||
|
||||
Control concurrency and inspect status:
|
||||
For further information read the linked docs at the top of this readme.
|
||||
|
||||
```typescript
|
||||
// Set maximum concurrent non-exclusive tasks (minimum 1)
|
||||
stack.setNonExclusiveMaxConcurrency(3);
|
||||
|
||||
console.log(stack.getNonExclusiveMaxConcurrency()); // 3
|
||||
console.log(stack.getActiveNonExclusiveCount()); // currently running tasks
|
||||
console.log(stack.getPendingNonExclusiveCount()); // tasks waiting for slots
|
||||
```
|
||||
|
||||
### FastMap
|
||||
|
||||
`FastMap` offers a high-performance, key-value map optimized for rapid access and modifications, ideal for scenarios requiring frequent read/write operations.
|
||||
|
||||
```typescript
|
||||
import { FastMap } from '@push.rocks/lik';
|
||||
|
||||
const myFastMap = new FastMap<string>();
|
||||
|
||||
// Add items
|
||||
myFastMap.addToMap('key1', 'value1');
|
||||
myFastMap.addToMap('key2', 'value2');
|
||||
|
||||
// Retrieve item
|
||||
const value = myFastMap.getByKey('key1'); // 'value1'
|
||||
```
|
||||
|
||||
### LimitedArray
|
||||
|
||||
`LimitedArray` enforces a maximum size on an array, automatically managing its length to prevent it from exceeding a defined limit.
|
||||
|
||||
```typescript
|
||||
import { LimitedArray } from '@push.rocks/lik';
|
||||
|
||||
const myLimitedArray = new LimitedArray<number>(5); // limit size to 5
|
||||
|
||||
myLimitedArray.addMany([1, 2, 3, 4, 5, 6]);
|
||||
console.log(myLimitedArray.array); // [2, 3, 4, 5, 6]
|
||||
```
|
||||
|
||||
### LoopTracker
|
||||
|
||||
`LoopTracker` helps detect and prevent infinite loops by tracking object references during iterations.
|
||||
|
||||
```typescript
|
||||
import { LoopTracker } from '@push.rocks/lik';
|
||||
|
||||
const myLoopTracker = new LoopTracker<object>();
|
||||
const obj1 = {};
|
||||
|
||||
if (myLoopTracker.checkAndTrack(obj1)) {
|
||||
// proceed with operation
|
||||
} else {
|
||||
// potential loop detected
|
||||
}
|
||||
```
|
||||
|
||||
### ObjectMap
|
||||
|
||||
`ObjectMap` facilitates object management, providing functionalities for adding, finding, and removing objects with ease.
|
||||
|
||||
```typescript
|
||||
import { ObjectMap } from '@push.rocks/lik';
|
||||
|
||||
interface MyObject {
|
||||
id: number;
|
||||
name: string;
|
||||
}
|
||||
|
||||
const myObjectMap = new ObjectMap<MyObject>();
|
||||
const obj: MyObject = { id: 1, name: 'Test Object' };
|
||||
|
||||
// Add object
|
||||
myObjectMap.add(obj);
|
||||
|
||||
// Find object
|
||||
const found = myObjectMap.findSync(item => item.id === 1);
|
||||
```
|
||||
|
||||
### StringMap
|
||||
|
||||
`StringMap` simplifies string collection management, allowing you to add, remove, and query strings effectively.
|
||||
|
||||
```typescript
|
||||
import { Stringmap } from '@push.rocks/lik';
|
||||
|
||||
const myStringMap = new Stringmap();
|
||||
|
||||
// Add strings
|
||||
myStringMap.addString('hello');
|
||||
myStringMap.addStringArray(['world', 'example']);
|
||||
|
||||
// Check string presence
|
||||
const exists = myStringMap.checkString('hello'); // true
|
||||
```
|
||||
|
||||
### TimedAggregator
|
||||
|
||||
`TimedAggregator` batches operations over a specified time interval, useful for aggregating logs, metrics, or any data points over time.
|
||||
|
||||
```typescript
|
||||
import { TimedAggregtor } from '@push.rocks/lik';
|
||||
|
||||
const myAggregator = new TimedAggregtor<string>({
|
||||
aggregationIntervalInMillis: 5000, // 5 seconds
|
||||
functionForAggregation: (items) => {
|
||||
console.log('Aggregated items:', items);
|
||||
}
|
||||
});
|
||||
|
||||
// Add items
|
||||
myAggregator.add('item1');
|
||||
myAggregator.add('item2');
|
||||
|
||||
// After 5 seconds, the functionForAggregation will log the aggregated items
|
||||
```
|
||||
|
||||
### InterestMap and Tree
|
||||
|
||||
`InterestMap` provides a structure for managing subscriptions or interests in certain events or entities, optimizing notification mechanisms.
|
||||
|
||||
```typescript
|
||||
import { InterestMap } from '@push.rocks/lik';
|
||||
|
||||
const myInterestMap = new InterestMap<string, number>((str) => str);
|
||||
|
||||
myInterestMap.addInterest('event1').then((interest) => {
|
||||
interest.fullfillInterest(42);
|
||||
});
|
||||
```
|
||||
|
||||
`Tree` offers a way to handle hierarchical data structures, allowing for the composition and traversal of tree-like data sets.
|
||||
|
||||
```typescript
|
||||
import { Tree } from '@push.rocks/lik';
|
||||
|
||||
class TreeNode {
|
||||
constructor(public value: string) {}
|
||||
}
|
||||
|
||||
const myTree = new Tree<TreeNode>();
|
||||
const rootNode = new TreeNode('root');
|
||||
myTree.initialize(rootNode);
|
||||
|
||||
// Add child nodes
|
||||
const childNode = new TreeNode('child');
|
||||
myTree.appendChild(rootNode, childNode);
|
||||
```
|
||||
|
||||
### Utilizing @push.rocks/lik in Your Project
|
||||
|
||||
With `@push.rocks/lik`, you gain access to a comprehensive set of lightweight utilities that can significantly simplify and expedite the development process in Node.js environments. By leveraging the library's classes and functions, you can implement efficient data structures, manage asynchronous operations gracefully, and streamline complex logic with ease.
|
||||
|
||||
By integrating `@push.rocks/lik` into your project, you'll benefit from improved code clarity, reduced boilerplate, and enhanced performance, allowing you to focus on developing the core functionalities of your application. Whether you're managing various collections, executing asynchronous tasks in controlled manners, or dealing with hierarchical data, `@push.rocks/lik` provides the tools you need to achieve your objectives with minimal overhead.
|
||||
|
||||
Remember, continuous exploration of `@push.rocks/lik`'s capabilities and experimenting with its various components in different scenarios will help you unlock its full potential. As your familiarity with the library grows, you'll discover even more ways to optimize your codebase and streamline your development workflow.
|
||||
|
||||
|
||||
|
||||
## License and Legal Information
|
||||
|
||||
This repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository.
|
||||
|
||||
**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.
|
||||
|
||||
### Trademarks
|
||||
|
||||
This project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH and are not included within the scope of the MIT license granted herein. Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines, and any usage must be approved in writing by Task Venture Capital GmbH.
|
||||
|
||||
### Company Information
|
||||
|
||||
Task Venture Capital GmbH
|
||||
Registered at District court Bremen HRB 35230 HB, Germany
|
||||
|
||||
For any legal inquiries or if you require further information, please contact us via email at hello@task.vc.
|
||||
|
||||
By using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.
|
||||
## Legal
|
||||
> MIT licensed | **©** [Task Venture Capital GmbH](https://task.vc)
|
||||
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
import { tap, expect } from '@push.rocks/tapbundle';
|
||||
import { tap, expect } from '@pushrocks/tapbundle';
|
||||
import * as lik from '../ts/index.js';
|
||||
|
||||
let testAsyncExecutionStack: lik.AsyncExecutionStack;
|
||||
@ -26,66 +26,4 @@ tap.test('should run in parallel', async (toolsArg) => {
|
||||
}, 0);
|
||||
});
|
||||
|
||||
// Test default non-exclusive has no concurrency limit property (Infinity)
|
||||
tap.test('default non-exclusive has no concurrency limit', () => {
|
||||
const stack = new lik.AsyncExecutionStack();
|
||||
// default maxConcurrency is Infinity (not finite)
|
||||
expect(Number.isFinite(stack.getNonExclusiveMaxConcurrency())).toBeFalse();
|
||||
});
|
||||
// Test respecting a non-exclusive concurrency limit
|
||||
tap.test('non-exclusive respects maxConcurrency', async (tools) => {
|
||||
const stack = new lik.AsyncExecutionStack();
|
||||
stack.setNonExclusiveMaxConcurrency(2);
|
||||
const activeCounts: number[] = [];
|
||||
const tasks: Promise<void>[] = [];
|
||||
for (let i = 0; i < 5; i++) {
|
||||
tasks.push(
|
||||
stack.getNonExclusiveExecutionSlot(async () => {
|
||||
activeCounts.push(stack.getActiveNonExclusiveCount());
|
||||
await tools.delayFor(50);
|
||||
})
|
||||
);
|
||||
}
|
||||
await Promise.all(tasks);
|
||||
// never more than 2 at once
|
||||
const maxActive = Math.max(...activeCounts);
|
||||
expect(maxActive).toBeLessThanOrEqual(2);
|
||||
});
|
||||
|
||||
// Test concurrency stats (active vs pending) for non-exclusive tasks
|
||||
tap.test('non-exclusive concurrency stats reflect active and pending', async (tools) => {
|
||||
const stack = new lik.AsyncExecutionStack();
|
||||
stack.setNonExclusiveMaxConcurrency(2);
|
||||
// initially, no tasks
|
||||
expect(stack.getActiveNonExclusiveCount()).toEqual(0);
|
||||
expect(stack.getPendingNonExclusiveCount()).toEqual(0);
|
||||
|
||||
// enqueue four tasks
|
||||
const p1 = stack.getNonExclusiveExecutionSlot(async () => {
|
||||
await tools.delayFor(30);
|
||||
});
|
||||
const p2 = stack.getNonExclusiveExecutionSlot(async () => {
|
||||
await tools.delayFor(30);
|
||||
});
|
||||
const p3 = stack.getNonExclusiveExecutionSlot(async () => {
|
||||
await tools.delayFor(30);
|
||||
});
|
||||
const p4 = stack.getNonExclusiveExecutionSlot(async () => {
|
||||
await tools.delayFor(30);
|
||||
});
|
||||
|
||||
// wait for first task to finish and scheduling of next batch
|
||||
await p1;
|
||||
await tools.delayFor(0);
|
||||
// second batch: two active, one pending (4 tasks, limit=2)
|
||||
expect(stack.getActiveNonExclusiveCount()).toEqual(2);
|
||||
expect(stack.getPendingNonExclusiveCount()).toEqual(1);
|
||||
|
||||
// wait for remaining tasks to complete
|
||||
await Promise.all([p2, p3, p4]);
|
||||
// after completion, counts reset
|
||||
expect(stack.getActiveNonExclusiveCount()).toEqual(0);
|
||||
expect(stack.getPendingNonExclusiveCount()).toEqual(0);
|
||||
});
|
||||
|
||||
export default tap.start();
|
||||
await tap.start();
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
import { tap, expect } from '@push.rocks/tapbundle';
|
||||
import { tap, expect } from '@pushrocks/tapbundle';
|
||||
|
||||
import * as lik from '../ts/index.js';
|
||||
|
||||
@ -27,4 +27,4 @@ tap.test('should find an entry', async () => {
|
||||
expect(result.value1).toEqual('heyho3');
|
||||
});
|
||||
|
||||
export default tap.start();
|
||||
await tap.start();
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
import { tap, expect } from '@push.rocks/tapbundle';
|
||||
import { tap, expect } from '@pushrocks/tapbundle';
|
||||
import * as lik from '../ts/index.js';
|
||||
|
||||
let testInterestmap: lik.InterestMap<number, number>;
|
||||
@ -22,4 +22,4 @@ tap.test('should be able to inform about a lost interest', async () => {
|
||||
testInterestmap.informLostInterest(3);
|
||||
});
|
||||
|
||||
export default tap.start();
|
||||
await tap.start();
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
import { tap, expect } from '@push.rocks/tapbundle';
|
||||
import { tap, expect } from '@pushrocks/tapbundle';
|
||||
|
||||
import { LimitedArray } from '../ts/index.js';
|
||||
|
||||
@ -14,4 +14,4 @@ tap.test('should never be longer than the set length', async () => {
|
||||
expect(testLimitedArray.array.length < 7).toBeTrue();
|
||||
});
|
||||
|
||||
export default tap.start();
|
||||
await tap.start();
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
// import test framework
|
||||
import { expect, tap } from '@push.rocks/tapbundle';
|
||||
import { expect, tap } from '@pushrocks/tapbundle';
|
||||
|
||||
// import the module
|
||||
import * as lik from '../ts/index.js';
|
||||
@ -21,4 +21,4 @@ tap.test('should add objects once and return true', async () => {
|
||||
expect(myLoopTracker.checkAndTrack(object2)).toBeFalse();
|
||||
});
|
||||
|
||||
export default tap.start();
|
||||
await tap.start();
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
// import test framework
|
||||
import { expect, tap } from '@push.rocks/tapbundle';
|
||||
import { expect, tap } from '@pushrocks/tapbundle';
|
||||
|
||||
// import the module
|
||||
import * as lik from '../ts/index.js';
|
||||
@ -73,4 +73,4 @@ tap.test('should get one object and then remove it', async () => {
|
||||
expect(testObjectmap.getArray()).not.toContain(oneObject);
|
||||
});
|
||||
|
||||
export default tap.start();
|
||||
await tap.start();
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
// import test framework
|
||||
import { expect, tap } from '@push.rocks/tapbundle';
|
||||
import { expect, tap } from '@pushrocks/tapbundle';
|
||||
|
||||
// import the module
|
||||
import * as lik from '../ts/index.js';
|
||||
@ -83,4 +83,4 @@ tap.test('lik.Stringmap.empty() -> should remove wipe and then notify', async ()
|
||||
testStringmap.wipe();
|
||||
});
|
||||
|
||||
export default tap.start();
|
||||
await tap.start();
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
// import test framework
|
||||
import { expect, tap } from '@push.rocks/tapbundle';
|
||||
import { expect, tap } from '@pushrocks/tapbundle';
|
||||
|
||||
// import the module
|
||||
import * as lik from '../ts/index.js';
|
||||
@ -20,4 +20,4 @@ tap.test('should create a timed aggregaotor', async (tools) => {
|
||||
await tools.delayFor(2000);
|
||||
});
|
||||
|
||||
export default tap.start();
|
||||
await tap.start();
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
import { tap, expect } from '@push.rocks/tapbundle';
|
||||
import { tap, expect } from '@pushrocks/tapbundle';
|
||||
import * as lik from '../ts/index.js';
|
||||
|
||||
class TestClass {
|
||||
@ -37,4 +37,4 @@ tap.test("should create a JSON object that reflects a tree's hierachy", async ()
|
||||
const jsonTreet = testTree.toJsonWithHierachy(testInstance);
|
||||
});
|
||||
|
||||
export default tap.start();
|
||||
await tap.start();
|
||||
|
||||
@ -1,8 +1,8 @@
|
||||
/**
|
||||
* autocreated commitinfo by @push.rocks/commitinfo
|
||||
* autocreated commitinfo by @pushrocks/commitinfo
|
||||
*/
|
||||
export const commitinfo = {
|
||||
name: '@push.rocks/lik',
|
||||
version: '6.2.2',
|
||||
description: 'Provides a collection of lightweight helpers and utilities for Node.js projects.'
|
||||
version: '6.0.8',
|
||||
description: 'light little helpers for node'
|
||||
}
|
||||
|
||||
@ -1,31 +1,29 @@
|
||||
import * as plugins from './classes.plugins.js';
|
||||
import * as plugins from './lik.plugins.js';
|
||||
|
||||
export class BackpressuredArray<T> {
|
||||
public data: T[];
|
||||
private data: T[];
|
||||
private highWaterMark: number;
|
||||
public hasSpace = new plugins.smartrx.rxjs.Subject<'hasSpace'>();
|
||||
private itemsAvailable = new plugins.smartrx.rxjs.Subject<'itemsAvailable'>();
|
||||
public hasSpace: plugins.smartrx.rxjs.Subject<void>;
|
||||
|
||||
constructor(highWaterMark: number = 16) {
|
||||
this.data = [];
|
||||
this.highWaterMark = highWaterMark;
|
||||
this.hasSpace = new plugins.smartrx.rxjs.Subject<void>();
|
||||
}
|
||||
|
||||
push(item: T): boolean {
|
||||
this.data.push(item);
|
||||
this.itemsAvailable.next('itemsAvailable');
|
||||
|
||||
const spaceAvailable = this.checkSpaceAvailable();
|
||||
if (spaceAvailable) {
|
||||
this.hasSpace.next('hasSpace');
|
||||
this.hasSpace.next();
|
||||
}
|
||||
return spaceAvailable;
|
||||
return spaceAvailable
|
||||
}
|
||||
|
||||
shift(): T | undefined {
|
||||
const item = this.data.shift();
|
||||
if (this.checkSpaceAvailable()) {
|
||||
this.hasSpace.next('hasSpace');
|
||||
this.hasSpace.next();
|
||||
}
|
||||
return item;
|
||||
}
|
||||
@ -34,10 +32,6 @@ export class BackpressuredArray<T> {
|
||||
return this.data.length < this.highWaterMark;
|
||||
}
|
||||
|
||||
public checkHasItems(): boolean {
|
||||
return this.data.length > 0;
|
||||
}
|
||||
|
||||
waitForSpace(): Promise<void> {
|
||||
return new Promise<void>((resolve) => {
|
||||
if (this.checkSpaceAvailable()) {
|
||||
@ -50,17 +44,4 @@ export class BackpressuredArray<T> {
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
waitForItems(): Promise<void> {
|
||||
return new Promise<void>((resolve) => {
|
||||
if (this.data.length > 0) {
|
||||
resolve();
|
||||
} else {
|
||||
const subscription = this.itemsAvailable.subscribe(() => {
|
||||
subscription.unsubscribe();
|
||||
resolve();
|
||||
});
|
||||
}
|
||||
});
|
||||
}
|
||||
}
|
||||
22
ts/index.ts
22
ts/index.ts
@ -1,11 +1,11 @@
|
||||
export * from './classes.asyncexecutionstack.js';
|
||||
export * from './classes.backpressuredarray.js';
|
||||
export * from './classes.fastmap.js';
|
||||
export * from './classes.interestmap.js';
|
||||
export * from './classes.interestmap.interest.js';
|
||||
export * from './classes.limitedarray.js';
|
||||
export * from './classes.looptracker.js';
|
||||
export * from './classes.objectmap.js';
|
||||
export * from './classes.stringmap.js';
|
||||
export * from './classes.timedaggregator.js';
|
||||
export * from './classes.tree.js';
|
||||
export * from './lik.asyncexecutionstack.js';
|
||||
export * from './backpressuredarray.js';
|
||||
export * from './lik.fastmap.js';
|
||||
export * from './lik.interestmap.js';
|
||||
export * from './lik.interestmap.interest.js';
|
||||
export * from './lik.limitedarray.js';
|
||||
export * from './lik.looptracker.js';
|
||||
export * from './lik.objectmap.js';
|
||||
export * from './lik.stringmap.js';
|
||||
export * from './lik.timedaggregator.js';
|
||||
export * from './lik.tree.js';
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
import * as plugins from './classes.plugins.js';
|
||||
import * as plugins from './lik.plugins.js';
|
||||
|
||||
interface IExecutionSlot<T> {
|
||||
executionDeferred: plugins.smartpromise.Deferred<T>;
|
||||
@ -10,12 +10,6 @@ interface IExecutionSlot<T> {
|
||||
export class AsyncExecutionStack {
|
||||
private executionSlots: IExecutionSlot<any>[] = [];
|
||||
private isProcessing = false;
|
||||
/** Maximum concurrent non-exclusive tasks (Infinity = unlimited) */
|
||||
private nonExclusiveMaxConcurrency: number = Infinity;
|
||||
/** Currently running non-exclusive task count */
|
||||
private nonExclusiveCurrentCount: number = 0;
|
||||
/** Queue of resolvers waiting for a non-exclusive slot */
|
||||
private nonExclusivePendingQueue: Array<() => void> = [];
|
||||
|
||||
public async getExclusiveExecutionSlot<T = any>(
|
||||
funcArg: () => Promise<T>,
|
||||
@ -48,28 +42,6 @@ export class AsyncExecutionStack {
|
||||
this.processExecutionSlots();
|
||||
return executionDeferred.promise;
|
||||
}
|
||||
/**
|
||||
* Set the maximum number of concurrent non-exclusive tasks.
|
||||
* @param concurrency minimum 1 (Infinity means unlimited)
|
||||
*/
|
||||
public setNonExclusiveMaxConcurrency(concurrency: number): void {
|
||||
if (!Number.isFinite(concurrency) || concurrency < 1) {
|
||||
throw new Error('nonExclusiveMaxConcurrency must be a finite number >= 1');
|
||||
}
|
||||
this.nonExclusiveMaxConcurrency = concurrency;
|
||||
}
|
||||
/** Get the configured max concurrency for non-exclusive tasks */
|
||||
public getNonExclusiveMaxConcurrency(): number {
|
||||
return this.nonExclusiveMaxConcurrency;
|
||||
}
|
||||
/** Number of non-exclusive tasks currently running */
|
||||
public getActiveNonExclusiveCount(): number {
|
||||
return this.nonExclusiveCurrentCount;
|
||||
}
|
||||
/** Number of non-exclusive tasks waiting for a free slot */
|
||||
public getPendingNonExclusiveCount(): number {
|
||||
return this.nonExclusivePendingQueue.length;
|
||||
}
|
||||
|
||||
private async processExecutionSlots() {
|
||||
if (this.isProcessing) {
|
||||
@ -115,14 +87,13 @@ export class AsyncExecutionStack {
|
||||
|
||||
private async executeNonExclusiveSlots(slots: IExecutionSlot<any>[]) {
|
||||
const promises = slots.map(async (slot) => {
|
||||
// wait for an available non-exclusive slot
|
||||
await this.waitForNonExclusiveSlot();
|
||||
try {
|
||||
// execute with optional timeout
|
||||
if (slot.timeout) {
|
||||
const result = await Promise.race([
|
||||
slot.funcToExecute(),
|
||||
plugins.smartdelay.delayFor(slot.timeout).then(() => { throw new Error('Timeout reached'); }),
|
||||
plugins.smartdelay.delayFor(slot.timeout).then(() => {
|
||||
throw new Error('Timeout reached');
|
||||
}),
|
||||
]);
|
||||
slot.executionDeferred.resolve(result);
|
||||
} else {
|
||||
@ -131,33 +102,9 @@ export class AsyncExecutionStack {
|
||||
}
|
||||
} catch (error) {
|
||||
slot.executionDeferred.reject(error);
|
||||
} finally {
|
||||
this.releaseNonExclusiveSlot();
|
||||
}
|
||||
});
|
||||
|
||||
await Promise.all(promises);
|
||||
}
|
||||
/**
|
||||
* Wait until a non-exclusive slot is available (respects max concurrency).
|
||||
*/
|
||||
private waitForNonExclusiveSlot(): Promise<void> {
|
||||
if (this.nonExclusiveCurrentCount < this.nonExclusiveMaxConcurrency) {
|
||||
this.nonExclusiveCurrentCount++;
|
||||
return Promise.resolve();
|
||||
}
|
||||
return new Promise((resolve) => {
|
||||
this.nonExclusivePendingQueue.push(() => {
|
||||
this.nonExclusiveCurrentCount++;
|
||||
resolve();
|
||||
});
|
||||
});
|
||||
}
|
||||
/** Release a non-exclusive slot and wake the next waiter, if any. */
|
||||
private releaseNonExclusiveSlot(): void {
|
||||
this.nonExclusiveCurrentCount--;
|
||||
const next = this.nonExclusivePendingQueue.shift();
|
||||
if (next) {
|
||||
next();
|
||||
}
|
||||
}
|
||||
}
|
||||
@ -3,7 +3,7 @@ The FastMap has the goal of creating the fastes to use map possible in JS
|
||||
|
||||
============ */
|
||||
|
||||
import * as plugins from './classes.plugins.js';
|
||||
import * as plugins from './lik.plugins.js';
|
||||
|
||||
/**
|
||||
* fast map allows for very quick lookups of objects with a unique key
|
||||
@ -1,6 +1,6 @@
|
||||
import * as plugins from './classes.plugins.js';
|
||||
import * as plugins from './lik.plugins.js';
|
||||
|
||||
import { InterestMap, type IInterestComparisonFunc } from './classes.interestmap.js';
|
||||
import { InterestMap, type IInterestComparisonFunc } from './lik.interestmap.js';
|
||||
|
||||
export interface IInterestOptions<DTInterestFullfillment> {
|
||||
markLostAfterDefault: number;
|
||||
@ -8,9 +8,9 @@ Subssequent interests will be mapped to the same interest
|
||||
which is then is only fullfilled once.
|
||||
=========== */
|
||||
|
||||
import * as plugins from './classes.plugins.js';
|
||||
import { ObjectMap } from './classes.objectmap.js';
|
||||
import { Interest } from './classes.interestmap.interest.js';
|
||||
import * as plugins from './lik.plugins.js';
|
||||
import { ObjectMap } from './lik.objectmap.js';
|
||||
import { Interest } from './lik.interestmap.interest.js';
|
||||
|
||||
export type IInterestComparisonFunc<T> = (objectArg: T) => string;
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
import * as plugins from './classes.plugins.js';
|
||||
import * as plugins from './lik.plugins.js';
|
||||
|
||||
export class LimitedArray<T> {
|
||||
array: T[] = [];
|
||||
@ -1,6 +1,6 @@
|
||||
import * as plugins from './classes.plugins.js';
|
||||
import * as plugins from './lik.plugins.js';
|
||||
|
||||
import { ObjectMap } from './classes.objectmap.js';
|
||||
import { ObjectMap } from './lik.objectmap.js';
|
||||
|
||||
export class LoopTracker<T> {
|
||||
referenceObjectMap = new ObjectMap<any>();
|
||||
@ -1,5 +1,5 @@
|
||||
import * as plugins from './classes.plugins.js';
|
||||
import { FastMap } from './classes.fastmap.js';
|
||||
import * as plugins from './lik.plugins.js';
|
||||
import { FastMap } from './lik.fastmap.js';
|
||||
|
||||
export const uni = (prefix: string = 'uni') => {
|
||||
return `${prefix}xxxxxxxxxxx`.replace(/[xy]/g, (c) => {
|
||||
@ -1,4 +1,4 @@
|
||||
import * as plugins from './classes.plugins.js';
|
||||
import * as plugins from './lik.plugins.js';
|
||||
|
||||
/**
|
||||
* allows you to easily keep track of a bunch of strings
|
||||
@ -1,4 +1,4 @@
|
||||
import * as plugins from './classes.plugins.js';
|
||||
import * as plugins from './lik.plugins.js';
|
||||
|
||||
export interface ITimedAggregatorOptions<T> {
|
||||
aggregationIntervalInMillis: number;
|
||||
@ -1,4 +1,4 @@
|
||||
import * as plugins from './classes.plugins.js';
|
||||
import * as plugins from './lik.plugins.js';
|
||||
|
||||
export class Tree<T> {
|
||||
symbolTree: any;
|
||||
@ -3,12 +3,8 @@
|
||||
"experimentalDecorators": true,
|
||||
"useDefineForClassFields": false,
|
||||
"target": "ES2022",
|
||||
"module": "NodeNext",
|
||||
"moduleResolution": "NodeNext",
|
||||
"esModuleInterop": true,
|
||||
"verbatimModuleSyntax": true
|
||||
},
|
||||
"exclude": [
|
||||
"dist_*/**/*.d.ts"
|
||||
]
|
||||
"module": "ES2022",
|
||||
"moduleResolution": "nodenext",
|
||||
"esModuleInterop": true
|
||||
}
|
||||
}
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user