feat: offline support #171

Mercy811 · 2024-01-02T05:42:26Z

Summary

Requirements

ACCESS_NETWORK_STATE permission is required. If not, this feature will not supported and will fallback to previous behavior (causing an error)

User interfaces

This feature is enabled by default.

To opt out of using AndroidNetworkConnectivityPlugin and implement custom offline logic, setting config.offline to null will prevent plugin setup.

// Disable this feature
amplitude = Amplitude(
    Configuration(
        apiKey = AMPLITUDE_API_KEY,
        context = applicationContext,
        offline = AndroidNetworkConnectivityCheckerPlugin.Disabled
    )
)

// Implement your own plugin to toggle offline

Implementation

AndroidNetworkConnectivityPlugin
- Network connectivity checker will detect network connectivity when setup and set config.offline accordingly
- Network listener will flush all stored events when back to online
EventPipeline
- If no network, it will only save events to storage and will not schedule a flush
- Otherwise (network connected, no permission, feature disabled), save events and schedule a flush

Checklist

Does your PR title have the correct title format?
Does your PR have a breaking change?:

Save events on offline and send out when back to online automatically

core/src/main/java/com/amplitude/core/platform/plugins/AmplitudeDestination.kt

android/src/main/java/com/amplitude/android/Amplitude.kt

core/src/main/java/com/amplitude/core/platform/plugins/AmplitudeDestination.kt

android/src/main/java/com/amplitude/android/Amplitude.kt

This reverts commit db0dace.

android/src/main/java/com/amplitude/android/Amplitude.kt

android/src/main/java/com/amplitude/android/utilities/AndroidNetworkConnectivityChecker.kt

android/src/main/java/com/amplitude/android/utilities/AndroidNetworkListener.kt

android/src/test/java/com/amplitude/android/plugins/AndroidLifecyclePluginTest.kt

core/src/main/java/com/amplitude/core/platform/plugins/AmplitudeDestination.kt

android/src/main/java/com/amplitude/android/plugins/AndroidNetworkConnectivityCheckerPlugin.kt

core/src/main/java/com/amplitude/core/Configuration.kt

Mercy811

Move network listener from Amplitude to the network connectivity plugin. So that customers can remove the plugin and have their own offline implementation.

android/src/main/java/com/amplitude/android/plugins/AndroidNetworkConnectivityCheckerPlugin.kt

android/src/main/java/com/amplitude/android/utilities/AndroidNetworkConnectivityChecker.kt

core/src/main/java/com/amplitude/core/Configuration.kt

android/src/main/java/com/amplitude/android/plugins/AndroidNetworkConnectivityCheckerPlugin.kt

android/src/main/java/com/amplitude/android/utilities/AndroidNetworkConnectivityChecker.kt

Mercy811

Check how to remove a plugin.

Plugins are removed by reference. So come up with another way to disable the default plugin by setting config.offline to null.

core/src/main/java/com/amplitude/core/platform/Timeline.kt

samples/java-android-app/src/main/java/com/amplitude/android/sample/MainApplication.java

android/src/main/java/com/amplitude/android/plugins/AndroidNetworkConnectivityCheckerPlugin.kt

...d/src/test/java/com/amplitude/android/plugins/AndroidNetworkConnectivityCheckerPluginTest.kt

android/src/main/java/com/amplitude/android/Amplitude.kt

samples/java-android-app/src/main/java/com/amplitude/android/sample/MainApplication.java

android/src/main/java/com/amplitude/android/Amplitude.kt

samples/java-android-app/src/main/java/com/amplitude/android/sample/MainApplication.java

Co-authored-by: Justin Fiedler <[email protected]>

justin-fiedler

Thanks @Mercy811 !

# [1.13.0](v1.12.2...v1.13.0) (2024-01-24) ### Features * offline support ([#171](#171)) ([669eead](669eead))

github-actions · 2024-01-24T01:15:06Z

🎉 This PR is included in version 1.13.0 🎉

The release is available on:

GitHub release
v1.13.0

Your semantic-release bot 📦🚀

feat: offline support

94a2d51

Save events on offline and send out when back to online automatically

Mercy811 marked this pull request as ready for review January 2, 2024 16:57

Mercy811 requested review from justin-fiedler, izaaz and qingzhuozhen January 2, 2024 16:57

remove network permission

6d0680d

qingzhuozhen suggested changes Jan 2, 2024

View reviewed changes

