Slide 1

Slide 1 text

WIRE @oldergod

Slide 2

Slide 2 text

No content

Slide 3

Slide 3 text

// service.proto message Request { optional Customer customer = 1; } message Customer { required string name = 1; optional int32 age = 2; } service CustomerService { rpc getCustomer(Request) returns (Response); }

Slide 4

Slide 4 text

- Proto3 - Options - Wire Gradle Plugin - Dependency Management Agenda

Slide 5

Slide 5 text

No content

Slide 6

Slide 6 text

Identity if absent

Slide 7

Slide 7 text

syntax = "proto2"; message Message { required string a = 1; optional string b = 2; }

Slide 8

Slide 8 text

syntax = "proto2"; message Message { required string a = 1; optional string b = 2; }

Slide 9

Slide 9 text

syntax = "proto3"; message Message { string a = 1; }

Slide 10

Slide 10 text

Identity if absent Strings → "" Bytes → empty bytes Bools → false Numerics → 0, 0L, 0f, 0.0 Enums → first defined value (which must be 0) Messages → null

Slide 11

Slide 11 text

syntax = "proto3"; message Message { string a = 1; }

Slide 12

Slide 12 text

syntax = "proto3"; message Message { string a = 1; optional string b = 2; }

Slide 13

Slide 13 text

syntax = "proto2"; message MyMessage { required string a = 1; optional string b = 2; } class MyMessage( val a: String, val b: String? = null ) : Message() {} →

Slide 14

Slide 14 text

syntax = "proto3"; message MyMessage { string a = 1; optional string b = 2; } class MyMessage( val a: String = "", val b: String? = null ) : Message() {} →

Slide 15

Slide 15 text

New Types

Slide 16

Slide 16 text

Any → com.squareup.wire.AnyMessage Duration → java.time.Duration Timestamp → java.time.Instant Struct → map Wrappers → Boxed types for primitives (String?) Empty → kotlin.Unit New Types google.protobuf. ~ Generic placeholder ~ same as java.time.Duration ~ same as java.time.Instant ~ JSON Object ~ JSON representation of primitive types + nullability ~ For parameter-less RPCs

Slide 17

Slide 17 text

