Custom phases expose custom providers (#946)

* rules_scala custom phases should expose providers- failing test

* rules_scala custom phases should expose providers- passing test
while doing it I found and fixed a bug in phases adjustments of first/last (they were duplicated)
Additionally this mandates bazel 2.0.0 as they have some kind of bug with providers before that (don't have an issue to ref but couldn't get the build to pass with lower bazel version)

* update readme to note when we stopped fully supporting 1.1.0

* remove unneeded 1.2.1 shas

* drop 1.1.0 travis builds

* remove 1.1.0 from bazel wrapper

* break after adding positional phase

* rule_providers to external_providers

Author: ittaiz

.travis.yml

@@ -48,20 +48,12 @@ jobs:
       <<: *linux
       env: TEST_SCRIPT=test_lint
 # Test
-    - <<: *linux
-      env: TEST_SCRIPT=test_rules_scala BAZEL_VERSION=1.1.0
     - <<: *linux
       env: TEST_SCRIPT=test_rules_scala BAZEL_VERSION=2.0.0
-    - <<: *linux
-      env: TEST_SCRIPT=test_reproducibility BAZEL_VERSION=1.1.0
     - <<: *linux
       env: TEST_SCRIPT=test_reproducibility BAZEL_VERSION=2.0.0
-    - <<: *osx
-      env: TEST_SCRIPT=test_rules_scala BAZEL_VERSION=1.1.0
     - <<: *osx
       env: TEST_SCRIPT=test_rules_scala BAZEL_VERSION=2.0.0
-    - <<: *osx
-      env: TEST_SCRIPT=test_reproducibility BAZEL_VERSION=1.1.0
     - <<: *osx
       env: TEST_SCRIPT=test_reproducibility BAZEL_VERSION=2.0.0
 

README.md

@@ -112,7 +112,7 @@ for an example workspace using another scala version.
 | bazel  | rules_scala gitsha |
 |--------|--------------------|
 | 2.0.0  | HEAD               |
-| 1.1.0  | HEAD               |
+| 1.1.0  | d681a952da74fc61a49fc3167b03548f42fc5dde |
 | 0.28.1 | bd0c388125e12f4f173648fc4474f73160a5c628 |
 | 0.23.x | ca655e5a330cbf1d66ce1d9baa63522752ec6011 |
 | 0.22.x | f3113fb6e9e35cb8f441d2305542026d98afc0a2 |

scala/private/phases/api.bzl

@@ -22,18 +22,22 @@ def _adjust_phases(phases, adjustments):
     # phase_name: the name of the new phase, also used to access phase information
     # phase_function: the function of the new phase
     for (relation, peer_name, phase_name, phase_function) in adjustments:
-        for idx, (needle, _) in enumerate(phases):
-            if relation in ["^", "first"]:
-                phases.insert(0, (phase_name, phase_function))
-            elif relation in ["$", "last"]:
-                phases.append((phase_name, phase_function))
-            elif needle == peer_name:
-                if relation in ["-", "before"]:
-                    phases.insert(idx, (phase_name, phase_function))
-                elif relation in ["+", "after"]:
-                    phases.insert(idx + 1, (phase_name, phase_function))
-                elif relation in ["=", "replace"]:
-                    phases[idx] = (phase_name, phase_function)
+        if relation in ["^", "first"]:
+            phases.insert(0, (phase_name, phase_function))
+        elif relation in ["$", "last"]:
+            phases.append((phase_name, phase_function))
+        else:
+            for idx, (needle, _) in enumerate(phases):
+                if needle == peer_name:
+                    if relation in ["-", "before"]:
+                        phases.insert(idx, (phase_name, phase_function))
+                        break
+                    elif relation in ["+", "after"]:
+                        phases.insert(idx + 1, (phase_name, phase_function))
+                        break
+                    elif relation in ["=", "replace"]:
+                        phases[idx] = (phase_name, phase_function)
+                        break
     return phases
 
 # Execute phases
@@ -59,18 +63,21 @@ def run_phases(ctx, builtin_customizable_phases, fixed_phase):
     # A placeholder for data shared with later phases
     global_provider = {}
     current_provider = struct(**global_provider)
+    acculmulated_external_providers = []
     for (name, function) in adjusted_phases + [fixed_phase]:
         # Run a phase
         new_provider = function(ctx, current_provider)
 
         # If a phase returns data, append it to global_provider
         # for later phases to access
         if new_provider != None:
+            if (hasattr(new_provider, "external_providers")):
+                acculmulated_external_providers.extend(new_provider.external_providers)
             global_provider[name] = new_provider
             current_provider = struct(**global_provider)
 
     # The final return of rules implementation
-    return current_provider
+    return acculmulated_external_providers + current_provider.final
 
 # A method to pass in phase provider
 def extras_phases(extras):

scala/private/rules/scala_binary.bzl

@@ -45,7 +45,7 @@ def _scala_binary_impl(ctx):
         ],
         # fixed phase
         ("final", phase_binary_final),
