Impact Analysis

The following numbers are representative of a skeletal sample app integrated with the Helpshift Unity plugin.

App Launch Time

Since all the Helpshift initialization takes place on a background thread, the Helpshift SDK does not affect app launch times.

Secondary Dex specifications

For tackling the method count limit of 65536 on android, we have introduced Helpshift SDK dex file. Helpshift SDK loads its own dex file in a background thread without affecting the application performance.

The dex will be loaded on the first call to HelpshiftSdk.getInstance() in the application's lifecycle.

Applies to v2.3.1 and above.

Unified dex specifications

Dex loading generally takes around 8-9 seconds on the very first load. (i.e the first time HelpshiftSdk.getInstance() is called after app install) For subsequent loads (i.e on first HelpshiftSdk.getInstance() call on app restarts) it is cached and would take around 100-150ms.

If your app is already using multidex setup, Helpshift SDK will not affect it since it is independent of the other dex files.

Integration impact :

  1. Since unified dex package already includes android support libraries, it is assumed that no other plugin uses the android support libraries.
  2. Remove the previous Helpshift package from your Unity project as it may duplicate code between dex and android support libraries. After importing the new unity package make sure there are no jar files in the following locations :
    1. /Assets/Plugins/Android/appcompat/libs
    2. /Assets/Plugins/Android/cardview/libs
    3. /Assets/Plugins/Android/recyclerview/libs
    4. /Assets/Plugins/Android/design/libs
  3. After importing the unity package make sure that the following jar file exists :
    1. /Assets/Plugins/Android/helpshift/libs/helpshiftloader.jar
    2. /Assets/Plugins/Android/helpshift/helpshiftnotificationhandler.jar
  4. After importing the unity package, make sure that the dex file exists at /Assets/Plugins/Android/assets/helpshift/helpshift_classes.dex
  5. No modifications to existing API signatures.

Helpshift SDK-only dex specifications

Dex loading generally takes around 2-3 seconds on the very first load. (i.e the first time HelpshiftSdk.getInstance() is called after app install) For subsequent loads (i.e on first HelpshiftSdk.getInstance() call on app restarts) it is cached and would take around 100-150ms.

If your app is already using multidex setup, Helpshift SDK will not affect it since it is independent of the other dex files.

Integration impact :

  1. Remove the previous Helpshift package from your Unity project.
  2. After importing the unity package make sure that the following jar file exists :
    1. /Assets/Plugins/Android/helpshift/libs/helpshiftloader.jar
    2. /Assets/Plugins/Android/helpshift/helpshiftnotificationhandler.jar
  3. After importing the unity package, make sure that the dex file exists at /Assets/Plugins/Android/assets/helpshift/helpshift_classes.dex
  4. If android support libraries are used by any other plugin then you can deselect the required libraires when importing the unity package.
  5. No modifications to existing API signatures.

v2.8.1

Unified SDK dex details :

  1. The dex file includes :
  2. Helpshift SDK.
  3. Appcompat library support-v7 (Version 23.4.0)
  4. support-v4 (Version 23.4.0)
  5. support-vector-drawable (Version 23.4.0)
  6. Cardview library. (Version 23.4.0)
  7. Recyclerview library. (Version 23.4.0)
  8. Design library. (Version 23.4.0)
  9. File size : 3.3 MB
  10. Method count : 27200

Helpshift SDK-only dex details :

  1. The dex file includes only Helpshift SDK code.
  2. File size : 1.1 MB
  3. Method count : 7641

The Helpshift Unity SDK for Android will add 2.8 MB to your application apk.

SDK Memory usage

Memory usage for the SDK screen launches.

Support API launch Memory Usage (approx. MB)
After adding Helpshift install call 1.00
showFAQs 3.90
showFAQSection 5.13
showSingleFAQ 4.01
showConversation (with no open Conversation) 2.94
showConversation (with an open Conversation) 4.30
showInbox (Campaigns) 2.30

Tested with a demo app. Usage will increase with number of FAQs and number of messages in a conversation.

