Include Javascript files in JVM binary

contrib/node/examples/src/java/org/pantsbuild/testproject/jsresources/BUILD

@@ -0,0 +1,17 @@
+jvm_binary(name = 'jsresources',
+  source = 'JsResourcesMain.java',
+  main = 'org.pantsbuild.testproject.jsresources.JsResourcesMain',
+  dependencies = [
+    '3rdparty:guava',
+    'contrib/node/examples/src/node/web-component-button:web-component-button-processed',
+  ]
+)
+
+jvm_binary(name = 'jsresources-with-dependency-artifacts',
+  source = 'JsResourcesMain.java',
+  main = 'org.pantsbuild.testproject.jsresources.JsResourcesMain',
+  dependencies = [
+    '3rdparty:guava',
+    'contrib/node/examples/src/node/web-component-button:web-component-button-processed-with-dependency-artifacts',
+  ]
+)

contrib/node/examples/src/java/org/pantsbuild/testproject/jsresources/JsResourcesMain.java

@@ -0,0 +1,30 @@
+package org.pantsbuild.testproject.jsresources;
+
+import com.google.common.base.Charsets;
+import com.google.common.io.Resources;
+import java.io.IOException;
+import java.net.URL;
+
+public class JsResourcesMain {
+  private static String RESOURCE_PATH = "web-component-button-processed/Button.js";
+  private static String ALT_RESOURCE_PATH = (
+    "web-component-button-processed-with-dependency-artifacts/Button.js");
+
+  public static void main(String[] args) throws IOException {
+    // Introduce a 3rdparty library so we can test if Manifest's Class-Path entry is
+    // set properly for both internal and external dependencies.
+    URL resourceUrl;
+    try {
+      resourceUrl = Resources.getResource(RESOURCE_PATH);
+    } catch (IllegalArgumentException e) {
+      resourceUrl = Resources.getResource(ALT_RESOURCE_PATH);
+    }
+    String content = Resources.toString(resourceUrl, Charsets.UTF_8);
+    // Ensure resource is loaded properly.
+    System.out.println(content);
+  }
+
+  private JsResourcesMain() {
+    // not called. placates checkstyle
+  }
+}

contrib/node/examples/src/node/web-build-tool/BUILD

@@ -6,5 +6,6 @@ node_module(
     'contrib/node/examples/3rdparty/node/null-loader',
     'contrib/node/examples/3rdparty/node/style-loader',
     'contrib/node/examples/3rdparty/node/webpack',
-  ]
+  ],
+  preserve_artifacts=False,
 )

contrib/node/examples/src/node/web-component-button/BUILD

