@jetshop/core 3.13.4 → 3.13.5-non-polyfill

package/analytics/README.md

@@ -1,81 +0,0 @@
-# Analytics, tracking and ab-testing
-
-The files in this directory take cares of tracking in different ways. The current functionality only support sending
-data to google analytics but it is partly prepared for using different frameworks as well.
-
-## What remains to do
-* The google analytics id is hardcoded in tha call to `initGA/init(trackingID)` in `boot.tsx`, that should be in
-a config file.
-* Support for other analytics/tracking tools
-* Perhaps support for multiple experiments. There are however not to smart to have multiple experiments running at the
-same time since this can ruin the statistics. Also google analytics experiments does not support multiple experiments at
-the same time.
-* Update the queries for the new graphQL api/structure. Specifically how categories are handled.
-* `init_experiment.ts` should be configured somewhere else.
-* Track also non-product and category pages as page views. (There is support for this but it is not done in
-the-gear-store, this might be needed to do in all stores). This also must be done to the pathname to be right for the
-other tracking.
-* Perhaps more explicit types in `tracking` and `googleAnalytics`.
-* `trackList` should also make additional graphQL requests to ensure that we have all data we want to track. The one
-thing that is not tracked in the-gear-store is the category of the product.
-* Now showing the cart is tracked as the first step in the checkout procedure. This should probably be changed.
-
-## How the tracking api is to be used in a store
-* The tracking of pageviews is handled in `DynamicRoute` for product and category pages automatically. Fore other pages,
-track by using the `Analytics` component with the `trackPage` function.
-* Whenever a product is shown this should be tracked. If multiple products is shown it should be tracked as an
-impression. This is done by the tracking function `trackList`. It is only when the details is viewed it should be
-tracked with `trackProduct` with action view.
-* The `trackProduct` supports the actions `click` (when a product is clicked), `view` (when the details about a product
-is viewed), `add` (when added to the cart) and `remove` (when removed from the cart).
-* The Experiment is set up with the `init_experiment` file and the experiment is then used as the example in the
-product page in the-gear-store.
-* There are `Analytics` components in the-gear-store at `Product`, `ProductGrid` ans `Cart`. These might not need to be
-tracked in the store if some of the code is moved to the framework.
-* For a/b testing there are three things to do. One should define the experiment in google analytics, make the
-specifications in `init_experiment` and write the code for the experiment. The structure looks like this:
-```
-<Experiment name="TheNameOfTheExperiment">
-  <Variant name="control">
-    // this is shown for variation namned "control"
-  </Variant>
-  <Variant name="v1">
-    // This is shown for variation namned "v1"
-  </Variant>
-</Experiment>
-```
-
-## Some design decisions
-* The order of the variations in the code does not matter. Instead the order of the names in `init_experiment` and at
-google analytics experiment (which have to be the same!) determine which is the "correct" order of the variants. The
-names of the variant is what matters in the code.
-* Since we can not access the `chooseVariation` function from the cxapi at the server and early enough, we decide the
-variation version ourselves and store the chosen both in a cookie ourselves and send the selection via cxapi to track
-the experiment in the experiment view in google analytics. This have the upside that it is easier to change google
-analytics experiment to another framework.
-* The `Category` component does not need a `Analytics` component but instead pass down the name of the category to the
-`ProductGrid` that takes care of the tracking.
-
-## Specific information about the files
-
-* `abExperiments.tsx` - includes two classes that together forms an experiment. The exported class `Experiment` is the
-class `ExperimentWithoutCookie` with `withCookie` and stores the variation id in a cookie that is also available on the
-server. This class uses the `init_experiment` file to know how the experiments look like. The `Variation` class just
-provides the property `name` that is used to determine what variation that is used.
-* `init_experiment.ts` - used to specify how the experiment look like. See the file for an example.
-The current supported fields are
-```
- experiment: string,   // the name/custom id of the experiment
- id: string,           // the experiment id given from google analytics experiments
- variations: string[], // list of variation namnes
- weights: int[]        // list of weigths for the different variations, this is used
-                       // to calculate a percentage of traffic to the different versions.
-```
-* `Analytics.tsx` - component for tracking various things. Calls the track function on mounting.
-* `tracking.ts` - there are three main tracking functions used to track a product, cart, list and page. These takes the
-`TrackArguments` as input, product and cart do additional graphQL queries to make sure we have all the data we want to
-track. All functions makes a call to some function in `googleAnalytics`. If no action are specified, `view` is the default.
-* `googleAnalytics.ts` - using the ga-function provided by `initGA`, the data is send to google analytics.
-* `initGA.js` - this contains the standard google analytics tracking script as well as exporting the ga function for use
-in other files.
-