smart-window-models-devtools

This is an unsigned, privileged Firefox extension that exports SmartWindow model contextual data to help the Models team debug issues.

Installation

Because this extension is unsigned and privileged, you must first set 2 prefs in about:config:

1. extensions.experiments.enabled to true -> Enables experiments so the extension can define its own API outside the normal WebExtension APIs
2. xpinstall.signatures.required to false -> Disables requiring extension signatures

Next, download the latest extension from the GitHub releases. It will be a zip file.

Open Nightly, and from the hamburger menu on the far right, choose "Extensions and themes".

On the next page, make sure you're on the "Extensions" page. If not, click "Extensions" on the left side. Click the gear next to "Manage Your Extensions", and choose "Install Add-on From File...". Pick the zip you just downloaded.

Nightly will say the extension is unverified. This is because it's not signed. Click "Add". You should see the extension in your installed list.

Usage

smart-window-models-devtools creates a blue "Export Conversation" button at the top right of the SmartWindow new tab page and sidebar. At any point, you can click this button to create a model context dump file.

When you click on the button, a pop up will overlay the screen with the following fields (all optional!):

1. Bugzilla URLs: 1 or more URLs to Bugzillas associated with the dump file. Click the + to add more or the x to remove ones you don't want anymore. That said, the export will ignore any left blank.
2. Browsing History: A dropdown with several common choices for browsing history datetime ranges relative to "now" (i.e. "Last 1 hour"). If you want to be more specific, you can choose "Custom range...", which will open 2 text boxes for start and end datetime.
3. Notes: A freeform field for you to include whatever information you want to leave.

Keyboard shortcuts Ctrl+Shift+E on Windows and Cmd+Shift+E on Mac or clicking the extensions icon (puzzle piece) and then the extension name will also open the same pop up.

Click save and choose a location and file name for your dump file. It will be a JSON file. Hand this to the Models team.

FAQ

Debugging

Q: When I try to install the extension, I get the following error:

Error: can't access property "exportToFile", browser.experiments.smartwindow is undefined

A: We found this happens if you install the extension before setting the preferences in installation steps 1 and 2. To fix this:

1. Uninstall the extension
2. Set the prefs correctly
3. Restart firefox
4. Reinstall the extension