mirror of
https://github.com/google/flatbuffers.git
synced 2026-06-21 04:17:31 +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,3 +1,4 @@
|
||||
load("@aspect_rules_js//js:defs.bzl", "js_test")
|
||||
load("//:typescript.bzl", "flatbuffer_ts_library")
|
||||
|
||||
flatbuffer_ts_library(
|
||||
@@ -12,3 +13,14 @@ flatbuffer_ts_library(
|
||||
visibility = ["//visibility:public"],
|
||||
deps = [":typescript_transitive_ts_fbs"],
|
||||
)
|
||||
|
||||
js_test(
|
||||
name = "import_test",
|
||||
chdir = package_name(),
|
||||
data = [
|
||||
"package.json",
|
||||
":include_ts_fbs",
|
||||
"//:node_modules/flatbuffers",
|
||||
],
|
||||
entry_point = "import_test.js",
|
||||
)
|
||||
|
||||
31
tests/ts/test_dir/import_test.js
Normal file
31
tests/ts/test_dir/import_test.js
Normal file
@@ -0,0 +1,31 @@
|
||||
import assert from 'assert'
|
||||
import * as flatbuffers from 'flatbuffers'
|
||||
|
||||
import typescript_include from './typescript_include_generated.cjs'
|
||||
|
||||
const foobar = typescript_include.foobar;
|
||||
|
||||
function main() {
|
||||
// Validate the enums.
|
||||
assert.strictEqual(foobar.Abc.a, 0);
|
||||
assert.strictEqual(foobar.class_.arguments_, 0);
|
||||
|
||||
// Validate building a table.
|
||||
var fbb = new flatbuffers.Builder(1);
|
||||
var name = fbb.createString("Foo Bar");
|
||||
|
||||
foobar.Tab.startTab(fbb);
|
||||
foobar.Tab.addAbc(fbb, foobar.Abc.a);
|
||||
foobar.Tab.addArg(fbb, foobar.class_.arguments_);
|
||||
foobar.Tab.addName(fbb, name);
|
||||
var tab = foobar.Tab.endTab(fbb);
|
||||
|
||||
fbb.finish(tab);
|
||||
|
||||
// Call as a sanity check. Would be better to validate actual output here.
|
||||
fbb.asUint8Array();
|
||||
|
||||
console.log('FlatBuffers Bazel Import test: completed successfully');
|
||||
}
|
||||
|
||||
main();
|
||||
6
tests/ts/test_dir/package.json
Normal file
6
tests/ts/test_dir/package.json
Normal file
@@ -0,0 +1,6 @@
|
||||
{
|
||||
"type": "module",
|
||||
"dependencies": {
|
||||
"flatbuffers": "../../../"
|
||||
}
|
||||
}
|
||||
@@ -1,6 +1,13 @@
|
||||
include 'typescript_transitive_include.fbs';
|
||||
|
||||
namespace foobar;
|
||||
|
||||
enum class: int {
|
||||
arguments,
|
||||
}
|
||||
|
||||
table Tab {
|
||||
abc:Abc;
|
||||
arg:class;
|
||||
name:string;
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user