feat: add telemetry settings

Minishlink · Minishlink · commit 9a7de94bce74 · 2025-04-01T12:07:44.000+02:00
diff --git a/android/app/src/main/java/com/appzung/codepush/react/CodePushConstants.java b/android/app/src/main/java/com/appzung/codepush/react/CodePushConstants.java
@@ -32,4 +32,5 @@ public class CodePushConstants {
     public static final String LATEST_ROLLBACK_TIME_KEY = "time";
     public static final String LATEST_ROLLBACK_COUNT_KEY = "count";
     public static final String CLIENT_UNIQUE_ID_KEY = "clientUniqueId";
+    public static final String TELEMETRY_ENABLED_KEY = "telemetryEnabled";
 }
diff --git a/android/app/src/main/java/com/appzung/codepush/react/CodePushNativeModule.java b/android/app/src/main/java/com/appzung/codepush/react/CodePushNativeModule.java
@@ -49,6 +49,7 @@
 public class CodePushNativeModule extends BaseJavaModule {
     private String mBinaryContentsHash = null;
     private String mClientUniqueId = null;
+    private boolean mTelemetryEnabled = true;
     private LifecycleEventListener mLifecycleEventListener = null;
     private int mMinimumBackgroundDuration = 0;
 
@@ -78,6 +79,17 @@ public CodePushNativeModule(ReactApplicationContext reactContext, CodePush codeP
             mClientUniqueId = UUID.randomUUID().toString();
             preferences.edit().putString(CodePushConstants.CLIENT_UNIQUE_ID_KEY, mClientUniqueId).apply();
         }
+
+        if (preferences.contains(CodePushConstants.TELEMETRY_ENABLED_KEY)) {
+            mTelemetryEnabled = preferences.getBoolean(CodePushConstants.TELEMETRY_ENABLED_KEY, true);
+        } else {
+            int defaultTelemetryEnabledResId = reactContext.getResources().getIdentifier("CodePushDefaultTelemetryEnabled", "bool", reactContext.getPackageName());
+            if (defaultTelemetryEnabledResId != 0) {
+                mTelemetryEnabled = reactContext.getResources().getBoolean(defaultTelemetryEnabledResId);
+            } else {
+                mTelemetryEnabled = true;
+            }
+        }
     }
 
     @Override
