Skip to content

Latest commit

 

History

History
166 lines (100 loc) · 9.77 KB

README.md

File metadata and controls

166 lines (100 loc) · 9.77 KB
Raw

Firefox Voice

Firefox Voice is an experiment from Mozilla Emerging Technologies.

Firefox Voice is a browser extension that allows you to give voice commands to your browser, such as "What is the weather?" or "Find the gmail tab". Initially, the goal is to provide any useful interactions. Ultimately, the goal is to see if we can facilitate meaningful user interactions with the web using just voice-based interactions.

Launcher Usage

Launcher is located in the top right corner of the browser window having mic icon, as shown below.

launcher location doc

Launcher contains 2 input modes :

  • Voice: You can give voice commands to your browser if the popup is open and listening.

  • Text: You can paste text or start typing the command when the popup is open. An input box and Go button appears when you start typing.

  • How it works: Demo video

Discussion

If you have a bug or idea you want to develop, you can open a new issue in this repository. You can also submit feedback using this feedback form. We are very interested in any feedback you have about using this tool!

If you'd like to discuss the tool, development, or contributions, we are in the firefox-voice channel on chat.mozilla.org (direct link to channel). Note that the team mostly works weekdays, North American work hours, so you may experience a delay in response.

Developing in Linux

To setup your local development environment, read the installation instructions here

There is some documentation in the docs/ directory, notably writing an intent.

By default messaging-related logging messages aren't shown, you can turn logging up slightly with $LOG_LEVEL=messaging (or like LOG_LEVEL=messaging npm start).

Any changes you make should cause any .jsx files to be recompiled and the extension will be reloaded.

After the project successfully starts, firefox will be automatically opened along with a console window. The console window consoles various kind of information.

The following errors or warnings should not concern you as these are not related to our project. So these can be ignored:

  1. Manifest warnings

You will probably see manifest warnings of the format:

<long number>	addons.webextension.doh-rollout@mozilla.org	WARN	Loading extension 'doh-rollout@mozilla.org': Reading manifest: Invalid extension permission: networkStatus
  1. Any error that comes from file ending with .jsm

Startup Issues

You may face errors on performing npm install that can be resolved by updating the node to its latest version see here

If a new browser does not open, it might be because the path to Nightly is not found. Use the command FIREFOX="/usr/bin/firefox" npm start instead.

By default this will use Firefox Nightly, but you can override this with the environmental variable $FIREFOX (you can point it to a release version, but some things may not work; also you can use a localized Firefox or an unbranded Firefox). You can also set $PROFILE to a directory where the profile information is kept (it defaults to ./Profile/).

Running Tests

  1. For running tests, run npm test. This command does the following:
    • Compiles JavaScript
    • Runs all tests
    • Checks the code formatting using prettier
    • Lints the code using eslint
  2. While firefox-voice makes use of jest, it has been excluded from continuous integration (CI) because CI couldn't handle the module rewrites.
  3. npm test runs npm run jest locally on node v13.8.0 in the development process.
  4. New jest unit tests can be added because npm test still runs jest locally. For examples to guide you, refer to files with the .test.js extension.
  5. npm run test:selenium runs Selenium tests.
  6. Many formatting and linting problems can be automatically fixed by running npm run lint:fix. In order to keep the firefox-voice codebase healthy and running properly, these tools are used:
    • Prettier formats and keeps the code the same way, saving energy and time
    • ESLint spots problems and errors, also saving everyone's energy and time
    • Stylelint helps to avoid errors and enforce conventions in stylesheets

Debugging

In Firefox Voice there are several separate processes where things run (see also Anatomy of an extension):

  1. The "background page". This is a persistent page that belongs to the extension, and is where most of the work is done. For debugging this specifically see this about:debugging document.
  2. The popup. This is its own page (in extension/popup/) and handles some of the initial lifecycle of invoking an intent. In most ways it is a normal page, but it runs in the short-lived popup. See the next section for a technique to debug this.
  3. The recorder tab. This is its own pinned tab that holds the media stream (because we have to keep this open to avoid permission issues). It is its own page. You can use the normal debugging tools on it.
  4. The search tab. This is also its own pinned tab that holds Google searches. It is not long-lived (each search causes it to reload), but it is specifically managed by the extension. The extension-specific code is run in content scripts, and normal debugging tools mostly work but can be finicky.
  5. Other content scripts. Any page that the extension manages directly (e.g., clicking controls, reading information) has content scripts injected.

The most reliable way to debug these is with the Browser Console, which should open automatically, or you can open with Tools > Web Developer > Browser Console. You should change the settings on the console using the gear icon in the upper-right, and turn on Show Content Messages (otherwise logging from the popup and some of these other sources will not be displayed). This setting should persist.

Debugging the popup

The popup can be hard to debug, since it disappears and there's no debugging tools. But the popup can also run in a tab. The easiest way to do this is to run:

OPEN_POPUP_ON_START=1 npm start

This will open the popup in a tab and reopen it whenever the extension restarts. Reloading the tab is equivalent to reopening the popup.

Writing a new command / intent

Please see Writing An Intent.

Using in-development versions

It's possible to install and use in-development versions of the extension. Every commit to master is built into the dev build, and when we prepare for a release and merge to stage is used to create the stage build.

NOTE THAT THESE VERSIONS INCLUDE EXTRA DATA COLLECTION

We are using these builds for internal testing with more-than-normal data collection. We have not yet implemented data collection controls.

The version numbers are increased for each release and each commit, but are not sequential.

Viewing Intent Information

There is an index of intents (commands) that is viewable if you open the panel, click on the gear/settings, and follow the "Intent Viewer" link.

Developing in Android

This is very experimental, but to develop for Firefox for Android, install Firefox (release) on your Android device.

To try, run:

npm run start-android

You may see an error message Android device ... was not found in list: ["99EAP164UC"]: if so, then 99EAP164UC (for example) is your Android device name. Try again:

export ANDROID_DEVICE=99EAP164UC
npm run start-android

You might have to install adb and enable some permissions as well. For more instructions, please refer to the console.

For some more information:

Contributing

See the guidelines for contributing to this project.

This project is governed by a Code Of Conduct.

To disclose any potential security vulnerability please see our security documentation.

Contributors

Wakeword provided by the Howl Project: Jaejun Lee, Ralph Tang, Jimmy Lin, University of Waterloo.

Made with contributors-img.

License

This module is licensed under the Mozilla Public License, version 2.0.