Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
5 changes: 5 additions & 0 deletions .changeset/node-nodemailer-transport.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'posthog-node': minor
---

Send Nodemailer mail through PostHog with the new `posthog-node/nodemailer` entry point: `nodemailer.createTransport(createPostHogTransport({ client }))`. Every `sendMail` call stays as it is, and `sendMail({ posthog: { ... } })` takes PostHog's options. A message PostHog can't carry fails with `code: 'EPOSTHOGUNSUPPORTED'` and sends nothing.
7 changes: 7 additions & 0 deletions packages/node/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,7 @@
"@types/react": "catalog:",
"esbuild": "^0.25.0",
"@vitest/coverage-v8": "catalog:",
"nodemailer": "^10.3.0",
"react": "catalog:",
"react-dom": "catalog:",
"rxjs": "^7.8.0",
Expand Down Expand Up @@ -140,6 +141,12 @@
"import": "./dist/entrypoints/otel.mjs",
"require": "./dist/entrypoints/otel.js",
"default": "./dist/entrypoints/otel.js"
},
"./nodemailer": {
"types": "./dist/entrypoints/nodemailer.d.ts",
Comment thread
Silthus marked this conversation as resolved.
Resolved
"import": "./dist/entrypoints/nodemailer.mjs",
"require": "./dist/entrypoints/nodemailer.js",
"default": "./dist/entrypoints/nodemailer.js"
}
}
}
62 changes: 62 additions & 0 deletions packages/node/src/__tests__/nodemailer-absent.spec.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
/** @vitest-environment node */

import { execFileSync } from 'node:child_process'
import { fileURLToPath } from 'node:url'

const packageRoot = fileURLToPath(new URL('../../', import.meta.url))

const HIDE_NODEMAILER = `
import { registerHooks } from 'node:module'
registerHooks({
resolve(specifier, context, nextResolve) {
if (specifier === 'nodemailer' || specifier.startsWith('nodemailer/')) {
throw Object.assign(new Error('Cannot find module ' + specifier), { code: 'ERR_MODULE_NOT_FOUND' })
}
return nextResolve(specifier, context)
},
})
`

describe('the built posthog-node without Nodemailer installed', () => {
it.each(['import', 'require'])('loads both entry points with %s and sends a message', (loader) => {
const load = (specifier: string): string =>
loader === 'import' ? `await import('${specifier}')` : `createRequire(import.meta.url)('${specifier}')`
const output = execFileSync(
process.execPath,
[
'--import',
`data:text/javascript,${encodeURIComponent(HIDE_NODEMAILER)}`,
'--input-type=module',
'-e',
`
import { createRequire } from 'node:module'
const { PostHog } = ${load('posthog-node')}
const { createPostHogTransport } = ${load('posthog-node/nodemailer')}
await import('nodemailer').then(() => { throw new Error('Nodemailer is still installed') }, () => {})
const client = new PostHog('phc_test', {
secretKey: 'phs_test',
enableLocalEvaluation: false,
fetch: async () => ({ status: 202, text: async () => '{"message_id":"msg_1"}', headers: { get: () => null } }),
})
const data = {
from: { name: '', address: 'shop@example.com' },
to: [{ name: '', address: 'ana@example.com' }],
subject: 'Hi',
text: 'Hi',
envelope: { from: 'shop@example.com', to: ['ana@example.com'] },
}
const info = await new Promise((resolve, reject) =>
createPostHogTransport({ client }).send({ normalize: (done) => done(null, data) }, (error, sent) =>
error ? reject(error) : resolve(sent)
)
)
await client.shutdown()
console.log(JSON.stringify(info))
`,
],
{ cwd: packageRoot, encoding: 'utf8', timeout: 10_000 }
)

expect(JSON.parse(output)).toEqual({ messageId: 'msg_1' })
})
})
76 changes: 76 additions & 0 deletions packages/node/src/__tests__/nodemailer-declarations.spec.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
/** @vitest-environment node */

import { spawnSync } from 'node:child_process'
import { mkdirSync, mkdtempSync, rmSync, symlinkSync, writeFileSync } from 'node:fs'
import { tmpdir } from 'node:os'
import { join } from 'node:path'
import { fileURLToPath } from 'node:url'

const packageRoot = fileURLToPath(new URL('../../', import.meta.url))

