2020-01-05 05:24:09 +08:00
# Changelog
All notable changes to this project will be documented in this file.
The format is based on ["Keep a Changelog" ](https://keepachangelog.com/en/1.0.0/ ),
and this project adheres to [Semantic Versioning ](https://semver.org/spec/v2.0.0.html ).
## [Unreleased]
2020-03-26 22:31:08 +08:00
### Added
- `ParseRedisURI` helper function is added to create a `RedisConnOpt` from a URI string.
2020-04-26 22:48:38 +08:00
- `SetDefaultOptions` method is added to `Client` .
2020-03-26 22:31:08 +08:00
2020-04-20 00:08:20 +08:00
## [0.8.0] - 2020-04-19
2020-04-13 08:16:44 +08:00
### Changed
- `Background` type is renamed to `Server` .
2020-04-19 03:37:24 +08:00
- To upgrade from the previous version, Update `NewBackground` to `NewServer` and pass `Config` by value.
2020-04-13 08:16:44 +08:00
- CLI is renamed to `asynq` .
2020-04-19 03:37:24 +08:00
- To upgrade the CLI to the latest version run `go get -u github.com/hibiken/tools/asynq`
2020-04-13 08:16:44 +08:00
- The `ps` command in CLI is renamed to `servers`
2020-04-19 03:44:52 +08:00
- `Concurrency` defaults to the number of CPUs when unset or set to a negative value.
2020-04-13 08:16:44 +08:00
2020-04-19 03:37:24 +08:00
### Added
- `ShutdownTimeout` field is added to `Config` to speicfy timeout duration used during graceful shutdown.
- New `Server` type exposes `Start` , `Stop` , and `Quiet` as well as `Run` .
2020-04-06 05:56:06 +08:00
## [0.7.1] - 2020-04-05
### Fixed
- Fixed signal handling for windows.
2020-03-23 03:04:37 +08:00
## [0.7.0] - 2020-03-22
### Changed
- Support Go v1.13+, dropped support for go v1.12
2020-03-18 21:49:39 +08:00
### Added
- `Unique` option was added to allow client to enqueue a task only if it's unique within a certain time period.
2020-03-16 12:02:28 +08:00
## [0.6.2] - 2020-03-15
2020-03-14 05:38:45 +08:00
### Added
- `Use` method was added to `ServeMux` to apply middlewares to all handlers.
2020-03-12 23:42:18 +08:00
## [0.6.1] - 2020-03-12
2020-03-08 12:24:03 +08:00
### Added
- `Client` can optionally schedule task with `asynq.Deadline(time)` to specify deadline for task's context. Default is no deadline.
2020-03-12 23:42:18 +08:00
- `Logger` option was added to config, which allows user to specify the logger used by the background instance.
2020-03-08 12:24:03 +08:00
2020-03-02 07:54:59 +08:00
## [0.6.0] - 2020-03-01
2020-03-01 13:34:12 +08:00
### Added
2020-03-02 03:08:00 +08:00
- Added `ServeMux` type to make it easy for users to implement Handler interface.
2020-03-01 13:34:12 +08:00
- `ErrorHandler` type was added. Allow users to specify error handling function (e.g. Report error to error reporting service such as Honeybadger, Bugsnag, etc)
2020-02-24 12:44:03 +08:00
## [0.5.0] - 2020-02-23
2020-02-24 07:40:04 +08:00
### Changed
- `Client` API has changed. Use `Enqueue` , `EnqueueAt` and `EnqueueIn` to enqueue and schedule tasks.
2020-02-23 13:06:02 +08:00
### Added
- `asynqmon workers` was added to list all running workers information
2020-02-13 22:25:27 +08:00
## [0.4.0] - 2020-02-13
2020-02-13 10:11:59 +08:00
### Changed
- `Handler` interface has changed. `ProcessTask` method takes two arguments `context.Context` and `*asynq.Task`
2020-02-13 22:17:47 +08:00
- `Queues` field in `Config` has change from `map[string]uint` to `map[string]int`
2020-02-13 10:11:59 +08:00
### Added
- `Client` can optionally schedule task with `asynq.Timeout(duration)` to specify timeout duration for task. Default is no timeout.
- `asynqmon cancel [task id]` will send a cancelation signal to the goroutine processing the speicified task.
2020-02-04 22:29:57 +08:00
## [0.3.0] - 2020-02-04
2020-02-03 12:59:00 +08:00
### Added
- `asynqmon ps` was added to list all background worker processes
2020-01-27 08:07:44 +08:00
## [0.2.2] - 2020-01-26
2020-01-27 05:55:23 +08:00
### Fixed
- Fixed restoring unfinished tasks back to correct queues.
2020-01-24 23:19:58 +08:00
### Changed
- `asynqmon ls` command is now paginated (default 30 tasks from first page)
- `asynqmon ls enqueued:[queue name]` requires queue name to be specified
2020-01-22 22:45:16 +08:00
## [0.2.1] - 2020-01-22
### Fixed
- More structured log messages
- Prevent spamming logs with a bunch of errors when Redis connection is lost
- Fixed and updated README doc
2020-01-20 07:28:24 +08:00
## [0.2.0] - 2020-01-19
2020-01-05 05:13:46 +08:00
### Added
- NewTask constructor
2020-01-08 13:53:38 +08:00
- `Queues` option in `Config` to specify mutiple queues with priority level
- `Client` can schedule a task with `asynq.Queue(name)` to specify which queue to use
2020-01-12 23:46:51 +08:00
- `StrictPriority` option in `Config` to specify whether the priority should be followed strictly
2020-01-17 12:54:36 +08:00
- `RedisConnOpt` to abstract away redis client implementation
2020-01-14 22:05:21 +08:00
- [CLI] `asynqmon rmq` command to remove queue
2020-01-05 05:13:46 +08:00
### Changed
2020-01-17 12:54:36 +08:00
- `Client` and `Background` constructors take `RedisConnOpt` as their first argument.
2020-01-20 07:28:24 +08:00
- `asynqmon stats` now shows the total of all enqueued tasks under "Enqueued"
- `asynqmon stats` now shows each queue's task count
- `asynqmon history` now doesn't take any arguments and shows data from the last 10 days by default (use `--days` flag to change the number of days)
2020-01-05 05:13:46 +08:00
- Task type is now immutable (i.e., Payload is read-only)
2020-01-05 05:24:09 +08:00
## [0.1.0] - 2020-01-04
### Added
- Initial version of asynq package
- Initial version of asynqmon CLI
