区分不同平台的 userAgent (#405)

* refactor(build): replace browserify with webpack

* fix: stop using global.Buffer to prevent polyfill

leancloud/leantodo-weapp#2

* chore: upload sourcemaps to cdn

* feat: standardize user agent

* chore: upload sourcemaps with correct names

Author: leeyeh

gulpfile.babel.js

@@ -8,29 +8,18 @@ import qiniu from 'qiniu';
 import fs from 'fs';
 import gulp from 'gulp';
 import clean from 'gulp-clean';
-import concat from 'gulp-concat';
-import rename from 'gulp-rename';
-import uglify from 'gulp-uglify';
-import source from 'vinyl-source-stream';
-import streamify from 'gulp-streamify';
-import browserify from 'browserify';
-import browserSync from 'browser-sync';
 import babel from 'gulp-babel';
+import shell from 'gulp-shell';
 import { version } from './package.json';
 
-const reload = browserSync.reload;
-
-// 获取当前版本号
-const getAVVersion = () => version;
-
-const uploadCDN = (file, version, cb) => {
+const uploadCDN = (file) => {
   qiniu.conf.ACCESS_KEY = process.env.CDN_QINIU_KEY;
   qiniu.conf.SECRET_KEY = process.env.CDN_QINIU_SECRET;
   if (!qiniu.conf.ACCESS_KEY || !qiniu.conf.SECRET_KEY) {
     throw new Error('Need Qiniu CDN_QINIU_KEY and CDN_QINIU_SECRET');
   }
   const bucketname = 'paas_files';
-  const key = 'static/js/' + path.basename(file, '.js') + '-' + version + '.js';
+  const key = `static/js/${version}/${path.basename(file)}`;
   const putPolicy = new qiniu.rs.PutPolicy(bucketname + ':' + key);
   const uptoken = putPolicy.token();
   const extra = new qiniu.io.PutExtra();
@@ -42,8 +31,8 @@ const uploadCDN = (file, version, cb) => {
     } else {
       console.log(err);
     }
-    cb();
   });
+  return file;
 };
 
 gulp.task('clean-dist', () => {
@@ -56,47 +45,14 @@ gulp.task('clean-dist', () => {
 });
 
 // 编译浏览器版本
-gulp.task('bundle-browser', () => {
-  return browserify({
-    entries: './src/index.js',
-    standalone: 'AV'
-  }).bundle()
-  .pipe(source('av.js'))
-    // .pipe(sourcemaps.init())
-    .pipe(streamify(babel({
-      compact: false
-    })))
-    // .pipe(sourcemaps.write("."))
-    .pipe(gulp.dest('dist'));
-});
+gulp.task('bundle-browser', shell.task('npm run build:browser'));
+gulp.task('bundle-rn', shell.task('npm run build:rn'));
+gulp.task('bundle-weapp', shell.task('npm run build:weapp'));
 
-gulp.task('uglify', ['bundle-browser', 'bundle-weapp'], () => {
-  return gulp.src([
-      'dist/av.js',
-      'dist/av-weapp.js'
-    ])
-    .pipe(uglify())
-    .pipe(rename((path) => {
-      path.basename += '-min';
-    }))
-    .pipe(gulp.dest('dist'));
-
-  // return gulp.src(['dist/av-es5.js'])
-  //   .pipe(clean());
-});
-
-gulp.task('bundle-weapp', () =>
-  browserify({
-    entries: './src/index-weapp.js',
-    standalone: 'AV'
-  })
-  .bundle()
-  .pipe(source('av-weapp.js'))
-  .pipe(streamify(babel({
-    compact: false
-  })))
-  .pipe(gulp.dest('dist'))
-)
+gulp.task('uglify', ['bundle-browser', 'bundle-weapp'], shell.task([
+  'npm run uglify:browser',
+  'npm run uglify:weapp',
+]));
 
 gulp.task('clean-node', () => {
   return gulp.src(['dist/node/**/*.*'])
@@ -106,10 +62,7 @@ gulp.task('clean-node', () => {
 // 编译出 Node 版本
 gulp.task('babel-node', ['clean-node'], () => {
   return gulp.src('src/**/*.js')
-    // .pipe(sourcemaps.init())
     .pipe(babel())
-    // .pipe(concat('av.js'))
-    // .pipe(sourcemaps.write("."))
     .pipe(gulp.dest('dist/node/'));
 });
 
@@ -130,53 +83,21 @@ gulp.task('babel-demo', ['clean-demo'], () => {
 
 // 上传到 CDN
 gulp.task('upload', () => {
-  uploadCDN('./dist/av-min.js', getAVVersion(), () => {});
-  uploadCDN('./dist/av-weapp-min.js', getAVVersion(), () => {});
-  uploadCDN('./dist/av.js', getAVVersion(), () => {});
-  uploadCDN('./dist/av-weapp.js', getAVVersion(), () => {});
+  [
+    './dist/av-min.js',
+    './dist/av-weapp-min.js',
+    './dist/av.js',
+    './dist/av-weapp.js',
+  ].map(uploadCDN).map(file => `${file}.map`).map(uploadCDN);
 });
 
 // 生成 release 文件
-gulp.task('release', [
-  // 生成浏览器版本
+gulp.task('build', [
   'clean-dist',
   'bundle-browser',
+  'bundle-rn',
   'bundle-weapp',
   'uglify',
-  // 生成 node 版本
   'clean-node',
   'babel-node'
 ]);
-
-// 浏览器开发时使用
-gulp.task('dev', [
-  'clean-dist',
-  'bundle-browser',
-  'babel-demo'
-], () => {
-  browserSync({
-    notify: false,
-    port: 8888,
-    server: {
-      baseDir: ['demo'],
-      routes: {
-        '/dist': 'dist'
-      }
-    }
-  });
-
-  gulp.watch('src/**/*.js', [
-    'clean-dist',
-    'browserify',
-    'babel-browser',
-    'uglify'
-  ]);
-
-  gulp.watch([
-    'demo/*.html',
-    'demo/*.js',
-    'dist/*.js'
-  ], [
-    'babel-demo'
-  ]).on('change', reload);
-});

package.json

@@ -10,7 +10,13 @@
   "scripts": {
     "test": "NODE_ENV=test nyc --reporter lcov --reporter text mocha --timeout 300000 test/index.js",
     "docs": "jsdoc src README.md package.json -d docs -c .jsdocrc.json",
-    "build": "gulp release"
+    "build:node": "gulp babel-node",
+    "build:browser": "PLATFORM=Browser webpack --config webpack/browser.js",
+    "build:rn": "PLATFORM=ReactNative webpack --config webpack/rn.js",
+    "build:weapp": "PLATFORM=Weapp webpack --config webpack/weapp.js",
+    "uglify:browser": "cd dist; uglifyjs av.js -m -c -o av-min.js --in-source-map av.js.map --source-map av-min.js.map; cd ..;",
+    "uglify:weapp": "cd dist; uglifyjs av-weapp.js -m -c -o av-weapp-min.js --in-source-map av-weapp.js.map --source-map av-weapp-min.js.map; cd ..;",
+    "build": "gulp build"
   },
   "dependencies": {
     "debug": "^2.2.0",
@@ -23,11 +29,10 @@
   },
   "devDependencies": {
     "babel-core": "^6.4.0",
+    "babel-loader": "^6.2.8",
     "babel-plugin-istanbul": "^2.0.0",
     "babel-preset-es2015": "^6.3.13",
     "babel-register": "^6.14.0",
-    "browser-sync": "^2.2.1",
-    "browserify": "^11.0.1",
     "docdash": "git+https://github.com/leeyeh/docdash.git#leancloud",
     "eslint": "^2.8.0",
     "eslint-config-airbnb": "^8.0.0",
@@ -38,49 +43,32 @@
     "gulp": "^3.8.10",
     "gulp-babel": "^6.1.1",
     "gulp-clean": "^0.3.1",
-    "gulp-concat": "^2.4.3",
-    "gulp-eslint": "^0.13.2",
-    "gulp-rename": "^1.2.0",
-    "gulp-streamify": "^1.0.2",
-    "gulp-uglify": "^1.0.2",
+    "gulp-shell": "^0.5.2",
     "jsdoc": "~3.4.0",
     "mocha": "^3.0.0",
     "nyc": "^8.1.0",
     "should": "^11.1.0",
-    "vinyl-source-stream": "^1.1.0",
-    "weapp-polyfill": "github:leancloud/weapp-polyfill#8efa131"
+    "uglify-js": "git+https://github.com/Swaagie/UglifyJS2.git#fcb4f2f21584dc5b21af4c10e17733e1686135e4",
+    "weapp-polyfill": "github:leancloud/weapp-polyfill#8efa131",
+    "webpack": "^2.1.0-beta.27"
   },
   "license": "MIT",
   "author": {
     "name": "LeanCloud",
     "email": "[email protected]"
   },
   "browser": {
-    "react-native": false,
     "./src/uploader/qiniu.js": "./src/uploader/qiniu-browser.js",
-    "./src/browserify-wrapper/localStorage.js": "./src/browserify-wrapper/localstorage-browser.js",
-    "./src/browserify-wrapper/parse-base64.js": "./src/browserify-wrapper/parse-base64-browser.js",
-    "./dist/node/uploader/qiniu.js": "./dist/node/uploader/qiniu-browser.js",
-    "./dist/node/browserify-wrapper/localStorage.js": "./dist/node/browserify-wrapper/localstorage-browser.js",
-    "./dist/node/browserify-wrapper/parse-base64.js": "./dist/node/browserify-wrapper/parse-base64-browser.js"
+    "./src/utils/localstorage.js": "./src/utils/localstorage-browser.js",
+    "./src/utils/parse-base64.js": "./src/utils/parse-base64-browser.js",
+    "./src/ua/comments.js": "./src/ua/comments-browser.js",
+    "./dist/node/index.js": "./dist/av.js"
   },
   "react-native": {
-    "react-native": "react-native"
+    "./src/utils/localstorage.js": "./src/utils/localstorage-rn.js",
+    "./dist/node/index.js": "./dist/av-rn.js"
   },
   "typings": "./storage.d.ts",
-  "eslintConfig": {
-    "env": {
-      "es6": true,
-      "node": true,
-      "browser": true
-    },
-    "rules": {
-      "quotes": [
-        2,
-        "single"
-      ]
-    }
-  },
   "nyc": {
     "require": [
       "babel-register"

src/av.js

@@ -1,4 +1,5 @@
 const _ = require('underscore');
+const userAgent = require('./ua');
 const {
   isNullOrUndefined,
 } = require('./utils');
@@ -24,7 +25,7 @@ _.extend(AVConfig, {
   disableCurrentUser: false,
 
   // Internal config can modifie the UserAgent
-  userAgent: null,
+  userAgent,
 
   // set production environment or test environment
   // 1: production environment, 0: test environment, null: default environment

src/browserify-wrapper/localstorage-browser.js

@@ -342,7 +342,7 @@ module.exports = function(AV) {
       data = { base64: encodeBase64(data) };
     }
     if (data && data.base64) {
-      var parseBase64 = require('./browserify-wrapper/parse-base64');
+      var parseBase64 = require('./utils/parse-base64');
       var dataBase64 = parseBase64(data.base64, guessedType);
       this.attributes.base64 = dataURLToBase64(data.base64);
       this._source = Promise.resolve({ data: dataBase64, type: guessedType });
@@ -351,13 +351,12 @@ module.exports = function(AV) {
         data.blob.type = guessedType;
       }
       this._source = Promise.resolve({ data: data.blob, type: guessedType });
-    } else if (typeof File !== "undefined" && data instanceof global.File) {
+    } else if (typeof File !== "undefined" && data instanceof File) {
       if (data.size) {
         this.attributes.metaData.size = data.size;
       }
       this._source = Promise.resolve({ data, type: guessedType });
-    } else if (typeof global.Buffer !== "undefined" && global.Buffer.isBuffer(data)) {
-      // use global.Buffer to prevent browserify pack Buffer module
+    } else if (typeof Buffer !== "undefined" && Buffer.isBuffer(data)) {
       this.attributes.metaData.size = data.length;
       this._source = Promise.resolve({ data, type: guessedType });
     } else if (_.isString(data)) {

src/file.js

@@ -1,6 +1,6 @@
 var _ = require('underscore');
 var Promise = require('./promise');
-var localStorage = require('./browserify-wrapper/localStorage');
+var localStorage = require('./utils/localstorage');
 
 var syncApiNames = [
   'getItem',

src/localstorage.js

@@ -124,12 +124,7 @@ const setHeaders = (authOptions = {}) => {
   if (AV._config.applicationProduction !== null) {
     headers['X-LC-Prod'] = AV._config.applicationProduction;
   }
-  if (!AV._config.isNode) {
-    headers['X-LC-UA'] = `AV/${AV.version}`;
-  } else {
-    // LeanEngine need use AV._config.userAgent
-    headers['User-Agent'] = AV._config.userAgent || `AV/${AV.version}; Node.js/${process.version}`;
-  }
+  headers[AV._config.isNode ? 'User-Agent' : 'X-LC-UA'] = AV._config.userAgent;
 
   return Promise.resolve().then(() => {
     // Pass the session token

src/request.js

@@ -0,0 +1 @@
+module.exports = [];

src/ua/comments-browser.js

@@ -0,0 +1 @@
+module.exports = [`Node.js/${process.version}`];

src/ua/comments.js

@@ -0,0 +1,4 @@
+const version = require('../version');
+const comments = [process.env.PLATFORM || 'Node.js'].concat(require('./comments'));
+
+module.exports = `LeanCloud-JS-SDK/${version} (${comments.join('; ')})`;