const CONSUMER = `
import nodemailer from 'nodemailer'
import { PostHog } from 'posthog-node'
import { createPostHogTransport } from 'posthog-node/nodemailer'

const client = new PostHog('phc_test', { secretKey: 'phs_test' })
const transporter = nodemailer.createTransport(createPostHogTransport({ client }))

export const messageId: Promise<string> = transporter
.sendMail({
to: 'ana@example.com',
subject: 'Hi',
text: 'Hi',
posthog: { distinct_id: 'user_42', tracking: { opens: true, clicks: false }, sensitive: true },
})
.then((info) => info.messageId)

// @ts-expect-error a PostHog send has no SMTP fields
export const accepted = transporter.sendMail({ to: 'ana@example.com', text: 'Hi' }).then((info) => info.accepted)

// @ts-expect-error the PostHog options keep the API's names
export const misnamed = transporter.sendMail({ to: 'ana@example.com', text: 'Hi', posthog: { distinctId: 'user_42' } })
`

describe('the built posthog-node/nodemailer declarations', () => {
let consumer: string

beforeAll(() => {
consumer = mkdtempSync(join(tmpdir(), 'posthog-nodemailer-consumer-'))
mkdirSync(join(consumer, 'node_modules/@types'), { recursive: true })
symlinkSync(packageRoot, join(consumer, 'node_modules/posthog-node'))
symlinkSync(join(packageRoot, 'node_modules/nodemailer'), join(consumer, 'node_modules/nodemailer'))
symlinkSync(join(packageRoot, 'node_modules/@types/node'), join(consumer, 'node_modules/@types/node'))
writeFileSync(join(consumer, 'package.json'), JSON.stringify({ private: true, type: 'module' }))
})

afterAll(() => rmSync(consumer, { recursive: true, force: true }))

it.each(['mts', 'cts'])('type-check sendMail with PostHog options in a NodeNext .%s consumer', (extension) => {
writeFileSync(join(consumer, `consumer.${extension}`), CONSUMER)
writeFileSync(
join(consumer, `tsconfig.${extension}.json`),
JSON.stringify({
compilerOptions: {
strict: true,
noEmit: true,
target: 'ES2022',
module: 'NodeNext',
moduleResolution: 'NodeNext',
types: ['node'],
esModuleInterop: true,
},
files: [`consumer.${extension}`],
})
)

const result = spawnSync(
process.execPath,
[join(packageRoot, 'node_modules/typescript/bin/tsc'), '-p', `tsconfig.${extension}.json`, '--pretty', 'false'],
{ cwd: consumer, encoding: 'utf8', timeout: 60_000 }
)

expect(result.stdout + result.stderr).toBe('')
expect(result.status).toBe(0)
})
})
46 changes: 46 additions & 0 deletions packages/node/src/__tests__/nodemailer-process.spec.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
/** @vitest-environment node */

import { spawn } from 'node:child_process'
import { fileURLToPath } from 'node:url'

const packageRoot = fileURLToPath(new URL('../../', import.meta.url))

const SCRIPT_WITH_A_STALLED_ATTACHMENT = `
import { PassThrough } from 'node:stream'
import nodemailer from 'nodemailer'
import { PostHog } from 'posthog-node'
import { createPostHogTransport } from 'posthog-node/nodemailer'

const client = new PostHog('phc_test', { secretKey: 'phs_test', enableLocalEvaluation: false })
const transporter = nodemailer.createTransport(createPostHogTransport({ client }))
const sent = transporter.sendMail({
from: 'shop@example.com',
to: 'ana@example.com',
subject: 'Report',
text: 'Attached.',
attachments: [{ filename: 'report.csv', content: new PassThrough() }],
})
console.log('sending')
await sent
`

describe('the built posthog-node/nodemailer in a script', () => {
it('keeps the script running while it waits for an attachment, so the send can still fail', async () => {
vi.useRealTimers()
const script = spawn(process.execPath, ['--input-type=module', '-e', SCRIPT_WITH_A_STALLED_ATTACHMENT], {
cwd: packageRoot,
stdio: ['ignore', 'pipe', 'ignore'],
})
const exited = new Promise<number | null>((resolve) => script.once('exit', resolve))
const sending = new Promise<void>((resolve) =>
script.stdout.on('data', (chunk) => chunk.includes('sending') && resolve())
)

await Promise.race([sending, exited])
const outcome = await Promise.race([exited, new Promise((resolve) => setTimeout(() => resolve('running'), 2_000))])
script.kill()
await exited

expect(outcome).toBe('running')
})
})
Loading
Loading