feat: refactor timeout #622

NguyenHoangSon96 · 2025-09-19T16:13:59Z

Closes #

Proposed Changes

Query and write timeout will not be passed directly to the transport. It will be passed to the query or write functions.
Users can pass a timeout directly to the query and write APIs now, and they will have the highest priority.

Checklist

karel-rehor

This looks good for passing timeout arguments to underlying APIs. Maybe I've missed something, but I don't see client properties like writeTimeout and queryTimeout

To synchronize changes with other libraries, in addition to sending a timeout value as a function argument, we also need to set a default writeTimeout and queryTimeout value when instantiating the client or its configuration. This especially needs to be used on the query side (https://grpc.io/docs/guides/deadlines/#deadlines-on-the-client and https://grpc.io/blog/deadlines/).

Having a client property that gets reused with every call will be much more convenient for users, than having to set the timeout with every call.

CHANGELOG.md

vlastahajek

Why flood the write and query API with the timeout parameter?
Is it really necessary to change the timeout for each call?

queryTimeout is already part of the options and is used correctly.
We could add just writeTimeout to properly differentiate values.

NguyenHoangSon96 · 2025-09-30T12:22:12Z

Why flood the write and query API with the timeout parameter? Is it really necessary to change the timeout for each call?

queryTimeout is already part of the options and is used correctly. We could add just writeTimeout to properly differentiate values.

The queryTimeout and writeTimeout were "flushed" for each call because maybe there are some cases where users want to override the timeout for only a specific query; It also makes the APIs consistent with other libraries. Now users can set a one-time timeout.

vlastahajek · 2025-10-01T08:04:25Z

The queryTimeout and writeTimeout were "flushed" for each call because maybe there are some cases where users want to override the timeout for only a specific query;

Maybe? We should be pretty sure about use-cases before changing API.

It also makes the APIs consistent with other libraries. Now users can set a one-time timeout.

What other libraries have the timeout parameter in the insert and query-like functions? I've checked Mongo and Postgresql and haven't found that.
Of course, there are already WriteOptions and QueryOptions parts for write and query functions.
If needed, the timeout parameter should be part of those, instead of adding a new parameter.

NguyenHoangSon96 · 2025-10-01T09:02:21Z

The queryTimeout and writeTimeout were "flushed" for each call because maybe there are some cases where users want to override the timeout for only a specific query;

Maybe? We should be pretty sure about use-cases before changing API.

It also makes the APIs consistent with other libraries. Now users can set a one-time timeout.

What other libraries have the timeout parameter in the insert and query-like functions? I've checked Mongo and Postgresql and haven't found that. Of course, there are already WriteOptions and QueryOptions parts for write and query functions. If needed, the timeout parameter should be part of those, instead of adding a new parameter.

I'm not talking about other libraries like Mongo or Posgrest, but our client libs like influxdb3-java, influxdb3-python, influxdb3-go,....

vlastahajek · 2025-10-01T09:52:01Z

Neither of the other InfuxDB 3 client libraries has a timeout as a parameter of the write or query function.

NguyenHoangSon96 · 2025-10-03T07:22:22Z

Neither of the other InfuxDB 3 client libraries has a timeout as a parameter of the write or query function.

Hi @vlastahajek
Ok, so there are some misunderstandings between me and Karel regarding how we should pass the timeout to functions.
I have changed the code to use QueryOptions and WriteOptions.
Please check again.

karel-rehor · 2025-10-06T08:43:35Z

@NguyenHoangSon96, @vlastahajek
The main point that arose from working on the Tarana EAR was that on the query side the gRPC error DeadlineExceeded should be triggered and captured, when the user defines a timeout directly or as a gRPC deadline option. So timeout should be an optional argument in a method call or an optional parameter in the configuration. Additionally the GRPC developers recommend setting deadlines (i.e. timeouts):

By default, gRPC does not set a deadline which means it is possible for a client to end up waiting for a response effectively forever. To avoid this you should always explicitly set a realistic deadline in your clients.

When working on the python client I added timeout as a handled known kwarg on query methods. The argument _request_timeout was already being used for write methods. I considered it a potentially useful feature to be able to override the timeout set in the client configuration with an optional argument in the call method. Note that in other clients, like the Java client, the deadline can be set as part of the gRPC options call argument. But this is a bit hidden for some users.

karel-rehor

I have some problems with some of the deprecated fields. queryTimeout is already an important value passed to the GrpcTransport, and likely should not be removed. It is also self descriptive. The option timeout can also simply be made more specific by creating a writeTimeout field which fulfills the same function.

packages/client/src/impl/QueryApiImpl.ts

packages/client/src/options.ts

packages/client/src/impl/QueryApiImpl.ts

packages/client/src/impl/node/NodeHttpTransport.ts

packages/client/src/options.ts

packages/client/src/impl/WriteApiImpl.ts

packages/client/src/transport.ts

packages/client/src/WriteApi.ts

vlastahajek · 2025-10-15T14:27:31Z

packages/client/src/impl/WriteApiImpl.ts

        ...writeOptions?.headers,
      },
      gzipThreshold: writeOptionsOrDefault.gzipThreshold,
