milestone

Author: mingmingwon

.babelrc

@@ -0,0 +1,3 @@
+{
+	"presets": ["env"]
+}

.gitignore

@@ -1,61 +1 @@
-# Logs
-logs
-*.log
-npm-debug.log*
-yarn-debug.log*
-yarn-error.log*
-
-# Runtime data
-pids
-*.pid
-*.seed
-*.pid.lock
-
-# Directory for instrumented libs generated by jscoverage/JSCover
-lib-cov
-
-# Coverage directory used by tools like istanbul
-coverage
-
-# nyc test coverage
-.nyc_output
-
-# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
-.grunt
-
-# Bower dependency directory (https://bower.io/)
-bower_components
-
-# node-waf configuration
-.lock-wscript
-
-# Compiled binary addons (https://nodejs.org/api/addons.html)
-build/Release
-
-# Dependency directories
-node_modules/
-jspm_packages/
-
-# TypeScript v1 declaration files
-typings/
-
-# Optional npm cache directory
-.npm
-
-# Optional eslint cache
-.eslintcache
-
-# Optional REPL history
-.node_repl_history
-
-# Output of 'npm pack'
-*.tgz
-
-# Yarn Integrity file
-.yarn-integrity
-
-# dotenv environment variables file
-.env
-
-# next.js build output
-.next
+node_modules

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2018 Stefan
+Copyright (c) 2018 Jordan Wang
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,2 +1,84 @@
-# deploy-server-webpack-plugin
-A plugin that deploys bundles to server
+# Introduction
+A plugin that deploys webpack bundles to server. It's useful when server ftp/sftp is forbidden or accessing server need pin + dynamic token.
+
+# Install
+```
+npm i deploy-server-webpack-plugin -D
+```
+
+# Usage
+
+**Client config**
+
+You need config your webpack conf file like this:
+
+```js
+const DeployServerPlugin = require('deploy-server-webpack-plugin');
+
+module.exports = {
+  // ...
+  plugins: [
+    // ...
+    new DeployServerPlugin({
+      receiver: 'http://1.23.45.678:9999/receiver',
+      mapping: { // Object type
+        from: path.resolve(__dirname, '../dist'), // absolute path
+        dest: '/data/front'
+      }
+    })
+  ]
+};
+```
+or
+
+```js
+const DeployServerPlugin = require('deploy-server-webpack-plugin')
+
+module.exports = {
+  // ...
+  plugins: [
+    // ...
+    new DeployServerPlugin({
+      receiver: 'http://1.23.45.678:9999/receiver',
+      mapping: [ // Array type
+        {
+          from: path.resolve(__dirname, '../dist/static'), // absolute path
+          dest: '/data/public/static',
+        },
+        {
+          from: path.resolve(__dirname, '../dist/index.tpl'), // absolute path
+          dest: '/data/views/index.tpl',
+        },
+        // ...
+      ],
+      token: '123456789'
+    })
+  ]
+};
+```
+
+**Server Config**
+
+Please copy ./server folder to you remote server somewhere, init the project and start it.
+
+```
+npm i
+npm run start
+```
+Next config your nginx/apache to allow your node service can be accessed.
+
+Try to visit "@your host/receiver" in browser, when you see "Method Not Allowed", it means node server started success, but 'GET' method is not allowed because we only config "POST" router to upload files.
+
+# Options
+
+|Name|Type|Required|Description|
+|:--:|:--:|:-----:|:----------|
+|receiver|String|true|server url used to receive files|
+|mapping|Object, Array|true|files will be copied from 'form' to 'dest'|
+|token|String|false|for security if needed|
+
+# Others
+Sometimes bundle files are too big and uploading appears "504 Gateay Time-out" error, enlarge client_max_body_size value in nginx.conf may solve this problem:
+```
+client_max_body_size: 10M; #default 1M
+```

dist/index.js

@@ -0,0 +1,31 @@
+{
+    "name": "deploy-server-webpack-plugin",
+    "version": "0.0.1",
+    "description": "A plugin that deploys wepack bundles to server",
+    "main": "dist/index.js",
+    "scripts": {
+        "babel": "babel ./src -d ./dist --compact"
+    },
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/mingmingwon/deploy-server-webpack-plugin.git"
+    },
+    "keywords": [
+        "deploy server",
+        "webpack plugin"
+    ],
+    "author": "Jordan Wang",
+    "license": "MIT",
+    "bugs": {
+        "url": "https://github.com/mingmingwon/deploy-server-webpack-plugin/issues"
+    },
+    "homepage": "https://github.com/mingmingwon/deploy-server-webpack-plugin#readme",
+    "dependencies": {
+        "chalk": "^2.4.1",
+        "request": "^2.87.0"
+    },
+    "devDependencies": {
+        "babel-cli": "^6.26.0",
+        "babel-preset-env": "^1.7.0"
+    }
+}

