fix(gitlab): URL-encode the owner in remote requests for GitLab (#742)

tonybutt · web-flow · commit e3e7c0794082 · 2024-07-28T09:12:32.000+03:00
Gitlab requires that the project path be fully encoded. See the docs for details. https://docs.gitlab.com/ee/api/rest/#namespaced-path-encoding Pulls in the urlencoding crate here. Might not be needed when you have the choice to just update the documentation. I don't think the end user should be required to url encode their own strings. It might be nicer to just add the subgroup paradigm to the gitlab config in general for the future. This will fix the problem for now.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/git-cliff-core/Cargo.toml b/git-cliff-core/Cargo.toml
@@ -74,6 +74,7 @@ tokio = { version = "1.38.0", features = [
 futures = { version = "0.3.30", optional = true }
 url = "2.5.2"
 dyn-clone = "1.0.17"
+urlencoding = "2.1.3"
 
 [dependencies.git2]
 version = "0.19.0"
diff --git a/git-cliff-core/src/remote/gitlab.rs b/git-cliff-core/src/remote/gitlab.rs
@@ -6,6 +6,7 @@ use serde::{
 	Serialize,
 };
 use std::env;
+use urlencoding::encode;
 
 use super::*;
 
@@ -47,7 +48,7 @@ pub struct GitLabProject {
 
 impl RemoteEntry for GitLabProject {
 	fn url(_id: i64, api_url: &str, remote: &Remote, _page: i32) -> String {
-		format!("{}/projects/{}%2F{}", api_url, remote.owner, remote.repo)
+		format!("{}/projects/{}%2F{}", api_url, encode(remote.owner.as_str()), remote.repo)
 	}
 
 	fn buffer_size() -> usize {
@@ -285,3 +286,21 @@ impl GitLabClient {
 			.collect())
 	}
 }
+#[cfg(test)]
+mod test {
+	use super::*;
+	use pretty_assertions::assert_eq;
+    
+    fn test_remote_entry_url<R: RemoteEntry>(expects: &str) {
+		let remote = Remote::new("abc/def", "xyz1");
+		assert_eq!(
+			expects, 
+			R::url(1, "https://gitlab.test.com/api/v4", &remote, 0)
+		)
+	}
+
+	#[test]
+	fn it_url_encodes_slashes() {
+		test_remote_entry_url::<GitLabProject>("https://gitlab.test.com/api/v4/projects/abc%2Fdef%2Fxyz1")
+	}
+}
diff --git a/website/docs/integration/gitlab.md b/website/docs/integration/gitlab.md
@@ -63,6 +63,8 @@ GITLAB_TOKEN="***" git cliff --gitlab-repo "orhun/git-cliff"
 
 You can use the `GITLAB_API_URL` environment variable want to override the API URL. This is useful if you are using your own GitLab instance.
 
+When your project on your own Gitlab has one or many subgroups (e.g my.gitlab.com/myGroup/mySubgroup/myProject) set owner in the toml to "myGroup/mySubgroup" and repo to the repo name.
+
 :::
 
 ## Templating
