v1.0.0: Web support, more granular IDs, German translations

This release brings a whole host of improvements. Most prominently, TrackHAR now supports trackers on the web and brings adapters for fifteen new tracking companies, including Criteo, OpenX, Taboola, and Xandr. We have also added major new adapters for Google trackers including Google Analytics and Firebase Remote Config.

TrackHAR is now more granular with regards to which types of IDs trackers collect. The old otherIdentifiers property has been deprecated and replaced by more specific properties like deviceId, userId, and sessionId wherever possible. On mobile, the properties idfa and idfv have been renamed to advertisingId and developerScopedId, respectively, to make it clear that they don't only apply to iOS. Also, we are not listing locales under country anymore. These are breaking changes.

There have also been improvements to adapter matching. We are now ignoring any potential trailing slashes when checking whether an endpoint URL matches an adapter. And we have introduced filters for DataPaths to weed out false-positive matches (like advertisingId: unknown).

Additionally, we now include German translations in addition to the English ones.

Finally, this release brings an updated version of our jsonpath-plus dependency, which fixes a potential security vulnerability.

What's Changed

Breaking changes are marked in bold.

• Fixes #79: Add JWT decoding function by @baltpeter in #81
• Fixes #69: Adapter for Google Identity Toolkit v3 by @baltpeter in #70
• Bump micromatch from 4.0.5 to 4.0.8 by @dependabot in #82
• Fixes #34: Trim trailing slash from endpointUrl for matching by @baltpeter in #84
• Fixes #22: Don't list locale under country by @baltpeter in #85
• Fixes #21: Rename idfa>advertisingId, idfv>developerScopedId by @baltpeter in #86
• Fixes #45: Group otherIdentifiers by type by @baltpeter in #87
• Fixes #75: Adapter for Firebase Remote Config by @baltpeter in #76
• German translations by @baltpeter in #88
• loadTestDataFromDb: Load data in chunks of 100 rows by @baltpeter in #90
• Fixes #46: Filters for DataPaths by @baltpeter in #83
• Closes #73: Extract more data in google/firebaseinstallations by @baltpeter in #89
• Bump jsonpath-plus from 7.2.0 to 10.0.0 by @dependabot in #92
• Bump jsonpath-plus from 10.0.0 to 10.0.7 by @dependabot in #94
• Adapters for GTM and Google Analytics by @baltpeter in #91
• Adapters for various Criteo endpoints by @baltpeter in #93
• Various adapters for trackers that (also) have Prebid/OpenRTB endpoints by @baltpeter in #95
  • Adapter for Media.Net 1b480d1
  • Adapters for various Pubmatic endpoints f3c8ed2
  • Adapters for various Kidoz endpoints 6aa1b8c
  • Adapters for various Taboola endpoints 0d3725b
  • Adapters for various Adform endpoints d1904f9
  • Adapters for various Zemanta/Outbrain DSP endpoints b837c81
  • Adapters for various Magnite/Rubicon Project endpoints 1ec37dd
  • Adapters for various Adagio endpoints a110cea
  • Adapters for various ID5 endpoints 764af40
  • Adapters for various Xandr/AppNexus/Microsoft Advertising/Microsoft Invest/Microsoft Marketing endpoints 5cc58e6
  • Adapter for various Equativ/Smart AdServer endpoints ab3e258
  • Adapter for various Index Exchange/Casale Media endpoints 2c02cdc
  • Adapters for various OpenX endpoints c8a96d4

Full Changelog: v0.5.1...v1.0.0

v0.5.1: Security fix in developer dependencies

A security relevant bug in one of our dependencies allowed for DOS attacks. This was only affecting developers who used the auto archive script and therefore very low impact.

