Generic Caching class For RxSwift












0














The latest version of the class can always be found at: https://gist.github.com/dtartaglia/bf24b3b59dd33fef4cfa568d0e47f91b



Did I miss anything? Is there anything I can do to make the code more lean or more reusable? Ideas for better names?



//
// RxCache.swift
//
// Created by Daniel Tartaglia on 12/20/18.
// Copyright © 2018 Daniel Tartaglia. MIT License.
//

import RxSwift

final class Cache<Key: Hashable, State> {
init(qos: DispatchQoS, source: @escaping (Key) -> Single<State>) {
scheduler = SerialDispatchQueueScheduler(qos: qos)
getState = source
}

func data(for key: Key) -> Single<State> {
lock.lock(); defer { lock.unlock() }
guard let state = cache[key] else {
let state = ReplaySubject<State>.create(bufferSize: 1)
getState(key)
.observeOn(scheduler)
.subscribe(
onSuccess: { state.onNext($0) },
onError: { [weak self] _ in
guard let this = self else { return }
this.lock.lock(); defer { this.lock.unlock() }
this.cache.removeValue(forKey: key)
}
)
.disposed(by: bag)
cache[key] = state
return state.asSingle()
}

return state.asSingle()
}

private var cache: [Key: ReplaySubject<State>] = [:]
private let scheduler: SerialDispatchQueueScheduler
private let lock = NSRecursiveLock()
private let getState: (Key) -> Single<State>
private let bag = DisposeBag()
}


The scheduler exists because Subjects aren't thread safe and I have no way of knowing what thread getData might be emitting on.



The lock exists because I don't want to create multiple responses for the same key in the event that the date(for:) method is called from multiple threads.



I added code to handle errors. Errors don't exit the class but they do remove the cache object so the next attempt will create a new ReplaySubject.










