basic implementation for front end plugin registration (see #77)

.env-base

@@ -14,6 +14,10 @@ SERVER_NAME="Default Server"
 # by default.
 PUBLIC_STREAMS=true
 
+# PLUGIN_DIRS: Dirs to scan for speckle plugins (comma separated). For example, if you install
+# some other modules in `./test` and `./wonderful`, you could use PLUGIN_DIRS="./test,./wonderful"
+PLUGIN_DIRS="./node_modules/@speckle,./plugins"
+
 # PORT: The port you want the speckle server to run on. Make sure the port is accesible
 # if you have any firewalls set up (ie, ufw).
 PORT=3000

app/api/index.js

@@ -155,14 +155,11 @@ module.exports = function ( app, express, urlRoot ) {
 
   let serverDescription = {
     serverName: process.env.SERVER_NAME,
-    maxRequestSize: process.env.REQ_SIZE
+    version: '1.x.x',
+    api: routes,
   }
 
-  r.get( '/', ( req, res ) => {
-    serverDescription.routes = routes
-    serverDescription.version = '1.x.x'
-    res.json( serverDescription )
-  } )
+  r.get( '/', ( req, res ) => res.json( serverDescription ) )
 
   // mount all these routes up
   app.use( urlRoot, r )

plugins.js

@@ -0,0 +1,48 @@
+const fs = require( 'fs' )
+const path = require( 'path' )
+const winston = require( 'winston' )
+
+const isDirectory = source => fs.lstatSync( source ).isDirectory( )
+const getDirectories = source => fs.readdirSync( source ).map( name => path.join( source, name ) ).filter( isDirectory )
+
+module.exports = ( ) => {
+  winston.debug( 'Scanning for speckle plugins...' )
+
+  // gather potential plugin subdirectories
+  const rootDirs = process.env.PLUGIN_DIRS.split( `,` )
+  let pluginDirs = [ ]
+  rootDirs.forEach( dir => {
+    if ( fs.existsSync( dir ) ) {
+      let dirs = getDirectories( dir )
+      pluginDirs = [ ...dirs, pluginDirs ]
+    } else
+      winston.warn( `specified plugin directory does not exist: ${dir}` )
+  } )
+
+  // read in manifest files
+  let plugins = []
+  pluginDirs.forEach( dir => {
+    let file = path.normalize( `${dir}//speckle-plugin-manifest.json` )
+    if ( fs.existsSync( file ) ) {
+      let obj = JSON.parse( fs.readFileSync( file, 'utf8' ) )
+      obj.sourceDir = dir
+      plugins.push( obj )
+    } else
+      winston.warn( `No plugin manifest file found in ${dir}.` )
+  } )
+
+  // check for conflicts
+  let serveLocations = []
+  plugins.forEach( pl => {
+    if ( serveLocations.indexOf( pl.serveFrom ) < 0 )
+      serveLocations.push( pl.serveFrom )
+    else {
+      winston.warn( `Conflicting plugin endpoint found at: ${pl.serveFrom} in folder ${pl.sourceDir}.
+        It will load from ${pl.serveFrom + '-dupe'} instead.` )
+      pl.serveFrom += '-dupe'
+    }
+  } )
+  winston.debug( `Found ${plugins.length} plugin(s):${plugins.map( p => ' ' + p.name )}` )
+
+  return plugins
+}

plugins/speckle-sample-plugin/index.html

@@ -0,0 +1,27 @@
+<h1>Sample Speckle Frontend Plugin</h1>
+<p>This is just  an example of  how you can register a speckle frontend plugin. Its manifest file looks something like this:</p>
+<pre>
+{
+  "name": "Sample Plugin",
+  "version":"",
+  "desc": "This plugin tests plugins",
+  "serveFrom": "/sample-plugin",
+  "author": "DAS",
+  "contact":"[email protected]",
+  "homepage":"https://dimitrie.org"
+}
+</pre>
+<p>
+  This file (`speckle-plugin-manifest.json`) is picked up by the server which then serves the plugin statically from the location specified.
+</p>
+<p>
+  Thanks for watching 👋 <a href="https://speckle.works">Speckle!</a>
+</p>
+<style type="text/css">
+  a,p,h1 {
+    font-family: sans-serif;
+  }
+  h1 {
+    color: royalblue;
+  }
+</style>

plugins/speckle-sample-plugin/speckle-plugin-manifest.json

@@ -0,0 +1,9 @@
+{
+  "name": "Sample Plugin",
+  "version":"0.1.0",
+  "desc": "This plugin tests plugins",
+  "serveFrom": "/sample-plugin",
+  "author": "DAS",
+  "contact":"[email protected]",
+  "homepage":"https://dimitrie.org"
+}