Skip to content
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

Fix github issue body size #1257

Merged
merged 8 commits into from
Nov 7, 2023
Merged

Fix github issue body size #1257

Changes from 2 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
c265482
Fix github issue body size
autoantwort Oct 29, 2023
083bfe6
Casts for msvc
autoantwort Oct 29, 2023
770ac95
First CR Comments
autoantwort Oct 30, 2023
16ea159
Add tests and fix stuff
autoantwort Nov 4, 2023
3bd810d
No args.get_command() != "x-set-installed"
autoantwort Nov 4, 2023
82f1a4d
Warnings
autoantwort Nov 4, 2023
16598da
MSVC Warnings -.-
autoantwort Nov 4, 2023
a7cbf3f
size_t everywhere + sort logs
autoantwort Nov 4, 2023
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
114 changes: 74 additions & 40 deletions src/vcpkg/commands.build.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1488,54 +1488,75 @@ namespace vcpkg
return res;
}

struct CreateLogDetails
static void append_log(const Filesystem& fs, const Path& path, int max_size, std::string& out)
{
const Filesystem& fs;
max_size -= static_cast<int>(path.native().size()) + 80 /* size of all static text */;
autoantwort marked this conversation as resolved.
Show resolved Hide resolved
if (max_size < 100)
{
return;
}
out += "<details><summary>";
out += path.native();
out += "</summary>\n\n```\n";

std::string operator()(const Path& path) const
const auto max_log_length = static_cast<size_t>(max_size);
const auto start_block_length = max_log_length * 4 / 12;
autoantwort marked this conversation as resolved.
Show resolved Hide resolved
const auto start_block_max_length = max_log_length * 5 / 12;
const auto end_block_length = max_log_length * 7 / 12;
const auto end_block_max_length = max_log_length - start_block_max_length;
auto log = fs.read_contents(path, VCPKG_LINE_INFO);
if (log.size() > max_log_length)
{
static constexpr auto MAX_LOG_LENGTH = 50'000;
static constexpr auto START_BLOCK_LENGTH = 3'000;
static constexpr auto START_BLOCK_MAX_LENGTH = 5'000;
static constexpr auto END_BLOCK_LENGTH = 43'000;
static constexpr auto END_BLOCK_MAX_LENGTH = 45'000;
auto log = fs.read_contents(path, VCPKG_LINE_INFO);
if (log.size() > MAX_LOG_LENGTH)
auto first_block_end = log.find_first_of('\n', start_block_length);
if (first_block_end == std::string::npos || first_block_end > start_block_max_length)
{
auto first_block_end = log.find_first_of('\n', START_BLOCK_LENGTH);
if (first_block_end == std::string::npos || first_block_end > START_BLOCK_MAX_LENGTH)
{
first_block_end = START_BLOCK_LENGTH;
}

auto last_block_end = log.find_last_of('\n', log.size() - END_BLOCK_LENGTH);
if (last_block_end == std::string::npos || last_block_end < log.size() - END_BLOCK_MAX_LENGTH)
{
last_block_end = log.size() - END_BLOCK_LENGTH;
}

auto first = log.begin() + first_block_end;
auto last = log.begin() + last_block_end;
auto skipped_lines = std::count(first, last, '\n');
log.replace(first, last, fmt::format("\n...\nSkipped {} lines\n...", skipped_lines));
first_block_end = start_block_max_length;
}

while (!log.empty() && log.back() == '\n')
auto last_block_start = log.find_last_of('\n', log.size() - end_block_length);
if (last_block_start == std::string::npos || last_block_start < log.size() - end_block_max_length)
{
log.pop_back();
last_block_start = log.size() - end_block_max_length;
}

return fmt::format("<details><summary>{}</summary>\n\n```\n{}\n```\n</details>", path.native(), log);
auto first = log.begin() + first_block_end;
auto last = log.begin() + last_block_start;
auto skipped_lines = std::count(first, last, '\n');
out.append(log, 0, first_block_end);
fmt::format_to(std::back_inserter(out), "\n...\nSkipped {} lines\n...", skipped_lines);
out.append(log, last_block_start);
autoantwort marked this conversation as resolved.
Show resolved Hide resolved
}
};

while (!out.empty() && out.back() == '\n')
{
out.pop_back();
}
out += "\n```\n</details>";
}

static void append_logs(const Filesystem& fs, const std::vector<std::string>& logs, int max_size, std::string& out)
{
int extra_size = 0;
max_size -= static_cast<int>(logs.size()) * 2;
autoantwort marked this conversation as resolved.
Show resolved Hide resolved
auto size_per_log = max_size / static_cast<int>(logs.size());
for (auto& log : logs)
{
const auto old_size = out.size();
append_log(fs, log, size_per_log + extra_size, out);
extra_size += size_per_log - static_cast<int>(out.size() - old_size);
out += "\n\n";
}
}

