Key learnings and pitfalls from building mobile SDK

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

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

Developer. GDG Lead. Public Speaker. @zasadnyy

LISTEN

SDK Lifecycle

@zasadnyy SDK Lifecycle Develop 1

@zasadnyy

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

Develop 1

@zasadnyy Start shaping your API Use Cases Examples Integration Tests

@zasadnyy Cost of fixing issue

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

@zasadnyy NOT SURE? DROP IT!

@zasadnyy IS BETTER LESS CODE

@zasadnyy Boilerplate ➡ Copy/Paste ➡ Bugs Why?

@zasadnyy GetSocial Analytics problem Almost all our clients mis-integrate analytics
<receiver android:name="im.getsocial.InstallReferrerReceiver"> <intent-filter> <action android:name="com.android.vending.INSTALL_REFERRER"/> </intent-filter> </receiver>

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

@zasadnyy IS BETTER LESS CODE

@zasadnyy API SURPRISES AVOID

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

@zasadnyy Avoid API surprises

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

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

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

@zasadnyy Much better API event Action OnInviteFriendsIntent event Action<int> OnFriendsInvited

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

@zasadnyy ? Library is crashing you app?

@zasadnyy

@zasadnyy CRASH HOST APP NEVER

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

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

@zasadnyy

@zasadnyy INTERNALS HIDE

@zasadnyy Hide internals

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

@zasadnyy There is much more!

Integrate

@zasadnyy ? What is important to developers?

@zasadnyy SIZE

@zasadnyy List information about Library size Method count Proguard rules

@zasadnyy COMPATIBILITY

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

@zasadnyy SUPPORT

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

@zasadnyy Get ready to repetitive questions

@zasadnyy DOCS

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

@zasadnyy

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

@zasadnyy ALL SNIPPETS MUST COMPILE

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

@zasadnyy ? Favourite source of copy / paste code?

@zasadnyy

@zasadnyy DEMOS

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

Support

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

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

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

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

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

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

@zasadnyy s THINK ABOUT SUPPORT AHEAD

Update

@zasadnyy ? Why developers update SDKs?

@zasadnyy Update. Build. And…

@zasadnyy

@zasadnyy UPDATES SMOOTH

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

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

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

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

@zasadnyy Changelog Fixed issues Added features Compatibility changes API changes

@zasadnyy

To sum up

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

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

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

@zasadnyy Happy dog Make developers happy again.

@zasadnyy @zasadnyy / zasadnyy.com Questions? Mulțumesc!

Key learnings and pitfalls from building mobile SDK

Key learnings and pitfalls from building mobile SDK

More Decks by Vitaliy Zasadnyy

Other Decks in Technology

Featured

Transcript