1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
|
# CHANGELOG
# <center> π v2023.3.12 π </center>
### `Centrifuge` plugin:
- π₯ Add support for the `NotifyChannelState` centrifuge API.
### `Temporal` plugin:
- π₯ Add support for the [Updates API](https://docs.temporal.io/dev-guide/go/features#updates).
- π₯ Add support for the healthchecks: [FR](https://github.com/roadrunner-server/roadrunner/issues/1872), (thanks @shanginn).
### <center>π§Ή Chore:</center>
- π§βπ: All `since` log entries are now always shown as milliseconds, [FR](https://github.com/roadrunner-server/roadrunner/issues/1858), (thanks @dmitryuk).
---
# <center> π v2023.3.11 π </center>
### `Centrifuge` plugin:
- ποΈ Check the connection propertly before attempting to send a request: [PR](https://github.com/roadrunner-server/centrifuge/pull/78)
### `OTEL` plugin:
- ποΈ Do not force to set `endpoint` and `headers`: [BUG](https://github.com/roadrunner-server/roadrunner/issues/1848). Update docs on OTEL env usage: [Docs](https://docs.roadrunner.dev/logging-and-observability/otel), (thanks @fasdalf and @arku31).
### <center>π§Ή Chore:</center>
- π§βπ **Dependencies**: Build with Go 1.22.0.
---
# <center> π v2023.3.10 π </center>
### Core `SDK` bugfixes:
- ποΈ Request queue gets too large, [BUG/FR](https://github.com/roadrunner-server/roadrunner/issues/1841), [Docs](https://docs.roadrunner.dev/php-worker/pool) (thanks, @L3tum)
- ποΈ Huge memory allocation in the debug mode [FIX](https://github.com/roadrunner-server/sdk/pull/110).
- ποΈ Stop handler (`worker->stop()`) was returned (breaking change fix) [FIX](https://github.com/roadrunner-server/sdk/pull/109), (thanks @Zylius)
### <center>π§Ή Chore:</center>
- π§βπ **Dependencies**: update project/system dependencies.
---
# <center> π v2023.3.9 π </center>
### `HTTP` plugin
- ποΈ Streaming responses can experience a lock-up when the client disconnects early, [BUG](https://github.com/roadrunner-server/roadrunner/issues/1830), (thanks @segrax)
### `SQS` JOBS driver
- ποΈ Use user specified credentials if they are set even if we're inside AWS, [BUG](https://github.com/roadrunner-server/roadrunner/issues/1833), (thanks @matteokov)
### `Service` plugin
- ποΈ Services directly killed when restarting on terminating. [BUG](https://github.com/roadrunner-server/roadrunner/issues/1814), (thanks @chazzbg)
### `Server` plugin
- π₯ Add `user` param to `on_init` command section. [PR](https://github.com/roadrunner-server/server/pull/68), [docs](https://roadrunner.dev/docs/plugins-server/current/en#configuration), (thanks @Kaspiman)
### `Redis` KV driver
- ποΈ Correctly finish the OTEL span. [PR](https://github.com/roadrunner-server/redis/pull/62), (thanks @Kaspiman)
### <center>π§Ή Chore:</center>
- π§βπ **Dependencies**: update project/system dependencies.
- π§βπ **Docs**: update docs, [BUG](https://github.com/roadrunner-server/roadrunner/issues/1819).
---
# <center> π v2023.3.8 π </center>
### `HTTP` plugin
- π₯ Experimental HTTP3 server, [FR](https://github.com/roadrunner-server/roadrunner/issues/926), docs: [link](https://roadrunner.dev/docs/experimental-experimental/current/en#support-for-the-http3-server-202338), (thanks @cv65kr & @cidious)
### `gRPC` plugin
- π₯ Experimental support for the OTLP protocol inside the `gRPC` plugin: [FR](https://roadrunner.dev/docs/experimental-experimental/current/en#otlp-support-in-the-grpc-plugin-202338), (thanks @rauanmayemir)
### `Beanstalk` driver
- ποΈ Fix NPE on empty options [BUG](https://github.com/roadrunner-server/roadrunner/issues/1804), (thanks @SerhiiMova).
### `Velox` plugin
- π₯ To ensure that Velox is able to build every RoadRunner version, we've added a new CI CRON job that builds RoadRunner with Velox daily. This job is not related to the RoadRunner release process, but it will help us to ensure that Velox is always compatible with the latest RoadRunner version.
### <center>π§Ή Chore:</center>
- π§βπ **Dependencies**: update project/system dependencies.
---
# <center> π v2023.3.7 π </center>
### `gRPC` plugin:
- π₯ Re-enable HTTP health and readiness checks via regular endpoints `/health` and `/ready`.
### `AMQP` driver:
- ποΈ Fix mapping for the RabbitMQ type `List` (Golang `[]any`), [BUG](https://github.com/roadrunner-server/roadrunner/issues/1793), (thanks @iborysenko).
- ποΈ Fix an edge case for the DLX queue type when user doesn't specify any queue, but use `Push` method with delays, [BUG](https://github.com/roadrunner-server/roadrunner/issues/1792), (thanks @fereron).
### <center>π§Ή Chore:</center>
- π§βπ **Dependencies**: update project/system dependencies.
---
# <center> π v2023.3.6 π </center>
### CI releases:
- π₯ Add support for the `arm64` deb packages: [FR](https://github.com/roadrunner-server/roadrunner/issues/1785), (thanks @stevenbrookes)
### <center>π§Ή Chore:</center>
- π§βπ **Dependencies**: update project/system dependencies.
---
# <center> π v2023.3.5 π </center>
### Config plugin:
- π₯ Add ability to include `.env` files in the configuration (experimental feature): [Docs](https://roadrunner.dev/docs/experimental-experimental/current/en#support-for-loading-envfiles-in-the-rryaml--v202335), (thanks @OO00O0O).
### Temporal plugin:
- ποΈ Fix bug with incorrect pool destroy order: [BUG](https://github.com/roadrunner-server/roadrunner/issues/1776), (thanks @pfy-oleksii-storozhylov).
### HTTP plugin:
- π₯ Allow showing PHP exception traces in the response: [BUG](https://github.com/roadrunner-server/roadrunner/issues/1781), (thanks @speller).
### <center>π§Ή Chore:</center>
- π§βπ **Dependencies**: update project (system) dependencies.
---
# <center> π v2023.3.4 π </center>
## π₯ Features:
### RR Core:
- βοΈ **Experimental features:** Add support for the experimental features: [Docs](https://roadrunner.dev/docs/experimental-experimental/current/en).
## π Plugins:
- βοΈ **NATS driver:** Replace the old JetStream client with the new one: [FR](https://github.com/roadrunner-server/roadrunner/issues/1574), [API](https://github.com/nats-io/nats.go/blob/main/jetstream/README.md).
- βοΈ **Config driver:** Add experimental support for merging two and more configuration files: [FR](https://github.com/roadrunner-server/roadrunner/issues/935), [Docs](https://roadrunner.dev/docs/experimental-experimental/current/en), (thanks @hugochinchilla)
- βοΈ **Headers middleware:** Add support for the regular expressions for `origin`: [FR](https://github.com/roadrunner-server/roadrunner/issues/1709), [Docs](https://roadrunner.dev/docs/http-headers/current/en#cors), (thanks @orlandothoeny)
## π©Ή Fixes
- π **HTTP Plugin**: Unable to POST relatively chunky POST: [BUG](https://github.com/roadrunner-server/roadrunner/issues/1765), (thanks @FluffyDiscord)
---
# <center> π v2023.3.3 [Bugfix] π </center>
## π©Ή Fixes
- π **RR Core**: Fix removed by mistake RPC endpoint: [ISSUE](https://github.com/roadrunner-server/roadrunner/issues/1758), (thanks @Kaspiman)
---
# <center> π v2023.3.2 [Maintenance] π </center>
## π©Ή Fixes
- π **Temporal**: Fix incorrect log entry: [ISSUE](https://github.com/roadrunner-server/roadrunner/issues/1752), (thanks @roxblnfk)
---
### <center>π§Ή Chore:</center>
- π§βπ **Dependencies**: update project dependencies (including CVE in transitive dependencies, especially gofiber).
---
# <center> π v2023.3.1 [Maintenance] π </center>
### <center>π§Ή Chore:</center>
- π§βπ **Dependencies**: update project dependencies (including CVE in Go libraries).
- π§βπ **Go**: Update Golang to version 1.21.3.
---
# <center> π v2023.3.0 π </center>
## π₯ Features:
### RR Core:
- βοΈ `sdnotify` support: [FR](https://github.com/roadrunner-server/roadrunner/pull/1671), (thanks @Kaspiman), Docs: [link](https://roadrunner.dev/docs/app-server-systemd/current/en)
## π JOBS plugin:
- βοΈ **AMQP Driver:** Support for a custom `routing_key` in the JOBS payload: [FR](https://github.com/roadrunner-server/roadrunner/issues/1555), (thanks @rauanmayemir)
- βοΈ **JOBS plugin**: Parallel pipelines start/stop/destroy initialization. If you have much number of the pipelines,
this feature should significantly reduce RR startup/shutdown time: [FR](https://github.com/roadrunner-server/roadrunner/issues/1672), (thanks @Kaspiman)
## π KV drivers (all):
- βοΈ Support for OTEL across all KV drivers: [FR](https://github.com/roadrunner-server/roadrunner/issues/1635)
## π App-Logger plugin:
- βοΈ Added new methods for your logger to log with context (message + key-values array): [FR](https://github.com/roadrunner-server/roadrunner/issues/1633), (thanks @Baiquette)
## π Temporal plugin:
- βοΈ Replay API support [SINCE PHP-SDK 2.6.0]: [FR](https://github.com/roadrunner-server/roadrunner/issues/1640)
- βοΈ Add support for the Worker Versioning: [FR](https://github.com/roadrunner-server/roadrunner/issues/1689)
## π Service plugin:
- βοΈ Support for the user/group per-service: [FR](https://github.com/roadrunner-server/roadrunner/issues/1570), (thanks @Kaspiman)
#### Configuration example:
```yaml
service:
schedule:run:
command: "bin/console schedule:run"
process_num: 1
exec_timeout: 0s
remain_after_exit: true
service_name_in_log: false
restart_sec: 60
user: www-data # <---------- [NEW]
group: www-data # <---------- [NEW]
```
## π HTTP plugin:
- βοΈ Response streaming support [FR](https://github.com/roadrunner-server/http/pull/152), (thanks @roxblnfk)
Worker example:
```php
<?php
require __DIR__ . '/vendor/autoload.php';
use Spiral\RoadRunner;
ini_set('display_errors', 'stderr');
require __DIR__ . "/vendor/autoload.php";
$worker = RoadRunner\Worker::create();
$http = new RoadRunner\Http\HttpWorker($worker);
$read = static function (): Generator {
foreach (\file(__DIR__ . '/test.txt') as $line) {
try {
yield $line;
} catch (Spiral\RoadRunner\Http\Exception\StreamStoppedException) {
// Just stop sending data
return;
}
}
};
try {
while ($req = $http->waitRequest()) {
$http->respond(200, $read());
}
} catch (\Throwable $e) {
$worker->error($e->getMessage());
}
```
- βοΈ Support for the `103` Early Hints via streamed response: [FR](https://github.com/roadrunner-server/roadrunner/issues/918), (thanks @azjezz)
Worker example:
```php
<?php
use Spiral\RoadRunner;
ini_set('display_errors', 'stderr');
require __DIR__ . "/vendor/autoload.php";
$worker = RoadRunner\Worker::create();
$http = new RoadRunner\Http\HttpWorker($worker);
$read = static function (): Generator {
$limit = 10;
foreach (\file(__DIR__ . '/test.txt') as $line) {
foreach (explode('"', $line) as $chunk) {
try {
usleep(50_000);
yield $chunk;
} catch (Spiral\RoadRunner\Http\Exception\StreamStoppedException $e) {
// Just stop sending data
return;
}
if (--$limit === 0) {
return;
}
}
}
};
try {
while ($req = $http->waitRequest()) {
$http->respond(103, '', headers: ['Link' => ['</style111.css>; rel=preload; as=style'], 'X-103' => ['103']], endOfStream: false);
$http->respond(200, $read(), headers: ['X-200' => ['200']], endOfStream: true); // your regular response
}
} catch (\Throwable $e) {
$worker->error($e->getMessage());
}
```
## π Server plugin:
- βοΈ **RAW command support**: Support for raw commands, which are not validated by RR and may contain spaces. Note that this feature is only supported via `.rr.yaml` configuration: [FR](https://github.com/roadrunner-server/roadrunner/issues/1667), (thanks @nunomaduro)
First argument should be a command (executable) and the rest of the arguments are passed to the command as arguments.
```yaml
version: "3"
server:
command: ["php", "../../php_test_files/client.php echo pipes"]
relay: "pipes"
relay_timeout: "20s"
```
2.
```yaml
version: "3"
server:
command:
- "php"
- "../../php_test_files/client.php echo pipes"
relay: "pipes"
relay_timeout: "20s"
```
## π©Ή Fixes:
- π **RR Core**: Actualize according to the docs `./rr jobs list/stop/resume` commands: [PR](https://github.com/roadrunner-server/roadrunner/pull/1675), (thanks @gam6itko).
- π **JOBS plugin**: Correctly handle OTEL span on listener error: [PR](https://github.com/roadrunner-server/amqp/pull/87), (thanks @Kaspiman).
- π **RR tests**: Fix tests failures on Darwin: [PR](https://github.com/roadrunner-server/roadrunner/pull/1680), (thanks @shyim).
- π **Streaming**: Add stream timeout (will be configurable in the next release). Fix loss of the first chunk of the streamed response.
### <center>π§Ή Chore:</center>
- π§βπ **Golang**: Update Golang version to v1.21.
- π§βπ **Dependencies**: update project dependencies.
---
# <center> π v2023.2.2 π </center>
## π©Ή Fixes
- π **JOBS plugin**: Fix typo in the `RPC` span name: [PR](https://github.com/roadrunner-server/jobs/pull/92), (thanks @Kaspiman).
- π **SDK**: Fix incorrect workers state when worker reached `idleTTL` state: [BUG](https://github.com/roadrunner-server/roadrunner/issues/1669), (thanks @Aleksa1996).
### <center>π§Ή Chore:</center>
- π§βπ **HTTP plugin**: faster PostForm/MultipartForm processing [PR](https://github.com/roadrunner-server/http/pull/145).
- π§βπ **Golang**: Update Golang version to v1.21.
- π§βπ **Dependencies**: update project dependencies.
---
# <center> π v2023.2.1 π </center>
## π©Ή Fixes
- π **NATS driver**: Segfault when sending job via third-party sender without `consume_all` option set to `true`: [BUG](https://github.com/roadrunner-server/roadrunner/issues/1650), (thanks @KernelMrex).
- π **Metrics plugin**: Irregular panic when declaring metrics via `on_init` option: [BUG](https://github.com/roadrunner-server/roadrunner/issues/1648), (thanks @Kaspiman).
- π **Headers middleware**: Inconsistent usage of CORS options, failed to apply `allowed_*` options with spaces: [BUG](https://github.com/roadrunner-server/roadrunner/issues/1655), (thanks @gam6itko).
### <center>π§Ή Chore:</center>
- π§βπ **Dependencies**: update project dependencies.
---
# <center> π v2023.2.0 π </center>
## π New
- βοΈ **Kafka driver**: Support for the `SCRAM-SHA-256` and `SCRAM-SHA-512` SASL mechanisms: [FR](https://github.com/roadrunner-server/roadrunner/issues/1601), (thanks @Azomas)
- βοΈ **Headers middleware**: Actualize CORS support: [FR](https://github.com/roadrunner-server/roadrunner/issues/909), (thanks @rmikalkenas, @hustlahusky)
- βοΈ **RoadRunner CLI**: Additional [semgrep](https://semgrep.dev/) security scanner.
- βοΈ **Docker builds**: New tags: `v2023`, `v2023.x` and with bugfix: `v2023.x.x`. The `latest` tag points to the latest **stable** release. All `rc`, `beta`, `alpha` releases will no longer be tagged with `latest`.
- βοΈ **AMQP driver**: Support for the `TLS` transport named `amqps`: [FR](https://github.com/roadrunner-server/roadrunner/issues/1538), (thanks @marcosraudkett)
- βοΈ **JOBS plugin**: Support for the workers health/readiness checks. [PR](https://github.com/roadrunner-server/jobs/pull/81), (thanks @Kaspiman)
- βοΈ **JOBS plugin**: Delete all messages that were in the priority queue when the pipeline was deleted (1-st part of the BUG), [BUG](https://github.com/roadrunner-server/roadrunner/issues/1382)
- βοΈ **JOBS plugin**: JOBS plugin now support reporting it's workers status with a simple query: `http://<status_plugin_host>:<port>/ready(health)?plugin=jobs`, [PR](https://github.com/roadrunner-server/roadrunner/issues/1382), (thanks @Kaspiman)
- βοΈ **Temporal plugin, internal**: Pass `history_len` to the PHP worker and get the PHP-SDK version to pass to the Temporal server.
- βοΈ **Lock plugin**: Completely rewritten. Now supports microseconds interval. Any `ttl/wait_ttl` value passed to RR is now treated as **microseconds**. There is no configuration for this plugin, it is bundled with RR.
- βοΈ **Service plugin**: Add a new option for the graceful process timeout: `timeout_stop_sec`. RR will wait for the specified amount of time (but not more than `endure.graceful_period`) for the process to stop, [FR](https://github.com/roadrunner-server/roadrunner/issues/1628), (thanks @asanikovich)
## π©Ή Fixes
- π **JOBS plugin**: Nil pointer exception on very fast (after RR was started, but JOBS worker failed to start) check for the JOBS metrics: [BUG](https://github.com/roadrunner-server/roadrunner/issues/1597), (thanks @Kaspiman).
- π **Service plugin**: Incorrect parsing and assignment of the `process_num` value passed via RPC: [BUG](https://github.com/roadrunner-server/roadrunner/issues/1621), (thanks @asanikovich)
### <center>π§Ή Chore:</center>
- π§βπ **Dependencies**: update project dependencies.
# <center> π v2023.2.0-beta.1 π </center>
## π New
- βοΈ **Kafka driver**: Support for the `SCRAM-SHA-256` and `SCRAM-SHA-512` SASL mechanisms: [FR](https://github.com/roadrunner-server/roadrunner/issues/1601), (thanks @Azomas)
- βοΈ **Headers middleware**: Actualize CORS support: [FR](https://github.com/roadrunner-server/roadrunner/issues/909), (thanks @rmikalkenas, @hustlahusky)
- βοΈ **RoadRunner CLI**: Additional [semgrep](https://semgrep.dev/) security scanner.
- βοΈ **Docker builds**: New tags: `v2023`, `v2023.x` and with bugfix: `v2023.x.x`. The `latest` tag points to the latest **stable** release. All `rc`, `beta`, `alpha` releases will no longer be tagged with `latest`.
- βοΈ **AMQP driver**: Support for the `TLS` transport named `amqps`: [FR](https://github.com/roadrunner-server/roadrunner/issues/1538), (thanks @marcosraudkett)
- βοΈ **JOBS plugin**: Support for the workers health/readiness checks. [PR](https://github.com/roadrunner-server/jobs/pull/81), (thanks @Kaspiman)
- βοΈ **JOBS plugin**: Delete all messages that were in the priority queue when the pipeline was deleted (1-st part of the BUG), [BUG](https://github.com/roadrunner-server/roadrunner/issues/1382)
### <center>π§Ή Chore:</center>
- π§βπ **Dependencies**: update project dependencies.
---
# <center> π v2023.1.5 π </center>
## π©Ή Fixes
- π **KV plugin**: Correct plugin startup order: [PR](https://github.com/roadrunner-server/roadrunner/issues/1589), (thanks @ekisu)
- π **JOBS plugin**: Check the pool pointer: [BUG](https://github.com/roadrunner-server/roadrunner/issues/1597), (thanks @Kaspiman)
- π **Send Middleware**: Fix bug in http.ResponseWriter wrapper: [BUG](https://github.com/roadrunner-server/roadrunner/issues/1593), (thanks @tux-rampage)
- π **XFF Middleware**: Split XFF content without space: [BUG](https://github.com/roadrunner-server/proxy_ip_parser/pull/35), (thanks @eightfourseventwo)
## π New
- βοΈ **Docker** Add tags with minor version (e.g.: `v2023.1`, `v2023.2`, etc.): [FR](https://github.com/roadrunner-server/roadrunner/issues/1581), (thanks @Kaspiman)
### <center>π§Ή Chore:</center>
- π§βπ **Dependencies**: update project dependencies.
---
# <center> π v2023.1.4 π </center>
## π©Ή Fixes
- π **gRPC plugin**: allow specifying wildcards in the `proto` field: [PR](https://github.com/roadrunner-server/grpc/pull/90), (thanks @MaxSem)
- π **SDK (internal)**: Workers are killed during processing when memory usage is exeeded: [BUG](https://github.com/roadrunner-server/roadrunner/issues/1561), (thanks @ekisu)
- π **JOBS plugin**: Jobs plugin hangd on many workers and pollers: [BUG](https://github.com/roadrunner-server/roadrunner/issues/1568), (thanks @embargo2710)
- π **JOBS plugin**: Safe shutdown occurs before the specified time: [BUG](https://github.com/roadrunner-server/roadrunner/issues/1567), (thanks @embargo2710)
- π **AMQP plugin**: Typo in the property name (`multiple_ack`): [BUG](https://github.com/roadrunner-server/roadrunner/issues/1565), (thanks @embargo2710)
### <center>π§Ή Chore:</center>
- π§βπ **Dependencies**: update project dependencies.
---
# <center> π v2023.1.3 π </center>
## π©Ή Fixes
- π **AMQP plugin**: Driver crash when not using OTEL metrics: [BUG](https://github.com/roadrunner-server/roadrunner/issues/1553), (thanks @rauanmayemir)
- π **JOBS plugin**: Incorrect parsing of JSON configuraion values: [BUG](https://github.com/roadrunner-server/roadrunner/issues/1557), (thanks @embargo2710)
### <center>π§Ή Chore:</center>
- π§βπ **Dependencies**: update project dependencies.
---
# <center> π v2023.1.2 π </center>
## π©Ή Fixes
- π **SQS plugin**: Revert optimized check for the AWS environment, [BUG](https://github.com/roadrunner-server/roadrunner/issues/1550), (thanks @sergey-telpuk)
### <center>π§Ή Chore:</center>
- π§βπ **Dependencies**: update project dependencies.
---
# <center> π v2023.1.1 π </center>
## π©Ή Fixes
- π **Centrifuge plugin**: Fix incorrect proto package import that caused panic on large payload.
- π **PHP metapackage**: Unable to install RoadRunner via Composer, [BUG](https://github.com/roadrunner-server/roadrunner/issues/1540), (thanks @monkenWu, @butschster)
- π **HTTP plugin**: Fix double unmarshal of the main plugin configuration.
- π **RR**: Fix `TestCommandWorkingDir` predifined temp directory, [BUG](https://github.com/roadrunner-server/roadrunner/issues/1545), (thanks @shyim)
- π **Status plugin**: Fix `superfluous response.WriteHeader` bug, [BUG](https://github.com/roadrunner-server/roadrunner/issues/1544), (thanks @mfadul24)
---
# <center> π v2023.1.0 π </center>
## β οΈ The `reload` plugin has been removed from the default plugins list. Please use `*.pool.debug=true` instead.
## π New
- βοΈ **Kafka plugin:** Completely rewritten Kafka plugin. Now supports regexps for topics, marked commits for group consumers, and SASL authentication. Configuration reference: [link](https://roadrunner.dev/docs/plugins-jobs/2.x/en#kafka-driver).
- βοΈ **RPC plugin:** The RPC plugin would be available immediately before worker initialization. This means that PHP worker can use all RPC methods immediately.
- βοΈ Endure v2 support (internal change).
- βοΈ Bash script to download the latest RR archive. Later we'll release a non-archived binary in addition to the regular archived releases. Sample of usage:
```bash
curl --proto '=https' --tlsv1.2 -sSf https://raw.githubusercontent.com/roadrunner-server/roadrunner/master/download-latest.sh | sh
```
- βοΈ RoadRunner Composer metapackage: Removed the `require` section: [PR](https://github.com/roadrunner-server/roadrunner/pull/1422), (thanks @roxblnfk)
- βοΈ **Lock plugin:** New plugin to handle shared resource access.
- βοΈ **AMQP plugin:** RR passes the queue, pipeline, and driver names to the PHP client in all modes, including the consuming payloads from the other senders.
- βοΈ **AMQP plugin:** `consumer_id` can now be set in configuration, [FR](https://github.com/roadrunner-server/roadrunner/issues/1432), (thanks @codercms)
- βοΈ **AMQP plugin:** Since `v2023.1.0` RR did not accept the empty queue name, [CH](https://github.com/roadrunner-server/roadrunner/issues/1443)
- βοΈ **OTEL plugin:** οΈSupport OpenTelemetry for the `temporal`, `http`, `gRPC` and `Jobs` plugins, including all `Jobs` drivers.
- βοΈ **Config plugin:** Configuration version updated to `version: '3'`.
- βοΈ **Logger plugin:** Now uses UTC timestamps [CH](https://github.com/roadrunner-server/roadrunner/issues/1442), (thanks @cv65kr)
- βοΈ **Service plugin:** Instead of `SIGKILL`, send `SIGINT` with a 5s timeout to stop the underlying processes.
- βοΈ **Configuration plugin:** Support for bash syntax with default values for keys. Starting from this release, you can use the following variables anywhere (values) in the configuration: `${LOG-LEVEL:-debug}`. That is, if the `LOG-LEVEL` env variable is not set, use `debug`.
- βοΈ **gRPC plugin:** Support for custom interceptors. Will be generally available in the `2023.2.0`.
- βοΈ **Temporal plugin:** Support for custom interceptors. Will be generally available in the `2023.2.0`.
## π©Ή Fixes
- π **HTTP plugin**: Edge case where empty form value overwrites existing value, [PR](https://github.com/roadrunner-server/http/pull/87), (thanks @tungfinblox).
- π **AMQP plugin**: Redial failed if user only uses consumer, [PR](https://github.com/roadrunner-server/roadrunner/issues/1472), (thanks @iborysenko).
- π **RR CLI**: ./rr jobs` command panics when used without arguments, [BUG](https://github.com/roadrunner-server/roadrunner/issues/1479), (thanks @embargo2710)
- π **gRPC Plugin:** panic when calling `grpc.Workers` immediately after RR start.[BUG](https://github.com/roadrunner-server/roadrunner/issues/1532), (thanks @genhoi)
- π **Proxy IP parser middleware:** Correctly handle the proxy headers from CloudFlare: [Discussion](https://github.com/orgs/roadrunner-server/discussions/1516), (thanks @victor-sudakov, @vladimir-vv)
---
###### tags: `roadrunner` `v2.12.3`
## v2.12.3 (16.02.2023)
## <center> π v2.12.3 π </center>
## <center>π New: <center>
- βοΈ **Composer.json:** add contributors, funds, project description: [PR](https://github.com/roadrunner-server/roadrunner/pull/1451), (thanks @roxblnfk)
### <center>π§Ή Chore:</center>
- π§βπ **Dependencies**: update project dependencies.
- π§βπ **Go**: update Go to `1.20`.
---
###### tags: `roadrunner` `v2.12.2`
## v2.12.2 (12.01.2023)
## <center> π v2.12.2 π </center>
## <center>π New: <center>
- βοΈ **AMQP plugin:** Custom headers in AMQP driver, [FR](https://github.com/roadrunner-server/roadrunner/issues/1388), (thanks @ykweb)
### <center>π©Ή Fixes:</center>
- π **Velox**: Unable to build RoadRunner with custom velox configuration, [BUG](https://github.com/roadrunner-server/roadrunner/issues/1400), (thanks @mprokocki)
- π **RR**: JSON Schema - wrong type for service `exec_timeout` option, [BUG](https://github.com/roadrunner-server/roadrunner/issues/1410), (thanks @Chi-teck)
- π **RR**: Fix the description of the `--silent` flag, [PR](https://github.com/roadrunner-server/roadrunner/pull/1401), (thanks @maximal)
---
###### tags: `roadrunner` `v2.12.2`
## <center>π v2.12.2-alpha.1 π<center>
## <center>π New: <center>
- β **AMQP plugin:** pass headers to the `Queue` declaration command to create quorum, lazy, etc. queues and provide additional options supported by RabbitMQ, [FR](https://github.com/roadrunner-server/roadrunner/issues/1388), (thanks @ykweb)
- β **AMQP plugin:** do not create a queue if the user does not consume it, [FR](https://github.com/spiral/roadrunner-jobs/issues/30), (thanks @Colomix)
### <center>π©Ή Fixes:</center>
- π **X-Sendfile middleware:** make it work as expected (as the response header), [BUG](https://github.com/roadrunner-server/roadrunner/issues/1386), (thanks @tux-rampage)
---
## v2.12.1 (01.12.2022)
###### tags: `roadrunner` `v2.12.1`
## <center> π v2.12.1 π </center>
## <center>π New: </center>
- β **RR:** Automatically set the `GOMAXPROCS` to match the container CPU quota.
- β **AMQP plugin:** implement `Status` to check the AMQP connection [PR](https://github.com/roadrunner-server/amqp/pull/33).
- β **SQS plugin:** `prefetch` option now works as expected. RR will not consume new JOBS when reaches `prefetch` limit, until already accepted messages are not ACK/NACK-ed.
- β **JOBS(memory) plugin:** `prefetch` option now works as expected (see SQS). You can now emulate FIFO in memory by setting the `prefetch` option to 1.
### <center>π©Ή Fixes:</center>
- **gRPC plugin**: server options are applied only when TLS is set. [Discussion](https://github.com/roadrunner-server/roadrunner/discussions/1384).
- **AMQP plugin**: fix a few typos in the configuration.
## v2.12.0 (24.11.2022)
# β οΈ `websocket` and `broadcast` plugins were replaced by the new `centrifuge` plugin.
# β οΈ All plugins, `sdk` and `api` updated to `v3`. There are no breaking changes, we moved all Go code from the `api` to `sdk`.
## π New:
- β **All plugins**: update to `v3`. This is done not because of some breaking change but because of the internal update.
- β **RPC plugin**: add new API to provide a running RR version and RR configuration in JSON format.
- β **Metrics plugin**: add new API to unregister previously registered collector. (thanks @butschster)
- β **Server plugin**: add new API to get statuses about the service and its child processes. (thanks @butschster)
- β **App logger plugin**: Application logger plugin, [FR](https://github.com/roadrunner-server/roadrunner/issues/1227) (thanks @wolfy-j)
**Docs**: [PHP-lib](https://github.com/roadrunner-php/app-logger)
- β **AMQP plugin**: new configuration options. [FR](https://github.com/roadrunner-server/roadrunner/issues/1351), (thanks @andrey-tech)
```yaml
jobs:
pipelines:
example:
driver: amqp
config:
# Durable exchange
#
# Default: true
exchange_durable: true
# Auto-deleted exchange
#
# Default: false
exchange_auto_deleted: false
# Auto-deleted queue
#
# Default: false
queue_auto_deleted: false
```
- β **Workers pool (SDK)**: New option to control the `reset_timeout`. Note that the `pool.Reset` is protected by mutexes, meaning that if you have some requests already in the pool, you'll have to wait for these requests to be processed. The `reset_timeout` does not count this time.
```yaml
pool:
allocate_timeout: 10s
reset_timeout: 10s
destroy_timeout: 10s
```
- β **Centrifugo plugin**: New `centrifugo` plugin. Which is going to replace existing `broadcast` + `websockets` plugins. [FR](https://github.com/roadrunner-server/roadrunner/issues/1134).
**Docs**: [PHP-lib](https://github.com/roadrunner-php/centrifugo)
RoadRunner config:
```yaml
version: "2.7"
centrifuge:
# Centrifugo server proxy address (docs: https://centrifugal.dev/docs/server/proxy#grpc-proxy)
#
# Optional, default: tcp://127.0.0.1:30000
proxy_address: "tcp://127.0.0.1:30000"
# gRPC server API address (docs: https://centrifugal.dev/docs/server/server_api#grpc-api)
#
# Optional, default: tcp://127.0.0.1:30000. Centrifugo: `grpc_api` should be set to true and `grpc_port` should be the same as in the RR's config.
grpc_api_address: tcp://127.0.0.1:30000
# Use gRPC gzip compressor
#
# Optional, default: false
use_compressor: true
# Your application version
#
# Optional, default: v1.0.0
version: "v1.0.0"
# Your application name
#
# Optional, default: roadrunner
name: "roadrunner"
# TLS configuration
#
# Optional, default: null
tls:
# TLS key
#
# Required
key: /path/to/key.pem
# TLS certificate
#
# Required
cert: /path/to/cert.pem
# Workers pool settings. link: https://github.com/roadrunner-server/roadrunner/blob/master/.rr.yaml#L812
#
# Optional, default: null (see default values)
pool: {}
```
## π©Ή Fixes:
- π **Headers middleware**: Header size is too small, [BUG](https://github.com/roadrunner-server/roadrunner/issues/1336) (thanks @masterjus)
- π **gRPC plugin**: Protobuf compiler plugin segfaults on import statements, [BUG](https://github.com/roadrunner-server/roadrunner/issues/1337) (thanks @phroggyy)
- π **Service plugin**: Get services list via RPC, [BUG](https://github.com/roadrunner-server/roadrunner/issues/1339) (thanks @butschster)
- π **gRPC plugin**: Remote `protoc-gen-php-grpc` plugin error, [BUG](https://github.com/roadrunner-server/roadrunner/issues/1341) (thanks @rapita)
- π **HTTP plugin**: Fail to upload files when RR's permissions are different from worker's, [BUG](https://github.com/roadrunner-server/roadrunner/issues/1314) (thanks @egonbraun)
## v2.11.4 (06.10.2022)
## π New:
- β **Temporal plugin**: Support for the `SearchAttributes`. [FR](https://github.com/temporalio/roadrunner-temporal/pull/275), (thanks @cv65kr).
**Docs**: [link](https://docs.temporal.io/concepts/what-is-a-search-attribute)
**Samples**: [link](https://github.com/temporalio/samples-php/tree/master/app/src/SearchAttributes)
## π§ Maintenance:
- `roadrunner-temporal` plugin updated to: `1.7.0`
- `http` plugin updated to: `2.23.5`
- `sqs` plugin updated to: `2.20.4`
- `config` plugin updated to: `2.16.5`
- `grpc` plugin updated to: `2.23.3`
- `nats` plugin updated to: `2.17.3`
- `jobs` plugin updated to: `2.18.4`
- `server` plugin updated to: `2.16.4`
- `tcp` plugin updated to: `2.15.4`
- `websockets` plugin updated to: `2.16.5`
- `otel` plugin updated to: `2.5.6`
- `kafka` plugin updated to: `2.2.3`
---
## v2.11.3 (29.09.2022)
## π New:
- β **[ALPHA] gRPC plugin**: `buf` remote plugins support for the `protoc-gen-php-grpc` plugin. [FR](https://github.com/roadrunner-server/roadrunner/issues/1297), (thanks @rauanmayemir)
- β **Temporal plugin**: `mTLS` support. [FR](https://github.com/roadrunner-server/roadrunner/issues/1300), (thanks @seregazhuk)
[Configuration sample](https://github.com/roadrunner-server/roadrunner/blob/master/.rr.yaml#L252):
```yaml
temporal:
address: 127.0.0.1:7233
cache_size: 100000
activities:
num_workers: 4
tls:
key: client.key
cert: client.pem
root_ca: ca.cert
client_auth_type: require_and_verify_client_cert
server_name: "tls-sample"
```
## π©Ή Fixes:
- π **Config plugin**: properly replace environment variables for the array `yaml` values. [BUG](https://github.com/roadrunner-server/roadrunner/issues/1308), (thanks @lyt8384)
## π§Ή Chore:
- π§βπ: **[ALPHA] gRPC plugin**: `base64` decoder for the google's `ErrorProto` structure. [FR](https://github.com/roadrunner-server/roadrunner/issues/1273), (thanks @rauanmayemir)
---
## v2.11.2 (13.09.2022)
## π New:
- β **Kafka plugin**: **[ β οΈ EXPERIMENTAL OPTION β οΈ ]** Kafka plugin now waits for 1 minute (automatically) for the broker to be available, [FR](https://github.com/roadrunner-server/roadrunner/issues/1267), (thanks @Baiquette)
- β **Internal**: PHP Worker now uses an [FSM](https://en.wikipedia.org/wiki/Finite-state_machine) to transition between states (`working`, `ready`, `invalid`, etc).
- β **Internal**: `./rr reset` now works in parallel. All workers will be restarted simultaneously instead of a one-by-one sync approach.
- β **Internal**: `./rr reset` and destroy (when stopping RR) now gracefully stop the workers (giving a chance for the finalizers to work). If the worker doesn't respond in 10 seconds, it'll be killed.
## π©Ή Fixes:
- π **SQS plugin**: Incorrect detection of the `AWS IMDSv2` instances, [BUG](https://github.com/roadrunner-server/roadrunner/issues/1250) (thanks @paulermo)
- π **Temporal plugin**: Segmentation violation when using TLS, [BUG](https://github.com/roadrunner-server/roadrunner/issues/1278), (thanks @seregazhuk)
- π **NATS plugin**: Properly check the `stream not found` error from NATS, [BUG](https://github.com/roadrunner-server/roadrunner/issues/1274), (thanks @pjtuxe)
## π§Ή Chore:
- π§βπ: **Temporal plugin**: Support for the `statsd` daemon for stats aggregation, [FR](https://github.com/temporalio/roadrunner-temporal/issues/265), (thanks @cv65kr)
Configuration stays the same (**no breaking changes**), but additionally, you may specify a `driver`:
**Prometheus:**
```yaml
temporal:
address: "127.0.0.1:7233"
metrics:
driver: prometheus # <---- prometheus used by default (you may omit the driver in this case)
address: "127.0.0.1:9095"
prefix: "samples"
type: "summary"
activities:
num_workers: 4
```
**Statsd:**
```yaml
temporal:
address: "127.0.0.1:7233"
metrics:
driver: statsd # <---- Should be specified to use a statsd driver
host_port: "127.0.0.1:8125"
prefix: "samples"
flush_interval: 1s
flush_bytes: 512
tags:
- foo: bar
activities:
num_workers: 4
```
Detailed description is here: [link](https://github.com/roadrunner-server/roadrunner/blob/master/.rr.yaml#L169)
---
## v2.11.1 (25.08.2022)
## π New:
- β **http plugin**: Send raw body (unescaped) to the PHP worker for the `application/x-www-form-urlencoded` content type. [FR1](https://github.com/roadrunner-server/roadrunner/issues/1264), [FR2](https://github.com/roadrunner-server/roadrunner/issues/1206), (thanks @ekisu, @rlantingmove4mobile)
Configuration:
```yaml
http:
raw_body: true/false (by default)
```
- β **temporal plugin**: Overwrite `client-name` and `client-version` in Go client to represent PHP-SDK, [FR](https://github.com/roadrunner-server/roadrunner/issues/1249), (thanks, @wolfy-j)
## π§Ή Chore:
- π§βπ: Autocomplete `.rr.yaml` configuration for the `cache` plugin. [link](https://cdn.jsdelivr.net/gh/roadrunner-server/roadrunner@latest/schemas/config/2.0.schema.json)
---
## v2.11.0 (18.08.2022)
## β οΈ NewRelic middleware was removed. Please, use [OTEL middleware instead](https://roadrunner.dev/docs/middleware-otel/2.x/en)
## β οΈ In `2.12.0` we plan to replace `websockets` and `broadcast` plugins with the `centrifuge` plugin. However, if you still need a RR with these deprecated plugins, you may use `Velox` to build your custom build.
## π New:
- βοΈ **[BETA]: RoadRunner**: Can now be embedded in other go programs. [PR](https://github.com/roadrunner-server/roadrunner/pull/1214), (thanks @khepin)
- βοΈ **gRPC Plugin**: Implement Google's `gRPC` [errors API](https://cloud.google.com/apis/design/errors). The exception might be passed as a `Status` structure in the `Metadata` (key - `error`) to be parsed and returned to the user w/o worker restart. NOTE: `Status` structure should be marshaled via `proto` marshaller, not `json`. [FR](https://github.com/roadrunner-server/roadrunner/issues/1001)
- βοΈ **Logger Plugin**: Get rid of the `context deadline exceeded` error on worker's allocation. We updated the error message with the link to the docs with the most common causes for the `worker allocation failed` error: https://roadrunner.dev/docs/known-issues-allocate-timeout/2.x/en. Feel free to add your cases here :)
- βοΈ **CLI**: New CLI command to pause, resume, destroy and list Jobs. [FR](https://github.com/roadrunner-server/roadrunner/issues/1088), (thanks @hustlahusky)
- βοΈ **Velox**: New configuration option: `folder`, which can be used to specify the folder with the plugin in the repository. (thanks, @darkweak)
- βοΈ **Velox**: Velox now respects the plugin's `replace` directives. (thanks, @darkweak)
- βοΈ **Cache plugin**: RR now uses a [great cache](https://github.com/darkweak/souin) (RFC 7234) plugin made by @darkweak
- βοΈ **[BETA] Kafka plugin**: New Kafka driver for the Jobs plugin. [FR](https://github.com/roadrunner-server/roadrunner/issues/1128), (thanks, @Smolevich)
- βοΈ **Temporal plugin**: Temporal now uses a new reset mechanism to prevent WF worker restarts on activity worker failure
- βοΈ **Temporal plugin**: Temporal plugin now supports a TSL-based authentication with the key and certificate.
Configuration:
```yaml
temporal:
tls:
key: path/to/key
cert: path/to/cert
# other options
```
## π©Ή Fixes:
- π **Server plugin**: use the `allocate_timeout` from the pool to wait for the `tcp/unix` socket connection from the PHP worker. [BUG](https://github.com/roadrunner-server/roadrunner/issues/1226), (thanks @Warxcell)
- π **Velox**: Fix panic when no `github` option is specified in the configuration.
- π **SDK**: Use `pool.allocate_timeout` for the sockets/tcp relays instead of silently used of `relay_timeout`.
## π§Ή Chore:
- 𧽠**Logger plugin**: use the parsable timestamp format for the `raw` logger mode. [CH](https://github.com/roadrunner-server/roadrunner/issues/1236), (thanks @ilsenem)
## π§ Maintenance:
- Temporal `GO-SDK` and `API` updated to the latest versions.
- All plugins, including RR, now use Go 1.19
---
## v2.10.7 (14.07.2022)
## π New:
- βοΈ **OTEL Middleware**: Support for the `jaeger_agent` exporter - [BUG](https://github.com/roadrunner-server/roadrunner/issues/1205), (thanks @L3tum)
## π¦ Packages:
- π¦ `OTEL` SDK updated to `v1.8.0`
- π¦ `google.golang.org/gRPC` updated to `v1.48.0`
- π¦ `logger` plugin updated to `v2.13.5`
- π¦ `Go` updated to `v1.18.4`
---
## v2.10.6 (07.07.2022)
## π©Ή Fixes:
- π **SDK**: In some cases, worker watcher might freeze if the user kills the worker right after allocation but before `wait4` syscall and become a zombie. [BUG](https://github.com/roadrunner-server/roadrunner/issues/1180)
- π **AMQP Plugin**: Ignored prefetch option when dynamically creating a pipeline. [BUG](https://github.com/roadrunner-server/roadrunner/issues/1197) (thanks @rauanmayemir)
## π New:
- βοΈ **VELOX**: Velox now supports environment variables for the `version`, `buildtime`, GitHub, and GitLab `tokens` in the `velox.toml`.
- βοΈ **Logger**: Say bye-bye to the `CRC verification failed` error. Starting from the `v2.10.6`, RR will show user-friendly message with the link to our docs on the most common causes for this type of error. [Docs](https://roadrunner.dev/docs/known-issues-stdout-crc/2.x/en)
---
## v2.10.5 (23.06.2022)
## π©Ή Fixes:
- π **SDK**: Increase `stderr` buffer size from 32kb to 65kb, [man7](https://linux.die.net/man/7/pipe), [BUG](https://github.com/roadrunner-server/roadrunner/issues/1171), (thanks @7krasov)
- π **AMQP Plugin**: Fix incorrect queue binding to the `default` routing key. [BUG](https://github.com/roadrunner-server/roadrunner/issues/1181), (thanks @rauanmayemir)
- π **HTTP Plugin**: Fix `x-www-form-urlencoded` requests 10Mb limit. [BUG](https://github.com/roadrunner-server/roadrunner/issues/1172) (thanks @StreetYo)
---
## v2.10.4 (11.06.2022)
## π©Ή Fixes:
- π Fix: incorrect `reset` behavior for the workers pool.
- π Fix: correct `reset` order for the RR and Temporal workers.
---
## v2.10.3 (02.06.2022)
## π New:
- βοΈ **CLI**: `rr stop` command. `rr stop` will read the `.pid` file to send a graceful stop signal to the main RR process (`SIGTERM`). [FR](https://github.com/roadrunner-server/roadrunner/issues/1162) (thanks @Baiquette)
## π©Ή Fixes:
- π Fix: incorrect `reset` behavior for the `temporal` plugin. [BUG](https://github.com/temporalio/sdk-php/issues/174), [BUG](https://github.com/temporalio/sdk-php/issues/170), [BUG](https://github.com/temporalio/sdk-php/issues/177). (thanks @dmitry-pilipenko, @mzavatsky)
---
## v2.10.2 (26.05.2022)
## π New:
- βοΈ **WORKER**: Starting from this release, RR is able to show full error messages sent to the `STDOUT` during the worker bootstrap.
- βοΈ **HTTP**: Connection might be upgraded from the `http/1.1` to `h2c`: [rfc7540](https://datatracker.ietf.org/doc/html/rfc7540#section-3.4)
Headers, which should be sent to upgrade connection:
1. `Upgrade`: `h2c`
2. `Connection`: `HTTP2-Settings`
3. `Connection`: `Upgrade`
4. `HTTP2-Settings`: `AAMAAABkAARAAAAAAAIAAAAA` [RFC](https://datatracker.ietf.org/doc/html/rfc7540#section-3.2.1)
- βοΈ [**VELOX**](https://github.com/roadrunner-server/velox): Add GitLab support. Starting from the `beta.2` you may use `GitHub` and `GitLab` plugins together. Configuration updated. Keep in mind, until stable release `1.0.0` configuration might be changed with breaking changes.
- βοΈ **protoc-gen-php-grpc**: Use of fully qualified names in place of imports. [PR](https://github.com/roadrunner-server/grpc/pull/30) (thanks @ryanjcohen)
---
## v2.10.1 (19.05.2022)
## π New:
- βοΈ **Jobs (queues)** plugin now can consume any payload from the queue. If RR fails in converting payload into the `Job` structure, it'll create and fill all available fields manually. To turn **on** this feature, use `consume_all: true` in the driver configuration, e.g.:
Supported drivers: `amqp`, `sqs`,`beanstalk`,`nats`.
```yaml
jobs:
num_pollers: 10
pipeline_size: 100000
pool:
num_workers: 10
pipelines:
test-raw:
driver: sqs
config:
consume_all: true # <------- NEW OPTION
consume: [ "test-raw" ]
```
- βοΈ **SQS** Jobs driver now can skip queue declaration in favor of getting queue URL instead. To use this feature, use `skip_queue_declaration: true` sqs driver option. [FR](https://github.com/roadrunner-server/roadrunner/issues/980), (thanks @sergey-telpuk)
```yaml
jobs:
num_pollers: 10
pipeline_size: 100000
pool:
num_workers: 10
pipelines:
test-2:
driver: sqs
config:
skip_queue_declaration: true # <----- NEW OPTION
consume: [ "test-2" ]
```
- βοΈ OpenTelemetry middleware now supports `Jaeger` exporter and propagator.
```yaml
http:
address: 127.0.0.1:43239
max_request_size: 1024
middleware: [gzip, otel]
pool:
num_workers: 2
max_jobs: 0
allocate_timeout: 60s
destroy_timeout: 60s
otel:
exporter: jaeger # <----- NEW OPTION
```
- βοΈ **HTTP Plugin** now supports [`mTLS` authentication](https://www.cloudflare.com/en-gb/learning/access-management/what-is-mutual-tls/). Possible values for the `client_auth_type` are the same as for the `gRPC` (`no_client_cert`, `request_client_cert`,`require_any_client_cert`,`verify_client_cert_if_given`,`require_and_verify_client_cert`) [FR](https://github.com/roadrunner-server/roadrunner/issues/1111), (thanks @fwolfsjaeger)
```yaml
version: '2.7'
server:
command: "php ../../php_test_files/http/client.php echo pipes"
relay: "pipes"
relay_timeout: "20s"
http:
address: :8085
max_request_size: 1024
middleware: [ ]
pool:
num_workers: 1
max_jobs: 0
allocate_timeout: 60s
destroy_timeout: 60s
ssl:
address: :8895
key: "key"
cert: "cert"
root_ca: "rootCA.pem" # <---- REQUIRED to use mTLS
client_auth_type: require_and_verify_client_cert # <---- NEW OPTION
logs:
mode: development
level: error
```
## π©Ή Fixes:
- π Fix: **HTTP plugin**: non-documented behavior on non-standard (but valid) http codes. [BUG](https://github.com/roadrunner-server/roadrunner/issues/1136), (thanks, @Meroje)
- π Fix: **SQS driver**: `rr_auto_ack` attribute won't fail the existing messages.
---
## v2.10.0 (16.05.2022)
## π New:
- βοΈ Documentation update: [link](https://roadrunner.dev).
- βοΈ **RoadRunner-Temporal plugin now supports local activities**. Here is the brief overview: [link](https://docs.temporal.io/docs/temporal-explained/activities/#local-activity).
- βοΈ Add Debian `amd64` releases. [FEATURE](https://github.com/roadrunner-server/roadrunner/issues/940)
- βοΈ Add signed releases. Starting from the `v2.10.0`, every released binary can be checked with a provided `*.asc` key. For example:
```bash
$ gpg --verify rr.asc
```
The openPGP key can be verified here: [keyserver](https://keyserver.ubuntu.com/pks/lookup?search=0x9480A51C85D357D0&fingerprint=on&op=index)
- βοΈ All proto api for the `Go` programming language located here: [link](https://buf.build/roadrunner-server/api). To use it, just import the latest stable version `go.buf.build/protocolbuffers/go/roadrunner-server/api latest`.
- βοΈ `Service` plugin now supports auto-reload. It can be added to the `reload` plugin targets and on change, it'll reload all underlying processes.
- βοΈ `AutoAck` jobs option. For the messages (jobs), which are acceptable to lose. Or which execution can lead to a worker's stop (for example - OOM).
- βοΈ **[BETA] OpenTelemetry support**. Starting from now, the `new_relic` middleware is deprecated, it'll receive only dependency updates and will be removed from the RR bundle in the `v2.12.0`. (thanks @brettmc)
OpenTelemetry plugin supports the following exporters:
1. OTLP (open telemetry protocol): `datadog`, `new relic`.
2. zipkin
3. stdout
All these exporters can send their data via `http` or `grpc` clients.
Configuration sample (stdout exporter):
```yaml
http:
address: 127.0.0.1:43239
max_request_size: 1024
middleware: [gzip, otel]
pool:
num_workers: 2
max_jobs: 0
allocate_timeout: 60s
destroy_timeout: 60s
otel:
insecure: false
compress: true
exporter: stdout
service_name: rr_test
service_version: 1.0.0
```
New Relic exporter via `http` client: [link](https://docs.newrelic.com/docs/more-integrations/open-source-telemetry-integrations/opentelemetry/opentelemetry-setup/#review-settings)
```yaml
http:
address: 127.0.0.1:43239
max_request_size: 1024
middleware: [gzip, otel]
pool:
num_workers: 2
max_jobs: 0
allocate_timeout: 60s
destroy_timeout: 60s
otel:
insecure: false
compress: true
client: http
exporter: stdout
custom_url: ""
service_name: rr_test
service_version: 1.0.0
endpoint: otlp.eu01.nr-data.net:4318
headers:
- api-key: xxx # your api key here
```
PHP worker can access tracing data via `w3c` [headers](https://www.w3.org/TR/trace-context/#trace-context-http-headers-format).
- βοΈ Jobs can be auto-ack'ed now. New option used to acknowledge a message after RR receive it from the queue. [FR](https://github.com/roadrunner-server/roadrunner/issues/1089), (thanks @hustlahusky)
- βοΈ `protoc-gen-php-grpc` now supports `optional` fields. (thanks @genhoi)
## π§Ή Chore:
- π§βπ: All spaces and new-lines from the `Service` plugin output will be automatically trimmed. [CHORE](https://github.com/roadrunner-server/roadrunner/issues/1060), (thanks, @OO00O0O)
---
## v2.9.4 (06.05.2022)
## π©Ή Fixes:
- π Fix: **HTTP plugin:** request max body size incorrectly parsed. [BUG](https://github.com/roadrunner-server/roadrunner/issues/1115), (thanks, @Opekunov)
---
## v2.9.3 (06.05.2022)
## π New:
- βοΈ: `--silent` flag. This flag will hide startup message and `./rr reset` output.
## π©Ή Fixes:
- π Fix: **AMQP** driver didn't reconnect on timeouts, which led to stopping consuming messages w/o a proper notification. [BUG](https://github.com/roadrunner-server/roadrunner/issues/1103), (thanks @hustlahusky)
- π Fix: `reset` command (`./rr reset`) gets stuck when using output redirects. [BUG](https://github.com/roadrunner-server/roadrunner/issues/1108), (thanks @maximal)
## π§Ή Chore:
- ποΈ **HTTP** plugin: better looking error message on wrong status code. [ISSUE](https://github.com/roadrunner-server/roadrunner/issues/1107), (thanks @gam6itko)
---
## v2.10.0-alpha.1 (07.04.2022)
## π New:
- βοΈ **[ALPHA]** HTTP response streaming. Available only in the alfa builds.
Worker sample:
```php
<?php
use Nyholm\Psr7\Factory\Psr17Factory;
use Nyholm\Psr7\Response;
use Nyholm\Psr7\Stream;
use Spiral\RoadRunner;
ini_set('display_errors', 'stderr');
require __DIR__ . "/vendor/autoload.php";
$worker = RoadRunner\Worker::create();
$psr7 = new RoadRunner\Http\PSR7Worker(
$worker,
new Psr17Factory(),
new Psr17Factory(),
new Psr17Factory()
);
$psr7->chunk_size = 10 * 10 * 1024;
$filename = 'file.tmp'; // big file or response
while ($req = $psr7->waitRequest()) {
try {
$fp = \fopen($filename, 'rb');
\flock($fp, LOCK_SH);
$resp = (new Response())->withBody(Stream::create($fp));
$psr7->respond($resp);
} catch (\Throwable $e) {
$psr7->getWorker()->error((string)$e);
}
```
Known issues:
1. RR will not notify a worker if HTTP connection was interrupted. RR will read all response from the worker and drop it. That will be fixed in the stable streaming release.
2. Sometimes RR may miss the immediate error from the worker and send a 0 payload with 200 status. This is related only to the http response.
- βοΈ **[BETA]** Local activities support [link](https://docs.temporal.io/docs/concepts/what-is-a-local-activity).
---
## v2.9.2 (28.04.2022)
## π©Ή Fixes:
- π Fix: incorrect `-w` flag behavior (set working dir). [BUG](https://github.com/roadrunner-server/roadrunner/issues/1101), (thanks @rauanmayemir)
---
## v2.9.1 (11.04.2022)
### β οΈ This is important. `trusted_subnets` HTTP option will work only when `proxy_ip_parser` was added to the list of the middlewares.
## π©Ή Fixes:
- π Fix: incorrect usage of the `ExecWithTTL` SDK method which leads to skipping the `exec_ttl` supervisor option [BUG](https://github.com/laravel/octane/issues/504) (thanks @Baiquette)
## π New:
- βοΈ Add [`proxy_ip_parser`](https://github.com/roadrunner-server/proxy_ip_parser) HTTP middleware responsible for parsing `X-Forwarded-For`, `Forwarded`, `True-Client-IP` and `X-Real-Ip`.
---
## v2.9.0 (07.04.2022)
---
πΊπ¦πΊπ¦πΊπ¦ `#StandWithUkraine` πΊπ¦πΊπ¦πΊπ¦
---
## π New:
- βοΈ [**API**](https://github.com/roadrunner-server/api): add service proto api to manage services, [FR](https://github.com/roadrunner-server/roadrunner/issues/1009) (thanks @butschster). Documentation is here: [link](https://roadrunner.dev/docs/beep-beep-service).
- βοΈ Grafana dashboard [PATH](dashboards/RR_Dashboard.json). Exposed metrics:
1. **General**:
1. Uptime (seconds).
2. Memory used by RR (MB).
3. Number of active goroutines.
2. **HTTP**:
1. Number of workers by its state (ready, working, invalid).
2. Total RSS memory used by workers.
3. Memory used by each worker individually (with PID).
4. Latency (ms).
5. Requests queue size.
6. Requests per minute.
3. **JOBS**:
1. Number of workers by its state (ready, working, invalid).
2. Total RSS memory used by workers.
3. Memory used by each worker individually (with PID).
4. Successfully processed jobs (rate, 5m).
5. Failed jobs (rate, 5m).
## π©Ή Fixes:
- π Fix: Goroutines leak in the `amqp` plugin when destroying pipelines.
## π§Ή Chore:
- π§βπ Update all dependencies to the most recent versions.
---
## v2.8.8 (31.03.2022)
## π©Ή Fixes:
- π Fix: Chdir (if the user sets the `-w` flag) before searching for the configuration.
## π¦ Packages:
- π¦ Update SQS and Go deps to the most recent versions.
---
## v2.8.6 (24.03.2022)
## π©Ή Fixes:
- π Fix: Websocket access validator requests don't send cookies [BUG](https://github.com/roadrunner-server/roadrunner/issues/1064), (@steffendietz)
---
## v2.8.5 (23.03.2022)
## π§Ή Chore:
- π§βπ Update all dependencies to the most recent versions.
## π©Ή Fixes:
- π Fix: Incorrect pointer assign to read the configuration [BUG](https://github.com/roadrunner-server/roadrunner/issues/1066)
---
## v2.8.4 (17.03.2022)
## π New:
- Go update to version `1.18`
## π§Ή Chore:
- π§βπ Update all dependencies to the most recent versions.
## π©Ή Fixes:
- π Fix: No longer able to set environment variables for service [BUG](https://github.com/roadrunner-server/roadrunner/issues/1055), (reporter @andrei-dascalu)
---
## v2.8.3 (13.03.2022)
## π New:
- βοΈ Better env variables parser. Now RR is able to parse the sentences like: `"mysql://${MYSQL_USER}:${MYSQL_PASSWORD}@${MYSQL_HOST}:${MYSQL_PORT}/${MYSQL_DATABASE}?serverVersion=5.7"` and get all environment variables. [FR](https://github.com/roadrunner-server/roadrunner/issues/1035), (reporter @Tony-Sol)
## π§Ή Chore:
- π§βπ Update all dependencies to the most recent versions.
- π§βπ Remove `configuration` plugin from the `root.go` and other files. Used only in the `serve` where it should be.
## π©Ή Fixes:
- π Fix: call of the `kv.TTL` for the Redis drivers returns non RFC3339 time format [BUG](https://github.com/roadrunner-server/roadrunner/issues/1024), (reporter @antikirra)
- π Fix: `rr workers` command doesn't work for the `service` plugin [BUG](https://github.com/roadrunner-server/roadrunner/issues/1033), (reporter @OO00O0O)
---
## v2.8.2 (22.02.2022)
## π§Ή Chore:
- Docker: migrate to the `trivy` action instead of `grype` [PR](https://github.com/roadrunner-server/roadrunner/pull/1020), (contributor: @tarampampam)
## π©Ή Fixes:
- π Fix: **CONFIG**: `version` can't be passed as inline option: [BUG](https://github.com/roadrunner-server/roadrunner/issues/1021), (reporter @nunomaduro)
---
## v2.8.1 (21.02.2022)
## π©Ή Fixes:
- π Fix: **HTTP**: incorrect middleware chain order [BUG](https://github.com/roadrunner-server/roadrunner/issues/1017), (reporter @nitrogenium)
```yaml
http:
middleware: ["static", "gzip"]
```
Middleware applied from the right to left, i.e. first will be `gzip` and then `static`.
## π New:
- βοΈ **HTTP**: Properly parse `Forwarder` header, [RFC](https://datatracker.ietf.org/doc/html/rfc7239), [FR](https://github.com/roadrunner-server/roadrunner/issues/1018) (reporter @digitalkaoz)
- βοΈ **TEMPORAL**: Add `rr_activities_pool_queue_size` and `rr_workflows_pool_queue_size` metrics. These metrics shows the number of activities/workflows waiting for the worker [BUG](https://github.com/temporalio/roadrunner-temporal/issues/183), (reporter @Zylius)
- βοΈ **API**: `Queuer` interface for the workers pool to show the number of requests waiting for the worker. Implemented in **SDK**.
---
## v2.8.0 (17.02.2022)
### β οΈ For the RR `v2.8.0` your `.rr.yaml` configuration version should be [`2.7`](https://github.com/roadrunner-server/roadrunner/blob/master/.rr.yaml), so please update your config and add `version: '2.7'` at the top.
## π New:
- βοΈ Timeout for the SQS create/get queue operations (30seconds) [FR](https://github.com/roadrunner-server/roadrunner/issues/903) (reporter @sergey-telpuk)
- βοΈ New workers pool option -> `command`:
```yaml
http:
address: 127.0.0.1:8080
max_request_size: 256
middleware: ["headers", "gzip"]
trusted_subnets: []
# Workers pool settings.
pool:
command: "php app.php" <---- NEW
```
This option is used to override the `server`'s command with the new one. The new command will inherit all server options. It can be used in any plugin (`jobs`, `grpc`, `tcp`, `http`, etc) using workers pool (`http` used here as a sample). No need to update your config. By default server command will be used as in the previous RR versions. Note, you can't leave the `server` command option empty. If you wanted to override the command in every plugin you use, put a placeholder in the `server.command`.
- βοΈ Add `Rr_newrelic_ignore` header support. Now you can send the `Rr_newrelic_ignore:true` header and RR will ignore such transactions. No data will be sent to the `newrelic` server. [FR](https://github.com/roadrunner-server/roadrunner/issues/900) (reporter @arku31)
- βοΈ Add support for the SQS FIFO queues [FR](https://github.com/roadrunner-server/roadrunner/issues/906) (reporter @paulermo)
- βοΈ Add support for the gRPC Healthcheck protocol v1 in the `grpc` plugin. [Doc](https://github.com/grpc/grpc/blob/master/doc/health-checking.md), [FR](https://github.com/roadrunner-server/roadrunner/issues/928) (reporter @porozhnyy)
---
## v2.7.9 (14.02.2022)
## π©Ή Fixes:
- π Fix: errors on workers reallocating when the unix/tcp socket transport is used: [BUG](https://github.com/roadrunner-server/roadrunner/issues/1008), (reporter @tarampampam)
---
## 2.7.8 (12.02.2022)
## π©Ή Fixes:
- π Fix: worker sometimes panics when `unix/tcp sockets` transport used: [BUG](https://github.com/roadrunner-server/roadrunner/issues/1006), (reporter @tarampampam)
---
## 2.7.7 (10.02.2022)
## π©Ή Fixes:
- π Fix: case-sensitive attributes for SQS [BUG](https://github.com/roadrunner-server/roadrunner/issues/994), (reporter @paulermo)
- π Fix: grpc plugin incorrectly parses the error response from the worker [BUG](https://github.com/roadrunner-server/roadrunner/issues/995), (reporter @rauanmayemir)
- π Fix: destroy operation hangs if the number of workers is 0 [BUG](https://github.com/roadrunner-server/roadrunner/issues/1003), (reporter @benalf)
---
## 2.7.6 (06.02.2022)
## π©Ή Fixes:
- π Fix: temporal: `ActivityNotRegisteredError` on the local activity workers [BUG](https://github.com/temporalio/roadrunner-temporal/issues/163) (reporter @Zylius)
---
## 2.7.5 (04.02.2022)
## π New:
- βοΈ Better workers' statistic. Add `worker state`, per-worker memory usage and worker's PID stats for the `JOBS`, `GRPC`, `HTTP` plugins [FR](https://github.com/roadrunner-server/roadrunner/issues/970)
---
## 2.7.4 (27.01.2022)
## π New:
- βοΈ Return an error if the user uses the `.env` file, but it doesn't exist. [BUG](https://github.com/roadrunner-server/roadrunner/issues/954), (reporter @O00O0O)
- βοΈ Parallel workers allocation within the plugin. [FR](https://github.com/roadrunner-server/roadrunner/issues/951), (reporter @roquie)
## π©Ή Fixes:
- π Fix: RR workers are blocked when one of them should send a big (> 100mb) response and when the time to send the response is bigger than the supervisor's `watch_tick` [BUG](https://github.com/roadrunner-server/roadrunner/issues/957) (reported by: @OO00O0O)
---
## 2.7.3 (19.01.2022)
## π©Ή Fixes:
- π Fix: `jobs` pipeline shadowing if registering the pipeline with the existing name [BUG](https://github.com/roadrunner-server/roadrunner/issues/943)
- π Fix: `reload` plugin doesn't collect a resettable plugins [BUG](https://github.com/roadrunner-server/roadrunner/issues/942)
---
## v2.7.2 (17.01.2022)
## π New:
- Moved to the new organization.
---
## 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.
- βοΈ `.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.6 (7.12.2021)
## π New:
- βοΈ 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.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)
---
## 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.2 (3.12.2021)
## π©Ή Fixes:
- π Fix: Random NPE on RR start. [BUG](https://github.com/spiral/roadrunner-plugins/issues/143)
---
## v2.6.1 (2.12.2021)
## π©Ή Fixes:
- π Fix: logger incorrectly escaped HTML, JSON, and other special symbols.
---
## 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:
- π Fix: ASLR builds causes [problems](https://github.com/roadrunner-server/roadrunner/issues/120) in the docker.
## v2.5.1 (22.10.2021)
## π©Ή Fixes:
- π Fix: [base64](https://github.com/spiral/roadrunner-plugins/issues/86) response instead of json in some edge cases.
## v2.5.0 (20.10.2021)
# π Breaking change:
- π¨ Some drivers now use a new `config` key to handle local configuration. Involved plugins and drivers:
- `plugins`: `broadcast`, `kv`
- `drivers`: `memory`, `redis`, `memcached`, `boltdb`.
### Old style:
```yaml
broadcast:
default:
driver: memory
interval: 1
```
### New style:
```yaml
broadcast:
default:
driver: memory
config: {} <--------------- NEW
```
```yaml
kv:
memory-rr:
driver: memory
config: <--------------- NEW
interval: 1
kv:
memcached-rr:
driver: memcached
config: <--------------- NEW
addr:
- "127.0.0.1:11211"
broadcast:
default:
driver: redis
config: <------------------ NEW
addrs:
- "127.0.0.1:6379"
```
## π 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:
```yaml
ssl:
# Host and port to listen on (eg.: `127.0.0.1:443`).
#
# Default: ":443"
address: "127.0.0.1:443"
# Use ACME certificates provider (Let's encrypt)
acme:
# Directory to use as a certificate/pk, account info storage
#
# Optional. Default: rr_cache
certs_dir: rr_le_certs
# User email
#
# Used to create LE account. Mandatory. Error on empty.
email: you-email-here@email
# Alternate port for the http challenge. Challenge traffic should be redirected to this port if overridden.
#
# Optional. Default: 80
alt_http_port: 80,
# Alternate port for the tls-alpn-01 challenge. Challenge traffic should be redirected to this port if overridden.
#
# Optional. Default: 443.
alt_tlsalpn_port: 443,
# Challenge types
#
# Optional. Default: http-01. Possible values: http-01, tlsalpn-01
challenge_type: http-01
# Use production or staging endpoints. NOTE, try to use the staging endpoint (`use_production_endpoint`: `false`) to make sure, that everything works correctly.
#
# Optional, but for production should be set to true. Default: false
use_production_endpoint: true
# List of your domains to obtain certificates
#
# Mandatory. Error on empty.
domains: [
"your-cool-domain.here",
"your-second-domain.here"
]
```
- βοΈ 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"
```
- βοΈ 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: []
pool:
num_workers: 2
max_jobs: 0
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.
```yaml
http:
address: 127.0.0.1:44444
max_request_size: 1024
middleware: ["sendfile"] <----- NEW MIDDLEWARE
pool:
num_workers: 2
max_jobs: 0
allocate_timeout: 60s
destroy_timeout: 60s
```
- βοΈ Service plugin now supports env variables passing to the script/executable/binary/any like in the `server` plugin:
```yaml
service:
some_service_1:
command: "php test_files/loop_env.php"
process_num: 1
exec_timeout: 5s # s,m,h (seconds, minutes, hours)
remain_after_exit: true
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"
```
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"
jobs:
num_pollers: 10
pipeline_size: 100000
pool:
num_workers: 10
max_jobs: 0
allocate_timeout: 60s
destroy_timeout: 60s
pipelines:
test-1:
driver: nats
prefetch: 100
subject: "default"
stream: "foo"
deliver_new: "true"
rate_limit: 100
delete_stream_on_stop: false
delete_after_ack: false
priority: 2
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).
- Driver uses the same endpoint (address) to send the response as specified in the configuration.
## π©Ή Fixes:
- π Fix: local and global configuration parsing.
- π Fix: `boltdb-jobs` connection left open after RPC close command.
- π Fix: close `beanstalk` connection and release associated resources after pipeline stopped.
- π Fix: grpc plugin fails to handle requests after calling `reset`.
- π Fix: superfluous response.WriteHeader call when connection is broken.
## π¦ Packages:
- π¦ roadrunner `v2.5.0`
- π¦ roadrunner-plugins `v2.5.0`
- π¦ roadrunner-temporal `v1.0.10`
- π¦ endure `v1.0.6`
- π¦ goridge `v3.2.3`
## v2.4.1 (13.09.2021)
## π©Ή 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.
## v2.4.0 (02.09.2021)
## π Internal BC:
- π¨ 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.
## π©Ή 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/roadrunner-server/roadrunner/issues/79).
## π¦ Packages:
- π¦ 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/roadrunner-server/roadrunner/milestone/10?closed=1)
---
## v2.3.2 (14.07.2021)
## π©Ή 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)
## π Summary:
- RR Milestone [2.3.2](https://github.com/spiral/roadrunner/milestone/31?closed=1)
---
## v2.3.1 (30.06.2021)
## π 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)
## π©Ή 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)
## π¦ Packages:
- π¦ 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)
---
## v2.3.0 (08.06.2021)
## π 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)
## π©Ή 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)
## π¦ Packages:
- π¦ Update goridge to `v3.1.0`
---
## v2.2.1 (13.05.2021)
## π©Ή 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.
---
## v2.2.0 (11.05.2021)
## π 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`.
### Option `always` was deleted from the plugin.
- βοΈ 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).
---
## v2.1.1 (29.04.2021)
## π©Ή Fixes:
- π 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.
## π©Ή 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`.
## 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.
## π©Ή Fixes:
- π 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.
## 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.
## 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.
## 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.
## 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.
## 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)
## 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
|