How to Control the World

On a daily basis we work with APIs that interact with the outside world. These APIs can be inconsistent, unreliable, or fail. As we sprinkle calls to these APIs throughout our applications, we often make our own code more difficult to work with, test, and be confidence in. This talk covers a simple, effective solution to taking control of the outside world, improving the way we work with our code in dramatic ways.

Transcript

1. how to control the world @stephencelis www.pointfree.co
2. why?
3. why not?
4. how to control the world
5. step one: describe the world
6. struct World { }
7. struct World { // ??? }
8. start small: control time
9. start small: control time Date() // 2018-09-13 16:50:01
10. start small: control time Date() // 2018-09-13 16:50:01 Date() // 2018-09-13 16:50:03
11. start small: control time Date() // 2018-09-13 16:50:01 Date() // 2018-09-13 16:50:03 Date() // 2018-09-13 16:50:06
12. struct World { }
13. struct World { var date: () -> Date }
14. struct World { var date: () -> Date = { Date() } }
15. struct World { var date = { Date() } }
16. ☑ 1. describe the world struct World { var date = { Date() } }
17. step two: create the world
18. struct World { var date = { Date() } }
19. struct World { var date = { Date() } } var Current = World()
20. ☑ 1. describe the world struct World { var date = { Date() } } ☑ 2. create the world var Current = World()
21. how to control the world
23. Current.date() // 2018-09-13 16:55:42
24. Current.date() // 2018-09-13 16:55:42 // Send the world back in time! Current.date = { .distantPast }
25. Current.date() // 2018-09-13 16:55:42 // Send the world back in time! Current.date = { .distantPast } Current.date() // 0001-01-01 00:00:00
26. Current.date() // 2018-09-13 16:55:42 // Send the world back in time! Current.date = { .distantPast } Current.date() // 0001-01-01 00:00:00 // Or into the future! Current.date = { .distantFuture }
27. Current.date() // 2018-09-13 16:55:42 // Send the world back in time! Current.date = { .distantPast } Current.date() // 0001-01-01 00:00:00 // Or into the future! Current.date = { .distantFuture } Current.date() // 4001-01-01 00:00:00
28. Current.date() // 2018-09-13 16:55:42 // Send the world back in time! Current.date = { .distantPast } Current.date() // 0001-01-01 00:00:00 // Or into the future! Current.date = { .distantFuture } Current.date() // 4001-01-01 00:00:00 Current.date() // 4001-01-01 00:00:00
29. Current.date() // 2018-09-13 16:55:42 // Send the world back in time! Current.date = { .distantPast } Current.date() // 0001-01-01 00:00:00 // Or into the future! Current.date = { .distantFuture } Current.date() // 4001-01-01 00:00:00 Current.date() // 4001-01-01 00:00:00 Current.date() // 4001-01-01 00:00:00
30. Current.date() // 2018-09-13 16:55:42 // Send the world back in time! Current.date = { .distantPast } Current.date() // 0001-01-01 00:00:00 // Or into the future! Current.date = { .distantFuture } Current.date() // 4001-01-01 00:00:00 Current.date() // 4001-01-01 00:00:00 Current.date() // 4001-01-01 00:00:00 // Restore the balance. Current.date = Date.init Current.date() // 2018-09-13 16:56:28
31. how to control the world
32. the old switcheroo
33. the old switcheroo Wherever we see: Date()
34. the old switcheroo Wherever we see: Date() Replace with: Current.date()
35. func application( _ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]? ) -> Bool { Current.date = { Date(timeIntervalSinceReferenceDate: 0) } return true }
36. struct World { var date = { Date() } }
37. let formatter = DateFormatter() formatter.string(from: Current.date())
38. let formatter = DateFormatter() formatter.calendar // Calendar formatter.locale // Locale formatter.timeZone // TimeZone formatter.string(from: Current.date())
39. let’s take control! struct World { var date = { Date() } }
40. let’s take control! struct World { var calendar = Calendar.autoupdatingCurrent var date = { Date() } var locale = Locale.autoupdatingCurrent var timeZone = TimeZone.autoupdatingCurrent }
41. the old switcheroo Wherever we see or don’t see: Calendar.autoupdatingCurrent Locale.autoupdatingCurrent TimeZone.autoupdatingCurrent Replace with: Current.calendar Current.locale Current.timeZone
42. let’s take control! let formatter = DateFormatter() formatter.calendar = Current.calendar formatter.locale = Current.locale formatter.timeZone = Current.timeZone formatter.string(from: Current.date())
43. let’s take control! extension World { func dateFormatter() -> DateFormatter { let formatter = DateFormatter() formatter.calendar = self.calendar formatter.locale = self.locale formatter.timeZone = self.timeZone return formatter } } Current.dateFormatter()
44. let’s take control! Current.dateFormatter().string(from: Current.date()) // "September 13, 2018 at 5:00 PM" Current.calendar = Calendar(identifier: .buddhist) Current.locale = Locale(identifier: "es_ES") Current.timeZone = TimeZone(identifier: "Pacific/Honolulu")! Current.dateFormatter().string(from: Current.date()) // "13 de septiembre de 2561 BE, 17:00"
45. func application( _ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]? ) -> Bool { Current.calendar = Calendar(identifier: .buddhist) Current.locale = Locale(identifier: "es_ES") Current.timeZone = TimeZone(identifier: "Pacific/Honolulu")! return true }
46. struct World { var calendar = Calendar.autoupdatingCurrent var date = { Date() } var locale = Locale.autoupdatingCurrent var timeZone = TimeZone.autoupdatingCurrent }
47. APIClient.shared.token = token APIClient.shared.fetchCurrentUser { result in // … }
48. APIClient.shared.token = token APIClient.shared.fetchCurrentUser { result in // … } struct API { var setToken = { APIClient.shared.token = $0 } var fetchCurrentUser = APIClient.shared.fetchCurrentUser }
49. APIClient.shared.token = token APIClient.shared.fetchCurrentUser { result in // … } struct API { var setToken = { APIClient.shared.token = $0 } var fetchCurrentUser = APIClient.shared.fetchCurrentUser } struct World { var api = API() // … }
50. the old switcheroo Wherever we see: APIClient.shared.token = token APIClient.shared.fetchCurrentUser { result in Replace with: Current.api.setToken(token) Current.api.fetchCurrentUser { result in
51. // Simulate being logged-in as a specific user Current.api.fetchCurrentUser = { callback in callback(.success(User(name: "Blob"))) }
52. // Simulate being logged-in as a specific user Current.api.fetchCurrentUser = { callback in callback(.success(User(name: "Blob"))) } // Simulate specific errors Current.api.fetchCurrentUser = { callback in callback(.failure(APIError.userSuspended)) }
53. this is not how we do things
54. aren’t singletons evil?
55. aren’t singletons evil? — singletons are only a problem when they’re out of our control
56. what about global mutation?
57. what about global mutation? — the option to mutate, not the requirement (avoid mutation in release mode)
58. what about global mutation? — the option to mutate, not the requirement (avoid mutation in release mode) — exercise restraint (with code review and lint checks)
59. what about global mutation? — the option to mutate, not the requirement (avoid mutation in release mode) — exercise restraint (with code review and lint checks) # .swiftlint.yml custom_rules: no_current_mutation: included: ".*\\.swift" excluded: ".*Test\\.swift" name: "Current Mutation" regex: "(Current\.\S+\s+=)" message: "Don’t mutate the current world!"
60. why structs?
61. why structs? — protocols can be a premature abstraction
62. why structs? — protocols can be a premature abstraction — protocols require a ton of boilerplate
63. protocol APIClientProtocol { var token: String? { get set } func fetchCurrentUser(_ completionHandler: (Result<User, Error>) -> Void) }
64. protocol APIClientProtocol { var token: String? { get set } func fetchCurrentUser(_ completionHandler: (Result<User, Error>) -> Void) } extension APIClient: APIClientProtocol {}
65. protocol APIClientProtocol { var token: String? { get set } func fetchCurrentUser(_ completionHandler: (Result<User, Error>) -> Void) } extension APIClient: APIClientProtocol {} class MockAPIClient: APIClientProtocol { var token: String? var currentUserResult: Result<User, Error>? func fetchCurrentUser(_ completionHandler: (Result<User, Error>) -> Void) { completionHandler(self.fetchCurrentUserResult!) } }
66. protocol APIClientProtocol { var token: String? { get set } func fetchCurrentUser(_ completionHandler: (Result<User, Error>) -> Void) } extension APIClient: APIClientProtocol {} class MockAPIClient: APIClientProtocol { var token: String? var currentUserResult: Result<User, Error>? func fetchCurrentUser(_ completionHandler: (Result<User, Error>) -> Void) { completionHandler(self.fetchCurrentUserResult!) } } struct World { var api: APIClientProtocol = APIClient.shared }
67. struct API { var setToken = { APIClient.shared.token = $0 } var fetchCurrentUser = APIClient.shared.fetchCurrentUser } struct World { var api = API() }
68. why structs? — protocols can be a premature abstraction — protocols require a ton of boilerplate
69. isn’t dependency injection be!er?
70. isn’t dependency injection be!er? — passing dependencies requires a lot more boilerplate
71. class MyViewController: UIViewController { let api: APIClientProtocol let date: () -> Date let label = UILabel() init(_ api: APIClientProtocol, _ date: () -> Date) { self.api = api self.date = date } func greet() { self.api.fetchCurrentUser { result in if let user = result.success { self.label.text = "Hi, \(user.name)! It’s \(self.date())." } } } }
72. class MyViewController: UIViewController { let api: APIClientProtocol let date: () -> Date init(_ api: APIClientProtocol, _ date: () -> Date) { self.api = api self.date = date } func presentChild() { let childViewController = ChildViewController( api: self.api, date: self.date ) } } class ChildViewController: UIViewController { let api: APIClientProtocol let date: () -> Date let label = UILabel() init(_ api: APIClientProtocol, _ date: () -> Date) { self.api = api self.date = date } func greet() { self.api.fetchCurrentUser { result in if let user = result.success { self.label.text = "Hi, \(user.name)! It’s \(self.date())." } } } }
73. protocol APIClientProvider { var api: APIClientProtocol { get } } protocol DateProvider { func date() -> Date } extension World: APIClientProvider, DateProvider {} class MyViewController: UIViewController { typealias Dependencies = APIClientProvider & DateProvider let label = UILabel() let dependencies: Dependencies init(dependencies: Dependencies) { self.dependencies = dependencies } func greet() { self.dependencies.api.fetchCurrentUser { result in if let user = result.success { self.label.text = "Hi, \(user.name)! It’s \(self.dependencies.date())." } } } }
74. class MyViewController: UIViewController { typealias Dependencies = APIClientProvider & DateProvider var dependencies: Dependencies! override func prepareForSegue(segue: UIStoryboardSegue, sender: AnyObject?) { if segue.identifier == "child" { let childViewController = segue.destinationViewController as! ChildViewController childViewController.dependencies = self.dependencies } } } class ChildViewController: UIViewController { typealias Dependencies = APIClientProvider & DateProvider var dependencies: Dependencies! @IBOutlet var label: UILabel! func greet() { self.dependencies.api.fetchCurrentUser { result in if let user = result.success { self.label.text = "Hi, \(user.name)! It’s \(self.dependencies.date())." } } } }
75. with Current: class MyViewController: UIViewController {} class ChildViewController: UIViewController { @IBOutlet var label: UILabel! func greet() { Current.api.fetchCurrentUser { result in if let user = result.success { self.label.text = "Hi, \(user.name)! It’s \(Current.date())." } } } }
76. guidelines for keeping it simple 1. singletons can be good (when there’s only one and you can control it) 2. global mutation can be good (when you’re not using it in production) 3. sometimes, you don’t need a protocol, and a struct can save you a ton of boilerplate 4. dependency injection is maybe more complicated of a solution than what we need
77. next steps?
78. class TestCase: XCTestCase { override func setUp() { super.setUp() Current = World( api: Api( setToken: { _ in }, fetchCurrentUser: { callback in callback(.success(User(name: "Blob")) } , calendar: Calendar(identifier: .gregorian), date: { Date(timeIntervalSinceReferenceDate: 0) } locale: Locale(identifier: "en_US"), timeZone: TimeZone(identifier: "UTC")! ) } }
79. extension API { static let mock = API( setToken: { _ in }, fetchCurrentUser: { callback in callback(.success(User(name: "Blob")) } ) } extension World { static let mock = World( api: .mock, calendar: Calendar(identifier: .gregorian), date: { Date(timeIntervalSinceReferenceDate: 0) } locale: Locale(identifier: "en_US"), timeZone: TimeZone(identifier: "UTC")! ) }
80. class TestCase: XCTestCase { override func setUp() { super.setUp() Current = .mock } }
81. next steps?
82. testing analytics struct World { var track = Analytics.shared.track } class TestCase: XCTestCase { var events: [Analytics.Event] = [] override func setUp() { super.setUp() Current = .mock Current.track = events.append } func testLoggingIn() { // … XCTAssertEqual([.loginStart, .loginSuccess], self.events) } }
83. testing localization struct World { var preferredLanguages = Locale.preferredLanguages } func localizedString(key: String, value: String) -> String { // … }
84. it can’t all be that simple!
85. it can’t all be that simple! — more complicated dependencies, like those following the delegate pattern, may require adopting simpler wrappers
86. it can’t all be that simple! — more complicated dependencies, like those following the delegate pattern, may require adopting simpler wrappers — ephemeral/local dependencies (like view controls and view delegates) shouldn’t be controlled on the world
87. in conclusion…
88. controlling the world is good — unlock the ability to simulate external state
89. controlling the world is simple — no need for the excessive boilerplate of protocols and dependency injection: store the minimal details of the world in a struct
90. Thanks!
91. Questions? @stephencelis www.pointfree.co