Custom callback test #1528

NidhiDixit09 · 2025-09-23T16:28:03Z

Reference

SDK-XXXX -- <TITLE>.

Summary

Motivation

Type Of Change

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to not work as expected)
This change requires a documentation update

Testing Instructions

cc @BranchMetrics/saas-sdk-devs for visibility.

matter-code-review · 2025-09-23T16:28:23Z

Summary By MatterAI

🔄 What Changed

This Pull Request enhances the request tracing mechanism within the Branch SDK. It introduces new properties (requestParams and requestServiceURL) to BranchInstallRequest and BranchOpenRequest to store request details. Crucially, the callbackForTracingRequests typedef has been updated to include the requestServiceURL as a new parameter, which is then passed to the traceCallback in BranchOpenRequest. 🚀

🔍 Impact of the Change

These changes significantly improve the observability and debugging capabilities for network requests made by the SDK. By exposing the service URL to custom tracing callbacks, developers gain deeper insights into the request lifecycle, facilitating better monitoring and troubleshooting. ✨

📁 Total Files Changed

Sources/BranchSDK/BranchInstallRequest.m: Now stores request parameters and the service URL as properties before making the network call.
Sources/BranchSDK/BranchOpenRequest.m: Stores the service URL and updates the traceCallback invocation to include this new URL.
Sources/BranchSDK/Private/BranchOpenRequest.h: Declares requestParams and requestServiceURL as public properties for BranchOpenRequest.
Sources/BranchSDK/Public/BNCCallbacks.h: Modifies the callbackForTracingRequests signature to accept the requestServiceURL.

🧪 Test Added

No explicit tests were added in this Pull Request. 🚫

🔒Security Vulnerabilities

No new security vulnerabilities were introduced or fixed by these changes. 🛡️

Tip

Quality Recommendations

Add unit tests for the traceCallback in BranchOpenRequest to ensure the requestServiceURL parameter is correctly passed and received.
Verify proper memory management for requestParams and requestServiceURL properties to prevent potential leaks, especially with copy and readwrite attributes.

Tanka Poem ♫

New data flows, a URL,
Traced now with keen, watchful eye.
Callbacks enriched, insights bloom,
Code's journey, clearer, high.
Observability's sweet gain. 🔬✨

Sequence Diagram

sequenceDiagram
    participant RI as BranchInstallRequest
    participant RO as BranchOpenRequest
    participant RF as BNCRequestFactory
    participant BSA as BNCServerAPI
    participant BSI as BNCServerInterface
    participant TC as traceCallback

    Note over RI,RO: Prepare Request
    RI->>RF: dataForInstallWithURLString(urlString)
    RF-->>RI: params
    RI->>BSA: installServiceURL()
    BSA-->>RI: installURL
    RI->>RI: self.requestParams = params
    RI->>RI: self.requestServiceURL = installURL
    RI->>BSI: postRequest(params, installURL, key, callback)

    RO->>RF: dataForOpenWithURLString(urlString)
    RF-->>RO: params
    RO->>BSA: openServiceURL()
    BSA-->>RO: openURL
    RO->>RO: self.requestParams = params
    RO->>RO: self.requestServiceURL = openURL
    RO->>BSI: postRequest(params, openURL, key, callback)

    Note over RO: Process Response
    BSI-->>RO: response (async)
    RO->>TC: traceCallback(urlString, requestParams, response.data, error, requestServiceURL)

matter-code-review · 2025-09-23T16:28:24Z

Important

PR Review Skipped

PR review skipped as per the configuration setting. Run a manually review by commenting /matter review

💡Tips to use MatterAI

Command List

/matter summary: Generate AI Summary for the PR
/matter review: Generate AI Reviews for the latest commit in the PR
/matter review-full: Generate AI Reviews for the complete PR
/matter release-notes: Generate AI release-notes for the PR
/matter : Chat with your PR with MatterAI Agent
/matter remember : Generate AI memories for the PR
/matter explain: Get an explanation of the PR
/matter help: Show the list of available commands and documentation
Need help? Join our Discord server: https://discord.gg/fJU5DvanU3

…code)

matter-code-review · 2025-09-23T16:36:54Z

Important

PR Review Skipped

PR review skipped as per the configuration setting. Run a manually review by commenting /matter review

💡Tips to use MatterAI

Command List

