Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -82,64 +82,40 @@ internal override bool TryParseSourceLinkUrl(Uri uri, [NotNullWhen(true)] out st
return false;
}

/// <summary>
/// Builds the repository URL by locating /_apis/git/repositories/ in the path.
/// Works for all Azure DevOps variants:
/// visualstudio.com: /{project}/_apis/git/repositories/{repo}/items
/// dev.azure.com: /{org}/{project}/_apis/git/repositories/{repo}/items
/// TFS on-prem: [/{vdir}][/{collection}]/{project}/_apis/git/repositories/{repo}/items
/// The repo URL is everything before _apis, plus /_git/{repo}.
/// </summary>
private static string? BuildRepositoryUrl(Uri uri)
{
ReadOnlySpan<char> segment0 = default;
ReadOnlySpan<char> segment1 = default;
ReadOnlySpan<char> segment4 = default;
ReadOnlySpan<char> segment5 = default;
var segmentCount = 0;
var path = uri.AbsolutePath;

foreach (var segment in uri.AbsolutePath.SplitIntoSpans('/'))
// Find /_apis/git/repositories/ in the path
const string marker = "/_apis/git/repositories/";
var markerPos = path.IndexOf(marker, StringComparison.Ordinal);
if (markerPos <= 0)
{
ReadOnlySpan<char> span = segment;
if (span.IsEmpty)
{
continue;
}

switch (segmentCount)
{
case 0: segment0 = span; break;
case 1: segment1 = span; break;
case 4: segment4 = span; break;
case 5: segment5 = span; break;
}

segmentCount++;
// markerPos == 0 means nothing before _apis (no project); < 0 means not found
return null;
}

if (uri.Host.EndsWith("visualstudio.com", StringComparison.OrdinalIgnoreCase))
{
if (segmentCount < 5)
{
return null;
}

// Legacy format: https://{organization}.visualstudio.com
#if NET6_0_OR_GREATER
return $"https://{uri.Host}/{segment0}/_git/{segment4}";
#else
return $"https://{uri.Host}/{segment0.ToString()}/_git/{segment4.ToString()}";
#endif
}
// The prefix path (project and any virtual dir/collection) is everything before /_apis
var prefixPath = path.Substring(0, markerPos);

if (uri.Host.EndsWith("dev.azure.com", StringComparison.OrdinalIgnoreCase))
// Extract the repo name after /_apis/git/repositories/
var afterMarker = path.Substring(markerPos + marker.Length);
var repoEndSlash = afterMarker.IndexOf('/');
if (repoEndSlash <= 0)
{
if (segmentCount < 6)
{
return null;
}

// New format: https://dev.azure.com/{organization}
#if NET6_0_OR_GREATER
return $"https://{uri.Host}/{segment0}/{segment1}/_git/{segment5}";
#else
return $"https://{uri.Host}/{segment0.ToString()}/{segment1.ToString()}/_git/{segment5.ToString()}";
#endif
return null;
}

Log.Error("Unsupported Azure DevOps host: {Host}", uri.Host);
return null;
var repo = afterMarker.Substring(0, repoEndSlash);

return $"{uri.Scheme}://{uri.Authority}{prefixPath}/_git/{repo}";
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,109 @@
// <copyright file="BitBucketServerSourceLinkUrlParser.cs" company="Datadog">
// Unless explicitly stated otherwise all files in this repository are licensed under the Apache 2 License.
// This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2017 Datadog, Inc.
// </copyright>

#nullable enable
using System;
using System.Diagnostics.CodeAnalysis;
using Datadog.Trace.Util;

namespace Datadog.Trace.Pdb.SourceLink;

internal sealed class BitBucketServerSourceLinkUrlParser : SourceLinkUrlParser
{
/// <summary>
/// Extract the git commit sha and repository url from a Bitbucket Server / Data Center SourceLink mapping string.
/// Supports two URL forms:
/// >= 4.7: https://{host}[/base]/projects/{project}/repos/{repo}/raw/*?at={sha}
/// &lt; 4.7: https://{host}[/base]/projects/{project}/repos/{repo}/browse/*?at={sha}&amp;raw
/// </summary>
internal override bool TryParseSourceLinkUrl(Uri uri, [NotNullWhen(true)] out string? commitSha, [NotNullWhen(true)] out string? repositoryUrl)
{
commitSha = null;
repositoryUrl = null;

try
{
var path = uri.AbsolutePath;
var query = uri.Query;

// Bitbucket Server paths are /projects/{project}/repos/{repo}/..., so /projects/ must precede /repos/
var projectsIdx = path.IndexOf("/projects/", StringComparison.Ordinal);
var reposIdx = path.IndexOf("/repos/", StringComparison.Ordinal);
if (projectsIdx < 0 || reposIdx <= projectsIdx)
{
return false;
}

var afterRepos = path.Substring(reposIdx + "/repos/".Length);

// Find the repo name (next segment after /repos/)
var repoEndSlash = afterRepos.IndexOf('/');
if (repoEndSlash <= 0)
{
return false;
}

var afterRepo = afterRepos.Substring(repoEndSlash);

bool isBrowseForm;
if (afterRepo.StartsWith("/raw/", StringComparison.Ordinal))
{
isBrowseForm = false;
}
else if (afterRepo.StartsWith("/browse/", StringComparison.Ordinal))
{
isBrowseForm = true;
}
else
{
return false;
}

// Walk the query string once: extract the at={sha} pair and, for browse form, also
// look for a standalone "raw" flag (as opposed to an unrelated substring match).
ReadOnlySpan<char> shaSpan = default;
var hasRawFlag = false;
foreach (var pair in query.SplitIntoSpans('&'))
{
ReadOnlySpan<char> pairSpan = ((ReadOnlySpan<char>)pair).TrimStart('?');
var eqIndex = pairSpan.IndexOf('=');
var key = eqIndex < 0 ? pairSpan : pairSpan.Slice(0, eqIndex);

if (key.SequenceEqual("at".AsSpan()) && eqIndex >= 0)
{
shaSpan = pairSpan.Slice(eqIndex + 1);
}
else if (key.SequenceEqual("raw".AsSpan()))
{
hasRawFlag = true;
}
}

if (isBrowseForm && !hasRawFlag)
{
return false;
}

if (!IsValidCommitSha(shaSpan))
{
return false;
}

// Build repo URL: {scheme}://{authority}[/base]/projects/{project}/repos/{repo}
// This is everything up to and including the repo name segment
var repoUrlPath = path.Substring(0, reposIdx + "/repos/".Length + repoEndSlash);

repositoryUrl = $"{uri.Scheme}://{uri.Authority}{repoUrlPath}";
commitSha = shaSpan.ToString();
return true;
}
catch (Exception ex)
{
Log.Error(ex, "Error while trying to parse Bitbucket Server SourceLink URL");
}

return false;
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ internal sealed class CompositeSourceLinkUrlParser : SourceLinkUrlParser
{
new GitHubSourceLinkUrlParser(),
new BitBucketSourceLinkUrlParser(),
new BitBucketServerSourceLinkUrlParser(),
new AzureDevOpsSourceLinkUrlParser(),
new GitLabSourceLinkUrlParser()
};
Expand Down
148 changes: 112 additions & 36 deletions tracer/src/Datadog.Trace/PDBs/SourceLink/GitHubSourceLinkUrlParser.cs
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,11 @@ namespace Datadog.Trace.Pdb.SourceLink;
internal sealed class GitHubSourceLinkUrlParser : SourceLinkUrlParser
{
/// <summary>
/// Extract the git commit sha and repository url from a GitHub SourceLink mapping string.
/// For example, for the following SourceLink mapping string:
/// https://raw.githubusercontent.com/DataDog/dd-trace-dotnet/dd35903c688a74b62d1c6a9e4f41371c65704db8/*
/// It will return:
/// - commit sha: dd35903c688a74b62d1c6a9e4f41371c65704db8
/// - repository URL: https://github.com/DataDog/dd-trace-dotnet
/// Extract the git commit sha and repository url from a GitHub or GitHub Enterprise SourceLink mapping string.
/// Supports three URL forms:
/// 1. GitHub.com: https://raw.githubusercontent.com/{owner}/{repo}/{sha}/*
/// 2. GHE subdomain isolation: https://raw.{host}/{owner}/{repo}/{sha}/*
/// 3. GHE main-host /raw/: https://{host}/raw/{owner}/{repo}/{sha}/*
/// </summary>
internal override bool TryParseSourceLinkUrl(Uri uri, [NotNullWhen(true)] out string? commitSha, [NotNullWhen(true)] out string? repositoryUrl)
{
Expand All @@ -28,52 +27,129 @@ internal override bool TryParseSourceLinkUrl(Uri uri, [NotNullWhen(true)] out st

try
{
if (uri.Host != "raw.githubusercontent.com")
// Case 1: GitHub.com — https://raw.githubusercontent.com/{owner}/{repo}/{sha}/*
if (uri.Host.Equals("raw.githubusercontent.com", StringComparison.OrdinalIgnoreCase))
{
return false;
return TryParseStandardPath(uri, "https://github.com", out commitSha, out repositoryUrl);
}

ReadOnlySpan<char> org = default;
ReadOnlySpan<char> repo = default;
ReadOnlySpan<char> sha = default;
var segmentCount = 0;
// Case 2: GHE with subdomain isolation — https://raw.{host}/{owner}/{repo}/{sha}/*
if (uri.Host.StartsWith("raw.", StringComparison.OrdinalIgnoreCase) && uri.Host.Length > 4)
{
var enterpriseHost = uri.Host.Substring(4);
return TryParseStandardPath(uri, BuildBaseUrl(uri, enterpriseHost), out commitSha, out repositoryUrl);
}

foreach (var segment in uri.AbsolutePath.SplitIntoSpans('/'))
// Case 3: GHE without subdomain isolation — https://{host}/raw/{owner}/{repo}/{sha}/*
return TryParseRawPrefixPath(uri, out commitSha, out repositoryUrl);
}
catch (Exception ex)
{
Log.Error(ex, "Error while trying to parse GitHub SourceLink URL");
}

return false;
}

/// <summary>
/// Parses /{owner}/{repo}/{sha}/* (4 segments) and builds repo URL with the given base.
/// Used for GitHub.com and GHE with subdomain isolation.
/// </summary>
private static bool TryParseStandardPath(Uri uri, string repoUrlBase, out string? commitSha, out string? repositoryUrl)
{
commitSha = null;
repositoryUrl = null;

ReadOnlySpan<char> org = default;
ReadOnlySpan<char> repo = default;
ReadOnlySpan<char> sha = default;
var segmentCount = 0;

foreach (var segment in uri.AbsolutePath.SplitIntoSpans('/'))
{
ReadOnlySpan<char> span = segment;
if (span.IsEmpty)
{
ReadOnlySpan<char> span = segment;
if (span.IsEmpty)
{
continue;
}

switch (segmentCount)
{
case 0: org = span; break;
case 1: repo = span; break;
case 2: sha = span; break;
}

segmentCount++;
continue;
}

if (segmentCount != 4 || !IsValidCommitSha(sha))
switch (segmentCount)
{
return false;
case 0: org = span; break;
case 1: repo = span; break;
case 2: sha = span; break;
}

segmentCount++;
}

if (segmentCount != 4 || !IsValidCommitSha(sha))
{
return false;
}

#if NET6_0_OR_GREATER
repositoryUrl = $"https://github.com/{org}/{repo}";
repositoryUrl = $"{repoUrlBase}/{org}/{repo}";
#else
repositoryUrl = $"https://github.com/{org.ToString()}/{repo.ToString()}";
repositoryUrl = $"{repoUrlBase}/{org.ToString()}/{repo.ToString()}";
#endif
commitSha = sha.ToString();
return true;
commitSha = sha.ToString();
return true;
}

/// <summary>
/// Parses /raw/{owner}/{repo}/{sha}/* (5 segments) for GHE without subdomain isolation.
/// </summary>
private static bool TryParseRawPrefixPath(Uri uri, out string? commitSha, out string? repositoryUrl)
{
commitSha = null;
repositoryUrl = null;

ReadOnlySpan<char> owner = default;
ReadOnlySpan<char> repo = default;
ReadOnlySpan<char> sha = default;
var segmentCount = 0;

foreach (var segment in uri.AbsolutePath.SplitIntoSpans('/'))
{
ReadOnlySpan<char> span = segment;
if (span.IsEmpty)
{
continue;
}

switch (segmentCount)
{
case 0:
if (!span.SequenceEqual("raw".AsSpan()))
{
return false;
}

break;
case 1: owner = span; break;
case 2: repo = span; break;
case 3: sha = span; break;
}

segmentCount++;
}
catch (Exception ex)

if (segmentCount != 5 || !IsValidCommitSha(sha))
{
Log.Error(ex, "Error while trying to parse GitHub SourceLink URL");
return false;
}

return false;
var repoUrlBase = BuildBaseUrl(uri, uri.Host);
#if NET6_0_OR_GREATER
repositoryUrl = $"{repoUrlBase}/{owner}/{repo}";
#else
repositoryUrl = $"{repoUrlBase}/{owner.ToString()}/{repo.ToString()}";
#endif
commitSha = sha.ToString();
return true;
}

private static string BuildBaseUrl(Uri uri, string host)
=> uri.IsDefaultPort ? $"{uri.Scheme}://{host}" : $"{uri.Scheme}://{host}:{uri.Port}";
}
Loading
Loading