Update Serving API - from backend PR #5314 - #316
Conversation
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary of Changes
Hello @clllaur, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
This pull request updates the TypeScript type definitions for the Serving API. These changes are a direct reflection of updates made in a corresponding backend pull request (#5314), ensuring that the frontend types remain synchronized with the latest API contract. The primary focus is on introducing new data structures for file handling and concurrency control, refining existing experience change models for serving purposes, and adjusting project configuration types.
Highlights
- API Type Additions: New types
UploadedFileDataandConcurrencyKeyhave been introduced.UploadedFileDatadescribes file objects withkey,name, andurlproperties, whileConcurrencyKeyis a server-generated hash for optimistic concurrency control. - Experience Change Type Refinement: A new union type
ExperienceChangeServinghas been added, consolidating various serving-specific experience change types. Correspondingly, thechangesproperty withinExperienceVariationConfignow explicitly usesArray<ExperienceChangeServing>. Additionally, an optionalconcurrency_keyfield has been added to severalExperienceChange*DataandExperienceChange*DataUpdatetypes to support optimistic concurrency. - Project Configuration Updates: The documentation for the
global_javascriptfield inConfigProjecthas been clarified regarding its behavior with environment-specific code. Theenvironmentsproperty has also been removed from theConfigProjecttype.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
|
There was a problem hiding this comment.
Code Review
This pull request updates the TypeScript Serving API types to align with recent backend changes. The main changes include:
- Adding
UploadedFileDataandConcurrencyKeytypes. - Introducing
...Servingvariants forExperienceChange...types, which are used in theExperienceVariationConfig. - Adding an optional
concurrency_keyto variousExperienceChange...data and update types for optimistic concurrency control. - Removing the
environmentsproperty fromConfigProject. - Updating the documentation for
global_javascript.
The changes are generally consistent and reflect the intended API update. I've pointed out a few documentation issues, including some copy-paste errors in JSDoc comments and opportunities to improve clarity on new types. Addressing these will improve the maintainability and correctness of the type definitions.
| /** | ||
| * Object that represents one change done inside an experience | ||
| */ |
There was a problem hiding this comment.
The JSDoc for ExperienceChangeServing is identical to the one for ExperienceChange. To improve clarity and maintainability, consider making the comment more specific to its purpose. This will help developers understand why there are two similar types.
| /** | |
| * Object that represents one change done inside an experience | |
| */ | |
| /** | |
| * Object that represents one change done inside an experience for serving purposes | |
| */ |
| /** | ||
| * Describes structure for "defaultCode" type of experience change | ||
| */ |
There was a problem hiding this comment.
The JSDoc for ExperienceChangeDefaultCodeDataServing is identical to the one for ExperienceChangeDefaultCodeData. To improve clarity, consider making the comment more specific to its purpose. This pattern of duplicated documentation for new ...Serving types appears in other places in this file; please consider applying a similar fix there as well.
| /** | |
| * Describes structure for "defaultCode" type of experience change | |
| */ | |
| /** | |
| * Describes structure for "defaultCode" type of experience change for serving | |
| */ |
| /** | ||
| * Describes structure for "defaultCode" type of experience change | ||
| */ |
There was a problem hiding this comment.
There appears to be a copy-paste error in this JSDoc. The comment describes a "defaultCode" type of change, but it's for ExperienceChangeRichStructureDataServing, which should be for a "richStructure" type.
| /** | |
| * Describes structure for "defaultCode" type of experience change | |
| */ | |
| /** | |
| * Describes structure for "richStructure" type of experience change | |
| */ |
| /** | ||
| * Describes structure for "defaultCode" type of experience change | ||
| */ |
There was a problem hiding this comment.
There appears to be a copy-paste error in this JSDoc. The comment describes a "defaultCode" type of change, but it's for ExperienceChangeCustomCodeDataServing, which should be for a "customCode" type.
| /** | |
| * Describes structure for "defaultCode" type of experience change | |
| */ | |
| /** | |
| * Describes structure for "customCode" type of experience change | |
| */ |
3 participants
Updating TS Serving API after the latest changes from backend repo,
PR #5314