@@ -485,6 +497,7 @@ public void getConfiguration(Promise promise) {
             configMap.putString("clientUniqueId", mClientUniqueId);
             configMap.putString("releaseChannelPublicId", mCodePush.getReleaseChannelPublicId());
             configMap.putString("serverUrl", mCodePush.getServerUrl());
+            configMap.putBoolean("telemetryEnabled", mTelemetryEnabled);
 
             // The binary hash may be null in debug builds
             if (mBinaryContentsHash != null) {
@@ -834,6 +847,24 @@ public void resetClientUniqueId(Promise promise) {
         }
     }
 
+    @ReactMethod
+    public void setTelemetryEnabled(boolean enabled, Promise promise) {
+        try {
+            SharedPreferences preferences = mCodePush.getContext().getSharedPreferences(CodePushConstants.CODE_PUSH_PREFERENCES, 0);
+            preferences.edit().putBoolean(CodePushConstants.TELEMETRY_ENABLED_KEY, enabled).apply();
+            mTelemetryEnabled = enabled;
+            promise.resolve(null);
+        } catch (Exception e) {
+            CodePushUtils.log(e);
+            promise.reject(e);
+        }
+    }
+
+    @ReactMethod
+    public void getTelemetryEnabled(Promise promise) {
+        promise.resolve(mTelemetryEnabled);
+    }
+
     @ReactMethod
     public void addListener(String eventName) {
         // Set up any upstream listeners or background tasks as necessary
diff --git a/docs/advanced-usage.md b/docs/advanced-usage.md
@@ -1,5 +1,60 @@
 ## Advanced usage
 
+### Privacy / GDPR
+
+#### Telemetry
+
+CodePush collects anonymous usage data by default to help improve the service (e.g. to provide you with analytics).
+To be fully compliant with GDPR and other privacy regulations, you may want to disable this telemetry collection.
+
+##### Disabling telemetry by default
+
+You can disable telemetry collection by default by configuring your native app:
+
+**Android:**
+
+Add this to your `android/app/build.gradle` file:
+
+```groovy
+android {
+    // ...
+    defaultConfig {
+        // ...
+        resValue "bool", "CodePushDefaultTelemetryEnabled", "false"
+    }
+}
+```
+
+**iOS:**
+
+Add this to your `ios/YourApp/Info.plist` file:
+
+```
+<key>CodePushDefaultTelemetryEnabled</key>
+<false/>
+```
+
+##### Managing telemetry during runtime
+
+You can also programmatically check or change telemetry status during app runtime:
+
+```typescript
+import * as CodePush from '@appzung/react-native-code-push';
+
+// Check if telemetry is enabled
+CodePush.getTelemetryEnabled().then((enabled) => {
+  console.log('Telemetry is ' + (enabled ? 'enabled' : 'disabled'));
+});
+
+// Enable telemetry
+CodePush.setTelemetryEnabled(true);
+
+// Disable telemetry
+CodePush.setTelemetryEnabled(false);
+```
+
+This setting will persist across app sessions.
+
 ### Multiple environments
 
 #### Staging / Production
@@ -43,7 +98,7 @@ In order to achieve this kind of workflow, all you need to do is specify the rel
 ```javascript
 // Imagine that "userProfile" is a prop that this component received
 // which includes the release channel public ID that the current user should use.
-codePush.sync({ releaseChannelPublicId: userProfile.RELEASE_CHANNEL_PUBLIC_ID });
+CodePush.sync({ releaseChannelPublicId: userProfile.RELEASE_CHANNEL_PUBLIC_ID });
 ```
 
 With that change in place, now it's just a matter of choosing how your app determines the right release channel for the current user. In practice, there are typically two solutions for this:
diff --git a/docs/api-js/README.md b/docs/api-js/README.md
@@ -43,11 +43,13 @@
 - [disallowRestart](functions/disallowRestart.md)
 - [getClientUniqueId](functions/getClientUniqueId.md)
 - [getLogLevel](functions/getLogLevel.md)
+- [getTelemetryEnabled](functions/getTelemetryEnabled.md)
 - [getUpdateMetadata](functions/getUpdateMetadata.md)
 - [notifyAppReady](functions/notifyAppReady.md)
 - [resetClientUniqueId](functions/resetClientUniqueId.md)
 - [restartApp](functions/restartApp.md)
 - [setLogLevel](functions/setLogLevel.md)
+- [setTelemetryEnabled](functions/setTelemetryEnabled.md)
 - [sync](functions/sync.md)
 - [withCodePush](functions/withCodePush.md)
 
diff --git a/docs/api-js/functions/getTelemetryEnabled.md b/docs/api-js/functions/getTelemetryEnabled.md
@@ -0,0 +1,17 @@
+[**@appzung/react-native-code-push v11.0.0-rc5**](../README.md)
+
+---
+
+[@appzung/react-native-code-push](../README.md) / getTelemetryEnabled
+
+# Function: getTelemetryEnabled()
+
+> **getTelemetryEnabled**(): `Promise`\<`boolean`\>
+
+Gets the current telemetry enabled status.
+
+When setTelemetryEnabled has never been enabled, returns the default value set in your configuration.
+
+## Returns
+
+`Promise`\<`boolean`\>
diff --git a/docs/api-js/functions/setTelemetryEnabled.md b/docs/api-js/functions/setTelemetryEnabled.md
@@ -0,0 +1,23 @@
+[**@appzung/react-native-code-push v11.0.0-rc5**](../README.md)
+
+---
+
+[@appzung/react-native-code-push](../README.md) / setTelemetryEnabled
+
+# Function: setTelemetryEnabled()
+
+> **setTelemetryEnabled**(`enabled`): `Promise`\<`void`\>
+
+Controls telemetry reporting.
+
+## Parameters
+
+### enabled
+
+`boolean`
+
+When false, updates on this device will stop appearing as failed, pending or succeeded in analytics.
+
+## Returns
+
+`Promise`\<`void`\>
diff --git a/ios/CodePush/CodePush.h b/ios/CodePush/CodePush.h
@@ -104,6 +104,7 @@
 @property (readonly) NSString *clientUniqueId;
 @property (copy) NSString *serverURL;
 @property (copy) NSString *publicKey;
+@property (nonatomic) BOOL telemetryEnabled;
 
 + (instancetype)current;
 
diff --git a/ios/CodePush/CodePush.m b/ios/CodePush/CodePush.m
@@ -1049,6 +1049,20 @@ - (void)restartAppInternal:(BOOL)onlyIfUpdateIsPending
     resolve([[CodePushConfig current] clientUniqueId]);
 }
 
+RCT_EXPORT_METHOD(setTelemetryEnabled:(BOOL)enabled
+                            resolver:(RCTPromiseResolveBlock)resolve
+                            rejecter:(RCTPromiseRejectBlock)reject)
+{
+    [[CodePushConfig current] setTelemetryEnabled:enabled];
+    resolve(nil);
+}
+
+RCT_EXPORT_METHOD(getTelemetryEnabled:(RCTPromiseResolveBlock)resolve
+                           rejecter:(RCTPromiseRejectBlock)reject)
+{
+    resolve(@([[CodePushConfig current] telemetryEnabled]));
+}
+
 #pragma mark - JavaScript-exported module methods (Private)
 
 /*
diff --git a/ios/CodePush/CodePushConfig.m b/ios/CodePush/CodePushConfig.m
@@ -13,6 +13,7 @@ @implementation CodePushConfig {
 static NSString * const ReleaseChannelPublicIDConfigKey = @"releaseChannelPublicId";
 static NSString * const ServerURLConfigKey = @"serverUrl";
 static NSString * const PublicKeyKey = @"publicKey";
+static NSString * const TelemetryEnabledKey = @"telemetryEnabled";
 
 + (instancetype)current
 {
@@ -49,6 +50,16 @@ - (instancetype)init
         [userDefaults synchronize];
     }
 
+    NSNumber *defaultTelemetryEnabled = [infoDictionary objectForKey:@"CodePushDefaultTelemetryEnabled"];
+    BOOL telemetryEnabled;
+    if ([userDefaults objectForKey:TelemetryEnabledKey] != nil) {
+        telemetryEnabled = [userDefaults boolForKey:TelemetryEnabledKey];
+    } else if (defaultTelemetryEnabled != nil) {
+        telemetryEnabled = [defaultTelemetryEnabled boolValue];
+    } else {
+        telemetryEnabled = YES;
+    }
+
     if (!serverURL) {
         serverURL = @"https://codepush.appzung.com/";
     }
@@ -64,6 +75,7 @@ - (instancetype)init
         CPLog(@"Executing CodePush with a signing public key.");
         [_configDictionary setObject:publicKey forKey:PublicKeyKey];
     }
+    [_configDictionary setObject:@(telemetryEnabled) forKey:TelemetryEnabledKey];
 
     return self;
 }
@@ -103,6 +115,19 @@ - (NSString *)publicKey
     return [_configDictionary objectForKey:PublicKeyKey];
 }
 
+- (BOOL)telemetryEnabled
+{
+    return [[_configDictionary objectForKey:TelemetryEnabledKey] boolValue];
+}
+
+- (void)setTelemetryEnabled:(BOOL)telemetryEnabled
+{
+    [_configDictionary setValue:@(telemetryEnabled) forKey:TelemetryEnabledKey];
+    NSUserDefaults *preferences = [NSUserDefaults standardUserDefaults];
+    [preferences setBool:telemetryEnabled forKey:TelemetryEnabledKey];
+    [preferences synchronize];
+}
+
 - (void)setAppVersion:(NSString *)appVersion
 {
     [_configDictionary setValue:appVersion forKey:AppVersionConfigKey];
diff --git a/src/checkForUpdates.ts b/src/checkForUpdates.ts
@@ -39,7 +39,7 @@ export async function checkForUpdate(
    * release channels (e.g. an early access release channel for insiders).
    */
   const config: Configuration = releaseChannelPublicId ? { ...nativeConfig, releaseChannelPublicId } : nativeConfig;
-  const sdk = new CodePushApiSdk(requestFetchAdapter, config);
+  const sdk = new CodePushApiSdk(requestFetchAdapter, log, config);
 
   const localPackage = await getCurrentPackage();
 
diff --git a/src/index.ts b/src/index.ts
@@ -11,6 +11,7 @@ export * from './sync';
 export * from './getClientUniqueId';
 export * from './resetClientUniqueId';
 export * from './logLevel';
+export * from './telemetry';
 
 export * from './types';
 
diff --git a/src/internals/CodePushApiSdk.ts b/src/internals/CodePushApiSdk.ts
@@ -1,3 +1,4 @@
+import { LogLevel } from '../enums/LogLevel.enum';
 import { CodePushError, CodePushHttpError } from './CodePushApiSdk.errors';
 import {
   type ApiSdkConfiguration,
@@ -22,6 +23,7 @@ export class CodePushApiSdk {
 
   constructor(
     private readonly httpRequester: Http.Requester,
+    private readonly log: (level: LogLevel, message: string) => void,
     configuration: ApiSdkConfiguration,
   ) {
     this.configuration = { ...configuration };
@@ -86,6 +88,11 @@ export class CodePushApiSdk {
     previousLabelOrAppVersion: string | null,
     previousDeploymentKey: string | null,
   ): Promise<void> {
+    if (!this.configuration.telemetryEnabled) {
+      this.log(LogLevel.DEBUG, 'Skipped reporting deploy status because telemetry is disabled');
+      return;
+    }
+
     const requestBody: ReportDeployInput = {
       app_version: this.configuration.appVersion,
       deployment_key: this.configuration.releaseChannelPublicId,
@@ -116,6 +123,11 @@ export class CodePushApiSdk {
   }
 
   async reportStatusDownload(downloadedPackage: ApiSdkDownloadReportPackageInfo): Promise<void> {
+    if (!this.configuration.telemetryEnabled) {
+      this.log(LogLevel.DEBUG, 'Skipped reporting download because telemetry is disabled');
+      return;
+    }
+
     const requestBody: ReportDownloadInput = {
       client_unique_id: this.configuration.clientUniqueId,
       deployment_key: this.configuration.releaseChannelPublicId,
diff --git a/src/internals/CodePushApiSdk.types.ts b/src/internals/CodePushApiSdk.types.ts
@@ -45,6 +45,7 @@ export interface ApiSdkConfiguration {
   clientUniqueId: string;
   releaseChannelPublicId: string;
   serverUrl: string;
+  telemetryEnabled: boolean;
   ignoreAppVersion?: boolean;
 }
 
diff --git a/src/internals/RNAppZungCodePushModuleSpec.ts b/src/internals/RNAppZungCodePushModuleSpec.ts
@@ -52,4 +52,7 @@ export interface Spec extends TurboModule {
 
   isFirstRun(packageHash: string): Promise<boolean>;
   isFailedUpdate(packageHash: string): Promise<boolean>;
+
+  setTelemetryEnabled(enabled: boolean): Promise<void>;
+  getTelemetryEnabled(): Promise<boolean>;
 }
diff --git a/src/notifyAppReady.ts b/src/notifyAppReady.ts
@@ -54,7 +54,7 @@ async function tryReportStatus(statusReport: StatusReport, retryOnAppResume?: Na
         throw new Error('Release channel is missing');
       }
 
-      const sdk = new CodePushApiSdk(requestFetchAdapter, config);
+      const sdk = new CodePushApiSdk(requestFetchAdapter, log, config);
       await sdk.reportStatusDeploy(null, previousLabelOrAppVersion, previousReleaseChannelPublicId);
     } else {
       if (!statusReport.package) {
@@ -70,7 +70,7 @@ async function tryReportStatus(statusReport: StatusReport, retryOnAppResume?: Na
       }
 
       config.releaseChannelPublicId = statusReport.package.releaseChannelPublicId;
-      const sdk = new CodePushApiSdk(requestFetchAdapter, config);
+      const sdk = new CodePushApiSdk(requestFetchAdapter, log, config);
       await sdk.reportStatusDeploy(
         {
           package: statusReport.package,
diff --git a/src/telemetry.ts b/src/telemetry.ts
@@ -0,0 +1,21 @@
+import { NativeRNAppZungCodePushModule } from './internals/NativeRNAppZungCodePushModule';
+import { reloadCachedConfiguration } from './internals/getConfiguration';
+
+/**
+ * Controls telemetry reporting.
+ *
+ * @param enabled - When false, updates on this device will stop appearing as failed, pending or succeeded in analytics.
+ */
+export async function setTelemetryEnabled(enabled: boolean): Promise<void> {
+  await NativeRNAppZungCodePushModule.setTelemetryEnabled(enabled);
+  await reloadCachedConfiguration();
+}
+
+/**
+ * Gets the current telemetry enabled status.
+ *
+ * When setTelemetryEnabled has never been enabled, returns the default value set in your configuration.
+ */
+export function getTelemetryEnabled(): Promise<boolean> {
+  return NativeRNAppZungCodePushModule.getTelemetryEnabled();
+}

Original file line number	Diff line number	Diff line change
`@@ -32,4 +32,5 @@ public class CodePushConstants {`
`32`	`32`	`public static final String LATEST_ROLLBACK_TIME_KEY = "time";`
`33`	`33`	`public static final String LATEST_ROLLBACK_COUNT_KEY = "count";`
`34`	`34`	`public static final String CLIENT_UNIQUE_ID_KEY = "clientUniqueId";`
	`35`	`+ public static final String TELEMETRY_ENABLED_KEY = "telemetryEnabled";`
`35`	`36`	`}`