feat: support new tokenless protocol (#447)

* feat: add new tokenless support

We no longer have to send the X-Tokenless header
anymore.

Signed-off-by: joseph-sentry <[email protected]>

* fix: remove github API call from tokenless

we no longer want to make the github API call to check if the current
ref we are uploading from is a PR to determine what to set the tokenless
header to. It's no longer necessary and all that is needed for tokenless
is to pass the correct  branch name (containing a ':') to the create
commit step so that tokenless works. The CLI will automatically check if
the TOKENLESS env var has been set by the action. The action will set
this env var when it detects it's running on a fork.

Signed-off-by: joseph-sentry <[email protected]>

* fix: address feedback

* fix: add clarifying comment

Signed-off-by: joseph-sentry <[email protected]>

* test: fix tests

* chore: make lint

Signed-off-by: joseph-sentry <[email protected]>

* chore: make lint

---------

Signed-off-by: joseph-sentry <[email protected]>

Author: joseph-sentry

codecov_cli/helpers/git.py

@@ -95,22 +95,3 @@ def parse_git_service(remote_repo_url: str):
             extra=dict(remote_repo_url=remote_repo_url),
         )
         return None
-
-
-def is_fork_pr(pull_dict: PullDict) -> bool:
-    """
-    takes in dict: pull_dict
-    returns true if PR is made in a fork context, false if not.
-    """
-    return pull_dict and pull_dict["head"]["slug"] != pull_dict["base"]["slug"]
-
-
-def get_pull(service, slug, pr_num) -> Optional[PullDict]:
-    """
-    takes in str git service e.g. github, gitlab etc., slug in the owner/repo format, and the pull request number
-    returns the pull request info gotten from the git service provider if successful, None if not
-    """
-    git_service = get_git_service(service)
-    if git_service:
-        pull_dict = git_service.get_pull_request(slug, pr_num)
-        return pull_dict

codecov_cli/helpers/request.py

@@ -1,6 +1,7 @@
 import logging
 from sys import exit
 from time import sleep
+from typing import Optional
 
 import click
 import requests
@@ -15,7 +16,7 @@
 USER_AGENT = f"codecov-cli/{__version__}"
 
 
-def _set_user_agent(headers: dict = None) -> dict:
+def _set_user_agent(headers: Optional[dict] = None) -> dict:
     headers = headers or {}
     headers.setdefault("User-Agent", USER_AGENT)
     return headers
@@ -37,7 +38,10 @@ def put(url: str, data: dict = None, headers: dict = None) -> requests.Response:
 
 
 def post(
-    url: str, data: dict = None, headers: dict = None, params: dict = None
+    url: str,
+    data: Optional[dict] = None,
+    headers: Optional[dict] = None,
+    params: Optional[dict] = None,
 ) -> requests.Response:
     headers = _set_user_agent(headers)
     return requests.post(url, json=data, headers=headers, params=params)
@@ -82,7 +86,10 @@ def wrapper(*args, **kwargs):
 
 @retry_request
 def send_post_request(
-    url: str, data: dict = None, headers: dict = None, params: dict = None
+    url: str,
+    data: Optional[dict] = None,
+    headers: Optional[dict] = None,
+    params: Optional[dict] = None,
 ):
     return request_result(post(url=url, data=data, headers=headers, params=params))
 
@@ -95,6 +102,12 @@ def get_token_header_or_fail(token: str) -> dict:
     return {"Authorization": f"token {token}"}
 
 
