Merge pull request #106 from rules-proto-grpc/dev

3.0.0 release

Author: aaliddell

.bazelci/presubmit.yml

@@ -1,15 +1,14 @@
 dependencies: ['repositories.bzl', '*/repositories.bzl', 'third_party/**/*']
 documentation: ['docs/**/*']
 lang-android: ['android/**/*', 'example/android/**/*', 'tools/rulegen/android.go']
-lang-closure: ['closure/**/*', 'example/closure/**/*', 'tools/rulegen/closure.go']
+lang-c: ['c/**/*', 'example/c/**/*', 'tools/rulegen/c.go']
 lang-cpp: ['cpp/**/*', 'example/cpp/**/*', 'tools/rulegen/cpp.go']
 lang-csharp: ['csharp/**/*', 'example/csharp/**/*', 'tools/rulegen/csharp.go']
 lang-d: ['d/**/*', 'example/d/**/*', 'tools/rulegen/d.go']
 lang-go: ['go/**/*', 'example/go/**/*', 'tools/rulegen/go.go']
 lang-grpc-gateway: ['grpc-gateway/**/*', 'example/grpc-gateway/**/*', 'tools/rulegen/grpc_gateway.go']
-lang-grpc-web: ['grpc-web/**/*', 'example/grpc-web/**/*', 'tools/rulegen/grpc_web.go']
 lang-java: ['java/**/*', 'example/java/**/*', 'tools/rulegen/java.go']
-lang-nodejs: ['nodejs/**/*', 'example/nodejs/**/*', 'tools/rulegen/nodejs.go', 'js/**/*', 'example/js/**/*', 'tools/rulegen/js.go']
+lang-js: ['js/**/*', 'example/js/**/*', 'tools/rulegen/js.go', 'tools/rulegen/grpc-web.go']
 lang-objc: ['objc/**/*', 'example/objc/**/*', 'tools/rulegen/objc.go']
 lang-php: ['php/**/*', 'example/php/**/*', 'tools/rulegen/php.go']
 lang-python: ['python/**/*', 'example/python/**/*', 'tools/rulegen/python.go']

.bazelrc

@@ -25,5 +25,6 @@ jobs:
         "${GITHUB_WORKSPACE}/bin/bazel" run --run_under="cd $PWD && " //tools/rulegen -- --ref=`git describe --abbrev=0 --tags`
         rm available_tests.txt
         git checkout -- README.md
+        make buildifier
         git diff
         git diff-files --quiet

.github/labeler.yml

@@ -6,4 +6,4 @@ available_tests.txt
 .ipynb_checkpoints
 csharp/nuget/nuget2config.json
 ruby/.bundle
-nodejs/requirements/yarn-error.log
+js/requirements/yarn-error.log

.github/workflows/ci.yml

@@ -1,10 +1,169 @@
 # Changelog
 