core/src/main/java/com/amplitude/core/platform/plugins/AmplitudeDestination.kt Outdated Show resolved Hide resolved

android/src/main/java/com/amplitude/android/Amplitude.kt Outdated Show resolved Hide resolved

qingzhuozhen reviewed Jan 2, 2024

View reviewed changes

Mercy811 added 3 commits January 2, 2024 14:24

remove NetworkChangeCallback interface for Amplitude

70e5ff4

Suppress missing permission lint

92d3d7d

Revert "Delete EventPipelineTest.kt"

564f308

This reverts commit db0dace.

justin-fiedler reviewed Jan 3, 2024

View reviewed changes

Mercy811 added 3 commits January 3, 2024 09:49

revert lint changes

acfab11

add docs link to add permission

7e95fd0

add android network checker plugin

bcd0721

Mercy811 requested review from justin-fiedler and qingzhuozhen January 3, 2024 22:58

qingzhuozhen reviewed Jan 4, 2024

View reviewed changes

android/src/main/java/com/amplitude/android/plugins/AndroidNetworkConnectivityCheckerPlugin.kt Outdated Show resolved Hide resolved

core/src/main/java/com/amplitude/core/Configuration.kt Outdated Show resolved Hide resolved

Update Configuration.kt

ea4753e

Mercy811 requested a review from qingzhuozhen January 4, 2024 05:55

Mercy811 commented Jan 8, 2024

View reviewed changes

move network listener to plugin and rename to offline

9c5702f

justin-fiedler suggested changes Jan 9, 2024

View reviewed changes

offline

0acb081

Mercy811 requested a review from justin-fiedler January 11, 2024 18:18

Mercy811 commented Jan 11, 2024

View reviewed changes

disable offline when null

bbe2b57

qingzhuozhen reviewed Jan 12, 2024

View reviewed changes

Update Timeline.kt

6db25e4

Mercy811 requested a review from justin-fiedler January 12, 2024 18:36

Mercy811 requested a review from qingzhuozhen January 12, 2024 18:36

should not install plugin if null

931ba2c

justin-fiedler reviewed Jan 16, 2024

View reviewed changes

Mercy811 added 2 commits January 17, 2024 15:46

add Disable constant

4488d99

add package

cbbcd9a

Mercy811 requested a review from justin-fiedler January 22, 2024 22:32

justin-fiedler reviewed Jan 22, 2024

View reviewed changes

android/src/main/java/com/amplitude/android/Amplitude.kt Outdated Show resolved Hide resolved

samples/java-android-app/src/main/java/com/amplitude/android/sample/MainApplication.java Outdated Show resolved Hide resolved

Mercy811 and others added 3 commits January 22, 2024 15:20

Update android/src/main/java/com/amplitude/android/Amplitude.kt

7c4d418

Co-authored-by: Justin Fiedler <[email protected]>

Use default method

f01adb9

chore

704c7f8

Mercy811 requested a review from justin-fiedler January 23, 2024 23:26

justin-fiedler approved these changes Jan 23, 2024

View reviewed changes

qingzhuozhen approved these changes Jan 24, 2024

View reviewed changes

Mercy811 merged commit 669eead into main Jan 24, 2024
3 checks passed

Mercy811 deleted the AMP-90600-offline branch January 24, 2024 00:49

github-actions bot pushed a commit that referenced this pull request Jan 24, 2024

chore(release): 1.13.0 [skip ci]

1ee97e6

# [1.13.0](v1.12.2...v1.13.0) (2024-01-24) ### Features * offline support ([#171](#171)) ([669eead](669eead))

github-actions bot added the released label Jan 24, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: offline support #171

feat: offline support #171

Mercy811 commented Jan 2, 2024 •

edited

Loading

Mercy811 left a comment

Mercy811 left a comment •

edited

Loading

justin-fiedler left a comment

github-actions bot commented Jan 24, 2024

feat: offline support #171

feat: offline support #171

Conversation

Mercy811 commented Jan 2, 2024 • edited Loading

Summary

Requirements

User interfaces

Implementation

Checklist

Mercy811 left a comment

Choose a reason for hiding this comment

Mercy811 left a comment • edited Loading

Choose a reason for hiding this comment

justin-fiedler left a comment

Choose a reason for hiding this comment

github-actions bot commented Jan 24, 2024

Mercy811 commented Jan 2, 2024 •

edited

Loading

Mercy811 left a comment •

edited

Loading