Slide 1

Slide 1 text

Elm Architecture in Swift 2017/05/08-09 MCE Conf #MCE2017 Yasuhiro Inami / @inamiy

Slide 2

Slide 2 text

No content

Slide 3

Slide 3 text

Architecture

Slide 4

Slide 4 text

No content

Slide 5

Slide 5 text

No content

Slide 6

Slide 6 text

No content

Slide 7

Slide 7 text

No content

Slide 8

Slide 8 text

No content

Slide 9

Slide 9 text

Modern iOS Architectures • MVC, MVP, MVVM, MV* (whatever) • Clean Architecture • VIPER (View-Interactor-Presenter-Entity-Routing) • Why separate layers? • Less dependency (code reusability, testability) • For our understandings (sharing design philosophy)

Slide 10

Slide 10 text

GUI first

Slide 11

Slide 11 text

Layer Ownership • UIApplicationMain → AppDelegate • AppDelegate → Window → View(Controller) • View → Presenter (or ViewModel) • Presenter → UseCase (or Interactor) • UseCase → Repository → DataStore → Entity • Presenter → Wireframe (or Router)

Slide 12

Slide 12 text

App → View View → Model

Slide 13

Slide 13 text

View → Model

Slide 14

Slide 14 text

☠ → Model

Slide 15

Slide 15 text

☠ → ☠

Slide 16

Slide 16 text

☠ → ☠ ← View

Slide 17

Slide 17 text

No content

Slide 18

Slide 18 text

