@forge/util 0.0.0-experimental-383053a → 0.0.0-experimental-c3d0263

package/CHANGELOG.md

@@ -1,6 +1,54 @@
 # @forge/util
 
-## 0.0.0-experimental-383053a
+## 0.0.0-experimental-c3d0263
+
+### Minor Changes
+
+- 88e57a12: Add metrics interface dependency
+
+## 1.2.0-next.0
+
+### Minor Changes
+
+- 88e57a1: Add metrics interface dependency
+
+## 1.1.0
+
+### Minor Changes
+
+- 037c31a5: Upgrade webpack from 4 to 5 and other relavent packages to fix the issue for node17+ (openssl change)
+
+## 1.1.0-next.0
+
+### Minor Changes
+
+- 037c31a: Upgrade webpack from 4 to 5 and other relavent packages to fix the issue for node17+ (openssl change)
+
+## 1.0.1
+
+### Patch Changes
+
+- 4608ccd: Update version of analytics client
+
+## 1.0.1-next.0
+
+### Patch Changes
+
+- 4608ccd: Update version of analytics client
+
+## 1.0.0
+
+### Major Changes
+
+- 1daf2c5: Forge packages to 1.0.0 for upcoming platform GA 🎉
+
+## 1.0.0-next.0
+
+### Major Changes
+
+- 1daf2c5: Forge is now generally available 🎉
+
+## 0.4.17
 
 ### Patch Changes
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@forge/util",
-  "version": "0.0.0-experimental-383053a",
+  "version": "0.0.0-experimental-c3d0263",
   "description": "",
   "module": "./packages",
   "scripts": {
@@ -10,7 +10,7 @@
   "author": "Daniel Winter-Wijntjes",
   "license": "UNLICENSED",
   "dependencies": {
-    "webpack": "^4.42.1",
-    "webpack-cli": "^3.3.11"
+    "webpack": "^5.66.0",
+    "webpack-cli": "^4.9.1"
   }
 }

package/packages/analytics-node-client/CHANGELOG.md

