Key learnings and pitfalls from building mobile SDK

Slide 1

Slide 1 text

@zasadnyy Or what did we learn in the last 4 years Building mobile SDK Vitaliy Zasadnyy Head of Mobile @ GetSocial

Slide 2

Slide 2 text

@zasadnyy Integrated SDK. But it doesn’t work.

Slide 3

Slide 3 text

Developer. GDG Lead. Public Speaker. @zasadnyy

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

LISTEN

Slide 8

Slide 8 text

SDK Lifecycle

Slide 9

Slide 9 text

@zasadnyy SDK Lifecycle Develop 1

Slide 10

Slide 10 text

@zasadnyy

Slide 11

Slide 11 text

@zasadnyy SDK Lifecycle Develop 1

Slide 12

Slide 12 text

@zasadnyy SDK Lifecycle Develop 1 Integrate 2 Support 3 Update 4

Slide 13

Slide 13 text

Develop 1

Slide 14

Slide 14 text

@zasadnyy Start shaping your API Use Cases Examples Integration Tests

Slide 15

Slide 15 text

@zasadnyy Cost of fixing issue

Slide 16

Slide 16 text

@zasadnyy Cost of fixing issue Spend 10x more time on line of examples comparing to production code

Slide 17

Slide 17 text

@zasadnyy NOT SURE? DROP IT!

Slide 18

Slide 18 text

@zasadnyy IS BETTER LESS CODE

Slide 19

Slide 19 text

@zasadnyy Boilerplate ➡ Copy/Paste ➡ Bugs Why?

Slide 20

Slide 20 text

@zasadnyy GetSocial Analytics problem Almost all our clients mis-integrate analytics

Slide 21

Slide 21 text

@zasadnyy How to solve? AndroidManifest merging Gradle plugin Android Studion plugin …

Slide 22

Slide 22 text

@zasadnyy IS BETTER LESS CODE

Slide 23

Slide 23 text

@zasadnyy API SURPRISES AVOID

Slide 24

Slide 24 text

@zasadnyy Avoid API surprises Thread.interrupted() Returns the current interrupted status and then clears it

Slide 25

Slide 25 text

@zasadnyy Avoid API surprises

Slide 26

Slide 26 text

@zasadnyy Avoid API surprises Thread.interrupted() Returns the current interrupted status and then clears it

Slide 27

Slide 27 text

@zasadnyy Make the API to your library as boring as possible - Chris Sells, Google

Slide 28

Slide 28 text

@zasadnyy No SetListener() in C# void SetOnInviteFriendsListener ( Action onInviteFriendsIntent, Action onFriendsInvited)

Slide 29

Slide 29 text

@zasadnyy Much better API event Action OnInviteFriendsIntent event Action OnFriendsInvited

Slide 30

Slide 30 text

@zasadnyy Follow platform guidelines Mimic core API Avoid introducing new concepts

Slide 31

Slide 31 text

@zasadnyy ? Library is crashing you app?

Slide 32

Slide 32 text

@zasadnyy

Slide 33

Slide 33 text

@zasadnyy CRASH HOST APP NEVER

Slide 34

Slide 34 text

@zasadnyy GetSocial approach Rx @Nullable PMD / FindBugs / Lint

Slide 35

Slide 35 text