message Request { // Only set when it is a Bitcoin request. optional BitcoinData bitcoin_data = 1; // Only set when it is a Stock request. optional StockData stock_data = 2; }

Slide 18

Slide 18 text

message Request { // Only set when it is a Bitcoin request. optional BitcoinData bitcoin_data = 1; // Only set when it is a Stock request. optional StockData stock_data = 2; } message Request { // Will be either BitcoinData or StockData. optional google.protobuf.Any request_data = 1; } ↓

Slide 19

Slide 19 text

Any → com.squareup.wire.AnyMessage Duration → java.time.Duration Timestamp → java.time.Instant Struct → map Wrappers → Boxed types for primitives (String?) Empty → kotlin.Unit New Types google.protobuf.

Slide 20

Slide 20 text

Any → com.squareup.wire.AnyMessage Duration → java.time.Duration Timestamp → java.time.Instant Struct → map Wrappers → Boxed primitives (e.g. String?) Empty → kotlin.Unit New Types google.protobuf.

Slide 21

Slide 21 text

syntax = "proto3"; import "google/protobuf/timestamp.proto"; message EndpointResponse { // ... google.protobuf.Timestamp valid_until = 6; }

Slide 22

Slide 22 text

val response: EndpointResponse if (isResponseStale(...)) { fetch() } private fun isResponseStale(validUntil: Instant): Boolean

Slide 23

Slide 23 text

val protocResponse: Message.EndpointResponse if (isResponseStale(...)) { fetch() } private fun isResponseStale(validUntil: Instant): Boolean Protoc

Slide 24

Slide 24 text

val millis = System.currentTimeMillis() val protocResponse: Message.EndpointResponse if (isResponseStale(...)) { fetch() } private fun isResponseStale(validUntil: Instant): Boolean Protoc

Slide 25

Slide 25 text

val millis = System.currentTimeMillis() val protocResponse = Message.EndpointResponse.newBuilder() .setValidUntil( Timestamp... ) .build() if (isResponseStale(...)) { fetch() } private fun isResponseStale(validUntil: Instant): Boolean Protoc

Slide 26

Slide 26 text

val millis = System.currentTimeMillis() val protocResponse = Message.EndpointResponse.newBuilder() .setValidUntil( Timestamp.newBuilder() .setSeconds(millis / 1000) .setNanos(((millis % 1000) * 1000000).toInt()) .build() ) .build() if (isResponseStale(...)) { fetch() } private fun isResponseStale(validUntil: Instant): Boolean Protoc

Slide 27

Slide 27 text

val millis = System.currentTimeMillis() val protocResponse = Message.EndpointResponse.newBuilder().build() if (isResponseStale(...)) { fetch() } private fun isResponseStale(validUntil: Instant): Boolean Protoc

Slide 28

Slide 28 text

val millis = System.currentTimeMillis() val protocResponse = Message.EndpointResponse.newBuilder().build() if (isResponseStale( Instant.ofEpochSecond( protocResponse.validUntil.seconds, protocResponse.validUntil.nanos.toLong() ) )) { fetch() } private fun isResponseStale(validUntil: Instant): Boolean Protoc

Slide 29

Slide 29 text

Wire val wireResponse: EndpointResponse if (isResponseStale(...)) { fetch() } private fun isResponseStale(validUntil: Instant): Boolean

Slide 30

Slide 30 text

Wire val millis = System.currentTimeMillis() val wireResponse: EndpointResponse if (isResponseStale(...)) { fetch() } private fun isResponseStale(validUntil: Instant): Boolean

Slide 31

Slide 31 text

Wire val millis = System.currentTimeMillis() val wireResponse = EndpointResponse(Instant.ofEpochMilli(millis)) if (isResponseStale(...)) { fetch() } private fun isResponseStale(validUntil: Instant): Boolean

Slide 32

Slide 32 text

Wire val millis = System.currentTimeMillis() val wireResponse = EndpointResponse(Instant.ofEpochMilli(millis)) if (isResponseStale(wireResponse.valid_until!!)) { fetch() } private fun isResponseStale(validUntil: Instant): Boolean

Slide 33

Slide 33 text

JSON

Slide 34

Slide 34 text

Why JSON?

Slide 35

Slide 35 text

JSON • Proto2 : Wire 㲗 Protoc communication is dangerous. • Proto3 : All good.

Slide 36

Slide 36 text

Proto2 㲗 Proto3 Compatibility

Slide 37

Slide 37 text

Proto2 㲗 Proto3 Compatibility • Cannot reference proto2 enums in proto3 message. • Because of identity-if-absent. • Anything else is good.

Slide 38

Slide 38 text

Protobuf Options

Slide 39

Slide 39 text

Protobuf Options message Money { optional int64 amount = 1 [(squareup.redacted) = true]; optional string title = 2 [deprecated = true]; optional Currency current = 3 [(whatever.opt) = 3]; }

Slide 40

Slide 40 text

Protobuf Options message Money { optional int64 amount = 1 [(squareup.redacted) = true]; optional string title = 2 [deprecated = true]; optional Currency current = 3 [(whatever.opt) = 3]; }

Slide 41

Slide 41 text

Protobuf Options • No intrinsic logic embedded • Wire handles a few • deprecated • default • json_name • packed • *.redacted • java_package • wire_package • "How about my option?"

Slide 42

Slide 42 text

extend google.protobuf.MessageOptions { optional string documentation_url = 22200; } message Octagon { option (documentation_url) = "https://en.wikipedia.org/wiki/Octagon"; optional bool stop = 1; }

Slide 43

Slide 43 text

wire { kotlin { emitDeclaredOptions = true emitAppliedOptions = true } } extend google.protobuf.MessageOptions { optional string documentation_url = 22200; } message Octagon { option (documentation_url) = "https://en.wikipedia.org/wiki/Octagon"; optional bool stop = 1; }

Slide 44

Slide 44 text

// emitDeclaredOptions = true @Retention(AnnotationRetention.RUNTIME) @Target(AnnotationTarget.CLASS) public annotation class DocumentationUrlOption( public val value: String ) // emitAppliedOptions = true @DocumentationUrlOption("https://en.wikipedia.org/wiki/Octagon") public class Octagon( ... ) : Message(ADAPTER, unknownFields) {}

Slide 45

Slide 45 text

Wire Gradle Plugin

Slide 46

Slide 46 text

Schema .proto Elements Java Kotlin Proto Schema Swift Parse Link Prune Generate

Slide 47

Slide 47 text

Schema .proto Elements Java Kotlin Proto Schema Swift Parse Link Prune Generate wire { sourcePath { srcDir 'src/main/protos' } sourcePath { srcJar 'lib/pizza-protos.jar' } protoPath { srcJar 'com.example.pizza:pizza-protos:1.0.0' } ... }

Slide 48

Slide 48 text

Schema .proto Elements Java Kotlin Proto Schema Swift Parse Link Prune Generate wire { sourcePath { srcDir 'src/main/protos' include 'com/example/pizza/pizza_delivery.proto' include 'com/example/pizza/pizza.proto' } }

Slide 49

Slide 49 text

Schema .proto Elements Java Kotlin Proto Schema Swift Parse Link Prune Generate wire { sourcePath { srcDir 'src/main/protos' include 'com/example/pizza/pizza_delivery.proto' include 'com/example/pizza/pizza.proto' } }

Slide 50

Slide 50 text

Schema .proto Elements Java Kotlin Proto Schema Swift Parse Link Prune Generate wire { sourcePath { srcDir 'src/main/protos' include 'com/example/pizza/pizza_delivery.proto' include 'com/example/pizza/pizza.proto' } }

Slide 51

Slide 51 text

Schema .proto Elements Java Kotlin Proto Schema Swift Parse Link Prune Generate wire { protoPath { srcJar 'com.squareup.protos:all-protos' } sourcePath { srcDir 'src/main/protos' include 'com/example/pizza/pizza_delivery.proto' include 'com/example/pizza/pizza.proto' } }

Slide 52

Slide 52 text

No content

Slide 53

Slide 53 text

No content

Slide 54

Slide 54 text

No content

Slide 55

Slide 55 text

No content

Slide 56

Slide 56 text

Schema .proto Elements Java Kotlin Proto Schema Swift Parse Link Prune Generate wire { root 'com.example.store.Store' }

Slide 57

Slide 57 text

wire { root 'com.example.store.Store' }

Slide 58

Slide 58 text

wire { root 'com.example.store.Store' }

Slide 59

Slide 59 text

Schema .proto Elements Java Kotlin Proto Schema Swift Parse Link Prune Generate wire { prune 'com.example.store.Store' prune 'com.example.geo.Country' }

Slide 60

Slide 60 text

wire { prune 'com.example.store.Store' prune 'com.example.geo.Country' }

Slide 61

Slide 61 text

wire { prune 'com.example.store.Store' prune 'com.example.geo.Country' }

Slide 62

Slide 62 text

wire { prune 'com.example.store.Store' prune 'com.example.geo.Country' }

Slide 63

Slide 63 text

Schema .proto Elements Java Kotlin Proto Schema Swift Parse Link Prune Generate wire { kotlin { includes = ['com.example.pizza.*'] excludes = ['com.example.sales.*'] exclusive = false out "${buildDir}/custom" } }

Slide 64

Slide 64 text

wire { ... kotlin { // Kotlin emits the matched types only. includes = [‘com.example.pizza.*'] exclusive = true } java { // Java gets everything else! } }

Slide 65

Slide 65 text

Schema .proto Elements Java Kotlin Proto Schema Swift Parse Link Prune Generate wire { custom { schemaHandlerFactoryClass = "MyHandlerFactory" } } Schema Handler Coming soon™

Slide 66

Slide 66 text

interface SchemaHandler { fun handle(schema: Schema, context: Context) interface Factory : Serializable { fun create(): SchemaHandler } } Coming soon™

Slide 67

Slide 67 text

Dependency management

Slide 68

Slide 68 text

Common • common/money.proto • common/customer.proto Service Trades • trade/payment.proto Service Bank • bank/balance.proto Mobile

Slide 69

Slide 69 text

Common • common/money.proto • common/customer.proto // money.proto syntax = "proto3"; package common; message Money { int64 amount = 1; Current currency = 2; } enum Currency { EUR = 0; GBP = 1; USD = 2; CAD = 3; } // customer.proto syntax = "proto3"; package common; message Customer { string token = 1; string name = 2; }

Slide 70

Slide 70 text

Common • common/money.proto • common/customer.proto wire { sourcePath { srcDir("src/main/proto") } }

Slide 71

Slide 71 text

Common • common/money.proto • common/customer.proto wire { sourcePath { srcDir("src/main/proto") } kotlin { } }

Slide 72

Slide 72 text

Common • common/money.proto • common/customer.proto wire { sourcePath { srcDir("src/main/proto") } kotlin { } } sourceSets { val main by getting { resources.srcDir( project.file(“src/main/proto/") ) } }

Slide 73

Slide 73 text

Common • common/money.proto • common/customer.proto wire { protoLibrary = true sourcePath { srcDir("src/main/proto") } kotlin { } }

Slide 74

Slide 74 text

Common • common/money.proto • common/customer.proto wire { protoLibrary = true sourcePath { srcDir("src/main/proto") } kotlin { } } jar published internally to 'app.cash.common:common'

Slide 75

Slide 75 text

Common • common/money.proto • common/customer.proto Service Trades • trade/payment.proto Service Bank • bank/balance.proto Mobile

Slide 76

Slide 76 text

Service Trades • trade/payment.proto syntax = "proto3"; package trade; import "common/customer.proto"; import "common/money.proto"; message PaymentRequest { string common.Money money = 1; string common.Customer recipient = 2; } message PaymentResponse {} service PaymentService { rpc Pay(PaymentRequest) returns (PaymentResponse); }

Slide 77

Slide 77 text

Service Trades • trade/payment.proto wire { protoLibrary = true sourcePath { srcDir("src/main/proto") } kotlin { } }

Slide 78

Slide 78 text

Service Trades • trade/payment.proto wire { protoLibrary = true protoPath { srcJar("app.cash.common:common:") } sourcePath { srcDir("src/main/proto") } kotlin { } }

Slide 79

Slide 79 text

Service Trades • trade/payment.proto wire { protoLibrary = true protoPath { srcJar("app.cash.common:common:") } sourcePath { srcDir("src/main/proto") } kotlin { } } dependencies { implementation("app.cash.common:common:") }

Slide 80

Slide 80 text

Service Trades • trade/payment.proto wire { protoLibrary = true protoPath { srcJar("app.cash.common:common:") } sourcePath { srcDir("src/main/proto") } kotlin { } } dependencies { implementation("app.cash.common:common:") } jar published internally to ‘app.cash.trade:trade'

Slide 81

Slide 81 text

Common • common/money.proto • common/customer.proto Service Trades • trade/payment.proto Service Bank • bank/balance.proto Mobile

Slide 82

Slide 82 text

Mobile wire { kotlin { } }

Slide 83

Slide 83 text

Mobile wire { kotlin { android = true } }

Slide 84

Slide 84 text

Mobile wire { sourcePath { srcJar("app.cash.trade:trade:") } sourcePath { srcJar("app.cash.balance:balance:") } kotlin { android = true } }

Slide 85

Slide 85 text

Mobile wire { sourcePath { srcJar("app.cash.common:common:") } sourcePath { srcJar("app.cash.trade:trade:") } sourcePath { srcJar("app.cash.balance:balance:") } kotlin { android = true } }

Slide 86

Slide 86 text

Common • common/money.proto • common/customer.proto Service Trades • trade/payment.proto Service Bank • bank/balance.proto Mobile

Slide 87

Slide 87 text

WIRE FIN

Slide 88

Slide 88 text

References • Protocol Bu ff ers documentations • https://developers.google.com/protocol-bu ff ers/ • Wire documentations • https://square.github.io/wire/ • Protogram • https://github.com/mattprecious/protogram

Slide 89

Slide 89 text

Protogram CLI Web

Slide 90

Slide 90 text

WIRE FIN for real