diff options
Diffstat (limited to 'CHANGELOG.md')
| -rw-r--r-- | CHANGELOG.md | 839 |
1 files changed, 643 insertions, 196 deletions
diff --git a/CHANGELOG.md b/CHANGELOG.md index f99bbf18..d0c9a309 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,63 +1,533 @@ # CHANGELOG -# v2.7.0 (?.?.2022) +## v2.7.0 (14.01.2022) ## ๐ New: - โ๏ธ RR `workers pool`, `worker`, `worker_watcher` now has their own log levels. `stderr/stdout` logged as before at the `info` log level. All other messages moved to the `debug` log level except a few events from the `worker_watcher` when RR can't allocate the new worker which are moved to the `warn`. - โ๏ธ Use the common logger for the whole roadrunner-sdk and roadrunner-plugins. -- โ๏ธ Add `codec` field to the `protocol` structure **[internal change]**. +- โ๏ธ `.rr.yaml` now support versions. You may safely use your old configurations w/o specifying versions. Configuration w/o version will be treated as `2.6`. It is safe to use configuration w/o version or with version `2.6` with RR `2.7` because RR is able to automatically transform the old configuration. + But if you use configuration version `2.7` you must update the `jobs` pipelines config. + **At this point we can guarantee, that no breaking changes will be introduced in the configuration w/o auto-convert from the older configuration version** + For example, if we introduce a configuration update let's say in version `2.10`, we will support automatic conversion from at least 2 previous versions w/o involving the user into the process. In the example case, versions `2.9` and `2.8` will be automatically converted. From our release cycle, you will have at least 3 months to update the configuration from version `2.8` and 2 months from `2.9`.Version located at the top of the `.rr.yaml`: + +**Compatibility matrix located here**: TODO +**Configuration changelog**: TODO + +```yaml +version: "2.6" + +# ..... PLUGINS ...... +``` + +**Before:** +```yaml + pipelines: + test-local: + driver: memory + priority: 10 + prefetch: 10000 + + test-local-1: + driver: boltdb + priority: 10 + file: "rr.db" + prefetch: 10000 + + test-local-2: + driver: amqp + prefetch: 10 + priority: 1 + queue: test-1-queue + exchange: default + exchange_type: direct + routing_key: test + exclusive: false + multiple_ack: false + requeue_on_fail: false + + test-local-3: + driver: beanstalk + priority: 11 + tube_priority: 1 + tube: default-1 + reserve_timeout: 10s + + test-local-4: + driver: sqs + priority: 10 + prefetch: 10 + visibility_timeout: 0 + wait_time_seconds: 0 + queue: default + attributes: + DelaySeconds: 0 + MaximumMessageSize: 262144 + MessageRetentionPeriod: 345600 + ReceiveMessageWaitTimeSeconds: 0 + VisibilityTimeout: 30 + tags: + test: "tag" + + test-local-5: + driver: nats + priority: 2 + prefetch: 100 + subject: default + stream: foo + deliver_new: true + rate_limit: 100 + delete_stream_on_stop: false + delete_after_ack: false +``` + +**After**: +Now, pipelines have only `driver` key with the configuration under the `config` key. We did that to uniform configuration across all drivers (like in the `KV`). +```yaml + pipelines: + test-local: + driver: memory + + config: # <------------------ NEW + priority: 10 + prefetch: 10000 + + test-local-1: + driver: boltdb + + config: # <------------------ NEW + priority: 10 + file: "test-local-1-bolt.db" + prefetch: 10000 + + test-local-2: + driver: amqp + + config: # <------------------ NEW + priority: 11 + prefetch: 100 + queue: test-12-queue + exchange: default + exchange_type: direct + routing_key: test + exclusive: false + multiple_ack: false + requeue_on_fail: false + + test-local-3: + driver: beanstalk + + config: # <------------------ NEW + priority: 11 + tube_priority: 1 + tube: default-2 + reserve_timeout: 10s + + test-local-4: + driver: sqs + + config: # <------------------ NEW + priority: 10 + prefetch: 10 + visibility_timeout: 0 + wait_time_seconds: 0 + queue: default + + attributes: + DelaySeconds: 0 + MaximumMessageSize: 262144 + MessageRetentionPeriod: 345600 + ReceiveMessageWaitTimeSeconds: 0 + VisibilityTimeout: 30 + tags: + test: "tag" + + test-local-5: + driver: nats + + config: # <------------------ NEW + priority: 2 + prefetch: 100 + subject: default + stream: foo + deliver_new: true + rate_limit: 100 + delete_stream_on_stop: false + delete_after_ack: false +``` + +- โ๏ธ **[ALPHA]** New cache http middleware. It is still in alpha, but we started implementing the [rfc-7234](https://httpwg.org/specs/rfc7234.html) to support `Cache-Control` and caching in general. In the first alpha you may test the `max-age`, `Age` and `Authorization` support via the in-memory driver. + +**Configuration**: +```yaml +http: +# ..... + middleware: ["cache"] + cache: + driver: memory + cache_methods: ["GET", "HEAD", "POST"] # only GET in alpha + config: {} # empty configuration for the memory +``` + +- โ๏ธ Logger unification. Starting this version we bound our logs to the `uber/zap` log library as one of the most popular and extensible. +- โ๏ธ API stabilization. All `v2` api interfaces moved to the `https://github.com/roadrunner-server/api` repository. Except logger (structure), all plugins depends only on the interfaces and don't import each other. +- โ๏ธ `GRPC` plugin now is able to work with gzipped payloads. [FR](https://github.com/spiral/roadrunner-plugins/issues/191) (reporter @hetao29) +- โ๏ธ `SQS` plugin now detects EC2 env and uses AWS credentials instead of static provider. [FR](https://github.com/spiral/roadrunner-plugins/issues/142) (reporter @paulermo) +- โ๏ธ `Jobs` plugin now acknowledges responses with incorrectly formed responses to prevent the infinity loop (with the error message in the logs). [BUG](https://github.com/spiral/roadrunner-plugins/issues/190) (reporter @sergey-telpuk) +- โ๏ธ `protoc` updated to the version `v3.19.2`. ## ๐ฉน Fixes: - ๐ Fix: RR may have missed the message from the `stderr` when the PHP script failed to start immediately after RR starts. +- ๐ Fix: 200 HTTP status code instead of 400 on readiness/health bad requests. [BUG](https://github.com/spiral/roadrunner-plugins/issues/180) +- ๐ Fix: `new_relic` plugin removes/modifies more headers than it should. [BUG](https://github.com/spiral/roadrunner-plugins/issues/185) (reporter: @arku31) ---- -# v2.6.3 (23.12.2021) +## v2.6.6 (7.12.2021) ## ๐ New: -- โ๏ธ Add `Reset` method to the static pool interface. Should be used to reset the pool instead of destroying and replacing it. +- โ๏ธ Add events from the supervisor to the `server` plugin. +- +## ๐ฉน Fixes: +- ๐ Fix: worker exited immediately after obtaining the response. [BUG](https://github.com/spiral/roadrunner/issues/871) (reporter: @samdark). + +## ๐ฆ Packages: + +- ๐ฆ Update RoadRunner to `v2.6.2` + +## v2.6.5 (7.12.2021) + +## ๐ฉน Fixes: +- ๐ Fix: wrong metrics type for the `rr_http_requests_queue`, [bug](https://github.com/spiral/roadrunner-plugins/issues/162) (reporter: @victor-sudakov) +- ๐ Fix: memory leak when supervised static pool used. [PR](https://github.com/spiral/roadrunner/pull/870). + +## ๐ฆ Packages: + +- ๐ฆ Update RoadRunner to `v2.6.1` --- -# v2.6.2 (15.12.2021) +## v2.6.4 (7.12.2021) + +## ๐ฆ Packages: + +- ๐ฆ Update endure to `v1.1.0` ## ๐ฉน Fixes: +- ๐ Fix: NPE in the `http.Reset`. [BUG](https://github.com/spiral/roadrunner-plugins/issues/155) -- ๐ Fix: worker exited immediately after obtaining the response. [BUG](https://github.com/spiral/roadrunner/issues/871) (reporter: @samdark). +--- + +## v2.6.3 (3.12.2021) + +## ๐ New: +- โ๏ธ `informer.List` RPC call return all available plugins with workers instead of all available plugins. This behavior was changed because `Informer` has the dependency of every RR plugin, which led to the cycles. This is not an external API and used only internally. +- โ๏ธ Beanstalk queue returned to the **[ALPHA]** stage. It's very unstable when destroying pipelines and can lead to infinite read loops when something wrong with the connection. Use with care. +- โ๏ธ Go version updated to `v1.17.4`. + +## ๐ฉน Fixes: +- ๐ Fix: add missing plugins to the container: `fileserver`, `http_metrics`. --- -# v2.6.1 (14.12.2021) +## v2.6.2 (3.12.2021) ## ๐ฉน Fixes: -- ๐ Fix: memory leak when supervised static pool used. [PR](https://github.com/spiral/roadrunner/pull/870). +- ๐ Fix: Random NPE on RR start. [BUG](https://github.com/spiral/roadrunner-plugins/issues/143) --- -# v2.6.0 (30.11.2021) +## v2.6.1 (2.12.2021) + +## ๐ฉน Fixes: + +- ๐ Fix: logger incorrectly escaped HTML, JSON, and other special symbols. + +--- -### ๐ New: +## v2.6.0 (30.11.2021) +## ๐ New: - โ๏ธ New internal message bus. Available globally. Supports wildcard subscriptions (for example: `http.*` will subscribe you to the all events coming from the `http` plugin). The subscriptions can be made from any RR plugin to any RR plugin. - โ๏ธ Now, RR will show in the returned error the bad header content in case of CRC mismatch error. More info in the [PR](https://github.com/spiral/roadrunner/pull/863). +- โ๏ธ **[BETA]** Support for the New Relic observability platform. Sample of the client library might be + found [here](https://github.com/arku31/roadrunner-newrelic). (Thanks @arku31) + New Relic middleware is a part of the HTTP plugin, thus configuration should be inside it: + +```yaml +http: + address: 127.0.0.1:15389 + middleware: [ "new_relic" ] <------- NEW + new_relic: <---------- NEW + app_name: "app" + license_key: "key" + pool: + num_workers: 10 + allocate_timeout: 60s + destroy_timeout: 60s +``` + +License key and application name could be set via environment variables: (leave `app_name` and `license_key` empty) + +- license_key: `NEW_RELIC_LICENSE_KEY`. +- app_name: `NEW_RELIC_APP_NAME`. + +To set the New Relic attributes, the PHP worker should send headers values withing the `rr_newrelic` header key. +Attributes should be separated by the `:`, for example `foo:bar`, where `foo` is a key and `bar` is a value. New Relic +attributes sent from the worker will not appear in the HTTP response, they will be sent directly to the New Relic. + +To see the sample of the PHP library, see the @arku31 implementation: https://github.com/arku31/roadrunner-newrelic + +The special key which PHP may set to overwrite the transaction name is: `transaction_name`. For +example: `transaction_name:foo` means: set transaction name as `foo`. By default, `RequestURI` is used as the +transaction name. + +```php + $resp = new \Nyholm\Psr7\Response(); + $rrNewRelic = [ + 'shopId:1', //custom data + 'auth:password', //custom data + 'transaction_name:test_transaction' //name - special key to override the name. By default it will use requestUri. + ]; + + $resp = $resp->withHeader('rr_newrelic', $rrNewRelic); +``` + +--- + +- โ๏ธ **[BETA]** New plugin: `TCP`. The TCP plugin is used to handle raw TCP payload with a bi-directional [protocol](tcp/docs/tcp.md) between the RR server and PHP worker. + +PHP client library: https://github.com/spiral/roadrunner-tcp + +Configuration: +```yaml +rpc: + listen: tcp://127.0.0.1:6001 + +server: + command: "php ../../psr-worker-tcp-cont.php" + +tcp: + servers: + server1: + addr: 127.0.0.1:7778 + delimiter: "\r\n" + server2: + addr: 127.0.0.1:8811 + read_buf_size: 10 + server3: + addr: 127.0.0.1:8812 + delimiter: "\r\n" + read_buf_size: 1 + + pool: + num_workers: 5 + max_jobs: 0 + allocate_timeout: 60s + destroy_timeout: 60s +``` + +--- + +- โ๏ธ New HTTP middleware: `http_metrics`. +```yaml +http: + address: 127.0.0.1:15389 + middleware: [ "http_metrics" ] <------- NEW + pool: + num_workers: 10 + allocate_timeout: 60s + destroy_timeout: 60s +``` +All old and new http metrics will be available after the middleware is activated. Be careful, this middleware may slow down your requests. New metrics: + + - `rr_http_requests_queue_sum` - number of queued requests. + - `rr_http_no_free_workers_total` - number of the occurrences of the `NoFreeWorkers` errors. + + +----- + +- โ๏ธ New file server to serve static files. It works on a different address, so it doesn't affect the HTTP performance. It uses advanced configuration specific for the static file servers. It can handle any number of directories with its own HTTP prefixes. + Config: + +```yaml +fileserver: + # File server address + # + # Error on empty + address: 127.0.0.1:10101 + # Etag calculation. Request body CRC32. + # + # Default: false + calculate_etag: true + + # Weak etag calculation + # + # Default: false + weak: false + + # Enable body streaming for the files more than 4KB + # + # Default: false + stream_request_body: true + + serve: + # HTTP prefix + # + # Error on empty + - prefix: "/foo" + + # Directory to serve + # + # Default: "." + root: "../../../tests" + + # When set to true, the server tries minimizing CPU usage by caching compressed files + # + # Default: false + compress: false + + # Expiration duration for inactive file handlers. Units: seconds. + # + # Default: 10, use a negative value to disable it. + cache_duration: 10 + + # The value for the Cache-Control HTTP-header. Units: seconds + # + # Default: 10 seconds + max_age: 10 + + # Enable range requests + # https://developer.mozilla.org/en-US/docs/Web/HTTP/Range_requests + # + # Default: false + bytes_range: true + + - prefix: "/foo/bar" + root: "../../../tests" + compress: false + cache_duration: 10s + max_age: 10 + bytes_range: true +``` + +- โ๏ธ `on_init` option for the `server` plugin. `on_init` code executed before the regular command and can be used to warm up the application for example. Failed `on_init` command doesn't affect the main command, so, the RR will continue to run. Thanks (@OO00O0O) + +Config: +```yaml +# Application server settings (docs: https://roadrunner.dev/docs/php-worker) +server: + on_init: <----------- NEW + # Command to execute before the main server's command + # + # This option is required if using on_init + command: "any php or script here" + + # Script execute timeout + # + # Default: 60s [60m, 60h], if used w/o units its means - NANOSECONDS. + exec_timeout: 20s + + # Environment variables for the worker processes. + # + # Default: <empty map> + env: + - SOME_KEY: "SOME_VALUE" + - SOME_KEY2: "SOME_VALUE2" + + # ..REGULAR SERVER OPTIONS... +``` + +--- + +- โ๏ธ **[BETA]** GRPC can handle multiply proto files. + Config: +```yaml +# GRPC service configuration +grpc: + # Proto files to use + # + # This option is required. At least one proto file must be specified. + proto: + - "first.proto" + - "second.proto" + +## ... OTHER REGULAR GRPC OPTIONS ... +``` + +--- + +- โ๏ธ New `allow` configuration option for the `http.uploads` and multipart requests. The new option allows you to filter upload extensions knowing only allowed. Now, there is no need to have a looong list with all possible extensions to forbid. [FR](https://github.com/spiral/roadrunner-plugins/issues/123) (Thanks @rjd22) + `http.uploads.forbid` has a higher priority, so, if you have duplicates in the `http.uploads.allow` and `http.uploads.forbid` the duplicated extension will be forbidden. + Config: + +```yaml +http: + address: 127.0.0.1:18903 + max_request_size: 1024 + middleware: ["pluginMiddleware", "pluginMiddleware2"] + uploads: + forbid: [".php", ".exe", ".bat"] + allow: [".html", ".aaa" ] <------------- NEW + trusted_subnets: + [ + "10.0.0.0/8", + "127.0.0.0/8", + "172.16.0.0/12", + "192.168.0.0/16", + "::1/128", + "fc00::/7", + "fe80::/10", + ] + pool: + num_workers: 2 + max_jobs: 0 + allocate_timeout: 60s + destroy_timeout: 60s +``` + +- โ๏ธ Beanstalk queue reject stop RPC calls if there are jobs in the priority queue associated with the requested + pipeline. + +- โ๏ธ Startup message when the RR has started. ## ๐ฉน Fixes: +- ๐ Fix: GRPC server will show message when started. +- ๐ Fix: Static plugin headers were added to all requests. [BUG](https://github.com/spiral/roadrunner-plugins/issues/115) - ๐ Fix: zombie processes in the `pool.debug` mode. ---- +## ๐ฆ Packages: + +- ๐ฆ roadrunner `v2.6.0` +- ๐ฆ roadrunner-plugins `v2.6.0` +- ๐ฆ roadrunner-temporal `v1.0.11` +- ๐ฆ endure `v1.0.8` +- ๐ฆ goridge `v3.2.4` +- ๐ฆ temporal.io/sdk `v1.11.1` + +## v2.5.3 (27.10.2021) + +## ๐ฉน Fixes: + +- ๐ Fix: panic in the TLS layer. The `http` plugin used `http` server instead of `https` in the rootCA routine. + +## v2.5.2 (23.10.2021) + +## ๐ฉน Fixes: -# v2.5.1 (07.11.2021) +- ๐ Fix: ASLR builds causes [problems](https://github.com/spiral/roadrunner-binary/issues/120) in the docker. + + +## v2.5.1 (22.10.2021) ## ๐ฉน Fixes: -- ๐ Fix: worker's channel deadlock when using [TTL](https://github.com/spiral/roadrunner/issues/853). Thanks @dstrop +- ๐ Fix: [base64](https://github.com/spiral/roadrunner-plugins/issues/86) response instead of json in some edge cases. -# v2.5.0 (20.10.2021) +## v2.5.0 (20.10.2021) # ๐ Breaking change: @@ -69,9 +539,9 @@ ```yaml broadcast: - default: - driver: memory - interval: 1 + default: + driver: memory + interval: 1 ``` ### New style: @@ -80,7 +550,7 @@ broadcast: broadcast: default: driver: memory - config: { } <--------------- NEW + config: {} <--------------- NEW ``` ```yaml @@ -94,8 +564,8 @@ kv: memcached-rr: driver: memcached config: <--------------- NEW - addr: - - "127.0.0.1:11211" + addr: + - "127.0.0.1:11211" broadcast: default: @@ -108,11 +578,8 @@ broadcast: ## ๐ New: - โ๏ธ **[BETA]** GRPC plugin update to v2. -- โ๏ธ [Roadrunner-plugins](https://github.com/spiral/roadrunner-plugins) repository. This is the new home for the - roadrunner plugins with documentation, configuration samples, and common problems. -- โ๏ธ **[BETA]** Let's Encrypt support. RR now can obtain an SSL certificate/PK for your domain automatically. Here is - the new configuration: - +- โ๏ธ [Roadrunner-plugins](https://github.com/spiral/roadrunner-plugins) repository. This is the new home for the roadrunner plugins with documentation, configuration samples, and common problems. +- โ๏ธ **[BETA]** Let's Encrypt support. RR now can obtain an SSL certificate/PK for your domain automatically. Here is the new configuration: ```yaml ssl: # Host and port to listen on (eg.: `127.0.0.1:443`). @@ -165,25 +632,23 @@ broadcast: - โ๏ธ Add a new option to the `logs` plugin to configure the line ending. By default, used `\n`. **New option**: - ```yaml # Logs plugin settings logs: - (....) - # Line ending - # - # Default: "\n". - line_ending: "\n" + (....) + # Line ending + # + # Default: "\n". + line_ending: "\n" ``` - โ๏ธ HTTP [Access log support](https://github.com/spiral/roadrunner-plugins/issues/34) at the `Info` log level. - ```yaml http: address: 127.0.0.1:55555 max_request_size: 1024 access_logs: true <-------- Access Logs ON/OFF - middleware: [ ] + middleware: [] pool: num_workers: 2 @@ -191,16 +656,13 @@ http: allocate_timeout: 60s destroy_timeout: 60s ``` - -- โ๏ธ HTTP middleware to handle `X-Sendfile` [header](https://github.com/spiral/roadrunner-plugins/issues/9). Middleware - reads the file in 10MB chunks. So, for example for the 5Gb file, only 10MB of RSS will be used. If the file size is - smaller than 10MB, the middleware fits the buffer to the file size. - +- โ๏ธ HTTP middleware to handle `X-Sendfile` [header](https://github.com/spiral/roadrunner-plugins/issues/9). + Middleware reads the file in 10MB chunks. So, for example for the 5Gb file, only 10MB of RSS will be used. If the file size is smaller than 10MB, the middleware fits the buffer to the file size. ```yaml http: address: 127.0.0.1:44444 max_request_size: 1024 - middleware: [ "sendfile" ] <----- NEW MIDDLEWARE + middleware: ["sendfile"] <----- NEW MIDDLEWARE pool: num_workers: 2 @@ -210,7 +672,6 @@ http: ``` - โ๏ธ Service plugin now supports env variables passing to the script/executable/binary/any like in the `server` plugin: - ```yaml service: some_service_1: @@ -218,25 +679,21 @@ service: process_num: 1 exec_timeout: 5s # s,m,h (seconds, minutes, hours) remain_after_exit: true - env: <----------------- NEW + env: <----------------- NEW foo: "BAR" restart_sec: 1 ``` - โ๏ธ Server plugin can accept scripts (sh, bash, etc) in it's `command` configuration key: - ```yaml server: - command: "./script.sh OR sh script.sh" <--- UPDATED - relay: "pipes" - relay_timeout: "20s" + command: "./script.sh OR sh script.sh" <--- UPDATED + relay: "pipes" + relay_timeout: "20s" ``` - -The script should start a worker as the last command. For the `pipes`, scripts should not contain programs, which can -close `stdin`, `stdout` or `stderr`. +The script should start a worker as the last command. For the `pipes`, scripts should not contain programs, which can close `stdin`, `stdout` or `stderr`. - โ๏ธ Nats jobs driver support - [PR](https://github.com/spiral/roadrunner-plugins/pull/68). - ```yaml nats: addr: "demo.nats.io" @@ -264,14 +721,12 @@ jobs: consume: [ "test-1" ] ``` - - Driver uses NATS JetStream API and is not compatible with non-js API. -- โ๏ธ Response API for the NATS, RabbitMQ, SQS and Beanstalk drivers. This means, that you'll be able to respond to a - specified in the response queue. Limitations: - - To send a response to the queue maintained by the RR, you should send it as a `Job` type. There are no limitations - for the responses into the other queues (tubes, subjects). +- โ๏ธ Response API for the NATS, RabbitMQ, SQS and Beanstalk drivers. This means, that you'll be able to respond to a specified in the response queue. + Limitations: + - To send a response to the queue maintained by the RR, you should send it as a `Job` type. There are no limitations for the responses into the other queues (tubes, subjects). - Driver uses the same endpoint (address) to send the response as specified in the configuration. ## ๐ฉน Fixes: @@ -294,46 +749,38 @@ jobs: ## ๐ฉน Fixes: -- ๐ Fix: bug with not-idempotent call to the `attributes.Init`. -- ๐ Fix: memory jobs driver behavior. Now memory driver starts consuming automatically if the user consumes the - pipeline in the configuration. +- ๐ Fix: bug with not-idempotent call to the `attributes.Init`. +- ๐ Fix: memory jobs driver behavior. Now memory driver starts consuming automatically if the user consumes the pipeline in the configuration. ## v2.4.0 (02.09.2021) ## ๐ Internal BC: -- ๐จ Pool, worker interfaces: payload now passed and returned by the pointer. +- ๐จ Pool, worker interfaces: payload now passed and returned by the pointer. ## ๐ New: -- โ๏ธ Long-awaited, reworked `Jobs` plugin with pluggable drivers. Now you can allocate/destroy pipelines in the runtime. - Drivers included in the initial release: `RabbitMQ (0-9-1)`, `SQS v2`, `beanstalk`, `memory` and local queue powered - by the `boltdb`. [PR](https://github.com/spiral/roadrunner/pull/726) -- โ๏ธ Support for the IPv6 (`tcp|http(s)|empty [::]:port`, `tcp|http(s)|empty [::1]:port` - , `tcp|http(s)|empty :// [0:0:0:0:0:0:0:1]:port`) for RPC, HTTP and other - plugins. [RFC](https://datatracker.ietf.org/doc/html/rfc2732#section-2) -- โ๏ธ Support for the Docker images via GitHub packages. -- โ๏ธ Go 1.17 support for the all spiral packages. +- โ๏ธ Long-awaited, reworked `Jobs` plugin with pluggable drivers. Now you can allocate/destroy pipelines in the runtime. Drivers included in the initial release: `RabbitMQ (0-9-1)`, `SQS v2`, `beanstalk`, `memory` and local queue powered by the `boltdb`. [PR](https://github.com/spiral/roadrunner/pull/726) +- โ๏ธ Support for the IPv6 (`tcp|http(s)|empty [::]:port`, `tcp|http(s)|empty [::1]:port`, `tcp|http(s)|empty :// [0:0:0:0:0:0:0:1]:port`) for RPC, HTTP and other plugins. [RFC](https://datatracker.ietf.org/doc/html/rfc2732#section-2) +- โ๏ธ Support for the Docker images via GitHub packages. +- โ๏ธ Go 1.17 support for the all spiral packages. ## ๐ฉน Fixes: -- ๐ Fix: fixed bug with goroutines waiting on the internal worker's container - channel, [issue](https://github.com/spiral/roadrunner/issues/750). -- ๐ Fix: RR become unresponsive when new workers failed to - re-allocate, [issue](https://github.com/spiral/roadrunner/issues/772). -- ๐ Fix: add `debug` pool config key to the `.rr.yaml` - configuration [reference](https://github.com/spiral/roadrunner-binary/issues/79). +- ๐ Fix: fixed bug with goroutines waiting on the internal worker's container channel, [issue](https://github.com/spiral/roadrunner/issues/750). +- ๐ Fix: RR become unresponsive when new workers failed to re-allocate, [issue](https://github.com/spiral/roadrunner/issues/772). +- ๐ Fix: add `debug` pool config key to the `.rr.yaml` configuration [reference](https://github.com/spiral/roadrunner-binary/issues/79). ## ๐ฆ Packages: -- ๐ฆ Update goridge to `v3.2.1` -- ๐ฆ Update temporal to `v1.0.9` -- ๐ฆ Update endure to `v1.0.4` +- ๐ฆ Update goridge to `v3.2.1` +- ๐ฆ Update temporal to `v1.0.9` +- ๐ฆ Update endure to `v1.0.4` ## ๐ Summary: -- RR Milestone [2.4.0](https://github.com/spiral/roadrunner/milestone/29?closed=1) -- RR-Binary Milestone [2.4.0](https://github.com/spiral/roadrunner-binary/milestone/10?closed=1) +- RR Milestone [2.4.0](https://github.com/spiral/roadrunner/milestone/29?closed=1) +- RR-Binary Milestone [2.4.0](https://github.com/spiral/roadrunner-binary/milestone/10?closed=1) --- @@ -341,13 +788,13 @@ jobs: ## ๐ฉน Fixes: -- ๐ Fix: Do not call the container's Stop method after the container stopped by an error. -- ๐ Fix: Bug with ttl incorrectly handled by the worker [PR](https://github.com/spiral/roadrunner/pull/749) -- ๐ Fix: Add `RR_BROADCAST_PATH` to the `websockets` plugin [PR](https://github.com/spiral/roadrunner/pull/749) +- ๐ Fix: Do not call the container's Stop method after the container stopped by an error. +- ๐ Fix: Bug with ttl incorrectly handled by the worker [PR](https://github.com/spiral/roadrunner/pull/749) +- ๐ Fix: Add `RR_BROADCAST_PATH` to the `websockets` plugin [PR](https://github.com/spiral/roadrunner/pull/749) ## ๐ Summary: -- RR Milestone [2.3.2](https://github.com/spiral/roadrunner/milestone/31?closed=1) +- RR Milestone [2.3.2](https://github.com/spiral/roadrunner/milestone/31?closed=1) --- @@ -355,32 +802,32 @@ jobs: ## ๐ New: -- โ๏ธ Rework `broadcast` plugin. Add architecture diagrams to the `doc` - folder. [PR](https://github.com/spiral/roadrunner/pull/732) -- โ๏ธ Add `Clear` method to the KV plugin RPC. [PR](https://github.com/spiral/roadrunner/pull/736) +- โ๏ธ Rework `broadcast` plugin. Add architecture diagrams to the `doc` + folder. [PR](https://github.com/spiral/roadrunner/pull/732) +- โ๏ธ Add `Clear` method to the KV plugin RPC. [PR](https://github.com/spiral/roadrunner/pull/736) ## ๐ฉน Fixes: -- ๐ Fix: Bug with channel deadlock when `exec_ttl` was used and TTL limit - reached [PR](https://github.com/spiral/roadrunner/pull/738) -- ๐ Fix: Bug with healthcheck endpoint when workers were marked as invalid and stay is that state until next - request [PR](https://github.com/spiral/roadrunner/pull/738) -- ๐ Fix: Bugs with `boltdb` storage: [Boom](https://github.com/spiral/roadrunner/issues/717) - , [Boom](https://github.com/spiral/roadrunner/issues/718), [Boom](https://github.com/spiral/roadrunner/issues/719) -- ๐ Fix: Bug with incorrect redis initialization and usage [Bug](https://github.com/spiral/roadrunner/issues/720) -- ๐ Fix: Bug, Goridge duplicate error messages [Bug](https://github.com/spiral/goridge/issues/128) -- ๐ Fix: Bug, incorrect request `origin` check [Bug](https://github.com/spiral/roadrunner/issues/727) +- ๐ Fix: Bug with channel deadlock when `exec_ttl` was used and TTL limit + reached [PR](https://github.com/spiral/roadrunner/pull/738) +- ๐ Fix: Bug with healthcheck endpoint when workers were marked as invalid and stay is that state until next + request [PR](https://github.com/spiral/roadrunner/pull/738) +- ๐ Fix: Bugs with `boltdb` storage: [Boom](https://github.com/spiral/roadrunner/issues/717) + , [Boom](https://github.com/spiral/roadrunner/issues/718), [Boom](https://github.com/spiral/roadrunner/issues/719) +- ๐ Fix: Bug with incorrect redis initialization and usage [Bug](https://github.com/spiral/roadrunner/issues/720) +- ๐ Fix: Bug, Goridge duplicate error messages [Bug](https://github.com/spiral/goridge/issues/128) +- ๐ Fix: Bug, incorrect request `origin` check [Bug](https://github.com/spiral/roadrunner/issues/727) ## ๐ฆ Packages: -- ๐ฆ Update goridge to `v3.1.4` -- ๐ฆ Update temporal to `v1.0.8` +- ๐ฆ Update goridge to `v3.1.4` +- ๐ฆ Update temporal to `v1.0.8` ## ๐ Summary: -- RR Milestone [2.3.1](https://github.com/spiral/roadrunner/milestone/30?closed=1) -- Temporal Milestone [1.0.8](https://github.com/temporalio/roadrunner-temporal/milestone/11?closed=1) -- Goridge Milestone [3.1.4](https://github.com/spiral/goridge/milestone/11?closed=1) +- RR Milestone [2.3.1](https://github.com/spiral/roadrunner/milestone/30?closed=1) +- Temporal Milestone [1.0.8](https://github.com/temporalio/roadrunner-temporal/milestone/11?closed=1) +- Goridge Milestone [3.1.4](https://github.com/spiral/goridge/milestone/11?closed=1) --- @@ -388,36 +835,36 @@ jobs: ## ๐ New: -- โ๏ธ Brand new `broadcast` plugin now has the name - `websockets` with broadcast capabilities. It can handle hundreds of - thousands websocket connections very efficiently (~300k messages per second with 1k connected clients, in-memory bus - on 2CPU cores and 1GB of RAM) [Issue](https://github.com/spiral/roadrunner/issues/513) -- โ๏ธ Protobuf binary messages for the `websockets` and `kv` RPC calls under the - hood. [Issue](https://github.com/spiral/roadrunner/issues/711) -- โ๏ธ Json-schemas for the config file v1.0 (it also registered - in [schemastore.org](https://github.com/SchemaStore/schemastore/pull/1614)) -- โ๏ธ `latest` docker image tag supported now (but we strongly recommend using a versioned tag (like `0.2.3`) instead) -- โ๏ธ Add new option to the `http` config section: `internal_error_code` to override default (500) internal error - code. [Issue](https://github.com/spiral/roadrunner/issues/659) -- โ๏ธ Expose HTTP plugin metrics (workers memory, requests count, requests duration) - . [Issue](https://github.com/spiral/roadrunner/issues/489) -- โ๏ธ Scan `server.command` and find errors related to the wrong path to a `PHP` file, or `.ph`, `.sh` - scripts. [Issue](https://github.com/spiral/roadrunner/issues/658) -- โ๏ธ Support file logger with log rotation [Wiki](https://en.wikipedia.org/wiki/Log_rotation) - , [Issue](https://github.com/spiral/roadrunner/issues/545) +- โ๏ธ Brand new `broadcast` plugin now has the name - `websockets` with broadcast capabilities. It can handle hundreds of + thousands websocket connections very efficiently (~300k messages per second with 1k connected clients, in-memory bus + on 2CPU cores and 1GB of RAM) [Issue](https://github.com/spiral/roadrunner/issues/513) +- โ๏ธ Protobuf binary messages for the `websockets` and `kv` RPC calls under the + hood. [Issue](https://github.com/spiral/roadrunner/issues/711) +- โ๏ธ Json-schemas for the config file v1.0 (it also registered + in [schemastore.org](https://github.com/SchemaStore/schemastore/pull/1614)) +- โ๏ธ `latest` docker image tag supported now (but we strongly recommend using a versioned tag (like `0.2.3`) instead) +- โ๏ธ Add new option to the `http` config section: `internal_error_code` to override default (500) internal error + code. [Issue](https://github.com/spiral/roadrunner/issues/659) +- โ๏ธ Expose HTTP plugin metrics (workers memory, requests count, requests duration) + . [Issue](https://github.com/spiral/roadrunner/issues/489) +- โ๏ธ Scan `server.command` and find errors related to the wrong path to a `PHP` file, or `.ph`, `.sh` + scripts. [Issue](https://github.com/spiral/roadrunner/issues/658) +- โ๏ธ Support file logger with log rotation [Wiki](https://en.wikipedia.org/wiki/Log_rotation) + , [Issue](https://github.com/spiral/roadrunner/issues/545) ## ๐ฉน Fixes: -- ๐ Fix: Bug with `informer.Workers` worked incorrectly: [Bug](https://github.com/spiral/roadrunner/issues/686) -- ๐ Fix: Internal error messages will not be shown to the user (except HTTP status code). Error message will be in - logs: [Bug](https://github.com/spiral/roadrunner/issues/659) -- ๐ Fix: Error message will be properly shown in the log in case of `SoftJob` - error: [Bug](https://github.com/spiral/roadrunner/issues/691) -- ๐ Fix: Wrong applied middlewares for the `fcgi` server leads to the - NPE: [Bug](https://github.com/spiral/roadrunner/issues/701) +- ๐ Fix: Bug with `informer.Workers` worked incorrectly: [Bug](https://github.com/spiral/roadrunner/issues/686) +- ๐ Fix: Internal error messages will not be shown to the user (except HTTP status code). Error message will be in + logs: [Bug](https://github.com/spiral/roadrunner/issues/659) +- ๐ Fix: Error message will be properly shown in the log in case of `SoftJob` + error: [Bug](https://github.com/spiral/roadrunner/issues/691) +- ๐ Fix: Wrong applied middlewares for the `fcgi` server leads to the + NPE: [Bug](https://github.com/spiral/roadrunner/issues/701) ## ๐ฆ Packages: -- ๐ฆ Update goridge to `v3.1.0` +- ๐ฆ Update goridge to `v3.1.0` --- @@ -425,9 +872,9 @@ jobs: ## ๐ฉน Fixes: -- ๐ Fix: revert static plugin. It stays as a separate plugin on the main route (`/`) and supports all the previously - announced features. -- ๐ Fix: remove `build` and other old targets from the Makefile. +- ๐ Fix: revert static plugin. It stays as a separate plugin on the main route (`/`) and supports all the previously + announced features. +- ๐ Fix: remove `build` and other old targets from the Makefile. --- @@ -435,21 +882,21 @@ jobs: ## ๐ New: -- โ๏ธ Reworked `static` plugin. Now, it does not affect the performance of the main route and persist on the separate - file server (within the `http` plugin). Looong awaited feature: `Etag` (+ weak Etags) as well with the `If-Mach` - , `If-None-Match`, `If-Range`, `Last-Modified` - and `If-Modified-Since` tags supported. Static plugin has a bunch of new options such as: `allow`, `calculate_etag` - , `weak` and `pattern`. +- โ๏ธ Reworked `static` plugin. Now, it does not affect the performance of the main route and persist on the separate + file server (within the `http` plugin). Looong awaited feature: `Etag` (+ weak Etags) as well with the `If-Mach` + , `If-None-Match`, `If-Range`, `Last-Modified` + and `If-Modified-Since` tags supported. Static plugin has a bunch of new options such as: `allow`, `calculate_etag` + , `weak` and `pattern`. - ### Option `always` was deleted from the plugin. + ### Option `always` was deleted from the plugin. -- โ๏ธ Update `informer.List` implementation. Now it returns a list with the all available plugins in the runtime. +- โ๏ธ Update `informer.List` implementation. Now it returns a list with the all available plugins in the runtime. ## ๐ฉน Fixes: -- ๐ Fix: issue with wrong ordered middlewares (reverse). Now the order is correct. -- ๐ Fix: issue when RR fails if a user sets `debug` mode with the `exec_ttl` supervisor option. -- ๐ Fix: uniform log levels. Use everywhere the same levels (warn, error, debug, info, panic). +- ๐ Fix: issue with wrong ordered middlewares (reverse). Now the order is correct. +- ๐ Fix: issue when RR fails if a user sets `debug` mode with the `exec_ttl` supervisor option. +- ๐ Fix: uniform log levels. Use everywhere the same levels (warn, error, debug, info, panic). --- @@ -457,102 +904,102 @@ jobs: ## ๐ฉน Fixes: -- ๐ Fix: issue with endure provided wrong logger interface implementation. +- ๐ Fix: issue with endure provided wrong logger interface implementation. ## v2.1.0 (27.04.2021) ## ๐ New: -- โ๏ธ New `service` plugin. Docs: [link](https://roadrunner.dev/docs/beep-beep-service) -- โ๏ธ Stabilize `kv` plugin with `boltdb`, `in-memory`, `memcached` and `redis` drivers. +- โ๏ธ New `service` plugin. Docs: [link](https://roadrunner.dev/docs/beep-beep-service) +- โ๏ธ Stabilize `kv` plugin with `boltdb`, `in-memory`, `memcached` and `redis` drivers. ## ๐ฉน Fixes: -- ๐ Fix: Logger didn't provide an anonymous log instance to a plugins w/o `Named` interface implemented. -- ๐ Fix: http handler was without log listener after `rr reset`. +- ๐ Fix: Logger didn't provide an anonymous log instance to a plugins w/o `Named` interface implemented. +- ๐ Fix: http handler was without log listener after `rr reset`. ## v2.0.4 (06.04.2021) ## ๐ New: -- โ๏ธ Add support for `linux/arm64` platform for docker image (thanks @tarampampam). -- โ๏ธ Add dotenv file support (`.env` in working directory by default; file location can be changed using CLI - flag `--dotenv` or `DOTENV_PATH` environment variable) (thanks @tarampampam). -- ๐ Add a new `raw` mode for the `logger` plugin to keep the stderr log message of the worker unmodified (logger - severity level should be at least `INFO`). -- ๐ Add Readiness probe check. The `status` plugin provides `/ready` endpoint which return the `204` HTTP code if there - are no workers in the `Ready` state and `200 OK` status if there are at least 1 worker in the `Ready` state. +- โ๏ธ Add support for `linux/arm64` platform for docker image (thanks @tarampampam). +- โ๏ธ Add dotenv file support (`.env` in working directory by default; file location can be changed using CLI + flag `--dotenv` or `DOTENV_PATH` environment variable) (thanks @tarampampam). +- ๐ Add a new `raw` mode for the `logger` plugin to keep the stderr log message of the worker unmodified (logger + severity level should be at least `INFO`). +- ๐ Add Readiness probe check. The `status` plugin provides `/ready` endpoint which return the `204` HTTP code if there + are no workers in the `Ready` state and `200 OK` status if there are at least 1 worker in the `Ready` state. ## ๐ฉน Fixes: -- ๐ Fix: bug with the temporal worker which does not follow general graceful shutdown period. +- ๐ Fix: bug with the temporal worker which does not follow general graceful shutdown period. ## v2.0.3 (29.03.2021) ## ๐ฉน Fixes: -- ๐ Fix: slow last response when reached `max_jobs` limit. +- ๐ Fix: slow last response when reached `max_jobs` limit. ## v2.0.2 (06.04.2021) -- ๐ Fix: Bug with required Root CA certificate for the SSL, now it's optional. -- ๐ Fix: Bug with incorrectly consuming metrics collector from the RPC calls (thanks @dstrop). -- ๐ New: HTTP/FCGI/HTTPS internal logs instead of going to the raw stdout will be displayed in the RR logger at - the `Info` log level. -- โก New: Builds for the Mac with the M1 processor (arm64). -- ๐ท Rework ServeHTTP handler logic. Use http.Error instead of writing code directly to the response writer. Other small - improvements. +- ๐ Fix: Bug with required Root CA certificate for the SSL, now it's optional. +- ๐ Fix: Bug with incorrectly consuming metrics collector from the RPC calls (thanks @dstrop). +- ๐ New: HTTP/FCGI/HTTPS internal logs instead of going to the raw stdout will be displayed in the RR logger at + the `Info` log level. +- โก New: Builds for the Mac with the M1 processor (arm64). +- ๐ท Rework ServeHTTP handler logic. Use http.Error instead of writing code directly to the response writer. Other small + improvements. ## v2.0.1 (09.03.2021) -- ๐ Fix: incorrect PHP command validation -- ๐ Fix: ldflags properly inject RR version -- โฌ๏ธ Update: README, links to the go.pkg from v1 to v2 -- ๐ฆ Bump golang version in the Dockerfile and in the `go.mod` to 1.16 -- ๐ฆ Bump Endure container to v1.0.0. +- ๐ Fix: incorrect PHP command validation +- ๐ Fix: ldflags properly inject RR version +- โฌ๏ธ Update: README, links to the go.pkg from v1 to v2 +- ๐ฆ Bump golang version in the Dockerfile and in the `go.mod` to 1.16 +- ๐ฆ Bump Endure container to v1.0.0. ## v2.0.0 (02.03.2021) -- โ๏ธ Add a shared server to create PHP worker pools instead of isolated worker pool in each individual plugin. -- ๐ New plugin system with auto-recovery, easier plugin API. -- ๐ New `logger` plugin to configure logging for each plugin individually. -- ๐ Up to 50% performance increase in HTTP workloads. -- โ๏ธ Add **[Temporal Workflow](https://temporal.io)** plugin to run distributed computations on scale. -- โ๏ธ Add `debug` flag to reload PHP worker ahead of a request (emulates PHP-FPM behavior). -- โ Eliminate `limit` service, now each worker pool includes `supervisor` configuration. -- ๐ New resetter, informer plugins to perform hot reloads and observe loggers in a system. -- ๐ซ Expose more HTTP plugin configuration options. -- ๐ Headers, static and gzip services now located in HTTP config. -- ๐ Ability to configure the middleware sequence. -- ๐ฃ Faster Goridge protocol (eliminated 50% of syscalls). -- ๐พ Add support for binary payloads for RPC (`msgpack`). -- ๐ Server no longer stops when a PHP worker dies (attempts to restart). -- ๐พ New RR binary server downloader. -- ๐ฃ Echoing no longer breaks execution (yay!). -- ๐ Migration to ZapLogger instead of Logrus. -- ๐ฅ RR can no longer stuck when studding down with broken tasks in a pipeline. -- ๐งช More tests, more static analysis. -- ๐ฅ Create a new foundation for new KV, WebSocket, GRPC and Queue plugins. +- โ๏ธ Add a shared server to create PHP worker pools instead of isolated worker pool in each individual plugin. +- ๐ New plugin system with auto-recovery, easier plugin API. +- ๐ New `logger` plugin to configure logging for each plugin individually. +- ๐ Up to 50% performance increase in HTTP workloads. +- โ๏ธ Add **[Temporal Workflow](https://temporal.io)** plugin to run distributed computations on scale. +- โ๏ธ Add `debug` flag to reload PHP worker ahead of a request (emulates PHP-FPM behavior). +- โ Eliminate `limit` service, now each worker pool includes `supervisor` configuration. +- ๐ New resetter, informer plugins to perform hot reloads and observe loggers in a system. +- ๐ซ Expose more HTTP plugin configuration options. +- ๐ Headers, static and gzip services now located in HTTP config. +- ๐ Ability to configure the middleware sequence. +- ๐ฃ Faster Goridge protocol (eliminated 50% of syscalls). +- ๐พ Add support for binary payloads for RPC (`msgpack`). +- ๐ Server no longer stops when a PHP worker dies (attempts to restart). +- ๐พ New RR binary server downloader. +- ๐ฃ Echoing no longer breaks execution (yay!). +- ๐ Migration to ZapLogger instead of Logrus. +- ๐ฅ RR can no longer stuck when studding down with broken tasks in a pipeline. +- ๐งช More tests, more static analysis. +- ๐ฅ Create a new foundation for new KV, WebSocket, GRPC and Queue plugins. ## v2.0.0-RC.4 (20.02.2021) -- PHP tests use latest signatures (https://github.com/spiral/roadrunner/pull/550). -- Endure container update to v1.0.0-RC.2 version. -- Remove unneeded mutex from the `http.Workers` method. -- Rename `checker` plugin package to `status`, remove `/v1` endpoint prefix (#557). -- Add static, headers, status, gzip plugins to the `main.go`. -- Fix workers pool behavior -> idle_ttl, ttl, max_memory are soft errors and exec_ttl is hard error. +- PHP tests use latest signatures (https://github.com/spiral/roadrunner/pull/550). +- Endure container update to v1.0.0-RC.2 version. +- Remove unneeded mutex from the `http.Workers` method. +- Rename `checker` plugin package to `status`, remove `/v1` endpoint prefix (#557). +- Add static, headers, status, gzip plugins to the `main.go`. +- Fix workers pool behavior -> idle_ttl, ttl, max_memory are soft errors and exec_ttl is hard error. ## v2.0.0-RC.3 (17.02.2021) -- Add support for the overwriting `.rr.yaml` keys with values (ref: https://roadrunner.dev/docs/intro-config) -- Make logger plugin optional to define in the config. Default values: level -> `debug`, mode -> `development` -- Add the ability to read env variables from the `.rr.yaml` in the form of: `rpc.listen: {RPC_ADDR}`. Reference: - ref: https://roadrunner.dev/docs/intro-config (Environment Variables paragraph) +- Add support for the overwriting `.rr.yaml` keys with values (ref: https://roadrunner.dev/docs/intro-config) +- Make logger plugin optional to define in the config. Default values: level -> `debug`, mode -> `development` +- Add the ability to read env variables from the `.rr.yaml` in the form of: `rpc.listen: {RPC_ADDR}`. Reference: + ref: https://roadrunner.dev/docs/intro-config (Environment Variables paragraph) ## v2.0.0-RC.2 (11.02.2021) -- Update RR to version v2.0.0-RC.2 -- Update Temporal plugin to version v2.0.0-RC.1 -- Update Goridge to version v3.0.1 -- Update Endure to version v1.0.0-RC.1 +- Update RR to version v2.0.0-RC.2 +- Update Temporal plugin to version v2.0.0-RC.1 +- Update Goridge to version v3.0.1 +- Update Endure to version v1.0.0-RC.1 |