feat: FastAPI debugger

[Marcelo Trylesinski (Kludex)]

For #14247

Only tests are missing.

• Pull request represents a single change (i.e. not fixing disparate/unrelated things in a single PR).
• Title summarizes what is changing.
• Has a news entry file (remember to thank yourself!).
• Appropriate comments and documentation strings in the code.
• Has sufficient logging.
• Has telemetry for enhancements.
• Unit tests & system/integration tests are added/updated.
• Test plan is updated as appropriate.
• package-lock.json has been regenerated by running npm install (if dependencies have changed).
• The wiki is updated with any design decisions/details.

[Deleted user (ghost)]

All CLA requirements met.

[Codecov (codecov-io)]

Codecov Report

Merging #14606 into main will increase coverage by 0.21%.
The diff coverage is 80.48%.

@@ Coverage Diff @@## main #14606 +/- ##
==========================================
+ Coverage 64.89% 65.10% +0.21% 
==========================================
Files 541 542 +1 Lines 25156 25418 +262 Branches 3545 3593 +48 ==========================================
+ Hits 16324 16548 +224 - Misses 8170 8184 +14 - Partials 662 686 +24 

Impacted Files	Coverage Δ
...tension/configuration/debugConfigurationService.ts	78.94% <ø> (ø)
src/client/telemetry/index.ts	78.12% <ø> (ø)
...debugger/extension/configuration/resolvers/base.ts	90.00% <50.00%> (-1.03%)	⬇️
...extension/configuration/providers/fastapiLaunch.ts	76.66% <76.66%> (ø)
src/client/common/utils/localize.ts	91.15% <100.00%> (+0.15%)	⬆️
...tension/configuration/providers/providerFactory.ts	100.00% <100.00%> (ø)
...bugger/extension/configuration/resolvers/launch.ts	91.01% <100.00%> (+0.10%)	⬆️
src/client/debugger/extension/serviceRegistry.ts	100.00% <100.00%> (ø)
src/client/debugger/extension/types.ts	100.00% <100.00%> (ø)
...rc/client/pythonEnvironments/common/commonUtils.ts	85.93% <0.00%> (-14.07%)	⬇️
... and 10 more

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update f752706...8c094d6. Read the comment docs.

[Brett Cannon (brettcannon)]

Converted to a draft as this is not ready to be reviewed.

Marcelo Trylesinski (@Kludex) I will leave this here for a week, but if you are not able to get your tests ready by then I will close this PR as we try not to leave non-team member PRs as drafts since they tend to linger that way. And please sign the CLA.

[Marcelo Trylesinski (Kludex)]

Brett Cannon (@brettcannon) I've signed the CLA, I thought the WIP was enough, thank you for moving to draft.

I've added analogous tests to the ones in Flask, as the debugger is similar, but I'm not satisfied with my work. I've used replace to get the filename without extension (and probably there's a smart way to do it) and there are some tests lacking. If someone can give me some feedback, I'll appreciate.

The functionality per se is working, jfyk. But instead of having main.py as default on inputBox, maybe the current file would be a better option, but none of the other debuggers are doing it, so I was wondering if there's a reason...

Questions related to checkbox:

The wiki is updated with any design decisions/details.
Test plan is updated as appropriate.
Has telemetry for enhancements.

Do I need to do something on those?

[sonarqubecloud]

Kudos, SonarCloud Quality Gate passed!

0 Bugs
0 Vulnerabilities (and 0 Security Hotspots to review)
0 Code Smells

No Coverage information
0.6% Duplication

[Brett Cannon (brettcannon)]

Marcelo Trylesinski (@Kludex) no need to worry about those other checkmarks; that's mostly for the team.

As for the best default, whatever makes sense for FastAPI should be it; don't read too much into how the other configurations do things. 😄

[Marcelo Trylesinski (Kludex)]

I didn't have the time to add the remaining tests, is it possible to not close at least until the weekend? If a pre-review is possible I'll appreciate as well.

[Brett Cannon (brettcannon)]

Marcelo Trylesinski (@Kludex) yep, as long as you're still working on it we can leave it open her for now and make an exception for you. 😄

[Kim-Adeline Miguel (kimadeline)]

Hi Marcelo Trylesinski (@Kludex)! It's pretty straight-forward, looks good to me so far 🙂

We made some changes to our CI checks, if you could merge/rebase main in your branch that would be great!

instead of having main.py as default on inputBox, maybe the current file would be a better option, but none of the other debuggers are doing it, so I was wondering if there's a reason...

Not that I can remember.

[Marcelo Trylesinski (Kludex)]

Thank you for the review. I'm going to apply the necessary changes and rebase tomorrow. :)

[Marcelo Trylesinski (Kludex)]

Kim-Adeline Miguel (@kimadeline) I've rebased and applied the necessary changes. Is there anything else?

P.S.: I'm unable to see the coverage report... I'm waiting for it to be updated here.

[Marcelo Trylesinski (Kludex)]

When I open the debugger, I have the default being main.py (which is the default name for files that contains a FastAPI application). But maybe having the current open file path would be a better idea. What do you think?

How can I get the tests/test_union_inherited_body.py? (Check the image below)

[Pavel Minaev (int19h)]

Marcelo Trylesinski (@Kludex) Apologies for slow response times - many people are away on Thanksgiving week.

For the file name, since the configuration is going to persist once it's created, it's probably best to not pick up some transient state such as selected editor tab - if somebody is setting up FastAPI debugging for the first time, they're likely to just click through the wizard on the assumption that the defaults make sense; if it picks the default from tab selection, it's likely to be wrong more often than picking the standard entrypoint. OTOH users who know what they're doing will just enter the correct value there for their custom layout.

[Marcelo Trylesinski (Kludex)]

Pavel Minaev (@int19h) Got it! Thank you!

[Kim-Adeline Miguel (kimadeline)]

It would be great if you could address these minor housekeeping items, but other than that great work! Thank you for your contribution Marcelo Trylesinski (@Kludex) 🙂

[Brett Cannon (brettcannon)]

Marcelo Trylesinski (@Kludex) don't wait for code coverage; it seems to be broken at the moment.

[Marcelo Trylesinski (Kludex)]

Kim-Adeline Miguel (@kimadeline) Thank you for the review :) I've applied the necessary changes.

Marcelo Trylesinski (@Kludex) don't wait for code coverage; it seems to be broken at the moment.

Brett Cannon (@brettcannon) Ok, thank you. 👍

[Brett Cannon (brettcannon)]

Thanks for the hard work on this PR, Marcelo Trylesinski (@Kludex) !

[Marcelo Trylesinski (Kludex)]

Thank you for all the attention. You guys are great! :) Brett Cannon (@brettcannon)Pavel Minaev (@int19h)Kim-Adeline Miguel (@kimadeline)