Multiple owners? protocol MyModelProtocol { ... } class MyView: UIView { let model: MyModelProtocol let subview: MySubView init(model: MyModelProtocol) { self.model = model // retained by ARC self.subview = MySubView(model: model) // pass model ... } } let model = MyModel(...) let view1 = MyView1(model: model) // pass model let view2 = MyView2(model: model) // pass model ... // pass, pass, pass... (manually)

Slide 19

Slide 19 text

class MyView: UIView, NibLoadable { // using Interface Builder var model: MyModelProtocol? { // optional + `var` didSet { self.subview.model = model // pass model via setter } } private(set) var subview: MySubView? // optional + `var` override func awakeFromNib() { super.awakeFromNib() self.subview = MySubView.loadFromNib() ... } } let model = MyModel(...) let view1 = MyView1.loadFromNib() view1.model = model // pass model via setter ... // pass, pass, pass...

Slide 20

Slide 20 text

No content

Slide 21

Slide 21 text

Let it be singleton? class GodModel { static let shared = GodModel() // lives forever } class MyView: UIView { // no `let model` override init() { // no arguments super.init() self.subview = MySubview() print(GodModel.shared.message) // can call from anywhere } } let view = MyView() // no arguments to pass

Slide 22

Slide 22 text

No content

Slide 23

Slide 23 text

View → Model

Slide 24

Slide 24 text

View1 → Model1 View2 → Model2 View3 → Model3 View4 → Model4 View5 → Model5

Slide 25

Slide 25 text

View1 <~> Model1 View2 <~> Model2 View3 <~> Model3 View4 <~> Model4 View5 <~> Model5

Slide 26

Slide 26 text

Model1 ~> (Web API) ~> Model2 Model2 ~> (Database) ~> Model3 Model3 + Model4 ~> (Calculation) ~> Model5

Slide 27

Slide 27 text

Model1 ~> (Web API) ~> Model2 Model2 ~> (Database) ~> Model3 Model3 + Model4 ~> (Calculation) ~> Model5 ... Model6 ~> (Web API) ~> Model7 Model8 ~> (Database) ~> Model9 Model9 + Model10 ~> (Calculation) ~> Model11 ... Model101 ~> (Web API) ~> Model102 Model102 ~> (Database) ~> Model103 Model103 + Model104 ~> (Calculation) ~> Model105 ... Model1001 ~> (Web API) ~> Model1002 Model1002 ~> (Database) ~> Model1003 Model1003 + Model1004 ~> (Calculation) ~> ... ...

Slide 28

Slide 28 text

No content

Slide 29

Slide 29 text

No content

Slide 30

Slide 30 text

App → View View → Model

Slide 31

Slide 31 text

App → View App → Model

Slide 32

Slide 32 text

App → View App → Model

Slide 33

Slide 33 text

! let model = view.model

Slide 34

Slide 34 text

! let model = app.model

Slide 35

Slide 35 text

! let model = app.model let view = app.render(model)

Slide 36

Slide 36 text

Model comes first View comes secondary

Slide 37

Slide 37 text

React

Slide 38

Slide 38 text

No content

Slide 39

Slide 39 text

No content

Slide 40

Slide 40 text

No content

Slide 41

Slide 41 text

No content

Slide 42

Slide 42 text

Redux

Slide 43

Slide 43 text

No content

Slide 44

Slide 44 text

React + Redux • React: Renders view in replace of stateful DOM • Virtual DOM: Efficient diff-patch algorithm • Redux: Singleton state container • Reducer: State transition using pure function • Middleware: Generates side-effect • Action, Reducer, and Middleware defines app's domain • Popular as a functional programming approach

Slide 45

Slide 45 text

No content

Slide 46

Slide 46 text

React Native ReactXP

Slide 47

Slide 47 text

No content

Slide 48

Slide 48 text

Elm

Slide 49

Slide 49 text

Elm • Functional programming language for web app • Generates HTML/CSS/JavaScript • Purely functional, static typing, strict evaluation • No typeclass (protocol) nor FRP = easy to understand • Uses Virtual DOM & Effect Manager • Unidirectional dataflow known as Elm Architecture

Slide 50

Slide 50 text

No content

Slide 51

Slide 51 text

Model View Update

Slide 52

Slide 52 text

main = Html.beginnerProgram { model = 0, view = view, update = update } type Msg = Increment | Decrement update msg model = case msg of Increment -> model + 1 Decrement -> model - 1 view model = div [] [ button [ onClick Decrement ] [ text "-" ] , div [] [ text (toString model) ] , button [ onClick Increment ] [ text "+" ] ]

Slide 53

Slide 53 text

Elm (V.S. React + Redux) • Elm's VirtualDOM doesn't... • own state (no setState) • manage lifecycle (no componentDidMount) • Redux is already built-in (Effect Manager) • Better effect handling inside pure "update (reducer)", not "middleware" • Typed (no propTypes validation)

Slide 54

Slide 54 text

Elm Architecture in iOS...? !

Slide 55

Slide 55 text

WKWebView JavaScriptCore

Slide 56

Slide 56 text

No content

Slide 57

Slide 57 text

let program = BeginnerProgram(model: 0, view: view, update: update) ... enum Msg { case increment, decrement } func update(msg: Msg, model: Model) -> Model { switch msg { case .increment: return model + 1 case .decrement: return model - 1 } } func view(model: Model) -> Html { return div(children: [ button(attributes: [onClick(.decrement)], children: [text("-")]), div(children: [text("\(model)")]), button(attributes: [onClick(.increment)], children: [text("+")]) ]) }

Slide 58

Slide 58 text

Requirements

Slide 59

Slide 59 text

Virtual DOM

Slide 60

Slide 60 text

No content

Slide 61

Slide 61 text

Diff & Patch

Slide 62

Slide 62 text

VTree https://github.com/inamiy/VTree

Slide 63

Slide 63 text

VTree • https://github.com/inamiy/VTree • VirtualDOM for UIKit • Inspired by Matt-Esch/virtual-dom • Diff & Patch • func diff(old: VTree, new: VTree) -> Patch • func apply(patch: Patch, to: UIView) -> UIView?

Slide 64

Slide 64 text

Example var model = 0 var tree = render(model) // virtual view var view = tree.createView() // real view timer(1) { model += 1 let newTree = render(model) let patch = diff(old: tree, new: newTree) view = apply(patch: patch, to: view) }

Slide 65

Slide 65 text

protocol VTree { associatedtype ViewType: View associatedtype MsgType: Message var key: Key? { get } // for efficient reordering var props: [String: Any] { get } // can be mapped by Mirror & KVC var propsKeysForMeasure: [String] { get } // for flexbox measurement var flexbox: Flexbox.Node? { get } // for view layout var handlers: HandlerMapping { get } // e.g. target-action var gestures: [GestureEvent] { get } var children: [AnyVTree] { get } func createView(_ msgMapper: @escaping (MsgType) -> Msg2) -> ViewType } class AnyVTree: VTree { ... } // type-erasure

Slide 66

Slide 66 text

Flexbox • inamiy/Flexbox • CSS Flexbox layout engine • Swift wrapper of facebook/yoga • Cross-platform, used in ReactNative • Originally from joshaber/SwiftBox • Can calculate asynchronously

Slide 67

Slide 67 text

State Machine (Automaton)

Slide 68

Slide 68 text

No content

Slide 69

Slide 69 text

State Machine • Manages app state (Model) and handles input (Msg) via state-transition function (update) that may include additional side-effect (Cmd) • That is, Mealy Machine (transducer) • A prototype of Redux since 1955 • Expressed as 6-tuple (Σ, Ω, S, s0, δ, λ)

Slide 70

Slide 70 text

Mealy Machine • Σ = Set of Inputs • Ω = Set of Outputs • S = Set of States • s0 = Initial state (s0 ∈ S) • δ = State transition function, δ: S x Σ → S • λ = Output function, λ: S x Σ → Ω

Slide 71

Slide 71 text

Elm works as Mealy Machine program : { init : (model, Cmd msg) , update : msg -> model -> (model, Cmd msg) , subscriptions : model -> Sub msg , view : model -> Html msg } -> Program Never model msg "update" has (almost) the same type as (Σ, S) -> (S, Ω)

Slide 72

Slide 72 text

Reactive / Rx Automaton inamiy/ReactiveAutomaton inamiy/RxAutomaton

Slide 73

Slide 73 text

ReactiveAutomaton • https://github.com/inamiy/ReactiveAutomaton • Uses ReactiveSwift (FRP) for easy event handling • Also have RxSwift version • Related Talks • iOSDC Japan 2016 (Japanese) • iOSConf SG 2016 (English)

Slide 74

Slide 74 text

Sample code (Login flow) • State: LoggedOut, LoggingIn, LoggedIn, LoggingOut • Input: Login, LoginOK, Logout, LogoutOK, ForceLogout

Slide 75

Slide 75 text

Sample code (Login flow) // 1. switch-case pattern matching let mapping: EffectMapping = { fromState, input in switch (fromState, input) { case (.loggedOut, .login): return (.loggingIn, loginOKProducer) case (.loggingIn, .loginOK): return (.loggedIn, .empty) case (.loggedIn, .logout): return (.loggingOut, logoutOKProducer) case (.loggingOut, .logoutOK): return (.loggedOut, .empty) case (.loggingIn, .forceLogout), (.loggedIn, .forceLogout): return (.loggingOut, forceLogoutOKProducer) default: return nil } }

Slide 76

Slide 76 text

Sample code (Login flow) let canForceLogout: State -> Bool = [.loggingIn, .loggedIn].contains // 2. Fancy pattern matching using Swift's custom operators let mappings: [EffectMapping] = [ /* input | fromState => toState | effect */ /* ---------------------------------------------------------- */ .login | .loggedOut => .loggingIn | loginOKProducer, .loginOK | .loggingIn => .loggedIn | .empty, .logout | .loggedIn => .loggingOut | logoutOKProducer, .logoutOK | .loggingOut => .loggedOut | .empty, .forceLogout | canForceLogout => .loggingOut | forceLogoutOKProducer ]

Slide 77

Slide 77 text

VTree + Automaton

Slide 78

Slide 78 text

SwiftElm https://github.com/inamiy/SwiftElm

Slide 79

Slide 79 text

No content

Slide 80

Slide 80 text

No content

Slide 81

Slide 81 text

Tricks

Slide 82

Slide 82 text

Template Metaprogramming • krzysztofzablocki/Sourcery • Uses SourceKitten (AST parser) & Stencil (template) • Code-generate to reduces verbose code • AutoEquatable, AutoHashable, AutoCases, AutoLenses, Auto-LinuxMain.swift, etc • Used to extract user-defined enum Msg case-functions to evaluate from SwiftElm runtime

Slide 83

Slide 83 text

Equatable Function • dankogai/peekFunc ✨"✨ func peekFunc(_ f: (A) -> R) -> (fp: Int, ctx: Int) { let (_, low) = unsafeBitCast(f, to: (Int, Int).self) let offset = MemoryLayout.size == 8 ? 16 : 12 let ptr = UnsafePointer(bitPattern: low + offset) return (ptr!.pointee, ptr!.successor().pointee) } • Required for comparing enum Msg case-functions • Use FuncBox wrapper to avoid reabstraction thunk

Slide 84

Slide 84 text

No content

Slide 85

Slide 85 text

For more safe version... Zelkova https://github.com/inamiy/Zelkova

Slide 86

Slide 86 text

Recap • Modern iOS Architecture ... Layer ownership problem • New Big Wave ! ... React + Redux, Elm • VTree (Virtual DOM) • ReactiveAutomaton (State Machine) • ... and some hacks ✨#✨ • Elm Architecture in Swift $

Slide 87

Slide 87 text

Thanks! Yasuhiro Inami @inamiy