mirror/appium
1
0
Fork 0
mirror of https://github.com/appium/appium.git synced 2026-02-05 17:18:52 -06:00
Code Issues Packages Projects Releases Wiki Activity

feat(appium): add env var to trigger reloading of extensions

Browse Source 
this is useful during driver/plugin development, so the appium server does not always
need to be restarted, at least not when extensions are created on new sessions
This commit is contained in:
Jonathan Lipps
2021-09-14 15:15:31 -07:00
parent 96079de6b3
commit ff3bb4f4b5
2 changed files with 23 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
docs/en/contributing-to-appium/developers-overview.md
View File

@@ -83,6 +83,22 @@ changes and automatically re-transpile the code. Usually, the same tool will
automatically run unit tests as well to ensure that nothing small has broken.
Most Appium packages have this as the default behavior when running `gulp`.
### Hacking on Extensions
If you are building an Appium driver or plugin, you can always link your development version into
an Appium server so that as you make changes, you don't have to publish/install as part of your dev
cycle:
```
appium driver install --source=/path/to/your/local/dev/repo
```
If you make changes to your extension while the Appium server is already running, those changes
won't be picked up since Appium has loaded your extension into memory. If you want to have
something approaching a "hot reload", then run appium with the `APPIUM_RELOAD_EXTENSIONS=1` env
var. This will cause Appium to reload your extension any time it would be instantiated, for
example, on a new session request.
### Linting and Style
It's important for all of Appium's JS to look and feel the same. This includes

8
packages/appium/lib/extension-config.js
View File

@@ -203,7 +203,13 @@ export default class ExtensionConfig {
require (extName) {
const {mainClass} = this.installedExtensions[extName];
return require(this.getExtensionRequirePath(extName))[mainClass];
const reqPath = this.getExtensionRequirePath(extName);
const reqResolved = require.resolve(reqPath);
if (process.env.APPIUM_RELOAD_EXTENSIONS && require.cache[reqResolved]) {
log.debug(`Removing ${reqResolved} from require cache`);
delete require.cache[reqResolved];
}
return require(reqPath)[mainClass];
}
isInstalled (extName) {