Skip to content
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.

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

BREAKING CHANGE!(js): Rip out onFlow and firebaseAuth. Update all docs #1798

Merged
merged 9 commits into from
Feb 4, 2025

Conversation

inlined
Copy link
Member

@inlined inlined commented Feb 3, 2025

Docs now explain to use onCallGenkit and have appropriate authPolicy docs.
Also update docs now that flows don't have an authPolicy themselves.

We still need to update migrating-from-0.5.md which currently explains how
to update to 0.9 not 1.0

firebaseAuth (or should it be called firebaseContext? Will be added in the future
as a request middleware that can be used by express and next.js, but we will not
block 1.0 on their completion.

Checklist (if applicable):

@github-actions github-actions bot added docs Improvements or additions to documentation js config labels Feb 3, 2025
inlined and others added 2 commits February 3, 2025 11:27
Co-authored-by: Daniel Lee <taeold@gmail.com>
Co-authored-by: Michael Doyle <michaeldoyle@google.com>
@ssbushi ssbushi mentioned this pull request Feb 4, 2025
2 tasks
@inlined inlined merged commit 076a28a into main Feb 4, 2025
7 checks passed
@inlined inlined deleted the inlined.firebase-purge branch February 4, 2025 18:52
@@ -5,9 +5,13 @@ use https://github.com/firebase/firebase-tools/blob/master/templates/init/functi

The Firebase plugin provides integrations with Firebase services, allowing you to build intelligent and scalable AI applications. Key features include:

<<<<<<< HEAD
Copy link
Contributor

Choose a reason for hiding this comment

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

These merge-conflict markers shouldn't be here.

Is the net-net this?

  • Firestore Vector Store: Use Firestore for indexing and retrieval with vector embeddings.
  • Cloud Functions: Deploy flows as HTTPS-triggered functions.
  • Firebase Authentication: Implement authorization policies.

Irillit pushed a commit that referenced this pull request Feb 5, 2025
#1798)

onFlow is being removed in favor of onCallGenkit in firebase-functions/https. This allows users to use genkit consistently across all environments. Web frameworks (e.g. express, next, firebase-functions) use simple handler functions to use a flow that is defined abstract of the transport protocol.

firebaseAuth is being temporarily removed because it is tightly coupled with onFlow. It will be added in the future as generic middleware that can be used by @genkit-ai/express and @genkit-ai/next to both allow easy enforcement of auth/appCheck and to provide a contex to the flow that is consistent with the one provided by onCallGenkit.

Co-authored-by: Daniel Lee <taeold@gmail.com>
Co-authored-by: Michael Doyle <michaeldoyle@google.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
config docs Improvements or additions to documentation js
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

7 participants