influxdata / influxdata/influxdb-client-csharp

Breaking change in 4.12.0 due to RestSharp update to 109+

Open
#515 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

question
Dominant language
C#
Stars
377
Forks
93
Avg merge
9m
Merged PRs (30d)
2

Description

__Steps to reproduce:__

Use version 4.11.0 and set a `BaseUrl`:

`ApiClient.RestClient.BaseUrl = new Uri("http://some.url")`

Upgrade to 4.12.0.

The code no longer builds even though the version upgrade was minor.

__Expected behavior:__

Either hide your third-party implementation details behind an interface.
Or be aware of breaking changes in your own API via third-party library changes and increase your major version accordingly.

__Actual behavior:__

`RestSharp` made a breaking change to `RestClient` in [SHA1:507ed8](https://github.com/restsharp/RestSharp/commit/507ed87f8b517037bd1f923828c7af4c4998845e) and increased heir major version to 109 accordingly.
`RestSharp` as part of the influx client API was updated from 108.0.1 to 110.1.0 (i. e. >=109) between influx client 4.11.0 and 4.12.0.
Even though this is a breaking API change for influx client as well, there was no major version increase.

__Specifications:__
- Client Version: 4.12.0
- InfluxDB Version: irrelevant
- Platform: irrelevant

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by inspecting the public ApiClient.RestClient API and the dependency declaration that changed between client versions 4.11.0 and 4.12.0. Compare the RestSharp 108.0.1 and 110.1.0 APIs, then determine whether the public BaseUrl usage can remain compatible or whether the client versioning needs to reflect the breaking change.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp
Domain
api, backend-api-design
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.