-    ).final
+    )
 
 _scala_binary_attrs = {
     "main_class": attr.string(mandatory = True),

scala/private/rules/scala_junit_test.bzl

@@ -50,7 +50,7 @@ def _scala_junit_test_impl(ctx):
         ],
         # fixed phase
         ("final", phase_binary_final),
-    ).final
+    )
 
 _scala_junit_test_attrs = {
     "prefixes": attr.string_list(default = []),

scala/private/rules/scala_library.bzl

@@ -69,7 +69,7 @@ def _scala_library_impl(ctx):
         ],
         # fixed phase
         ("final", phase_library_final),
-    ).final
+    )
 
 _scala_library_attrs = {}
 
@@ -146,7 +146,7 @@ def _scala_library_for_plugin_bootstrapping_impl(ctx):
         ],
         # fixed phase
         ("final", phase_library_final),
-    ).final
+    )
 
 # the scala compiler plugin used for dependency analysis is compiled using `scala_library`.
 # in order to avoid cyclic dependencies `scala_library_for_plugin_bootstrapping` was created for this purpose,
@@ -202,7 +202,7 @@ def _scala_macro_library_impl(ctx):
         ],
         # fixed phase
         ("final", phase_library_final),
-    ).final
+    )
 
 _scala_macro_library_attrs = {
     "main_class": attr.string(),

scala/private/rules/scala_repl.bzl

@@ -46,7 +46,7 @@ def _scala_repl_impl(ctx):
         ],
         # fixed phase
         ("final", phase_binary_final),
-    ).final
+    )
 
 _scala_repl_attrs = {
     "jvm_flags": attr.string_list(),

scala/private/rules/scala_test.bzl

@@ -47,7 +47,7 @@ def _scala_test_impl(ctx):
         ],
         # fixed phase
         ("final", phase_scalatest_final),
-    ).final
+    )
 
 _scala_test_attrs = {
     "main_class": attr.string(

test/phase/providers/BUILD.bazel

@@ -0,0 +1,15 @@
+load(":phase_providers_expose.bzl", "phase_expose_provider_singleton", "rule_that_needs_custom_provider", "scala_library_that_exposes_custom_provider")
+
+scala_library_that_exposes_custom_provider(
+    name = "scala_library_that_exposes_custom_provider",
+)
+
+rule_that_needs_custom_provider(
+    name = "rule_that_needs_custom_provider",
+    dep = ":scala_library_that_exposes_custom_provider",
+)
+
+phase_expose_provider_singleton(
+    name = "phase_expose_provider_singleton_target",
+    visibility = ["//visibility:public"],
+)

test/phase/providers/phase_providers_expose.bzl

@@ -0,0 +1,42 @@
+load("@io_bazel_rules_scala//scala:advanced_usage/providers.bzl", "ScalaRulePhase")
+load("@io_bazel_rules_scala//scala:advanced_usage/scala.bzl", "make_scala_library")
+
+ext_phase_expose_provider = {
+    "phase_providers": [
+        "//test/phase/providers:phase_expose_provider_singleton_target",
+    ],
+}
+
+scala_library_that_exposes_custom_provider = make_scala_library(ext_phase_expose_provider)
+
+_some_position = "last"  #last position is just because a location is mandatory, not important
+
+def _phase_expose_provider_singleton_implementation(ctx):
+    return [
+        ScalaRulePhase(
+            custom_phases = [
+                (_some_position, "", "phase_expose_provider", _phase_expose_provider),
+            ],
+        ),
+    ]
+
+phase_expose_provider_singleton = rule(
+    implementation = _phase_expose_provider_singleton_implementation,
+)
+
+CustomProviderExposedByPhase = provider()
+
+def _phase_expose_provider(ctx, p):
+    return struct(
+        external_providers = [CustomProviderExposedByPhase()],
+    )
+
+def _rule_that_needs_custom_provider_impl(ctx):
+    return []
+
+rule_that_needs_custom_provider = rule(
+    implementation = _rule_that_needs_custom_provider_impl,
+    attrs = {
+        "dep": attr.label(providers = [CustomProviderExposedByPhase]),
+    },
+)