Skip to content

refactor: define a helper function to customize ClientFactoryOptions#240

Merged
ishymko merged 4 commits intomainfrom
ishymko/options-create-from
Dec 9, 2025
Merged

refactor: define a helper function to customize ClientFactoryOptions#240
ishymko merged 4 commits intomainfrom
ishymko/options-create-from

Conversation

@ishymko
Copy link
Member

@ishymko ishymko commented Dec 9, 2025

Description

Deep cloning each object and array for adding an interceptor into default client config (for example) is quite involved, define a helper function so that it can be done as follows:

const options = ClientFactoryOptions.createFrom(ClientFactoryOptions.default, {
  clientConfig: { interceptors: [new MyInterceptor()] },
});

@ishymko ishymko requested a review from guglielmo-san December 9, 2025 10:36
@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello @ishymko, 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 refactors the ClientFactoryOptions by introducing a new static helper function, createFrom, which streamlines the customization of client configuration. Previously, deep cloning and merging complex option objects was cumbersome. The new function provides a clean, declarative way to combine base options with specific overrides, intelligently handling array concatenation for transport configurations and object merging for client-specific settings, thereby simplifying option management and enhancing developer experience.

Highlights

  • New Helper Function for ClientFactoryOptions: Introduced ClientFactoryOptions.createFrom to simplify the process of customizing client factory options by providing a structured way to merge an original set of options with overrides.
  • Deep Merging Logic: The new createFrom function performs a deep merge, specifically concatenating arrays for transports and preferredTransports, and merging objects for clientConfig, ensuring that default options can be extended easily without manual deep cloning.
  • Enhanced Readability and Maintainability: This refactoring aims to improve code readability and reduce boilerplate when configuring ClientFactoryOptions, as demonstrated by the provided example in the PR description.
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 by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

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 pull request 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 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. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

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

  1. 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.

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request introduces a createFrom helper function to simplify the creation of custom ClientFactoryOptions, which is a great addition for usability. My review focuses on an inconsistency in the merging logic. While top-level arrays like transports are concatenated, nested arrays within clientConfig are replaced, which can be unintuitive and lead to data loss. I've suggested a change to make this behavior consistent. Additionally, I've pointed out that some of the new tests could be more robust. Overall, a good refactoring that will be even better with these adjustments.

@ishymko ishymko enabled auto-merge (squash) December 9, 2025 11:12
@ishymko ishymko merged commit 1ca8c8b into main Dec 9, 2025
6 checks passed
@ishymko ishymko deleted the ishymko/options-create-from branch December 9, 2025 11:27
ishymko added a commit that referenced this pull request Dec 10, 2025
# Description

Update `ClientFactory.createFrom` merging logic to work better with
common use-cases:

1. Merge transports by `TransportFactory.protocolName` to allow the
following:
```ts
const factory = new ClientFactory(ClientFactoryOptions.createFrom(ClientFactoryOptions.default, {
  transports: [
    new JsonRpcTransportFactory({ fetchImpl: myCustomFetch })
  ]
}))
```
2. Concatenate interceptors to allow providing SDK default interceptors.
3. Other config-like arrays (`preferredTransports`,
`clientConfig.acceptedOutputModes`) are replaced.

Re: follow-up for unreleased #240
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants