feat: vertexAI package support (#8236)

* init

* update README

* .npmignore

* license

* initial port over of vertexAI from firebase-js-sdk

* react-native-builder-bob

* package.json updates

* fix: format & fix TS type warnings

* chore: format stream-reader file

* initial attempt at polyfilling stream

* fix: polyfill stream for react native

* chore: remove verbatimModuleSyntax

* chore: use module dist and update version for TS

* chore: check in version.ts

* get version from version.ts

* fix: RN specific stream

* feat: allow auth and app check to be passed in

* test: write first test file

* test: chat session

* initial count token

* test utils

* ignore vertex test data

* convert mocks

* test: grab vertex mock responses

* setup jest for vertex

* fix vertex script

* test: fix count token to use jest

* yarn.lock

* revert jest config

* test: port over generate content test

* test: fix generate content

* format mock response

* port over generative model test

* test: generative model

* port over request helpers tests

* test: request helpers using jest

* port over request tests

* test: request tests

* test: request tests

* port over response helpers

* test: response headers

* port over schema builder

* test: scheme builder

* test: stream reader

* port over api tests

* test: update chat session helper

* rm dead code

* test: api tests

* test: service test

* chore: move vertex mock script to scripts/

* chore: update license headers

* chore: make note on API versions

* fix: pin `web-streams-polyfill` dependency

* chore: remove version.ts from git

* fix: mock-response types

* chore: update genversion script

* chore: move logger to app

* fix: wire up `onLog()` & `setLogLevel()` for VertexAI

* chore: rm unneeded TS declaration

* chore: remove FirebaseService class

* chore: update yarn.lock

* test: make vertex response scripts only checkout repo if not existing

* chore: move script call into vertex prepare

* chore: move to start

* fix: Logger internals, make it private

* fix: try ignoring TS build issue

* test: remove e2e test for onLog and add unit test

* chore: remove onLog e2e test

* chore: eslint update

* chore: fix lint issues

* fix: fetch API issue with global polyfill. not needed

* fix: stream now global polyfill has been removed

* chore: update yarn.lock

* docs: vertexAI documentation

* docs: vertexAI improvement

* chore: format docs

* chore: update spellcheck

* chore: bump web-streams-polyfill version

* chore: update yarn.lock

* test: rm unused files

* chore: update types to use RNFB

* test: add vertexAI to test runner

* chore: vertexAI e2e emulator functions

* test: export vertex functions for testing

* test: e2e test fetch/stream responses

* test: reduce stream latency

* test: setup test environment

* test: add env var for test setup

* chore: update app check and auth types

* chore: update type comments

* docs(vertexai): getting ready for production

* chore: update script to rm dist/

* chore: make explicit that it is a type

* fix: TS build issue on CI

* test: fix jest tests

* test: use different tsconfig for jest. the use of RNFB app module caused issues for compile/jest

* docs: fix sidebar hyperlink

* test: fix android e2e, point to correct host

* chore: use correct types for auth and app check

* chore: update initialization of vertexai

* chore: updates stringToEnum object

* fix: do not ship unit tests with released package

* test: avoid typing error on stream types with temporary ignore

* test: avoid logging test console messages we expect

keeps the logs clean

* test: fixups to avoid deprecation warnings and handle type errors from same

* chore: update language tag

* chore: switch to using `globalThis`

* test(vertexai): alter test to expect new gl-rn header

* chore: update license headers in src/

* chore: update license headers in tests/

* chore: update yarn.lock

* chore: clean up code annotation and unused block of code

* fix: filter empty text parts when streaming

* chore: add missing enum types

* chore: update license header

* chore: update yarn.lock

---------

Co-authored-by: Mike Hardy <[email protected]>
Co-authored-by: Daniel La Rocque <[email protected]>
Co-authored-by: hsubox76 <[email protected]>
Co-authored-by: Tanzim Hossain <[email protected]>
Co-authored-by: Josh Soref <[email protected]>
Co-authored-by: DellaBitta <[email protected]>

Author: 7 people

.github/workflows/scripts/functions/src/index.ts

@@ -24,3 +24,5 @@ export { testFunctionDefaultRegionV2 } from './testFunctionDefaultRegion';
 export { testFunctionRemoteConfigUpdateV2 } from './testFunctionRemoteConfigUpdate';
 export { fetchAppCheckTokenV2 } from './fetchAppCheckToken';
 export { sendFCM } from './sendFCM';
+
+export { testFetchStream, testFetch } from './vertexaiFunctions';

.github/workflows/scripts/functions/src/vertexaiFunctions.ts

@@ -0,0 +1,62 @@
+import * as functions from 'firebase-functions/v2';
+
+const poem = [
+  'The wind whispers secrets through the trees,',
+  'Rustling leaves in a gentle breeze.',
+  'Sunlight dances on the grass,',
+  'A fleeting moment, sure to pass.',
+  'Birdsong fills the air so bright,',
+  'A symphony of pure delight.',
+  'Time stands still, a peaceful pause,',
+  "In nature's beauty, no flaws.",
+];
+
+const response = {
+  candidates: [
+    {
+      content: {
+        parts: [
+          {
+            text: 'Google\'s mission is to "organize the world\'s information and make it universally accessible and useful."',
+          },
+        ],
+        role: 'model',
+      },
+      finishReason: 'STOP',
+      index: 0,
+      safetyRatings: [
+        { category: 'HARM_CATEGORY_SEXUALLY_EXPLICIT', probability: 'NEGLIGIBLE' },
+        { category: 'HARM_CATEGORY_HATE_SPEECH', probability: 'NEGLIGIBLE' },
+        { category: 'HARM_CATEGORY_HARASSMENT', probability: 'NEGLIGIBLE' },
+        { category: 'HARM_CATEGORY_DANGEROUS_CONTENT', probability: 'NEGLIGIBLE' },
+      ],
+    },
+  ],
+  promptFeedback: {
+    safetyRatings: [
+      { category: 'HARM_CATEGORY_SEXUALLY_EXPLICIT', probability: 'NEGLIGIBLE' },
+      { category: 'HARM_CATEGORY_HATE_SPEECH', probability: 'NEGLIGIBLE' },
+      { category: 'HARM_CATEGORY_HARASSMENT', probability: 'NEGLIGIBLE' },
+      { category: 'HARM_CATEGORY_DANGEROUS_CONTENT', probability: 'NEGLIGIBLE' },
+    ],
+  },
+};
+
+export const testFetchStream = functions.https.onRequest(async (req, res) => {
+  res.setHeader('Content-Type', 'text/event-stream');
+  res.setHeader('Cache-Control', 'no-cache');
+  res.setHeader('Connection', 'keep-alive');
+
+  const updatedResponse = { ...response };
+
+  for (let i = 0; i < poem.length; i++) {
+    updatedResponse.candidates[0].content.parts[0].text = poem[i];
+    res.write(`data: ${JSON.stringify(updatedResponse)}\n\n`);
+    await new Promise(resolve => setTimeout(resolve, 100));
+  }
+  res.end();
+});
+
+export const testFetch = functions.https.onRequest(async (req, res) => {
+  res.json(response);
+});

.gitignore

@@ -536,6 +536,7 @@ Pods/*
 **/Pods/**
 **/dist/
 packages/**/version.js
+packages/**/version.ts
 typedoc.raw.json
 tests/ios/Firebase
 tests/ios/resetXcode.sh
@@ -580,3 +581,7 @@ website/public
 
 # Typescript items
 *.tsbuildinfo
+
+# vertexai test data
+vertexai-sdk-test-data
+mocks-lookup.ts

.spellcheck.dict.txt

@@ -77,6 +77,7 @@ FirebaseApp
 FirebaseCore
 firestore
 Firestore
+freeform
 GDPR
 GDPR-compliant
 getIdToken
@@ -187,6 +188,7 @@ signInTester
 Siri
 SMS
 SNS
+SPII
 src
 SSV
 stacktrace
@@ -219,6 +221,7 @@ v7
 v9
 v22
 Ventura
+VertexAI
 VPN
 VSCode
 Wix

docs/sidebar.yaml

@@ -129,6 +129,10 @@
     - - KY Integration
       - '/perf/ky-integration'
   - '//static.invertase.io/assets/firebase/performance-monitoring.svg'
+- - VertexAi
+  - - - Usage
+      - '/vertexai/usage'
+  - '//static.invertase.io/assets/social/firebase-logo.png'
 - - Legacy docs
   - - - Migrating to v6
       - '/migrating-to-v6'