• Bump braces from 3.0.2 to 3.0.3 (#80) 0d1cfce

v0.5.0...v0.5.1

v0.5.0: Example data generation

This release only brings new scripts to generate example data for tracker-wiki. These scripts are not included in the distributed package.

• Towards tweaselORG/tracker-wiki#15: Add a script to generate adapter example data from the database (#56) 50053e7

v0.4.1...v0.5.0

v0.4.1: Bugfix

Fixes a formatting bug.

• Fix code snippet formatting 682cf92

v0.4.0...v0.4.1

v0.4.0: Translations, browser compat, new adapters

This release packages the translations for datatypes and adapter descriptions in TrackHAR. Previously, parts were included in https://github.com/tweaselORG/tracker-wiki. Also, it brings compatibility to run the library complete in the browser to enable web based analysis of HAR files. Finally, we added some more adapters for tracking endpoints by Google.

• Fixes #73: Adapter for Firebase Installations SDK (#74) 07dfa18
• Fixes #77: Expand match clause of facebook/graph-activities-qs (#78) f3951dc
• Fixes #52: Adapters for GoogleDataTransport FireLog (#72) 8edee8b
• More DoubleClick adapters (#68) dfc7a1e
• Fixes #64: Adapter for Google Funding Choices (#65) 2017d7a
• Translations and additional metadata for adapters (#59) f767229
• Make it possible to run TrackHAR in the browser (#61) 1b7c691

v0.3.1...v0.4.0

v0.3.1: Bump dependencies

This release mainly bumps protobufjs and msgpackr to versions that fix security vulnerabilities.

What's Changed

• Fix heading in a Adjust documentation by @zner0L in #55
• Bump protobufjs from 7.2.4 to 7.2.5 by @dependabot in #62
• Bump msgpackr from 1.8.5 to 1.10.1 by @dependabot in #63

Full Changelog: v0.3.0...v0.3.1

v0.3.0: Documentation for adapters

This release includes the documentation for the adapters, explaining, why certain properties in the analyzed traffic are mapped to the properties in the results of TrackHAR. This new documentation can be found in the research-docs/ folder of the repository, however, it is not part of the npm package (because it is not needed for running TrackHAR). The changes to the package include dependency updates and update to some of the adapters according to newly gathered data.

Furthermore, some development tools were added to the repository. There is now a script that tests an adapter against our open request database. You can use it like this (for more info, read the README at the root of the repository):

yarn debug-adapter <tracker slug>/<adapter slug>
# e.g.: yarn debug-adapter facebook/graph

Also, in order to archive the links included in the adapters, a script was added automatically gathering links that have not been archived yet and saving them in the Internet Archive. You can keep it running in the background, while you edit the adapters, so you can have it archive all the links you add automatically:

yarn auto-archive

For more info, you can refer to the README in the research-docs/ folder.

What's Changed

• Bump protobufjs from 7.2.3 to 7.2.4 by @dependabot in #18
• Bump semver from 5.7.1 to 5.7.2 by @dependabot in #19
• Bump word-wrap from 1.2.3 to 1.2.5 by @dependabot in #20
• Script for debugging adapters by @baltpeter in #17
• Towards tweaselORG/meta#3: Add research-docs folder by @zner0L in #32
• Towards tweaselORG/meta#36: Add auto-archiving script by @zner0L in #54
• Fixes #16: Adapter for singular.net by @baltpeter in #24
• Fixes #27: Better document Facebook adapters and add missing properties by @baltpeter in #35
• Fixes #26: Document adjust adapters by @baltpeter in #28
• Towards #9: Document branch-io/v1 by @baltpeter in #31
• Fixes #38: Document ioam adapters by @baltpeter in #43
• Fixes #44: Document Microsoft App Center adapter by @baltpeter in #47
• Fixes #49: Document OneSignal adapter by @baltpeter in #50
• Document smartbear/bugsnag-sessions and add adapter for notify.bugsnag.com by @baltpeter in #51

Full Changelog: v0.2.0...v0.3.0

v0.2.0: Indicator matching

In this release we introduce indicator matching as a fallback from our preferred adapter matching. You can provide a list of indicators which TrackHAR will then look for in the requests for which no adapter was defined. TrackHAR will also check for base64 and URL-encoded versions of the indicators.

Here is an example of how to use the new feature:

const data = await process(harJson, { indicatorValues: {
	deviceName: 'Sam’s iPhone',
	localIp: '192.168.0.42'
}});

What's Changed

• Fixes #8: Improve the README and explain how to contribute adapters by @zner0L in #13
• Fixes #6: Indicator matching by @baltpeter in #15

Full Changelog: v0.1.1...v0.2.0

v0.1.1: TrackHAR is now CC0

With this release, TrackHAR is now licensed under a Creative Commons CC0 1.0 Universal license. \o/

What's Changed

• Relicense as CC0 by @baltpeter in #12

Full Changelog: v0.1.0...v0.1.1

v0.1.0: First pre-release

This is the first pre-release version. We are pretty happy with the design now and welcome feedback on that.

Currently, most of the adapters from baltpeter/thesis-mobile-consent-dialogs are ported over but have received only limited additional testing and checking so far. Also, the documentation for the containedDataPaths is lacking behind what we are aiming for. That will be fixed in a future release.

What's Changed

• Initial implementation by @baltpeter and @zner0L in #1
• Export adapters in the module by @zner0L in #4
• Port over more adapters from baltpeter/thesis-mobile-consent-dialogs by @baltpeter in #2
• Write README and docstrings by @baltpeter in #7
• Fix a few errors based on testing adapters on 220k requests by @baltpeter in #11

Full Changelog: https://github.com/tweaselORG/TrackHAR/commits/v0.1.0