Skip to content

fix(client): resolve double /api/v4 segments in _build_url method #3247

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix(client): resolve double /api/v4 segments in _build_url method #3247

wants to merge 1 commit into from

Conversation

netflash
Copy link

Description

This PR fixes a longstanding bug in the _build_url method that causes double /api/v4 segments in URLs when paths start with /api/v4/.

Problem

When calling _build_url with a path like /api/v4/projects/123/security_settings, the method returns:

https://api.example.com/api/v4/api/v4/projects/123/security_settings

Instead of the expected:

https://api.example.com/api/v4/projects/123/security_settings

Solution

The fix detects paths starting with /api/v4/ and removes the duplicate prefix before constructing the final URL.

Testing

  • ✅ Added test case that reproduces the bug
  • ✅ All existing tests still pass
  • ✅ Fix maintains backward compatibility
  • ✅ Tested across multiple versions (5.0.0, 5.6.0, 6.0.0, 6.1.0, 6.2.0)

Impact

This bug has existed in all versions from 5.0.0 onwards and affects any code using paths starting with /api/v4/. The fix resolves a real-world issue encountered when trying to enable GitLab secret detection features.

Closes #3246

@netflash
fix(client): resolve double /api/v4 segments in _build_url method
d158706 
- Fix URL construction bug when paths start with /api/v4/
- Add test case to reproduce and verify the fix
- Maintain backward compatibility with existing behavior
- Resolves longstanding bug affecting all versions from 5.0.0+

Closes python-gitlab#3246
@netflash netflash force-pushed the fix/url-construction-bug branch from 68e8b67 to d158706 Compare August 14, 2025 05:17
@codecov Codecov
Copy link

codecov bot commented Aug 14, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 97.32%. Comparing base (397cf39) to head (d158706).

Additional details and impacted files 
@@           Coverage Diff           @@
##             main    #3247   +/-   ##
=======================================
  Coverage   97.32%   97.32%           
=======================================
  Files          98       98           
  Lines        6062     6065    +3     
=======================================
+ Hits         5900     5903    +3     
  Misses        162      162
Flag Coverage Δ
api_func_v4 83.52% <33.33%> (-0.08%) ⬇️
cli_func_v4 84.64% <33.33%> (-0.03%) ⬇️
unit 90.20% <100.00%> (+<0.01%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing lines Coverage Δ
gitlab/client.py 98.74% <100.00%> (+<0.01%) ⬆️
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@JohnVillalovos JohnVillalovos requested a review from Copilot August 15, 2025 14:46
Copilot
Copilot AI reviewed Aug 15, 2025
View reviewed changes
Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR fixes a URL construction bug in the _build_url method that caused double /api/v4 segments when paths already contained the API version prefix. The fix detects when a path starts with /api/v{version}/ and removes the duplicate prefix to prevent malformed URLs.

  • Fixes double /api/v4 segments in URL construction for paths already containing the API prefix
  • Adds comprehensive test coverage for the bug scenario
  • Maintains backward compatibility with existing functionality

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

File Description
gitlab/client.py Adds logic to detect and strip duplicate /api/v4 prefixes in _build_url method
tests/unit/test_gitlab_http_methods.py Adds test case that reproduces and validates the fix for the double API prefix bug

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
You can also share your feedback on Copilot code review for a chance to win a $100 gift card. Take the survey.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

Copilot code review Copilot Copilot left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

URL Construction Bug: Double /api/v4 segments in _build_url method
1 participant
@netflash