Skip to content

Commit 55e3338

Browse files
committed
chore: sync with poolifier repo
Signed-off-by: Jérôme Benoit <[email protected]>
1 parent 1a37f7e commit 55e3338

23 files changed

+346
-28
lines changed

.serena/.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
/cache
Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
# Code Style and Conventions
2+
3+
## TypeScript/JavaScript Conventions
4+
5+
- **Imports**: Use `.ts` extensions for TypeScript imports, relative paths from
6+
`src/`
7+
- **Naming**:
8+
- camelCase for variables and functions
9+
- PascalCase for classes, types, enums, interfaces
10+
- **Types**: Explicit types over `any`, use type guards, avoid non-null
11+
assertions (`!`)
12+
- **Async**: Prefer async/await over raw Promises, handle rejections with
13+
try/catch
14+
- **Error Handling**: Use typed errors with structured properties
15+
16+
## Formatting (Deno fmt)
17+
18+
- 2-space indentation
19+
- Single quotes for strings
20+
- No semicolons
21+
- Trailing commas (ES5 style)
22+
23+
## JSDoc Comments
24+
25+
- All functions should have proper JSDoc comments
26+
- Include meaningful descriptions for the function purpose
27+
- Document all parameters with `@param {type} name - description`
28+
- Document return values with `@returns {type} description`
29+
- Empty comments like `/** */` should be filled with proper documentation
30+
31+
## Worker Patterns
32+
33+
- Use MessageChannel/MessagePort for worker communication
34+
- Use postMessage/onmessage for worker messaging
35+
- Store Promise resolvers in Maps for async operations
36+
37+
## Testing
38+
39+
- Use `@std/expect` and `@std/testing/bdd`
40+
- Test files should have `.mjs` extension
41+
- Test files should be in `tests/` directory
42+
43+
## Architecture Principles
44+
45+
- Follow DRY principle (Don't Repeat Yourself)
46+
- Maintain single source of truth for configuration
47+
- Use design patterns (factory/strategy) where appropriate
48+
- Optimize for minimal time/space complexity
49+
- English-only code and documentation
50+
- Tests-first mindset
Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# Codebase Structure
2+
3+
## Root Directory Structure
4+
5+
```
6+
/
7+
├── src/ # Main source code
8+
│ ├── pools/ # Pool implementations and strategies
9+
│ ├── queues/ # Queue implementations
10+
│ ├── worker/ # Worker abstractions and implementations
11+
│ └── mod.ts # Main module exports
12+
├── tests/ # Test files (.mjs extension)
13+
├── examples/ # Usage examples for different runtimes
14+
│ ├── deno/ # Deno-specific examples
15+
│ └── bun/ # Bun-specific examples
16+
├── benchmarks/ # Performance benchmarks
17+
├── docs/ # Documentation files
18+
├── dist/ # Built/bundled files
19+
├── .github/ # GitHub workflows and configs
20+
└── deno.json # Deno configuration
21+
22+
## Key Source Files
23+
- `src/mod.ts` - Main entry point with exports
24+
- `src/pools/abstract-pool.ts` - Base pool implementation
25+
- `src/pools/thread/fixed.ts` - Fixed thread pool
26+
- `src/pools/thread/dynamic.ts` - Dynamic thread pool
27+
- `src/worker/abstract-worker.ts` - Base worker class
28+
- `src/worker/thread-worker.ts` - Thread worker implementation
29+
30+
## Architecture Patterns
31+
- Factory pattern for pool creation
32+
- Strategy pattern for worker selection
33+
- Observer pattern for pool events
34+
- Template method pattern for abstract classes
35+
36+
## Module Organization
37+
- Each module has clear separation of concerns
38+
- Types are defined in separate files or alongside implementations
39+
- Utilities are separated from core logic
40+
- Test files mirror source structure in tests/ directory
41+
```
Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# Poolifier Web Worker Project Overview
2+
3+
## Purpose
4+
5+
Poolifier Web Worker is a TypeScript/JavaScript library that provides worker
6+
pool implementations for Deno, Bun, and browser environments using the Web
7+
Worker API. It enables CPU and/or I/O intensive task execution without blocking
8+
the main event loop.
9+
10+
## Key Features
11+
12+
- Fixed and dynamic pool size management
13+
- Worker choice strategies for task distribution
14+
- Lockless task queueing and rescheduling
15+
- Support for sync/async task functions
16+
- Multiple task functions with priority queuing
17+
- Error handling and performance monitoring
18+
- Zero runtime dependencies
19+
20+
## Tech Stack
21+
22+
- **Runtime**: Deno, Bun, Browser
23+
- **Language**: TypeScript with ESM modules
24+
- **Testing**: Deno test framework with @std/expect
25+
- **Benchmarking**: Tatami-ng and built-in Deno bench
26+
- **Formatting**: Deno fmt (2-space, single quotes, no semicolons)
27+
- **Linting**: Deno lint
28+
29+
## Target Platforms
30+
31+
- Deno >= 1.40.x
32+
- Bun >= 1.x
33+
- Modern browsers with Web Worker support
Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# Suggested Commands for Poolifier Web Worker
2+
3+
## Development Commands
4+
5+
- `deno task test` - Run all tests
6+
- `deno task test:parallel` - Run tests in parallel
7+
- `deno task test:coverage` - Run tests with coverage
8+
- `deno test -A tests/path/to/specific.test.mjs` - Run single test file
9+
- `deno task lint` - Run linting checks
10+
- `deno task lint:fix` - Run linting with auto-fixes
11+
- `deno task format` - Format code
12+
- `deno task format:check` - Check formatting without fixing
13+
- `deno task bundle` - Bundle the project
14+
- `deno task coverage:report` - Generate coverage report
15+
16+
## Benchmarking Commands
17+
18+
- `deno task benchmark:deno` - Run Deno benchmarks
19+
- `deno task benchmark:tatami-ng` - Run Tatami-ng benchmarks
20+
- `deno task benchmark:tatami-ng:debug` - Run benchmarks with debugging
21+
22+
## Documentation
23+
24+
- `deno task documentation` - Generate code documentation
25+
26+
## Utilities
27+
28+
- `git` - Git version control
29+
- `ls` - List files
30+
- `cd` - Change directory
31+
- `grep` - Search text patterns
32+
- `find` - Find files
33+
- `cat` - Display file content
34+
- `head`/`tail` - Show beginning/end of files
Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
# Task Completion Checklist
2+
3+
## When a Task is Completed
4+
5+
### 1. Code Quality Checks
6+
7+
- Run `deno task lint` to check for linting issues
8+
- Run `deno task lint:fix` to auto-fix linting issues
9+
- Run `deno task format` to format code consistently
10+
11+
### 2. Testing
12+
13+
- Run `deno task test` to execute all tests
14+
- For specific changes, run individual test files:
15+
`deno test -A tests/path/to/specific.test.mjs`
16+
- If making significant changes, run `deno task test:coverage` to ensure
17+
coverage
18+
19+
### 3. Documentation
20+
21+
- Ensure all new functions have proper JSDoc comments
22+
- Update documentation if public API changes
23+
- Generate code documentation with `deno task documentation` if needed
24+
25+
### 4. Final Validation
26+
27+
- Verify code builds: `deno task bundle`
28+
- Check format compliance: `deno task format:check`
29+
- Ensure no linting errors: `deno task lint`
30+
31+
### 5. Quality Gates
32+
33+
All of the following must pass before considering a task complete:
34+
35+
- ✅ Linting passes
36+
- ✅ Formatting is correct
37+
- ✅ All tests pass
38+
- ✅ Code coverage is maintained
39+
- ✅ Documentation is updated
40+
41+
### 6. Git Workflow
42+
43+
- Stage relevant changes: `git add <files>`
44+
- Commit with meaningful message: `git commit -m "description"`
45+
- Push changes: `git push`

.serena/project.yml

Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
# list of languages for which language servers are started; choose from:
2+
# al bash clojure cpp csharp csharp_omnisharp
3+
# dart elixir elm erlang fortran go
4+
# haskell java julia kotlin lua markdown
5+
# nix perl php python python_jedi r
6+
# rego ruby ruby_solargraph rust scala swift
7+
# terraform typescript typescript_vts zig
8+
# Note:
9+
# - For C, use cpp
10+
# - For JavaScript, use typescript
11+
# Special requirements:
12+
# - csharp: Requires the presence of a .sln file in the project folder.
13+
# When using multiple languages, the first language server that supports a given file will be used for that file.
14+
# The first language is the default language and the respective language server will be used as a fallback.
15+
# Note that when using the JetBrains backend, language servers are not used and this list is correspondingly ignored.
16+
languages:
17+
- typescript
18+
19+
# the encoding used by text files in the project
20+
# For a list of possible encodings, see https://docs.python.org/3.11/library/codecs.html#standard-encodings
21+
encoding: 'utf-8'
22+
23+
# whether to use the project's gitignore file to ignore files
24+
# Added on 2025-04-07
25+
ignore_all_files_in_gitignore: true
26+
27+
# list of additional paths to ignore
28+
# same syntax as gitignore, so you can use * and **
29+
# Was previously called `ignored_dirs`, please update your config if you are using that.
30+
# Added (renamed) on 2025-04-07
31+
ignored_paths: []
32+
33+
# whether the project is in read-only mode
34+
# If set to true, all editing tools will be disabled and attempts to use them will result in an error
35+
# Added on 2025-04-18
36+
read_only: false
37+
38+
# list of tool names to exclude. We recommend not excluding any tools, see the readme for more details.
39+
# Below is the complete list of tools for convenience.
40+
# To make sure you have the latest list of tools, and to view their descriptions,
41+
# execute `uv run scripts/print_tool_overview.py`.
42+
#
43+
# * `activate_project`: Activates a project by name.
44+
# * `check_onboarding_performed`: Checks whether project onboarding was already performed.
45+
# * `create_text_file`: Creates/overwrites a file in the project directory.
46+
# * `delete_lines`: Deletes a range of lines within a file.
47+
# * `delete_memory`: Deletes a memory from Serena's project-specific memory store.
48+
# * `execute_shell_command`: Executes a shell command.
49+
# * `find_referencing_code_snippets`: Finds code snippets in which the symbol at the given location is referenced.
50+
# * `find_referencing_symbols`: Finds symbols that reference the symbol at the given location (optionally filtered by type).
51+
# * `find_symbol`: Performs a global (or local) search for symbols with/containing a given name/substring (optionally filtered by type).
52+
# * `get_current_config`: Prints the current configuration of the agent, including the active and available projects, tools, contexts, and modes.
53+
# * `get_symbols_overview`: Gets an overview of the top-level symbols defined in a given file.
54+
# * `initial_instructions`: Gets the initial instructions for the current project.
55+
# Should only be used in settings where the system prompt cannot be set,
56+
# e.g. in clients you have no control over, like Claude Desktop.
57+
# * `insert_after_symbol`: Inserts content after the end of the definition of a given symbol.
58+
# * `insert_at_line`: Inserts content at a given line in a file.
59+
# * `insert_before_symbol`: Inserts content before the beginning of the definition of a given symbol.
60+
# * `list_dir`: Lists files and directories in the given directory (optionally with recursion).
61+
# * `list_memories`: Lists memories in Serena's project-specific memory store.
62+
# * `onboarding`: Performs onboarding (identifying the project structure and essential tasks, e.g. for testing or building).
63+
# * `prepare_for_new_conversation`: Provides instructions for preparing for a new conversation (in order to continue with the necessary context).
64+
# * `read_file`: Reads a file within the project directory.
65+
# * `read_memory`: Reads the memory with the given name from Serena's project-specific memory store.
66+
# * `remove_project`: Removes a project from the Serena configuration.
67+
# * `replace_lines`: Replaces a range of lines within a file with new content.
68+
# * `replace_symbol_body`: Replaces the full definition of a symbol.
69+
# * `restart_language_server`: Restarts the language server, may be necessary when edits not through Serena happen.
70+
# * `search_for_pattern`: Performs a search for a pattern in the project.
71+
# * `summarize_changes`: Provides instructions for summarizing the changes made to the codebase.
72+
# * `switch_modes`: Activates modes by providing a list of their names
73+
# * `think_about_collected_information`: Thinking tool for pondering the completeness of collected information.
74+
# * `think_about_task_adherence`: Thinking tool for determining whether the agent is still on track with the current task.
75+
# * `think_about_whether_you_are_done`: Thinking tool for determining whether the task is truly completed.
76+
# * `write_memory`: Writes a named memory (for future reference) to Serena's project-specific memory store.
77+
excluded_tools: []
78+
79+
# initial prompt for the project. It will always be given to the LLM upon activating the project
80+
# (contrary to the memories, which are loaded on demand).
81+
initial_prompt: ''
82+
83+
project_name: 'poolifier-web-worker'
84+
included_optional_tools: []

examples/deno/javascript/multiFunctionWorker.js

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,20 @@
11
import { ThreadWorker } from '@poolifier/poolifier-web-worker'
22

3+
/**
4+
* First worker function example.
5+
* @param data - The input data containing text.
6+
* @returns The processed result with modified text.
7+
*/
38
function fn0(data) {
49
console.info('Executing fn0')
510
return { data: `fn0 input text was '${data.text}'` }
611
}
712

13+
/**
14+
* Second worker function example.
15+
* @param data - The input data containing text.
16+
* @returns The processed result with modified text.
17+
*/
818
function fn1(data) {
919
console.info('Executing fn1')
1020
return { data: `fn1 input text was '${data.text}'` }

examples/deno/javascript/yourWorker.js

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
import { ThreadWorker } from '@poolifier/poolifier-web-worker'
22

3+
/**
4+
* Example worker function that performs JSON serialization operations.
5+
* @returns The result indicating successful completion.
6+
*/
37
function yourFunction() {
48
for (let i = 0; i <= 1000; i++) {
59
const o = {

src/circular-buffer.ts

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,10 @@ export class CircularBuffer {
1616
public size: number
1717

1818
/**
19-
* @param size - Buffer size. @defaultValue defaultBufferSize
19+
* CircularBuffer constructor.
20+
*
21+
* @param size - Buffer size.
22+
* @defaultValue defaultBufferSize
2023
* @returns CircularBuffer.
2124
*/
2225
constructor(size: number = defaultBufferSize) {

0 commit comments

Comments
 (0)