From a506a027bfc1d02febb19cbee83138fefd1f39ba Mon Sep 17 00:00:00 2001
From: Gregory Haskins <gregory.haskins@gmail.com>
Date: Thu, 8 Sep 2016 11:13:57 -0400
Subject: [PATCH] [NODESDK] Do not use sudo/global in Makefile

The current SDK build relies on "npm install -g" for some of its
tooling.  This requires sudo in some cases, which can be problematic.
This also means we are spraying binaries around a system which may not
be appreciated in some environments.

The global install is not strictly necessary as long as we can be
intelligent about the paths of our prerequisite tooling. We therefore
refactor the SDK build to use local installs with explicit path
management.  We also clean up the build process a bit so we add some
build-avoidance in places where it is reasonable to do so.

Change-Id: I802d2b3894e9b0a7cea07a1ac577fa1061634ebb
Signed-off-by: Gregory Haskins <gregory.haskins@gmail.com>
---
 sdk/node/Makefile   | 67 +++++++++++++++++++++++++++++++++++++--------
 sdk/node/makedoc.sh | 58 ---------------------------------------
 2 files changed, 55 insertions(+), 70 deletions(-)
 delete mode 100755 sdk/node/makedoc.sh

diff --git a/sdk/node/Makefile b/sdk/node/Makefile
index fbe86f4e7a4..4a5cecac0d3 100644
--- a/sdk/node/Makefile
+++ b/sdk/node/Makefile
@@ -16,24 +16,67 @@
 # under the License.
 #
 
+BINDIR  := node_modules/.bin
+TYPINGS := $(BINDIR)/typings
+TSC     := $(BINDIR)/tsc
+TYPEDOC := $(BINDIR)/typedoc
+
+DOCURI := "https://github.com/hyperledger/fabric/tree/master/sdk/node/"
+
+SRC := $(shell find src -type f)
+CONFIG := $(shell ls *.json)
+
 EXECUTABLES = npm
 K := $(foreach exec,$(EXECUTABLES),\
 	$(if $(shell which $(exec)),some string,$(error "No $(exec) in PATH: Check dependencies")))
 
-all: hfc
+# npm tool->pkg mapping
+npm.pkg.typings   := typings
+npm.pkg.tsc       := typescript
+npm.pkg.typedoc   := typedoc
+
+all: lib doc
+
+.PHONY: lib doc
+lib: lib/hfc.js
+doc: doc/index.html
+
+.SECONDARY: $(TYPINGS) $(TSC) $(TYPEDOC)
+$(BINDIR)/%: $(CONFIG)
+	@echo "[INSTALL] $@"
+	npm install $(npm.pkg.$(@F))
+	@touch $@
+
+doc/index.html: $(TYPEDOC) $(SRC) $(CONFIG) typedoc-special.d.ts Makefile
+	@echo "[BUILD] SDK documentation"
+	@-rm -rf $(@D)
+	@mkdir -p $(@D)
+	$(TYPEDOC) -m amd \
+		--name 'Node.js Hyperledger Fabric SDK' \
+		--includeDeclarations \
+		--excludeExternals \
+		--excludeNotExported \
+		--out $(@D) \
+		src/hfc.ts typedoc-special.d.ts
+	# Typedoc generates links to working GIT repo which is fixed
+	# below to use an official release URI.
+	find $(@D) -name '*.html' -exec sed -i 's!href="http.*sdk/node/!href="'$(DOCURI)'!' {} \;
 
-.PHONY: hfc
-hfc:
-	mkdir -p ./lib/protos
-	cp ../../protos/*.proto ./lib/protos
-	cp ../../membersrvc/protos/*.proto ./lib/protos
-	npm ls -g | grep 'typings' || sudo npm install -g typings
-	npm ls -g | grep 'typescript' || sudo npm install -g typescript
-	npm install && typings install
-	tsc
-	./makedoc.sh
+lib/hfc.js: $(TYPINGS) $(TSC) $(SRC) $(CONFIG) Makefile
+	@echo "[BUILD] SDK"
+	@mkdir -p ./lib/protos
+	@cp ../../protos/*.proto ./lib/protos
+	@cp ../../membersrvc/protos/*.proto ./lib/protos
+	npm install
+	$(TYPINGS) install
+	$(TSC)
 
-unit-tests: hfc
+unit-tests: lib
+	@echo "[RUN] unit tests..."
 	@./bin/run-unit-tests.sh
 
 clean:
+	@echo "[CLEAN]"
+	-rm -rf node_modules
+	-rm -rf doc
+	-find lib | grep -v "protos/google" | grep -v "hash.js" | xargs rm
diff --git a/sdk/node/makedoc.sh b/sdk/node/makedoc.sh
deleted file mode 100755
index 89d6cad71a1..00000000000
--- a/sdk/node/makedoc.sh
+++ /dev/null
@@ -1,58 +0,0 @@
-#!/bin/bash
-
-# -------------------------------------------------------------
-#
-# Licensed to the Apache Software Foundation (ASF) under one
-# or more contributor license agreements.  See the NOTICE file
-# distributed with this work for additional information
-# regarding copyright ownership.  The ASF licenses this file
-# to you under the Apache License, Version 2.0 (the
-# "License"); you may not use this file except in compliance
-# with the License.  You may obtain a copy of the License at
-#
-#   http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing,
-# software distributed under the License is distributed on an
-# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-# KIND, either express or implied.  See the License for the
-# specific language governing permissions and limitations
-# under the License.
-#
-# -------------------------------------------------------------
-
-typedoc=$(which typedoc)
-if [[ $? -ne 0 ]]; then
-    echo "Installing typedoc ..."
-    sudo npm install -g typedoc
-    if [[ $? -ne 0 ]]; then
-       echo "No typedoc found. Please install it like this:"
-       echo "  npm install -g typedoc"
-       echo "and rerun this shell script again."
-       exit 1
-    fi
-    echo "Successfully installed typedoc"
-fi
-set -e
-
-tv="$(typings -v)"
-if [[ "${tv%.*}" < "1.0" ]]; then
-    echo "You have typings ${tv} but you need 1.0 or higher."
-    exit 1
-fi
-
-mkdir -p doc
-rm -rf doc/*
-
-typedoc -m amd \
---name 'Node.js Hyperledger Fabric SDK' \
---includeDeclarations \
---excludeExternals \
---excludeNotExported \
---out doc \
-src/hfc.ts typedoc-special.d.ts
-
-# Typedoc generates links to working GIT repo which is fixed
-# below to use an official release URI.
-DOCURI="https://github.com/hyperledger/fabric/tree/master/sdk/node/"
-find doc -name '*.html' -exec sed -i 's!href="http.*sdk/node/!href="'$DOCURI'!' {} \;