Price Tracker is a Firefox extension that tracks price changes to help you find the best time to buy.
IMPORTANT: Price Tracker is no longer under active development. Official support for Price Tracker ended on September 30, 2019.
See METRICS.md.
Prerequisites:
Clone the repository:
git clone https://github.com/mozilla/price-tracker.git cd price-tracker
Install dependencies:
Build the extension:
Run the built extension in a test browser:
Note: This will install the extension as an unsigned WebExtension Experiment.
about:config preferences xpinstall.signatures.required set to false and extensions.legacy.enabled set to true.npm start Launch Firefox with the extension temporarily installed npm run lint Run linting checks npm run build Compile source files with Webpack using a development configuration npm run build:prod Compile source files with Webpack using a production configuration npm run watch Watch for changes and rebuild with Webpack using a development configuration npm run watch:prod Watch for changes and rebuild with Webpack using a production configuration npm run package Package the extension into an XPI file pipenv run test Run test suite (See "Running Tests" for setup)
Global state for the add-on is managed via Redux. Any time the data is changed, it is persisted to the add-on local storage.
Reducers, action creators, etc. are organized into ducks inside the src/state directory.
A fake product page is available for testing the add-on. The price on the page changes upon refresh, and URL parameters can be used to manually set the price.
See the github repo for more details.
Automated tests are run in a Firefox browser instance using Marionette. We use the Python client for Marionette since there is no up-to-date JavaScript client.
To set up your environment for running the tests, you must have:
.app folder at Firefox.app/Contents/MacOS/firefox.With these installed, you can set up the test suite:
Install Python dependencies:
Save the path to your Firefox binary with npm:
npm config set price-tracker:firefox_bin <PATH_TO_FIREFOX_BINARY>
After this, you can run pipenv run test to run the automated test suite.
The following preferences can be set to customize the extension's behavior for testing purposes. Some convenient testing values can be found in web-ext-config.js, and will be used by default with npm start.
extensions.shopping-testpilot@mozilla.org.extractionAllowlist
string) List of domains ({Array.string} or *) that extraction is performed on. Can be set to * to enable extraction on all sites.
extensions.shopping-testpilot@mozilla.org.priceCheckInterval
integer) Time to wait between price checks for a product in milliseconds.
extensions.shopping-testpilot@mozilla.org.priceCheckTimeoutInterval
integer) Time to wait between checking if we should fetch new prices in milliseconds.
extensions.shopping-testpilot@mozilla.org.iframeTimeout
integer) Delay before removing iframes created during price checks in milliseconds.
extensions.shopping-testpilot@mozilla.org.alertPercentThreshold
integer) The percentage drop in price on which to trigger a price alert compared to the last high price (See price_last_high in [METRICS.md](./docs/METRICS.md)).
extensions.shopping-testpilot@mozilla.org.alertAbsoluteThreshold
integer) The absolute drop in price on which to trigger a price alert compared to the last high price (see `price_last_high` in [METRICS.md](./docs/METRICS.md)) in currency subunits (e.g. cents for USD).
Price Tracker bumps the major version number for every release, similar to Firefox. Releases are created by tagging a commit that bumps the version number and pushing that tag to the repo. This triggers CircleCI automation that packages, tests, signs and uploads the new version to the Test Pilot S3 bucket.
It is strongly recommended that developers creating releases configure Git to sign their commits and tags.
To create a new release of Price Tracker:
Increment the version number in package.json, create a new commit on the master branch with this change, and create a new git tag pointing to the commit with a name of the form v1.0.0, where 1.0.0 is the new version number.
npm ships with a command that can perform these steps for you automatically:
Push the updated master branch and the new tag to the remote for the Mozilla Price Tracker repository (named origin in the example below):
git push origin master git push origin v1.0.0
You can follow along with the build and upload progress for the new release on the CircleCI dashboard. Once the build finishes, a signed copy of the new version will be available in the dashboard under Artifacts. The following upload job, however, is gated on a hold job.
This hold job is intended to provide developers and QA an opportunity for final testing and review of the extension in release channels before uploading. When QA is satisfied, a developer with push access must manually trigger the upload to Test Pilot via the CircleCI dashboard by clicking the hold job and approving the build.
Once the upload is complete, the new version should be available immediately at https://testpilot.firefox.com/files/shopping-testpilot@mozilla.org/latest.
The Commerce WebExtension is licensed under the MPL v2.0. See LICENSE for details.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.3