Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

test: Convert transaction* and urltils tests to node:test #2585

Merged
merged 4 commits into from
Sep 19, 2024
Merged

test: Convert transaction* and urltils tests to node:test #2585

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
9fd851a
test: transaction and urltils to node:test
amychisholm03 Sep 17, 2024
a8a90e8
test: remaining transaction* files
amychisholm03 Sep 17, 2024
1d72273
Merge branch 'newrelic:main' into unit-tests
amychisholm03 Sep 17, 2024
d55fa54
Merge branch 'newrelic:main' into unit-tests
amychisholm03 Sep 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
109 changes: 50 additions & 59 deletions test/unit/transaction-event-aggregator.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@
*/

'use strict'
const tap = require('tap')
const test = require('node:test')
const assert = require('node:assert')
const sinon = require('sinon')
const TransactionEventAggregator = require('../../lib/transaction/transaction-event-aggregator')
const Metrics = require('../../lib/metrics')
Expand All @@ -14,11 +15,12 @@ const LIMIT = 5
const EXPECTED_METHOD = 'analytic_event_data'
const SPLIT_THRESHOLD = 3

function beforeEach(t) {
function beforeEach(ctx) {
const fakeCollectorApi = { send: sinon.stub() }
const fakeHarvester = { add: sinon.stub() }

t.context.eventAggregator = new TransactionEventAggregator(
ctx.nr = {}
ctx.nr.eventAggregator = new TransactionEventAggregator(
{
runId: RUN_ID,
limit: LIMIT,
Expand All @@ -30,23 +32,21 @@ function beforeEach(t) {
metrics: new Metrics(5, {}, {})
}
)
t.context.fakeCollectorApi = fakeCollectorApi
ctx.nr.fakeCollectorApi = fakeCollectorApi
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was hoping to get to this suite myself so that I could update it to use https://github.com/newrelic/node-newrelic/blob/2f45a4a535d83ac8fe073ed5082edda4ff1fb720/test/lib/test-collector.js instead. We don't need to block this PR because of it, though. Would you mind writing a new ticket for it?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

#2592

}

tap.test('Transaction Event Aggregator', (t) => {
t.autoend()
test('Transaction Event Aggregator', async (t) => {
t.beforeEach(beforeEach)

t.test('should set the correct default method', (t) => {
const { eventAggregator } = t.context
await t.test('should set the correct default method', (t) => {
const { eventAggregator } = t.nr
const method = eventAggregator.method

t.equal(method, EXPECTED_METHOD)
t.end()
assert.equal(method, EXPECTED_METHOD)
})

t.test('toPayload() should return json format of data', (t) => {
const { eventAggregator } = t.context
await t.test('toPayload() should return json format of data', (t) => {
const { eventAggregator } = t.nr
const expectedMetrics = {
reservoir_size: LIMIT,
events_seen: 1
Expand All @@ -57,56 +57,52 @@ tap.test('Transaction Event Aggregator', (t) => {
eventAggregator.add(rawEvent)

const payload = eventAggregator._toPayloadSync()
t.equal(payload.length, 3)
assert.equal(payload.length, 3)

const [runId, eventMetrics, eventData] = payload

t.equal(runId, RUN_ID)
t.same(eventMetrics, expectedMetrics)
t.same(eventData, [rawEvent])
t.end()
assert.equal(runId, RUN_ID)
assert.deepEqual(eventMetrics, expectedMetrics)
assert.deepEqual(eventData, [rawEvent])
})

t.test('toPayload() should return nothing with no event data', (t) => {
const { eventAggregator } = t.context
await t.test('toPayload() should return nothing with no event data', (t) => {
const { eventAggregator } = t.nr
const payload = eventAggregator._toPayloadSync()

t.notOk(payload)
t.end()
assert.equal(payload, null)
})
})

tap.test('Transaction Event Aggregator - when data over split threshold', (t) => {
t.autoend()
test('Transaction Event Aggregator - when data over split threshold', async (t) => {
t.beforeEach((t) => {
beforeEach(t)
const { eventAggregator } = t.context
const { eventAggregator } = t.nr
eventAggregator.add([{ type: 'Transaction', error: false }, { num: 1 }])
eventAggregator.add([{ type: 'Transaction', error: false }, { num: 2 }])
eventAggregator.add([{ type: 'Transaction', error: false }, { num: 3 }])
eventAggregator.add([{ type: 'Transaction', error: false }, { num: 4 }])
eventAggregator.add([{ type: 'Transaction', error: false }, { num: 5 }])
})

t.test('should emit proper message with method for starting send', (t) => {
const { eventAggregator } = t.context
await t.test('should emit proper message with method for starting send', (t, end) => {
const { eventAggregator } = t.nr
const expectedStartEmit = `starting_data_send-${EXPECTED_METHOD}`

eventAggregator.once(expectedStartEmit, t.end)
eventAggregator.once(expectedStartEmit, end)

eventAggregator.send()
})

t.test('should clear existing data', (t) => {
const { eventAggregator } = t.context
await t.test('should clear existing data', (t) => {
const { eventAggregator } = t.nr
eventAggregator.send()

t.equal(eventAggregator.events.length, 0)
t.end()
assert.equal(eventAggregator.events.length, 0)
})

t.test('should call transport for two payloads', (t) => {
const { eventAggregator, fakeCollectorApi } = t.context
await t.test('should call transport for two payloads', (t) => {
const { eventAggregator, fakeCollectorApi } = t.nr
const payloads = []

fakeCollectorApi.send.callsFake((_method, payload, callback) => {
Expand All @@ -118,30 +114,29 @@ tap.test('Transaction Event Aggregator - when data over split threshold', (t) =>

eventAggregator.send()

t.equal(payloads.length, 2)
assert.equal(payloads.length, 2)

const [firstPayload, secondPayload] = payloads

const [firstRunId, firstMetrics, firstEventData] = firstPayload
t.equal(firstRunId, RUN_ID)
t.same(firstMetrics, {
assert.equal(firstRunId, RUN_ID)
assert.deepEqual(firstMetrics, {
reservoir_size: 2,
events_seen: 2
})
t.equal(firstEventData.length, 2)
assert.equal(firstEventData.length, 2)

const [secondRunId, secondMetrics, secondEventData] = secondPayload
t.equal(secondRunId, RUN_ID)
t.same(secondMetrics, {
assert.equal(secondRunId, RUN_ID)
assert.deepEqual(secondMetrics, {
reservoir_size: 3,
events_seen: 3
})
t.equal(secondEventData.length, 3)
t.end()
assert.equal(secondEventData.length, 3)
})

t.test('should call merge with original data when transport indicates retain', (t) => {
const { eventAggregator, fakeCollectorApi } = t.context
await t.test('should call merge with original data when transport indicates retain', (t) => {
const { eventAggregator, fakeCollectorApi } = t.nr
const originalData = eventAggregator._getMergeData()

fakeCollectorApi.send.callsFake((_method, _payload, callback) => {
Expand All @@ -151,17 +146,16 @@ tap.test('Transaction Event Aggregator - when data over split threshold', (t) =>
eventAggregator.send()

const currentData = eventAggregator._getMergeData()
t.equal(currentData.length, originalData.length)
assert.equal(currentData.length, originalData.length)

const originalEvents = originalData.toArray().sort(sortEventsByNum)
const currentEvents = currentData.toArray().sort(sortEventsByNum)

t.same(currentEvents, originalEvents)
t.end()
assert.deepEqual(currentEvents, originalEvents)
})

t.test('should not merge when transport indicates not to retain', (t) => {
const { eventAggregator, fakeCollectorApi } = t.context
await t.test('should not merge when transport indicates not to retain', (t) => {
const { eventAggregator, fakeCollectorApi } = t.nr
fakeCollectorApi.send.callsFake((_method, _payload, callback) => {
callback(null, { retainData: false })
})
Expand All @@ -170,12 +164,11 @@ tap.test('Transaction Event Aggregator - when data over split threshold', (t) =>

const currentData = eventAggregator._getMergeData()

t.equal(currentData.length, 0)
t.end()
assert.equal(currentData.length, 0)
})

t.test('should handle payload retain values individually', (t) => {
const { eventAggregator, fakeCollectorApi } = t.context
await t.test('should handle payload retain values individually', (t) => {
const { eventAggregator, fakeCollectorApi } = t.nr
let payloadCount = 0
let payloadToRetain = null
fakeCollectorApi.send.callsFake((_method, payload, callback) => {
Expand All @@ -194,19 +187,17 @@ tap.test('Transaction Event Aggregator - when data over split threshold', (t) =>
const eventsToRetain = payloadToRetain[2].sort(sortEventsByNum)

const currentData = eventAggregator._getMergeData()
t.equal(currentData.length, eventsToRetain.length)
assert.equal(currentData.length, eventsToRetain.length)

const currentEvents = currentData.toArray().sort(sortEventsByNum)

t.same(currentEvents, eventsToRetain)
t.end()
assert.deepEqual(currentEvents, eventsToRetain)
})

t.test('should emit proper message with method for finishing send', (t) => {
const { eventAggregator, fakeCollectorApi } = t.context
await t.test('should emit proper message with method for finishing send', (t, end) => {
const { eventAggregator, fakeCollectorApi } = t.nr
const expectedEndEmit = `finished_data_send-${EXPECTED_METHOD}`

eventAggregator.once(expectedEndEmit, t.end)
eventAggregator.once(expectedEndEmit, end)

fakeCollectorApi.send.callsFake((_method, _payload, callback) => {
callback(null, { retainData: false })
Expand Down
45 changes: 22 additions & 23 deletions test/unit/transaction-logs.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,56 +4,55 @@
*/

'use strict'
const test = require('node:test')
const assert = require('node:assert')
const Logs = require('../../lib/transaction/logs')
const { test } = require('tap')
const sinon = require('sinon')

test('Logs tests', (t) => {
t.autoend()
let logs
let agent
t.beforeEach(() => {
test('Logs tests', async (t) => {
t.beforeEach((ctx) => {
ctx.nr = {}
const config = {
event_harvest_config: {
harvest_limits: {
log_event_data: 2
}
}
}
agent = {
ctx.nr.agent = {
logs: { addBatch: sinon.stub() },
config
}
logs = new Logs(agent)
ctx.nr.logs = new Logs(ctx.nr.agent)
})
t.test('should initialize logs storage', (t) => {
t.same(logs.storage, [], 'should init storage to empty')
t.same(logs.aggregator, agent.logs, 'should create log aggregator')
t.equal(logs.maxLimit, 2, 'should set max limit accordingly')
t.end()
await t.test('should initialize logs storage', (t) => {
const { agent, logs } = t.nr
assert.deepEqual(logs.storage, [], 'should init storage to empty')
assert.deepEqual(logs.aggregator, agent.logs, 'should create log aggregator')
assert.equal(logs.maxLimit, 2, 'should set max limit accordingly')
})

t.test('it should add logs to storage', (t) => {
await t.test('it should add logs to storage', (t) => {
const { logs } = t.nr
logs.add('line')
t.same(logs.storage, ['line'])
t.end()
assert.deepEqual(logs.storage, ['line'])
})

t.test('it should not add data to storage if max limit has been met', (t) => {
await t.test('it should not add data to storage if max limit has been met', (t) => {
const { logs } = t.nr
logs.add('line1')
logs.add('line2')
logs.add('line3')
logs.add('line4')
t.same(logs.storage, ['line1', 'line2'])
t.end()
assert.deepEqual(logs.storage, ['line1', 'line2'])
})

t.test('it should flush the batch', (t) => {
await t.test('it should flush the batch', (t) => {
const { logs } = t.nr
logs.add('line')
const priority = Math.random() + 1
logs.flush(priority)
t.ok(logs.aggregator.addBatch.callCount, 1, 'should call addBatch once')
t.same(logs.aggregator.addBatch.args[0], [['line'], priority])
t.end()
assert.ok(logs.aggregator.addBatch.callCount, 1, 'should call addBatch once')
assert.deepEqual(logs.aggregator.addBatch.args[0], [['line'], priority])
})
})
Loading
Loading