/matter summary: Generate AI Summary for the PR
/matter review: Generate AI Reviews for the latest commit in the PR
/matter review-full: Generate AI Reviews for the complete PR
/matter release-notes: Generate AI release-notes for the PR
/matter : Chat with your PR with MatterAI Agent
/matter remember : Generate AI memories for the PR
/matter explain: Get an explanation of the PR
/matter help: Show the list of available commands and documentation
Need help? Join our Discord server: https://discord.gg/fJU5DvanU3

matter-code-review · 2025-09-23T16:39:15Z

Important

PR Review Skipped

PR review skipped as per the configuration setting. Run a manually review by commenting /matter review

💡Tips to use MatterAI

Command List

/matter summary: Generate AI Summary for the PR
/matter review: Generate AI Reviews for the latest commit in the PR
/matter review-full: Generate AI Reviews for the complete PR
/matter release-notes: Generate AI release-notes for the PR
/matter : Chat with your PR with MatterAI Agent
/matter remember : Generate AI memories for the PR
/matter explain: Get an explanation of the PR
/matter help: Show the list of available commands and documentation
Need help? Join our Discord server: https://discord.gg/fJU5DvanU3

matter-code-review · 2025-09-24T16:48:31Z

Important

PR Review Skipped

PR review skipped as per the configuration setting. Run a manually review by commenting /matter review

💡Tips to use MatterAI

Command List

/matter summary: Generate AI Summary for the PR
/matter review: Generate AI Reviews for the latest commit in the PR
/matter review-full: Generate AI Reviews for the complete PR
/matter release-notes: Generate AI release-notes for the PR
/matter : Chat with your PR with MatterAI Agent
/matter remember : Generate AI memories for the PR
/matter explain: Get an explanation of the PR
/matter help: Show the list of available commands and documentation
Need help? Join our Discord server: https://discord.gg/fJU5DvanU3

gdeluna-branch · 2025-09-24T18:10:58Z

Sources/BranchSDK/BNCODMInfoCollector.m

                    };

                    [invocation setArgument:&_odmFetchCompletion atIndex:3];
+                    [invocation retainArguments];


Is this needed because ODM info goes out of scope and garbage collected?

NidhiDixit09 added 2 commits September 18, 2025 22:26

setCallbackForTracingRequests Initial Commit

fd85c04

Removed example for the API setCallbackForTracingRequests

278f24e

Added defensive check as suggested in code review (for swift + obj-c …

9ae4e07

…code)

Removed extra space.

28f629b

NidhiDixit09 requested a review from gdeluna-branch September 23, 2025 16:42

Added param requestServiceURL in callback callbackForTracingRequests

1a0427f

gdeluna-branch reviewed Sep 24, 2025

View reviewed changes

gdeluna-branch approved these changes Sep 24, 2025

View reviewed changes

NidhiDixit09 merged commit 8d8f5ce into master Sep 24, 2025
22 of 23 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Custom callback test #1528

Custom callback test #1528

Uh oh!

NidhiDixit09 commented Sep 23, 2025

Uh oh!

matter-code-review bot commented Sep 23, 2025 •

edited

Loading

Quality Recommendations

Uh oh!

matter-code-review bot commented Sep 23, 2025

PR Review Skipped

Command List

Uh oh!

matter-code-review bot commented Sep 23, 2025

PR Review Skipped

Command List

Uh oh!

matter-code-review bot commented Sep 23, 2025

PR Review Skipped

Command List

Uh oh!

matter-code-review bot commented Sep 24, 2025

PR Review Skipped

Command List

Uh oh!

gdeluna-branch Sep 24, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Custom callback test #1528

Custom callback test #1528

Uh oh!

Conversation

NidhiDixit09 commented Sep 23, 2025

Reference

Summary

Motivation

Type Of Change

Testing Instructions

Uh oh!

matter-code-review bot commented Sep 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary By MatterAI

🔄 What Changed

🔍 Impact of the Change

📁 Total Files Changed

🧪 Test Added

🔒Security Vulnerabilities

Quality Recommendations

Tanka Poem ♫

Sequence Diagram

Uh oh!

matter-code-review bot commented Sep 23, 2025

PR Review Skipped

Command List

Uh oh!

matter-code-review bot commented Sep 23, 2025

PR Review Skipped

Command List

Uh oh!

matter-code-review bot commented Sep 23, 2025

PR Review Skipped

Command List

Uh oh!

matter-code-review bot commented Sep 24, 2025

PR Review Skipped

Command List

Uh oh!

gdeluna-branch Sep 24, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

matter-code-review bot commented Sep 23, 2025 •

edited

Loading