v2.8.0

Unified SDK dex details :

  1. The dex file includes :
    1. Helpshift SDK.
    2. Appcompat library support-v7 (Version 23.4.0)
    3. support-v4 (Version 23.4.0)
    4. support-vector-drawable (Version 23.4.0)
    5. Cardview library. (Version 23.4.0)
    6. Recyclerview library. (Version 23.4.0)
    7. Design library. (Version 23.4.0)
  2. File size : 3.3 MB
  3. Method count : 27200

Helpshift SDK-only dex details :

  1. The dex file includes only Helpshift SDK code.
  2. File size : 1.1 MB
  3. Method count : 7641

The Helpshift Unity SDK for Android will add 2.8 MB to your application apk.

SDK Memory usage

Memory usage for the SDK screen launches.

Support API launch Memory Usage (approx. MB)
After adding Helpshift install call 1.00
showFAQs 3.90
showFAQSection 5.13
showSingleFAQ 4.01
showConversation (with no open Conversation) 2.94
showConversation (with an open Conversation) 4.30
showInbox (Campaigns) 2.30

Tested with a demo app. Usage will increase with number of FAQs and number of messages in a conversation.

v2.7.0

Unified SDK dex details :

  1. The dex file includes :
    1. Helpshift SDK.
    2. Appcompat library support-v7 (Version 23.4.0)
    3. support-v4 (Version 23.4.0)
    4. support-vector-drawable (Version 23.4.0)
    5. Cardview library. (Version 23.4.0)
    6. Recyclerview library. (Version 23.4.0)
    7. Design library. (Version 23.4.0)
  2. File size : 3.0 MB
  3. Method count : 25453

Helpshift SDK-only dex details :

  1. The dex file includes only Helpshift SDK code.
  2. File size : 832 kB
  3. Method count : 5857

The Helpshift Unity SDK for Android will add 3 MB to your application apk.

SDK Memory usage

Memory usage for the SDK screen launches.

Support API launch Memory Usage (approx. MB)
After adding Helpshift install call 1.00
showFAQs 4.50
showFAQSection 3.40
showSingleFAQ 3.53
showConversation (with no open Conversation) 3.60
showConversation (with an open Conversation) 4.23
showInbox (Campaigns) 2.35

Tested with a demo app. Usage will increase with number of FAQs and number of messages in a conversation.

v2.6.1

Unified SDK dex details :

  1. The dex file includes :
    1. Helpshift SDK.
    2. Appcompat library support-v7 (Version 23.4.0)
    3. support-v4 (Version 23.4.0)
    4. support-vector-drawable (Version 23.4.0)
    5. Cardview library. (Version 23.4.0)
    6. Recyclerview library. (Version 23.4.0)
    7. Design library. (Version 23.4.0)
  2. File size : 3.0 MB
  3. Method count : 24637

Helpshift SDK-only dex details :

  1. The dex file includes only Helpshift SDK code.
  2. File size : 749 kB
  3. Method count : 4661

The Helpshift Unity SDK for Android will add 3 MB to your application apk.

SDK Memory usage

Memory usage for the SDK screen launches.

Support API launch Memory Usage (approx. MB)
After adding Helpshift install call 1.00
showFAQs 3.65
showFAQSection 2.11
showSingleFAQ 2.20
showConversation (with no open Conversation) 2.12
showConversation (with an open Conversation) 2.10
showInbox (Campaigns) 0.66

Tested with a demo app. Usage will increase with number of FAQs and number of messages in a conversation.

v2.5.0

Integration impact

If you are upgrading from older versions of the Helpshift Unity package then please remove the following folders from /Assets/Plugins/Android

  1. appcompat
  2. design
  3. cardview
  4. recyclerview

This version is packaged with required android support libs v23.4.0 and is also tested with Android Nougat devices.

If the developer wants to integrate with android support libs 24.x, there are reported issues on pre-lolipop devices Refer this blog and the issue here.

