Disable telemetry when data collection in Firefox is disabled

This WebExtension is NOT maintained anymore. The development of Firefox Translation moved into Firefox itself and will be available for anyone from Firefox 108.

Please open new issues in https://bugzilla.mozilla.org/enter_bug.cgi?product=Firefox&component=Translation

Firefox Translations

Firefox Translations was a WebExtension that enabled client side in-page translations for web browsers.

Firefox Translations was developed with The Bergamot Project Consortium, coordinated by the University of Edinburgh with partners Charles University in Prague, the University of Sheffield, University of Tartu, and Mozilla. This project has received funding from the European Union’s Horizon 2020 research and innovation programme under grant agreement No 825303. 🇪🇺

Release version

Desktop

The current release version is available for installation on Mozilla Add-ons

Android

Follow the steps below to install the extension on Firefox Nightly or Beta for Android:

Apply the steps described on this article, skipping the section Create a collection on AMO (we already provide a collection here) and starting from the section Enable general extension support setting in Nightly
On step 5, input 17436609 in the Collection owner field, and fxt in the Collection name field
Your browser should restart.
After restarting, click on the three dot menu and select Add-ons
The Add-ons page should be displayed and Firefox Translations appear at the top of the list. Just click on the + icon to have it installed
With that you should have the addon added to your browser. Please refer to this video on how to use the extension.
You can then remove the Custom Addon-on collection, just by clicking at it and clearing the fields, so you could have the stock addons listed again.

Supported languages

Production

Spanish
Estonian
English
German
Czech
Bulgarian
Portuguese
Italian
French
Polish

Development

Russian
Persian (Farsi)
Icelandic
Norwegian Nynorsk
Norwegian Bokmål
Ukrainian
Dutch

Testing

Nightly builds

Desktop

You can test nightly builds of the extension in Firefox Nightly or Developer Edition in one of the supported languages by following the steps below:

Type about:config in the navigation bar and set the following preferences:

    xpinstall.signatures.required to false
    extensions.experiments.enabled to true

Then install the extension by clicking here
You may need to restart your browser and Firefox Translations will be ready to use. Just browse to a website in one of the supported languages and the option to translate should be displayed.

Demo

Firefox.Translations.v2.mov

Android

You can test the addon on Android by following the steps below:

Clone this repo and execute npm install
Install Firefox Nightly for Android in your phone
Connect your phone to your computer via USB
Follow these steps in order to setup your phone and browser to install the addon
You might need to execute adb shell pm grant org.mozilla.fenix android.permission.READ_EXTERNAL_STORAGE in your terminal so the addon could be pushed to your phone
Execute adb devices in your terminal, copy the device id, and replace the string <device id from adb devices> on package.json by it
Execute npm run android -- --android-device=<ANDROID_DEVICE_ID> in your terminal to install the addon in your phone and have the browser automatically started (or npm run android-win -- --android-device=<ANDROID_DEVICE_ID> if developing on a Windows system)

That should be enough to have the addon installed on Firefox in your Android. Folow the steps in the video below to learn how to use it.

Demo

screen-20230302-100129.mp4

Development

3rd party dependencies

The extension does not utilize any npm modules, and the only vendored dependencies within are:

Bergamot Translator
- A WebAssembly wrapper around the actual Neural Machine Translator, Marian. The code to build the WASM module can be found on its repository
Fasttext
- We bundle the WebAssembly port of fasttext along its compressed model in order to detect the page's language. Instructions to build the WebAssembly module can be found here
Sentry
- We bundle Sentry Javascript's SDK for error reporting.
serialize-error
- code of serialize-error npm package is bundled for serialization of exceptions to report errors from content scripts to background script

How to run

Install Firefox Nightly
Clone this repo and run npm install
Run npm run once and wait until Nightly starts
Go to about:config and set extensions.experiments.enabled to true
Browse to a page in any of the supported languages to have the translation option to appear

Updating telemetry schema

After adding new metrics to extension/model/telemetry/metrics.yaml or pings to extension/model/telemetry/pings.yaml, run

bash scripts/update-telemetry-schema.sh

to regenerate JS telemetry schema.

Updating bergamot-translator WASM module

Replace

extension/controller/translation/bergamot-translation-worker.js
extension/model/static/translation/bergamot-translator-worker.wasm

with the new artifacts and then execute:

bash scripts/update-bergamot-translator.sh

to regenerate JS version file. This version is reported in telemetry.

Discussions

Firefox translations channel on Matrix

	submitTranslation(node, key) {
	if (this.messagesSent.has(key)) {
	// if we already sent this message, we just skip it
	return;
	}
	const text = node.textContent;
	if (text.trim().length) {

	/*
	* send the content back to mediator in order to have the translation
	* requested by it
	*/
	const payload = {
	text,
	type: "inpage",
	attrId: [
	this.processingNodeMap,
	key
	],
	};
	this.notifyMediator("translate", payload);
	this.messagesSent.add(key);
	}
	}

mozilla / firefox-translations Goto Github PK

firefox-translations's Introduction

This WebExtension is NOT maintained anymore. The development of Firefox Translation moved into Firefox itself and will be available for anyone from Firefox 108.

Firefox Translations

Release version

Desktop

Android

Supported languages

Production

Development

Testing

Nightly builds

Desktop

Demo

Android

Demo

Development

3rd party dependencies

How to run

Updating telemetry schema

Updating bergamot-translator WASM module

Discussions

firefox-translations's People

Contributors

Stargazers

Watchers

Forkers

firefox-translations's Issues

Recommend Projects

Recommend Topics

Recommend Org