Skip to content

Commit 43c28e6

Browse files
committed
Remove usages of "whitelist" in Firestore.
Fixes #6755.
1 parent c264003 commit 43c28e6

File tree

4 files changed

+12
-12
lines changed

4 files changed

+12
-12
lines changed

Firestore/core/src/remote/datastore.cc

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -82,8 +82,8 @@ void LogGrpcCallFinished(absl::string_view rpc_name,
8282
status.error_message());
8383
if (LogIsDebugEnabled()) {
8484
auto headers =
85-
Datastore::GetWhitelistedHeadersAsString(call->GetResponseHeaders());
86-
LOG_DEBUG("RPC %s returned headers (whitelisted): %s", rpc_name, headers);
85+
Datastore::GetAllowlistedHeadersAsString(call->GetResponseHeaders());
86+
LOG_DEBUG("RPC %s returned headers (allowlisted): %s", rpc_name, headers);
8787
}
8888
}
8989

@@ -332,15 +332,15 @@ bool Datastore::IsPermanentWriteError(const Status& error) {
332332
return IsPermanentError(error) && !IsAbortedError(error);
333333
}
334334

335-
std::string Datastore::GetWhitelistedHeadersAsString(
335+
std::string Datastore::GetAllowlistedHeadersAsString(
336336
const GrpcCall::Metadata& headers) {
337-
static std::unordered_set<std::string> whitelist = {
337+
static std::unordered_set<std::string> allowlist = {
338338
"date", "x-google-backends", "x-google-netmon-label", "x-google-service",
339339
"x-google-gfe-request-trace"};
340340

341341
std::string result;
342342
for (const auto& kv : headers) {
343-
if (whitelist.find(MakeString(kv.first)) != whitelist.end()) {
343+
if (allowlist.find(MakeString(kv.first)) != allowlist.end()) {
344344
absl::StrAppend(&result, MakeStringView(kv.first), ": ",
345345
MakeStringView(kv.second), "\n");
346346
}

Firestore/core/src/remote/datastore.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -123,7 +123,7 @@ class Datastore : public std::enable_shared_from_this<Datastore> {
123123
*/
124124
static bool IsPermanentWriteError(const util::Status& status);
125125

126-
static std::string GetWhitelistedHeadersAsString(
126+
static std::string GetAllowlistedHeadersAsString(
127127
const GrpcCall::Metadata& headers);
128128

129129
Datastore(const Datastore& other) = delete;
@@ -169,7 +169,7 @@ class Datastore : public std::enable_shared_from_this<Datastore> {
169169

170170
void RemoveGrpcCall(GrpcCall* to_remove);
171171

172-
static GrpcCall::Metadata ExtractWhitelistedHeaders(
172+
static GrpcCall::Metadata ExtractAllowlistedHeaders(
173173
const GrpcCall::Metadata& headers);
174174

175175
// In case Auth tries to invoke a callback after `Datastore` has been shut

Firestore/core/src/remote/stream.cc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -202,8 +202,8 @@ void Stream::OnStreamRead(const grpc::ByteBuffer& message) {
202202
HARD_ASSERT(IsStarted(), "OnStreamRead called for a stopped stream.");
203203

204204
if (LogIsDebugEnabled()) {
205-
LOG_DEBUG("%s headers (whitelisted): %s", GetDebugDescription(),
206-
Datastore::GetWhitelistedHeadersAsString(
205+
LOG_DEBUG("%s headers (allowlisted): %s", GetDebugDescription(),
206+
Datastore::GetAllowlistedHeadersAsString(
207207
grpc_stream_->GetResponseHeaders()));
208208
}
209209

Firestore/core/test/unit/remote/datastore_test.cc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -176,17 +176,17 @@ TEST_F(DatastoreTest, CanShutdownWithNoOperations) {
176176
Shutdown();
177177
}
178178

179-
TEST_F(DatastoreTest, WhitelistedHeaders) {
179+
TEST_F(DatastoreTest, AllowlistedHeaders) {
180180
GrpcStream::Metadata headers = {
181181
{"date", "date value"},
182182
{"x-google-backends", "backend value"},
183-
{"x-google-foo", "should not be in result"}, // Not whitelisted
183+
{"x-google-foo", "should not be in result"}, // Not allowlisted
184184
{"x-google-gfe-request-trace", "request trace"},
185185
{"x-google-netmon-label", "netmon label"},
186186
{"x-google-service", "service 1"},
187187
{"x-google-service", "service 2"}, // Duplicate names are allowed
188188
};
189-
std::string result = Datastore::GetWhitelistedHeadersAsString(headers);
189+
std::string result = Datastore::GetAllowlistedHeadersAsString(headers);
190190
EXPECT_EQ(result,
191191
"date: date value\n"
192192
"x-google-backends: backend value\n"

0 commit comments

Comments
 (0)