add compile db support

Signed-off-by: wangbaiping(wbpcode) <[email protected]>

Author: wbpcode

.gitignore

@@ -1 +1,3 @@
 /bazel-*
+.cache
+compile_commands.json

CONTRIBUTING.md

@@ -26,3 +26,7 @@ information on using pull requests.
 
 This project follows [Google's Open Source Community
 Guidelines](https://opensource.google/conduct/).
+
+## Development
+
+See the [Development Guidelines](DEVELOPMENT.md).

DEVELOPMENT.md

@@ -0,0 +1,11 @@
+# Development guidelines
+
+## Generate compilation database
+
+[JSON Compilation Database](https://clang.llvm.org/docs/JSONCompilationDatabase.html) files can be used by [clangd](https://clangd.llvm.org/) or similar tools to add source code cross-references and code completion functionality to editors.
+
+The following command can be used to generate the `compile_commands.json` file:
+
+```
+./tools/gen_compilation_database.py --include_all //example/... //:proxy_wasm_intrinsics_full
+```

bazel/repositories.bzl

@@ -56,3 +56,12 @@ def proxy_wasm_cpp_sdk_repositories():
         strip_prefix = "re2-2023-07-01",
         url = "https://github.com/google/re2/archive/2023-07-01.tar.gz",
     )
+
+    # Compile DB dependencies.
+    maybe(
+        http_archive,
+        name = "bazel_compdb",
+        sha256 = "acd2a9eaf49272bb1480c67d99b82662f005b596a8c11739046a4220ec73c4da",
+        strip_prefix = "bazel-compilation-database-40864791135333e1446a04553b63cbe744d358d0",
+        url = "https://github.com/grailbio/bazel-compilation-database/archive/40864791135333e1446a04553b63cbe744d358d0.tar.gz",
+    )

example/BUILD

@@ -1,4 +1,6 @@
 load("@proxy_wasm_cpp_sdk//bazel:defs.bzl", "proxy_wasm_cc_binary")
+load("@rules_cc//cc:defs.bzl", "cc_proto_library")
+load("@rules_proto//proto:defs.bzl", "proto_library")
 
 licenses(["notice"])  # Apache 2
 
@@ -21,22 +23,45 @@ proxy_wasm_cc_binary(
     copts = ["-std=c++17"],
 )
 
-proxy_wasm_cc_binary(
-    name = "http_proto_example_lite.wasm",
+proto_library(
+    name = "example_proto",
+    srcs = ["example.proto"],
+    deps = ["@com_google_protobuf//:struct_proto"],
+)
+
+cc_proto_library(
+    name = "example_proto_cc",
+    deps = [":example_proto"],
+)
+
+cc_library(
+    name = "http_proto_example_lite_lib",
     srcs = ["http_proto_example.cc"],
     copts = ["-std=c++17"],
-    protobuf = "lite",
     deps = [
-        "@com_google_protobuf//:struct_cc_proto",
+        ":example_proto_cc",
+        "@proxy_wasm_cpp_sdk//:proxy_wasm_intrinsics_lite",
     ],
+    alwayslink = 1,
 )
 
 proxy_wasm_cc_binary(
-    name = "http_proto_example_full.wasm",
+    name = "http_proto_example_lite.wasm",
+    deps = [":http_proto_example_lite_lib"],
+)
+
+cc_library(
+    name = "http_proto_example_full_lib",
     srcs = ["http_proto_example.cc"],
     copts = ["-std=c++17"],
-    protobuf = "full",
     deps = [
-        "@com_google_protobuf//:struct_cc_proto",
+        ":example_proto_cc",
+        "@proxy_wasm_cpp_sdk//:proxy_wasm_intrinsics_full",
     ],
+    alwayslink = 1,
+)
+
+proxy_wasm_cc_binary(
+    name = "http_proto_example_full.wasm",
+    deps = [":http_proto_example_full_lib"],
 )

example/example.proto

@@ -0,0 +1,23 @@
+// Copyright 2024 Google LLC
+//
+// 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.
+
+syntax = "proto3";
+
+package example;
+
+import "google/protobuf/struct.proto";
+
+message Example {
+  google.protobuf.Struct data = 1;
+}

example/http_proto_example.cc

@@ -12,10 +12,12 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-#include "google/protobuf/struct.pb.h"
-
 #include "proxy_wasm_intrinsics.h"
 
+#ifdef PROXY_WASM_PROTOBUF
+#include "example/example.pb.h"
+#endif
+
 class MyRootContext : public RootContext {
 public:
   explicit MyRootContext(uint32_t id, std::string_view root_id) : RootContext(id, root_id) {}
@@ -25,10 +27,16 @@ class MyRootContext : public RootContext {
     LOG_TRACE("onStart with protobuf (full)");
     google::protobuf::Value value;
     value.set_string_value("unused");
+
+    example::Example example_proto;
+    (*example_proto.mutable_data()->mutable_fields())["key"] = value;
 #elif defined(PROXY_WASM_PROTOBUF_LITE)
     LOG_TRACE("onStart with protobuf (lite)");
     google::protobuf::Value value;
     value.set_string_value("unused");
+
+    example::Example example_proto;
+    (*example_proto.mutable_data()->mutable_fields())["key"] = value;
 #else
     LOG_TRACE("onStart without protobuf");
 #endif

proxy_wasm_api.h

@@ -35,6 +35,10 @@
 #include <utility>
 #include <vector>
 
+#include "proxy_wasm_common.h"
+#include "proxy_wasm_enums.h"
+#include "proxy_wasm_externs.h"
+
 // Macro to log a message and abort the plugin if the given value is not
 // `WasmResult::Ok`.
 #define CHECK_RESULT(_c)                                                                           \

tools/gen_compilation_database.py

@@ -0,0 +1,79 @@
+#!/usr/bin/env python3
+
+# Copyright 2016-2019 Envoy Project Authors
+# Copyright 2020 Google LLC
+#
+# 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.
+
+import argparse
+import json
+import os
+import shlex
+import subprocess
+from pathlib import Path
+
+# This is copied from https://github.com/envoyproxy/envoy and remove unnecessary code.
+
+# This method is equivalent to https://github.com/grailbio/bazel-compilation-database/blob/master/generate.py
+def generate_compilation_database(args):
+    # We need to download all remote outputs for generated source code. This option lives here to override those
+    # specified in bazelrc.
+    bazel_startup_options = shlex.split(os.environ.get("BAZEL_STARTUP_OPTION_LIST", ""))
+    bazel_options = shlex.split(os.environ.get("BAZEL_BUILD_OPTION_LIST", "")) + [
+        "--remote_download_outputs=all",
+    ]
+
+    source_dir_targets = args.bazel_targets
+
+    subprocess.check_call(["bazel", *bazel_startup_options, "build"] + bazel_options + [
+        "--aspects=@bazel_compdb//:aspects.bzl%compilation_database_aspect",
+        "--output_groups=compdb_files,header_files"
+    ] + source_dir_targets)
+
+    execroot = subprocess.check_output(
+        ["bazel", *bazel_startup_options, "info", *bazel_options,
+         "execution_root"]).decode().strip()
+
+    db_entries = []
+    for db in Path(execroot).glob('**/*.compile_commands.json'):
+        db_entries.extend(json.loads(db.read_text()))
+
+    def replace_execroot_marker(db_entry):
+        if 'directory' in db_entry and db_entry['directory'] == '__EXEC_ROOT__':
+            db_entry['directory'] = execroot
+        if 'command' in db_entry:
+            db_entry['command'] = (
+                db_entry['command'].replace('-isysroot __BAZEL_XCODE_SDKROOT__', ''))
+        return db_entry
+
+    return list(map(replace_execroot_marker, db_entries))
+
+if __name__ == "__main__":
+    parser = argparse.ArgumentParser(description='Generate JSON compilation database')
+    parser.add_argument('--include_external', action='store_true')
+    parser.add_argument('--include_genfiles', action='store_true')
+    parser.add_argument('--include_headers', action='store_true')
+    parser.add_argument('--include_all', action='store_true')
+    parser.add_argument(
+        '--system-clang',
+        action='store_true',
+        help=
+        'Use `clang++` instead of the bazel wrapper for commands. This may help if `clangd` cannot find/run the tools.'
+    )
+    parser.add_argument('bazel_targets', nargs='*', default=[])
+
+    args = parser.parse_args()
+    db = generate_compilation_database(args)
+
+    with open("compile_commands.json", "w") as db_file:
+        json.dump(db, db_file, indent=2)