+def get_token_header(token: str) -> Optional[dict]:
+    if token is None:
+        return None
+    return {"Authorization": f"token {token}"}
+
+
 @retry_request
 def send_put_request(
     url: str,

codecov_cli/services/commit/__init__.py

@@ -1,9 +1,9 @@
 import logging
+import os
 import typing
 
 from codecov_cli.helpers.config import CODECOV_API_URL
 from codecov_cli.helpers.encoder import decode_slug, encode_slug
-from codecov_cli.helpers.git import get_pull, is_fork_pr
 from codecov_cli.helpers.request import (
     get_token_header_or_fail,
     log_warnings_and_errors_if_any,
@@ -43,11 +43,12 @@ def create_commit_logic(
 def send_commit_data(
     commit_sha, parent_sha, pr, branch, slug, token, service, enterprise_url
 ):
-    decoded_slug = decode_slug(slug)
-    pull_dict = get_pull(service, decoded_slug, pr) if not token else None
-    if is_fork_pr(pull_dict):
-        headers = {"X-Tokenless": pull_dict["head"]["slug"], "X-Tokenless-PR": pr}
-        branch = pull_dict["head"]["slug"] + ":" + branch
+    # this is how the CLI receives the username of the user to whom the fork belongs
+    # to and the branch name from the action
+    tokenless = os.environ.get("TOKENLESS")
+    if tokenless:
+        headers = None  # type: ignore
+        branch = tokenless  # type: ignore
         logger.info("The PR is happening in a forked repo. Using tokenless upload.")
     else:
         headers = get_token_header_or_fail(token)

codecov_cli/services/report/__init__.py

@@ -7,7 +7,6 @@
 from codecov_cli.helpers import request
 from codecov_cli.helpers.config import CODECOV_API_URL
 from codecov_cli.helpers.encoder import decode_slug, encode_slug
-from codecov_cli.helpers.git import get_pull, is_fork_pr
 from codecov_cli.helpers.request import (
     get_token_header_or_fail,
     log_warnings_and_errors_if_any,
@@ -47,17 +46,7 @@ def send_create_report_request(
     commit_sha, code, service, token, encoded_slug, enterprise_url, pull_request_number
 ):
     data = {"code": code}
-    decoded_slug = decode_slug(encoded_slug)
-    pull_dict = (
-        get_pull(service, decoded_slug, pull_request_number) if not token else None
-    )
-    if is_fork_pr(pull_dict):
-        headers = {
-            "X-Tokenless": pull_dict["head"]["slug"],
-            "X-Tokenless-PR": pull_request_number,
-        }
-    else:
-        headers = get_token_header_or_fail(token)
+    headers = get_token_header_or_fail(token)
     upload_url = enterprise_url or CODECOV_API_URL
     url = f"{upload_url}/upload/{service}/{encoded_slug}/commits/{commit_sha}/reports"
     return send_post_request(url=url, headers=headers, data=data)

codecov_cli/services/upload/upload_sender.py

@@ -8,9 +8,8 @@
 from codecov_cli import __version__ as codecov_cli_version
 from codecov_cli.helpers.config import CODECOV_API_URL
 from codecov_cli.helpers.encoder import encode_slug
-from codecov_cli.helpers.git import get_pull, is_fork_pr
 from codecov_cli.helpers.request import (
-    get_token_header_or_fail,
+    get_token_header,
     send_post_request,
     send_put_request,
 )
@@ -53,19 +52,7 @@ def send_upload_data(
             "version": codecov_cli_version,
             "ci_service": ci_service,
         }
-
-        # Data to upload to Codecov
-        pull_dict = (
-            get_pull(git_service, slug, pull_request_number) if not token else None
-        )
-
-        if is_fork_pr(pull_dict):
-            headers = {
-                "X-Tokenless": pull_dict["head"]["slug"],
-                "X-Tokenless-PR": pull_request_number,
-            }
-        else:
-            headers = get_token_header_or_fail(token)
+        headers = get_token_header(token)
         encoded_slug = encode_slug(slug)
         upload_url = enterprise_url or CODECOV_API_URL
         url, data = self.get_url_and_possibly_update_data(

codecov_cli/services/upload_completion/__init__.py

@@ -4,7 +4,7 @@
 from codecov_cli.helpers.config import CODECOV_API_URL
 from codecov_cli.helpers.encoder import encode_slug
 from codecov_cli.helpers.request import (
-    get_token_header_or_fail,
+    get_token_header,
     log_warnings_and_errors_if_any,
     send_post_request,
 )
@@ -16,7 +16,7 @@ def upload_completion_logic(
     commit_sha, slug, token, git_service, enterprise_url, fail_on_error=False
 ):
     encoded_slug = encode_slug(slug)
-    headers = get_token_header_or_fail(token)
+    headers = get_token_header(token)
     upload_url = enterprise_url or CODECOV_API_URL
     url = f"{upload_url}/upload/{git_service}/{encoded_slug}/commits/{commit_sha}/upload-complete"
     sending_result = send_post_request(url=url, headers=headers)

tests/helpers/test_git.py

@@ -135,82 +135,3 @@ def test_get_git_service_class():
     assert git.get_git_service("bitbucket") == None
 
 
-def test_pr_is_not_fork_pr(mocker):
-    def mock_request(*args, headers={}, **kwargs):
-        assert headers["X-GitHub-Api-Version"] == "2022-11-28"
-        res = {
-            "url": "https://api.github.com/repos/codecov/codecov-cli/pulls/1",
-            "head": {
-                "sha": "123",
-                "label": "codecov-cli:branch",
-                "ref": "branch",
-                "repo": {"full_name": "codecov/codecov-cli"},
-            },
-            "base": {
-                "sha": "123",
-                "label": "codecov-cli:main",
-                "ref": "main",
-                "repo": {"full_name": "codecov/codecov-cli"},
-            },
-        }
-        response = Response()
-        response.status_code = 200
-        response._content = json.dumps(res).encode("utf-8")
-        return response
-
-    mocker.patch.object(
-        requests,
-        "get",
-        side_effect=mock_request,
-    )
-    pull_dict = git.get_pull("github", "codecov/codecov-cli", 1)
-    assert not git.is_fork_pr(pull_dict)
-
-
-def test_pr_is_fork_pr(mocker):
-    def mock_request(*args, headers={}, **kwargs):
-        assert headers["X-GitHub-Api-Version"] == "2022-11-28"
-        res = {
-            "url": "https://api.github.com/repos/codecov/codecov-cli/pulls/1",
-            "head": {
-                "sha": "123",
-                "label": "codecov-cli:branch",
-                "ref": "branch",
-                "repo": {"full_name": "user_forked_repo/codecov-cli"},
-            },
-            "base": {
-                "sha": "123",
-                "label": "codecov-cli:main",
-                "ref": "main",
-                "repo": {"full_name": "codecov/codecov-cli"},
-            },
-        }
-        response = Response()
-        response.status_code = 200
-        response._content = json.dumps(res).encode("utf-8")
-        return response
-
-    mocker.patch.object(
-        requests,
-        "get",
-        side_effect=mock_request,
-    )
-    pull_dict = git.get_pull("github", "codecov/codecov-cli", 1)
-    assert git.is_fork_pr(pull_dict)
-
-
-def test_pr_not_found(mocker):
-    def mock_request(*args, headers={}, **kwargs):
-        assert headers["X-GitHub-Api-Version"] == "2022-11-28"
-        response = Response()
-        response.status_code = 404
-        response._content = b"not-found"
-        return response
-
-    mocker.patch.object(
-        requests,
-        "get",
-        side_effect=mock_request,
-    )
-    pull_dict = git.get_pull("github", "codecov/codecov-cli", 1)
-    assert not git.is_fork_pr(pull_dict)

tests/helpers/test_request.py

@@ -7,6 +7,7 @@
 from codecov_cli import __version__
 from codecov_cli.helpers.request import (
     get,
+    get_token_header,
     get_token_header_or_fail,
     log_warnings_and_errors_if_any,
 )
@@ -69,6 +70,17 @@ def test_get_token_header_or_fail():
         == "Codecov token not found. Please provide Codecov token with -t flag."
     )
 
+def test_get_token_header():
+    # Test with a valid UUID token
+    token = uuid.uuid4()
+    result = get_token_header(token)
+    assert result == {"Authorization": f"token {str(token)}"}
+
+    # Test with a None token
+    token = None
+    result = get_token_header(token)
+    assert result is None
+
 
 def test_request_retry(mocker, valid_response):
     expected_response = request_result(valid_response)

tests/helpers/test_upload_sender.py

@@ -231,14 +231,8 @@ def test_upload_sender_post_called_with_right_parameters_tokenless(
         mocked_storage_server,
         mocker,
     ):
-        headers = {"X-Tokenless": "user-forked/repo", "X-Tokenless-PR": "pr"}
-        mock_get_pull = mocker.patch(
-            "codecov_cli.services.upload.upload_sender.get_pull",
-            return_value={
-                "head": {"slug": "user-forked/repo"},
-                "base": {"slug": "org/repo"},
-            },
-        )
+        headers = {}
+        
         mocked_legacy_upload_endpoint.match = [
             matchers.json_params_matcher(request_data),
             matchers.header_matcher(headers),
@@ -263,7 +257,6 @@ def test_upload_sender_post_called_with_right_parameters_tokenless(
         assert (
             post_req_made.headers.items() >= headers.items()
         )  # test dict is a subset of the other
-        mock_get_pull.assert_called()
 
     def test_upload_sender_put_called_with_right_parameters(
         self, mocked_responses, mocked_legacy_upload_endpoint, mocked_storage_server

tests/services/commit/test_commit_service.py

@@ -150,33 +150,7 @@ def test_commit_sender_with_forked_repo(mocker):
         return_value=mocker.MagicMock(status_code=200, text="success"),
     )
 
-    def mock_request(*args, headers={}, **kwargs):
-        assert headers["X-GitHub-Api-Version"] == "2022-11-28"
-        res = {
-            "url": "https://api.github.com/repos/codecov/codecov-cli/pulls/1",
-            "head": {
-                "sha": "123",
-                "label": "codecov-cli:branch",
-                "ref": "branch",
-                "repo": {"full_name": "user_forked_repo/codecov-cli"},
-            },
-            "base": {
-                "sha": "123",
-                "label": "codecov-cli:main",
-                "ref": "main",
-                "repo": {"full_name": "codecov/codecov-cli"},
-            },
-        }
-        response = Response()
-        response.status_code = 200
-        response._content = json.dumps(res).encode("utf-8")
-        return response
-
-    mocker.patch.object(
-        requests,
-        "get",
-        side_effect=mock_request,
-    )
+    mocker.patch("os.environ", dict(TOKENLESS="user_forked_repo/codecov-cli:branch"))
     res = send_commit_data(
         "commit_sha",
         "parent_sha",
@@ -195,5 +169,5 @@ def mock_request(*args, headers={}, **kwargs):
             "pullid": "1",
             "branch": "user_forked_repo/codecov-cli:branch",
         },
-        headers={"X-Tokenless": "user_forked_repo/codecov-cli", "X-Tokenless-PR": "1"},
+        headers=None,
     )