Skip to content

Quiet ESI streaming gunzip zero-output logs #13171

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

Open
bneradt wants to merge 1 commit into
base: master
Choose a base branch
from
+54 −13
Open

Quiet ESI streaming gunzip zero-output logs #13171

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
27 changes: 15 additions & 12 deletions plugins/esi/lib/EsiGunzip.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,29 +72,32 @@ EsiGunzip::stream_decode(const char *data, int data_len, std::string &udata)
int32_t curr_buf_size;

do {
_zstrm.next_out = reinterpret_cast<Bytef *>(raw_buf);
_zstrm.avail_out = BUF_SIZE;
inflate_result = inflate(&_zstrm, Z_SYNC_FLUSH);
curr_buf_size = -1;
if ((inflate_result == Z_OK) || (inflate_result == Z_BUF_ERROR)) {
curr_buf_size = BUF_SIZE - _zstrm.avail_out;
} else if (inflate_result == Z_STREAM_END) {
_zstrm.next_out = reinterpret_cast<Bytef *>(raw_buf);
_zstrm.avail_out = BUF_SIZE;
auto const avail_in_before = _zstrm.avail_in;
inflate_result = inflate(&_zstrm, Z_SYNC_FLUSH);
if ((inflate_result == Z_OK) || (inflate_result == Z_BUF_ERROR) || (inflate_result == Z_STREAM_END)) {
curr_buf_size = BUF_SIZE - _zstrm.avail_out;
} else {
TSError("[%s] Failure while inflating; error code %d", __FUNCTION__, inflate_result);
_success = false;
return false;
}
if (curr_buf_size > BUF_SIZE) {
TSError("[%s] buf too large", __FUNCTION__);
break;
}
if (curr_buf_size < 1) {
TSError("[%s] buf below zero", __FUNCTION__);
if (curr_buf_size < 1 && avail_in_before == _zstrm.avail_in) {
break;
}

// push empty object onto list and add data to in-list object to
// avoid data copy for temporary
buf_list.push_back(string());
string &curr_buf = buf_list.back();
curr_buf.assign(raw_buf, curr_buf_size);
if (curr_buf_size > 0) {
buf_list.push_back(string());
string &curr_buf = buf_list.back();
curr_buf.assign(raw_buf, curr_buf_size);
}

if (inflate_result == Z_STREAM_END) {
break;
Expand Down
26 changes: 26 additions & 0 deletions plugins/esi/test/gzip_test.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,12 +26,16 @@

#include <catch2/catch_test_macros.hpp>

#include "EsiGunzip.h"
#include "Utils.h"
#include "gzip.h"

using std::string;
using namespace EsiLib;

extern void enableFakeErrorLog();
extern string gFakeErrorLog;

TEST_CASE("test esi plugin - gzip")
{
SECTION("===================== Test 1")
Expand Down Expand Up @@ -102,4 +106,26 @@ TEST_CASE("test esi plugin - gzip")
// check output of gunzip
CHECK(gunzip(expected_cdata, 32, buf_list) == false);
}

SECTION("streaming gunzip does not log an error for chunks with no output")
{
const char expected_data[] = "Hello World!";

string cdata;
REQUIRE(gzip(expected_data, 12, cdata));

EsiGunzip gunzip;
string data;

enableFakeErrorLog();
REQUIRE(gunzip.stream_decode(cdata.data(), GZIP_HEADER_SIZE, data));
CHECK(data.empty());
CHECK(gFakeErrorLog.empty());

REQUIRE(gunzip.stream_decode(cdata.data() + GZIP_HEADER_SIZE, cdata.size() - GZIP_HEADER_SIZE, data));
REQUIRE(gunzip.stream_finish());

CHECK(data == expected_data);
CHECK(gFakeErrorLog.empty());
}
}
14 changes: 13 additions & 1 deletion plugins/esi/test/print_funcs.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,9 +34,11 @@ static const int LINE_SIZE = 1024 * 1024;
namespace
{
bool fakeDebugLogEnabled;
}
bool fakeErrorLogEnabled;
} // namespace

std::string gFakeDebugLog;
std::string gFakeErrorLog;

void
enableFakeDebugLog()
Expand All @@ -45,6 +47,13 @@ enableFakeDebugLog()
gFakeDebugLog.assign("");
}

void
enableFakeErrorLog()
{
fakeErrorLogEnabled = true;
gFakeErrorLog.assign("");
}

void
DbgCtl::print(const char *tag, const char * /* file */, const char * /* function */, int /* line */, const char *fmt, ...)
{
Expand Down Expand Up @@ -101,4 +110,7 @@ TSError(const char *fmt, ...)
vsnprintf(buf, LINE_SIZE, fmt, ap);
printf("Error: %s\n", buf);
va_end(ap);
if (fakeErrorLogEnabled) {
gFakeErrorLog.append(buf);
}
}