@@ -0,0 +1,71 @@
+# Change log
+
+## 2.1.1
+
+Use `https://` instead of `git://` as it is no longer allowed
+https://github.blog/2021-09-01-improving-git-protocol-security-github/
+
+## 2.1.0
+
+Added Halp as a valid userIdType
+
+## 2.0.3
+
+Updated analytics-node from [5.0.0 to 5.1.0](https://github.com/segmentio/analytics-node/releases).
+Added mechanism for comsumers to pass in their own retry delay function. See readme [Custom retryDelayFn](./README.md#markdown-header-custom-retrydelayfn).
+
+## 2.0.2
+
+Patch axios in our lock files while waiting for segment to release a version which patches the exposed version of axios. [reference](https://github.com/segmentio/analytics-node/pull/295).
+
+## 2.0.1
+
+Changes from [analytics-node v5](https://github.com/segmentio/analytics-node/releases/tag/v5.0.0):
+
+- Breaking: Dropped support for Node 8,
+- Flush queue when maximum storage has been reached,
+- Return a promise from flush,
+- Upgrade uuid package to support treeshaking,
+- Dependency upgrades
+
+## 1.2.2
+
+Added request timeout option. Default is 60 seconds.
+
+Added logger option which takes the same shape as console. Default is console.
+
+## 1.2.1
+
+Note: Firing events over 32kb in size will now throw errors.
+[Bumped analytics-node from 3.5.0 to 4.0.1](https://github.com/segmentio/analytics-node/releases).
+
+HTTP requests now have KeepAlive headers.
+
+## 1.1.6
+
+Fixed an issue with the generated TypeScript typings files. (Importing `AnalyticsClient` was broken).
+The Typing Definitions should be more accurate now, and are included for all package files.
+
+## 1.1.5
+
+Added hashedEmail and opsgenie userIdTypes support
+
+## 1.1.4
+
+Upgraded lodash to fix security vulnerability
+
+## 1.1.3
+
+Added security assistant configuration
+
+## 1.1.2
+
+Bumped `analytics-node` to include security fix for `axios` dependency
+
+## 1.1.1
+
+Added artifacts to the deploy process to fix issues of missing declaration files in package
+
+## 1.1.0
+
+Added Typescript type declaration files for Typescript compatibility

package/packages/analytics-node-client/README.md

@@ -2,13 +2,13 @@
 
 Analytics Client NodeJS services. Uses the GASv3 platform.
 
-* [Builds](https://engservices-bamboo.internal.atlassian.com/browse/DS-ANCBUILD)
 * [Event Guidelines](http://go.atlassian.com/analytics)
+* [Trait Guidelines](https://developer.atlassian.com/platform/targeting/overview/concepts/traits/)
 * Questions / Other support: visit us in Slack: #product-analytics-dev "Product Analytics Dev"
 
 ## Usage
 
-#### Creating a client
+### Creating a client
 
 ```javascript
 const { analyticsClient } = require('@atlassiansox/analytics-node-client');
@@ -21,23 +21,25 @@ const client = analyticsClient({
 });
 ```
 
-#### User information 
+#### User information
 
 If a `userId` is specified, then a valid `userIdType` is also required. If no `userId` is specified, then `anonymousId` must be used.
 
-We support the following `userIdType`s: 
+We support the following `userIdType`s:
 
 * `ATLASSIAN_ACCOUNT`
-* `TRELLO` 
+* `TRELLO`
+* `HASHED_EMAIL`
+* `OPSGENIE`
+* `HALP`
 
+#### Tenant information
 
-#### Tenant information 
+If a `tenantId` is specified, then a valid `tenantIdType` is also required.
 
-If a `tenantId` is specified, then a valid `tenantIdType` is also required. 
+We support the following `tenantIdType`s:
 
-We support the following `tenantIdType`s: 
-
-* `CLOUD_ID` - Atlassian Cloud 
+* `CLOUD_ID` - Atlassian Cloud
 * `NONE` - Products without a tenant concept
 
 #### Containers
@@ -48,7 +50,8 @@ There is no strict definition or schema for the fields allowed in the containers
 The `containers` field will be validated, and will throw and `Error` if the validation does not pass, preventing the event from being sent.
 You need to put the values that will make the analytical events valuable to your use case; most probayly matching the expectations set by some analyst's queries on top of the Socrates, Redash or Amplitude tables.
 An example of a `containers` structure:
-```
+
+```json
 "containers": {
     "project": {
         "id": "projectId",
@@ -65,9 +68,10 @@ An example of a `containers` structure:
 }
 ```
 
-
 #### Reporting OS info/version
+
 OS version can be optionally reported with `os` attribute of an event:
+
 ```javascript
 {
     ...
@@ -79,16 +83,41 @@ OS version can be optionally reported with `os` attribute of an event:
 ```
 
 #### Reporting event creation time
+
 Creation time of the analytics event can be optionally reported with the `timestamp` attribute of an event:
+
 ```javascript
 this.analyticsClient.track({
     ...
     timestamp: new Date()
 })
 ```
+
 For compatibility with the underlying `node-analytics` library the timestamp must be supplied as a Date object.
 This creation timestamp will be reflected as `originalTimestamp` after processing.
 
+#### Custom retryDelayFn
+
+This client uses [analytics-node](https://github.com/segmentio/analytics-node) under the hood which uses [axios](https://github.com/axios/axios) to send events and [axios-retry](https://github.com/softonic/axios-retry) to retry sending events in case of failure.
+
+axios-retry uses a function parameter to determine how long the client should wait after a failed HTTP request before trying again. By default, [analytics-node](https://github.com/segmentio/analytics-node/blob/master/index.js#L62) uses [exponential-delay](https://github.com/softonic/axios-retry/blob/master/es/index.js#L77).
+
+If you wish to change this behaviour, you can provide the client with `retryDelayFn` in the main argument object when creating the client.
+
+```javascript
+const { analyticsClient } = require('@atlassiansox/analytics-node-client');
+
+const client = analyticsClient({
+    env: 'prod', // prod, stg or dev
+    product: 'jira', // required
+    subproduct: 'software' // Optional
+    sendEventHook: (event) => {} // Optional callback\
+
+    // Please dont actually use this, its just an example
+    retryDelayFn: (retryAtempt) => retryAtempt * 10 * (0.5 + Math.random()), 
+});
+```
+
 
 
 ## Sending a TrackEvent
@@ -122,7 +151,7 @@ client.sendTrackEvent({
 });
 ```
 
-#### TrackEvent with OS details:
+### TrackEvent with OS details:
 
 ```javascript
 client.sendTrackEvent({
@@ -157,7 +186,7 @@ client.sendTrackEvent({
 });
 ```
 
-## Sending a UIEvent
+## Sending an UIEvent
 
 ```javascript
 client.sendUIEvent({
@@ -218,7 +247,7 @@ client.sendScreenEvent({
 });
 ```
 
-## Sending a OperationalEvent
+## Sending an OperationalEvent
 
 ```javascript
 client.sendOperationalEvent({
@@ -249,9 +278,23 @@ client.sendOperationalEvent({
 });
 ```
 
+## Sending a TraitEvent
+
+```javascript
+client.sendTraitEvent({
+    entityType: entityTypes.ATLASSIAN_ACCOUNT, // required
+    entityId: '557058:qweqwe-1793-45a0-9732-9ef656b7ab43', // required
+    entityTraits: { // required
+        'first-logged-in-to-your-service': new Date() // at least one trait required
+    }
+});
+```
+
 ## Developing Locally
 
 Setup: `npm install`
+Generating Typescript Types: `npm run generateTypes`
+Cleaning up Typescript Types: `npm run cleanTypes`
 
 ### Tests:
 

package/packages/analytics-node-client/package.json

@@ -1,10 +1,13 @@
 {
   "name": "analytics-node-client",
-  "version": "1.0.111",
+  "version": "2.1.2",
   "description": "Analytics Serverside client for Node JS",
   "main": "src/index.js",
+  "types": "src/index.d.ts",
   "scripts": {
     "build": "run-s test",
+    "generateTypes": "npm run cleanTypes && tsc",
+    "cleanTypes": "find src/ -name '*.d.ts' -delete",
     "test:unit": "jasmine JASMINE_CONFIG_PATH=jasmine.json",
     "test:lint": "eslint src test --fix",
     "test": "run-s -s test:unit test:lint",
@@ -27,11 +30,12 @@
     "jasmine-reporters": "^2.2.0",
     "npm-run-all": "^3.1.0",
     "proxyquire": "^1.7.2",
-    "watch": "git://github.com/jbunton-atlassian/watch#5de0fc9c13df5ebc3320c1cbe275916cc954142d"
+    "typescript": "^4.2.3",
+    "watch": "https://github.com/jbunton-atlassian/watch#5de0fc9c13df5ebc3320c1cbe275916cc954142d"
   },
   "dependencies": {
-    "analytics-node": "^3.4.0-beta.1",
-    "lodash": "^4.17.5"
+    "analytics-node": "^5.1.0",
+    "lodash": "^4.17.21"
   },
   "files": [
     "src"