Update user agent for NetworkClient()

[mhasbini]

Summary

Update user agent for NetworkClient() to include the project name with its current version.

I need guidance in deciding how to implement this change for files that includes requests directly. I have two approaches:

• Refactor these imports to use NetworkClient()
• If the above is not recommended for certain reasons then create a new factory for requests that have this custom user agent.

lmk what's the recommended approach.

References

Fixes #10995

Reviewer guidance

• should be handled by the automated test

---

Testing checklist

• Contributor has fully tested the PR manually
• If there are any front-end changes, before/after screenshots are included
• Critical user journeys are covered by Gherkin stories
• Critical and brittle code paths are covered by unit tests

PR process

• PR has the correct target branch and milestone
• PR has 'needs review' or 'work-in-progress' label
• If PR is ready for review, a reviewer has been added. (Don't use 'Assignees')
• If this is an important user-facing change, PR or related issue has a 'changelog' label
• If this includes an internal dependency change, a link to the diff is provided

Reviewer checklist

• Automated test coverage is satisfactory
• PR is fully functional
• PR has been tested for accessibility regressions
• External dependency files were updated if necessary (yarn and pip)
• Documentation is updated
• Contributor is in AUTHORS.md

[bjester]

Thanks for tackling this! Could you make one small change, for simplicity?

[github-actions]

Build Artifacts

Asset type	Download link
PEX file	kolibri-0.16.0a21.dev0_git.41.g08baca45.pex
Windows Installer (EXE)	kolibri-0.16.0a21.dev0+git.41.g08baca45-unsigned.exe
Debian Package	kolibri_0.16.0a21.dev0+git.41.g08baca45-0ubuntu1_all.deb
Mac Installer (DMG)	kolibri-0.16.0a21.dev0+git.41.g08baca45-0.3.0.dmg
TAR file	kolibri-0.16.0a21.dev0+git.41.g08baca45.tar.gz
WHL file	kolibri-0.16.0a21.dev0+git.41.g08baca45-py2.py3-none-any.whl

[bjester]

Thanks for resolving my last feedback. It looks good.

Now I see the test is failing, so just a couple fixes for the test to pass and this to be merged

[mhasbini]

@bjester Thanks again for checking. I addressed the test & lint issues.

btw NetworkClient() is one part of this change, there are a couple of other places that uses requests directly and they won't have the update UA.

I was thinking I could either:

• Refactor these imports to use NetworkClient().
• If the above is not recommended for certain reasons then create a new factory for requests that have this custom user agent and NetworkClient can then extends it.

lmk what's the recommended approach.

[bjester]

@mhasbini There are still some linting failures that I can see. If you install pre-commit (instructions), it will fix those during commit. Or you can do so manually by looking at the failure in the PR check.

Could you please comment on this issue so I can make you the assignee?

Yes you're right, there are several usages of requests that bypass the NetworkClient. We do want to refactor those to use it but that's definitely out of scope of this issue. I think what you've done here is sufficient for the assigned issue.

Refactoring existing usage of requests was tracked as a task within this issue. I created a new and separate issue from it which we can assign you if you're interested in continuing with that. It'll be a heavy refactor in some places, but it's worthwhile and you can take your time with it. If you'd like to work on it, please comment on the issue.

[mhasbini]

@bjester Thanks for the clarification!
Unfortunately my local env is a mess rn and I couldn't setup pre-commit hook. I tried to fix the issues by manually doing the changes from the lint output in the CI.

[bjester]

Thank you @mhasbini!