From 05c34c91e61deb1c148ff1bc99333fc50e9e371f Mon Sep 17 00:00:00 2001 From: Kia Abdi <65511468+TheeKia@users.noreply.github.com> Date: Tue, 20 Aug 2024 00:22:50 +0300 Subject: [PATCH 01/11] fix: remove unnecessary console.log statement (#8437) --- .changeset/perfect-weeks-care.md | 5 +++++ packages/app/src/heartbeatService.ts | 1 - 2 files changed, 5 insertions(+), 1 deletion(-) create mode 100644 .changeset/perfect-weeks-care.md diff --git a/.changeset/perfect-weeks-care.md b/.changeset/perfect-weeks-care.md new file mode 100644 index 00000000000..7059cdb5c45 --- /dev/null +++ b/.changeset/perfect-weeks-care.md @@ -0,0 +1,5 @@ +--- +'@firebase/app': patch +--- + +Removed an unnecessary console.log statement. diff --git a/packages/app/src/heartbeatService.ts b/packages/app/src/heartbeatService.ts index 6bf9464319b..83a2b63993e 100644 --- a/packages/app/src/heartbeatService.ts +++ b/packages/app/src/heartbeatService.ts @@ -90,7 +90,6 @@ export class HeartbeatServiceImpl implements HeartbeatService { // service, not the browser user agent. const agent = platformLogger.getPlatformInfoString(); const date = getUTCDateString(); - console.log('heartbeats', this._heartbeatsCache?.heartbeats); if (this._heartbeatsCache?.heartbeats == null) { this._heartbeatsCache = await this._heartbeatsCachePromise; // If we failed to construct a heartbeats cache, then return immediately. From 2ee2a90aebcf75a0df467c47a5f731b07ce69070 Mon Sep 17 00:00:00 2001 From: Segev Finer Date: Tue, 20 Aug 2024 01:10:34 +0300 Subject: [PATCH 02/11] Allow a custom path in Firebase functions custom domain (#8441) * Allow a custom path in Firebase functions custom domain * Add a test * Add changeset * Update packages/functions/src/service.ts Co-authored-by: Daniel La Rocque --------- Co-authored-by: Daniel La Rocque --- .changeset/dull-nails-kneel.md | 5 +++++ packages/functions/src/service.test.ts | 5 +++++ packages/functions/src/service.ts | 3 ++- 3 files changed, 12 insertions(+), 1 deletion(-) create mode 100644 .changeset/dull-nails-kneel.md diff --git a/.changeset/dull-nails-kneel.md b/.changeset/dull-nails-kneel.md new file mode 100644 index 00000000000..09403953549 --- /dev/null +++ b/.changeset/dull-nails-kneel.md @@ -0,0 +1,5 @@ +--- +'@firebase/functions': patch +--- + +Allow a custom path in Firebase functions custom domain diff --git a/packages/functions/src/service.test.ts b/packages/functions/src/service.test.ts index 1a43b32136f..bb29f9025fe 100644 --- a/packages/functions/src/service.test.ts +++ b/packages/functions/src/service.test.ts @@ -70,6 +70,11 @@ describe('Firebase Functions > Service', () => { assert.equal(service._url('foo'), 'https://mydomain.com/foo'); }); + it('correctly sets custom domain with path', () => { + service = createTestService(app, 'https://mydomain.com/functions'); + assert.equal(service._url('foo'), 'https://mydomain.com/functions/foo'); + }); + it('prefers emulator to custom domain', () => { const service = createTestService(app, 'https://mydomain.com'); connectFunctionsEmulator(service, 'localhost', 5005); diff --git a/packages/functions/src/service.ts b/packages/functions/src/service.ts index b70a5b1fe57..c5fe7fa8a85 100644 --- a/packages/functions/src/service.ts +++ b/packages/functions/src/service.ts @@ -122,7 +122,8 @@ export class FunctionsService implements _FirebaseService { // Resolve the region or custom domain overload by attempting to parse it. try { const url = new URL(regionOrCustomDomain); - this.customDomain = url.origin; + this.customDomain = + url.origin + (url.pathname === '/' ? '' : url.pathname); this.region = DEFAULT_REGION; } catch (e) { this.customDomain = null; From 62348e116c795d19c5ca58729c250805240ce345 Mon Sep 17 00:00:00 2001 From: DellaBitta Date: Tue, 20 Aug 2024 09:38:06 -0400 Subject: [PATCH 03/11] Update undici dependency (#8432) Update our dependency on Undici to `6.19.7`. Earlier implementations contained a memory leak. Fixes #8431. --- .changeset/sixty-cycles-scream.md | 10 ++++++++++ integration/messaging/package.json | 2 +- package.json | 2 +- packages/auth-compat/package.json | 2 +- packages/auth/package.json | 2 +- packages/firestore/package.json | 2 +- packages/functions/package.json | 2 +- packages/storage/package.json | 2 +- repo-scripts/changelog-generator/package.json | 2 +- yarn.lock | 15 ++++----------- 10 files changed, 22 insertions(+), 19 deletions(-) create mode 100644 .changeset/sixty-cycles-scream.md diff --git a/.changeset/sixty-cycles-scream.md b/.changeset/sixty-cycles-scream.md new file mode 100644 index 00000000000..1c848d94b36 --- /dev/null +++ b/.changeset/sixty-cycles-scream.md @@ -0,0 +1,10 @@ +--- +'@firebase/auth-compat': patch +'@firebase/firestore': patch +'@firebase/functions': patch +'@firebase/storage': patch +'@firebase/auth': patch +'firebase': patch +--- + +Update undici dependency to 6.19.7 due to a memory leak in older versions. diff --git a/integration/messaging/package.json b/integration/messaging/package.json index 07e7e21bd9a..bd32daa7f21 100644 --- a/integration/messaging/package.json +++ b/integration/messaging/package.json @@ -15,7 +15,7 @@ "express": "4.19.2", "geckodriver": "2.0.4", "mocha": "9.2.2", - "undici": "5.28.4", + "undici": "6.19.7", "selenium-assistant": "6.1.1" } } diff --git a/package.json b/package.json index 5918cf1b3fc..32d8e78eeb9 100644 --- a/package.json +++ b/package.json @@ -156,7 +156,7 @@ "tslint": "6.1.3", "typedoc": "0.16.11", "typescript": "4.7.4", - "undici": "5.28.4", + "undici": "6.19.7", "watch": "1.0.2", "webpack": "5.76.0", "yargs": "17.7.2" diff --git a/packages/auth-compat/package.json b/packages/auth-compat/package.json index b8de7c494da..770b0438d63 100644 --- a/packages/auth-compat/package.json +++ b/packages/auth-compat/package.json @@ -55,7 +55,7 @@ "@firebase/auth-types": "0.12.2", "@firebase/component": "0.6.8", "@firebase/util": "1.9.7", - "undici": "5.28.4", + "undici": "6.19.7", "tslib": "^2.1.0" }, "license": "Apache-2.0", diff --git a/packages/auth/package.json b/packages/auth/package.json index 5fc03c9c57f..add928154b5 100644 --- a/packages/auth/package.json +++ b/packages/auth/package.json @@ -130,7 +130,7 @@ "@firebase/component": "0.6.8", "@firebase/logger": "0.4.2", "@firebase/util": "1.9.7", - "undici": "5.28.4", + "undici": "6.19.7", "tslib": "^2.1.0" }, "license": "Apache-2.0", diff --git a/packages/firestore/package.json b/packages/firestore/package.json index f2f18451fb5..5547161658b 100644 --- a/packages/firestore/package.json +++ b/packages/firestore/package.json @@ -103,7 +103,7 @@ "@firebase/webchannel-wrapper": "1.0.1", "@grpc/grpc-js": "~1.9.0", "@grpc/proto-loader": "^0.7.8", - "undici": "5.28.4", + "undici": "6.19.7", "tslib": "^2.1.0" }, "peerDependencies": { diff --git a/packages/functions/package.json b/packages/functions/package.json index 3f0aea9cac7..f69d514b376 100644 --- a/packages/functions/package.json +++ b/packages/functions/package.json @@ -72,7 +72,7 @@ "@firebase/auth-interop-types": "0.2.3", "@firebase/app-check-interop-types": "0.3.2", "@firebase/util": "1.9.7", - "undici": "5.28.4", + "undici": "6.19.7", "tslib": "^2.1.0" }, "nyc": { diff --git a/packages/storage/package.json b/packages/storage/package.json index 23768508baf..f609e2b5f85 100644 --- a/packages/storage/package.json +++ b/packages/storage/package.json @@ -49,7 +49,7 @@ "dependencies": { "@firebase/util": "1.9.7", "@firebase/component": "0.6.8", - "undici": "5.28.4", + "undici": "6.19.7", "tslib": "^2.1.0" }, "peerDependencies": { diff --git a/repo-scripts/changelog-generator/package.json b/repo-scripts/changelog-generator/package.json index e04bb6f2ecf..f4afc131d1f 100644 --- a/repo-scripts/changelog-generator/package.json +++ b/repo-scripts/changelog-generator/package.json @@ -20,7 +20,7 @@ "@changesets/types": "3.3.0", "@changesets/get-github-info": "0.5.2", "@types/node": "20.8.10", - "undici": "5.28.4" + "undici": "6.19.7" }, "license": "Apache-2.0", "devDependencies": { diff --git a/yarn.lock b/yarn.lock index 49bbd54a546..477e784871e 100644 --- a/yarn.lock +++ b/yarn.lock @@ -1639,11 +1639,6 @@ resolved "https://registry.npmjs.org/@eslint/js/-/js-8.56.0.tgz#ef20350fec605a7f7035a01764731b2de0f3782b" integrity sha512-gMsVel9D7f2HLkBma9VbtzZRehRogVRfbr++f06nL2vnCGCNlzOD+/MUov/F4p8myyAHspEhVobgjpX64q5m6A== -"@fastify/busboy@^2.0.0": - version "2.0.0" - resolved "https://registry.npmjs.org/@fastify/busboy/-/busboy-2.0.0.tgz#f22824caff3ae506b18207bad4126dbc6ccdb6b8" - integrity sha512-JUFJad5lv7jxj926GPgymrWQxxjPYuJNiNjNMzqT+HiuP6Vl3dk5xzG+8sTX96np0ZAluvaMzPsjhHZ5rNuNQQ== - "@gar/promisify@^1.0.1": version "1.1.2" resolved "https://registry.npmjs.org/@gar/promisify/-/promisify-1.1.2.tgz" @@ -17393,12 +17388,10 @@ undici-types@~5.26.4: resolved "https://registry.npmjs.org/undici-types/-/undici-types-5.26.5.tgz#bcd539893d00b56e964fd2657a4866b221a65617" integrity sha512-JlCMO+ehdEIKqlFxk6IfVoAUVmgz7cU7zD/h9XZ0qzeosSHmUJVOzSQvvYSYWXkFXC+IfLKSIffhv0sVZup6pA== -undici@5.28.4: - version "5.28.4" - resolved "https://registry.npmjs.org/undici/-/undici-5.28.4.tgz#6b280408edb6a1a604a9b20340f45b422e373068" - integrity sha512-72RFADWFqKmUb2hmmvNODKL3p9hcB6Gt2DOQMis1SEBaV6a4MH8soBvzg+95CYhCKPFedut2JY9bMfrDl9D23g== - dependencies: - "@fastify/busboy" "^2.0.0" +undici@6.19.7: + version "6.19.7" + resolved "https://registry.npmjs.org/undici/-/undici-6.19.7.tgz#7d4cf26dc689838aa8b6753a3c5c4288fc1e0216" + integrity sha512-HR3W/bMGPSr90i8AAp2C4DM3wChFdJPLrWYpIS++LxS8K+W535qftjt+4MyjNYHeWabMj1nvtmLIi7l++iq91A== unicode-canonical-property-names-ecmascript@^2.0.0: version "2.0.0" From 1ff9661af927ee665c833c43c7a088eb61e796ec Mon Sep 17 00:00:00 2001 From: Daniel La Rocque Date: Tue, 20 Aug 2024 09:37:06 -0500 Subject: [PATCH 04/11] Update Bug Report Template (#8434) --- .github/ISSUE_TEMPLATE/bug_report_v2.yaml | 37 ++++++++++++++--------- 1 file changed, 22 insertions(+), 15 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report_v2.yaml b/.github/ISSUE_TEMPLATE/bug_report_v2.yaml index 289ab8125b0..0d68981c80b 100644 --- a/.github/ISSUE_TEMPLATE/bug_report_v2.yaml +++ b/.github/ISSUE_TEMPLATE/bug_report_v2.yaml @@ -1,4 +1,4 @@ -# Copyright 2023 Google LLC +# Copyright 2024 Google LLC # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. @@ -21,7 +21,7 @@ body: id: before-you-start attributes: value: | - *[READ THIS]:* to evaluate if you are in the right place? + *[READ THIS]:* Are you in the right place? - 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. @@ -31,31 +31,31 @@ body: id: operating-system attributes: label: Operating System - description: Describe your operating system - placeholder: ex. iOS 16.4 + description: Describe the operating system(s) where you are experiencing the issue. + placeholder: ex. iOS 16.4, macOS Ventura 13.4, Windows 11 validations: required: true - type: input - id: browser-version + id: environment attributes: - label: Browser Version - description: Describe your browser version - placeholder: ex. Safari/604.1 + label: Environment (if applicable) + description: Describe the environment where you are experiencing the issue. This could include the browser and its version, Node.js version, or any other relevant environment details. + placeholder: ex. Chrome 115, Node.js v18.16.0, React Native validations: required: true - type: input id: firebase-sdk-version attributes: label: Firebase SDK Version - description: Describe your Firebase SDK Version + description: The Firebase JS SDK version you're using. placeholder: ex. 9.16.0 validations: required: true - type: dropdown id: firebase-sdk-products attributes: - label: 'Firebase SDK Product:' - description: Which Firebase Products are used in your app? + label: Firebase SDK Product(s) + description: Select the Firebase product(s) relevant to your issue. You can select multiple options in the dropdown. multiple: true options: - Analytics @@ -77,7 +77,7 @@ body: - type: textarea id: project-tooling attributes: - label: Describe your project's tooling + label: Project Tooling description: Describe the tooling your app is built with placeholder: React app with Webpack and Jest validations: @@ -85,8 +85,13 @@ body: - type: textarea id: describe-your-problem attributes: - label: Describe the problem - description: Describe what you were trying to do and what occurred + label: Detailed Problem Description + description: | + Please provide a clear and concise description of the problem. Include: + - What you were trying to achieve. + - What actually happened. + - Any error messages or unexpected behavior you observed. + - Relevant log snippets or console output (if available). placeholder: | What were you trying to accomplish? What happened? This should include a background description, log/console output, etc. validations: @@ -95,6 +100,8 @@ body: id: reproduce-code attributes: label: Steps and code to reproduce issue - description: Please provide a description of how to replicate your issue. Copy and paste any relevant code here to reproduce the problem or links to code to reproduce it. + description: | + If possible, provide a minimal, self-contained code snippet or steps that consistently reproduce the issue. + This will significantly aid in debugging. validations: required: true From 12ba46ff4cfa732d3466254ab2ae7dd678ecc055 Mon Sep 17 00:00:00 2001 From: Daniel La Rocque Date: Tue, 20 Aug 2024 12:52:56 -0500 Subject: [PATCH 05/11] Fix Storage Node tests (#8443) --- .../test/integration/integration.test.ts | 2 +- packages/storage/test/unit/requests.test.ts | 24 +++++++------------ 2 files changed, 9 insertions(+), 17 deletions(-) diff --git a/packages/storage/test/integration/integration.test.ts b/packages/storage/test/integration/integration.test.ts index df6622b5878..d3d6a5fa0cc 100644 --- a/packages/storage/test/integration/integration.test.ts +++ b/packages/storage/test/integration/integration.test.ts @@ -215,5 +215,5 @@ describe('FirebaseStorage Exp', () => { await task; const bytes = await getBytes(referenceA); expect(bytes).to.deep.eq(bytesToUpload); - }); + }).timeout(10_000); }); diff --git a/packages/storage/test/unit/requests.test.ts b/packages/storage/test/unit/requests.test.ts index 65fbc17cfba..efa6accb98b 100644 --- a/packages/storage/test/unit/requests.test.ts +++ b/packages/storage/test/unit/requests.test.ts @@ -145,19 +145,6 @@ describe('Firebase Storage > Requests', () => { const metadataContentType = 'application/json; charset=utf-8'; - function readBlob(blob: Blob): Promise { - const reader = new FileReader(); - reader.readAsText(blob); - return new Promise((resolve, reject) => { - reader.onload = () => { - resolve(reader.result as string); - }; - reader.onerror = () => { - reject(reader.error as Error); - }; - }); - } - async function assertBodyEquals( body: Blob | string | Uint8Array | null, expectedStr: string @@ -167,9 +154,14 @@ describe('Firebase Storage > Requests', () => { } if (typeof Blob !== 'undefined' && body instanceof Blob) { - return readBlob(body).then(str => { - assert.equal(str, expectedStr); - }); + return body + .text() + .then(str => { + assert.equal(str, expectedStr); + }) + .catch(err => { + return Promise.reject(err); + }); } else if (body instanceof Uint8Array) { const str = decodeUint8Array(body); assert.equal(str, expectedStr); From 8a96f4f11b6e5bdac55f2f8bfd96b06d61c9860b Mon Sep 17 00:00:00 2001 From: Daniel La Rocque Date: Tue, 20 Aug 2024 13:22:11 -0500 Subject: [PATCH 06/11] Upgrade vertex responses to v3 (#8445) --- packages/vertexai/src/requests/stream-reader.test.ts | 2 +- scripts/update_vertexai_responses.sh | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/packages/vertexai/src/requests/stream-reader.test.ts b/packages/vertexai/src/requests/stream-reader.test.ts index d390666f4b0..eea72f9c7a6 100644 --- a/packages/vertexai/src/requests/stream-reader.test.ts +++ b/packages/vertexai/src/requests/stream-reader.test.ts @@ -210,7 +210,7 @@ describe('processStream', () => { expect(aggregatedResponse.text()).to.include('Quantum mechanics is'); expect( aggregatedResponse.candidates?.[0].citationMetadata?.citations.length - ).to.equal(2); + ).to.equal(3); let foundCitationMetadata = false; for await (const response of result.stream) { expect(response.text()).to.not.be.empty; diff --git a/scripts/update_vertexai_responses.sh b/scripts/update_vertexai_responses.sh index 568612e340d..27c32a09ead 100755 --- a/scripts/update_vertexai_responses.sh +++ b/scripts/update_vertexai_responses.sh @@ -17,7 +17,7 @@ # This script replaces mock response files for Vertex AI unit tests with a fresh # clone of the shared repository of Vertex AI test data. -RESPONSES_VERSION='v2.*' # The major version of mock responses to use +RESPONSES_VERSION='v3.*' # The major version of mock responses to use REPO_NAME="vertexai-sdk-test-data" REPO_LINK="https://github.com/FirebaseExtended/$REPO_NAME.git" From fa0ed08fbbfba427a4a33814ec508fdc97c9b0d4 Mon Sep 17 00:00:00 2001 From: Daniel La Rocque Date: Wed, 21 Aug 2024 11:50:23 -0500 Subject: [PATCH 07/11] Repair devsite docs (#8447) --- docs-devsite/_toc.yaml | 559 +++++++++++++++++++++ docs-devsite/firestore_.vectorvalue.md | 62 +++ docs-devsite/firestore_lite.vectorvalue.md | 62 +++ 3 files changed, 683 insertions(+) create mode 100644 docs-devsite/_toc.yaml create mode 100644 docs-devsite/firestore_.vectorvalue.md create mode 100644 docs-devsite/firestore_lite.vectorvalue.md diff --git a/docs-devsite/_toc.yaml b/docs-devsite/_toc.yaml new file mode 100644 index 00000000000..3a04923f8de --- /dev/null +++ b/docs-devsite/_toc.yaml @@ -0,0 +1,559 @@ +toc: + - title: firebase + path: /docs/reference/js/index + - title: analytics + path: /docs/reference/js/analytics.md + section: + - title: Analytics + path: /docs/reference/js/analytics.analytics.md + - title: AnalyticsCallOptions + path: /docs/reference/js/analytics.analyticscalloptions.md + - title: AnalyticsSettings + path: /docs/reference/js/analytics.analyticssettings.md + - title: ConsentSettings + path: /docs/reference/js/analytics.consentsettings.md + - title: ControlParams + path: /docs/reference/js/analytics.controlparams.md + - title: CustomParams + path: /docs/reference/js/analytics.customparams.md + - title: EventParams + path: /docs/reference/js/analytics.eventparams.md + - title: GtagConfigParams + path: /docs/reference/js/analytics.gtagconfigparams.md + - title: Item + path: /docs/reference/js/analytics.item.md + - title: Promotion + path: /docs/reference/js/analytics.promotion.md + - title: SettingsOptions + path: /docs/reference/js/analytics.settingsoptions.md + - title: app + path: /docs/reference/js/app.md + section: + - title: FirebaseApp + path: /docs/reference/js/app.firebaseapp.md + - title: FirebaseAppSettings + path: /docs/reference/js/app.firebaseappsettings.md + - title: FirebaseOptions + path: /docs/reference/js/app.firebaseoptions.md + - title: FirebaseServerApp + path: /docs/reference/js/app.firebaseserverapp.md + - title: FirebaseServerAppSettings + path: /docs/reference/js/app.firebaseserverappsettings.md + - title: app-check + path: /docs/reference/js/app-check.md + section: + - title: AppCheck + path: /docs/reference/js/app-check.appcheck.md + - title: AppCheckOptions + path: /docs/reference/js/app-check.appcheckoptions.md + - title: AppCheckToken + path: /docs/reference/js/app-check.appchecktoken.md + - title: AppCheckTokenResult + path: /docs/reference/js/app-check.appchecktokenresult.md + - title: CustomProvider + path: /docs/reference/js/app-check.customprovider.md + - title: CustomProviderOptions + path: /docs/reference/js/app-check.customprovideroptions.md + - title: ReCaptchaEnterpriseProvider + path: /docs/reference/js/app-check.recaptchaenterpriseprovider.md + - title: ReCaptchaV3Provider + path: /docs/reference/js/app-check.recaptchav3provider.md + - title: auth + path: /docs/reference/js/auth.md + section: + - title: ActionCodeInfo + path: /docs/reference/js/auth.actioncodeinfo.md + - title: ActionCodeSettings + path: /docs/reference/js/auth.actioncodesettings.md + - title: ActionCodeURL + path: /docs/reference/js/auth.actioncodeurl.md + - title: AdditionalUserInfo + path: /docs/reference/js/auth.additionaluserinfo.md + - title: ApplicationVerifier + path: /docs/reference/js/auth.applicationverifier.md + - title: Auth + path: /docs/reference/js/auth.auth.md + - title: AuthCredential + path: /docs/reference/js/auth.authcredential.md + - title: AuthError + path: /docs/reference/js/auth.autherror.md + - title: AuthErrorMap + path: /docs/reference/js/auth.autherrormap.md + - title: AuthProvider + path: /docs/reference/js/auth.authprovider.md + - title: AuthSettings + path: /docs/reference/js/auth.authsettings.md + - title: Config + path: /docs/reference/js/auth.config.md + - title: ConfirmationResult + path: /docs/reference/js/auth.confirmationresult.md + - title: Dependencies + path: /docs/reference/js/auth.dependencies.md + - title: EmailAuthCredential + path: /docs/reference/js/auth.emailauthcredential.md + - title: EmailAuthProvider + path: /docs/reference/js/auth.emailauthprovider.md + - title: EmulatorConfig + path: /docs/reference/js/auth.emulatorconfig.md + - title: FacebookAuthProvider + path: /docs/reference/js/auth.facebookauthprovider.md + - title: GithubAuthProvider + path: /docs/reference/js/auth.githubauthprovider.md + - title: GoogleAuthProvider + path: /docs/reference/js/auth.googleauthprovider.md + - title: IdTokenResult + path: /docs/reference/js/auth.idtokenresult.md + - title: MultiFactorAssertion + path: /docs/reference/js/auth.multifactorassertion.md + - title: MultiFactorError + path: /docs/reference/js/auth.multifactorerror.md + - title: MultiFactorInfo + path: /docs/reference/js/auth.multifactorinfo.md + - title: MultiFactorResolver + path: /docs/reference/js/auth.multifactorresolver.md + - title: MultiFactorSession + path: /docs/reference/js/auth.multifactorsession.md + - title: MultiFactorUser + path: /docs/reference/js/auth.multifactoruser.md + - title: OAuthCredential + path: /docs/reference/js/auth.oauthcredential.md + - title: OAuthCredentialOptions + path: /docs/reference/js/auth.oauthcredentialoptions.md + - title: OAuthProvider + path: /docs/reference/js/auth.oauthprovider.md + - title: ParsedToken + path: /docs/reference/js/auth.parsedtoken.md + - title: PasswordPolicy + path: /docs/reference/js/auth.passwordpolicy.md + - title: PasswordValidationStatus + path: /docs/reference/js/auth.passwordvalidationstatus.md + - title: Persistence + path: /docs/reference/js/auth.persistence.md + - title: PhoneAuthCredential + path: /docs/reference/js/auth.phoneauthcredential.md + - title: PhoneAuthProvider + path: /docs/reference/js/auth.phoneauthprovider.md + - title: PhoneMultiFactorAssertion + path: /docs/reference/js/auth.phonemultifactorassertion.md + - title: PhoneMultiFactorEnrollInfoOptions + path: /docs/reference/js/auth.phonemultifactorenrollinfooptions.md + - title: PhoneMultiFactorGenerator + path: /docs/reference/js/auth.phonemultifactorgenerator.md + - title: PhoneMultiFactorInfo + path: /docs/reference/js/auth.phonemultifactorinfo.md + - title: PhoneMultiFactorSignInInfoOptions + path: /docs/reference/js/auth.phonemultifactorsignininfooptions.md + - title: PhoneSingleFactorInfoOptions + path: /docs/reference/js/auth.phonesinglefactorinfooptions.md + - title: PopupRedirectResolver + path: /docs/reference/js/auth.popupredirectresolver.md + - title: ReactNativeAsyncStorage + path: /docs/reference/js/auth.reactnativeasyncstorage.md + - title: RecaptchaParameters + path: /docs/reference/js/auth.recaptchaparameters.md + - title: RecaptchaVerifier + path: /docs/reference/js/auth.recaptchaverifier.md + - title: SAMLAuthProvider + path: /docs/reference/js/auth.samlauthprovider.md + - title: TotpMultiFactorAssertion + path: /docs/reference/js/auth.totpmultifactorassertion.md + - title: TotpMultiFactorGenerator + path: /docs/reference/js/auth.totpmultifactorgenerator.md + - title: TotpMultiFactorInfo + path: /docs/reference/js/auth.totpmultifactorinfo.md + - title: TotpSecret + path: /docs/reference/js/auth.totpsecret.md + - title: TwitterAuthProvider + path: /docs/reference/js/auth.twitterauthprovider.md + - title: User + path: /docs/reference/js/auth.user.md + - title: UserCredential + path: /docs/reference/js/auth.usercredential.md + - title: UserInfo + path: /docs/reference/js/auth.userinfo.md + - title: UserMetadata + path: /docs/reference/js/auth.usermetadata.md + - title: database + path: /docs/reference/js/database.md + section: + - title: Database + path: /docs/reference/js/database.database.md + - title: DatabaseReference + path: /docs/reference/js/database.databasereference.md + - title: DataSnapshot + path: /docs/reference/js/database.datasnapshot.md + - title: IteratedDataSnapshot + path: /docs/reference/js/database.iterateddatasnapshot.md + - title: ListenOptions + path: /docs/reference/js/database.listenoptions.md + - title: OnDisconnect + path: /docs/reference/js/database.ondisconnect.md + - title: Query + path: /docs/reference/js/database.query.md + - title: QueryConstraint + path: /docs/reference/js/database.queryconstraint.md + - title: ThenableReference + path: /docs/reference/js/database.thenablereference.md + - title: TransactionOptions + path: /docs/reference/js/database.transactionoptions.md + - title: TransactionResult + path: /docs/reference/js/database.transactionresult.md + - title: firestore + path: /docs/reference/js/firestore_.md + section: + - title: AggregateField + path: /docs/reference/js/firestore_.aggregatefield.md + - title: AggregateQuerySnapshot + path: /docs/reference/js/firestore_.aggregatequerysnapshot.md + - title: AggregateSpec + path: /docs/reference/js/firestore_.aggregatespec.md + - title: Bytes + path: /docs/reference/js/firestore_.bytes.md + - title: CollectionReference + path: /docs/reference/js/firestore_.collectionreference.md + - title: DocumentChange + path: /docs/reference/js/firestore_.documentchange.md + - title: DocumentData + path: /docs/reference/js/firestore_.documentdata.md + - title: DocumentReference + path: /docs/reference/js/firestore_.documentreference.md + - title: DocumentSnapshot + path: /docs/reference/js/firestore_.documentsnapshot.md + - title: ExperimentalLongPollingOptions + path: /docs/reference/js/firestore_.experimentallongpollingoptions.md + - title: FieldPath + path: /docs/reference/js/firestore_.fieldpath.md + - title: FieldValue + path: /docs/reference/js/firestore_.fieldvalue.md + - title: Firestore + path: /docs/reference/js/firestore_.firestore.md + - title: FirestoreDataConverter + path: /docs/reference/js/firestore_.firestoredataconverter.md + - title: FirestoreError + path: /docs/reference/js/firestore_.firestoreerror.md + - title: FirestoreSettings + path: /docs/reference/js/firestore_.firestoresettings.md + - title: GeoPoint + path: /docs/reference/js/firestore_.geopoint.md + - title: Index + path: /docs/reference/js/firestore_.index.md + - title: IndexConfiguration + path: /docs/reference/js/firestore_.indexconfiguration.md + - title: IndexField + path: /docs/reference/js/firestore_.indexfield.md + - title: LoadBundleTask + path: /docs/reference/js/firestore_.loadbundletask.md + - title: LoadBundleTaskProgress + path: /docs/reference/js/firestore_.loadbundletaskprogress.md + - title: MemoryCacheSettings + path: /docs/reference/js/firestore_.memorycachesettings.md + - title: MemoryEagerGarbageCollector + path: /docs/reference/js/firestore_.memoryeagergarbagecollector.md + - title: MemoryLocalCache + path: /docs/reference/js/firestore_.memorylocalcache.md + - title: MemoryLruGarbageCollector + path: /docs/reference/js/firestore_.memorylrugarbagecollector.md + - title: PersistenceSettings + path: /docs/reference/js/firestore_.persistencesettings.md + - title: PersistentCacheIndexManager + path: /docs/reference/js/firestore_.persistentcacheindexmanager.md + - title: PersistentCacheSettings + path: /docs/reference/js/firestore_.persistentcachesettings.md + - title: PersistentLocalCache + path: /docs/reference/js/firestore_.persistentlocalcache.md + - title: PersistentMultipleTabManager + path: /docs/reference/js/firestore_.persistentmultipletabmanager.md + - title: PersistentSingleTabManager + path: /docs/reference/js/firestore_.persistentsingletabmanager.md + - title: PersistentSingleTabManagerSettings + path: /docs/reference/js/firestore_.persistentsingletabmanagersettings.md + - title: Query + path: /docs/reference/js/firestore_.query.md + - title: QueryCompositeFilterConstraint + path: /docs/reference/js/firestore_.querycompositefilterconstraint.md + - title: QueryConstraint + path: /docs/reference/js/firestore_.queryconstraint.md + - title: QueryDocumentSnapshot + path: /docs/reference/js/firestore_.querydocumentsnapshot.md + - title: QueryEndAtConstraint + path: /docs/reference/js/firestore_.queryendatconstraint.md + - title: QueryFieldFilterConstraint + path: /docs/reference/js/firestore_.queryfieldfilterconstraint.md + - title: QueryLimitConstraint + path: /docs/reference/js/firestore_.querylimitconstraint.md + - title: QueryOrderByConstraint + path: /docs/reference/js/firestore_.queryorderbyconstraint.md + - title: QuerySnapshot + path: /docs/reference/js/firestore_.querysnapshot.md + - title: QueryStartAtConstraint + path: /docs/reference/js/firestore_.querystartatconstraint.md + - title: SnapshotListenOptions + path: /docs/reference/js/firestore_.snapshotlistenoptions.md + - title: SnapshotMetadata + path: /docs/reference/js/firestore_.snapshotmetadata.md + - title: SnapshotOptions + path: /docs/reference/js/firestore_.snapshotoptions.md + - title: Timestamp + path: /docs/reference/js/firestore_.timestamp.md + - title: Transaction + path: /docs/reference/js/firestore_.transaction.md + - title: TransactionOptions + path: /docs/reference/js/firestore_.transactionoptions.md + - title: Unsubscribe + path: /docs/reference/js/firestore_.unsubscribe.md + - title: VectorValue + path: /docs/reference/js/firestore_.vectorvalue.md + - title: WriteBatch + path: /docs/reference/js/firestore_.writebatch.md + - title: firestore/lite + path: /docs/reference/js/firestore_lite.md + section: + - title: AggregateField + path: /docs/reference/js/firestore_lite.aggregatefield.md + - title: AggregateQuerySnapshot + path: /docs/reference/js/firestore_lite.aggregatequerysnapshot.md + - title: AggregateSpec + path: /docs/reference/js/firestore_lite.aggregatespec.md + - title: Bytes + path: /docs/reference/js/firestore_lite.bytes.md + - title: CollectionReference + path: /docs/reference/js/firestore_lite.collectionreference.md + - title: DocumentData + path: /docs/reference/js/firestore_lite.documentdata.md + - title: DocumentReference + path: /docs/reference/js/firestore_lite.documentreference.md + - title: DocumentSnapshot + path: /docs/reference/js/firestore_lite.documentsnapshot.md + - title: FieldPath + path: /docs/reference/js/firestore_lite.fieldpath.md + - title: FieldValue + path: /docs/reference/js/firestore_lite.fieldvalue.md + - title: Firestore + path: /docs/reference/js/firestore_lite.firestore.md + - title: FirestoreDataConverter + path: /docs/reference/js/firestore_lite.firestoredataconverter.md + - title: FirestoreError + path: /docs/reference/js/firestore_lite.firestoreerror.md + - title: GeoPoint + path: /docs/reference/js/firestore_lite.geopoint.md + - title: Query + path: /docs/reference/js/firestore_lite.query.md + - title: QueryCompositeFilterConstraint + path: /docs/reference/js/firestore_lite.querycompositefilterconstraint.md + - title: QueryConstraint + path: /docs/reference/js/firestore_lite.queryconstraint.md + - title: QueryDocumentSnapshot + path: /docs/reference/js/firestore_lite.querydocumentsnapshot.md + - title: QueryEndAtConstraint + path: /docs/reference/js/firestore_lite.queryendatconstraint.md + - title: QueryFieldFilterConstraint + path: /docs/reference/js/firestore_lite.queryfieldfilterconstraint.md + - title: QueryLimitConstraint + path: /docs/reference/js/firestore_lite.querylimitconstraint.md + - title: QueryOrderByConstraint + path: /docs/reference/js/firestore_lite.queryorderbyconstraint.md + - title: QuerySnapshot + path: /docs/reference/js/firestore_lite.querysnapshot.md + - title: QueryStartAtConstraint + path: /docs/reference/js/firestore_lite.querystartatconstraint.md + - title: Settings + path: /docs/reference/js/firestore_lite.settings.md + - title: Timestamp + path: /docs/reference/js/firestore_lite.timestamp.md + - title: Transaction + path: /docs/reference/js/firestore_lite.transaction.md + - title: TransactionOptions + path: /docs/reference/js/firestore_lite.transactionoptions.md + - title: VectorValue + path: /docs/reference/js/firestore_lite.vectorvalue.md + - title: WriteBatch + path: /docs/reference/js/firestore_lite.writebatch.md + - title: functions + path: /docs/reference/js/functions.md + section: + - title: Functions + path: /docs/reference/js/functions.functions.md + - title: FunctionsError + path: /docs/reference/js/functions.functionserror.md + - title: HttpsCallableOptions + path: /docs/reference/js/functions.httpscallableoptions.md + - title: HttpsCallableResult + path: /docs/reference/js/functions.httpscallableresult.md + - title: installations + path: /docs/reference/js/installations.md + section: + - title: Installations + path: /docs/reference/js/installations.installations.md + - title: messaging + path: /docs/reference/js/messaging_.md + section: + - title: FcmOptions + path: /docs/reference/js/messaging_.fcmoptions.md + - title: GetTokenOptions + path: /docs/reference/js/messaging_.gettokenoptions.md + - title: MessagePayload + path: /docs/reference/js/messaging_.messagepayload.md + - title: Messaging + path: /docs/reference/js/messaging_.messaging.md + - title: NotificationPayload + path: /docs/reference/js/messaging_.notificationpayload.md + - title: messaging/sw + path: /docs/reference/js/messaging_sw.md + section: + - title: FcmOptions + path: /docs/reference/js/messaging_sw.fcmoptions.md + - title: GetTokenOptions + path: /docs/reference/js/messaging_sw.gettokenoptions.md + - title: MessagePayload + path: /docs/reference/js/messaging_sw.messagepayload.md + - title: Messaging + path: /docs/reference/js/messaging_sw.messaging.md + - title: NotificationPayload + path: /docs/reference/js/messaging_sw.notificationpayload.md + - title: performance + path: /docs/reference/js/performance.md + section: + - title: FirebasePerformance + path: /docs/reference/js/performance.firebaseperformance.md + - title: PerformanceSettings + path: /docs/reference/js/performance.performancesettings.md + - title: PerformanceTrace + path: /docs/reference/js/performance.performancetrace.md + - title: remote-config + path: /docs/reference/js/remote-config.md + section: + - title: RemoteConfig + path: /docs/reference/js/remote-config.remoteconfig.md + - title: RemoteConfigSettings + path: /docs/reference/js/remote-config.remoteconfigsettings.md + - title: Value + path: /docs/reference/js/remote-config.value.md + - title: storage + path: /docs/reference/js/storage.md + section: + - title: FirebaseStorage + path: /docs/reference/js/storage.firebasestorage.md + - title: FullMetadata + path: /docs/reference/js/storage.fullmetadata.md + - title: ListOptions + path: /docs/reference/js/storage.listoptions.md + - title: ListResult + path: /docs/reference/js/storage.listresult.md + - title: SettableMetadata + path: /docs/reference/js/storage.settablemetadata.md + - title: StorageError + path: /docs/reference/js/storage.storageerror.md + - title: StorageObserver + path: /docs/reference/js/storage.storageobserver.md + - title: StorageReference + path: /docs/reference/js/storage.storagereference.md + - title: UploadMetadata + path: /docs/reference/js/storage.uploadmetadata.md + - title: UploadResult + path: /docs/reference/js/storage.uploadresult.md + - title: UploadTask + path: /docs/reference/js/storage.uploadtask.md + - title: UploadTaskSnapshot + path: /docs/reference/js/storage.uploadtasksnapshot.md + - title: vertexai-preview + path: /docs/reference/js/vertexai-preview.md + section: + - title: BaseParams + path: /docs/reference/js/vertexai-preview.baseparams.md + - title: ChatSession + path: /docs/reference/js/vertexai-preview.chatsession.md + - title: Citation + path: /docs/reference/js/vertexai-preview.citation.md + - title: CitationMetadata + path: /docs/reference/js/vertexai-preview.citationmetadata.md + - title: Content + path: /docs/reference/js/vertexai-preview.content.md + - title: CountTokensRequest + path: /docs/reference/js/vertexai-preview.counttokensrequest.md + - title: CountTokensResponse + path: /docs/reference/js/vertexai-preview.counttokensresponse.md + - title: CustomErrorData + path: /docs/reference/js/vertexai-preview.customerrordata.md + - title: Date_2 + path: /docs/reference/js/vertexai-preview.date_2.md + - title: EnhancedGenerateContentResponse + path: /docs/reference/js/vertexai-preview.enhancedgeneratecontentresponse.md + - title: ErrorDetails + path: /docs/reference/js/vertexai-preview.errordetails.md + - title: FileData + path: /docs/reference/js/vertexai-preview.filedata.md + - title: FileDataPart + path: /docs/reference/js/vertexai-preview.filedatapart.md + - title: FunctionCall + path: /docs/reference/js/vertexai-preview.functioncall.md + - title: FunctionCallingConfig + path: /docs/reference/js/vertexai-preview.functioncallingconfig.md + - title: FunctionCallPart + path: /docs/reference/js/vertexai-preview.functioncallpart.md + - title: FunctionDeclaration + path: /docs/reference/js/vertexai-preview.functiondeclaration.md + - title: FunctionDeclarationSchema + path: /docs/reference/js/vertexai-preview.functiondeclarationschema.md + - title: FunctionDeclarationSchemaProperty + path: >- + /docs/reference/js/vertexai-preview.functiondeclarationschemaproperty.md + - title: FunctionDeclarationsTool + path: /docs/reference/js/vertexai-preview.functiondeclarationstool.md + - title: FunctionResponse + path: /docs/reference/js/vertexai-preview.functionresponse.md + - title: FunctionResponsePart + path: /docs/reference/js/vertexai-preview.functionresponsepart.md + - title: GenerateContentCandidate + path: /docs/reference/js/vertexai-preview.generatecontentcandidate.md + - title: GenerateContentRequest + path: /docs/reference/js/vertexai-preview.generatecontentrequest.md + - title: GenerateContentResponse + path: /docs/reference/js/vertexai-preview.generatecontentresponse.md + - title: GenerateContentResult + path: /docs/reference/js/vertexai-preview.generatecontentresult.md + - title: GenerateContentStreamResult + path: /docs/reference/js/vertexai-preview.generatecontentstreamresult.md + - title: GenerationConfig + path: /docs/reference/js/vertexai-preview.generationconfig.md + - title: GenerativeContentBlob + path: /docs/reference/js/vertexai-preview.generativecontentblob.md + - title: GenerativeModel + path: /docs/reference/js/vertexai-preview.generativemodel.md + - title: GroundingAttribution + path: /docs/reference/js/vertexai-preview.groundingattribution.md + - title: GroundingMetadata + path: /docs/reference/js/vertexai-preview.groundingmetadata.md + - title: InlineDataPart + path: /docs/reference/js/vertexai-preview.inlinedatapart.md + - title: ModelParams + path: /docs/reference/js/vertexai-preview.modelparams.md + - title: PromptFeedback + path: /docs/reference/js/vertexai-preview.promptfeedback.md + - title: RequestOptions + path: /docs/reference/js/vertexai-preview.requestoptions.md + - title: RetrievedContextAttribution + path: /docs/reference/js/vertexai-preview.retrievedcontextattribution.md + - title: SafetyRating + path: /docs/reference/js/vertexai-preview.safetyrating.md + - title: SafetySetting + path: /docs/reference/js/vertexai-preview.safetysetting.md + - title: Segment + path: /docs/reference/js/vertexai-preview.segment.md + - title: StartChatParams + path: /docs/reference/js/vertexai-preview.startchatparams.md + - title: TextPart + path: /docs/reference/js/vertexai-preview.textpart.md + - title: ToolConfig + path: /docs/reference/js/vertexai-preview.toolconfig.md + - title: UsageMetadata + path: /docs/reference/js/vertexai-preview.usagemetadata.md + - title: VertexAI + path: /docs/reference/js/vertexai-preview.vertexai.md + - title: VertexAIError + path: /docs/reference/js/vertexai-preview.vertexaierror.md + - title: VertexAIOptions + path: /docs/reference/js/vertexai-preview.vertexaioptions.md + - title: VideoMetadata + path: /docs/reference/js/vertexai-preview.videometadata.md + - title: WebAttribution + path: /docs/reference/js/vertexai-preview.webattribution.md diff --git a/docs-devsite/firestore_.vectorvalue.md b/docs-devsite/firestore_.vectorvalue.md new file mode 100644 index 00000000000..7906970b2dd --- /dev/null +++ b/docs-devsite/firestore_.vectorvalue.md @@ -0,0 +1,62 @@ +Project: /docs/reference/js/_project.yaml +Book: /docs/reference/_book.yaml +page_type: reference + +{% comment %} +DO NOT EDIT THIS FILE! +This is generated by the JS SDK team, and any local changes will be +overwritten. Changes should be made in the source code at +https://github.com/firebase/firebase-js-sdk +{% endcomment %} + +# VectorValue class +Represents a vector type in Firestore documents. Create an instance with . + + VectorValue + +Signature: + +```typescript +export declare class VectorValue +``` + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [isEqual(other)](./firestore_.vectorvalue.md#vectorvalueisequal) | | Returns true if the two VectorValue has the same raw number arrays, returns false otherwise. | +| [toArray()](./firestore_.vectorvalue.md#vectorvaluetoarray) | | Returns a copy of the raw number array form of the vector. | + +## VectorValue.isEqual() + +Returns `true` if the two VectorValue has the same raw number arrays, returns `false` otherwise. + +Signature: + +```typescript +isEqual(other: VectorValue): boolean; +``` + +#### Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| other | [VectorValue](./firestore_.vectorvalue.md#vectorvalue_class) | | + +Returns: + +boolean + +## VectorValue.toArray() + +Returns a copy of the raw number array form of the vector. + +Signature: + +```typescript +toArray(): number[]; +``` +Returns: + +number\[\] + diff --git a/docs-devsite/firestore_lite.vectorvalue.md b/docs-devsite/firestore_lite.vectorvalue.md new file mode 100644 index 00000000000..6c5aa1f4ca4 --- /dev/null +++ b/docs-devsite/firestore_lite.vectorvalue.md @@ -0,0 +1,62 @@ +Project: /docs/reference/js/_project.yaml +Book: /docs/reference/_book.yaml +page_type: reference + +{% comment %} +DO NOT EDIT THIS FILE! +This is generated by the JS SDK team, and any local changes will be +overwritten. Changes should be made in the source code at +https://github.com/firebase/firebase-js-sdk +{% endcomment %} + +# VectorValue class +Represents a vector type in Firestore documents. Create an instance with . + + VectorValue + +Signature: + +```typescript +export declare class VectorValue +``` + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [isEqual(other)](./firestore_lite.vectorvalue.md#vectorvalueisequal) | | Returns true if the two VectorValue has the same raw number arrays, returns false otherwise. | +| [toArray()](./firestore_lite.vectorvalue.md#vectorvaluetoarray) | | Returns a copy of the raw number array form of the vector. | + +## VectorValue.isEqual() + +Returns `true` if the two VectorValue has the same raw number arrays, returns `false` otherwise. + +Signature: + +```typescript +isEqual(other: VectorValue): boolean; +``` + +#### Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| other | [VectorValue](./firestore_lite.vectorvalue.md#vectorvalue_class) | | + +Returns: + +boolean + +## VectorValue.toArray() + +Returns a copy of the raw number array form of the vector. + +Signature: + +```typescript +toArray(): number[]; +``` +Returns: + +number\[\] + From 4c2c78b1f3e9f5813c9af94fb3bbcdb1ac5408a8 Mon Sep 17 00:00:00 2001 From: Daniel La Rocque Date: Thu, 22 Aug 2024 09:17:10 -0500 Subject: [PATCH 08/11] Use git status to check for changes to devsite (#8448) --- .github/workflows/check-docs.yml | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/.github/workflows/check-docs.yml b/.github/workflows/check-docs.yml index bfd812a1855..ef4c38ce951 100644 --- a/.github/workflows/check-docs.yml +++ b/.github/workflows/check-docs.yml @@ -36,7 +36,12 @@ jobs: - name: Run doc generation run: yarn docgen:all - name: Check for changes in docs-devsite dir (fail if so) - run: git diff --exit-code docs-devsite + run: | + if [[ -n "$(git status docs-devsite --porcelain)" ]]; then + echo "Unstaged changes detected:" + git status -s + exit 1 + fi - name: Reference documentation needs to be updated. See message below. if: ${{ failure() }} run: echo "Changes in this PR affect the reference docs. Run \`yarn docgen:all\` locally to regenerate docs and add them to this PR." \ No newline at end of file From c6a885181295da3e55a1dc81f32d82b53cf7ff1a Mon Sep 17 00:00:00 2001 From: Daniel La Rocque Date: Thu, 22 Aug 2024 09:17:46 -0500 Subject: [PATCH 09/11] Run Storage Node tests in CI (#8375) The script that runs the tests in CI accepts a `-s` flag we use to pass the test command we want to run in CI. We were passing two commands, and only the first one (`test:browser`) was being run, skipping the Node tests. Now we only pass one command `test`, which runs both. --- packages/storage/package.json | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/packages/storage/package.json b/packages/storage/package.json index f609e2b5f85..cb8fdd48a55 100644 --- a/packages/storage/package.json +++ b/packages/storage/package.json @@ -34,7 +34,8 @@ "build:deps": "lerna run --scope @firebase/storage --include-dependencies build", "dev": "rollup -c -w", "test": "run-p --npm-path npm test:browser test:node lint", - "test:ci": "node ../../scripts/run_tests_in_ci.js -s test:browser test:node", + "test:all": "run-p --npm-path npm test:browser test:node", + "test:ci": "node ../../scripts/run_tests_in_ci.js -s test:all", "test:browser:unit": "karma start --single-run --unit", "test:browser:integration": "karma start --single-run --integration", "test:browser": "karma start --single-run", From 5594ebc9f770db11854d18fd693d0d6592fad349 Mon Sep 17 00:00:00 2001 From: Daniel La Rocque Date: Fri, 23 Aug 2024 09:40:38 -0500 Subject: [PATCH 10/11] Replace 'Vertex AI For Firebase' usage with 'Vertex AI in Firebase' (#8394) --- docs-devsite/index.md | 2 +- docs-devsite/vertexai-preview.md | 8 ++++---- docs-devsite/vertexai-preview.vertexai.md | 2 +- docs-devsite/vertexai-preview.vertexaierror.md | 2 +- docs-devsite/vertexai-preview.vertexaioptions.md | 2 +- packages/vertexai/src/errors.ts | 2 +- packages/vertexai/src/index.ts | 2 +- packages/vertexai/src/public-types.ts | 4 ++-- 8 files changed, 12 insertions(+), 12 deletions(-) diff --git a/docs-devsite/index.md b/docs-devsite/index.md index 2c22b58d80c..0064652e792 100644 --- a/docs-devsite/index.md +++ b/docs-devsite/index.md @@ -27,5 +27,5 @@ https://github.com/firebase/firebase-js-sdk | [@firebase/performance](./performance.md#performance_package) | The Firebase Performance Monitoring Web SDK. This SDK does not work in a Node.js environment. | | [@firebase/remote-config](./remote-config.md#remote-config_package) | The Firebase Remote Config Web SDK. This SDK does not work in a Node.js environment. | | [@firebase/storage](./storage.md#storage_package) | Cloud Storage for Firebase | -| [@firebase/vertexai-preview](./vertexai-preview.md#vertexai-preview_package) | The Vertex AI For Firebase Web SDK. | +| [@firebase/vertexai-preview](./vertexai-preview.md#vertexai-preview_package) | The Vertex AI in Firebase Web SDK. | diff --git a/docs-devsite/vertexai-preview.md b/docs-devsite/vertexai-preview.md index 57fbab35909..27829c8ad2e 100644 --- a/docs-devsite/vertexai-preview.md +++ b/docs-devsite/vertexai-preview.md @@ -10,7 +10,7 @@ https://github.com/firebase/firebase-js-sdk {% endcomment %} # vertexai-preview package -The Vertex AI For Firebase Web SDK. +The Vertex AI in Firebase Web SDK. ## Functions @@ -27,7 +27,7 @@ The Vertex AI For Firebase Web SDK. | --- | --- | | [ChatSession](./vertexai-preview.chatsession.md#chatsession_class) | ChatSession class that enables sending chat messages and stores history of sent and received messages so far. | | [GenerativeModel](./vertexai-preview.generativemodel.md#generativemodel_class) | Class for generative model APIs. | -| [VertexAIError](./vertexai-preview.vertexaierror.md#vertexaierror_class) | Error class for the Vertex AI for Firebase SDK. | +| [VertexAIError](./vertexai-preview.vertexaierror.md#vertexaierror_class) | Error class for the Vertex AI in Firebase SDK. | ## Enumerations @@ -90,8 +90,8 @@ The Vertex AI For Firebase Web SDK. | [TextPart](./vertexai-preview.textpart.md#textpart_interface) | Content part interface if the part represents a text string. | | [ToolConfig](./vertexai-preview.toolconfig.md#toolconfig_interface) | Tool config. This config is shared for all tools provided in the request. | | [UsageMetadata](./vertexai-preview.usagemetadata.md#usagemetadata_interface) | Usage metadata about a [GenerateContentResponse](./vertexai-preview.generatecontentresponse.md#generatecontentresponse_interface). | -| [VertexAI](./vertexai-preview.vertexai.md#vertexai_interface) | An instance of the Vertex AI for Firebase SDK. | -| [VertexAIOptions](./vertexai-preview.vertexaioptions.md#vertexaioptions_interface) | Options when initializing the Vertex AI for Firebase SDK. | +| [VertexAI](./vertexai-preview.vertexai.md#vertexai_interface) | An instance of the Vertex AI in Firebase SDK. | +| [VertexAIOptions](./vertexai-preview.vertexaioptions.md#vertexaioptions_interface) | Options when initializing the Vertex AI in Firebase SDK. | | [VideoMetadata](./vertexai-preview.videometadata.md#videometadata_interface) | Describes the input video content. | | [WebAttribution](./vertexai-preview.webattribution.md#webattribution_interface) | | diff --git a/docs-devsite/vertexai-preview.vertexai.md b/docs-devsite/vertexai-preview.vertexai.md index 35991f2be12..46c13416370 100644 --- a/docs-devsite/vertexai-preview.vertexai.md +++ b/docs-devsite/vertexai-preview.vertexai.md @@ -10,7 +10,7 @@ https://github.com/firebase/firebase-js-sdk {% endcomment %} # VertexAI interface -An instance of the Vertex AI for Firebase SDK. +An instance of the Vertex AI in Firebase SDK. Signature: diff --git a/docs-devsite/vertexai-preview.vertexaierror.md b/docs-devsite/vertexai-preview.vertexaierror.md index 05a12c62b8e..8ad434d0988 100644 --- a/docs-devsite/vertexai-preview.vertexaierror.md +++ b/docs-devsite/vertexai-preview.vertexaierror.md @@ -10,7 +10,7 @@ https://github.com/firebase/firebase-js-sdk {% endcomment %} # VertexAIError class -Error class for the Vertex AI for Firebase SDK. +Error class for the Vertex AI in Firebase SDK. Signature: diff --git a/docs-devsite/vertexai-preview.vertexaioptions.md b/docs-devsite/vertexai-preview.vertexaioptions.md index 320132c22f9..4b42406eb95 100644 --- a/docs-devsite/vertexai-preview.vertexaioptions.md +++ b/docs-devsite/vertexai-preview.vertexaioptions.md @@ -10,7 +10,7 @@ https://github.com/firebase/firebase-js-sdk {% endcomment %} # VertexAIOptions interface -Options when initializing the Vertex AI for Firebase SDK. +Options when initializing the Vertex AI in Firebase SDK. Signature: diff --git a/packages/vertexai/src/errors.ts b/packages/vertexai/src/errors.ts index 7cb7a30020b..46db2fd271f 100644 --- a/packages/vertexai/src/errors.ts +++ b/packages/vertexai/src/errors.ts @@ -20,7 +20,7 @@ import { VertexAIErrorCode, CustomErrorData } from './types'; import { VERTEX_TYPE } from './constants'; /** - * Error class for the Vertex AI for Firebase SDK. + * Error class for the Vertex AI in Firebase SDK. * * @public */ diff --git a/packages/vertexai/src/index.ts b/packages/vertexai/src/index.ts index b4c78b0731c..c8f798ff3c5 100644 --- a/packages/vertexai/src/index.ts +++ b/packages/vertexai/src/index.ts @@ -1,5 +1,5 @@ /** - * The Vertex AI For Firebase Web SDK. + * The Vertex AI in Firebase Web SDK. * * @packageDocumentation */ diff --git a/packages/vertexai/src/public-types.ts b/packages/vertexai/src/public-types.ts index 5577bc69c85..fbc5d51084d 100644 --- a/packages/vertexai/src/public-types.ts +++ b/packages/vertexai/src/public-types.ts @@ -20,7 +20,7 @@ import { FirebaseApp } from '@firebase/app'; export * from './types'; /** - * An instance of the Vertex AI for Firebase SDK. + * An instance of the Vertex AI in Firebase SDK. * @public */ export interface VertexAI { @@ -32,7 +32,7 @@ export interface VertexAI { } /** - * Options when initializing the Vertex AI for Firebase SDK. + * Options when initializing the Vertex AI in Firebase SDK. * @public */ export interface VertexAIOptions { From 4ff947408728ce4ae20229d7eb0cd71c3e65c885 Mon Sep 17 00:00:00 2001 From: Christina Holland Date: Fri, 23 Aug 2024 13:05:18 -0700 Subject: [PATCH 11/11] Fix AppCheck getToken docs text (#8454) --- docs-devsite/app-check.md | 4 ++-- packages/app-check/src/api.ts | 8 +++++--- 2 files changed, 7 insertions(+), 5 deletions(-) diff --git a/docs-devsite/app-check.md b/docs-devsite/app-check.md index 0673cf0373b..ea60678e688 100644 --- a/docs-devsite/app-check.md +++ b/docs-devsite/app-check.md @@ -22,7 +22,7 @@ Firebase App Check does not work in a Node.js environment using `ReCaptchaV3Prov | [initializeAppCheck(app, options)](./app-check.md#initializeappcheck_5548dfc) | Activate App Check for the given app. Can be called only once per app. | | function(appCheckInstance, ...) | | [getLimitedUseToken(appCheckInstance)](./app-check.md#getlimitedusetoken_53ef5e3) | Requests a Firebase App Check token. This method should be used only if you need to authorize requests to a non-Firebase backend.Returns limited-use tokens that are intended for use with your non-Firebase backend endpoints that are protected with Replay Protection. This method does not affect the token generation behavior of the \#getAppCheckToken() method. | -| [getToken(appCheckInstance, forceRefresh)](./app-check.md#gettoken_39fc1b3) | Get the current App Check token. Attaches to the most recent in-flight request if one is present. Returns null if no token is present and no token requests are in-flight. | +| [getToken(appCheckInstance, forceRefresh)](./app-check.md#gettoken_39fc1b3) | Get the current App Check token. If forceRefresh is false, this function first checks for a valid token in memory, then local persistence (IndexedDB). If not found, or if forceRefresh is true, it makes a request to the App Check endpoint for a fresh token. That request attaches to the most recent in-flight request if one is present. | | [onTokenChanged(appCheckInstance, observer)](./app-check.md#ontokenchanged_9761e16) | Registers a listener to changes in the token state. There can be more than one listener registered at the same time for one or more App Check instances. The listeners call back on the UI thread whenever the current token associated with this App Check instance changes. | | [onTokenChanged(appCheckInstance, onNext, onError, onCompletion)](./app-check.md#ontokenchanged_8ef80a7) | Registers a listener to changes in the token state. There can be more than one listener registered at the same time for one or more App Check instances. The listeners call back on the UI thread whenever the current token associated with this App Check instance changes. | | [setTokenAutoRefreshEnabled(appCheckInstance, isTokenAutoRefreshEnabled)](./app-check.md#settokenautorefreshenabled_057a76c) | Set whether App Check will automatically refresh tokens as needed. | @@ -102,7 +102,7 @@ The limited use token. ### getToken(appCheckInstance, forceRefresh) {:#gettoken_39fc1b3} -Get the current App Check token. Attaches to the most recent in-flight request if one is present. Returns null if no token is present and no token requests are in-flight. +Get the current App Check token. If `forceRefresh` is false, this function first checks for a valid token in memory, then local persistence (IndexedDB). If not found, or if `forceRefresh` is true, it makes a request to the App Check endpoint for a fresh token. That request attaches to the most recent in-flight request if one is present. Signature: diff --git a/packages/app-check/src/api.ts b/packages/app-check/src/api.ts index cd0c7de2d74..e6897320be1 100644 --- a/packages/app-check/src/api.ts +++ b/packages/app-check/src/api.ts @@ -187,9 +187,11 @@ export function setTokenAutoRefreshEnabled( state.isTokenAutoRefreshEnabled = isTokenAutoRefreshEnabled; } /** - * Get the current App Check token. Attaches to the most recent - * in-flight request if one is present. Returns null if no token - * is present and no token requests are in-flight. + * Get the current App Check token. If `forceRefresh` is false, this function first + * checks for a valid token in memory, then local persistence (IndexedDB). + * If not found, or if `forceRefresh` is true, it makes a request to the + * App Check endpoint for a fresh token. That request attaches + * to the most recent in-flight request if one is present. * * @param appCheckInstance - The App Check service instance. * @param forceRefresh - If true, will always try to fetch a fresh token.