+      timeout: writeOptions?.timeout ?? this._options.timeout,


Suggested change

timeout: writeOptions?.timeout ?? this._options.timeout,

timeout: writeOptions?.timeout ?? this._options.writeTimeout,

I don't see the new writeTimeout option anywhere used

It's already set in file InfluxDBClient line 133.

The line you mentioned in the InfluxDBClient doesn't use writeTimeout.

In fact, the line 145 here should be only:

timeout: writeOptions?.timeout

because sendOptions are optional.

I mean, line 133 in the file "InfluxDBClient" already sets the timeout inside the options object
timeout: this._options.writeOptions?.timeout ?? this._options.timeout,

, so in the file "WriteApiImpl", line 145, I just need to check between timeout in the options object with the timeout passed directly to the doWrite function through the writeOptions object.
timeout: writeOptions?.timeout ?? this._options.timeout,

Explained here

vlastahajek · 2025-10-17T05:51:18Z

packages/client/src/InfluxDBClient.ts

    this._transport = impl.writeTransport(this._options)
    this._writeApi = new WriteApiImpl({
      transport: this._transport,
      ...this._options,
+      timeout: this._options.writeOptions?.timeout ?? this._options.timeout,
    })


Suggested change

this._transport = impl.writeTransport(this._options)

this._writeApi = new WriteApiImpl({

transport: this._transport,

...this._options,

timeout: this._options.writeOptions?.timeout ?? this._options.timeout,

})

this._transport = impl.writeTransport({

...this._options,

writeTimeout: this._options.writeOptions?.timeout ?? this._options.writeTimeout

})

this._writeApi = new WriteApiImpl({

transport: this._transport,

...this._options,

})

passing an explicit timeout doesn't have an effect, because transport is pre-created and passed. Still, you used the deprecated timeout instead of writeTimeout

vlastahajek · 2025-10-17T06:00:44Z

packages/client/src/impl/node/NodeHttpTransport.ts

        ...headers,
        ...sendOptions.headers,
      },
+      timeout: sendOptions.timeout ?? this._defaultOptions.timeout,


Suggested change

timeout: sendOptions.timeout ?? this._defaultOptions.timeout,

timeout: sendOptions.timeout ?? this._defaultOptions.writeTimeout,

Utilize writeTimeout passed via WriteApi from InfluxDBClient

I just thought that NodeHttpTransport should stay away from our "write" logic timeout, so it should only care about the 'timeout" but shouldn't care if it is "writeTimeout" or whatever "....Timeout".

And in the file "InfluxDBClient" line 133, when initializing the NodeHttpTransport, I set the "timeout"
timeout: this._options.writeOptions?.timeout ?? this._options.timeout,

I just thought that NodeHttpTransport should stay away from our "write" logic timeout, so it should only care about the timeout but shouldn't care if it is "writeTimeout" or whatever "....Timeout".

NodeHttpTransport has ConnectionOptions as a constructor parameter, so it cannot ignore the deprecation of the timeout option and add a new writeTimeout option.

