Skip to content

Updating firebase-perf external documentation as part of Open Sourcing #2359

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 5 commits into from
Jan 28, 2021
Merged

Updating firebase-perf external documentation as part of Open Sourcing #2359

merged 5 commits into from
Jan 28, 2021

Conversation

ramanpreetSinghKhinda
Copy link
Contributor

@ramanpreetSinghKhinda ramanpreetSinghKhinda commented Jan 26, 2021 •
edited
Loading

Preparing firebase-perf to be OSS ready.

  • Updating main README to include firebase-perf
  • Updating firebaseopensource to include firebase-perf

Note: Merge only after firebase-perf have been Open Sourced.

@ramanpreetSinghKhinda
Update README.md
7592e3e 
Preparing `firebase-perf` to be OSS ready

**Note:** Merge only after `firebase-perf` have been Open Sourced.
@googlebot googlebot added the cla: yes Override cla label Jan 26, 2021
@google-oss-bot
Copy link
Contributor

google-oss-bot commented Jan 26, 2021 •
edited
Loading

Coverage Report

Affected SDKs

  • firebase-components

    SDK overall coverage changed from ? (783c430) to 57.45% (00b93004) by ?.

    Click to show coverage changes in 26 files.
    Filename Base (783c430) Head (00b93004) Diff
    AbstractComponentContainer.java ? 16.67% ?
    Component.java ? 70.31% ?
    ComponentContainer.java ? 0.00% ?
    ComponentDiscovery.java ? 49.25% ?
    ComponentFactory.java ? 0.00% ?
    ComponentLoader.java ? 0.00% ?
    ComponentRegistrar.java ? 0.00% ?
    ComponentRuntime.java ? 74.56% ?
    CycleDetector.java ? 63.74% ?
    Deferred.java ? 0.00% ?
    Dependency.java ? 48.78% ?
    DependencyCycleException.java ? 0.00% ?
    DependencyException.java ? 0.00% ?
    Event.java ? 0.00% ?
    EventBus.java ? 28.57% ?
    EventHandler.java ? 0.00% ?
    InvalidRegistrarException.java ? 100.00% ?
    Lazy.java ? 80.00% ?
    LazySet.java ? 0.00% ?
    MissingDependencyException.java ? 0.00% ?
    OptionalProvider.java ? 80.56% ?
    Preconditions.java ? 46.15% ?
    Provider.java ? 0.00% ?
    Publisher.java ? 0.00% ?
    RestrictedComponentContainer.java ? 43.33% ?
    Subscriber.java ? 0.00% ?

  • firebase-perf

    SDK overall coverage changed from 70.24% (783c430) to 70.22% (00b93004) by -0.02%.

    Filename Base (783c430) Head (00b93004) Diff
    TransportManager.java 96.06% 95.57% -0.49%

  • firebase-storage

    SDK overall coverage changed from 85.52% (783c430) to 85.48% (00b93004) by -0.04%.

    Filename Base (783c430) Head (00b93004) Diff
    StreamDownloadTask.java 88.41% 88.89% +0.48%
    UploadTask.java 80.59% 79.85% -0.73%

Test Logs

Notes

HTML coverage reports can be produced locally with ./gradlew <product>:checkCoverage.
Report files are located at <product-build-dir>/reports/jacoco/.

Head commit (00b93004) is created by Prow via merging commits: 783c430 4f34950.

@google-oss-bot
Copy link
Contributor

google-oss-bot commented Jan 26, 2021 •
edited
Loading

Binary Size Report

Affected SDKs

No changes between base commit (783c430) and head commit (00b93004).

Test Logs

Notes

Head commit (00b93004) is created by Prow via merging commits: 783c430 4f34950.

@ramanpreetSinghKhinda
Copy link
Contributor Author

@rlazo Are there any other public documentation updates required for fireperf?

jeremyjiang-dev
jeremyjiang-dev reviewed Jan 26, 2021
View reviewed changes
Copy link
Contributor

