taskforcesh / bullmq / 29440486531

89%

push

github

feat: idiomatic builder-based ergonomics across the public API [rust] (#4288)

- Queue::add now returns an `AddJob` builder implementing `IntoFuture`, so
  `queue.add(name, data).delay(..).priority(..).await?` works, and the
  simple `queue.add(name, data).await?` still does. `data` accepts any
  `impl Serialize` (serialized internally, like TS).
- add_bulk takes `Vec<BulkJob>` with `BulkJob::new(..)`/`with_options(..)`
  and the same fluent setters.
- JobOptions/QueueOptions/WorkerOptions/RateLimiterOptions gain infallible,
  chainable builders (public fields kept, so struct-literals still work).
- FlowProducer gains builders: `FlowJob::new(..).options(..).add_child(..)`,
  plus `GetFlowOptions`, `FlowOptions`, `FlowQueueOptions`,
  `FlowProducerOptions` builders.
- Unified constructor convention: `new(requiredArgs)` uses defaults,
  `with_options(requiredArgs, opts)` is explicit
  (Queue/Worker/QueueEvents/FlowProducer).
- Worker processors accept a bare async closure via a new `IntoProcessor`
  trait (pre-boxed `ProcessorFn` still accepted).
- Normalized option type names from `Opts` to `Options`.
- Added tests/ergonomics_test.rs covering the new surface end-to-end.

- `Queue::new(name, opts)` -> `Queue::with_options(name, opts)`; `Queue::new`
  now takes only the name.
- `Worker::new(name, processor, opts)` -> `Worker::with_options(..)`;
  `Worker::new(name, processor)` uses default options.
- `QueueEvents::new(name, opts)` -> `QueueEvents::with_options(name, opts)`.
- `FlowProducer::new(opts)` -> `FlowProducer::with_options(opts)`;
  `FlowProducer::new()` uses defaults.
- `Queue::add(name, data, opts)` -> `Queue::add(name, data)` builder.
- `Queue::add_bulk(Vec<(String, Value, Option<JobOptions>)>)` ->
  `add_bulk(Vec<BulkJob>)`.
- Renamed types: `ParentOpts`->`ParentOptions`, `FlowOpts`->`FlowOptions`,
  `GetFlowOpts`->`GetFlowOptions`; methods `add_with_opts`/`add_bulk_with_opts`
  -> `add_with_options`/`add_bulk_with_options`.

1655 of 1959 branches covered (84.48%)

Branch coverage included in aggregate %.

3088 of 3414 relevant lines covered (90.45%)

4102.53 hits per line