@@ -5,7 +5,7 @@ node_module(
     'contrib/node/examples/3rdparty/node/mocha',
     'contrib/node/examples/3rdparty/node/react',
     'contrib/node/examples/src/node/web-build-tool',
-  ]
+  ],
 )
 
 node_test(
@@ -29,3 +29,32 @@ node_bundle(
   name='web-component-button-bundle',
   node_module=':web-component-button'
 )
+
+# The following target invokes webpack build.
+node_module(
+  name='web-component-button-processed',
+  sources=globs('package.json', 'webpack.config.js', 'src/*', 'test/*'),
+  dependencies=[
+    'contrib/node/examples/3rdparty/node/mocha',
+    'contrib/node/examples/3rdparty/node/react',
+    'contrib/node/examples/src/node/web-build-tool',
+  ],
+  build_script='build',
+)
+
+node_bundle(
+  name='web-component-button-processed-bundle',
+  node_module=':web-component-button-processed'
+)
+
+node_module(
+  name='web-component-button-processed-with-dependency-artifacts',
+  sources=globs('package.json', 'webpack.config.js', 'src/*', 'test/*'),
+  dependencies=[
+    'contrib/node/examples/3rdparty/node/mocha',
+    'contrib/node/examples/3rdparty/node/react',
+    'contrib/node/examples/src/node/web-build-tool',
+    'contrib/node/examples/src/node/web-dependency-test',
+  ],
+  build_script='build',
+)

contrib/node/examples/src/node/web-dependency-test/BUILD

@@ -0,0 +1,6 @@
+node_module(
+  sources=globs('package.json', 'src/*'),
+  dependencies=[
+    'contrib/node/examples/3rdparty/node/mocha',
+  ]
+)

contrib/node/examples/src/node/web-dependency-test/package.json

@@ -0,0 +1,3 @@
+{
+  "name": "web-dependency-test"
+}

contrib/node/examples/src/node/web-dependency-test/src/index.js

@@ -0,0 +1 @@
+console.writeln("Hello World.")

contrib/node/src/python/pants/contrib/node/register.py

@@ -16,6 +16,7 @@
 from pants.contrib.node.targets.node_preinstalled_module import NodePreinstalledModule
 from pants.contrib.node.targets.node_remote_module import NodeRemoteModule
 from pants.contrib.node.targets.node_test import NodeTest as NodeTestTarget
+from pants.contrib.node.tasks.node_build import NodeBuild
 from pants.contrib.node.tasks.node_bundle import NodeBundle as NodeBundleTask
 from pants.contrib.node.tasks.node_repl import NodeRepl
 from pants.contrib.node.tasks.node_resolve import NodeResolve
@@ -39,6 +40,7 @@ def register_goals():
   task(name='node', action=NodeRepl).install('repl')
   task(name='node', action=NodeResolve).install('resolve')
   task(name='node', action=NodeRun).install('run')
+  task(name='node', action=NodeBuild).install('compile', first=True)
   task(name='node', action=NodeTestTask).install('test')
   task(name='node', action=NodeBundleTask).install('bundle')
 

contrib/node/src/python/pants/contrib/node/targets/BUILD

@@ -14,7 +14,7 @@ python_library(
   name='node_bundle',
   sources=['node_bundle.py'],
   dependencies=[
-    ':node_module',
+    ':node_package',
     'src/python/pants/base:payload',
     'src/python/pants/fs',
   ],

contrib/node/src/python/pants/contrib/node/targets/node_bundle.py

@@ -10,10 +10,10 @@
 from pants.base.payload_field import PrimitiveField
 from pants.fs import archive as archive_lib
 
-from pants.contrib.node.targets.node_module import NodeModule
+from pants.contrib.node.targets.node_package import NodePackage
 
 
-class NodeBundle(NodeModule):
+class NodeBundle(NodePackage):
   """A bundle of node modules."""
 
   def __init__(self, node_module=None, archive='tgz', address=None, payload=None, **kwargs):

contrib/node/src/python/pants/contrib/node/targets/node_module.py

@@ -6,18 +6,28 @@
                         unicode_literals, with_statement)
 
 from pants.base.payload import Payload
+from pants.base.payload_field import PrimitiveField
 
 from pants.contrib.node.targets.node_package import NodePackage
 
 
 class NodeModule(NodePackage):
   """A Node module."""
 
-  def __init__(self, sources=None, address=None, payload=None, **kwargs):
+  def __init__(
+    self, sources=None, build_script=None, output_dir='dist',
+    preserve_artifacts=True, address=None, payload=None, **kwargs):
     """
     :param sources: Javascript and other source code files that make up this module; paths are
                     relative to the BUILD file's directory.
     :type sources: `globs`, `rglobs` or a list of strings
+
+    :param build_script: build script name as defined in package.json.
+    :param output_dir: relative path to assets generated by build script. The path will be
+      preserved in the created JAR if the target is used as a JVM target dependency.
+    :param preserve_artifacts: boolean value.  Default is True. If a node_module is used as parts
+      of devDependencies and thus should not be included in the final artifact, set this value to
+      False.
     """
     # TODO(John Sirois): Support devDependencies, etc.  The devDependencies case is not
     # clear-cut since pants controlled builds would provide devDependencies as needed to perform
@@ -26,8 +36,11 @@ def __init__(self, sources=None, address=None, payload=None, **kwargs):
     # of pre-existing package.json files as node_module targets will require this.
     payload = payload or Payload()
     payload.add_fields({
-      'sources': self.create_sources_field(sources=sources,
-                                           sources_rel_path=address.spec_path,
-                                           key_arg='sources'),
+      'sources': self.create_sources_field(
+        sources=sources, sources_rel_path=address.spec_path, key_arg='sources'),
+      'build_script': PrimitiveField(build_script),
+      'output_dir': PrimitiveField(output_dir),
+      'preserve_artifacts': PrimitiveField(preserve_artifacts),
     })
+
     super(NodeModule, self).__init__(address=address, payload=payload, **kwargs)

contrib/node/src/python/pants/contrib/node/tasks/BUILD

@@ -16,6 +16,18 @@ python_library(
   sources=['node_paths.py']
 )
 
+python_library(
+  name='node_build',
+  sources=['node_build.py'],
+  dependencies=[
+    ':node_paths',
+    ':node_task',
+    'src/python/pants/base:workunit',
+    'src/python/pants/task',
+    'src/python/pants/util:contextutil',
+  ]
+)
+
 python_library(
   name='node_bundle',
   sources=['node_bundle.py'],

contrib/node/src/python/pants/contrib/node/tasks/node_build.py

@@ -0,0 +1,89 @@
+# coding=utf-8
+# Copyright 2015 Pants project contributors (see CONTRIBUTORS.md).
+# Licensed under the Apache License, Version 2.0 (see LICENSE).
+
+from __future__ import (absolute_import, division, generators, nested_scopes, print_function,
+                        unicode_literals, with_statement)
+
+import os
+from collections import defaultdict
+
+from pants.backend.jvm.tasks.classpath_products import ClasspathProducts
+from pants.base.exceptions import TaskError
+from pants.base.workunit import WorkUnitLabel
+from pants.goal.products import MultipleRootedProducts
+from pants.util.contextutil import pushd
+from pants.util.dirutil import absolute_symlink
+
+from pants.contrib.node.tasks.node_paths import NodePaths
+from pants.contrib.node.tasks.node_task import NodeTask
+
+
+class NodeBuild(NodeTask):
+  """Create an archive bundle of NodeModule targets."""
+
+  @classmethod
+  def product_types(cls):
+    # runtime_classpath is used for JVM target to include node build results as resources.
+    return ['bundleable_js', 'runtime_classpath']
+
+  @classmethod
+  def prepare(cls, options, round_manager):
+    super(NodeBuild, cls).prepare(options, round_manager)
+    round_manager.require_data(NodePaths)
+
+  @property
+  def create_target_dirs(self):
+    return True
+
+  def __init__(self, *args, **kwargs):
+    super(NodeBuild, self).__init__(*args, **kwargs)
+
+  def execute(self):
+    node_paths = self.context.products.get_data(NodePaths)
+    runtime_classpath_product = self.context.products.get_data(
+      'runtime_classpath', init_func=ClasspathProducts.init_func(self.get_options().pants_workdir))
+    bundleable_js_product = self.context.products.get_data(
+      'bundleable_js', init_func=lambda: defaultdict(MultipleRootedProducts))
+
+    targets = self.context.targets(predicate=self.is_node_module)
+    with self.invalidated(targets) as invalidation_check:
+      for vt in invalidation_check.all_vts:
+        target = vt.target
+        target_address = target.address.reference()
+        node_installed_path = node_paths.node_path(target)
+
+        with pushd(node_installed_path):
+          if target.payload.build_script:
+            if not vt.valid:
+              self.context.log.info('Running node build {} for {} at {}\n'.format(
+                target.payload.build_script, target_address, node_installed_path))
+              result, npm_build_command = self.execute_npm(
+                ['run-script', target.payload.build_script],
+                workunit_name=target_address,
+                workunit_labels=[WorkUnitLabel.COMPILER])
+              if result != 0:
+                raise TaskError(
+                  'Failed to run build for {}:\n\t{} failed with exit code {}'.format(
+                    target_address, npm_build_command, result))
+
+            if target.payload.preserve_artifacts:
+              output_dir = os.path.join(node_installed_path, target.payload.output_dir)
+              if os.path.exists(output_dir):
+                bundleable_js_product[target].add_abs_paths(output_dir, [output_dir])
+              else:
+                raise TaskError(
+                  'Target {} has build script {} specified, but did not generate any output '
+                  'at {}.\n'.format(target_address, npm_build_command, output_dir))
+          else:
+            if target.payload.preserve_artifacts:
+              bundleable_js_product[target].add_abs_paths(node_installed_path, [node_installed_path])
+              output_dir = node_installed_path
+
+          if target.payload.preserve_artifacts:
+            if not vt.valid:
+              # Resources included in a JAR file will be under %target_name%
+              absolute_symlink(output_dir, os.path.join(vt.results_dir, target.address.target_name))
+            self.context.log.debug('adding {} for target {} to runtime classpath'.format(
+              vt.results_dir, target_address))
+            runtime_classpath_product.add_for_target(target, [('default', vt.results_dir)])

contrib/node/src/python/pants/contrib/node/tasks/node_bundle.py

@@ -11,7 +11,6 @@
 from pants.fs import archive
 from pants.util import dirutil
 
-from pants.contrib.node.tasks.node_paths import NodePaths
 from pants.contrib.node.tasks.node_task import NodeTask
 
 
@@ -25,31 +24,35 @@ def product_types(cls):
   @classmethod
   def prepare(cls, options, round_manager):
     super(NodeBundle, cls).prepare(options, round_manager)
-    round_manager.require_data(NodePaths)
+    round_manager.require_data('bundleable_js')
 
   def __init__(self, *args, **kwargs):
     super(NodeBundle, self).__init__(*args, **kwargs)
     self._outdir = self.get_options().pants_distdir
 
   def execute(self):
-    node_paths = self.context.products.get_data(NodePaths)
+    bundleable_js = self.context.products.get_data('bundleable_js')
     bundle_archive_product = self.context.products.get('deployable_archives')
     dirutil.safe_mkdir(self._outdir)  # Make sure dist dir is present.
 
     for target in self.context.target_roots:
       if self.is_node_bundle(target):
         archiver = archive.archiver(target.payload.archive)
-        # build_dir is a symlink.  Since dereference option for tar is set to False, we need to
-        # dereference manually to archive the linked build dir.
-        build_dir = os.path.realpath(node_paths.node_path(target.node_module))
-        self.context.log.debug('archiving %s' % build_dir)
-        archivepath = archiver.create(
-          build_dir,
-          self._outdir,
-          target.package_name,
-          None,
-          dereference=False
-        )
-        bundle_archive_product.add(
-          target, os.path.dirname(archivepath)).append(os.path.basename(archivepath))
-        self.context.log.info('created {}'.format(os.path.relpath(archivepath, get_buildroot())))
+
+        for _, abs_paths in bundleable_js[target.node_module].abs_paths():
+          for abs_path in abs_paths:
+            # build_dir is a symlink.  Since dereference option for tar is set to False, we need to
+            # dereference manually to archive the linked build dir.
+            build_dir = os.path.realpath(abs_path)
+            self.context.log.debug('archiving {}'.format(build_dir))
+            archivepath = archiver.create(
+              build_dir,
+              self._outdir,
+              target.package_name,
+              None,
+              dereference=False
+            )
+            bundle_archive_product.add(
+              target, os.path.dirname(archivepath)).append(os.path.basename(archivepath))
+            self.context.log.info(
+              'created {}'.format(os.path.relpath(archivepath, get_buildroot())))

contrib/node/tests/python/pants_test/contrib/node/tasks/BUILD

@@ -1,6 +1,19 @@
 # Copyright 2015 Pants project contributors (see CONTRIBUTORS.md).
 # Licensed under the Apache License, Version 2.0 (see LICENSE).
 
+python_tests(
+  name='node_build',
+  sources=['test_node_build.py'],
+  dependencies=[
+    'contrib/node/src/python/pants/contrib/node/targets:node_module',
+    'contrib/node/src/python/pants/contrib/node/tasks:node_build',
+    'src/python/pants/build_graph',
+    'src/python/pants/util:contextutil',
+    'src/python/pants/util:dirutil',
+    'tests/python/pants_test/tasks:task_test_base',
+  ],
+)
+
 python_tests(
   name='node_bundle',
   sources=['test_node_bundle.py'],
@@ -21,7 +34,7 @@ python_tests(
     'src/python/pants/fs',
     'src/python/pants/util:contextutil',
   ],
-  timeout=120,
+  timeout=300,
   tags={'integration'},
 )