@jeremyjiang-dev jeremyjiang-dev left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we need to update https://github.com/firebase/firebase-android-sdk/blob/master/.opensource/project.json and https://github.com/firebase/firebase-android-sdk/tree/master/docs

@rlazo
Copy link
Collaborator

rlazo commented Jan 26, 2021

@rlazo Are there any other public documentation updates required for fireperf?

The only "public" doc that refers to the actual contents of the repo is the README.md So if that's updated, you're good to go.

@ramanpreetSinghKhinda
Copy link
Contributor Author

Do we need to update https://github.com/firebase/firebase-android-sdk/blob/master/.opensource/project.json and https://github.com/firebase/firebase-android-sdk/tree/master/docs

Good point Jeremy. Let me update this in this PR.

@rlazo
Copy link
Collaborator

rlazo commented Jan 26, 2021

Do we need to update https://github.com/firebase/firebase-android-sdk/blob/master/.opensource/project.json and https://github.com/firebase/firebase-android-sdk/tree/master/docs

That's a great question. If anything needs to be changed there is not a blocker for OSS. It would be more an oversight from our (Core) part. I'll double check about those files.

@ramanpreetSinghKhinda ramanpreetSinghKhinda changed the title Preparing firebase-perf to be OSS ready Updating firebase-perf external documentation as part of Open Sourcing Jan 26, 2021
rachelsaunders
rachelsaunders previously requested changes Jan 27, 2021
View reviewed changes
@ramanpreetSinghKhinda @rachelsaunders
Update README.md
4f34950 
Co-authored-by: rachelsaunders <[email protected]>
@ramanpreetSinghKhinda
Copy link
Contributor Author

/test check-changed
/test smoke-tests

jeremyjiang-dev
jeremyjiang-dev reviewed Jan 27, 2021
View reviewed changes
@ramanpreetSinghKhinda
Copy link
Contributor Author

/test device-check-changed

@ramanpreetSinghKhinda
Copy link
Contributor Author

/test device-check-changed

@ramanpreetSinghKhinda
Copy link
Contributor Author

/retest

@ramanpreetSinghKhinda
Copy link
Contributor Author

/test device-check-changed

@ramanpreetSinghKhinda
Copy link
Contributor Author

@rlazo Looks like there are some tests which has been failing. I wonder why README changes are triggering tests for those SDKs in the first place.

Also how can we avoid getting blocked on these unrelated transient errors?

@ramanpreetSinghKhinda
Copy link
Contributor Author

/test device-check-changed

@jeremyjiang-dev
Copy link
Contributor

I wonder what is the best approach here for some unrelated flaky tests that are failing:

  1. Should we ask people to fix them?
  2. Should we merge without that test passing if we know that test is flaky by running it locally.

I think rerunning the tests may not help to solve the problem fundamentally.

@ramanpreetSinghKhinda
Copy link
Contributor Author

I wonder what is the best approach here for some unrelated flaky tests that are failing:

  1. Should we ask people to fix them?
  2. Should we merge without that test passing if we know that test is flaky by running it locally.

I think rerunning the tests may not help to solve the problem fundamentally.

cc @vkryachko @rlazo

@ramanpreetSinghKhinda ramanpreetSinghKhinda merged commit c822574 into master Jan 28, 2021
@ramanpreetSinghKhinda ramanpreetSinghKhinda deleted the ramanpreetSinghKhinda-patch-1 branch January 28, 2021 18:08
@firebase firebase locked and limited conversation to collaborators Feb 28, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@rlazo rlazo rlazo approved these changes

@visumickey visumickey visumickey approved these changes

@jeremyjiang-dev jeremyjiang-dev jeremyjiang-dev approved these changes

@vkryachko vkryachko Awaiting requested review from vkryachko

@rachelsaunders rachelsaunders Awaiting requested review from rachelsaunders

Assignees
No one assigned
Labels
cla: yes Override cla size/XS
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
7 participants
@ramanpreetSinghKhinda @google-oss-bot @rlazo @jeremyjiang-dev @visumickey @rachelsaunders @googlebot