@zasadnyy Rx chains Observable .just(MetaDataKey.APP_ID) .map(ValidateAppIdFunc.create()) .flatMap(TrackInstallFunc.create()) ... .subscribe((result) -> { ... }, (throwable) -> { // all exceptions end up here } );

Slide 36

Slide 36 text

Slide 37

Slide 37 text

@zasadnyy

Slide 38

Slide 38 text

@zasadnyy INTERNALS HIDE

Slide 39

Slide 39 text

@zasadnyy Hide internals

Slide 40

Slide 40 text

@zasadnyy Hide internals Use .internal package Keep everything private by default

Slide 41

Slide 41 text

@zasadnyy There is much more!

Slide 42

Slide 42 text

Integrate

Slide 43

Slide 43 text

@zasadnyy ? What is important to developers?

Slide 44

Slide 44 text

@zasadnyy SIZE

Slide 45

Slide 45 text

@zasadnyy List information about Library size Method count Proguard rules

Slide 46

Slide 46 text

@zasadnyy COMPATIBILITY

Slide 47

Slide 47 text

@zasadnyy Keep compatibility Select minimum supported platform version. After detailed market research Update maximum supported version. Continuously

Slide 48

Slide 48 text

@zasadnyy SUPPORT

Slide 49

Slide 49 text

@zasadnyy Give a voice to your users GitHub issue tracker Intercom Support email …

Slide 50

Slide 50 text

@zasadnyy Get ready to repetitive questions

Slide 51

Slide 51 text

@zasadnyy DOCS

Slide 52

Slide 52 text

@zasadnyy Key parts Step by step tutorials Product guides API Reference

Slide 53

Slide 53 text

@zasadnyy

Slide 54

Slide 54 text

@zasadnyy

Slide 55

Slide 55 text

@zasadnyy

Slide 56

Slide 56 text

@zasadnyy What is wrong with snippet? CurrentUser user = getSocial.getCurrentUser();

Slide 57

Slide 57 text

@zasadnyy What is wrong with snippet? CurrentUser user = getSocial.getCurrentUser();

Slide 58

Slide 58 text

@zasadnyy ALL SNIPPETS MUST COMPILE

Slide 59

Slide 59 text

@zasadnyy Better snippet import im.getsocial.sdk.GetSocial; import im.getsocial.sdk.CurrentUser; ... CurrentUser user = GetSocial.getInstance().getCurrentUser();

Slide 60

Slide 60 text

@zasadnyy ? Favourite source of copy / paste code?

Slide 61

Slide 61 text

@zasadnyy

Slide 62

Slide 62 text

@zasadnyy DEMOS

Slide 63

Slide 63 text

@zasadnyy Demo apps Make demos well documented Keep SDK integration code separated

Slide 64

Slide 64 text

Support

Slide 65

Slide 65 text

@zasadnyy ? You’ve got support request. Now what?

Slide 66

Slide 66 text

@zasadnyy Two types of problems Integration time problems End-user side problems

Slide 67

Slide 67 text

@zasadnyy Solving integration time problems Easy way to get SDK version Debug SDK conﬁguration Unique log tag Actionable errors

Slide 68

Slide 68 text

@zasadnyy Actionable errors public class GetSocialException extends RuntimeException { private final int _errorCode; … }

Slide 69

Slide 69 text

@zasadnyy Actionable errors public class GetSocialException extends RuntimeException { private final int _errorCode; … }

Slide 70

Slide 70 text

@zasadnyy Solving end-user side problems Comprehensive logs Errors analytics

Slide 71

Slide 71 text

@zasadnyy Solving end-user side problems private void trackError(GetSocialException exception) { ... AnalyticsTrackManager.trackAnalyticsEvent( AnalyticsEventDetails.Name.SDK_ERROR, eventProperties); }

Slide 72

Slide 72 text

@zasadnyy s THINK ABOUT SUPPORT AHEAD

Slide 73

Slide 73 text

Update

Slide 74

Slide 74 text

@zasadnyy ? Why developers update SDKs?

Slide 75

Slide 75 text

@zasadnyy Update. Build. And…

Slide 76

Slide 76 text

@zasadnyy

Slide 77

Slide 77 text

@zasadnyy UPDATES SMOOTH

Slide 78

Slide 78 text

@zasadnyy Backward compatibility Use @Deprecation cycle /** * @deprecated use {@link #getAllIdentities()} instead. * Method will be removed in SDK v5.0.0. */ @Deprecated public List getIdentities() { ... }

Slide 79

Slide 79 text

@zasadnyy Semantic versioning v4.5.1 Major Minor Bugﬁx

Slide 80

Slide 80 text

@zasadnyy Versioned packages import okhttp3; import im.getsocial.sdk6;

Slide 81

Slide 81 text

@zasadnyy Versioned packages import okhttp3; import im.getsocial.sdk6; Partial transition A/B testing

Slide 82

Slide 82 text

@zasadnyy Changelog Fixed issues Added features Compatibility changes API changes

Slide 83

Slide 83 text

@zasadnyy

Slide 84

Slide 84 text

To sum up

Slide 85

Slide 85 text

@zasadnyy SDK Lifecycle Develop 1

Slide 86

Slide 86 text

@zasadnyy SDK Lifecycle Develop Integrate Support Update 1 2 3 4

Slide 87

Slide 87 text

@zasadnyy Develop 1 Integrate 2 Support 3 Update 4 Not sure? Drop it! Never crash Be your own customer Think ahead Smooth

Slide 88

Slide 88 text

@zasadnyy API can be you biggest asset of liability - Joshua Bloch Put yourself in your customer’s shoes - Cesare Rocchi