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
use crate::observer::{
  complete_proxy_impl, error_proxy_impl, is_stopped_proxy_impl,
};
use crate::prelude::*;
use std::cell::RefCell;
use std::rc::Rc;
use std::sync::{Arc, Mutex};

////////////////////////////////////////////////////////////////////////////////

#[derive(Clone)]
/// Operator to merge Observables
pub struct FlattenOp<S, Inner> {
  pub(crate) source: S,
  pub(crate) marker: std::marker::PhantomData<Inner>,
}

impl<Outer, Inner, Item, Err> Observable for FlattenOp<Outer, Inner>
where
  Outer: Observable<Item = Inner, Err = Err>,
  Inner: Observable<Item = Item, Err = Err>,
{
  type Item = Item;
  type Err = Err;
}

////////////////////////////////////////////////////////////////////////////////

/// Keeps track of how many observables are being observed at any point in time.
///
/// Because we are subscribed to an Observable of Observables we need to keep
/// track of every new Observable that is emitted from the source Observable.
pub struct FlattenState {
  total: u64,
  done: u64,
  is_completed: bool,
}

impl FlattenState {
  /// Creates a new state for a Flatten operator.
  #[inline]
  pub fn new() -> Self { Self::default() }

  /// Indicates if a completion of emissions has been detected. This happens
  /// when the number of new Observables is the same as the number of
  /// completed Observables.
  pub fn is_completed(&self) -> bool { self.is_completed }

  /// Records the registration of a new Observable.
  pub fn register_new_observable(&mut self) {
    if self.is_completed {
      return;
    }

    self.total += 1;
  }

  /// Records the signaling of an error from any registered Observable.
  pub fn register_observable_error(&mut self) -> bool {
    if self.is_completed {
      // signal not to register error on observer, as it was completed already
      false
    } else {
      // ensure to complete the state machine and signal the observer should
      // receive an error call
      self.is_completed = true;
      true
    }
  }

  /// Records the signaling of completion from any registered Observable.
  pub fn register_observable_completed(&mut self) -> bool {
    if self.is_completed {
      // return signal to not complete observer, as it has been already
      // completed
      return false;
    }

    self.done += 1;

    if self.total == self.done {
      self.is_completed = true;
      // report signal to complete observer
      true
    } else {
      // report signal to not complete observer
      false
    }
  }
}

impl Default for FlattenState {
  fn default() -> Self {
    FlattenState {
      // when this record is created, we are subscribing to an observable of
      // observables, so it must be accounted for from the get-go
      total: 1,
      done: 0,
      is_completed: false,
    }
  }
}

////////////////////////////////////////////////////////////////////////////////
// Inner observer

#[derive(Clone)]
/// This is an `Observer` for items of an `Observable` that is emitted from a
/// parent `Observable`.
pub struct FlattenInnerObserver<O, S, St> {
  observer: O,
  subscription: S,
  state: St,
}

impl<O, S, St, Item, Err> Observer for FlattenInnerObserver<O, S, St>
where
  O: Observer<Item = Item, Err = Err>,
  S: SubscriptionLike,
  St: InnerDerefMut<Target = FlattenState>,
{
  type Item = Item;
  type Err = Err;

  fn next(&mut self, item: Self::Item) {
    let state = self.state.inner_deref();
    let is_completed = state.is_completed;
    drop(state);

    if !is_completed {
      self.observer.next(item);
    }
  }

  fn error(&mut self, err: Self::Err) {
    let mut state = self.state.inner_deref_mut();
    let should_error = state.register_observable_error();
    drop(state);

    if should_error {
      self.observer.error(err);
      self.subscription.unsubscribe();
    }
  }

  fn complete(&mut self) {
    let mut state = self.state.inner_deref_mut();
    let should_complete = state.register_observable_completed();
    drop(state);

    if should_complete {
      self.observer.complete();
      self.subscription.unsubscribe();
    }
  }

  fn is_stopped(&self) -> bool {
    let state = self.state.inner_deref();
    state.is_completed()
  }
}

////////////////////////////////////////////////////////////////////////////////
// shared

type SharedInnerObserver<O> =
  FlattenInnerObserver<O, SharedSubscription, Arc<Mutex<FlattenState>>>;

