refactor: pre-1.0 release breaking changes

gregmagolan · alexeagle · commit cc6481831608 · 2019-12-17T09:07:53.000-08:00
BREAKING CHANGE:
//:declaration_provider.bzl deleted; load from //:providers.bzl instead
//internal/common:npm_pacakge_info.bzl removed; load from //:providers.bzl instead
transitive_js_ecma_script_module_info macro removed; use js_ecma_script_module_info instead
@npm_bazel_karma//:browser_repositories.bzl removed; use @io_bazel_rules_webtesting//web/versioned:browsers-0.3.2.bzl instead
@npm_bazel_protractor//:browser_repositories.bzl removed; use @io_bazel_rules_webtesting//web/versioned:browsers-0.3.2.bzl instead
ts_web_test &amp; ts_web_test_suite marcos removed; use karma_web_test &amp; karma_web_test_suite instead
diff --git a/BUILD.bazel b/BUILD.bazel
@@ -38,7 +38,6 @@ exports_files([
 bzl_library(
     name = "bzl",
     srcs = [
-        "declaration_provider.bzl",
         "index.bzl",
         "index.for_docs.bzl",
         "providers.bzl",
diff --git a/WORKSPACE b/WORKSPACE
@@ -114,6 +114,8 @@ install_bazel_dependencies()
 git_repository(
     name = "build_bazel_rules_typescript",
     commit = "951ae46a9651e9f6814b303c5902d858cc509aa4",
+    patch_args = ["-p1"],
+    patches = ["//:rules_typescript.patch"],
     remote = "http://github.com/bazelbuild/rules_typescript.git",
 )
 
diff --git a/declaration_provider.bzl b/declaration_provider.bzl
diff --git a/examples/user_managed_deps/WORKSPACE b/examples/user_managed_deps/WORKSPACE
@@ -68,6 +68,8 @@ local_repository(
 git_repository(
     name = "build_bazel_rules_typescript",
     commit = "951ae46a9651e9f6814b303c5902d858cc509aa4",
+    patch_args = ["-p1"],
+    patches = ["//:rules_typescript.patch"],
     remote = "http://github.com/bazelbuild/rules_typescript.git",
 )
 
diff --git a/examples/user_managed_deps/rules_typescript.patch b/examples/user_managed_deps/rules_typescript.patch
@@ -0,0 +1,13 @@
+diff --git a/internal/common/compilation.bzl b/internal/common/compilation.bzl
+index e815f37..a2b6468 100644
+--- a/internal/common/compilation.bzl
++++ b/internal/common/compilation.bzl
+@@ -17,7 +17,7 @@
+ 
+ load(":common/json_marshal.bzl", "json_marshal")
+ load(":common/module_mappings.bzl", "module_mappings_aspect")
+-load("@build_bazel_rules_nodejs//:declaration_provider.bzl", "DeclarationInfo")
++load("@build_bazel_rules_nodejs//:providers.bzl", "DeclarationInfo")
+ 
+ _DEBUG = False
+ 
diff --git a/examples/web_testing/WORKSPACE b/examples/web_testing/WORKSPACE
@@ -45,10 +45,9 @@ load("@io_bazel_rules_webtesting//web:repositories.bzl", "web_test_repositories"
 
 web_test_repositories()
 
-# Note: intentionally loads from the deprecated location to assert that it still works
-load("@npm_bazel_karma//:browser_repositories.bzl", "browser_repositories")
+load("@io_bazel_rules_webtesting//web/versioned:browsers-0.3.2.bzl", "browser_repositories")
 
-browser_repositories()
+browser_repositories(chromium = True)
 
 load("@npm_bazel_typescript//:index.bzl", "ts_setup_workspace")
 
diff --git a/examples/webapp/WORKSPACE b/examples/webapp/WORKSPACE
@@ -46,7 +46,6 @@ load("@io_bazel_rules_webtesting//web:repositories.bzl", "web_test_repositories"
 
 web_test_repositories()
 
-# Note: intentionally loads from the deprecated location to assert that it still works
-load("@npm_bazel_protractor//:browser_repositories.bzl", "browser_repositories")
+load("@io_bazel_rules_webtesting//web/versioned:browsers-0.3.2.bzl", "browser_repositories")
 
-browser_repositories()
+browser_repositories(chromium = True)
diff --git a/internal/common/npm_package_info.bzl b/internal/common/npm_package_info.bzl
diff --git a/internal/providers/js_providers.bzl b/internal/providers/js_providers.bzl
@@ -95,10 +95,3 @@ Returns a single JSEcmaScriptModuleInfo.
         direct_sources = sources,
         sources = depset(transitive = transitive_depsets),
     )
-
-def transitive_js_ecma_script_module_info(**kwargs):
-    """Alias of js_ecma_script_module_info.
-
-TODO(gregmagolan): Remove this alias before 1.0 release.
-"""
-    return js_ecma_script_module_info(**kwargs)
diff --git a/packages/karma/docs/install.md b/packages/karma/docs/install.md
@@ -28,12 +28,13 @@ Finally, configure the rules_webtesting:
 
 ```python
 # Set up web testing, choose browsers we can test on
-load("@io_bazel_rules_webtesting//web:repositories.bzl", "browser_repositories", "web_test_repositories")
+load("@io_bazel_rules_webtesting//web:repositories.bzl", "web_test_repositories")
 
 web_test_repositories()
-browser_repositories(
-    chromium = True,
-)
+
+load("@io_bazel_rules_webtesting//web/versioned:browsers-0.3.2.bzl", "browser_repositories")
+
+browser_repositories(chromium = True)
 ```
 
 ## Installing with self-managed dependencies
diff --git a/packages/karma/src/BUILD.bazel b/packages/karma/src/BUILD.bazel
@@ -75,7 +75,6 @@ filegroup(
     name = "package_contents",
     srcs = [
         "WORKSPACE",
-        "browser_repositories.bzl",
         "index.bzl",
         "karma.conf.js",
         "karma_web_test.bzl",
diff --git a/packages/karma/src/browser_repositories.bzl b/packages/karma/src/browser_repositories.bzl
diff --git a/packages/karma/src/index.bzl b/packages/karma/src/index.bzl
@@ -25,28 +25,3 @@ karma_web_test = _karma_web_test
 karma_web_test_suite = _karma_web_test_suite
 # DO NOT ADD MORE rules here unless they appear in the generated docsite.
 # Run yarn skydoc to re-generate the docsite.
-
-# TODO(gregmagolan): remove ts_web_test & ts_web_test_suite entirely for 1.0 release
-def ts_web_test(**kwargs):
-    """This rule has been removed. Replace with karma_web_test"""
-
-    fail("""***********
-        
-The ts_web_test rule has been removed.
-
-The existing karma_web_test rule with an identical API should be used instead.
-It can be loaded from `load("@npm_bazel_karma//:index.bzl", "karma_web_test")`.
-************
-""")
-
-def ts_web_test_suite(**kwargs):
-    """This rule has been removed. Replace with ts_web_test_suite"""
-
-    fail("""***********
-        
-The ts_web_test_suite rule has been removed.
-
-The existing karma_web_test_suite rule with an identical API should be used instead.
-It can be loaded from `load("@npm_bazel_karma//:index.bzl", "karma_web_test_suite")`.
-************
-""")
diff --git a/packages/protractor/src/BUILD.bazel b/packages/protractor/src/BUILD.bazel
@@ -45,7 +45,6 @@ stardoc(
 filegroup(
     name = "package_contents",
     srcs = [
-        "browser_repositories.bzl",
         "index.bzl",
         "package.bzl",
         "package.json",
diff --git a/packages/protractor/src/browser_repositories.bzl b/packages/protractor/src/browser_repositories.bzl
diff --git a/providers.bzl b/providers.bzl
@@ -28,7 +28,6 @@ load(
     _JSNamedModuleInfo = "JSNamedModuleInfo",
     _js_ecma_script_module_info = "js_ecma_script_module_info",
     _js_named_module_info = "js_named_module_info",
-    _transitive_js_ecma_script_module_info = "transitive_js_ecma_script_module_info",
 )
 load(
     "//internal/providers:node_runtime_deps_info.bzl",
@@ -47,7 +46,6 @@ JSNamedModuleInfo = _JSNamedModuleInfo
 js_named_module_info = _js_named_module_info
 JSEcmaScriptModuleInfo = _JSEcmaScriptModuleInfo
 js_ecma_script_module_info = _js_ecma_script_module_info
-transitive_js_ecma_script_module_info = _transitive_js_ecma_script_module_info
 NpmPackageInfo = _NpmPackageInfo
 node_modules_aspect = _node_modules_aspect
 
@@ -57,6 +55,5 @@ NodeContextInfo = provider(
     fields = ["stamp"],
 )
 
-# TODO: remove transitive_js_ecma_script_module_info alias before 1.0 release
 NodeRuntimeDepsInfo = _NodeRuntimeDepsInfo
 run_node = _run_node
diff --git a/rules_typescript.patch b/rules_typescript.patch
@@ -0,0 +1,13 @@
+diff --git a/internal/common/compilation.bzl b/internal/common/compilation.bzl
+index e815f37..a2b6468 100644
+--- a/internal/common/compilation.bzl
++++ b/internal/common/compilation.bzl
+@@ -17,7 +17,7 @@
+ 
+ load(":common/json_marshal.bzl", "json_marshal")
+ load(":common/module_mappings.bzl", "module_mappings_aspect")
+-load("@build_bazel_rules_nodejs//:declaration_provider.bzl", "DeclarationInfo")
++load("@build_bazel_rules_nodejs//:providers.bzl", "DeclarationInfo")
+ 
+ _DEBUG = False
+ 

Original file line number	Diff line number	Diff line change
`@@ -114,6 +114,8 @@ install_bazel_dependencies()`
`114`	`114`	`git_repository(`
`115`	`115`	`name = "build_bazel_rules_typescript",`
`116`	`116`	`commit = "951ae46a9651e9f6814b303c5902d858cc509aa4",`
	`117`	`+ patch_args = ["-p1"],`
	`118`	`+ patches = ["//:rules_typescript.patch"],`
`117`	`119`	`remote = "http://github.com/bazelbuild/rules_typescript.git",`
`118`	`120`	`)`
`119`	`121`
Original file line number	Diff line number	Diff line change
`@@ -68,6 +68,8 @@ local_repository(`
`68`	`68`	`git_repository(`
`69`	`69`	`name = "build_bazel_rules_typescript",`
`70`	`70`	`commit = "951ae46a9651e9f6814b303c5902d858cc509aa4",`
	`71`	`+ patch_args = ["-p1"],`
	`72`	`+ patches = ["//:rules_typescript.patch"],`
`71`	`73`	`remote = "http://github.com/bazelbuild/rules_typescript.git",`
`72`	`74`	`)`
`73`	`75`