First-Class Commands: an unexpectedly fertile design pattern

Transcript

1. © 2016 Reginald Braithwaite. Some rights reserved. 1

2. First-Class Commands an unexpectedly fer/le design pa3ern © 2016 Reginald

   Braithwaite. Some rights reserved. 2

3. why do we care about commands? © 2016 Reginald Braithwaite.

   Some rights reserved. 3

4. © 2016 Reginald Braithwaite. Some rights reserved. 4

5. the canonical example: mutable data © 2016 Reginald Braithwaite. Some

   rights reserved. 5

6. class Buffer { constructor (text = '') { this.text =

   text; } replaceWith (replacement, from = 0, to = this.text.length) { this.text = this.text.slice(0, from) + replacement + this.text.slice(to); return this; } toString () { return this.text; } } © 2016 Reginald Braithwaite. Some rights reserved. 6

7. let buffer = new Buffer(); buffer.replaceWith( "The quick brown fox

   jumped over the lazy dog" ); buffer.replaceWith("fast", 4, 9); buffer.replaceWith("canine", 40, 43); //=> The fast brown fox jumped over the lazy canine © 2016 Reginald Braithwaite. Some rights reserved. 7

8. buffer is an object © 2016 Reginald Braithwaite. Some rights

   reserved. 8

9. we treat objects as first-class en00es © 2016 Reginald Braithwaite.

   Some rights reserved. 9

10. replaceWith is a method © 2016 Reginald Braithwaite. Some rights

    reserved. 10

11. we can treat methods as first-class en11es © 2016 Reginald

    Braithwaite. Some rights reserved. 11

12. buffer.replaceWith("fast", 4, 9) is an invoca)on © 2016 Reginald Braithwaite.

    Some rights reserved. 12

13. what does it mean to treat an invoca0on as a

    first-class en0ty? © 2016 Reginald Braithwaite. Some rights reserved. 13

14. store it © 2016 Reginald Braithwaite. Some rights reserved. 14

15. class Edit { constructor (buffer, {replacement, from, to}) { this.buffer

    = buffer; Object.assign(this, {replacement, from, to}); } doIt () { this.buffer.text = this.buffer.text.slice(0, this.from) + this.replacement + this.buffer.text.slice(this.to); return this.buffer; } } © 2016 Reginald Braithwaite. Some rights reserved. 15

16. class Buffer { constructor (text = '') { this.text =

    text; } replaceWith (replacement, from = 0, to = this.text.length) { return new Edit(this, {replacement, from, to}); } toString () { return this.text; } } © 2016 Reginald Braithwaite. Some rights reserved. 16

17. let buffer = new Buffer(), jobQueue = []; jobQueue.push( buffer.replaceWith(

    "The quick brown fox jumped over the lazy dog" ) ); jobQueue.push( buffer.replaceWith("fast", 4, 9) ); jobQueue.push( buffer.replaceWith("canine", 40, 43) ); while (jobQueue.length > 0) { jobQueue.shift().doIt(); } //=> The fast brown fox jumped over the lazy canine © 2016 Reginald Braithwaite. Some rights reserved. 17

18. query it © 2016 Reginald Braithwaite. Some rights reserved. 18

19. class Edit { netChange () { return this.from - this.to

    + this.replacement.length; } } © 2016 Reginald Braithwaite. Some rights reserved. 19

