Jar licensing (digital-asset#17299)

* Add _distribute.jar target with correct license Use it everywhere * Fixes from review * Change NOTICES to NOTICES.txt for consistency
kgeonw · Aug 22, 2023 · 9179b2e · 9179b2e
1 parent 73c4f71
commit 9179b2e
Show file tree

Hide file tree

Showing 30 changed files with 135 additions and 84 deletions.
diff --git a/BAZEL.md b/BAZEL.md
@@ -70,9 +70,9 @@ da_scala_binary(
     runtime_deps = [
         "@maven//:ch_qos_logback_logback_classic",
     ],
+    tags = ["ee-jar-license"],
     deps = [
         ":script-runner-lib",
-        "//release:ee-license",
     ],
 )
 ```
@@ -924,7 +924,10 @@ JAR suitable for deployment for all your Java and Scala targets. For example,
 if you defined a Scala executable target called `foo`, then Bazel will generate
 the target `foo_deploy.jar` next to the regular `foo.jar` target. Building the
 `foo_deploy.jar` target will generate a self-contained fat JAR suitable to be
-passed to `java -jar`.
+passed to `java -jar`. When using `da_scala_binary`, we also generate a 
+`foo_distribute.jar` which takes the deployment jar and fixes the notices and
+licenses. It will check for the `ee-jar-license` tag to decide whether to use
+the default apache license, or our Enterprise Edition license.
 
 ### Scaladoc
 

diff --git a/bazel_tools/BUILD.bazel b/bazel_tools/BUILD.bazel
@@ -17,6 +17,7 @@ exports_files(
         "haskell-win-sys-includes.patch",
         "haskell-drop-fake-static.patch",
         "pom_template.xml",
+        "distribute_jar_cleanup.sh",
     ],
     visibility = ["//:__subpackages__"],
 )

diff --git a/bazel_tools/distribute_jar_cleanup.sh b/bazel_tools/distribute_jar_cleanup.sh
@@ -0,0 +1,27 @@
+#!/bin/bash
+# Copyright (c) 2023 Digital Asset (Switzerland) GmbH and/or its affiliates. All rights reserved.
+# SPDX-License-Identifier: Apache-2.0
+
+
+SRC=$1
+OUT=$2
+NOTICES=$3
+LICENSE=$4
+LICENSE_EE=$5
+IS_EE=$6
+
+cp $SRC $OUT
+chmod +w $OUT
+zip -dq $OUT "/LICENSE*" "/META-INF/LICENSE*" "/NOTICE*" "/META-INF/NOTICE*"
+
+# both licenses have the wrong file name/directory, so we copy to a temp dir
+TMP_LICENSE_DIR=$(mktemp -d)
+cp $NOTICES $TMP_LICENSE_DIR/NOTICES.txt
+if [[ "$IS_EE" -eq 1 ]]; then
+  cp $LICENSE_EE $TMP_LICENSE_DIR/LICENSE.txt
+else
+  cp $LICENSE $TMP_LICENSE_DIR/LICENSE.txt
+fi
+zip -ujq $OUT $TMP_LICENSE_DIR/LICENSE.txt $TMP_LICENSE_DIR/NOTICES.txt
+rm -rf $TMP_LICENSE_DIR
+
diff --git a/bazel_tools/scala.bzl b/bazel_tools/scala.bzl
@@ -655,7 +655,11 @@ def da_scala_binary(name, initial_heap_size = default_initial_heap_size, max_hea
     arguments = _set_jvm_flags(arguments, initial_heap_size = initial_heap_size, max_heap_size = max_heap_size)
     _wrap_rule(scala_binary, name, **arguments)
 
+    is_ee = 0
+
     if "tags" in arguments:
+        if "ee-jar-license" in arguments["tags"]:
+            is_ee = 1
         for tag in arguments["tags"]:
             if tag.startswith("maven_coordinates="):
                 pom_file(
@@ -676,6 +680,28 @@ def da_scala_binary(name, initial_heap_size = default_initial_heap_size, max_hea
                 )
                 break
 
+    native.genrule(
+        name = name + "_distribute",
+        srcs = [":" + name + "_deploy.jar"],
+        tools = [
+            "//bazel_tools:distribute_jar_cleanup.sh",
+            "//:NOTICES",
+            "//:LICENSE",
+            "//release:ee-license.txt",
+        ],
+        outs = [name + "_distribute.jar"],
+        cmd = """
+$(location //bazel_tools:distribute_jar_cleanup.sh)\
+  $(location :{name}_deploy.jar)\
+  $(location :{name}_distribute.jar)\
+  $(location //:NOTICES)\
+  $(location //:LICENSE)\
+  $(location //release:ee-license.txt)\
+  {is_ee}
+""".format(name = name, is_ee = is_ee),
+        visibility = arguments.get("visibility"),
+    )
+
 def da_scala_test(initial_heap_size = default_initial_heap_size, max_heap_size = default_max_heap_size, **kwargs):
     """
     Define a Scala executable that runs the unit tests in the given source files.

diff --git a/ci/copy-unix-release-artifacts.sh b/ci/copy-unix-release-artifacts.sh
@@ -34,34 +34,34 @@ if [[ "$NAME" == "linux" ]]; then
 
     JSON_API=http-json-$RELEASE_TAG.jar
     JSON_API_EE=http-json-$RELEASE_TAG-ee.jar
-    bazel build //ledger-service/http-json:http-json-binary_deploy.jar
-    cp bazel-bin/ledger-service/http-json/http-json-binary_deploy.jar $OUTPUT_DIR/github/$JSON_API
-    bazel build //ledger-service/http-json:http-json-binary-ee_deploy.jar
-    cp bazel-bin/ledger-service/http-json/http-json-binary-ee_deploy.jar $OUTPUT_DIR/artifactory/$JSON_API_EE
+    bazel build //ledger-service/http-json:http-json-binary_distribute.jar
+    cp bazel-bin/ledger-service/http-json/http-json-binary_distribute.jar $OUTPUT_DIR/github/$JSON_API
+    bazel build //ledger-service/http-json:http-json-binary-ee_distribute.jar
+    cp bazel-bin/ledger-service/http-json/http-json-binary-ee_distribute.jar $OUTPUT_DIR/artifactory/$JSON_API_EE
 
     TRIGGER_SERVICE=trigger-service-$RELEASE_TAG.jar
     TRIGGER_SERVICE_EE=trigger-service-$RELEASE_TAG-ee.jar
-    bazel build //triggers/service:trigger-service-binary-ce_deploy.jar
-    cp bazel-bin/triggers/service/trigger-service-binary-ce_deploy.jar $OUTPUT_DIR/github/$TRIGGER_SERVICE
-    bazel build //triggers/service:trigger-service-binary-ee_deploy.jar
-    cp bazel-bin/triggers/service/trigger-service-binary-ee_deploy.jar $OUTPUT_DIR/artifactory/$TRIGGER_SERVICE_EE
+    bazel build //triggers/service:trigger-service-binary-ce_distribute.jar
+    cp bazel-bin/triggers/service/trigger-service-binary-ce_distribute.jar $OUTPUT_DIR/github/$TRIGGER_SERVICE
+    bazel build //triggers/service:trigger-service-binary-ee_distribute.jar
+    cp bazel-bin/triggers/service/trigger-service-binary-ee_distribute.jar $OUTPUT_DIR/artifactory/$TRIGGER_SERVICE_EE
 
     OAUTH2_MIDDLEWARE=oauth2-middleware-$RELEASE_TAG.jar
-    bazel build //triggers/service/auth:oauth2-middleware-binary_deploy.jar
-    cp bazel-bin/triggers/service/auth/oauth2-middleware-binary_deploy.jar $OUTPUT_DIR/github/$OAUTH2_MIDDLEWARE
+    bazel build //triggers/service/auth:oauth2-middleware-binary_distribute.jar
+    cp bazel-bin/triggers/service/auth/oauth2-middleware-binary_distribute.jar $OUTPUT_DIR/github/$OAUTH2_MIDDLEWARE
 
 
     TRIGGER=daml-trigger-runner-$RELEASE_TAG.jar
-    bazel build //triggers/runner:trigger-runner_deploy.jar
-    cp bazel-bin/triggers/runner/trigger-runner_deploy.jar $OUTPUT_DIR/artifactory/$TRIGGER
+    bazel build //triggers/runner:trigger-runner_distribute.jar
+    cp bazel-bin/triggers/runner/trigger-runner_distribute.jar $OUTPUT_DIR/artifactory/$TRIGGER
 
     SCRIPT=daml-script-$RELEASE_TAG.jar
-    bazel build //daml-script/runner:daml-script-binary_deploy.jar
-    cp bazel-bin/daml-script/runner/daml-script-binary_deploy.jar $OUTPUT_DIR/artifactory/$SCRIPT
+    bazel build //daml-script/runner:daml-script-binary_distribute.jar
+    cp bazel-bin/daml-script/runner/daml-script-binary_distribute.jar $OUTPUT_DIR/artifactory/$SCRIPT
 
     NON_REPUDIATION=non-repudiation-$RELEASE_TAG-ee.jar
-    bazel build //runtime-components/non-repudiation-app:non-repudiation-app_deploy.jar
-    cp bazel-bin/runtime-components/non-repudiation-app/non-repudiation-app_deploy.jar $OUTPUT_DIR/artifactory/$NON_REPUDIATION
+    bazel build //runtime-components/non-repudiation-app:non-repudiation-app_distribute.jar
+    cp bazel-bin/runtime-components/non-repudiation-app/non-repudiation-app_distribute.jar $OUTPUT_DIR/artifactory/$NON_REPUDIATION
 
     NON_REPUDIATION_CORE_JAR=non-repudiation-core-$RELEASE_TAG.jar
     NON_REPUDIATION_CORE_POM=non-repudiation-core-$RELEASE_TAG.pom

diff --git a/compatibility/WORKSPACE b/compatibility/WORKSPACE
@@ -282,7 +282,7 @@ daml_sdk_head(
     daml_ledger_tarball = "@head_sdk//:daml-ledger-0.0.0.tgz",
     daml_react_tarball = "@head_sdk//:daml-react-0.0.0.tgz",
     daml_types_tarball = "@head_sdk//:daml-types-0.0.0.tgz",
-    ledger_api_test_tool = "@head_sdk//:ledger-api-test-tool_deploy.jar",
+    ledger_api_test_tool = "@head_sdk//:ledger-api-test-tool_distribute.jar",
     os_name = os_name,
     sdk_tarball = "@head_sdk//:sdk-release-tarball-ce.tar.gz",
 )

diff --git a/compatibility/build-release-artifacts-windows.ps1 b/compatibility/build-release-artifacts-windows.ps1
@@ -41,10 +41,10 @@ bazel fetch @nodejs_dev_env//...
 bazel build `
   `-`-experimental_execution_log_file ${ARTIFACT_DIRS}/build_execution_windows.log `
   //release:sdk-release-tarball `
-  //ledger-test-tool/tool:ledger-api-test-tool_deploy.jar
+  //ledger-test-tool/tool:ledger-api-test-tool_distribute.jar
 
 git clean -fxd -e 'daml-*.tgz' compatibility/head_sdk
 
 cp -Force bazel-bin\release\sdk-release-tarball-ce.tar.gz compatibility/head_sdk
-cp -Force bazel-bin\ledger-test-tool\tool\ledger-api-test-tool_deploy.jar compatibility/head_sdk
+cp -Force bazel-bin\ledger-test-tool\tool\ledger-api-test-tool_distribute.jar compatibility/head_sdk
 cp -Force templates\create-daml-app-test-resources\messaging.patch compatibility/head_sdk
diff --git a/compatibility/build-release-artifacts.sh b/compatibility/build-release-artifacts.sh
@@ -21,8 +21,8 @@ git clean -fxd -e 'daml-*.tgz' $HEAD_TARGET_DIR
 
 bazel build \
   //release:sdk-release-tarball \
-  //ledger-test-tool/tool:ledger-api-test-tool_deploy.jar
+  //ledger-test-tool/tool:ledger-api-test-tool_distribute.jar
 
 cp -f bazel-bin/release/sdk-release-tarball-ce.tar.gz "$HEAD_TARGET_DIR"
-cp -f bazel-bin/ledger-test-tool/tool/ledger-api-test-tool_deploy.jar "$HEAD_TARGET_DIR"
+cp -f bazel-bin/ledger-test-tool/tool/ledger-api-test-tool_distribute.jar "$HEAD_TARGET_DIR"
 cp -f templates/create-daml-app-test-resources/messaging.patch "$HEAD_TARGET_DIR"
diff --git a/compiler/repl-service/server/BUILD.bazel b/compiler/repl-service/server/BUILD.bazel
@@ -9,7 +9,7 @@ load(
 
 genrule(
     name = "repl_service_jar",
-    srcs = [":repl-service-raw_deploy.jar"],
+    srcs = [":repl-service-raw_distribute.jar"],
     outs = ["repl-service.jar"],
     cmd = "cp $< $@",
     visibility = ["//visibility:public"],

diff --git a/compiler/scenario-service/server/BUILD.bazel b/compiler/scenario-service/server/BUILD.bazel
@@ -5,7 +5,7 @@ load("//bazel_tools:scala.bzl", "da_scala_binary", "lf_scalacopts_stricter")
 
 genrule(
     name = "scenario_service_jar",
-    srcs = [":scenario-service-raw_deploy.jar"],
+    srcs = [":scenario-service-raw_distribute.jar"],
     outs = ["scenario-service.jar"],
     cmd = "cp $< $@",
     visibility = ["//visibility:public"],

diff --git a/daml-assistant/daml-sdk/BUILD.bazel b/daml-assistant/daml-sdk/BUILD.bazel
@@ -48,6 +48,7 @@ da_scala_binary(
     resources = glob(["src/main/resources/**/*"]),
     scala_deps = scala_deps,
     scala_runtime_deps = scala_runtime_deps,
+    tags = ["ee-jar-license"],
     # Navigator resources trigger this incorrectly
     unused_dependency_checker_mode = "off",
     visibility = ["//visibility:public"],
@@ -65,12 +66,12 @@ sh_test(
     srcs = ["validate.sh"],
     args = [
         "$(location @local_jdk//:bin/java.exe)" if is_windows else "$(location @local_jdk//:bin/java)",
-        "$(location :sdk_deploy.jar)",
-        "$(location :sdk_ee_deploy.jar)",
+        "$(location :sdk_distribute.jar)",
+        "$(location :sdk_ee_distribute.jar)",
     ],
     data = [
-        ":sdk_deploy.jar",
-        ":sdk_ee_deploy.jar",
+        ":sdk_distribute.jar",
+        ":sdk_ee_distribute.jar",
         "@local_jdk//:bin/java.exe" if is_windows else "@local_jdk//:bin/java",
     ],
     deps = [

diff --git a/daml-ghcide b/daml-ghcide
diff --git a/daml-script/runner/BUILD.bazel b/daml-script/runner/BUILD.bazel
@@ -86,13 +86,13 @@ da_scala_binary(
         "@maven//:com_typesafe_akka_akka_slf4j",
     ],
     scalacopts = lf_scalacopts_stricter,
+    tags = ["ee-jar-license"],
     visibility = ["//visibility:public"],
     runtime_deps = [
         "@maven//:ch_qos_logback_logback_classic",
     ],
     deps = [
         ":script-runner-lib",
-        "//release:ee-license",
     ],
 )
 

diff --git a/language-support/codegen-main/BUILD.bazel b/language-support/codegen-main/BUILD.bazel
@@ -54,7 +54,7 @@ da_scala_binary(
 
 jar_jar(
     name = "shaded_binary",
-    input_jar = "//language-support/codegen-main:codegen-main_deploy.jar",
+    input_jar = "//language-support/codegen-main:codegen-main_distribute.jar",
     rules = "shade_rule",
     tags = ["maven_coordinates=com.daml:codegen-jvm-main:__VERSION__"],
     visibility = ["//visibility:public"],

diff --git a/language-support/java/codegen/BUILD.bazel b/language-support/java/codegen/BUILD.bazel
@@ -170,7 +170,7 @@ dar_to_java(
 
 jar_jar(
     name = "shaded_binary",
-    input_jar = "//language-support/java/codegen:codegen_deploy.jar",
+    input_jar = "//language-support/java/codegen:codegen_distribute.jar",
     rules = "shade_rule",
     tags = ["maven_coordinates=com.daml:codegen-java:__VERSION__"],
     visibility = ["//visibility:public"],

diff --git a/language-support/ts/codegen/tests/BUILD.bazel b/language-support/ts/codegen/tests/BUILD.bazel
@@ -89,7 +89,7 @@ sh_test(
         "$(location //:yarn)",
         "$(location //:daml2js)",
         "$(location //canton:canton_deploy.jar)",
-        "$(location //ledger-service/http-json:http-json-binary_deploy.jar)",
+        "$(location //ledger-service/http-json:http-json-binary_distribute.jar)",
         "$(location :build-and-lint.dar)",
         "$(location ts/package.json)",
         "$(location //language-support/ts/daml-types:npm_package)",
@@ -104,7 +104,7 @@ sh_test(
         "//:java",
         "//:yarn",
         "//:daml2js",
-        "//ledger-service/http-json:http-json-binary_deploy.jar",
+        "//ledger-service/http-json:http-json-binary_distribute.jar",
         ":build-and-lint.dar",
         ":hidden.dar",
         "//test-common:model-tests-default.dar",

diff --git a/ledger-service/http-json/BUILD.bazel b/ledger-service/http-json/BUILD.bazel
@@ -147,7 +147,6 @@ json_deps = {
         "//ledger-service/http-json-cli:ee",
         "//ledger-service/http-json-ledger-client:ee",
         "@maven//:com_oracle_database_jdbc_ojdbc8",
-        "//release:ee-license",
     ],
 }
 
@@ -178,6 +177,7 @@ da_scala_binary(
     scala_deps = json_scala_deps,
     scalacopts = hj_scalacopts,
     tags = [
+        "ee-jar-license",
         "maven_coordinates=com.daml:http-json-deploy:__VERSION__",
         "no_scala_version_suffix",
     ],

diff --git a/ledger-test-tool/tool/BUILD.bazel b/ledger-test-tool/tool/BUILD.bazel
@@ -85,10 +85,10 @@ sh_test(
     srcs = ["src/test/test-extract.sh"],
     args = [
         "$(location @local_jdk//:bin/java.exe)" if is_windows else "$(location @local_jdk//:bin/java)",
-        "$(location :ledger-api-test-tool_deploy.jar)",
+        "$(location :ledger-api-test-tool_distribute.jar)",
     ],
     data = [
-        ":ledger-api-test-tool_deploy.jar",
+        ":ledger-api-test-tool_distribute.jar",
         "@local_jdk//:bin/java.exe" if is_windows else "@local_jdk//:bin/java",
     ],
     deps = [

diff --git a/navigator/README.md b/navigator/README.md
@@ -22,13 +22,13 @@ To build a "fat" JAR of the Navigator that includes the pre-compiled front-end
 assets, run:
 
 ```bash
-bazel build //navigator/backend:navigator-binary_deploy.jar
+bazel build //navigator/backend:navigator-binary_distribute.jar
 ```
 
-This produces a "fat" JAR `bazel-bin/navigator/backend/navigator-binary_deploy.jar` which can be run with:
+This produces a "fat" JAR `bazel-bin/navigator/backend/navigator-binary_distribute.jar` which can be run with:
 
 ```bash
-java -jar bazel-bin/navigator/backend/navigator-binary_deploy.jar
+java -jar bazel-bin/navigator/backend/navigator-binary_distribute.jar
 ```
 
 Notable things in the Navigator build:

diff --git a/navigator/backend/README.md b/navigator/backend/README.md
@@ -19,10 +19,10 @@ We can build and run a basic the backend using the following commands:
 
 ```bash
 # Build a distribution archive ("fat jar"):
-bazel build //navigator/backend:navigator-binary_deploy.jar
+bazel build //navigator/backend:navigator-binary_distribute.jar
 
 # Run without arguments to show usage:
-java -jar bazel-bin/navigator/backend/navigator-binary_deploy.jar --help
+java -jar bazel-bin/navigator/backend/navigator-binary_distribute.jar --help
 
 # Create a dummy configuration file
 cat << EOF > navigator.conf
@@ -34,7 +34,7 @@ users {
 EOF
 
 # Start the web server
-java -jar bazel-bin/navigator/backend/navigator-binary_deploy.jar server -c navigator.conf
+java -jar bazel-bin/navigator/backend/navigator-binary_distribute.jar server -c navigator.conf
 ```
 
 If you start the server and the configuration file doesn't exist, the server will

diff --git a/release/BUILD.bazel b/release/BUILD.bazel
@@ -6,21 +6,7 @@ load("util.bzl", "protos_zip", "sdk_tarball")
 load("@build_environment//:configuration.bzl", "sdk_version")
 load("@os_info//:os_info.bzl", "is_windows")
 
-genrule(
-    name = "LICENSE",
-    srcs = [":ee-license.txt"],
-    outs = ["LICENSE.txt"],
-    cmd = """
-    cp $(location :ee-license.txt) $@
-    """,
-)
-
-java_library(
-    name = "ee-license",
-    resource_strip_prefix = "release/",
-    resources = [":LICENSE.txt"],
-    visibility = ["//visibility:public"],
-)
+exports_files(["ee-license.txt"])
 
 da_haskell_binary(
     name = "release",

diff --git a/release/artifacts.yaml b/release/artifacts.yaml
@@ -62,7 +62,7 @@
 - target: //language-support/codegen-main:shaded_binary
   type: jar-jarjar
 - target: //language-support/scala/codegen:codegen-main
-  type: jar-deploy
+  type: jar-distribute
 - target: //language-support/java/bindings:bindings-java
   type: jar-lib
 - target: //language-support/java/bindings-rxjava:bindings-rxjava
@@ -116,13 +116,13 @@
 - target: //ledger-test-tool/suites:suites-1.dev
   type: jar-scala
 - target: //ledger-test-tool/tool:ledger-api-test-tool
-  type: jar-deploy
+  type: jar-distribute
 - target: //ledger-test-tool/tool:tool-1.14
-  type: jar-deploy
+  type: jar-distribute
 - target: //ledger-test-tool/tool:tool-1.15
-  type: jar-deploy
+  type: jar-distribute
 - target: //ledger-test-tool/tool:tool-1.dev
-  type: jar-deploy
+  type: jar-distribute
 - target: //ledger/participant-local-store:participant-local-store
   type: jar-scala
 - target: //test-common:dar-files-1.14-lib