Skip to content

Commit

Permalink
Revert "Speculative logging for PostHog/posthog#4816 (#293)" (#302)
Browse files Browse the repository at this point in the history
This reverts commit 5447142.
  • Loading branch information
pauldambra authored Sep 30, 2021
1 parent 8eff39b commit 6a3c0c6
Show file tree
Hide file tree
Showing 5 changed files with 5 additions and 98 deletions.
34 changes: 1 addition & 33 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,40 +28,8 @@ Use [`yarn link`](https://classic.yarnpkg.com/en/docs/cli/link/). Run `yarn link

An alternative is to update dependency in package.json to e.g. `"posthog-js": "link:../posthog-js"`, `yarn` and run `yarn build && yarn build-module`

## Alternative to yarn link

Run `npm install -g yalc`

In the posthog-js repo

* run `yalc publish`

In the posthog repo

* run `yalc add posthog-js`
* run `yarn`
* run `yarn copy-scripts`

### When making changes

In the posthog-js repo

* run `yalc publish`

In the posthog repo

* run `yalc update`
* run `yarn`
* run `yarn copy-scripts`

### To remove the local package

In the posthog repo

* run `yalc remove posthog-js`
* run `yarn install`

## Developing with main PostHog repo
### Developing with main PostHog repo

The `posthog-js` snippet for a website loads static js from the main `PostHog/posthog` repo. Which means, when testing the snippet with a website, there's a bit of extra setup required:

Expand Down
25 changes: 1 addition & 24 deletions src/__tests__/capture-metrics.js
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ describe('CaptureMetrics()', () => {

given('enabled', () => true)
given('capture', () => jest.fn())

given('getTime', () => jest.fn())

describe('incr() and decr()', () => {
Expand Down Expand Up @@ -84,32 +85,8 @@ describe('CaptureMetrics()', () => {
given.captureMetrics.captureInProgressRequests()
given.captureMetrics.markRequestFailed({ foo: 'bar' })
given.captureMetrics.finishRequest(null)
given.captureMetrics.addDebugMessage('tomato', 'potato')

expect(given.capture).not.toHaveBeenCalled()
})

describe('logging debug messages via metrics', () => {
it('does nothing if not enabled', () => {
given('enabled', () => false)

given.captureMetrics.addDebugMessage('tomato', 'potato')

expect(given.captureMetrics.metrics).toEqual({})
})

it('does something if capture metrics is enabled', () => {
given('enabled', () => true)

given.captureMetrics.addDebugMessage('tomato', 'potato')
given.captureMetrics.addDebugMessage('potato', 'salad')
given.captureMetrics.addDebugMessage('potato', 'chips')

expect(given.captureMetrics.metrics).toEqual({
'phjs-debug-tomato': ['potato'],
'phjs-debug-potato': ['salad', 'chips'],
})
})
})
})
})
10 changes: 0 additions & 10 deletions src/capture-metrics.js
Original file line number Diff line number Diff line change
Expand Up @@ -23,16 +23,6 @@ export class CaptureMetrics {
}
}

addDebugMessage(key, payload) {
if (this.enabled) {
key = `phjs-debug-${key}`
if (!this.metrics[key]) {
this.metrics[key] = []
}
this.metrics[key].push(payload)
}
}

startRequest(payload) {
if (this.enabled) {
const requestId = _.UUID()
Expand Down
32 changes: 2 additions & 30 deletions src/compression.js
Original file line number Diff line number Diff line change
Expand Up @@ -12,43 +12,15 @@ export function decideCompression(compressionSupport) {
}
}

function hasMagicGzipHeader(compressionResultElement) {
try {
const a = compressionResultElement[0]
const b = compressionResultElement[1]
return a === 31 && b === 139
} catch (e) {
return false
}
}

export function compressData(compression, jsonData, options, captureMetrics) {
export function compressData(compression, jsonData, options) {
if (compression === 'lz64') {
return [{ data: LZString.compressToBase64(jsonData), compression: 'lz64' }, options]
} else if (compression === 'gzip-js') {
// :TRICKY: This returns an UInt8Array. We don't encode this to a string - returning a blob will do this for us.
const compressionResult = [
return [
gzipSync(strToU8(jsonData), { mtime: 0 }),
{ ...options, blob: true, urlQueryArgs: { compression: 'gzip-js' } },
]

// temporary logging to identify source of https://github.com/PostHog/posthog/issues/4816
try {
const jsonDataIsUnexpected = !jsonData || jsonData === 'undefined'
if (jsonDataIsUnexpected || !compressionResult[0] || !hasMagicGzipHeader(compressionResult[0])) {
captureMetrics.addDebugMessage('PostHogJSCompressionCannotBeDecompressed', {
jsonData,
compressionResult: compressionResult[0],
})
}
} catch (e) {
captureMetrics.addDebugMessage('PostHogJSCompressionCannotBeDecompressed-error', {
error: e,
message: e.message,
})
}

return compressionResult
} else {
return [{ data: _.base64Encode(jsonData) }, options]
}
Expand Down
2 changes: 1 addition & 1 deletion src/posthog-core.js
Original file line number Diff line number Diff line change
Expand Up @@ -368,7 +368,7 @@ PostHogLib.prototype._handle_queued_event = function (url, data, options) {
}

PostHogLib.prototype.__compress_and_send_json_request = function (url, jsonData, options, callback) {
const [data, _options] = compressData(decideCompression(this.compression), jsonData, options, this._captureMetrics)
const [data, _options] = compressData(decideCompression(this.compression), jsonData, options)
this._send_request(url, data, _options, callback)
}

Expand Down

0 comments on commit 6a3c0c6

Please sign in to comment.