Skip to content

:hedgehog: PostHog is the leading platform for building self-driving products. Our developer tools – AI observability, analytics, session replay, flags, experiments, error tracking, logs, and more – capture all the context agents need to diagnose problems, uncover opportunities, and ship fixes. Steer it all from Slack, web, desktop, or the MCP.

6.0 KB
Raw Blame
import { DateTime, Settings } from 'luxon'

import { parseJSON } from '~/common/utils/json-parse'

import { TemplateTester, createAdDestinationPayload } from '../../test/test-helpers'
import { template } from './microsoft.template'

jest.setTimeout(60 * 1000)
describe('microsoft template', () => {
    const tester = new TemplateTester(template)
    beforeEach(async () => {
        Settings.defaultZone = 'UTC'
        await tester.beforeEach()
        const fixedTime = DateTime.fromISO('2025-01-01T00:00:00Z').toJSDate()
        jest.spyOn(Date, 'now').mockReturnValue(fixedTime.getTime())
    })
    afterEach(() => {
        Settings.defaultZone = 'system'
        jest.useRealTimers()
    })
    it('works with conversion value and currency', async () => {
        const response = await tester.invokeMapping(
            'Conversion',
            { tagId: '12345678', apiToken: 'api-token', eventName: 'purchase' },
            createAdDestinationPayload({ event: { properties: { currency: 'USD', value: '100' } } }),
            { currency: '{event.properties.currency}', conversionValue: '{event.properties.value}' }
        )
        expect(response.error).toBeUndefined()
        expect(response.finished).toEqual(false)
        expect(response.invocation.queueParameters).toMatchInlineSnapshot(`
            {
              "body": "{"data":[{"eventType":"custom","eventName":"purchase","eventTime":1735689600,"userData":{"msclkid":"microsoft-id","em":"3d4eee8538a4bbbe2ef7912f90ee494c1280f74dd7fd81232e58deb9cb9997e3","ph":"422ce82c6fc1724ac878042f7d055653ab5e983d186e616826a72d4384b68af8"},"eventId":"event-id","customData":{"value":100,"currency":"USD"}}]}",
              "headers": {
                "Authorization": "Bearer api-token",
                "Content-Type": "application/json",
              },
              "method": "POST",
              "type": "fetch",
              "url": "https://capi.uet.microsoft.com/v1/12345678/events",
            }
        `)
        const fetchResponse = await tester.invokeFetchResponse(response.invocation, { status: 200, body: {} })
        expect(fetchResponse.finished).toBe(true)
        expect(fetchResponse.error).toBeUndefined()
    })
    it('works with minimal inputs and hashes the email', async () => {
        const response = await tester.invokeMapping(
            'Conversion',
            { tagId: '12345678', apiToken: 'api-token', eventName: 'purchase' },
            createAdDestinationPayload()
        )
        expect(response.error).toBeUndefined()
        expect(response.finished).toEqual(false)
        expect(response.invocation.queueParameters).toMatchInlineSnapshot(`
            {
              "body": "{"data":[{"eventType":"custom","eventName":"purchase","eventTime":1735689600,"userData":{"msclkid":"microsoft-id","em":"3d4eee8538a4bbbe2ef7912f90ee494c1280f74dd7fd81232e58deb9cb9997e3","ph":"422ce82c6fc1724ac878042f7d055653ab5e983d186e616826a72d4384b68af8"},"eventId":"event-id"}]}",
              "headers": {
                "Authorization": "Bearer api-token",
                "Content-Type": "application/json",
              },
              "method": "POST",
              "type": "fetch",
              "url": "https://capi.uet.microsoft.com/v1/12345678/events",
            }
        `)
        const fetchResponse = await tester.invokeFetchResponse(response.invocation, { status: 200, body: {} })
        expect(fetchResponse.finished).toBe(true)
        expect(fetchResponse.error).toBeUndefined()
    })
    it('handles error responses', async () => {
        const response = await tester.invokeMapping(
            'Conversion',
            { tagId: '12345678', apiToken: 'api-token', eventName: 'purchase' },
            createAdDestinationPayload()
        )
        expect(response.error).toBeUndefined()
        expect(response.finished).toEqual(false)
        const fetchResponse = await tester.invokeFetchResponse(response.invocation, {
            status: 401,
            body: { error: { code: 'Unauthorized', message: 'You are not authorized to access this resource.' } },
        })
        expect(fetchResponse.finished).toBe(true)
        expect(fetchResponse.error).toMatchInlineSnapshot(
            `"Error from capi.uet.microsoft.com (status 401): {'error': {'code': 'Unauthorized', 'message': 'You are not authorized to access this resource.'}}"`
        )
    })
    // Any one identifier is enough for Microsoft to attribute, so none of them may gate the send
    it.each([
        ['click id', { email: null, phone: null }, { msclkid: 'microsoft-id' }],
        [
            'email',
            { msclkid: null, phone: null },
            { em: '3d4eee8538a4bbbe2ef7912f90ee494c1280f74dd7fd81232e58deb9cb9997e3' },
        ],
        [
            'phone',
            { msclkid: null, email: null },
            { ph: '422ce82c6fc1724ac878042f7d055653ab5e983d186e616826a72d4384b68af8' },
        ],
    ])('sends the conversion when only %s is available', async (_, personProperties, expectedUserData) => {
        const response = await tester.invokeMapping(
            'Conversion',
            { tagId: '12345678', apiToken: 'api-token', eventName: 'purchase' },
            createAdDestinationPayload({ person: { properties: personProperties } })
        )
        expect(response.error).toBeUndefined()
        const body = parseJSON((response.invocation.queueParameters as { body: string }).body)
        expect(body.data[0].userData).toEqual(expectedUserData)
    })
    it('skips when no identifier is available', async () => {
        const response = await tester.invokeMapping(
            'Conversion',
            { tagId: '12345678', apiToken: 'api-token', eventName: 'purchase' },
            createAdDestinationPayload({ person: { properties: { msclkid: null, email: null, phone: null } } })
        )
        expect(response.logs.filter((log) => log.level === 'info').map((log) => log.message)).toMatchInlineSnapshot(
            `
            [
              "No \`microsoftClickId\`, \`email\` or \`phone\` to identify the user with. Skipping...",
            ]
        `
        )
        expect(response.finished).toEqual(true)
    })
})