fix(@phenomic/plugin-public-assets): make "public" folder optional

change(@phenomic/core): merge getMiddlewares and defineDevMiddleware as addDevServerMiddlewares Closes #1056 Closes #1059 Closes #1068
MoOx · Jun 8, 2017 · 4322731 · 4322731
1 parent ac2be85
commit 4322731
Show file tree

Hide file tree

Showing 6 changed files with 72 additions and 30 deletions.
diff --git a/flow/interfaces/phenomic-next.js b/flow/interfaces/phenomic-next.js
@@ -64,11 +64,14 @@ export type PhenomicPlugin = {
   collect?: (db: PhenomicDB, fileName: string, parsed: Object) => Array<mixed>,
   // bunder
   buildForPrerendering?: Function,
-  getMiddlewares?: (config: PhenomicConfig) => Array<express$Middleware>,
   // renderer
   getRoutes?: Function,
   renderServer?: Function,
-  renderHTML?: PhenomicPluginRenderHTMLType
+  renderHTML?: PhenomicPluginRenderHTMLType,
+  // common
+  addDevServerMiddlewares?: (
+    config: PhenomicConfig
+  ) => Array<express$Middleware | Promise<express$Middleware>>
 };
 
 export type PhenomicPlugins = Array<PhenomicPlugin>;

diff --git a/packages/core/src/commands/start.js b/packages/core/src/commands/start.js
@@ -6,23 +6,26 @@ import socketIO from "socket.io";
 import createWatcher from "../watch";
 import processFile from "../injection/processFile";
 import db from "../db";
-import createServer from "../api";
+import createAPIServer from "../api";
 
 const debug = require("debug")("phenomic:core:commands:start");
 
-function createBundlerServer(config: PhenomicConfig) {
-  debug("creating webpack server");
+function createDevServer(config: PhenomicConfig) {
+  debug("creating dev server");
   const server = express();
-  const bundlers = config.plugins.filter(p => p.buildForPrerendering);
-  const bundler = bundlers[0];
-  if (!bundler || !bundler.getMiddlewares) {
-    throw new Error("At least a bundler plugin should be used");
-  }
-  bundler.getMiddlewares(config).forEach(middleware => server.use(middleware));
-  const middlewares = config.plugins.filter(p => p.defineDevMiddleware);
-  middlewares.forEach(middleware =>
-    middleware.defineDevMiddleware(server, config)
-  );
+  config.plugins.forEach(async plugin => {
+    if (plugin.addDevServerMiddlewares) {
+      const middlewares = plugin.addDevServerMiddlewares(config);
+      middlewares.forEach(async m => {
+        if (m.then && typeof m.then) {
+          const resolved = await m;
+          if (resolved) server.use(resolved);
+        } else {
+          server.use(m);
+        }
+      });
+    }
+  });
   return server;
 }
 
@@ -31,8 +34,8 @@ function start(config: PhenomicConfig) {
   process.env.BABEL_ENV = process.env.BABEL_ENV || "development";
   process.env.PHENOMIC_ENV = "development";
   debug("starting phenomic server");
-  const phenomicServer = createServer(db, config.plugins);
-  const bundlerServer = createBundlerServer(config);
+  const phenomicServer = createAPIServer(db, config.plugins);
+  const bundlerServer = createDevServer(config);
   const renderers = config.plugins.filter(p => p.getRoutes);
   const renderer: PhenomicPlugin = renderers[0];
   const transformers = config.plugins.filter(
@@ -83,4 +86,5 @@ function start(config: PhenomicConfig) {
   bundlerServer.listen(config.port);
   console.log(`✨ Open http://localhost:${config.port}`);
 }
+
 export default start;
diff --git a/packages/core/src/logger/index.js b/packages/core/src/logger/index.js
@@ -8,7 +8,7 @@ const ERROR = "error";
 
 // from log-symbols
 type TypeType = "info" | "success" | "warning" | "error" | null;
-type WriterType = (msg: string) => void;
+type WriterType = false | ((msg: string) => void);
 
 const log = (
   sender: string,

diff --git a/packages/core/src/utils/getPath.js b/packages/core/src/utils/getPath.js
@@ -0,0 +1,6 @@
+import fs from "fs";
+
+export default (path: string): Promise<string> =>
+  new Promise((resolve, reject) =>
+    fs.stat(path, err => (err ? reject(err) : resolve(path)))
+  );
diff --git a/packages/plugin-bundler-webpack/src/index.js b/packages/plugin-bundler-webpack/src/index.js
@@ -58,7 +58,7 @@ const getWebpackConfig = (config: PhenomicConfig) => {
 export default function() {
   return {
     name: "@phenomic/plugin-bundler-webpack",
-    getMiddlewares(config: PhenomicConfig) {
+    addDevServerMiddlewares(config: PhenomicConfig) {
       debug("get middlewares");
       const compiler = webpack(getWebpackConfig(config));
       return [

diff --git a/packages/plugin-public-assets/src/index.js b/packages/plugin-public-assets/src/index.js
@@ -1,22 +1,51 @@
 import path from "path";
 
 import express from "express";
-import fsExtra from "fs-extra";
+import fse from "fs-extra";
+import logger from "@phenomic/core/lib/logger";
+import getPath from "@phenomic/core/lib/utils/getPath";
 
-export default function() {
+export type PhenomicPluginPublicAssetsOptionsType = {
+  path: string
+};
+
+const pluginName = "@phenomic/plugin-public-assets";
+const log = logger(pluginName);
+
+const defaultOptions = {
+  path: "public"
+};
+
+export default function(
+  options: PhenomicPluginPublicAssetsOptionsType = defaultOptions
+) {
+  const warnNoPublic = (): void => {
+    log.warn(
+      `No '${options.path}' folder found. Please create this folder if you want static files to be served from the root (eg: favicon.ico).`
+    );
+  };
   return {
-    name: "@phenomic/plugin-public-assets",
-    defineDevMiddleware(server: express$Application, config: PhenomicConfig) {
-      server.use(express.static(path.join(config.path, "public")));
+    name: pluginName,
+    addDevServerMiddlewares(config: PhenomicConfig) {
+      return [
+        getPath(path.join(config.path, options.path)).then(
+          (publicPath: string) => express.static(publicPath),
+          warnNoPublic
+        )
+      ];
     },
     beforeBuild(config: PhenomicConfig) {
       return new Promise((resolve, reject) => {
-        fsExtra.copy(path.join(config.path, "public"), config.outdir, err => {
-          if (err) {
-            reject(err);
-          }
-          resolve();
-        });
+        getPath(
+          path.join(config.path, options.path)
+        ).then((publicPath: string) => {
+          fse.copy(publicPath, config.outdir, err => {
+            if (err) {
+              reject(err);
+            }
+            resolve();
+          });
+        }, warnNoPublic);
       });
     }
   };