Set a global requester for the Hubcast application (llnl#239)

* remove configurability of "requesters"

we currently allow users to set "requester" strings for calls to GitHub
and GitLab. They don't seem to get used anywhere in the authentication
process for either site, other than getting used as the user-string for
each request.

Rather than having to explain this nuance to the user, I propose we use
`hubcast` as our user agent and simplify our configuration. The wording
is confusing and heavily implies that it is of functional importance.

If someone needs to figure out where a request is coming from, I think
"hubcast" as the user agent, combined with signals like the github app
id or github token id, is more than enough for any diagnosis.

* Set REQUESTER global in Hubcast __main__

Signed-off-by: Alec Scott <alec@llnl.gov>

* Swap from self.user -> self.requester for the client user-agent

Signed-off-by: Alec Scott <alec@llnl.gov>
Co-authored-by: Caetano Melone <cmelone@llnl.gov>

---------

Signed-off-by: Alec Scott <alec@llnl.gov>
Co-authored-by: Caetano Melone <melone1@llnl.gov>
Co-authored-by: Caetano Melone <cmelone@llnl.gov>

Author: alecbcs

src/hubcast/__main__.py

@@ -17,6 +17,10 @@
 
 log = logging.getLogger(__name__)
 
+# Set requester for both GitHub and GitLab clients to
+# identify Hubcast via the user-agent header
+REQUESTER = "hubcast"
+
 
 def main():
     app = web.Application()
@@ -70,11 +74,11 @@ def main():
         sys.exit(1)
 
     gh_client_factory = GitHubClientFactory(
-        conf.gh.app_id, conf.gh.privkey, conf.gh.requester, conf.gh.bot_user
+        conf.gh.app_id, conf.gh.privkey, REQUESTER, conf.gh.bot_user
     )
     gl_client_factory = GitLabClientFactory(
         conf.gl.instance_url,
-        conf.gl.requester,
+        REQUESTER,
         conf.gl.token,
         conf.gl.callback_url,
         conf.gl.webhook_secret,

src/hubcast/clients/gitlab/client.py

@@ -34,6 +34,7 @@ def create_client(self, user: str):
         """creates a GitLabClient for a specific user"""
         return GitLabClient(
             self.auth,
+            self.requester,
             self.instance_url,
             self.callback_url,
             self.webhook_secret,
@@ -45,12 +46,14 @@ class GitLabClient:
     def __init__(
         self,
         auth: GitLabAuthenticator,
+        requester: str,
         instance_url: str,
         callback_url: str,
         webhook_secret: str,
         user: str,
     ):
         self.auth = auth
+        self.requester = requester
         self.instance_url = instance_url
         self.callback_url = callback_url
         self.webhook_secret = webhook_secret
@@ -72,7 +75,7 @@ async def set_webhook(self, gl_fullname: str, data: Dict):
         async with aiohttp.ClientSession() as session:
             gl = gidgetlab.aiohttp.GitLabAPI(
                 session,
-                requester=self.user,
+                requester=self.requester,
                 access_token=gl_token,
                 url=self.instance_url,
             )
@@ -117,7 +120,7 @@ async def get_latest_pipeline(self, gl_fullname: str, ref: str) -> int:
         async with aiohttp.ClientSession() as session:
             gl = gidgetlab.aiohttp.GitLabAPI(
                 session,
-                requester=self.user,
+                requester=self.requester,
                 access_token=gl_token,
                 url=self.instance_url,
             )
@@ -141,7 +144,7 @@ async def run_pipeline(self, gl_fullname: str, ref: str) -> str:
         async with aiohttp.ClientSession() as session:
             gl = gidgetlab.aiohttp.GitLabAPI(
                 session,
-                requester=self.user,
+                requester=self.requester,
                 access_token=gl_token,
                 url=self.instance_url,
             )
@@ -164,7 +167,7 @@ async def retry_pipeline_jobs(self, gl_fullname: str, pipeline_id: int) -> str:
         async with aiohttp.ClientSession() as session:
             gl = gidgetlab.aiohttp.GitLabAPI(
                 session,
-                requester=self.user,
+                requester=self.requester,
                 access_token=gl_token,
                 url=self.instance_url,
             )

src/hubcast/config.py

@@ -34,17 +34,13 @@ class GitHubConfig:
     def __init__(self):
         self.app_id = env_get("HC_GH_APP_IDENTIFIER")
         self.privkey = env_get("HC_GH_PRIVATE_KEY")
-        self.requester = env_get("HC_GH_REQUESTER")
         self.webhook_secret = env_get("HC_GH_SECRET")
         self.bot_user = env_get("HC_GH_BOT_USER")
 
 
 class GitLabConfig:
     def __init__(self):
         self.instance_url = env_get("HC_GL_URL")
-        # requester identifies the app making requests, it doesn't
-        # perform any auth function but is included in user-agent
-        self.requester = env_get("HC_GL_REQUESTER")
         self.token = env_get("HC_GL_TOKEN")
         self.token_type = env_get("HC_GL_TOKEN_TYPE", default="impersonation")
         self.webhook_secret = env_get("HC_GL_SECRET")