Skip to content

Commit ff7f251

Browse files
viktorklangviktorklang
committed
WIP of release notes
1 parent c3b2c6d commit ff7f251

File tree

1 file changed

+144
-1
lines changed

1 file changed

+144
-1
lines changed

‎RELEASE-NOTES.md

+144-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,146 @@
11
# Release notes for Reactive Streams
22

3-
Changes will be listed below after version 1.0.0 is released.
3+
---
4+
5+
# Version 1.0.1 released on YYYY-MM-DD
6+
7+
After more than two years since 1.0.0, we are proud to announce the immediate availability of `Reactive Streams version 1.0.1-RC1`.
8+
9+
## Highlights:
10+
11+
- Specification
12+
+ A new [Glossary](https://github.com/reactive-streams/reactive-streams-jvm/blob/v1.0.1-RC1/README.md#glossary) section
13+
+ Description of the intent behind every single rule
14+
+ No breaking semantical changes
15+
+ Multiple rule [clarifications](#specification-clarifications)
16+
- Interfaces
17+
+ No changes
18+
+ Improved JavaDoc
19+
- TCK
20+
+ Improved coverage
21+
+ Improved JavaDoc
22+
+ Multiple test [alterations](#tck-alterations)
23+
- New contributors since 1.0.0
24+
+ @briantopping
25+
+ @rstoyanchev
26+
+ @BjornHamels
27+
+ @JakeWharton
28+
+ @anthonyvdotbe
29+
+ @seratch
30+
+ @akarnokd
31+
+ @egetman
32+
33+
## Specification clarifications
34+
35+
## Publisher Rule 1
36+
37+
**1.0.0:** The total number of onNext signals sent by a Publisher to a Subscriber MUST be less than or equal to the total number of elements requested by that Subscriber´s Subscription at all times.
38+
39+
**1.0.1:** The total number of onNext´s signalled by a Publisher to a Subscriber MUST be less than or equal to the total number of elements requested by that Subscriber´s Subscription at all times.
40+
41+
**Comment: Minor spelling update.**
42+
43+
## Publisher Rule 2
44+
45+
**1.0.0:** A Publisher MAY signal less onNext than requested and terminate the Subscription by calling onComplete or onError.
46+
47+
**1.0.1:** A Publisher MAY signal fewer onNext than requested and terminate the Subscription by calling onComplete or onError.
48+
49+
**Comment: Minor spelling update.**
50+
51+
## Publisher Rule 3
52+
53+
**1.0.0:** onSubscribe, onNext, onError and onComplete signaled to a Subscriber MUST be signaled sequentially (no concurrent notifications).
54+
55+
**1.0.1:** onSubscribe, onNext, onError and onComplete signaled to a Subscriber MUST be signaled in a thread-safe manner—and if performed by multiple threads—use external synchronization.
56+
57+
**Comment: Reworded the part about sequential signal and its implications, for clarity.**
58+
59+
## Subscriber Rule 6
60+
61+
**1.0.0:** A Subscriber MUST call Subscription.cancel() if it is no longer valid to the Publisher without the Publisher having signaled onError or onComplete.
62+
63+
**1.0.1:** A Subscriber MUST call Subscription.cancel() if the Subscription is no longer needed.
64+
65+
**Comment: Rule could be reworded since it now has an intent section describing desired effect.**
66+
67+
## Subscriber Rule 11
68+
69+
**1.0.0:** A Subscriber MUST make sure that all calls on its onXXX methods happen-before [1] the processing of the respective signals. I.e. the Subscriber must take care of properly publishing the signal to its processing logic.
70+
71+
**1.0.1:** A Subscriber MUST make sure that all calls on its signal methods happen-before the processing of the respective signals. I.e. the Subscriber must take care of properly publishing the signal to its processing logic.
72+
73+
**Comment: Rule slightly reworded to use the glossary for `signal` instead of the more *ad-hoc* name "onXXX methods". Footnote was reworked into the Intent-section of the rule.**
74+
75+
## Subscription Rule 1
76+
77+
**1.0.0:** Subscription.request and Subscription.cancel MUST only be called inside of its Subscriber context. A Subscription represents the unique relationship between a Subscriber and a Publisher [see 2.12].
78+
79+
**1.0.1:** Subscription.request and Subscription.cancel MUST only be called inside of its Subscriber context.
80+
81+
**Comment: Second part of rule moved into the Intent-section of the rule.**
82+
83+
## Subscription Rule 3
84+
85+
**1.0.0:** Subscription.request MUST place an upper bound on possible synchronous recursion between Publisher and Subscriber[1].
86+
87+
**1.0.1:** Subscription.request MUST place an upper bound on possible synchronous recursion between Publisher and Subscriber.
88+
89+
**Comment: Footnote reworked into the Intent-section of the rule.**
90+
91+
## Subscription Rule 4
92+
93+
**1.0.0:** Subscription.request SHOULD respect the responsivity of its caller by returning in a timely manner[2].
94+
95+
**1.0.1:** Subscription.request SHOULD respect the responsivity of its caller by returning in a timely manner.
96+
97+
**Comment: Footnote reworked into the Intent-section of the rule.**
98+
99+
## Subscription Rule 5
100+
101+
**1.0.0:** Subscription.cancel MUST respect the responsivity of its caller by returning in a timely manner[2], MUST be idempotent and MUST be thread-safe.
102+
103+
**1.0.1:** Subscription.cancel MUST respect the responsivity of its caller by returning in a timely manner, MUST be idempotent and MUST be thread-safe.
104+
105+
**Comment: Footnote reworked into the Intent-section of the rule.**
106+
107+
## Subscription Rule 13
108+
109+
**1.0.0:** While the Subscription is not cancelled, Subscription.cancel() MUST request the Publisher to eventually drop any references to the corresponding subscriber. Re-subscribing with the same Subscriber object is discouraged [see 2.12], but this specification does not mandate that it is disallowed since that would mean having to store previously cancelled subscriptions indefinitely.
110+
111+
**1.0.1:** While the Subscription is not cancelled, Subscription.cancel() MUST request the Publisher to eventually drop any references to the corresponding subscriber.
112+
113+
**Comment: Second part of rule reworked into the Intent-section of the rule.**
114+
115+
## Subscription Rule 15
116+
117+
**1.0.0:** Calling Subscription.cancel MUST return normally. The only legal way to signal failure to a Subscriber is via the onError method.
118+
119+
**1.0.1:** Calling Subscription.cancel MUST return normally.
120+
121+
**Comment: Replaced second part of rule with a definition for `return normally` in the glossary.**
122+
123+
## Subscription Rule 16
124+
125+
**1.0.0:** Calling Subscription.request MUST return normally. The only legal way to signal failure to a Subscriber is via the onError method.
126+
127+
**1.0.1:** Calling Subscription.request MUST return normally.
128+
129+
**Comment: Replaced second part of rule with a definition for `return normally` in the glossary.**
130+
131+
## Subscription Rule 17
132+
133+
**1.0.0:** A Subscription MUST support an unbounded number of calls to request and MUST support a demand (sum requested - sum delivered) up to 2^63-1 (java.lang.Long.MAX_VALUE). A demand equal or greater than 2^63-1 (java.lang.Long.MAX_VALUE) MAY be considered by the Publisher as “effectively unbounded”[3].
134+
135+
**1.0.1:** A Subscription MUST support an unbounded number of calls to request and MUST support a demand up to 2^63-1 (java.lang.Long.MAX_VALUE). A demand equal or greater than 2^63-1 (java.lang.Long.MAX_VALUE) MAY be considered by the Publisher as “effectively unbounded”.
136+
137+
**Comment: Rule simplified by defining `demand` in the glossary, and footnote was reworked into the Intent-section of the rule.**
138+
139+
---
140+
141+
## TCK alterations
142+
143+
- Fixed potential resource leaks in partially consuming Publisher tests
144+
- Fixed potential resource leaks in partially emitting Subscriber tests
145+
- Renamed `untested_spec305_cancelMustNotSynchronouslyPerformHeavyCompuatation` to `untested_spec305_cancelMustNotSynchronouslyPerformHeavyComputation` (typo)
146+
---

0 commit comments

Comments
 (0)