share|improve this question





























    0














    The latest version of the class can always be found at: https://gist.github.com/dtartaglia/bf24b3b59dd33fef4cfa568d0e47f91b



    Did I miss anything? Is there anything I can do to make the code more lean or more reusable? Ideas for better names?



    //
    // RxCache.swift
    //
    // Created by Daniel Tartaglia on 12/20/18.
    // Copyright © 2018 Daniel Tartaglia. MIT License.
    //

    import RxSwift

    final class Cache<Key: Hashable, State> {
    init(qos: DispatchQoS, source: @escaping (Key) -> Single<State>) {
    scheduler = SerialDispatchQueueScheduler(qos: qos)
    getState = source
    }

    func data(for key: Key) -> Single<State> {
    lock.lock(); defer { lock.unlock() }
    guard let state = cache[key] else {
    let state = ReplaySubject<State>.create(bufferSize: 1)
    getState(key)
    .observeOn(scheduler)
    .subscribe(
    onSuccess: { state.onNext($0) },
    onError: { [weak self] _ in
    guard let this = self else { return }
    this.lock.lock(); defer { this.lock.unlock() }
    this.cache.removeValue(forKey: key)
    }
    )
    .disposed(by: bag)
    cache[key] = state
    return state.asSingle()
    }

    return state.asSingle()
    }

    private var cache: [Key: ReplaySubject<State>] = [:]
    private let scheduler: SerialDispatchQueueScheduler
    private let lock = NSRecursiveLock()
    private let getState: (Key) -> Single<State>
    private let bag = DisposeBag()
    }


    The scheduler exists because Subjects aren't thread safe and I have no way of knowing what thread getData might be emitting on.



    The lock exists because I don't want to create multiple responses for the same key in the event that the date(for:) method is called from multiple threads.



    I added code to handle errors. Errors don't exit the class but they do remove the cache object so the next attempt will create a new ReplaySubject.










    share|improve this question



























      0












      0








      0







      The latest version of the class can always be found at: https://gist.github.com/dtartaglia/bf24b3b59dd33fef4cfa568d0e47f91b



      Did I miss anything? Is there anything I can do to make the code more lean or more reusable? Ideas for better names?



      //
      // RxCache.swift
      //
      // Created by Daniel Tartaglia on 12/20/18.
      // Copyright © 2018 Daniel Tartaglia. MIT License.
      //

      import RxSwift

      final class Cache<Key: Hashable, State> {
      init(qos: DispatchQoS, source: @escaping (Key) -> Single<State>) {
      scheduler = SerialDispatchQueueScheduler(qos: qos)
      getState = source
      }

      func data(for key: Key) -> Single<State> {
      lock.lock(); defer { lock.unlock() }
      guard let state = cache[key] else {
      let state = ReplaySubject<State>.create(bufferSize: 1)
      getState(key)
      .observeOn(scheduler)
      .subscribe(
      onSuccess: { state.onNext($0) },
      onError: { [weak self] _ in
      guard let this = self else { return }
      this.lock.lock(); defer { this.lock.unlock() }
      this.cache.removeValue(forKey: key)
      }
      )
      .disposed(by: bag)
      cache[key] = state
      return state.asSingle()
      }

      return state.asSingle()
      }

      private var cache: [Key: ReplaySubject<State>] = [:]
      private let scheduler: SerialDispatchQueueScheduler
      private let lock = NSRecursiveLock()
      private let getState: (Key) -> Single<State>
      private let bag = DisposeBag()
      }


      The scheduler exists because Subjects aren't thread safe and I have no way of knowing what thread getData might be emitting on.



      The lock exists because I don't want to create multiple responses for the same key in the event that the date(for:) method is called from multiple threads.



      I added code to handle errors. Errors don't exit the class but they do remove the cache object so the next attempt will create a new ReplaySubject.










      share|improve this question















      The latest version of the class can always be found at: https://gist.github.com/dtartaglia/bf24b3b59dd33fef4cfa568d0e47f91b



      Did I miss anything? Is there anything I can do to make the code more lean or more reusable? Ideas for better names?



      //
      // RxCache.swift
      //
      // Created by Daniel Tartaglia on 12/20/18.
      // Copyright © 2018 Daniel Tartaglia. MIT License.
      //

      import RxSwift

      final class Cache<Key: Hashable, State> {
      init(qos: DispatchQoS, source: @escaping (Key) -> Single<State>) {
      scheduler = SerialDispatchQueueScheduler(qos: qos)
      getState = source
      }

      func data(for key: Key) -> Single<State> {
      lock.lock(); defer { lock.unlock() }
      guard let state = cache[key] else {
      let state = ReplaySubject<State>.create(bufferSize: 1)
      getState(key)
      .observeOn(scheduler)
      .subscribe(
      onSuccess: { state.onNext($0) },
      onError: { [weak self] _ in
      guard let this = self else { return }
      this.lock.lock(); defer { this.lock.unlock() }
      this.cache.removeValue(forKey: key)
      }
      )
      .disposed(by: bag)
      cache[key] = state
      return state.asSingle()
      }

      return state.asSingle()
      }

      private var cache: [Key: ReplaySubject<State>] = [:]
      private let scheduler: SerialDispatchQueueScheduler
      private let lock = NSRecursiveLock()
      private let getState: (Key) -> Single<State>
      private let bag = DisposeBag()
      }


      The scheduler exists because Subjects aren't thread safe and I have no way of knowing what thread getData might be emitting on.



      The lock exists because I don't want to create multiple responses for the same key in the event that the date(for:) method is called from multiple threads.



      I added code to handle errors. Errors don't exit the class but they do remove the cache object so the next attempt will create a new ReplaySubject.







      swift rx-swift






      share|improve this question















      share|improve this question













      share|improve this question




      share|improve this question








      edited Dec 22 at 0:58

























      asked Dec 20 at 14:40









      Daniel T.

      521313




      521313



























          active

          oldest

          votes











          Your Answer





          StackExchange.ifUsing("editor", function () {
          return StackExchange.using("mathjaxEditing", function () {
          StackExchange.MarkdownEditor.creationCallbacks.add(function (editor, postfix) {
          StackExchange.mathjaxEditing.prepareWmdForMathJax(editor, postfix, [["\$", "\$"]]);
          });
          });
          }, "mathjax-editing");

          StackExchange.ifUsing("editor", function () {
          StackExchange.using("externalEditor", function () {
          StackExchange.using("snippets", function () {
          StackExchange.snippets.init();
          });
          });
          }, "code-snippets");

          StackExchange.ready(function() {
          var channelOptions = {
          tags: "".split(" "),
          id: "196"
          };
          initTagRenderer("".split(" "), "".split(" "), channelOptions);

          StackExchange.using("externalEditor", function() {
          // Have to fire editor after snippets, if snippets enabled
          if (StackExchange.settings.snippets.snippetsEnabled) {
          StackExchange.using("snippets", function() {
          createEditor();
          });
          }
          else {
          createEditor();
          }
          });

          function createEditor() {
          StackExchange.prepareEditor({
          heartbeatType: 'answer',
          autoActivateHeartbeat: false,
          convertImagesToLinks: false,
          noModals: true,
          showLowRepImageUploadWarning: true,
          reputationToPostImages: null,
          bindNavPrevention: true,
          postfix: "",
          imageUploader: {
          brandingHtml: "Powered by u003ca class="icon-imgur-white" href="https://imgur.com/"u003eu003c/au003e",
          contentPolicyHtml: "User contributions licensed under u003ca href="https://creativecommons.org/licenses/by-sa/3.0/"u003ecc by-sa 3.0 with attribution requiredu003c/au003e u003ca href="https://stackoverflow.com/legal/content-policy"u003e(content policy)u003c/au003e",
          allowUrls: true
          },
          onDemand: true,
          discardSelector: ".discard-answer"
          ,immediatelyShowMarkdownHelp:true
          });


          }
          });














          draft saved

          draft discarded


















          StackExchange.ready(
          function () {
          StackExchange.openid.initPostLogin('.new-post-login', 'https%3a%2f%2fcodereview.stackexchange.com%2fquestions%2f210054%2fgeneric-caching-class-for-rxswift%23new-answer', 'question_page');
          }
          );

          Post as a guest















          Required, but never shown






























          active

          oldest

          votes













          active

          oldest

          votes









          active

          oldest

          votes






          active

          oldest

          votes
















          draft saved

          draft discarded




















































          Thanks for contributing an answer to Code Review Stack Exchange!


          • Please be sure to answer the question. Provide details and share your research!

          But avoid



          • Asking for help, clarification, or responding to other answers.

          • Making statements based on opinion; back them up with references or personal experience.


          Use MathJax to format equations. MathJax reference.


          To learn more, see our tips on writing great answers.





          Some of your past answers have not been well-received, and you're in danger of being blocked from answering.


          Please pay close attention to the following guidance:


          • Please be sure to answer the question. Provide details and share your research!

          But avoid



          • Asking for help, clarification, or responding to other answers.

          • Making statements based on opinion; back them up with references or personal experience.


          To learn more, see our tips on writing great answers.




          draft saved


          draft discarded














          StackExchange.ready(
          function () {
          StackExchange.openid.initPostLogin('.new-post-login', 'https%3a%2f%2fcodereview.stackexchange.com%2fquestions%2f210054%2fgeneric-caching-class-for-rxswift%23new-answer', 'question_page');
          }
          );

          Post as a guest















          Required, but never shown





















































          Required, but never shown














          Required, but never shown












          Required, but never shown







          Required, but never shown

































          Required, but never shown














          Required, but never shown












          Required, but never shown







          Required, but never shown







          Popular posts from this blog

          Terni

          A new problem with tex4ht and tikz

          Sun Ra