#[derive(Clone)]
/// This is an `Observer` for `Observable` values that get emitted by an
/// `Observable` that works on a shared environment.
pub struct FlattenSharedOuterObserver<Inner, O> {
  marker: std::marker::PhantomData<Inner>,
  inner_observer: Arc<Mutex<SharedInnerObserver<O>>>,
  subscription: SharedSubscription,
  state: Arc<Mutex<FlattenState>>,
}

impl<Inner, O, Item, Err> Observer for FlattenSharedOuterObserver<Inner, O>
where
  O: Observer<Item = Item, Err = Err> + Sync + Send + 'static,
  Inner: SharedObservable<Item = Item, Err = Err, Unsub = SharedSubscription>,
{
  type Item = Inner;
  type Err = Err;

  fn next(&mut self, value: Inner) {
    // increase count of registered Observables to keep track
    // of observable completion
    let mut state = self.state.lock().unwrap();
    state.register_new_observable();
    drop(state);

    self.subscription.add(value.actual_subscribe(Subscriber {
      observer: self.inner_observer.clone(),
      subscription: SharedSubscription::default(),
    }));
  }

  error_proxy_impl!(Err, inner_observer);

  complete_proxy_impl!(inner_observer);

  is_stopped_proxy_impl!(inner_observer);
}

impl<Outer, Inner, Item, Err> SharedObservable for FlattenOp<Outer, Inner>
where
  Outer: SharedObservable<Item = Inner, Err = Err>,
  Outer::Unsub: Send + Sync,
  Inner: SharedObservable<Item = Item, Err = Err, Unsub = SharedSubscription>
    + Send
    + Sync
    + 'static,
{
  type Unsub = SharedSubscription;

  fn actual_subscribe<O>(
    self,
    subscriber: Subscriber<O, SharedSubscription>,
  ) -> Self::Unsub
  where
    O: Observer<Item = Self::Item, Err = Self::Err> + Sync + Send + 'static,
  {
    let state = Arc::new(Mutex::new(FlattenState::new()));

    let subscription = subscriber.subscription;

    let inner_observer = Arc::new(Mutex::new(FlattenInnerObserver {
      observer: subscriber.observer,
      subscription: subscription.clone(),
      state: state.clone(),
    }));

    let observer = FlattenSharedOuterObserver {
      marker: std::marker::PhantomData::<Inner>,
      inner_observer,
      subscription: subscription.clone(),
      state,
    };

    subscription
      .add(self.source.actual_subscribe(Subscriber::shared(observer)));

    subscription
  }
}

////////////////////////////////////////////////////////////////////////////////
// local

type LocalInnerObserver<O> =
  FlattenInnerObserver<O, LocalSubscription, Rc<RefCell<FlattenState>>>;

#[derive(Clone)]
/// This is an `Observer` for `Observable` values that get emitted by an
/// `Observable` that works on a local environment.
pub struct FlattenLocalOuterObserver<Inner, O> {
  marker: std::marker::PhantomData<Inner>,
  inner_observer: Rc<RefCell<LocalInnerObserver<O>>>,
  subscription: LocalSubscription,
  state: Rc<RefCell<FlattenState>>,
}

impl<'a, Inner, O, Item, Err> Observer for FlattenLocalOuterObserver<Inner, O>
where
  O: Observer<Item = Item, Err = Err> + 'a,
  Inner: LocalObservable<'a, Item = Item, Err = Err, Unsub = LocalSubscription>,
{
  type Item = Inner;
  type Err = Err;

  fn next(&mut self, value: Inner) {
    let mut state = self.state.borrow_mut();
    state.register_new_observable();
    drop(state);

    self.subscription.add(
      value.actual_subscribe(Subscriber::local(self.inner_observer.clone())),
    );
  }

  error_proxy_impl!(Err, inner_observer);

  complete_proxy_impl!(inner_observer);

  is_stopped_proxy_impl!(inner_observer);
}

impl<'a, Outer, Inner, Item, Err> LocalObservable<'a>
  for FlattenOp<Outer, Inner>
where
  Outer: LocalObservable<'a, Item = Inner, Err = Err>,
  Inner:
    LocalObservable<'a, Item = Item, Err = Err, Unsub = LocalSubscription> + 'a,
{
  type Unsub = LocalSubscription;

  fn actual_subscribe<O>(
    self,
    subscriber: Subscriber<O, LocalSubscription>,
  ) -> Self::Unsub
  where
    O: Observer<Item = Self::Item, Err = Self::Err> + 'a,
  {
    let state = Rc::new(RefCell::new(FlattenState::new()));

    let subscription = subscriber.subscription;

    let inner_observer = Rc::new(RefCell::new(FlattenInnerObserver {
      observer: subscriber.observer,
      subscription: subscription.clone(),
      state: state.clone(),
    }));

    let observer = FlattenLocalOuterObserver {
      marker: std::marker::PhantomData::<Inner>,
      inner_observer,
      subscription: subscription.clone(),
      state,
    };

    subscription.add(self.source.actual_subscribe(Subscriber::local(observer)));

    subscription
  }
}

////////////////////////////////////////////////////////////////////////////////

#[cfg(test)]
mod test {
  extern crate test;
  use crate::prelude::*;
  use std::sync::{
    atomic::{AtomicBool, Ordering},
    Arc, Mutex,
  };
  use test::Bencher;

  #[test]
  fn odd_even_flatten() {
    let mut odd_store = vec![];
    let mut even_store = vec![];
    let mut numbers_store = vec![];

    {
      let mut sources = Subject::new();

      let numbers = sources.clone().flatten();
      let odd = numbers.clone().filter(|v: &i32| *v % 2 != 0);
      let even = numbers.clone().filter(|v: &i32| *v % 2 == 0);

      numbers.subscribe(|v: i32| numbers_store.push(v));
      odd.subscribe(|v: i32| odd_store.push(v));
      even.subscribe(|v: i32| even_store.push(v));

      (0..10).for_each(|v| {
        let source = observable::of(v);
        sources.next(source);
      });
    }

    assert_eq!(even_store, vec![0, 2, 4, 6, 8]);
    assert_eq!(odd_store, vec![1, 3, 5, 7, 9]);
    assert_eq!(numbers_store, (0..10).collect::<Vec<_>>());
  }

  #[test]
  fn flatten_unsubscribe_work() {
    let mut source = Subject::new();

    let sources = source.clone().map(|v| observable::from_iter(vec![v]));
    let numbers = sources.flatten();
    // enabling multiple observers for even stream;
    let _even = numbers.clone().filter(|v| *v % 2 == 0);
    // enabling multiple observers for odd stream;
    let _odd = numbers.clone().filter(|v| *v % 2 != 0);

    numbers
      .subscribe(|_| unreachable!("oh, unsubscribe does not work."))
      .unsubscribe();

    source.next(&1);
  }

  #[test]
  fn flatten_completed_test() {
    let completed = Arc::new(AtomicBool::new(false));
    let c_clone = completed.clone();

    let mut source = Subject::new();
    let mut one = Subject::new();
    let mut two = Subject::new();

    let out = source.clone().flatten();

    // we need to subscribe to out first to keep track of the
    // events from source
    out.subscribe_complete(
      |_: &()| {},
      move || {
        println!("subscribe_complete complete callback done");
        completed.store(true, Ordering::Relaxed);
      },
    );

    source.next(one.clone());
    source.next(two.clone());

    one.complete();
    assert!(!c_clone.load(Ordering::Relaxed));

    two.complete();
    assert!(!c_clone.load(Ordering::Relaxed));

    source.complete();
    assert!(c_clone.load(Ordering::Relaxed));
  }

  #[test]
  fn flatten_error_test() {
    let completed = Arc::new(Mutex::new(0));
    let cc = completed.clone();

    let error = Arc::new(Mutex::new(0));
    let ec = error.clone();

    let mut source = Subject::new();
    let mut even = Subject::new();
    let mut odd = Subject::new();

    let output = source.clone().flatten();

    output.subscribe_all(
      |_: ()| {},
      move |_| *error.lock().unwrap() += 1,
      move || *completed.lock().unwrap() += 1,
    );

    source.next(even.clone());
    source.next(odd.clone());

    odd.error("");
    even.error("");
    even.complete();

    // if error occur, stream terminated.
    assert_eq!(*cc.lock().unwrap(), 0);
    // error should be hit just once
    assert_eq!(*ec.lock().unwrap(), 1);
  }

  #[test]
  fn flatten_local_and_shared() {
    let mut res = vec![];

    let mut source = Subject::new();
    let local1 = observable::of(1);
    let local2 = observable::of(2);

    let shared = source.clone().flatten().into_shared();

    shared.subscribe(move |v: i32| {
      res.push(v);
    });

    source.next(local1);
    source.next(local2);
  }

  #[bench]
  fn bench_flatten(b: &mut Bencher) { b.iter(odd_even_flatten); }
}