feat: add parameter for persist the base url

iomarmochtar · iomarmochtar · commit 4f30ec50a2df · 2022-08-02T23:35:08.000+07:00
diff --git a/gitlab/client.py b/gitlab/client.py
@@ -66,6 +66,7 @@ class Gitlab:
         user_agent: A custom user agent to use for making HTTP requests.
         retry_transient_errors: Whether to retry after 500, 502, 503, 504
             or 52x responses. Defaults to False.
+        persist_base_url: reconstruct next url if found not same as user provided url
     """
 
     def __init__(
@@ -85,6 +86,7 @@ def __init__(
         order_by: Optional[str] = None,
         user_agent: str = gitlab.const.USER_AGENT,
         retry_transient_errors: bool = False,
+        persist_base_url: bool = False,
     ) -> None:
 
         self._api_version = str(api_version)
@@ -95,6 +97,7 @@ def __init__(
         #: Timeout to use for requests to gitlab server
         self.timeout = timeout
         self.retry_transient_errors = retry_transient_errors
+        self.persist_base_url = persist_base_url
         #: Headers that will be used in request to GitLab
         self.headers = {"User-Agent": user_agent}
 
@@ -1133,8 +1136,29 @@ def _query(
                 next_url = requests.utils.parse_header_links(result.headers["links"])[
                     0
                 ]["url"]
-            if not next_url.startswith(self._gl._base_url):
-                next_url = re.sub(r"^.*?/api", f"{self._gl._base_url}/api", next_url)
+            # if the next url is different with user provided server URL
+            # then give a warning it may because of misconfiguration
+            # but if the option to fix provided then just reconstruct it
+            if not next_url.startswith(self._gl.url):
+                search_api_url = re.search(r"(^.*?/api)", next_url)
+                if search_api_url:
+                    next_api_url = search_api_url.group(1)
+                    if self._gl.persist_base_url:
+                        next_url = next_url.replace(
+                            next_api_url, f"{self._gl._base_url}/api"
+                        )
+                    else:
+                        utils.warn(
+                            message=(
+                                f"The base url of the returned next page got "
+                                f"different with the user provided "
+                                f"{self._gl.url}/api* ~> {next_api_url}*, "
+                                f"since this may can lead to unexpected behaviour. "
+                                f"set argument persist_base_url to True for "
+                                f"resonctruct it with the origin one."
+                            ),
+                            category=UserWarning,
+                        )
             self._next_url = next_url
         except KeyError:
             self._next_url = None
diff --git a/tests/unit/test_gitlab.py b/tests/unit/test_gitlab.py
@@ -356,7 +356,33 @@ def test_gitlab_plain_const_does_not_warn(recwarn):
 
 
 @responses.activate
-def test_gitlab_keep_base_url(gl):
+@pytest.mark.parametrize(
+    "kwargs,link_header,expected_next_url,show_warning",
+    [
+        # normal execution
+        (
+            {},
+            "<http://localhost/api/v4/tests?per_page=1&page=2>;" ' rel="next"',
+            "http://localhost/api/v4/tests?per_page=1&page=2",
+            False,
+        ),
+        # got different url and will show the warning
+        (
+            {},
+            "<http://orig_host/api/v4/tests?per_page=1&page=2>;" ' rel="next"',
+            "http://orig_host/api/v4/tests?per_page=1&page=2",
+            True,
+        ),
+        # persist the base url
+        (
+            {"persist_base_url": True},
+            "<http://orig_host/api/v4/tests?per_page=1&page=2>;" ' rel="next"',
+            "http://localhost/api/v4/tests?per_page=1&page=2",
+            False,
+        ),
+    ],
+)
+def test_gitlab_persist_base_url(kwargs, link_header, expected_next_url, show_warning):
     responses.add(
         **{
             "method": responses.GET,
@@ -368,22 +394,19 @@ def test_gitlab_keep_base_url(gl):
                 "X-Per-Page": "1",
                 "X-Total-Pages": "2",
                 "X-Total": "2",
-                "Link": (
-                    "<http://orig_host/api/v4/tests?per_page=1&page=2>;" ' rel="next"'
-                ),
+                "Link": (link_header),
             },
             "content_type": "application/json",
             "status": 200,
             "match": helpers.MATCH_EMPTY_QUERY_PARAMS,
         }
     )
 
-    obj = gl.http_list("/tests", iterator=True)
-    assert len(obj) == 2
-    assert obj._next_url == "http://localhost/api/v4/tests?per_page=1&page=2"
-    assert obj.current_page == 1
-    assert obj.prev_page is None
-    assert obj.next_page == 2
-    assert obj.per_page == 1
-    assert obj.total_pages == 2
-    assert obj.total == 2
+    gl = gitlab.Gitlab(url="http://localhost", **kwargs)
+    if show_warning:
+        with pytest.warns(UserWarning) as warn_record:
+            obj = gl.http_list("/tests", iterator=True)
+        assert len(warn_record) == 1
+    else:
+        obj = gl.http_list("/tests", iterator=True)
+    assert obj._next_url == expected_next_url