And in the file "InfluxDBClient" line 133, when initializing the NodeHttpTransport, I set the "timeout": this._options.writeOptions?.timeout ?? this._options.timeout,`

The timeout option is deprecated. We should not use our own deprecated parts, but use the new ones.

vlastahajek · 2025-10-17T06:07:27Z

packages/client/src/impl/WriteApiImpl.ts

        ...writeOptions?.headers,
      },
      gzipThreshold: writeOptionsOrDefault.gzipThreshold,
+      timeout: writeOptions?.timeout ?? this._options.timeout,


The line you mentioned in the InfluxDBClient doesn't use writeTimeout.

In fact, the line 145 here should be only:

timeout: writeOptions?.timeout

because sendOptions are optional.

vlastahajek · 2025-10-17T06:16:36Z

Also, current tests don't validate correct timeout propagation

…property

packages/client/src/InfluxDBClient.ts

NguyenHoangSon96 added this to the 1.5.0 milestone Sep 19, 2025

NguyenHoangSon96 self-assigned this Sep 19, 2025

NguyenHoangSon96 requested review from jansimonb and karel-rehor September 19, 2025 16:39

karel-rehor requested changes Sep 22, 2025

View reviewed changes

CHANGELOG.md Outdated Show resolved Hide resolved

NguyenHoangSon96 added 8 commits September 25, 2025 11:45

feat: passing timeout directly

84f3dd3

feat: passing timeout directly query function

7830664

chore: linter

becc93d

chore: linter

f997af4

chore: CHANGELOG.md

534557b

refactor: query and write timeout

21c0010

lint: fix linter

2fd2ac6

lint: fix linter

42575c1

NguyenHoangSon96 force-pushed the feat/refactor-timeout branch from 9fc395e to 42575c1 Compare September 25, 2025 04:46

NguyenHoangSon96 added 3 commits September 25, 2025 11:48

chore: CHANGELOG.md

2c3b49c

chore: CHANGELOG.md

69a09cf

lint: fix linter

09c19cd

NguyenHoangSon96 requested a review from karel-rehor September 25, 2025 05:00

vlastahajek reviewed Sep 29, 2025

View reviewed changes

NguyenHoangSon96 requested a review from vlastahajek September 30, 2025 12:22

NguyenHoangSon96 added 6 commits October 3, 2025 09:43

fix: refactor timeout

2f56fba

lint: fix linter

878f274

lint: fix linter

d146b01

lint: fix linter

aa6bef6

lint: fix linter

da14aac

fix: refactor timeout

9c49d0b

NguyenHoangSon96 added 3 commits October 3, 2025 14:06

fix: refactor timeout

847c248

fix: refactor timeout

17a5094

chore: CHANGELOG.md

d5fcaff

karel-rehor requested changes Oct 8, 2025

View reviewed changes

packages/client/src/impl/QueryApiImpl.ts Show resolved Hide resolved

packages/client/src/options.ts Show resolved Hide resolved

packages/client/src/options.ts Show resolved Hide resolved

packages/client/src/impl/QueryApiImpl.ts Show resolved Hide resolved

NguyenHoangSon96 added 3 commits October 10, 2025 10:03

refactor: queryTimeout and writeTimeout

5e6a16d

chore: update CHANGELOG for timeout refactor

047ea62

refactor: add writeTimeout to connection options and update comments

6bdf871

NguyenHoangSon96 requested a review from karel-rehor October 10, 2025 03:25

vlastahajek requested changes Oct 10, 2025

View reviewed changes

refactor: simplify transport initialization and improve documentation

4afbb46

NguyenHoangSon96 requested a review from vlastahajek October 14, 2025 03:38

vlastahajek requested changes Oct 15, 2025

View reviewed changes

NguyenHoangSon96 requested a review from vlastahajek October 16, 2025 08:36

vlastahajek requested changes Oct 17, 2025

View reviewed changes

NguyenHoangSon96 added 2 commits October 20, 2025 16:22

refactor: improve timeout handling and deprecate ambiguous timeout …

0a6283f

…property

lint: fix linter

3a6e74d

vlastahajek reviewed Oct 21, 2025

View reviewed changes

packages/client/src/InfluxDBClient.ts Outdated Show resolved Hide resolved

NguyenHoangSon96 added 2 commits October 22, 2025 10:37

refactor: simplify writeTimeout logic in InfluxDBClient

93374d1

lint: fix linter

481d27f

NguyenHoangSon96 requested a review from vlastahajek October 22, 2025 03:48

	timeout: writeOptions?.timeout ?? this._options.timeout,
	timeout: writeOptions?.timeout ?? this._options.writeTimeout,

	timeout: sendOptions.timeout ?? this._defaultOptions.timeout,
	timeout: sendOptions.timeout ?? this._defaultOptions.writeTimeout,

feat: refactor timeout #622

Are you sure you want to change the base?

feat: refactor timeout #622

Uh oh!

Conversation

NguyenHoangSon96 commented Sep 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Proposed Changes

Checklist

Uh oh!

karel-rehor left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

vlastahajek left a comment

Choose a reason for hiding this comment

Uh oh!

NguyenHoangSon96 commented Sep 30, 2025

Uh oh!

vlastahajek commented Oct 1, 2025

Uh oh!

NguyenHoangSon96 commented Oct 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

vlastahajek commented Oct 1, 2025

Uh oh!

NguyenHoangSon96 commented Oct 3, 2025

Uh oh!

karel-rehor commented Oct 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

karel-rehor left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

NguyenHoangSon96 Oct 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

vlastahajek commented Oct 17, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

NguyenHoangSon96 commented Sep 19, 2025 •

edited

Loading

NguyenHoangSon96 commented Oct 1, 2025 •

edited

Loading

karel-rehor commented Oct 6, 2025 •

edited

Loading

NguyenHoangSon96 Oct 17, 2025 •

edited

Loading