package.json

@@ -0,0 +1,35 @@
+const Koa = require('koa');
+const koaBody = require('koa-body');
+const Router = require('koa-router');
+const fse = require('fs-extra');
+
+const router = new Router();
+router.post('/receiver', koaBody({
+	multipart: true
+}), async (ctx, next) => {
+	const { files, body: { dest, token } } = ctx.request;
+
+	// deal with "token" here if needed 
+
+	for (let key in files) {
+		const file = files[key];
+		try {
+			await fse.copy(file.path, dest);
+			console.log(new Date().toLocaleString(), 'success', dest);
+			ctx.body = '0';
+		} catch (err) {
+			console.log(new Date().toLocaleString(), 'failed', dest, err);
+			ctx.status = 500;
+			// don't tell client error detail
+			ctx.body = 'Internal Server Error';
+		}
+	}
+});
+
+const app = new Koa();
+app.use(router.routes());
+app.use(router.allowedMethods());
+
+app.listen(3000, () => {
+	console.log('server is ready');
+});

server/app.js

@@ -0,0 +1,19 @@
+{
+  "name": "receiver",
+  "version": "0.0.1",
+  "description": "file receiver",
+  "main": "app.js",
+  "scripts": {
+    "start": "pm2 start app.js",
+    "stop": "pm2 stop app.js"
+  },
+  "author": "Jordan Wang",
+  "license": "MIT",
+  "dependencies": {
+    "fs-extra": "^6.0.1",
+    "koa": "^2.5.2",
+    "koa-body": "^4.0.4",
+    "koa-router": "^7.4.0",
+    "pm2": "^3.0.0"
+  }
+}

server/package.json

@@ -0,0 +1,103 @@
+const fs = require('fs');
+const path = require('path');
+const chalk = require('chalk');
+const request = require('request');
+
+module.exports = class DeployServerWebpackPlugin {
+	constructor(config = {}) {
+		this.config = config;
+	}
+
+	apply(compiler) {
+		compiler.plugin('after-emit', (compilation, callback) => {
+			this.validConfig(compilation);
+			this.deployHandler(callback);
+		});
+	}
+
+	validConfig(compilation) {
+		const { receiver, token = '' } = this.config;
+		let { mapping } = this.config;
+
+		if (!receiver) {
+			this.error('Missing param: receiver');
+		}
+		if (!mapping) {
+			this.error('Missing param: mapping');
+		}
+
+		const mappingType = Object.prototype.toString.call(mapping);
+		if (mappingType === '[object Object]') {
+			mapping = [mapping];
+		} else if (mappingType === '[object Array]') {
+			// do nothing
+		} else {
+			this.error('Invalid param: mapping');
+		}
+
+		const assets = compilation.assets;
+		const avalAssets = {};
+		mapping.map((item, index) => {
+			for (let key in assets) {
+				const asset = assets[key];
+				const assetPath = asset.existsAt;
+				const from = item.from;
+				// limit "src" path within compiled files
+				if (assetPath.startsWith(from)) {
+					if (!avalAssets[from]) {
+						avalAssets[from] = [assetPath];
+						continue;
+					}
+					avalAssets[from].push(assetPath);
+				}
+			}
+		});
+
+		const avalKeys = Object.keys(avalAssets);
+		if (!avalKeys.length) {
+			this.error('No available mapping files');
+		}
+
+		this.receiver = receiver;
+		this.mapping = mapping;
+		this.token = token;
+		this.avalKeys = avalKeys;
+		this.avalAssets = avalAssets;
+	}
+
+	deployHandler(callback) {
+		const formData = {};
+		this.avalKeys.map((item, index) => {
+			this.avalAssets[item].map(from => {
+				// compatible with windows
+				const dest = (this.mapping[index].to + from.replace(item, '')).replace(/\\/g, '/');
+				this.deploy({
+					dest,
+					token: this.token,
+					file: fs.createReadStream(from)
+				});
+			});
+		});
+
+		callback();
+	}
+
+	deploy(formData) {
+		request.post({
+			url: this.receiver,
+			formData
+		}, (err, { statusCode } = {}, body) => {
+			const time = new Date().toLocaleTimeString();
+			if (!err && 200 === statusCode) {
+				console.log(chalk.green(`[${time}] [success] => ${formData.dest}`));
+				return;
+			}
+			console.log(chalk.yellow(`[${time}] [failed] => ${formData.dest} ${body}`));
+		});
+	}
+
+	error(err) {
+		console.log(`\n${chalk.yellow('[deploy-server-webpack-plugin] ' + err)}`);
+		process.exit();
+	}
+};