-## Unreleased
+## 3.0.0
+
+This update brings some major improvements to rules_proto_grpc and solves many of the longstanding issues that have been
+present. However, in doing so there have been some changes that make a major version increment necessary and may require
+updates to your build files. The updates for each language are explained below and should you have any issues, please
+open a new [issue](https://github.com/rules-proto-grpc/rules_proto_grpc/issues/new) or
+[discussion](https://github.com/rules-proto-grpc/rules_proto_grpc/discussions/new).
+
+The most substantial change is that compilation of .proto files into language specific files is no longer transitive.
+This means that only the direct dependencies of a `lang_proto_library` will be present within the generated library,
+rather than every transitive proto message. The justification for this is below, but if you're just interested in the
+changes, you can skip down to the next heading.
+
+In previous versions of rules_proto_grpc, the compilation aspect would compile and aggregate all dependent .proto files
+from any top level target. In hindsight, this was not the correct behaviour and led to many bugs, since you may end up
+creating a library that contains compiled proto files from a third party, where you should instead be depending on a
+proper library for that third party's protos.
+
+Even in a single repo, this may have meant multiple copies of a single compiled proto file being present in a target, if
+it is depended on via multiple routes. For some languages, such as C++, this breaks the 'one definition rule' and
+produces compilation failures or runtime bugs. For other languages, such as Python, this just meant unnecessary
+duplicate files in the output binaries.
+
+Therefore, in this release of rules_proto_grpc, there is now a recommedned option to bundle only the direct proto
+dependencies into  the libraries, without including the compiled transitive proto files. This is done by replacing the
+`deps` attr on `lang_{proto|grpc}_{compile|library}` with the `protos` attr. Since this would be a substantial breaking
+change to drop at once on a large project, the new behaviour is opt-in in 3.0.0 and the old method continues to work
+throughout the 3.x.x release cycle. Rules using the previous deps attr will have a warning written to console to signify
+that your library may be bundling more than expect and should switch attr.
+
+As an additional benefit of this change, we can now support passing arbitrary per-target rules to protoc through the new
+`options` attr of the rules, which was a much sought after change that was impossible in the aspect based compilation.
+
+### Switching to non-transitive compilation
+
+In short, replace `deps` with `protos` on your targets:
+
+```starlark
+# Old
+python_grpc_library(
+    name = "routeguide",
+    deps = ["//example/proto:routeguide_proto"],
+)
+
+# New
+python_grpc_library(
+    name = "routeguide",
+    protos = ["//example/proto:routeguide_proto"],
+)
+```
+
+In applying the above change, you may discover that you were inheriting dependencies transitively and that your builds
+now fail. In such cases, you should add a `lang_{proto|grpc}_{compile|library}` target for those proto files and
+depend on it explicitly from the relevant top level binaries/libraries.
+
+### General Changes
+- Updated protobuf to 3.15.1
+- Updated gRPC to 1.35.0
+- All rules have new per-target `options` and `extra_protoc_args` attributes to control options to protoc
+  [#54](https://github.com/rules-proto-grpc/rules_proto_grpc/issues/54)
+  [#68](https://github.com/rules-proto-grpc/rules_proto_grpc/issues/68)
+  [#105](https://github.com/rules-proto-grpc/rules_proto_grpc/issues/105)
+- Updated `rules_proto` to latest head
+- `aspect.bzl` and `plugin.bzl` have merged to a single top level `defs.bzl`
+- The minimum supported Bazel version is 3.0.0. Some language specific rules may require 4.0.0
 
+### Android
+- **WORKSPACE update needed**: The WORKSPACE imports necessary for Android rules have been updated due to upstream
+  changes in `grpc-java`. Please see the examples for the latest WORKSPACE template for the Android rules
+
+### C
+- Added experimental rules for C using upb [#20](https://github.com/rules-proto-grpc/rules_proto_grpc/issues/20)
+
+### C++
+- Non-transitive mode resolves issue where the same proto may be defined more than once
+  [#25](https://github.com/rules-proto-grpc/rules_proto_grpc/issues/25)
+- Header and source files are now correctly passed to the underlying `cc_library` rule
+  [#40](https://github.com/rules-proto-grpc/rules_proto_grpc/issues/40)
+
+### Closure
+- Closure rules have been removed. In practice these have been superceded by the Javascript rules, but if you are an
+  active user of these rules please open a discussion.
+
+### C#
+- Updated `rules_dotnet` to 0.0.7. Note that the new versions of `rules_dotnet` drop support for .Net Framework and
+  Mono and require use of alternate platforms. Please see the examples for the latest WORKSPACE template for the
+  C# rules
+- Updated `Grpc` to 2.35.0
+
+### D
+- Updated `rules_d` to latest
+
+### Go
+- Updated `rules_go` to 0.25.1
+- **WORKSPACE update needed**: It is now necessary to specify `version` to `go_register_toolchains`
+- The plugin used for compiling .proto files for Go has switched to the new google.golang.org/protobuf
+  [#85](https://github.com/rules-proto-grpc/rules_proto_grpc/issues/85)
+- Updated `gazelle` to 0.22.3
+- Updated `org_golang_x_net` to v0.0.0-20210129194117-4acb7895a057
+- Updated `org_golang_x_text` to 0.3.5
+- Well-known types are now depended on by default
+- Removed support for GoGo rules
+
+### grpc-gateway
+- Updated `grpc-gateway` to 2.2.0
+- The `gateway_swagger_compile` rule has been replaced with `gateway_openapiv2_compile`
+  [#93](https://github.com/rules-proto-grpc/rules_proto_grpc/issues/93)
+- The grpc-gateway rules have move to repo top level, meaning they are no longer under the `github.com/...` prefix. To
+  Update your use of these rules find and replace `@rules_proto_grpc//github.com/grpc-ecosystem/grpc-gateway` with
+  `@rules_proto_grpc//grpc-gateway`
+
+### gRPC-Web
+- The gRPC-Web rules have moved into `//js`
+- Text mode generation is now supported [#59](https://github.com/rules-proto-grpc/rules_proto_grpc/issues/59)
+
+### Java
+- **WORKSPACE update needed**: The WORKSPACE imports necessary for Java rules have been updated due to upstream
+  changes in `grpc-java`. Please see the examples for the latest WORKSPACE template for the Java rules
+
+### NodeJS/JavaScript
+- The JavaScript rules have moved from `@rules_proto_grpc//nodejs` to `@rules_proto_grpc//js`, but the old rules are
+  still aliased to ease transition
+- Updated `rules_nodejs` to 3.1.0
+- Updated `@grpc/grpc-js` to 1.2.6
+- Added typescript generation to JS rules
+
+### Objective-C
 - Added `copt` argument pass-through for Obj-C library rules.
-- Added `CHANGELOG.md`
+- Header and source files are now correctly passed to the underlying `cc_library` rule
+  [#40](https://github.com/rules-proto-grpc/rules_proto_grpc/issues/40)
+
+### Python
+- Updated `rules_python` to latest
+- **WORKSPACE update needed**: `py_repositories` from `rules_python` is no longer required
+
+### Ruby
+- The Ruby rules have migrated from `yugui/rules_ruby` to `bazelruby/rules_ruby`
+- Changes `rules_proto_grpc_gems` to `rules_proto_grpc_bundle`
+- **WORKSPACE update needed**: The above changes requiresupdates to your WORKSPACE, please see the examples for the
+  latest WORKSPACE template for the Ruby rules
+- **Open issue**: The `grpc` gem may not be loadable in generated Ruby libraries, please see
+  [this issue](https://github.com/rules-proto-grpc/rules_proto_grpc/issues/65).
+
+### Rust
+- **WORKSPACE update needed**: The upstream repo `io_bazel_rules_rust` has been renamed to `rules_rust`. The
+  `rust_workspace` rule is also no longer required
+- Updated `rules_rust` to latest
+- Updated `grpcio` to 0.7.1
+- Updated `protobuf` to 2.20.0
+
+### Scala
+- Update `rules_scala` to latest [#108](https://github.com/rules-proto-grpc/rules_proto_grpc/issues/108)
+- **WORKSPACE update needed**: The `scala_config` rule from `rules_scala` is now required in your WORKSPACE
+
+### Swift
+- Updated `rules_swift` to 0.18.0
+- Updated `grpc-swift` to 1.0.0
+- Visibility of generated types is now configurable with `options`
+  [#111](https://github.com/rules-proto-grpc/rules_proto_grpc/issues/111)
+
+### Thanks
+Thanks to everyone who has contributed issues and patches for this release.
 
+---
 
 ## 2.0.0
 
@@ -82,6 +241,7 @@
 - Updated `grpc-swift` to 0.11.0
 - Moved the Swift library rules to be internal to this repo
 
+---
 
 ## 1.0.2
 
@@ -91,6 +251,7 @@
 - Replaced Maven HTTP URLs with HTTPS URLs
 - Updated grpc-java, rules_closure and rules_scala to include Maven HTTPS fix
 
+---
 
 ## 1.0.1
 
@@ -99,6 +260,7 @@
 - Fix support for plugins that use `output_directory` and produce no output files: #39 
 - Misc typo fixes and tidying
 
+---
 
 ## 1.0.0
 
@@ -135,6 +297,7 @@
 - Scala gRPC rules are currently not working fully. Due to delays in publishing support for Bazel 1.0, this support has been pushed back to 1.1.0
 - The required WORKSPACE rules has been updated for all Scala rules, please check the documentation for the current recommended set
 
+---
 
 ## 0.2.0
 
@@ -146,7 +309,8 @@
 - The naming of the Ruby gems workspace has changed to remove the 'routeguide' prefix
 - Ruby client/server is now included in the non-manual test matrix
 
+---
 
-# 0.1.0
+## 0.1.0
 
 Initial release of `rules_proto_grpc`. For changes from predecessor `rules_proto`, please see [MIGRATION.md](https://github.com/rules-proto-grpc/rules_proto_grpc/blob/master/docs/MIGRATION.md)

.gitignore

@@ -6,26 +6,34 @@ rulegen:
 	rm available_tests.txt; \
 
 
+# Apply buildifier
+buildifier:
+	bazel run //tools:buildifier
+
+
 # Run cargo raze on the rust dependencies
 .PHONY: rust_raze
 rust_raze:
 	cd rust/raze; \
 	rm Cargo.lock; \
 	rm -r remote; \
-	cargo raze;
+	cargo raze; \
+	sed -i -e 's/io_bazel_rules_rust/rules_rust/g' rust/raze/remote/*.bazel;
 
 
-# Run yarn to upgrade the nodejs dependencies
+# Run yarn to upgrade the js dependencies
 .PHONY: yarn_upgrade
 yarn_upgrade:
-	cd nodejs/requirements; \
+	cd js/requirements; \
+	rm yarn.lock; \
 	yarn install; \
 
 
 # Run bundle to upgrade the Ruby dependencies
 .PHONY: ruby_bundle_upgrade
 ruby_bundle_upgrade:
 	cd ruby; \
+	rm Gemfile.lock; \
 	bundle install --path /tmp/ruby-bundle; \
 
 
@@ -71,7 +79,6 @@ servers:
 .PHONY: tests
 tests:
 	bazel test \
-		//closure/example/routeguide/... \
 		//cpp/example/routeguide/... \
 		//java/example/routeguide/... \
 		//go/example/routeguide/... \
@@ -80,16 +87,14 @@ tests:
 pending_clients:
 	bazel build \
 		//android/example/routeguide:client \
-		//closure/example/routeguide/client \
-		//nodejs/example/routeguide:client \
+		//js/example/routeguide:client \
 		//ruby/example/routeguide:client \
-		//github.com/grpc/grpc-web/example/routeguide/closure:bundle \
 		//rust/example/routeguide:client
 
 .PHONY: pending_servers
 pending_servers:
 	bazel build \
-		//nodejs/example/routeguide:server \
+		//js/example/routeguide:server \
 		//ruby/example/routeguide:server \
 		//rust/example/routeguide:server