GoogleDataTransport

This library is for internal Google use only. It allows the logging of data and telemetry from Google SDKs.

Integration Testing

These instructions apply to minor and patch version updates. Major versions need a customized adaptation.

After the CI is green:

Update the version in the podspec
Add the CocoaPods tag
- git tag CocoaPods-{version}
- git push origin CocoaPods-{version}
Push the podspec to SpecsStaging
- pod repo push staging GoogleDataTransport.podspec
Run Firebase CI by waiting until next nightly or adding a PR that touches Gemfile
On google3, copybara and run a global TAP which should kick off automatically after each PR.

Publishing

Add a version tag for Swift PM
- git tag {version}
- git push origin {version}
pod trunk push GoogleDataTransport.podspec
Clean up SpecsStaging

Set logging level

Swift

Import GoogleDataTransport module:
```
import GoogleDataTransport
```
Set logging level global variable to the desired value before calling FirebaseApp.config():
```
GDTCORConsoleLoggerLoggingLevel = GDTCORLoggingLevel.debug.rawValue
```

Objective-C

Import GoogleDataTransport:

#import <GoogleDataTransport/GoogleDataTransport.h>

Set logging level global variable to the desired value before calling -[FIRApp config]:
```
GDTCORConsoleLoggerLoggingLevel = GDTCORLoggingLevelDebug;
```

Prereqs

gem install --user cocoapods cocoapods-generate
brew install protobuf nanopb-generator
easy_install --user protobuf

To develop

Run generate_project.sh after installing the prereqs

When adding new logging endpoint

Use commands similar to:
- python -c "line='https://www.firebase.com'; print line[0::2]"
- python -c "line='https://www.firebase.com'; print line[1::2]"

When adding internal code that shouldn't be easily usable on github

Consider using go/copybara-library/scrubbing#cc_scrub

Development

Ensure that you have at least the following software:

Xcode 12.0 (or later)
CocoaPods 1.10.0 (or later)
CocoaPods generate

For the pod that you want to develop:

pod gen GoogleDataTransport.podspec --local-sources=./ --auto-open --platforms=ios

Note: If the CocoaPods cache is out of date, you may need to run pod repo update before the pod gen command.

Note: Set the --platforms option to macos or tvos to develop/test for those platforms. Since 10.2, Xcode does not properly handle multi-platform CocoaPods workspaces.

Development for Catalyst

pod gen GoogleDataTransport.podspec --local-sources=./ --auto-open --platforms=ios
Check the Mac box in the App-iOS Build Settings
Sign the App in the Settings Signing & Capabilities tab
Click Pods in the Project Manager
Add Signing to the iOS host app and unit test targets
Select the Unit-unit scheme
Run it to build and test

Alternatively disable signing in each target:

Go to Build Settings tab
Click +
Select Add User-Defined Setting
Add CODE_SIGNING_REQUIRED setting with a value of NO

Code Formatting

To ensure that the code is formatted consistently, run the script ./scripts/check.sh before creating a PR.

GitHub Actions will verify that any code changes are done in a style compliant way. Install clang-format and mint:

brew install clang-format@11
brew install mint

Running Unit Tests

Select a scheme and press Command-u to build a component and run its unit tests.

Contributing

See Contributing for more information on contributing to the Firebase iOS SDK.

License

The contents of this repository is licensed under the Apache License, version 2.0.

fx91/GoogleDataTransport