std::string create_github_issue(const VcpkgCmdArguments& args,
const ExtendedBuildResult& build_result,
const VcpkgPaths& paths,
const InstallPlanAction& action)
{
constexpr int MAX_ISSUE_SIZE = 65536;
const auto& fs = paths.get_filesystem();
std::string result;
result.reserve(MAX_ISSUE_SIZE);
BillyONeal marked this conversation as resolved.
Show resolved Hide resolved
fmt::format_to(std::back_inserter(result),
"Package: {} -> {}\n\n**Host Environment**\n\n- Host: {}-{}\n",
action.displayname(),
Expand All @@ -1561,17 +1582,25 @@ namespace vcpkg
"**Failure logs**\n\n```\n{}\n```\n",
paths.get_filesystem().read_contents(build_result.stdoutlog.value_or_exit(VCPKG_LINE_INFO),
VCPKG_LINE_INFO));
result.append(Strings::join("\n", build_result.error_logs, CreateLogDetails{fs}));

std::string postfix;
const auto maybe_manifest = paths.get_manifest();
if (auto manifest = maybe_manifest.get())
{
fmt::format_to(
std::back_inserter(result),
"**Additional context**\n\n<details><summary>vcpkg.json</summary>\n\n```\n{}\n```\n</details>\n",
Json::stringify(manifest->manifest));
if (args.get_command() != "x-set-installed" || manifest->manifest.contains("builtin-baseline"))
autoantwort marked this conversation as resolved.
Show resolved Hide resolved
{
fmt::format_to(
std::back_inserter(postfix),
"**Additional context**\n\n<details><summary>vcpkg.json</summary>\n\n```\n{}\n```\n</details>\n",
Json::stringify(manifest->manifest));
}
}

int max_body_size = MAX_ISSUE_SIZE - static_cast<int>(result.size()) - static_cast<int>(postfix.size());
autoantwort marked this conversation as resolved.
Show resolved Hide resolved
append_logs(fs, build_result.error_logs, max_body_size, result);

result.append(postfix);

return result;
}

Expand All @@ -1580,11 +1609,13 @@ namespace vcpkg
return "https://github.com/microsoft/vcpkg/issues?q=is%3Aissue+is%3Aopen+in%3Atitle+" + spec_name;
}

static std::string make_gh_issue_open_url(StringView spec_name, StringView path)
static std::string make_gh_issue_open_url(StringView spec_name, StringView triplet, StringView path)
{
return Strings::concat("https://github.com/microsoft/vcpkg/issues/new?title=[",
spec_name,
"]+Build+error&body=Copy+issue+body+from+",
"]+Build+error+on+",
triplet,
"&body=Copy+issue+body+from+",
Strings::percent_encode(path));
}

Expand All @@ -1593,18 +1624,19 @@ namespace vcpkg
const Optional<Path>& issue_body)
{
const auto& spec_name = action.spec.name();
const auto& triplet_name = action.spec.triplet().to_string();
BillyONeal marked this conversation as resolved.
Show resolved Hide resolved
LocalizedString result = msg::format(msgBuildTroubleshootingMessage1).append_raw('\n');
result.append_indent().append_raw(make_gh_issue_search_url(spec_name)).append_raw('\n');
result.append(msgBuildTroubleshootingMessage2).append_raw('\n');
if (issue_body.has_value())
{
const auto path = issue_body.get()->generic_u8string();
result.append_indent().append_raw(make_gh_issue_open_url(spec_name, path)).append_raw('\n');
result.append_indent().append_raw(make_gh_issue_open_url(spec_name, triplet_name, path)).append_raw('\n');
if (!paths.get_filesystem().find_from_PATH("gh").empty())
{
Command gh("gh");
gh.string_arg("issue").string_arg("create").string_arg("-R").string_arg("microsoft/vcpkg");
gh.string_arg("--title").string_arg(fmt::format("[{}] Build failure", spec_name));
gh.string_arg("--title").string_arg(fmt::format("[{}] Build failure on {}", spec_name, triplet_name));
gh.string_arg("--body-file").string_arg(path);

result.append(msgBuildTroubleshootingMessageGH).append_raw('\n');
Expand All @@ -1617,7 +1649,9 @@ namespace vcpkg
.append_raw("https://github.com/microsoft/vcpkg/issues/"
"new?template=report-package-build-failure.md&title=[")
.append_raw(spec_name)
.append_raw("]+Build+error\n");
.append_raw("]+Build+error+on+")
.append_raw(triplet_name)
.append_raw("\n");
result.append(msgBuildTroubleshootingMessage3, msg::package_name = spec_name).append_raw('\n');
result.append_raw(paths.get_toolver_diagnostics()).append_raw('\n');
}
Expand Down