20. let buffer = new Buffer(); buffer.replaceWith( "The quick brown fox

    jumped over the lazy dog" ).netChange(); //=> 44 buffer.replaceWith("fast", 4, 9).netChange(); //=> -1 © 2016 Reginald Braithwaite. Some rights reserved. 20

21. transform it © 2016 Reginald Braithwaite. Some rights reserved. 21

22. class Edit { reversed () { let replacement = this.buffer.text.slice(this.from,

    this.to), from = this.from, to = from + this.replacement.length; return new Edit(buffer, {replacement, from, to}); } } © 2016 Reginald Braithwaite. Some rights reserved. 22

23. let buffer = new Buffer( "The quick brown fox jumped

    over the lazy dog" ); let doer = buffer.replaceWith("fast", 4, 9), undoer = doer.reversed(); doer.doIt(); //=> The fast brown fox jumped over the lazy dog undoer.doIt(); //=> The quick brown fox jumped over the lazy dog © 2016 Reginald Braithwaite. Some rights reserved. 23

24. all together now © 2016 Reginald Braithwaite. Some rights reserved.

    24

25. class Buffer { constructor (text = '') { this.text =

    text; this.history = []; this.future = []; } } © 2016 Reginald Braithwaite. Some rights reserved. 25

26. class Buffer { replaceWith (replacement, from = 0, to =

    this.length()) { let doer = new Edit(this, {replacement, from, to}), undoer = doer.reversed(); this.history.push(undoer); this.future = []; return doer.doIt(); } } © 2016 Reginald Braithwaite. Some rights reserved. 26

27. undo © 2016 Reginald Braithwaite. Some rights reserved. 27

28. class Buffer { undo () { let undoer = this.history.pop(),

    redoer = undoer.reversed(); this.future.unshift(redoer); return undoer.doIt(); } } © 2016 Reginald Braithwaite. Some rights reserved. 28

29. let buffer = new Buffer( "The quick brown fox jumped

    over the lazy dog" ); buffer.replaceWith("fast", 4, 9) //=> The fast brown fox jumped over the lazy dog buffer.replaceWith("canine", 40, 43) //=> The fast brown fox jumped over the lazy canine © 2016 Reginald Braithwaite. Some rights reserved. 29

30. buffer.undo() //=> The fast brown fox jumped over the lazy

    dog buffer.undo() //=> The quick brown fox jumped over the lazy dog © 2016 Reginald Braithwaite. Some rights reserved. 30

31. redo © 2016 Reginald Braithwaite. Some rights reserved. 31

32. class Buffer { redo () { let redoer = this.future.shift(),

    undoer = redoer.reversed(); this.history.push(undoer); return redoer.doIt(); } } © 2016 Reginald Braithwaite. Some rights reserved. 32

33. buffer.redo() //=> The fast brown fox jumped over the lazy

    dog buffer.redo() //=> The fast brown fox jumped over the lazy canine © 2016 Reginald Braithwaite. Some rights reserved. 33

34. that's the basic command pa0ern © 2016 Reginald Braithwaite. Some

    rights reserved. 34

35. invoca'ons as first-class en''es: we stored them; we queried them;

    we transformed them. © 2016 Reginald Braithwaite. Some rights reserved. 35

36. ques%on! © 2016 Reginald Braithwaite. Some rights reserved. 36

37. class Buffer { replaceWith (replacement, from = 0, to =

    this.length()) { let doer = new Edit(this, {replacement, from, to}), undoer = doer.reversed(); this.history.push(undoer); this.future = []; return doer.doIt(); } } © 2016 Reginald Braithwaite. Some rights reserved. 37

38. why do we have to throw the future away? ©

    2016 Reginald Braithwaite. Some rights reserved. 38

39. class Buffer { replaceWith (replacement, from = 0, to =

    this.length()) { let doer = new Edit(this, {replacement, from, to}), undoer = doer.reversed(); this.history.push(undoer); // this.future = []; return doer.doIt(); } } © 2016 Reginald Braithwaite. Some rights reserved. 39

40. let buffer = new Buffer( "The quick brown fox jumped

    over the lazy dog" ); buffer.replaceWith("fast", 4, 9); //=> The fast brown fox jumped over the lazy dog buffer.undo(); //=> The quick brown fox jumped over the lazy dog buffer.replaceWith("My", 0, 3); //=> My quick brown fox jumped over the lazy dog © 2016 Reginald Braithwaite. Some rights reserved. 40

41. what happens when we evaluate buffer.redo()? © 2016 Reginald Braithwaite.

    Some rights reserved. 41

42. "My qfastbrown fox jumped over the lazy dog" © 2016

    Reginald Braithwaite. Some rights reserved. 42

43. © 2016 Reginald Braithwaite. Some rights reserved. 43

44. let's consider commands as a history © 2016 Reginald Braithwaite.

    Some rights reserved. 44

45. let buffer = new Buffer("The quick brown fox jumped over

    the lazy dog"); "The quick brown fox jumped over the lazy dog" // PAST // FUTURE © 2016 Reginald Braithwaite. Some rights reserved. 45

46. buffer.replaceWith("fast", 4, 9) "The fast brown fox jumped over the

    lazy dog" // PAST replaceWith("fast", 4, 9) // FUTURE © 2016 Reginald Braithwaite. Some rights reserved. 46

47. buffer.undo() "The quick brown fox jumped over the lazy dog"

    // PAST // FUTURE replaceWith("fast", 4, 9) © 2016 Reginald Braithwaite. Some rights reserved. 47

48. buffer.replaceWith("My", 0, 3) "My quick brown fox jumped over the

    lazy dog" // PAST replaceWith("My", 0, 3) // FUTURE replaceWith("fast", 4, 9) © 2016 Reginald Braithwaite. Some rights reserved. 48

49. buffer.redo() "My qfastbrown fox jumped over the lazy dog" //

    PAST replaceWith("My", 0, 3) replaceWith("fast", 4, 9) // FUTURE © 2016 Reginald Braithwaite. Some rights reserved. 49

50. every command depends on the history of commands preceding it

    © 2016 Reginald Braithwaite. Some rights reserved. 50

51. prepending a command into its history alters the command ©

    2016 Reginald Braithwaite. Some rights reserved. 51

52. let buffer = new Buffer( "The quick brown fox jumped

    over the lazy dog" ); let fast = new Edit( buffer, { replacement: "fast", from: 4, to: 9 } ); let my = new Edit( buffer, { replacement: "My", from: 0, to: 3 } ); © 2016 Reginald Braithwaite. Some rights reserved. 52

53. let buffer = new Buffer( "The quick brown fox jumped

    over the lazy dog" ); let fast = new Edit( buffer, { replacement: "fast", from: 4, to: 9 } ); let my = new Edit( buffer, { replacement: "My", from: 0, to: 3 } ); © 2016 Reginald Braithwaite. Some rights reserved. 53

54. class Edit { isBefore (other) { return other.from >= this.to;

    } } fast.isBefore(my); //=> false my.isBefore(fast); //=> true © 2016 Reginald Braithwaite. Some rights reserved. 54

55. class Edit { prependedWith (other) { if (this.isBefore(other)) { return

    this; } else if (other.isBefore(this)) { let change = other.netChange(), {replacement, from, to} = this; from = from + change; to = to + change; return new Edit(this.buffer, {replacement, from, to}) } } } © 2016 Reginald Braithwaite. Some rights reserved. 55

56. my.prependedWith(fast) //=> buffer.replaceWith("My", 0, 3) fast.prependedWith(my) //=> buffer.replaceWith("fast", 3, 8)

    © 2016 Reginald Braithwaite. Some rights reserved. 56

57. my.prependedWith(fast) //=> buffer.replaceWith("My", 0, 3) fast.prependedWith(my) //=> buffer.replaceWith("fast", 3, 8)

    © 2016 Reginald Braithwaite. Some rights reserved. 57

58. class Buffer { replaceWith (replacement, from = 0, to =

    this.length()) { let doer = new Edit(this, {replacement, from, to}), undoer = doer.reversed(); this.history.push(undoer); this.future = this.future.map( (edit) => edit.prependedWith(doer) ); return doer.doIt(); } } © 2016 Reginald Braithwaite. Some rights reserved. 58

59. let's start over © 2016 Reginald Braithwaite. Some rights reserved.

    59

60. let buffer = new Buffer( "The quick brown fox jumped

    over the lazy dog" ); buffer.replaceWith("fast", 4, 9); //=> The fast brown fox jumped over the lazy dog buffer.undo(); //=> The quick brown fox jumped over the lazy dog buffer.replaceWith("My", 0, 3); //=> My quick brown fox jumped over the lazy dog buffer.redo(); © 2016 Reginald Braithwaite. Some rights reserved. 60

61. "My fast brown fox jumped over the lazy dog" ©

    2016 Reginald Braithwaite. Some rights reserved. 61

62. what did fixing redo teach us about invoca3ons as first-class

    en33es? © 2016 Reginald Braithwaite. Some rights reserved. 62

63. "People assume that .me is a strict progression of cause

    to effect, but actually from a non-linear, non- subjec.ve viewpoint—it's more like a big ball of wibbly wobbly… .me-y wimey… stuff." © 2016 Reginald Braithwaite. Some rights reserved. 63

64. reversed() and prependedWith() show us we can change both the

    direc1on and order of 1me. © 2016 Reginald Braithwaite. Some rights reserved. 64

65. © 2016 Reginald Braithwaite. Some rights reserved. 65

66. let alice = new Buffer( "The quick brown fox jumped

    over the lazy dog" ); let bob = new Buffer( "The quick brown fox jumped over the lazy dog" ); © 2016 Reginald Braithwaite. Some rights reserved. 66

67. for simplicity, we'll omit undo , redo and reversed class

    Buffer { constructor (text = '') { this.text = text; this.history = []; } } © 2016 Reginald Braithwaite. Some rights reserved. 67

68. class Buffer { replaceWith (replacement, from = 0, to =

    this.length()) { let edit = new Edit(this, {replacement, from, to} ); this.history.push(edit); return edit.doIt(); } } © 2016 Reginald Braithwaite. Some rights reserved. 68

69. alice.replaceWith("My", 0, 3); //=> My quick brown fox jumped over

    the lazy dog bob.replaceWith("fast", 4, 9); //=> The fast brown fox jumped over the lazy dog © 2016 Reginald Braithwaite. Some rights reserved. 69

70. © 2016 Reginald Braithwaite. Some rights reserved. 70

71. class Buffer { append (theirEdit) { this.history.forEach( (myEdit) => {

    theirEdit = theirEdit.prependedWith(myEdit); }); return new Edit(this, theirEdit).doIt(); } } © 2016 Reginald Braithwaite. Some rights reserved. 71

72. class Buffer { appendAll(otherBuffer) { otherBuffer.history.forEach( (theirEdit) => this.append(theirEdit) );

    return this; } } © 2016 Reginald Braithwaite. Some rights reserved. 72

73. alice.appendAll(bob); //=> My fast brown fox jumped over the lazy

    dog bob.appendAll(alice); //=> My fast brown fox jumped over the lazy dog © 2016 Reginald Braithwaite. Some rights reserved. 73

74. ! © 2016 Reginald Braithwaite. Some rights reserved. 74

75. © 2016 Reginald Braithwaite. Some rights reserved. 75

76. let GUID = () => ??? class Buffer { constructor

    (text = '', history = []) { let befores = new Set(history.map(e => e.guid)); history = history.slice(0); Object.assign(this, {text, history, befores}); } share () { return new Buffer(this.text, this.history); } } © 2016 Reginald Braithwaite. Some rights reserved. 76

77. class Edit { constructor (buffer, { guid = GUID(), befores

    = new Set(), replacement, from, to }) { this.buffer = buffer; befores = new Set(befores); Object.assign(this, {guid, replacement, from, to, befores}); } } © 2016 Reginald Braithwaite. Some rights reserved. 77

78. class Buffer { has (edit) { return this.befores.has(edit.guid); } perform

    (edit) { if (!this.has(edit)) { this.history.push(edit); this.befores.add(edit.guid); return edit.doIt(); } } } © 2016 Reginald Braithwaite. Some rights reserved. 78

79. class Buffer { replaceWith (replacement, from = 0, to =

    this.length()) { let edit = new Edit(this, {replacement, from, to, befores: this.befores} ); return this.perform(edit); } } © 2016 Reginald Braithwaite. Some rights reserved. 79

80. class Buffer { append (theirEdit) { this.history.forEach( (myEdit) => {

    theirEdit = theirEdit.prependedWith(myEdit); }); return this.perform(new Edit(this, theirEdit)); } } © 2016 Reginald Braithwaite. Some rights reserved. 80

81. class Buffer { appendAll(otherBuffer) { otherBuffer.history.forEach( (theirEdit) => this.has(theirEdit) ||

    this.append(theirEdit) ); return this; } } © 2016 Reginald Braithwaite. Some rights reserved. 81

82. class Edit { prependedWith (other) { if (this.isBefore(other) || this.befores.has(other.guid)

    || this.guid === other.guid) return this; let change = other.netChange(), {guid, replacement, from, to, befores} = this; from = from + change; to = to + change; befores = new Set(befores); befores.add(other.guid); return new Edit(this.buffer, {guid, replacement, from, to, befores}); } } © 2016 Reginald Braithwaite. Some rights reserved. 82

83. © 2016 Reginald Braithwaite. Some rights reserved. 83

84. let alice = new Buffer( "The quick brown fox jumped

    over the lazy dog" ); let bob = alice.share(); //=> The quick brown fox jumped over the lazy dog alice.replaceWith("My", 0, 3); //=> My quick brown fox jumped over the lazy dog © 2016 Reginald Braithwaite. Some rights reserved. 84

85. let carol = alice.share(); //=> My quick brown fox jumped

    over the lazy dog bob.replaceWith("fast", 4, 9); //=> The fast brown fox jumped over the lazy dog alice.appendAll(bob); //=> My fast brown fox jumped over the lazy dog © 2016 Reginald Braithwaite. Some rights reserved. 85

86. bob.appendAll(alice); //=> My fast brown fox jumped over the lazy

    dog alice.replaceWith("spotted", 8, 13); //=> My fast spotted fox jumped over the lazy dog bob.appendAll(alice); //=> My fast spotted fox jumped over the lazy dog carol.appendAll(bob); //=> My fast spotted fox jumped over the lazy dog © 2016 Reginald Braithwaite. Some rights reserved. 86

87. "Unfortunately, implemen2ng OT sucks. There's a million algorithms with different

    tradeoffs, mostly trapped in academic papers. The algorithms are really hard and 2me consuming to implement correctly." © 2016 Reginald Braithwaite. Some rights reserved. 87

88. perhaps we should borrow a trick from react, and periodically

    scan a "shadow buffer" for diffs that we exchange with collaborators… © 2016 Reginald Braithwaite. Some rights reserved. 88

89. differen'al synchroniza'on © 2016 Reginald Braithwaite. Some rights reserved. 89

90. this is a very big problem space © 2016 Reginald

    Braithwaite. Some rights reserved. 90

91. © 2016 Reginald Braithwaite. Some rights reserved. 91

92. class Buffer { replaceWith () { ... } share ()

    { ... } append () { ... } appendAll () { ... } } © 2016 Reginald Braithwaite. Some rights reserved. 92

93. class Branch { commit () { ... } fork ()

    { ... } cherryPick () { ... } merge () { ... } } © 2016 Reginald Braithwaite. Some rights reserved. 93

94. distributed version control © 2016 Reginald Braithwaite. Some rights reserved.

    94

95. with invoca+ons as first-class en++es, we can build algorithms and

    protocols mastering +me and change, from single apps to distributed systems © 2016 Reginald Braithwaite. Some rights reserved. 95

96. © 2016 Reginald Braithwaite. Some rights reserved. 96

97. "Never confuse the example given of a pa6ern, with the

    underlying idea the pa6ern represents." © 2016 Reginald Braithwaite. Some rights reserved. 97

98. Reg Braithwaite PagerDuty, Inc. raganwald.com @raganwald © 2016 Reginald Braithwaite.

    Some rights reserved. 98