feat(graphql): add async client

[nejch]

Users have been asking for years for some kind of async support. This is pretty easy to do with the GraphQL client as we're only talking to a single endpoint so it's a good start.

Changes

Adds AsyncGraphQL and a private base client for common graphql logic.

Related to #1357
Related to #1025

Documentation and testing

Please consider whether this PR needs documentation and tests. This is not required, but highly appreciated:

• Documentation in the matching docs section
• Unit tests and/or functional tests

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 96.64%. Comparing base (8046387) to head (ad75cab).
Report is 1 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #3045      +/-   ##
==========================================
+ Coverage   96.62%   96.64%   +0.01%     
==========================================
  Files          95       95              
  Lines        6106     6142      +36     
==========================================
+ Hits         5900     5936      +36     
  Misses        206      206              

Flag	Coverage Δ
api_func_v4	82.46% <83.67%> (-0.03%)	⬇️
cli_func_v4	82.59% <34.69%> (-0.31%)	⬇️
unit	88.83% <97.95%> (+0.06%)	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing lines	Coverage Δ
gitlab/__init__.py	100.00% <100.00%> (ø)
gitlab/_backends/graphql.py	100.00% <100.00%> (ø)
gitlab/client.py	98.72% <100.00%> (+0.06%)	⬆️

[nejch]

@JohnVillalovos @max-wittig this should be ready now. I opted for two separate clients rather than a async=True flag as it seemed a bit more explicit with typing and less of a pain. Otherwise, seems like a quick win as we can reuse gql + httpx quite a bit.

The diffs are super weird on GitHub, might be easier to check locally.

[max-wittig]

Suggested change

	class _BaseGrapQL:
	class _BaseGraphQL:

[max-wittig]

Suggested change

	class GraphQL(_BaseGrapQL):
	class GraphQL(_BaseGraphQL):

[max-wittig]

Suggested change

	class AsyncGraphQL(_BaseGrapQL):
	class AsyncGraphQL(_BaseGraphQL):

[max-wittig]

Suggested change

	def api_url():
	def api_url() -> str:

[max-wittig]

Let's fix some typos

[nejch]

Thanks @max-wittig should be ready now 🙇

[roma-glushko]

Hey folks, I have installed v5.1.0 and could not find the async client, so it must be not released yet.
When you do plan to include it in the next version of the client?

[nejch]

Hi @roma-glushko the next release is auto-scheduled for the 28th. If there's demand though we can trigger it before.

[roma-glushko]

@nejch I would love to give it a try, so if it's not too much trouble to release sooner I would really appreciate that (at least a prerelease version if the pipeline you have supports that).

Otherwise, I can try to temporary pull it from the main branch.

[nejch]

This is now released. There's a bit of blocking code in there for the retry logic AFAIK, so let us know if it doesn't work as expected.

[roma-glushko]

@nejch Hey Nejc, this is awesome! Thank you for releasing it soo fast (it's version 5.2.0 in case anyone else is curious).
Gonna give it a try and let you know if there is anything.

There's a bit of blocking code in there for the retry logic AFAIK, so let us know if it doesn't work as expected.

Okay, that's good to know 👁️ I think this is fine for now. Do you guys have any plans to address that part?

[nejch]

@roma-glushko for sure if we get any feedback from users as you most likely have more uses for this than ourselves at the moment :) It was mostly so we could reuse some sync/async client code.