Integrated puppeteer based rendering into build

faustedition · Mar 31, 2020 · f9b74d8 · f9b74d8
1 parent ea299d7
commit f9b74d8
Show file tree

Hide file tree

Showing 5 changed files with 80 additions and 25 deletions.
diff --git a/.gitignore b/.gitignore
@@ -8,3 +8,5 @@ target
 .ipynb_checkpoints
 .ropeproject
 __pycache__
+node
+node_modules
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -0,0 +1,21 @@
+{
+  "name": "faust-gen",
+  "version": "1.0.0",
+  "description": "The Faust-Edition web application builds on data that is automatically pre-generated from the original XML files. This project integrates the various generation and upload processes (except for the images, actually).",
+  "main": "rendersvgs-puppeteer.js",
+  "dependencies": {
+    "puppeteer": "^2.1.1"
+  },
+  "devDependencies": {},
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/faustedition/faust-gen.git"
+  },
+  "bugs": {
+    "url": "https://github.com/faustedition/faust-gen/issues"
+  },
+  "homepage": "https://github.com/faustedition/faust-gen#readme"
+}
diff --git a/pom.xml b/pom.xml
@@ -226,7 +226,7 @@
 			</activation>
 			<build>
 				<plugins>
-				
+
 				<!-- PhantomJS or SlimerJS? 
 				
 				 Uncomment either of the plugins below: 
@@ -240,6 +240,24 @@
 				 see the comment there.
 				
 				 -->
+                    <plugin>
+                        <groupId>com.github.eirslett</groupId>
+                        <artifactId>frontend-maven-plugin</artifactId>
+                        <version>1.9.1</version>
+                        <configuration>
+                            <nodeVersion>v12.16.1</nodeVersion>
+                        </configuration>
+                        <executions>
+                            <execution>
+                                <id>install node and npm</id>
+                                <goals><goal>install-node-and-npm</goal></goals>
+                            </execution>
+                            <execution>
+                                <id>npm install</id>
+                                <goals><goal>npm</goal></goals>
+                            </execution>
+                        </executions>
+                    </plugin>
 
 <!--					<plugin>
 						<groupId>com.github.klieber</groupId>
@@ -255,7 +273,7 @@
 						</executions>
 					</plugin>
 -->							
-				 
+				<!--
 					
 					<plugin>
 						<groupId>org.apache.maven.plugins</groupId>
@@ -286,6 +304,7 @@
 							</execution>
 						</executions>
 					</plugin>
+					-->
 				</plugins>
 			</build>
 		</profile>
@@ -320,7 +339,10 @@
 										<!-- For PhantomJS: -->										
 										<!-- <argument>-Dphantomjs.binary=${phantomjs.binary}</argument> -->
 										<!-- For SlimerJS instead: -->
-										<argument>-Dphantomjs.binary=${project.build.directory}/dependency/slimerjs-1.0.0-beta.1/slimerjs</argument>
+										<!--argument>-Dphantomjs.binary=${project.build.directory}/dependency/slimerjs-1.0.0-beta.1/slimerjs</argument-->
+                                        <!-- or for puppeteer: -->
+                                        <argument>-Dnode.binary=${project.basedir}/node/node</argument>
+										<argument>-Dnode.script=${project.basedir}/rendersvgs-puppeteer.js</argument>
 										<argument>-Dfaust.diplo.allowedFailures=${faust.diplo.allowedFailures}</argument>
 										<argument>-Dfaust.diplo.server=${faust.diplo.server}</argument>
 										<argument>-Dfaust.diplo.port=${faust.diplo.port}</argument>

diff --git a/src/main/java/net/faustedition/gen/DiplomaticConversion.java b/src/main/java/net/faustedition/gen/DiplomaticConversion.java
@@ -72,8 +72,6 @@ public class DiplomaticConversion {
 
 	private static boolean onlyWebServer;
 
-	private static ImmutableList<String> baseCmdLine;
-
 	public static class TranscriptPage {
 		public final Document document;
 		private final String page;
@@ -133,17 +131,11 @@ public boolean buildSVGs() {
 			logger.fine("Converting " + this);
 			final Path resolvedSvgPath = diplomatic_path.resolve(getPagePath("svg"));
 			resolvedSvgPath.getParent().toFile().mkdirs();
-			final ArrayList<String> arguments = Lists.newArrayList(
-					System.getProperty("phantomjs.binary", "/usr/local/bin/phantomjs"), 
-					"rendersvgs.js",
-					serverURL, 
-					getJsonPath().toString(),
-					resolvedSvgPath.toString());
-			if (debugPhantomJS)
-				arguments.add(1, "--debug=errors");
-			if (arguments.get(0).contains("slimerjs"))
-				arguments.add(1, "--headless");
-
+            final ArrayList<String> arguments = getRenderCommandLine();
+
+            arguments.add(getJsonPath().toString());
+			arguments.add(resolvedSvgPath.toString());
+
 			final Optional<Path> imageLinkPath = getImageLinkPath();
 			if (imageLinkPath.isPresent()) {
 				arguments.add(imageLinkPath.get().toString());
@@ -183,7 +175,28 @@ private Path getJsonPath() {
 
 	}
 
-	public static class Document {
+    private static ArrayList<String> getRenderCommandLine() {
+        String renderScript = System.getProperty("node.script");
+        final String renderBinary;
+        if (renderScript == null) {
+            renderBinary = System.getProperty("phantomjs.binary", "/usr/local/bin/phantomjs");
+            renderScript = "rendersvgs.js";
+        } else {
+            renderBinary = System.getProperty("node.binary", "node");
+        }
+
+        final ArrayList<String> arguments = Lists.newArrayList(
+                renderBinary,
+                renderScript,
+                serverURL);
+        if (debugPhantomJS)
+            arguments.add(1, "--debug=errors");
+        if (arguments.get(0).contains("slimerjs"))
+            arguments.add(1, "--headless");
+        return arguments;
+    }
+
+    public static class Document {
 
 		private final Path path;
 		/** The base faust:// uri for the transcripts of this document */
@@ -231,13 +244,8 @@ public static void main(final String[] args) throws IOException {
 		try {
 			serverURL = new URL("http", "localhost", webServer.getListeningPort(), "/transcript-generation.html").toString();
 			logger.info(MessageFormat.format("Web server runs on {0}", serverURL));
-			baseCmdLine = ImmutableList.of(
-					System.getProperty("phantomjs.binary", "/usr/local/bin/phantomjs"), 
-					"--profile", profile.toString(),
-					debugPhantomJS? "--debug=true" : "",
-					"rendersvgs.js",
-					serverURL);
-			logger.info(() -> "PhantomJS command line: " + String.join(" ", baseCmdLine) + " <input> <output> [<links> <linkoutput>]");
+			List<String> baseCmdLine = getRenderCommandLine();
+			logger.info(() -> "Render script command line: " + String.join(" ", baseCmdLine) + " <input> <output> [<links> <linkoutput>]");
 
 
 			if (onlyWebServer) {