How not to fuckup with building mobile SDK and make clients happy (DevFest Prague)

@zasadnyy With building the mobile SDK How not to Fuck
Up Vitaliy Zasadnyy Head of Mobile @ GetSocial

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

Developer. GDG Lead. Public Speaker. @zasadnyy

@zasadnyy UNDERSTANDING “WHY?” BETTER DEVELOPER MAKES YOU A

@zasadnyy My first library… Develop

@zasadnyy

@zasadnyy SDK Lifecycle Develop 1

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

Develop 1

Integrate

<receiver android:name="im.getsocial.InstallReferrerReceiver"> <intent-filter> <action android:name="com.android.vending.INSTALL_REFERRER"/> </intent-filter> </receiver> <provider android:name="im.getsocial.sdk.invites.ImageContentProvider" <meta-data
android:name="im.getsocial.sdk.AppId" android:value="LuDPp7W0J4"/> <activity android:name="com.demo.GetSocialDeepLinkingActivity"> <intent-filter> <action android:name="android.intent.action.VIEW"/> <category android:name="android.intent.category.DEFAULT"/> <category android:name="android.intent.category.BROWSABLE"/> <data android:scheme="https" android:host="demo.gsc.im"/> <data android:scheme="getsocial" android:host="LuDPp7W0J4"/> </intent-filter> </activity> GetSocial.init()

@zasadnyy Android manifest merging App manifest Lib 1 manifest Lib
2 manifest Lib N manifest …

@zasadnyy Gradle plugin apply plugin: 'im.getsocial'

@zasadnyy Gradle plugin apply plugin: 'im.getsocial' getsocial { appId "LGa80P9790xsg4"
}

@zasadnyy Android Studio plugin

@zasadnyy Auto initialisation <provider android:name="im.getsocial.AutoInitContentProvider" android:authorities="..." android:exported="false" />

@zasadnyy Boilerplate ➡ Copy/Paste ➡ Bugs Why?

@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 API of your library as boring as possible
- Chris Sells, Google

@zasadnyy

@zasadnyy INTERNALS HIDE

@zasadnyy Hide internals

@zasadnyy Hide internals Use .internal package Keep everything private by
default Bonus: easy to generate Javadocs

@zasadnyy There is much more!

@zasadnyy ? Library is crashing your app?

@zasadnyy

@zasadnyy CRASH HOST APP NEVER

@zasadnyy Prevent crashes Rx @Nullable / PMD / FindBugs /
Lint Development Mode

@zasadnyy Development mode if (BuildConfig.IS_DEVELOPMENT) { _executionPolicy = new StrictExecutionPolicy();
}

@zasadnyy Development mode if (BuildConfig.IS_DEVELOPMENT) { _executionPolicy = new StrictExecutionPolicy();
} else { _executionPolicy = new SilentExecutionPolicy(); }

@zasadnyy SUPPORT

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

@zasadnyy Get ready to repetitive questions

@zasadnyy DOCS

@zasadnyy Documentation is like sex. Even bad is better than
nothing

@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();

Google Developers Documentation Style Guide

@zasadnyy Documentation engine GitHub Wiki Jekyll MkDocs …

@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 Easy way to collect DEBUG information

@zasadnyy Debug SDK configuration adb shell setprop debug.getsocial.sdk.app com.demo

@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 void trackError(GetSocialException exception) { ...
AnalyticsTrackManager.trackAnalyticsEvent( AnalyticsEventDetails.Name.SDK_ERROR, eventProperties); }

@zasadnyy

@zasadnyy THINK ABOUT SUPPORT AHEAD

Update

@zasadnyy ? Just download and lean back?

@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 Partial transition A/B testing import okhttp3; import
im.getsocial.sdk6;

@zasadnyy Changelog Fixed issues New features Deprecations Upgrade guide

@zasadnyy

To sum up

@zasadnyy PER APP 17 SDKs Source: Safe SDK

@zasadnyy SDK Lifecycle Develop 1

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

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

@zasadnyy Happy dog Make clients happy again.

@zasadnyy Find me at: @zasadnyy / zasadnyy.com Questions? Děkuji! Get
the app at: devfestcz.gsc.im/1/getamos

How not to fuckup with building mobile SDK and make clients happy (DevFest Prague)

How not to fuckup with building mobile SDK and make clients happy (DevFest Prague)

More Decks by Vitaliy Zasadnyy

Other Decks in Technology

Featured

Transcript