Merge pull request #466 from RodrigoSMarques/dev_branch_config

Release 8.8.0

Author: RodrigoSMarques

CHANGELOG.md

@@ -1,3 +1,12 @@
+## 8.8.0
+### 🎉 Features
+* Configuration through `branch-config.json` file. 
+- Some settings can be configured by adding an `assets/branch-config.json` file to your project. 
+- This eliminates the need for manual modifications to native files (`AndroidManifest.xml` and `Info.plist`). 
+- Toggle between your test and live keys within the `branch-config.json` file, streamlining the development and release process.
+- The `branch-config.json` file and its keys are optional. The plugin will gracefully handle its absence, allowing for programmatic setup or backward compatibility with the manual native setup. If the file is present but a key is missing, the plugin will use default values where applicable.
+- Read the **README.md** for full instructions for JSON-based configuration.
+
 ## 8.7.1
 ### 🐛 Bug Fixes
 * Fix issue #461 : iOS Build Failure using Cocoapods

README.md

@@ -15,7 +15,7 @@ Supports Android, iOS and Web.
 | --- |---------| ---
 | Android | 5.20.+ | [Android Version History](https://github.com/BranchMetrics/android-branch-deep-linking-attribution/releases)
 | iOS | 3.13.+ | [iOS Version History](https://github.com/BranchMetrics/ios-branch-deep-linking-attribution/releases)
-| Web | 2.86.4 | [Web Version History](https://github.com/BranchMetrics/web-branch-deep-linking-attribution/releases)
+| Web | 2.86.+ | [Web Version History](https://github.com/BranchMetrics/web-branch-deep-linking-attribution/releases)
 
 
 Implemented functions in plugin:
@@ -77,7 +77,11 @@ Follow only the steps:
 * [Configure App](https://help.branch.io/developers-hub/docs/android-basic-integration#4-configure-app)
 * [Configure ProGuard](https://help.branch.io/developers-hub/docs/android-basic-integration#7-configure-proguard)
 
-**Note**: It is not necessary to perform the Branch Android SDK installation steps. The plugin performs these steps.
+**Note**:
+
+1. You can configure your Branch keys (`liveKey`, `testKey`) and test mode (`useTestInstance`) centrally in the `assets/branch-config.json` file. Please see the [**(Optional) Configuration via `branch-config.json` file**](#optional-configuration-via-branch-configjson).
+
+2. The native Branch Android SDK dependency is included automatically by this plugin. No need to add it manually in your project.
 
 ### iOS Integration
 Follow only the steps:
@@ -86,7 +90,11 @@ Follow only the steps:
 * [Configure associated domains](https://help.branch.io/developers-hub/docs/ios-basic-integration#3-configure-associated-domains)
 * [Configure Info.plist](https://help.branch.io/developers-hub/docs/ios-basic-integration#4-configure-infoplist)
 
-**Note**: It is not necessary to perform the Branch iOS SDK installation steps. The plugin performs these steps.
+**Note**: 
+
+1. You can configure your Branch keys (`live`, `test`) and test mode (`useTestInstance`) centrally in the `assets/branch-config.json` file. Please see the [**(Optional) Configuration via `branch-config.json` file**](#optional-configuration-via-branch-configjson).
+2. The native Branch iOS SDK dependency is included automatically by this plugin. No need to add it manually in your project.
+
 
 #### NativeLink™ Deferred Deep Linking
 Use iOS pasteboard to enable deferred deep linking via Branch NativeLink™, which enables 100% matching on iOS through Installs.
@@ -184,6 +192,75 @@ Full example `index.html`:
 
 ```
 
+## (Optional) Configuration via `branch-config.json`
+
+One way to configure keys and other settings is through a JSON configuration file. 
+
+This method allows you to easily manage your test and active keys without modifying native code.
+
+The plugin will automatically read this file on startup (only Android/iOs).
+
+If you have configured `branch-config.json`, you do not need to manually add your Branch keys to `AndroidManifest.xml` or `Info.plist`.
+
+
+### Step 1: Create the Configuration File
+
+1. In the root of your Flutter project, create a folder named `assets` if it doesn't already exist.
+2. Inside the `assets` folder, create a new file named `branch-config.json`.
+
+Your project structure should look like this:
+```
+my_flutter_app/
+├── assets/
+│ └── branch-config.json
+├── lib/
+├── pubspec.yaml
+...
+```
+
+### Step 2: Add Your Keys and Settings
+
+Copy and paste the following structure into your `assets/branch-config.json` file and replace the placeholder values with your actual Branch keys.
+
+```json
+{
+ "apiUrl": "https://api.myapi.com/"
+ "branchKey": "key_live_test_xxxx_yyyy",
+ "liveKey": "key_live_xxxx",
+ "testKey": "key_test_yyyy",
+ "enableLogging": true,
+ "useTestInstance": true,
+}
+```
+
+#### Key Descriptions:
+
+* **`apiUrl`**: (Optional) Sets a custom base URL for all calls to the Branch API.
+Requires HTTPS.
+* **`branchKey`**: (Optional) The Branch key that the SDK will use for initialization. It's recommended to set this to your `liveKey` or `testKey` depending on your current build environment.
+* **`liveKey`**: (Optional) Your Branch live key from the Branch Dashboard.
+* **`testKey`**: (Optional) Your Branch test key from the Branch Dashboard.
+* **`useTestInstance`**: (Optional, default: `false`) Set to `true` to use the test key for debugging and testing. Set to `false` for production releases. This allows you to easily switch between environments.
+* **`enableLogging`**: (Optional, default: `false`) Set to `true` to see detailed logs from the native Branch SDK in your device's log output (Logcat for Android, Console for iOS).
+
+**Note:**
+
+ - if `branchKey` **is present**, it will override the `useTestInstance`/`testKey`/`liveKey` config
+ - if `branchKey` **is missing**, `testKey`/`liveKey`, must be present.
+
+
+### Step 3: Declare the Asset in `pubspec.yaml`
+
+Finally, you need to inform your Flutter app about this new asset file. Open your `pubspec.yaml` and add the file path under the `flutter:` section:
+
+```yaml
+flutter:
+ assets:
+ - assets/branch-config.json
+```
+
+Done! plugin will now automatically configure itself using the values ​​in this file when your app starts, overriding the values ​​set in `AndroidManifest.xml` and `Info.plist`.
+
 ## Installation
 To use the plugin, add `flutter_branch_sdk` as a [dependency in your pubspec.yaml file](https://pub.dev/packages/flutter_branch_sdk/install).
 
@@ -230,7 +307,7 @@ FlutterBranchSdk.validateSDKIntegration();
 
 Android | iOS
  --- | --- |
- ![](https://github.com/RodrigoSMarques/flutter_branch_sdk/blob/master/assets/validate_sdk_android.png) | ![](https://github.com/RodrigoSMarques/flutter_branch_sdk/blob/master/assets/validate_sdk_ios.png) |
+ ![](https://github.com/RodrigoSMarques/flutter_branch_sdk/blob/master/assets/validate_sdk_android.png?raw=true) | ![](https://github.com/RodrigoSMarques/flutter_branch_sdk/blob/master/assets/validate_sdk_ios.png?raw=true) |
 
 
 Make sure to comment out or remove `validateSDKIntegration` in your release build.
@@ -622,7 +699,7 @@ print(status);
 ```
 > Note: After the user's response, call the `handleATTAuthorizationStatus` Branch SDK method to monitor the performance of the ATT prompt.
 
-![App tracking dialog](https://github.com/RodrigoSMarques/flutter_branch_sdk/blob/master/assets/app_tracking_dialog.png)
+![App tracking dialog](https://github.com/RodrigoSMarques/flutter_branch_sdk/blob/master/assets/app_tracking_dialog.png?raw=true)
 
 
 #### Get tracking authorization status
@@ -685,45 +762,18 @@ When parameters are successfully set using `setDMAParamsForEEA`, they will be se
 
 
 # Configuring the project to use Branch Test Key
-## Android
-
-Add or update the code below in `AndroidManifest.xml`:
-
-```xml
-<!-- Set to `true` to use `BranchKey.test` -->
-<meta-data 
- android:name="io.branch.sdk.TestMode" android:value="true" />
-```
-
-***Note***: Remember to set the value to `false` before releasing to production.
-
-### iOS
-
-1) Create an empty file called `branch.json`.
-
-2) Paste the content below into the file or make download [here](https://github.com/RodrigoSMarques/flutter_branch_sdk/blob/master/assets/branch.json):
-
-```json
-{
- "useTestInstance": true
-}
-
-```
-
-3) Add the file `branch.json` to your project using Xcode. Within your project, navigate to File → Add Files. 
 
-4) Select the `branch.json` file and make sure every target in your project that uses Branch is selected.
 
-![branch.json](https://github.com/RodrigoSMarques/flutter_branch_sdk/blob/master/assets/branch_json_add.png)
+Use the configuration through the `branch-config.json` file, setting the `useTestInstance` value to `true`.
 
-![branch.json](https://github.com/RodrigoSMarques/flutter_branch_sdk/blob/master/assets/branch_json_project.png)
+[Instructions here](#optional-configuration-via-branch-configjson).
 
 **Note*:* Remember to set the value to `false` before releasing to production.
 
 # Getting Started
 See the `example` directory for a complete sample app using Branch SDK.
 
-![Example app](https://github.com/RodrigoSMarques/flutter_branch_sdk/blob/master/assets/example.png)
+![Example app](https://github.com/RodrigoSMarques/flutter_branch_sdk/blob/master/assets/example.png?raw=true)
 
 See example in Flutter Web: [https://flutter-branch-sdk.netlify.app/](https://flutter-branch-sdk.netlify.app/#/)
 
@@ -749,7 +799,7 @@ Practices to avoid:
 * Deep links with [Long links](https://help.branch.io/using-branch/docs/creating-a-deep-link#long-links)
 
 # Data Privacy
-* [Introducing Consumer Protection Preference Levels] (https://help.branch.io/using-branch/changelog/introducing-consumer-protection-preference-levels) 
+* [Introducing Consumer Protection Preference Levels](https://help.branch.io/using-branch/changelog/introducing-consumer-protection-preference-levels) 
 * [Consumer Protection Preferences](https://help.branch.io/developers-hub/docs/consumer-protection-preferences)
 * [Answering the App Store Connect Privacy Questions](https://help.branch.io/using-branch/docs/answering-the-app-store-connect-privacy-questions)
 * [Answering the Google Play Store Privacy Questions](https://help.branch.io/using-branch/docs/answering-the-google-play-store-privacy-questions)
@@ -772,6 +822,7 @@ Read the iOS or Android documentation for all Branch object parameters:
 
 * Android - [https://help.branch.io/developers-hub/docs/android-advanced-features](https://help.branch.io/developers-hub/docs/android-advanced-features)
 * iOS - [https://help.branch.io/developers-hub/docs/ios-advanced-features](https://help.branch.io/developers-hub/docs/ios-advanced-features)
+* Web - [https://help.branch.io/developers-hub/docs/web-advanced-features](https://help.branch.io/developers-hub/docs/web-advanced-features)
 
 # Author
 This project was authored by Rodrigo S. Marques. You can contact me at [rodrigosmarques@gmail.com](mailto:rodrigosmarques@gmail.com)

android/src/main/java/br/com/rsmarques/flutter_branch_sdk/BranchJsonConfig.java

@@ -0,0 +1,55 @@
+package br.com.rsmarques.flutter_branch_sdk;
+
+import android.content.Context;
+import org.json.JSONException;
+import org.json.JSONObject;
+import java.io.BufferedReader;
+import java.io.IOException;
+import java.io.InputStream;
+import java.io.InputStreamReader;
+import io.flutter.embedding.engine.plugins.FlutterPlugin;
+
+public class BranchJsonConfig {
+ private static final String TAG = "BranchJsonConfig";
+ private static final String DEBUG_NAME = "FlutterBranchSDK";
+
+ public final String apiUrl;
+ public final String branchKey;
+ public final String liveKey;
+ public final String testKey;
+ public final Boolean enableLogging;
+ public final Boolean useTestInstance;
+
+
+ private BranchJsonConfig(JSONObject jsonObject) {
+ this.apiUrl = jsonObject.optString("apiUrl", "");
+ this.branchKey = jsonObject.optString("branchKey", "");
+ this.liveKey = jsonObject.optString("liveKey", "");
+ this.testKey = jsonObject.optString("testKey", "");
+ this.enableLogging = jsonObject.has("enableLogging") && jsonObject.optBoolean("enableLogging");
+ this.useTestInstance = jsonObject.has("useTestInstance") && jsonObject.optBoolean("useTestInstance");
+ }
+
+ public static BranchJsonConfig loadFromFile(Context context, FlutterPlugin.FlutterPluginBinding binding) {
+ try {
+ String assetKey = binding.getFlutterAssets().getAssetFilePathByName("assets/branch-config.json");
+
+ try (InputStream inputStream = context.getAssets().open(assetKey)) {
+ BufferedReader reader = new BufferedReader(new InputStreamReader(inputStream));
+ StringBuilder stringBuilder = new StringBuilder();
+ String line;
+ while ((line = reader.readLine()) != null) {
+ stringBuilder.append(line);
+ }
+ JSONObject jsonObject = new JSONObject(stringBuilder.toString());
+ return new BranchJsonConfig(jsonObject);
+ }
+ } catch (IOException e) {
+ //File 'assets/branch-config.json' not exists
+ return null;
+ } catch (JSONException e) {
+ LogUtils.debug(DEBUG_NAME, "Failed to decode 'assets/branch-config.json'. Check if the JSON is valid. Error: " + e);
+ return null;
+ }
+ }
+}

android/src/main/java/br/com/rsmarques/flutter_branch_sdk/FlutterBranchSdkPlugin.java

@@ -63,6 +63,8 @@ public class FlutterBranchSdkPlugin implements FlutterPlugin, MethodCallHandler,
  private EventSink eventSink = null;
  private Map<String, Object> sessionParams = null;
  private BranchError initialError = null;
+ public static BranchJsonConfig branchJsonConfig = null;
+
  /**
  * ---------------------------------------------------------------------------------------------
  * Branch SDK Call Methods
@@ -119,6 +121,8 @@ public void onInitFinished(JSONObject params, BranchError error) {
  public void onAttachedToEngine(@NonNull FlutterPluginBinding binding) {
  LogUtils.debug(DEBUG_NAME, "triggered onAttachedToEngine");
  setupChannels(binding.getBinaryMessenger(), binding.getApplicationContext());
+
+ branchJsonConfig = BranchJsonConfig.loadFromFile(context, binding);
  }
 
  @Override
@@ -393,6 +397,8 @@ public void onMethodCall(@NonNull MethodCall call, @NonNull Result rawResult) {
  }
 
  private void setupBranch(MethodCall call, final Result result) {
+ Boolean enableLogginFromJson = false;
+
  LogUtils.debug(DEBUG_NAME, "triggered setupBranch");
  if (!(call.arguments instanceof Map)) {
  throw new IllegalArgumentException("Map argument expected");
@@ -402,12 +408,41 @@ private void setupBranch(MethodCall call, final Result result) {
  result.success(Boolean.TRUE);
  }
 
+ if (branchJsonConfig != null) {
+ if (!branchJsonConfig.apiUrl.isEmpty()) {
+ Branch.setAPIUrl(branchJsonConfig.apiUrl);
+ LogUtils.debug(DEBUG_NAME, "Set API URL from branch-config.json: " + branchJsonConfig.apiUrl);
+ }
+
+ if (branchJsonConfig.enableLogging) {
+ Branch.enableLogging();
+ LogUtils.debug(DEBUG_NAME, "Set EnableLogging from branch-config.json");
+ enableLogginFromJson = true;
+ }
+
+ if (!branchJsonConfig.branchKey.isEmpty()) {
+ Branch.getInstance().setBranchKey(branchJsonConfig.branchKey);
+ LogUtils.debug(DEBUG_NAME, "Set Branch Key from branch-config.json: " + branchJsonConfig.branchKey);
+ } else {
+ if (branchJsonConfig.useTestInstance && !branchJsonConfig.testKey.isEmpty()) {
+ Branch.getInstance().setBranchKey(branchJsonConfig.testKey);
+ LogUtils.debug(DEBUG_NAME, "Set Test Key from branch-config.json: " + branchJsonConfig.testKey);
+
+ } else if (!branchJsonConfig.liveKey.isEmpty()) {
+ Branch.getInstance().setBranchKey(branchJsonConfig.liveKey);
+ LogUtils.debug(DEBUG_NAME, "Set Live Key from branch-config.json: " + branchJsonConfig.liveKey);
+ }
+ }
+ }
+
  HashMap<String, Object> argsMap = (HashMap<String, Object>) call.arguments;
 
- if ((Boolean) argsMap.get("enableLogging")) {
- Branch.enableLogging(BranchLogger.BranchLogLevel.VERBOSE);
- } else {
- Branch.disableLogging();
+ if (!enableLogginFromJson) {
+ if ((Boolean) argsMap.get("enableLogging")) {
+ Branch.enableLogging(BranchLogger.BranchLogLevel.VERBOSE);
+ } else {
+ Branch.disableLogging();
+ }
  }
 
  if (requestMetadata.length() > 0) {

example/android/app/src/main/AndroidManifest.xml

@@ -50,13 +50,13 @@
  android:value="2" />
  <!-- Branch init -->
  <meta-data
- android:name="io.branch.sdk.BranchKey"
+ android:name="io.branch.sdk.BranchKey1"
  android:value="key_live_bkJRqpb15wLqUAgsDVNUIobjyviWi6Wx" />
  <!-- For your test app, if you have one; Again, use your actual test Branch key -->
  <meta-data
- android:name="io.branch.sdk.BranchKey.test"
+ android:name="io.branch.sdk.BranchKey.test1"
  android:value="key_test_ipQTteg11ENANDeCzSXgqdgfuycWoXYH" />
  <meta-data
- android:name="io.branch.sdk.TestMode" android:value="true" />
+ android:name="io.branch.sdk.TestMode1" android:value="true" />
  </application>
 </manifest>

example/assets/branch-config.json

@@ -0,0 +1,8 @@
+{
+ "apiUrl": "https://api3.branch.io/",
+ "branchKey": "key_test_ipQTteg11ENANDeCzSXgqdgfuycWoXYH",
+ "liveKey": "key_live_bkJRqpb15wLqUAgsDVNUIobjyviWi6Wx",
+ "testKey": "key_test_ipQTteg11ENANDeCzSXgqdgfuycWoXYH",
+ "useTestInstance": true,
+ "enableLogging": true
+}