[DO NOT MERGE] Comments on the current implementation

.circleci/config.yml

@@ -8,7 +8,7 @@ version: 2.1
 jobs:
   Linting:
     docker:
-      - image: cimg/node:14.13.1
+      - image: cimg/python:3.8.8-node
     steps:
       - checkout
       - run:
@@ -23,7 +23,7 @@ jobs:
 
   Firefox integration tests:
     docker:
-      - image: cimg/node:14.13.1
+      - image: cimg/python:3.8.8-node
     steps:
       - checkout
       - run:

.eslintignore

@@ -1 +1,2 @@
 dist
+tests/integration/webarchive

.eslintrc.js

@@ -40,14 +40,14 @@ module.exports = {
     "mocha"
   ],
   root: true,
+  ignorePatterns: [ "compiled-ts/**/*.js" ],
   rules: {
     "node/no-deprecated-api": "error",
     "node/no-extraneous-require": "off",
     "node/no-missing-import": "off",
     "node/no-unpublished-import": "off",
     "node/no-unpublished-require": "off",
     "node/no-unsupported-features/es-syntax": "off",
-
     "no-multi-spaces": "error",
     "no-unused-vars": [ "error", { vars: "all", args: "none", ignoreRestSiblings: false } ],
     "no-var": "warn",

.github/story.md

@@ -0,0 +1,19 @@
+---
+name: Story
+about: Use this to file a new story for a cycle
+title: "[story]"
+assignees: ''
+
+---
+
+## Story
+
+*fill this out*: as a **PERSONA**, I want to **BE ABLE TO DO SOME TASK** so that I can **ACHIEVE AN INTENDED OUTCOME**.
+
+## Definition of Done (optional)
+
+*Write out the concrete deliverable here in a sentence.*
+
+## Tasks (optional)
+
+*List all the tasks needed to close this story. You can follow the [task list](https://docs.github.com/en/github/managing-your-work-on-github/about-task-lists) syntax. Feel free to link to each task as its own github issue!*

.gitignore

@@ -105,3 +105,15 @@ dist
 
 # Generated study files
 web-ext-artifacts/
+
+# Compiled Typescript .js
+compiled-ts/
+
+.DS_Store
+
+# Testing output files
+tests/output/
+
+# Glean-related files
+.venv/
+src/generated/

OpenSearch/Brave.xml

@@ -0,0 +1,10 @@
+<?xml version="1.0" encoding="utf-8"?>
+<OpenSearchDescription xmlns="http://a9.com/-/spec/opensearch/1.1/">
+  <ShortName>Brave</ShortName>
+  <LongName>Brave</LongName>
+  <Description>Brave Search: private, independent, open</Description>
+  <InputEncoding>UTF-8</InputEncoding>
+  <Image width="32" height="32" type="image/png">https://cdn.search.brave.com/serp/v1/static/brand/eebf5f2ce06b0b0ee6bbd72d7e18621d4618b9663471d42463c692d019068072-brave-lion-favicon.png</Image>
+  <Url type="text/html" method="get" template="https://search.brave.com/search?q={searchTerms}"/>
+  <Url type="application/x-suggestions+json" method="get" template="https://search.brave.com/api/suggest?q={searchTerms}"/>
+</OpenSearchDescription>

README.md

@@ -1,80 +1,14 @@
-# Mozilla Rally study template.
-The purpose of this repository is to provide a starting point to build a Rally study. It contains:
+# Search Engine Usage Study [DECOMMISSIONED]
+A study to assess how individuals interact with their search engines.
 
-1. an example [`manifest.json`](https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/manifest.json) file.
-2. an example background and content script in `src/`.
-3. a rollup config file that builds the files needed for the web extension using the source files in `src/` (the background & content scripts).
-4. an example integration test that launches a browser & installs the add-on.
-5. a `web-ext-config.js` file & an eslint configuration.
-
-## Getting started
-
-1. Fork this repository.
-2. Customize the [manifest.json](./manifest.json) file:
-  * change the `name`, `author`, and `description` properties;
-  * swap the value of `application.gecko.id` (e.g. `[email protected]`) with the one provided you by the Rally team;
-3. Customize the [package.json](./package.json) file. At a bare minimum, change the `name`,`description`, `version`, `author`, `repository`, `bugs`, and `homepage` properties;
-4. Provide the encryption data to the `Rally` class constructor in the [src/background.js](./src/background.js) file:
-
-```js
-rally.initialize(
-  // A sample key id used for encrypting data.
-  "sample-invalid-key-id",
-  // A sample *valid* JWK object for the encryption.
-  {
-    "kty":"EC",
-    "crv":"P-256",
-    "x":"f83OJ3D2xF1Bg8vub9tLe1gHMzV76e8Tus9uPHvRVEU",
-    "y":"x_FEzRu9m36HLN_tue659LNpXW6pCyStikYjKIWI5a0",
-    "kid":"Public key used in JWS spec Appendix A.3 example"
-  },
-  // ... other required arguments ...
-);
-```
-
-4. From the forked repository directory, install all the NPM dependencies:
-
-```bash
-fork-dir> npm install .
-```
-
-5. Test the customized study in Firefox and commit your changes: doing this right after the initial fork provides a nice and clean cutting point with the original repository, which will simplify future updates (if needed).
-
-## Building upon this template
-This template uses [rollup.js](https://rollupjs.org/) as a module bundler and NPM for dependency management. The [manifest.json](./manifest.json) file already includes a sample background scripts.
-
-Dependencies can be added using the [`npm install`](https://docs.npmjs.com/cli/v6/commands/npm-install) command, using the appropriate `--save-dev` or `--save-prod` switch. This command will take care of automatically updating the [package.json](./package.json) file.
-
-New modules can be added in the `src/` directory. Modules need to expose the exported functions using the `module.exports` syntax. For example, a class can be exported as follows in a `MyClass.js` file:
-
-```js
-module.exports = class MyClass {
-  myFunc() {
-    console.log("Testing!");
-  }
-}
-```
-
-And then be imported in another file with `const MyClass = require("./MyClass.js");`.
-
-Plain functions can be exposed as follows in a `MyFuncs.js` file:
-
-```js
-module.exports = {
-  myTest() {
-    //... something!
-  },
-  otherFunc() {
-    // ... other function!
-  }
-};
-```
-
-And then be imported in another file with `const {myTest, otherFunc} = require("./MyFuncs.js");`.
+## Requirements
+* [Node.js](https://nodejs.org/en/), available via [Homebrew](https://brew.sh/) on macOS
+* [Mozilla web-ext](https://extensionworkshop.com/documentation/develop/getting-started-with-web-ext/)
 
 ## Supported NPM commands
-The template comes with a set of pre-defined NPM commands (to run as `npm run <command>`) to help study authors:
+The repo comes with a set of pre-defined NPM commands (to run as `npm run <command>`):
 
+* `compile-typescript`: Compiles the Typescript source code. The compiled code is saved in the `src/` directory.
 * `build`: assembles the final addon. The bundler generated code is saved in the `dist/` directory.
 * `dev`: assembles the addon in _developer mode_. In this mode data doesn't get submitted but, instead, is dumped to the [Browser Console](https://developer.mozilla.org/en-US/docs/Tools/Browser_Console). This mode allows for a smoother development process.
 * `lint`: run linting on the add-on code.
@@ -85,3 +19,5 @@ The template comes with a set of pre-defined NPM commands (to run as `npm run <c
 
 ## Manual testing in the browser
 To test, either load as a temporary add-on in Firefox (`about:debugging`) or Chrome ("developer mode" in `chrome://extensions`) or use `npm run start`.
+
+Debugging output is available in Tools → Web Developer → Browser Console. Make sure that the Show Content Messages option is checked. You might find it helpful to set a filter for debugging messages of interest.

babel.config.cjs

@@ -0,0 +1,7 @@
+module.exports = {
+    presets: [
+        ['@babel/preset-env', { targets: { node: 'current' } }],
+        '@babel/preset-typescript',
+    ],
+    sourceMap: 'inline'
+};