mirror of
https://github.com/google/flatbuffers.git
synced 2025-04-09 00:12:15 +08:00
* Migrate from rules_nodejs to rules_js/rules_ts (take 2) This is the second version of patch #7923. The first version got reverted because bazel query was failing: $ bazel --nosystem_rc --nohome_rc query tests(set('//...')) except tests(attr("tags", "manual", set('//...'))) ERROR: Traceback (most recent call last): File "/workdir/tests/ts/bazel_repository_test_dir/BUILD", line 6, column 22, in <toplevel> npm_link_all_packages(name = "node_modules") File "/var/lib/buildkite-agent/.cache/bazel/_bazel_buildkite-agent/ec321eb2cc2d0f8f91b676b6d4c66c29/external/npm/defs.bzl", line 188, column 13, in npm_link_all_packages fail(msg) Error in fail: The npm_link_all_packages() macro loaded from @npm//:defs.bzl and called in bazel package 'tests/ts/bazel_repository_test_dir' may only be called in bazel packages that correspond to the pnpm root package '' and pnpm workspace projects '' This was happening because the `.bazelrc` file only added `--deleted_packages` to the `build` command. We also need it for the `query` command. This second version of the patch fixes that. Original commit message: This patch migrates the current use of rules_nodejs to the new rules_js. rules_js is the intended replacement of rules_nodejs as per this note: https://github.com/aspect-build/rules_js#relationship-to-rules_nodejs > rules_js is an alternative to the build_bazel_rules_nodejs Bazel module > and accompanying npm packages hosted in > https://github.com/bazelbuild/rules_nodejs, which is now > unmaintained. All users are recommended to use rules_js instead. There are a few notable changes in this patch: 1. The `flatbuffer_ts_library` macro no longer accepts a `package_name` attribute. This is because rules_js appears to manage the import naming of dependencies via top-level `npm_link_package` targets. Users will have to migrate. 2. I added a few more arguments to `flatbuffer_library_public()`. These helped with exposing esbuild to `ts/compile_flat_file.sh`. 3. I pinned the version of `typescript` in `package.json` so that rules_ts can download the exact same version. rules_ts doesn't know what to do if the version isn't exact. 4. Since rules_js uses the pnpm locking mechanism, we now have a `pnpm-lock.yaml` file instead of a yarn lock file. 4. I added bazel targets for a few of the existing tests in `tests/ts`. They can be run with `bazel test //test/ts:all`. Since there is no flexbuffers bazel target, I did not add a bazel target for the corresponding test. 5. I added a separate workspace in `tests/ts/bazel_repository_test_dir/` to validate that the flatbuffers code can be imported as an external repository. You can run the test with `bazel test //test/ts:bazel_repository_test`. For this to work, I needed to expose a non-trivial chunk of the flatbuffers code to the test. I achieved this through some recursive `distribution` filegroups. This is inspired by rules_python's workspace tests. I did not do anything special to validate that the `gen_reflections` parameter works the same. This patch doesn't change anything about the TypeScript generation. As a side note: I am not an expert with rules_js. This patch is my attempt based on my limited understanding of the rule set. Fixes #7817 * Fix the query --------- Co-authored-by: Derek Bailey <derekbailey@google.com>
140 lines
3.5 KiB
Python
140 lines
3.5 KiB
Python
load("@aspect_rules_js//npm:defs.bzl", "npm_link_package")
|
|
load("@npm//:defs.bzl", "npm_link_all_packages")
|
|
load("@rules_cc//cc:defs.bzl", "cc_binary", "cc_library")
|
|
|
|
licenses(["notice"])
|
|
|
|
package(
|
|
default_visibility = ["//visibility:public"],
|
|
)
|
|
|
|
npm_link_all_packages(name = "node_modules")
|
|
|
|
npm_link_package(
|
|
name = "node_modules/flatbuffers",
|
|
src = "//ts:flatbuffers",
|
|
)
|
|
|
|
exports_files([
|
|
"LICENSE",
|
|
"tsconfig.json",
|
|
])
|
|
|
|
config_setting(
|
|
name = "platform_freebsd",
|
|
constraint_values = [
|
|
"@platforms//os:freebsd",
|
|
],
|
|
)
|
|
|
|
config_setting(
|
|
name = "platform_openbsd",
|
|
constraint_values = [
|
|
"@platforms//os:openbsd",
|
|
],
|
|
)
|
|
|
|
filegroup(
|
|
name = "distribution",
|
|
srcs = [
|
|
"BUILD.bazel",
|
|
"WORKSPACE",
|
|
"build_defs.bzl",
|
|
"typescript.bzl",
|
|
"//grpc/src/compiler:distribution",
|
|
"//reflection:distribution",
|
|
"//src:distribution",
|
|
"//ts:distribution",
|
|
] + glob([
|
|
"include/flatbuffers/*.h",
|
|
]),
|
|
visibility = ["//visibility:public"],
|
|
)
|
|
|
|
# Public flatc library to compile flatbuffer files at runtime.
|
|
cc_library(
|
|
name = "flatbuffers",
|
|
hdrs = ["//:public_headers"],
|
|
linkstatic = 1,
|
|
strip_include_prefix = "/include",
|
|
deps = ["//src:flatbuffers"],
|
|
)
|
|
|
|
# Public C++ headers for the Flatbuffers library.
|
|
filegroup(
|
|
name = "public_headers",
|
|
srcs = [
|
|
"include/flatbuffers/allocator.h",
|
|
"include/flatbuffers/array.h",
|
|
"include/flatbuffers/base.h",
|
|
"include/flatbuffers/buffer.h",
|
|
"include/flatbuffers/buffer_ref.h",
|
|
"include/flatbuffers/code_generator.h",
|
|
"include/flatbuffers/code_generators.h",
|
|
"include/flatbuffers/default_allocator.h",
|
|
"include/flatbuffers/detached_buffer.h",
|
|
"include/flatbuffers/file_manager.h",
|
|
"include/flatbuffers/flatbuffer_builder.h",
|
|
"include/flatbuffers/flatbuffers.h",
|
|
"include/flatbuffers/flex_flat_util.h",
|
|
"include/flatbuffers/flexbuffers.h",
|
|
"include/flatbuffers/grpc.h",
|
|
"include/flatbuffers/hash.h",
|
|
"include/flatbuffers/idl.h",
|
|
"include/flatbuffers/minireflect.h",
|
|
"include/flatbuffers/reflection.h",
|
|
"include/flatbuffers/reflection_generated.h",
|
|
"include/flatbuffers/registry.h",
|
|
"include/flatbuffers/stl_emulation.h",
|
|
"include/flatbuffers/string.h",
|
|
"include/flatbuffers/struct.h",
|
|
"include/flatbuffers/table.h",
|
|
"include/flatbuffers/util.h",
|
|
"include/flatbuffers/vector.h",
|
|
"include/flatbuffers/vector_downward.h",
|
|
"include/flatbuffers/verifier.h",
|
|
],
|
|
)
|
|
|
|
# Public flatc compiler library.
|
|
cc_library(
|
|
name = "flatc_library",
|
|
linkstatic = 1,
|
|
deps = [
|
|
"//src:flatc_library",
|
|
],
|
|
)
|
|
|
|
# Public flatc compiler.
|
|
cc_binary(
|
|
name = "flatc",
|
|
data = ["//reflection:reflection_fbs_schema"],
|
|
deps = [
|
|
"//src:flatc",
|
|
],
|
|
)
|
|
|
|
filegroup(
|
|
name = "flatc_headers",
|
|
srcs = [
|
|
"include/flatbuffers/flatc.h",
|
|
],
|
|
visibility = ["//:__subpackages__"],
|
|
)
|
|
|
|
# Library used by flatbuffer_cc_library rules.
|
|
cc_library(
|
|
name = "runtime_cc",
|
|
hdrs = [
|
|
"include/flatbuffers/base.h",
|
|
"include/flatbuffers/flatbuffers.h",
|
|
"include/flatbuffers/flexbuffers.h",
|
|
"include/flatbuffers/stl_emulation.h",
|
|
"include/flatbuffers/util.h",
|
|
"include/flatbuffers/vector.h",
|
|
"include/flatbuffers/verifier.h",
|
|
],
|
|
linkstatic = 1,
|
|
strip_include_prefix = "/include",
|
|
)
|