Skip to content

Commit

Permalink
Implement simple annotation bundling
Browse files Browse the repository at this point in the history
Summary: The standard annotation library is essentially a part of the Thrift compiler toolchain and they have to match each other. Unfortunately this is currently not the case and there exist multiple copies of the annotation library that are rarely updated and cause various issues.

Reviewed By: aristidisp

Differential Revision: D64916919

fbshipit-source-id: 19d95dced4a5c6e54eaf1164bf24d46b52f38575
  • Loading branch information
vitaut authored and facebook-github-bot committed Oct 25, 2024
1 parent a2f0209 commit d43d589
Show file tree
Hide file tree
Showing 4 changed files with 86 additions and 2 deletions.
45 changes: 45 additions & 0 deletions third-party/thrift/src/thrift/annotation/build_annotations.cc
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
/*
* Copyright (c) Meta Platforms, Inc. and affiliates.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

#include <fmt/core.h>
#include "thrift/compiler/source_location.h"

int main() {
// Print the header.
fmt::print(
"// {}generated\n"
"\n"
"#include <thrift/annotation/bundled_annotations.h>\n"
"\n",
'@');

// Read the file.
apache::thrift::compiler::source_manager sm;
std::string_view content = sm.get_file("scope.thrift")->text;
content.remove_suffix(1); // Remove trailing NUL.

// Print the content.
fmt::print(
"namespace apache::thrift::detail {{\n"
"\n"
"const std::string_view bundled_annotations::scope_file_content() {{\n"
" return R\"{0}({1}){0}\";\n"
"}}\n"
"\n"
"}} // namespace apache::thrift::detail\n",
"__FBTHRIFT_TAG__",
content);
}
25 changes: 25 additions & 0 deletions third-party/thrift/src/thrift/annotation/bundled_annotations.h
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
/*
* Copyright (c) Meta Platforms, Inc. and affiliates.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

#include <string_view>

namespace apache::thrift::detail {

struct bundled_annotations {
static const std::string_view scope_file_content();
};

} // namespace apache::thrift::detail
1 change: 1 addition & 0 deletions third-party/thrift/src/thrift/compiler/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -200,6 +200,7 @@ add_executable(
main.cc
compiler.cc
)
target_compile_definitions(thrift1 PRIVATE THRIFT_OSS)
target_link_libraries(
thrift1
compiler_ast
Expand Down
17 changes: 15 additions & 2 deletions third-party/thrift/src/thrift/compiler/compiler.cc
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@

#include <boost/algorithm/string/split.hpp>

#include <thrift/annotation/bundled_annotations.h>
#include <thrift/compiler/ast/t_program_bundle.h>
#include <thrift/compiler/detail/system.h>
#include <thrift/compiler/diagnostic.h>
Expand All @@ -50,7 +51,6 @@

namespace apache::thrift::compiler {
namespace {

/**
* Flags to control code generation
*/
Expand Down Expand Up @@ -733,7 +733,7 @@ std::unique_ptr<t_program_bundle> parse_and_mutate(
}

// Load standard library if available.
static const std::string schema_path = "thrift/lib/thrift/schema.thrift";
const std::string schema_path = "thrift/lib/thrift/schema.thrift";
auto found_or_error =
source_mgr.find_include_file(schema_path, "", pparams.incl_searchpath);
if (found_or_error.index() == 0) {
Expand Down Expand Up @@ -767,6 +767,19 @@ std::unique_ptr<t_program_bundle> parse_and_mutate(
std::get<1>(found_or_error));
}

#ifndef THRIFT_OSS
const std::string scope_path = "thrift/annotation/scope.thrift";
found_or_error =
source_mgr.find_include_file(scope_path, "", pparams.incl_searchpath);
if (found_or_error.index() != 0) {
// Fall back to the bundled annotation file.
std::string_view content =
apache::thrift::detail::bundled_annotations::scope_file_content();
source_mgr.add_virtual_file(
scope_path, std::string(content.data(), content.size()));
}
#endif

// C++ codegen inserts an empty const if this is false. Other languages may
// dynamically determine whether the schema const exists.
if (gparams.inject_schema_const) {
Expand Down

0 comments on commit d43d589

Please sign in to comment.