Skip to content

Commit

Permalink
Merge main into release
Browse files Browse the repository at this point in the history
  • Loading branch information
google-oss-bot authored Jul 30, 2024
2 parents 67ea4f7 + aef5468 commit 5ae04bc
Show file tree
Hide file tree
Showing 273 changed files with 1,403 additions and 874 deletions.
2 changes: 1 addition & 1 deletion .changeset/config.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
"commit": false,
"linked": [],
"access": "public",
"baseBranch": "master",
"baseBranch": "main",
"updateInternalDependencies": "patch",
"ignore": [
"firebase-namespace-integration-test",
Expand Down
12 changes: 12 additions & 0 deletions .changeset/late-humans-tan.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
'@firebase/firestore-compat': patch
'@firebase/database-compat': patch
'@firebase/auth-compat': patch
'@firebase/app-compat': patch
'@firebase/firestore': patch
'@firebase/database': patch
'firebase': patch
'@firebase/auth': patch
---

Fixed typos in documentation and some internal variables and parameters.
5 changes: 5 additions & 0 deletions .changeset/spicy-dragons-pay.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@firebase/app-compat': patch
---

Properly handle the case in app-compat checks where `window` exists but `self` does not. (This occurs in Ionic Stencil's Jest preset.)
6 changes: 6 additions & 0 deletions .changeset/tender-apes-clap.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
'@firebase/analytics': patch
'@firebase/app-check': patch
---

Revert introduction of safevalues to prevent issues from arising in Browser CommonJS environments due to ES5 incompatibility. For more information, see [GitHub PR #8395](https://github.com/firebase/firebase-js-sdk/pull/8395)
2 changes: 1 addition & 1 deletion .editorconfig
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ root = true
end_of_line = lf
insert_final_newline = true

# Javascript and Typescript look like Google-style
# JavaScript and TypeScript look like Google-style
[*.{js,json,ts}]
charset = utf-8
indent_style = space
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/bug_report_v2.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ body:
attributes:
value: |
*[READ THIS]:* to evaluate if you are in the right place?
- For issues or feature requests related to __the code in this repository__, file a Github issue.
- For issues or feature requests related to __the code in this repository__, file a GitHub issue.
- If this is a __feature request__, make sure the issue title starts with "FR:".
- For general technical questions, post a question on [StackOverflow](http://stackoverflow.com/) with the firebase tag.
- For general Firebase discussion, use the [firebase-talk](https://groups.google.com/forum/#!forum/firebase-talk) google group.
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/canary-deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ name: Canary Deploy
on:
push:
branches:
- master
- main
workflow_dispatch:

jobs:
Expand Down
14 changes: 7 additions & 7 deletions .github/workflows/check-changeset.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ name: Check Changeset
on:
pull_request:
branches:
- master
- main

env:
GITHUB_PULL_REQUEST_HEAD_SHA: ${{ github.event.pull_request.head.sha }}
Expand All @@ -41,9 +41,9 @@ jobs:
- name: Yarn install
run: yarn
- name: Run changeset script
# pull master so changeset can diff against it
# pull main so changeset can diff against it
run: |
git pull -f --no-rebase origin master:master
git pull -f --no-rebase origin main:main
yarn ts-node-script scripts/ci/check_changeset.ts
id: check-changeset
- name: Print changeset checker output
Expand All @@ -54,22 +54,22 @@ jobs:
- name: Print blocking failure status
run: echo "${{steps.check-changeset.outputs.BLOCKING_FAILURE}}"
- name: Find Comment
uses: peter-evans/find-comment@v1
uses: peter-evans/find-comment@v3
id: fc
with:
issue-number: ${{github.event.number}}
body-includes: Changeset File Check
- name: Create comment (missing packages)
if: ${{!steps.fc.outputs.comment-id && steps.check-changeset.outputs.CHANGESET_ERROR_MESSAGE}}
uses: peter-evans/create-or-update-comment@v1
uses: peter-evans/create-or-update-comment@v4
with:
issue-number: ${{github.event.number}}
body: |
### Changeset File Check :warning:
${{steps.check-changeset.outputs.CHANGESET_ERROR_MESSAGE}}
- name: Update comment (missing packages)
if: ${{steps.fc.outputs.comment-id}}
uses: peter-evans/create-or-update-comment@v1
uses: peter-evans/create-or-update-comment@v4
with:
comment-id: ${{steps.fc.outputs.comment-id}} && steps.check-changeset.outputs.CHANGESET_ERROR_MESSAGE}}
edit-mode: replace
Expand All @@ -78,7 +78,7 @@ jobs:
${{steps.check-changeset.outputs.CHANGESET_ERROR_MESSAGE}}
- name: Update comment (no missing packages)
if: ${{steps.fc.outputs.comment-id && !steps.check-changeset.outputs.CHANGESET_ERROR_MESSAGE}}
uses: peter-evans/create-or-update-comment@v1
uses: peter-evans/create-or-update-comment@v4
with:
comment-id: ${{steps.fc.outputs.comment-id}}
edit-mode: replace
Expand Down
8 changes: 4 additions & 4 deletions .github/workflows/merge-release-branch.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,12 @@
# See the License for the specific language governing permissions and
# limitations under the License.

name: Merge Release Into Master
name: Merge Release Into Main

on: workflow_dispatch

jobs:
merge_to_master:
merge_to_main:
runs-on: ubuntu-latest
# Allow GITHUB_TOKEN to have write permissions
permissions:
Expand All @@ -36,15 +36,15 @@ jobs:
- name: Echo version in shell
run: |
echo "Merging release ${{ steps.get-version.outputs.RELEASE_VERSION }}"
- name: Merge to master
- name: Merge to main
uses: actions/github-script@v6
with:
github-token: ${{ secrets.GITHUB_TOKEN }}
script: |
github.rest.repos.merge({
owner: context.repo.owner,
repo: context.repo.repo,
base: 'master',
base: 'main',
head: 'release',
commit_message: 'Release ${{ steps.get-version.outputs.RELEASE_VERSION }}'
})
4 changes: 2 additions & 2 deletions .github/workflows/release-pr.yml
Original file line number Diff line number Diff line change
Expand Up @@ -43,9 +43,9 @@ jobs:
# Ensures a new @firebase/app is published with every release.
# This keeps the SDK_VERSION variable up to date.
- name: Add a changeset for @firebase/app
# pull master so changeset can diff against it
# pull main so changeset can diff against it
run: |
git pull -f --no-rebase origin master:master
git pull -f --no-rebase origin main:main
yarn ts-node-script scripts/ci/add_changeset.ts
- name: Create Release Pull Request
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/release-prod.yml
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ jobs:
curl -X POST -H "Content-Type:application/json" \
-d "{\"version\":\"$BASE_VERSION\",\"date\":\"$DATE\"}" \
$RELEASE_TRACKER_URL/logProduction
- name: Create Github release
- name: Create GitHub release
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: |
Expand Down
6 changes: 3 additions & 3 deletions .github/workflows/release-staging.yml
Original file line number Diff line number Diff line change
Expand Up @@ -25,10 +25,10 @@ on:
source-branch:
description: 'Branch to release from'
type: choice
default: 'master'
default: 'main'
required: true
options:
- master
- main
- v8
verbose:
description: 'Enable verbose logging'
Expand All @@ -50,7 +50,7 @@ jobs:
uses: actions/setup-node@v3
with:
node-version: 20.x
- name: Merge master into release
- name: Merge main into release
uses: actions/github-script@v6
with:
github-token: ${{ secrets.OSS_BOT_GITHUB_TOKEN }}
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/test-all.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ env:
# make chromedriver detect installed Chrome version and download the corresponding driver
DETECT_CHROMEDRIVER_VERSION: true
# The default behavior of chromedriver uses the older Chrome download URLs. We need to override
# the beahvior to use the new URLs.
# the behavior to use the new URLs.
CHROMEDRIVER_CDNURL: https://googlechromelabs.github.io/
CHROMEDRIVER_CDNBINARIESURL: https://storage.googleapis.com/chrome-for-testing-public
CHROME_VALIDATED_VERSION: linux-120.0.6099.71
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/test-changed-auth.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ env:
# make chromedriver detect installed Chrome version and download the corresponding driver
DETECT_CHROMEDRIVER_VERSION: true
# The default behavior of chromedriver uses the older Chrome download URLs. We need to override
# the beahvior to use the new URLs.
# the behavior to use the new URLs.
CHROMEDRIVER_CDNURL: https://googlechromelabs.github.io/
CHROMEDRIVER_CDNBINARIESURL: https://storage.googleapis.com/chrome-for-testing-public
CHROME_VALIDATED_VERSION: linux-120.0.6099.71
Expand Down
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ review.
* Make your changes in a new git branch:

```shell
git checkout -b my-fix-branch master
git checkout -b my-fix-branch main
```

* Create your change, **including appropriate test cases**. Changes with tests are more likely to be
Expand Down Expand Up @@ -144,7 +144,7 @@ entries to the `.gitignore`).
git push origin my-fix-branch
```

* In GitHub, create a pull request against the `firebase-js-sdk:master` branch.
* In GitHub, create a pull request against the `firebase-js-sdk:main` branch.
* Add changeset. See [Adding changeset to PR](#adding-changeset-to-pr).
* All pull requests must be reviewed by a member of the Firebase JS SDK team, who will merge it
when/if they feel it is good to go.
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# Firebase Javascript SDK
# Firebase JavaScript SDK

<!-- BADGES -->
![Build Status](https://img.shields.io/github/actions/workflow/status/firebase/firebase-js-sdk/test-all.yml)
[![Version](https://img.shields.io/npm/v/firebase.svg?label=version)](https://www.npmjs.com/package/firebase)
[![Coverage Status](https://coveralls.io/repos/github/firebase/firebase-js-sdk/badge.svg?branch=master)](https://coveralls.io/github/firebase/firebase-js-sdk?branch=master)
[![Coverage Status](https://coveralls.io/repos/github/firebase/firebase-js-sdk/badge.svg?branch=main)](https://coveralls.io/github/firebase/firebase-js-sdk?branch=main)
<!-- END BADGES -->

The Firebase JavaScript SDK implements the client-side libraries used by
Expand Down
2 changes: 1 addition & 1 deletion config/api-extractor.json
Original file line number Diff line number Diff line change
Expand Up @@ -289,7 +289,7 @@
*/
"default": {
/**
* Specifies whether the message should be written to the the tool's output log. Note that
* Specifies whether the message should be written to the tool's output log. Note that
* the "addToApiReportFile" property may supersede this option.
*
* Possible values: "error", "warning", "none"
Expand Down
2 changes: 1 addition & 1 deletion config/karma.saucelabs.js
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ function getPackageLabels() {

/**
* Gets a list of file patterns for test, defined individually
* in karma.conf.js in each package under worksapce packages or
* in karma.conf.js in each package under workspace packages or
* integration.
*/
function getTestFiles() {
Expand Down
10 changes: 5 additions & 5 deletions docs-devsite/auth.githubauthprovider.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ export declare class GithubAuthProvider extends BaseOAuthProvider
| Method | Modifiers | Description |
| --- | --- | --- |
| [credential(accessToken)](./auth.githubauthprovider.md#githubauthprovidercredential) | <code>static</code> | Creates a credential for Github. |
| [credential(accessToken)](./auth.githubauthprovider.md#githubauthprovidercredential) | <code>static</code> | Creates a credential for GitHub. |
| [credentialFromError(error)](./auth.githubauthprovider.md#githubauthprovidercredentialfromerror) | <code>static</code> | Used to extract the underlying [OAuthCredential](./auth.oauthcredential.md#oauthcredential_class) from a [AuthError](./auth.autherror.md#autherror_interface) which was thrown during a sign-in, link, or reauthenticate operation. |
| [credentialFromResult(userCredential)](./auth.githubauthprovider.md#githubauthprovidercredentialfromresult) | <code>static</code> | Used to extract the underlying [OAuthCredential](./auth.oauthcredential.md#oauthcredential_class) from a [UserCredential](./auth.usercredential.md#usercredential_interface)<!-- -->. |
Expand Down Expand Up @@ -74,7 +74,7 @@ static readonly PROVIDER_ID: 'github.com';
## GithubAuthProvider.credential()
Creates a credential for Github.
Creates a credential for GitHub.
<b>Signature:</b>
Expand All @@ -86,7 +86,7 @@ static credential(accessToken: string): OAuthCredential;
| Parameter | Type | Description |
| --- | --- | --- |
| accessToken | string | Github access token. |
| accessToken | string | GitHub access token. |
<b>Returns:</b>
Expand Down Expand Up @@ -148,7 +148,7 @@ const result = await getRedirectResult(auth);
if (result) {
// This is the signed-in user
const user = result.user;
// This gives you a Github Access Token.
// This gives you a GitHub Access Token.
const credential = GithubAuthProvider.credentialFromResult(result);
const token = credential.accessToken;
}
Expand All @@ -166,7 +166,7 @@ const result = await signInWithPopup(auth, provider);

// The signed-in user info.
const user = result.user;
// This gives you a Github Access Token.
// This gives you a GitHub Access Token.
const credential = GithubAuthProvider.credentialFromResult(result);
const token = credential.accessToken;

Expand Down
4 changes: 2 additions & 2 deletions docs-devsite/database.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Firebase Realtime Database
| Function | Description |
| --- | --- |
| <b>function(app, ...)</b> |
| [getDatabase(app, url)](./database.md#getdatabase_d9cea01) | Returns the instance of the Realtime Database SDK that is associated with the provided [FirebaseApp](./app.firebaseapp.md#firebaseapp_interface)<!-- -->. Initializes a new instance with with default settings if no instance exists or if the existing instance uses a custom database URL. |
| [getDatabase(app, url)](./database.md#getdatabase_d9cea01) | Returns the instance of the Realtime Database SDK that is associated with the provided [FirebaseApp](./app.firebaseapp.md#firebaseapp_interface)<!-- -->. Initializes a new instance with default settings if no instance exists or if the existing instance uses a custom database URL. |
| <b>function(db, ...)</b> |
| [connectDatabaseEmulator(db, host, port, options)](./database.md#connectdatabaseemulator_27b9e93) | Modify the provided instance to communicate with the Realtime Database emulator.<p>Note: This method must be called before performing any other operation. |
| [goOffline(db)](./database.md#gooffline_732b338) | Disconnects from the server (all Database operations will be completed offline).<!-- -->The client automatically maintains a persistent connection to the Database server, which will remain active indefinitely and reconnect when disconnected. However, the <code>goOffline()</code> and <code>goOnline()</code> methods may be used to control the client connection in cases where a persistent connection is undesirable.<!-- -->While offline, the client will no longer receive data updates from the Database. However, all Database operations performed locally will continue to immediately fire events, allowing your application to continue behaving normally. Additionally, each operation performed locally will automatically be queued and retried upon reconnection to the Database server.<!-- -->To reconnect to the Database and begin receiving remote events, see <code>goOnline()</code>. |
Expand Down Expand Up @@ -112,7 +112,7 @@ Firebase Realtime Database

### getDatabase(app, url) {:#getdatabase_d9cea01}

Returns the instance of the Realtime Database SDK that is associated with the provided [FirebaseApp](./app.firebaseapp.md#firebaseapp_interface)<!-- -->. Initializes a new instance with with default settings if no instance exists or if the existing instance uses a custom database URL.
Returns the instance of the Realtime Database SDK that is associated with the provided [FirebaseApp](./app.firebaseapp.md#firebaseapp_interface)<!-- -->. Initializes a new instance with default settings if no instance exists or if the existing instance uses a custom database URL.

<b>Signature:</b>

Expand Down
Loading

0 comments on commit 5ae04bc

Please sign in to comment.