Forward local ports to remote debugging interfaces on connected Firefox OS devices
This is part of the node-firefox project.
Firefox OS devices offer a Remote Debugging service on a local network socket. This can be forwarded to a host computer over USB using ADB. This module takes care of that as necessary, reusing forwarded ports when possible.
git clone https://github.com/mozilla/node-firefox-forward-ports.gitcd node-firefox-forward-portsnpm install
If you want to update later on:
cd node-firefox-forward-portsgit pull origin masternpm install
npm install node-firefox-forward-ports
var forwardPorts = ;// Forwards ports as necessary, while reusing existing ports.// Returns the list of devices annotated with details on forwarded ports.;// forwardPorts() can also accept an options object, for future expansion// when additional options are supported.;
This example uses node-firefox-find-devices
to first assemble a list of connected Firefox OS devices. The output of
findDevices() is basically what
forwardPorts() expects for its
var findDevices = ;var forwardPorts = ;;
This example would result in output like the following, which consists of the
findDevices() altered to include a list of forward ports for each
"id": "3739ced5""type": "device""isFirefoxOS": true"ports":"local": "tcp:8001""remote": "localfilesystem:/data/local/debugger-socket""port": "8001"
The listing of each device returned from
findDevices() will be annotated with
ports property. This is a list of details on each port forwarded to the
local property contains the local side of the port forward. If this is a
TCP/IP port, then its numerical port can be found in the
remote property contains the remote side of the port forward, useful for
filtering and selecting particular kinds of forwarded ports. Currently, this
module only supports Firefox remote debugging sockets - but that could expand
in the future.
Running the tests
After installing, you can simply run the following from the module folder:
To add a new unit test file, create a new file in the
tests/unit folder. Any file that matches
test.*.js will be run as a test by the appropriate test runner, based on the folder location.
gulp behind the scenes to run the test; if you don't have it installed globally you can use
npm gulp from inside the project's root folder to run
Code quality and style
Because we have multiple contributors working on our projects, we value consistent code styles. It makes it easier to read code written by many people! :-)
Our tests include unit tests as well as code quality ("linting") tests that make sure our test pass a style guide and JSHint. Instead of submitting code with the wrong indentation or a different style, run the tests and you will be told where your code quality/style differs from ours and instructions on how to fix it.
This program is free software; it is distributed under an Apache License.
Copyright (c) 2015 Mozilla (Contributors).