1.10.1

* Reinstall node modules before shrinkwrapping
* Add script to check shrinkwrap will be packaged

check-npm-pack-files.js

@@ -0,0 +1,21 @@
+const childProcess = require('child_process');
+const _ = require('lodash');
+
+const res = JSON.parse(childProcess.execSync('npm pack --dry-run --json --ignore-scripts', {encoding: 'utf8'}))[0];
+
+// List of files we are testing to make sure they are included in package
+const testFiles = [
+  'npm-shrinkwrap.json', // Check that npm-shrinkwrap.json is being packed
+  'LICENSE', // Check that license is included
+  'build/lib/appium.js', // Sanity check that build files are being included by testing just one file
+];
+
+// Get list of files in `testFiles` that aren't in the list of packaged fileNames
+const missingFiles = _.without(testFiles, ..._.map(res.files, 'path'));
+
+if (!_.isEmpty(missingFiles)) {
+  throw new Error(`Files [${missingFiles.join(', ')}] are not included in package.json "files". ` +
+    `Please make sure these files are included before publishing.`);
+}
+
+process.exit(0);

docs/en/contributing-to-appium/developers-overview.md

@@ -180,8 +180,7 @@ converted into the `npm-shrinkwrap.json` file.
 1. Determine whether we have a `patch` (bugfix), `minor` (feature), or `major` (breaking) release according to the principles of SemVer.
 1. Update `package.json` with the appropriate new version.
 1. Update the CHANGELOG/README with appropriate changes and submit for review as a PR, along with shrinkwrap and `package.json` changes. Wait for it to be merged, then pull it into the release branch.
-1. `rm -rf node_modules && npm install --production` to get just the production dependencies.
-1. `npm shrinkwrap` to write the new NPM shrinkwrap JSON file, and commit this file.
+1. Run `npm run shrinkwrap:prod`. This script removes `node_modules`, installs node production dependencies, creates `npm-shrinkwrap.json` (which only shrinkwrap prod dependencies) and then re-installs the dev dependencies by doing `npm install --no-shrinkwrap`.
 1. Create a tag of the form `v<version>` on the release branch (usually a minor branch like `1.5` or `1.4`), with: `git tag -a v<version>`, e.g., `git tag -a v1.5.0`. This is not necessary for beta versions.
 1. Push the tag to upstream: `git push --tags <remote> <branch>`
 1. Install dev dependencies (or at least `gulp` and `appium-gulp-plugins`), and undo the changes to the NPM shrinkwrap JSON file (e.g., `git checkout -- npm-shrinkwrap.json`).

docs/en/writing-running-appium/server-args.md

@@ -14,6 +14,7 @@ All flags are optional, but some are required in conjunction with certain others
 |Flag|Default|Description|Example|
 |----|-------|-----------|-------|
 |`--shell`|null|Enter REPL mode||
+|`--allow-cors`|false|Turn on CORS compatibility mode, which will allow connections to the Appium server from within websites hosted on any domain. Be careful when enabling this feature, since there is a potential security risk if you visit a website that uses a cross-domain request to initiate or introspect sessions on your running Appium server.||
 |`--ipa`|null|(IOS-only) abs path to compiled .ipa file|`--ipa /abs/path/to/my.ipa`|
 |`-a`, `--address`|0.0.0.0|IP Address to listen on|`--address 0.0.0.0`|
 |`-p`, `--port`|4723|port to listen on|`--port 4723`|

lib/main.js

@@ -122,7 +122,12 @@ async function main (args = null) {
   await logStartupInfo(parser, args);
   let appiumDriver = new AppiumDriver(args);
   let router = routeConfiguringFunction(appiumDriver);
-  let server = await baseServer(router, args.port, args.address);
+  let server = await baseServer(router, args.port, args.address, args.allowCors);
+  if (args.allowCors) {
+    logger.warn('You have enabled CORS requests from any host. Be careful not ' +
+                'to visit sites which could maliciously try to start Appium ' +
+                'sessions on your machine');
+  }
   appiumDriver.server = server;
   try {
     // TODO prelaunch if args.launch is set

lib/parser.js

@@ -13,6 +13,15 @@ const args = [
     dest: 'shell',
   }],
 
+  [['--allow-cors'], {
+    required: false,
+    defaultValue: false,
+    action: 'storeTrue',
+    help: 'Whether the Appium server should allow web browser connections from any host',
+    nargs: 0,
+    dest: 'allowCors',
+  }],
+
   [['--reboot'], {
     defaultValue: false,
     dest: 'reboot',

package.json

@@ -11,7 +11,7 @@
     "firefoxos",
     "testing"
   ],
-  "version": "1.9.2-beta.2",
+  "version": "1.10.1",
   "author": "https://github.com/appium",
   "license": "Apache-2.0",
   "repository": {
@@ -36,13 +36,14 @@
   "files": [
     "bin",
     "lib",
-    "build/lib"
+    "build/lib",
+    "npm-shrinkwrap.json"
   ],
   "dependencies": {
     "@babel/runtime": "^7.0.0",
     "appium-android-driver": "^4.0.0",
     "appium-base-driver": "3.x",
-    "appium-espresso-driver": "^1.0.0",
+    "appium-espresso-driver": "^1.3.0",
     "appium-fake-driver": "^0.x",
     "appium-ios-driver": "2.x",
     "appium-mac-driver": "1.x",
@@ -51,8 +52,8 @@
     "appium-tizen-driver": "1.1.1-beta.2",
     "appium-uiautomator2-driver": "1.x",
     "appium-windows-driver": "1.x",
-    "appium-xcuitest-driver": "2.x",
-    "appium-youiengine-driver": "1.x",
+    "appium-xcuitest-driver": "^2.104.0",
+    "appium-youiengine-driver": "^1.1.1",
     "argparse": "^1.0.10",
     "async-lock": "^1.0.0",
     "asyncbox": "2.x",
@@ -84,7 +85,7 @@
     "coverage": "gulp coveralls",
     "generate-docs": "node ./build/commands-yml/parse.js",
     "clean": "rm -rf node_modules && rm -rf package-lock.json && npm install",
-    "clean:prod": "rm -rf node_modules && rm -rf package-lock.json && npm install --production",
+    "shrinkwrap:prod": "rimraf package-lock.json && rimraf node_modules && npm install --production && npm shrinkwrap && node ./check-npm-pack-files && npm install --no-shrinkwrap",
     "zip": "zip -qr appium.zip .",
     "upload": "node ./build/test/scripts/bintray-upload.js",
     "zip-and-upload": "npm run zip && npm run upload",