Add comprehensive SalesforceReact library documentation#2893
Open
wmathurin wants to merge 2 commits into
Open
Conversation
- Created docs/salesforcereact/ with complete documentation - README.md: Overview, features, quick start - ARCHITECTURE.md: Bridge pattern, class hierarchy, data flow - API_REFERENCE.md: Complete API docs for all bridge classes - TESTING.md: Testing guide with examples and patterns Covers Android bridge implementation for React Native integration.
Fixes identified during documentation review: TESTING.md (rewritten): - Removed false claim that "library does not have a dedicated test suite" - Documented actual tests in libs/test/SalesforceReactTest/ - Listed actual test files: ReactOAuthTest, ReactNetTest, ReactSmartStoreTest, ReactMobileSyncTest, ReactHarnessTest - Documented actual test pattern (parameterized JUnit + ReactTestActivity + SalesforceTestBridge) - Removed fabricated unit test examples that didn't match real code - Removed invented dependency list (Mockito, etc.) - Added accurate test execution flow and architecture diagram README.md: - Fixed dependency chain to match reality (api dependency on MobileSync, transitively pulls SmartStore -> SalesforceSDK -> SalesforceAnalytics) - Added note about React Native version (currently 0.79.3, alignment to 0.81.5 planned) - Added note about Java -> Kotlin migration plan - Replaced Promise-based JS examples with actual callback-based API - Added clarification that fifth file (ReactBridgeHelper) is utility, not @ReactMethod-bearing bridge ARCHITECTURE.md: - Marked SalesforceReactActivity as abstract in class diagram (matches actual code: public abstract class SalesforceReactActivity)
Generated by 🚫 Danger |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## dev #2893 +/- ##
============================================
- Coverage 55.16% 55.13% -0.03%
+ Complexity 2508 2504 -4
============================================
Files 226 226
Lines 17781 17781
Branches 2328 2328
============================================
- Hits 9809 9804 -5
- Misses 6967 6968 +1
- Partials 1005 1009 +4
🚀 New features to boost your workflow:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds comprehensive in-repo documentation for the
libs/SalesforceReactlibrary: overview, architecture, API reference, and the actual test infrastructure underlibs/test/SalesforceReactTest/.What's new under
docs/salesforcereact/SalesforceReactActivitycorrectly marked<<abstract>>), data flow, with Mermaid diagramsSalesforceOauthReactBridge,SalesforceNetReactBridge,SmartStoreReactBridge,MobileSyncReactBridge) plusReactBridgeHelper,SalesforceReactSDKManager, andSalesforceReactActivitylibs/test/SalesforceReactTest/setup: parameterized JUnit +ReactTestActivity+SalesforceTestBridge, real test classes (ReactOAuthTest,ReactNetTest,ReactSmartStoreTest,ReactMobileSyncTest,ReactHarnessTest)Accuracy review
All docs were reviewed against the code on this branch:
build.gradle.kts(api dependency on:libs:MobileSync)SalesforceReactActivitydocumented as abstract (matchespublic abstract class SalesforceReactActivity)@ReactMethod-bearing modules + 1 utility (ReactBridgeHelper)oauth.authenticate(success, error))Notes
react-android:0.79.3↔ JS-sidereact-native:0.81.5version gap is also noted in README.Test plan
libs/SalesforceReact/src/com/salesforce/androidsdk/reactnative/./gradlew :libs:SalesforceReact:connectedAndroidTest