mirror of
https://github.com/google/flatbuffers.git
synced 2026-06-18 23:28:56 +00:00
Migrate from rules_nodejs to rules_js/rules_ts (take 2) (#7928)
* 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>
This commit is contained in:
@@ -1,5 +1,23 @@
|
||||
load("@npm//@bazel/typescript:index.bzl", "ts_project")
|
||||
load("@build_bazel_rules_nodejs//:index.bzl", "js_library")
|
||||
load("@aspect_rules_ts//ts:defs.bzl", "ts_project")
|
||||
load("@aspect_rules_js//npm:defs.bzl", "npm_package")
|
||||
|
||||
filegroup(
|
||||
name = "distribution",
|
||||
srcs = [
|
||||
"BUILD.bazel",
|
||||
"compile_flat_file.sh",
|
||||
] + glob([
|
||||
"*.ts",
|
||||
]),
|
||||
visibility = ["//visibility:public"],
|
||||
)
|
||||
|
||||
# Add an index to emulate the top-level package.json's "main" entry.
|
||||
genrule(
|
||||
name = "generate_index.ts",
|
||||
outs = ["index.ts"],
|
||||
cmd = """echo "export * from './flatbuffers.js'" > $(OUTS)""",
|
||||
)
|
||||
|
||||
ts_project(
|
||||
name = "flatbuffers_ts",
|
||||
@@ -11,6 +29,7 @@ ts_project(
|
||||
"flatbuffers.ts",
|
||||
"types.ts",
|
||||
"utils.ts",
|
||||
":index.ts",
|
||||
],
|
||||
declaration = True,
|
||||
tsconfig = {
|
||||
@@ -28,14 +47,19 @@ ts_project(
|
||||
},
|
||||
},
|
||||
visibility = ["//visibility:public"],
|
||||
deps = ["@npm//@types/node"],
|
||||
deps = [
|
||||
# Because the main repository instantiates the @npm repository, we need
|
||||
# to depend on the main repository's node import.
|
||||
"@//:node_modules/@types/node",
|
||||
],
|
||||
)
|
||||
|
||||
js_library(
|
||||
npm_package(
|
||||
name = "flatbuffers",
|
||||
package_name = "flatbuffers",
|
||||
srcs = [":flatbuffers_ts"],
|
||||
include_external_repositories = ["*"],
|
||||
package = "flatbuffers",
|
||||
visibility = ["//visibility:public"],
|
||||
deps = [":flatbuffers_ts"],
|
||||
)
|
||||
|
||||
sh_binary(
|
||||
@@ -44,7 +68,6 @@ sh_binary(
|
||||
data = [
|
||||
"@com_github_google_flatbuffers//:flatc",
|
||||
"@nodejs_linux_amd64//:node_bin",
|
||||
"@npm//esbuild/bin:esbuild",
|
||||
],
|
||||
# We just depend directly on the linux amd64 nodejs binary, so only support
|
||||
# running this script on amd64 for now.
|
||||
|
||||
@@ -14,10 +14,9 @@ source "${RUNFILES_DIR:-/dev/null}/$f" 2>/dev/null || \
|
||||
source "$(grep -sm1 "^$f " "$0.exe.runfiles_manifest" | cut -f2- -d' ')" 2>/dev/null || \
|
||||
{ echo>&2 "ERROR: cannot find $f"; exit 1; }; f=; set -e
|
||||
# --- end runfiles.bash initialization v2 ---
|
||||
set -e
|
||||
set -eu
|
||||
runfiles_export_envvars
|
||||
FLATC=$(rlocation com_github_google_flatbuffers/flatc)
|
||||
ESBUILD=$(rlocation npm/node_modules/esbuild/bin/esbuild)
|
||||
TS_FILE=$(${FLATC} $@ | grep "Entry point.*generated" | grep -o "bazel-out.*ts")
|
||||
export PATH=$(rlocation nodejs_linux_amd64/bin/nodejs/bin)
|
||||
${ESBUILD} ${TS_FILE} --format=cjs --bundle --outfile="${OUTPUT_FILE}" --external:flatbuffers --log-level=warning
|
||||
export PATH="$(rlocation nodejs_linux_amd64/bin/nodejs/bin):${PATH}"
|
||||
${ESBUILD_BIN} ${TS_FILE} --format=cjs --bundle --outfile="${OUTPUT_FILE}" --external:flatbuffers --log-level=warning
|
||||
|
||||
Reference in New Issue
Block a user