Unity does not support android build for the vector changes introduced in 24.x version. Refer here

Helpshift Unity plugin is tested with 24.x support lib version but does not work on pre-lollipop devices because of the Unity android build incompatibility.

Unified SDK dex details :

  1. The dex file includes :
    1. Helpshift SDK.
    2. Appcompat library support-v7 (Version 23.4.0)
    3. support-v4 (Version 23.4.0)
    4. support-vector-drawable (Version 23.4.0)
    5. Cardview library. (Version 23.4.0)
    6. Recyclerview library. (Version 23.4.0)
    7. Design library. (Version 23.4.0)
  2. File size : 3.0 MB
  3. Method count : 24637

Helpshift SDK-only dex details :

  1. The dex file includes only Helpshift SDK code.
  2. File size : 760 kB
  3. Method count : 5454

The Helpshift Unity SDK for Android will add 2.7 MB to your application apk.

SDK Memory usage

Memory usage for the SDK screen launches.

Support API launch Memory Usage (approx. MB)
After adding Helpshift install call 2.08
showFAQs 7.12
showFAQSection 4.4
showSingleFAQ 4.73
showConversation (with no open Conversation) 3.79
showConversation (with an open Conversation) 6.84
showInbox (Campaigns) 1.70

Tested with a demo app on Moto G4 Plus running Android 6.0.1. Usage will increase with number of FAQs and number of messages in a conversation.

v2.4.0

Unified SDK dex details :

  1. The dex file includes :
    1. Helpshift SDK.
    2. Appcompat library i.e android-support-v4 and android-support-v7. (Version 23.0.1)
    3. Cardview library. (Version 23.0.1)
    4. Recyclerview library. (Version 23.0.1)
    5. Design library. (Version 23.0.1)
  2. File size : 2.9 MB
  3. Method count : 24913

Helpshift SDK-only dex details :

  1. The dex file includes only Helpshift SDK code.
  2. File size : 737 kB
  3. Method count : 5283

The Helpshift Unity SDK for Android will add 2.5 MB to your application apk.

SDK Memory usage

Memory usage for the SDK screen launches.

Support API launch Memory Usage (approx. MB)
After adding Helpshift install call 2.64
showFAQs 8.00
showFAQSection 6.19
showSingleFAQ 6.53
showConversation (with no open Conversation) 4.86
showConversation (with an open Conversation) 5.63
showInbox (Campaigns) 1.63

Tested with a demo app. Usage will increase with number of FAQs and number of messages in a conversation.

v2.3.1

Unified SDK dex details :

  1. The dex file includes :
    1. Helpshift SDK.
    2. Appcompat library i.e android-support-v4 and android-support-v7. (Version 23.0.1)
    3. Cardview library. (Version 23.0.1)
    4. Recyclerview library. (Version 23.0.1)
    5. Design library. (Version 23.0.1)
  2. File size : 2.8 MB
  3. Method count : 23903

Helpshift SDK-only dex details :

  1. The dex file includes only Helpshift SDK code.
  2. File size : 726 kB
  3. Method count : 5227

The Helpshift Unity SDK for Android will add 2.5 MB to your application apk.

SDK memory usage

Memory usage for the SDK support screen launches.

Support API launch Memory Usage (approx. MB)
showConversation (with no Conversation) 5.18
showConversation (with already running Conversation) 6.02
showFAQs 5.99
showFAQSection 7.15
showSingleFAQ 6.97
showInbox (Campaigns) 1.58

Tested with a demo app. Usage will increase with number of FAQs and number of messages in a conversation.

v2.2.0-support

The Helpshift Unity SDK for Android will add 581 KB to your application apk.

SDK memory usage

Memory usage for the SDK support screen launches.

Support API launch Memory Usage (approx. MB)
showConversation (with no Conversation) 1.1
showConversation (with already running Conversation) 0.63
showFAQs 8.25
showFAQSection 7.91
showSingleFAQ 2.07

Tested with a demo app. Usage will increase with number of FAQs and number of messages in a conversation.