Add wait_until_completion to InfrahubBranchManager.create

[LucasG0]

Related PR: opsmill/infrahub#4917

[LucasG0]

• We cannot return branch object as it has not be created yet, does returning task_id make sense? Downside is that create return signature becomes BranchData | str
• Currently, background_execution has no effect but is available sdk side, so this is somehow a small breaking change even though I do not expect of this parameter to be used

[ogenstad]

• We cannot return branch object as it has not be created yet, does returning task_id make sense? Downside is that create return signature becomes BranchData | str

That's unfortunate. But for now I think we should go with BranchData | str I don't remember if that works on Python 3.9 or if we have to do a Union[BranchData, str]. What we can do is to use an @overload decorator which we use in a few other places. We can use that to indicate the returned data type depending on the input params used.

[LucasG0]

Should we add this parameter for other branch methods (merge, ...)?

[dgarros]

not sure if this is so useful because if the server doesn't support wait_until_completion it will blow up when you execute the query 2 lines up

[LucasG0]

As discussed, let's use deprecated background_execution as query input field so query does not break, and we will switch to wait_until_completion the day background_execution is completely removed from the graphql query.

[codecov]

Codecov Report

Attention: Patch coverage is 45.00000% with 11 lines in your changes missing coverage. Please review.

Files with missing lines	Patch %	Lines
infrahub_sdk/branch.py	45.00%	7 Missing and 4 partials ⚠️

@@             Coverage Diff             @@
##           develop     #142      +/-   ##
===========================================
- Coverage    65.40%   65.32%   -0.08%     
===========================================
  Files           76       76              
  Lines         6923     6942      +19     
  Branches      1367     1375       +8     
===========================================
+ Hits          4528     4535       +7     
- Misses        2026     2037      +11     
- Partials       369      370       +1     

Flag	Coverage Δ
python-3.10	44.31% <10.00%> (-0.10%)	⬇️
python-3.11	?
python-3.12	?
python-3.9	?
python-filler-3.12	23.85% <35.00%> (+<0.01%)	⬆️

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

Files with missing lines	Coverage Δ
infrahub_sdk/branch.py	45.71% <45.00%> (-1.40%)	⬇️

... and 3 files with indirect coverage changes