-
Notifications
You must be signed in to change notification settings - Fork 898
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
[Vertex GA] Rewrite Schema #8479
Conversation
|
Size Report 1Affected Products
Test Logs |
Size Analysis Report 1Affected Products
Test Logs |
} | ||
|
||
/** Converts class to a plain JSON object (not a string). */ | ||
toJSON(): Record<string, unknown> { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why do we name this toJSON()
if it returns a plain JS object? Is this an API requirement?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not sure what the best name is - this is an intermediate object between the very abstract Schema, where all the children are Schemas, and a JSON string - it's a plain JS object or POJO, could call it toPOJO()
? I have this instead of going straight to the stringified JSON because it's easier to inspect and debug.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Oh, I was wrong, toJSON() actually should not return a JSON string, it should in fact return a JS symbol that is ready to pass to JSON.stringify(). Changing this back. https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify#tojson_behavior
@@ -34,15 +34,15 @@ export class VertexAIError extends FirebaseError { | |||
*/ | |||
constructor( | |||
readonly code: VertexAIErrorCode, | |||
readonly message: string, | |||
message: string, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sorry, I know I reviewed this already, but is there a reason that this isn't readonly anymore?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is a good question, I was going to mention it in the description. If it's readonly it can't be overwritten by super() which was causing some unexpected behavior. super() at the bottom of the constructor sets message
to fullMessage (adds the service name and code) but it simply won't do anything if it's readonly. The next question would be, what about code
- it's ok for code to not be overwritten with fullCode because adding the prefix just makes it harder to compare (e.g. error.code === VertexAIErrorCode.SOME_CODE
). The formatted fullCode
. only needs to go into the message.
* Add node engines fields specifying a minimum of 18 (#8457) * Make memory lru gc the default (#8110) * Make memory lru gc the default * undo yarn.lock * Make memory lru gc the default * Fix tests * V11 release removal of node-fetch and undici dependencies (#8492) Our v11 release will require node 18+. Since fetch has been introduced in these node versions, we can remove our dependency on third party fetch implementations. This change removes our usage of fetch variants undici and node-fetch for our node target builds and our CI tools. * V11 - Remove functions node bundle (#8507) With the removal of fetch we no long need to create a node bundle for functions. Instead the sourcebase may become isomorphic, so long as we remove the older node sources. And that's what the PR does! * Initial changes for Vertex GA packaging (#8498) * [Vertex GA] Rewrite Schema (#8479) * [Vertex GA] Add new endpoint and error message. (#8497) * [Vertex GA] Miscellaneous breaking changes for Vertex GA (#8514) * Remove ES5 Support (#8509) * Emit a module package file for functions ESM builds (#8517) * Update API_NOT_ENABLED error for Vertex (#8549) * Upgrade cjs bundles for storage and performance (#8557) These should have been part of the bigger PR, but I missed these. * Rollup JS files with rollup-typescript-plugin (#8503) The rollup-typescript-plugin does not transpile JS files using the TS compiler by default. This means that external dependencies that provide JS bundles will not be transpiled to the target ES version specified in the TypeScript config used by the plugin. This resulted in one of our dependencies (https://github.com/jakearchibald/idb) being included in the CDN bundles without being transpiled to ES5 (the target ES version). Since this dependencies bundle uses ES2018 syntax (object spread operator `{ ...x }`), this upgraded our CDN bundles' minimum ES version requirement to ES2018 which isn't compatible with older browser versions. To see the ES2018 syntax in one of the CDN bundles, see https://www.gstatic.com/firebasejs/10.13.1/firebase-app.js and search for `...oldTraps`. * Fix tsc errors in vertex tests (#8562) * Make SafetySettings.method optional (#8567) * Make SafetySettings.method optional * Update API reports --------- Co-authored-by: hsubox76 <[email protected]> * [Vertex GA] Regenerate docs after Vertex GA changes (#8505) * Close emulator file after download is complete (#8572) * close file * Add test:ci to end of test command in CI * revert workflow file changes * format * rename vertexai package reference in a changeset (#8573) * Missed one doc change from a PR (#8575) * Overwrite undefined candidate index (#8577) * Overwrite undefined candidate index * Fix index overwrite condition to only be true when index is not a property * Upgrade Vertex Mock Responses to V5 (#8579) * Upgrade to mock responses v4 * Upgrade from v4 to v5 mock responses --------- Co-authored-by: wu-hui <[email protected]> Co-authored-by: DellaBitta <[email protected]> Co-authored-by: Daniel La Rocque <[email protected]> Co-authored-by: hsubox76 <[email protected]>
See https://docs.google.com/document/d/1CXRbH7zmKqupD5LWUq8dh3spsGpozfRbOUa5MWi2tVY/edit?tab=t.wiordux8zots (internal)
Rewriting Schema as a class with static methods to enable easier building and some validation.
This is mostly backwards compatible - functionDeclaration.parameters takes an ObjectSchemaInterface which could be the ObjectSchema class or just a JS object that matches the interface. The only breaking change is the FunctionDeclarationSchemaType enum is now named SchemaType.
Keeping validation minimal as (1) TS should handle a lot of it and even if TS checking doesn't extend to JS-only developers, we don't really want to duplicate efforts with TS, (2) not a lot of rules have strong enough confirmation/guarantees from the backend for us to be sure enough to throw errors.