-
Notifications
You must be signed in to change notification settings - Fork 767
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[bazel] Introduce grpc_web_toolchain #872
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,33 @@ | ||
| ## 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 | ||
| ## | ||
| ## https://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. | ||
|
|
||
| load("//bazel:defs.bzl", "grpc_web_toolchain") | ||
|
|
||
| # The toolchain type used to distinguish proto toolchains. | ||
| toolchain_type( | ||
| name = "toolchain_type", | ||
| visibility = ["//visibility:public"], | ||
| ) | ||
|
|
||
| grpc_web_toolchain( | ||
| name = "closure_toolchain_impl", | ||
| generator = "//javascript/net/grpc/web:protoc-gen-grpc-web", | ||
| runtime_library = "//javascript/net/grpc/web:closure_grpcweb_runtime", | ||
| ) | ||
|
|
||
| toolchain( | ||
| name = "closure_toolchain", | ||
| toolchain = ":closure_toolchain_impl", | ||
| toolchain_type = ":toolchain_type", | ||
| ) | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,199 +1,20 @@ | ||
| # This rule was inspired by rules_closure`s implementation of | ||
| # |closure_proto_library|, licensed under Apache 2. | ||
| # https://github.com/bazelbuild/rules_closure/blob/3555e5ba61fdcc17157dd833eaf7d19b313b1bca/closure/protobuf/closure_proto_library.bzl | ||
|
|
||
| """Starlark rules for using gRPC-Web with Bazel and `rules_closure`.""" | ||
|
|
||
| load("@io_bazel_rules_closure//closure/compiler:closure_js_library.bzl", "create_closure_js_library") | ||
| load("@io_bazel_rules_closure//closure/private:defs.bzl", "CLOSURE_JS_TOOLCHAIN_ATTRS", "unfurl") # buildifier: disable=bzl-visibility | ||
| load("@io_bazel_rules_closure//closure/protobuf:closure_proto_library.bzl", "closure_proto_aspect") | ||
| load("@rules_proto//proto:defs.bzl", "ProtoInfo") | ||
|
|
||
| # This was borrowed from Rules Go, licensed under Apache 2. | ||
| # https://github.com/bazelbuild/rules_go/blob/67f44035d84a352cffb9465159e199066ecb814c/proto/compiler.bzl#L72 | ||
| def _proto_path(proto): | ||
| path = proto.path | ||
| root = proto.root.path | ||
| ws = proto.owner.workspace_root | ||
| if path.startswith(root): | ||
| path = path[len(root):] | ||
| if path.startswith("/"): | ||
| path = path[1:] | ||
| if path.startswith(ws): | ||
| path = path[len(ws):] | ||
| if path.startswith("/"): | ||
| path = path[1:] | ||
| return path | ||
|
|
||
| def _proto_include_path(proto): | ||
| path = proto.path[:-len(_proto_path(proto))] | ||
| if not path: | ||
| return "." | ||
| if path.endswith("/"): | ||
| path = path[:-1] | ||
| return path | ||
|
|
||
| def _proto_include_paths(protos): | ||
| return [_proto_include_path(proto) for proto in protos] | ||
|
|
||
| def _generate_closure_grpc_web_src_progress_message(proto): | ||
| # TODO(yannic): Add a better message? | ||
| return "Generating GRPC Web for %s" % proto | ||
|
|
||
| def _assert(condition, message): | ||
| if not condition: | ||
| fail(message) | ||
|
|
||
| def _generate_closure_grpc_web_srcs( | ||
| label, | ||
| actions, | ||
| protoc, | ||
| protoc_gen_grpc_web, | ||
| import_style, | ||
| mode, | ||
| sources, | ||
| transitive_sources): | ||
| args = actions.args() | ||
|
|
||
| args.add("--plugin", "protoc-gen-grpc-web=" + protoc_gen_grpc_web.path) | ||
|
|
||
| args.add_all(_proto_include_paths(transitive_sources.to_list()), format_each = "-I%s") | ||
|
|
||
| args.add("--grpc-web_opt", "mode=" + mode) | ||
| if "es6" == import_style: | ||
| args.add("--grpc-web_opt", "import_style=experimental_closure_es6") | ||
| else: | ||
| args.add("--grpc-web_opt", "import_style=" + import_style) | ||
|
|
||
| root = None | ||
|
|
||
| files = [] | ||
| es6_files = [] | ||
| for src in sources: | ||
| basename = src.basename[:-(len(src.extension) + 1)] | ||
|
|
||
| js = actions.declare_file(basename + "_grpc_web_pb.js", sibling = src) | ||
| files.append(js) | ||
|
|
||
| _assert( | ||
| ((root == None) or (root == js.root.path)), | ||
| "proto sources do not have the same root: '{}' != '{}'".format(root, js.root.path), | ||
| ) | ||
| root = js.root.path | ||
|
|
||
| if "es6" == import_style: | ||
| es6 = actions.declare_file(basename + ".pb.grpc-web.js", sibling = src) | ||
| es6_files.append(es6) | ||
|
|
||
| _assert(root == es6.root.path, "ES6 file should have same root: '{}' != '{}'".format(root, es6.root.path)) | ||
|
|
||
| _assert(root, "At least one source file is required") | ||
|
|
||
| args.add("--grpc-web_out", root) | ||
| args.add_all(sources) | ||
|
|
||
| actions.run( | ||
| tools = [protoc_gen_grpc_web], | ||
| inputs = transitive_sources, | ||
| outputs = files + es6_files, | ||
| executable = protoc, | ||
| arguments = [args], | ||
| progress_message = | ||
| _generate_closure_grpc_web_src_progress_message(str(label)), | ||
| ) | ||
|
|
||
| return files, es6_files | ||
|
|
||
| _error_multiple_deps = "".join([ | ||
| "'deps' attribute must contain exactly one label ", | ||
| "(we didn't name it 'dep' for consistency). ", | ||
| "We may revisit this restriction later.", | ||
| ]) | ||
|
|
||
| def _closure_grpc_web_library_impl(ctx): | ||
| if len(ctx.attr.deps) > 1: | ||
| # TODO(yannic): Revisit this restriction. | ||
| fail(_error_multiple_deps, "deps") | ||
|
|
||
| proto_info = ctx.attr.deps[0][ProtoInfo] | ||
| srcs, es6_srcs = _generate_closure_grpc_web_srcs( | ||
| label = ctx.label, | ||
| actions = ctx.actions, | ||
| protoc = ctx.executable._protoc, | ||
| protoc_gen_grpc_web = ctx.executable._protoc_gen_grpc_web, | ||
| import_style = ctx.attr.import_style, | ||
| mode = ctx.attr.mode, | ||
| sources = proto_info.direct_sources, | ||
| transitive_sources = proto_info.transitive_imports, | ||
| ) | ||
|
|
||
| deps = unfurl(ctx.attr.deps, provider = "closure_js_library") | ||
| deps.append(ctx.attr._runtime) | ||
| library = create_closure_js_library( | ||
| ctx = ctx, | ||
| srcs = srcs + es6_srcs, | ||
| deps = deps, | ||
| suppress = [ | ||
| "misplacedTypeAnnotation", | ||
| "unusedPrivateMembers", | ||
| "reportUnknownTypes", | ||
| "strictDependencies", | ||
| "extraRequire", | ||
| ], | ||
| lenient = False, | ||
| ) | ||
|
|
||
| # `rules_closure` still uses the legacy provider syntax. | ||
| # buildifier: disable=rule-impl-return | ||
| return struct( | ||
| exports = library.exports, | ||
| closure_js_library = library.closure_js_library, | ||
| # The usual suspects are exported as runfiles, in addition to raw source. | ||
| runfiles = ctx.runfiles(files = srcs), | ||
| ) | ||
|
|
||
| closure_grpc_web_library = rule( | ||
| implementation = _closure_grpc_web_library_impl, | ||
| attrs = dict({ | ||
| "deps": attr.label_list( | ||
| mandatory = True, | ||
| providers = [ProtoInfo, "closure_js_library"], | ||
| # The files generated by this aspect are required dependencies. | ||
| aspects = [closure_proto_aspect], | ||
| ), | ||
| "import_style": attr.string( | ||
| default = "closure", | ||
| values = [ | ||
| "closure", | ||
|
|
||
| # This is experimental and requires closure-js. | ||
| # We reserve the right to do breaking changes at any time. | ||
| "es6", | ||
| ], | ||
| ), | ||
| "mode": attr.string( | ||
| default = "grpcwebtext", | ||
| values = ["grpcwebtext", "grpcweb"], | ||
| ), | ||
|
|
||
| # Internal only. | ||
|
|
||
| # TODO(yannic): Switch to using `proto_toolchain` after | ||
| # https://github.com/bazelbuild/rules_proto/pull/25 lands. | ||
| "_protoc": attr.label( | ||
| default = Label("@com_google_protobuf//:protoc"), | ||
| executable = True, | ||
| cfg = "host", | ||
| ), | ||
|
|
||
| # TODO(yannic): Create `grpc_web_toolchain`. | ||
| "_protoc_gen_grpc_web": attr.label( | ||
| default = Label("//javascript/net/grpc/web:protoc-gen-grpc-web"), | ||
| executable = True, | ||
| cfg = "host", | ||
| ), | ||
| "_runtime": attr.label( | ||
| default = Label("//javascript/net/grpc/web:closure_grpcweb_runtime"), | ||
| ), | ||
| }, **CLOSURE_JS_TOOLCHAIN_ATTRS), | ||
| ) | ||
| ## 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 | ||
| ## | ||
| ## https://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. | ||
|
|
||
| """Compatibility-export for `closure_grpc_web_library`.""" | ||
|
|
||
| load("//bazel/private/rules:closure_grpc_web_library.bzl", _closure_grpc_web_library = "closure_grpc_web_library") | ||
|
|
||
| # TODO(yannic): Deprecate and remove. | ||
| closure_grpc_web_library = _closure_grpc_web_library |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| ## 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 | ||
| ## | ||
| ## https://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. | ||
|
|
||
| """Starlark rules for using gRPC-Web.""" | ||
|
|
||
| load("//bazel/private/rules:closure_grpc_web_library.bzl", _closure_grpc_web_library = "closure_grpc_web_library") | ||
| load("//bazel/private/rules:grpc_web_toolchain.bzl", _grpc_web_toolchain = "grpc_web_toolchain") | ||
|
|
||
| closure_grpc_web_library = _closure_grpc_web_library | ||
| grpc_web_toolchain = _grpc_web_toolchain |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| # Intentionally left empty (for now). |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I guess my question here is that, do the attribute
generatorandruntime_libraryhave special meaning here? Or it can be any string?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Both attributes are Labels that have to point to targets (just like, e.g,
cc_library'sdeps).generatoralso must be an executable target (e.g.{cc,go,java}_binary) andruntime_librarymust point to aclosure_js_library(compatible) target.