|
| 1 | +// Copyright (c) 2026 ObjectStack. Licensed under the Apache-2.0 license. |
| 2 | + |
| 3 | +/** |
| 4 | + * The template context's `baseUrl` key: the deployment's address, so a |
| 5 | + * template can render an absolute link to a record or an app route |
| 6 | + * (`{{baseUrl}}/<object>/<id>`). |
| 7 | + * |
| 8 | + * The chain, env first as for `appName`: `OS_AUTH_URL` (legacy |
| 9 | + * `BETTER_AUTH_URL`) > `OS_BASE_URL` > `config.email.defaultTemplateContext.baseUrl` |
| 10 | + * > `http://localhost:<port>`, never ending in a slash. The env half mirrors |
| 11 | + * `os serve`'s own reader; the parity pin against it lives in |
| 12 | + * `@objectstack/cli` (`serve-email-base-url-parity.test.ts`). |
| 13 | + */ |
| 14 | + |
| 15 | +import { describe, it, expect } from 'vitest'; |
| 16 | +import { resolveEmailCapabilityArg } from './capability-arg.js'; |
| 17 | +import { EmailService, type TemplateLoader, type EmailTemplateRow } from './email-service.js'; |
| 18 | +import type { IEmailTransport, NormalizedEmailMessage, TransportSendResult } from '@objectstack/spec/contracts'; |
| 19 | + |
| 20 | +function contextOf(cfgEmail: Record<string, any>, env: NodeJS.ProcessEnv): Record<string, unknown> { |
| 21 | + return resolveEmailCapabilityArg(cfgEmail, env).options.defaultTemplateContext as Record<string, unknown>; |
| 22 | +} |
| 23 | + |
| 24 | +const CONFIG = { defaultTemplateContext: { baseUrl: 'https://config.example.com' } }; |
| 25 | + |
| 26 | +describe('defaultTemplateContext.baseUrl — the deployment address chain', () => { |
| 27 | + it('OS_AUTH_URL wins over every other link', () => { |
| 28 | + expect(contextOf(CONFIG, { |
| 29 | + OS_AUTH_URL: 'https://auth.example.com', |
| 30 | + BETTER_AUTH_URL: 'https://legacy.example.com', |
| 31 | + OS_BASE_URL: 'https://base.example.com', |
| 32 | + OS_PORT: '4100', |
| 33 | + }).baseUrl).toBe('https://auth.example.com'); |
| 34 | + }); |
| 35 | + |
| 36 | + it('the legacy BETTER_AUTH_URL stands in for OS_AUTH_URL, over OS_BASE_URL (serve reads it so)', () => { |
| 37 | + expect(contextOf(CONFIG, { |
| 38 | + BETTER_AUTH_URL: 'https://legacy.example.com', |
| 39 | + OS_BASE_URL: 'https://base.example.com', |
| 40 | + }).baseUrl).toBe('https://legacy.example.com'); |
| 41 | + }); |
| 42 | + |
| 43 | + it('OS_BASE_URL wins over the config', () => { |
| 44 | + expect(contextOf(CONFIG, { OS_BASE_URL: 'https://base.example.com', OS_PORT: '4100' }).baseUrl) |
| 45 | + .toBe('https://base.example.com'); |
| 46 | + }); |
| 47 | + |
| 48 | + it('the config wins over the local default', () => { |
| 49 | + expect(contextOf(CONFIG, { OS_PORT: '4100' }).baseUrl).toBe('https://config.example.com'); |
| 50 | + }); |
| 51 | + |
| 52 | + it('with nothing set, the local default names the port serve listens on', () => { |
| 53 | + expect(contextOf({}, {}).baseUrl).toBe('http://localhost:3000'); |
| 54 | + expect(contextOf({}, { PORT: '4200' }).baseUrl).toBe('http://localhost:4200'); |
| 55 | + expect(contextOf({}, { OS_PORT: '4100', PORT: '4200' }).baseUrl).toBe('http://localhost:4100'); |
| 56 | + }); |
| 57 | + |
| 58 | + it('a trailing slash is trimmed, from every link', () => { |
| 59 | + expect(contextOf({}, { OS_AUTH_URL: 'https://auth.example.com/' }).baseUrl).toBe('https://auth.example.com'); |
| 60 | + expect(contextOf({}, { OS_BASE_URL: 'https://base.example.com/app//' }).baseUrl) |
| 61 | + .toBe('https://base.example.com/app'); |
| 62 | + expect(contextOf({ defaultTemplateContext: { baseUrl: 'https://config.example.com/' } }, {}).baseUrl) |
| 63 | + .toBe('https://config.example.com'); |
| 64 | + }); |
| 65 | + |
| 66 | + it('a set-but-empty OS_AUTH_URL is a value, as serve reads it — not skipped', () => { |
| 67 | + // `serve` resolves `OS_AUTH_URL=` to '' and warns at boot that the auth |
| 68 | + // base URL is unusable; the mirror takes the same answer rather than |
| 69 | + // inventing a second reading of the same variable. |
| 70 | + expect(contextOf(CONFIG, { OS_AUTH_URL: '', OS_BASE_URL: 'https://base.example.com' }).baseUrl).toBe(''); |
| 71 | + }); |
| 72 | + |
| 73 | + it('control: appName resolves exactly as before, beside it', () => { |
| 74 | + expect(contextOf( |
| 75 | + { appName: 'Key', defaultTemplateContext: { appName: 'Context', baseUrl: 'https://c.example.com' } }, |
| 76 | + { OS_APP_NAME: 'Env', OS_BASE_URL: 'https://base.example.com' }, |
| 77 | + ).appName).toBe('Env'); |
| 78 | + expect(contextOf({ defaultTemplateContext: { appName: 'Context' } }, {}).appName).toBe('Context'); |
| 79 | + expect(contextOf({}, {}).appName).toBe('ObjectStack'); |
| 80 | + }); |
| 81 | +}); |
| 82 | + |
| 83 | +// ── what a template renders with it ───────────────────────────────────────── |
| 84 | + |
| 85 | +class CaptureTransport implements IEmailTransport { |
| 86 | + public sent: NormalizedEmailMessage[] = []; |
| 87 | + async send(message: NormalizedEmailMessage): Promise<TransportSendResult> { |
| 88 | + this.sent.push(message); |
| 89 | + return { messageId: `msg-${this.sent.length}` }; |
| 90 | + } |
| 91 | +} |
| 92 | + |
| 93 | +const recordLink: EmailTemplateRow = { |
| 94 | + name: 'crm.deal_assigned', |
| 95 | + locale: 'en-US', |
| 96 | + subject: 'Deal assigned', |
| 97 | + body_html: '<p>Open it at {{baseUrl}}/x/1</p>', |
| 98 | + body_text: 'Open it at {{baseUrl}}/x/1', |
| 99 | + active: true, |
| 100 | +}; |
| 101 | + |
| 102 | +function serviceWith(env: NodeJS.ProcessEnv): EmailService { |
| 103 | + const loader: TemplateLoader = { async load(name) { return name === recordLink.name ? recordLink : null; } }; |
| 104 | + const { defaultTemplateContext } = resolveEmailCapabilityArg({}, env).options as { |
| 105 | + defaultTemplateContext: Record<string, unknown>; |
| 106 | + }; |
| 107 | + return new EmailService({ |
| 108 | + transport: new CaptureTransport(), |
| 109 | + defaultFrom: { address: 'no-reply@x.com' }, |
| 110 | + templateLoader: loader, |
| 111 | + defaultTemplateContext, |
| 112 | + }); |
| 113 | +} |
| 114 | + |
| 115 | +describe('a template renders {{baseUrl}} as the absolute link', () => { |
| 116 | + it('produces the absolute link in every face', async () => { |
| 117 | + const out = await serviceWith({ OS_BASE_URL: 'https://crm.example.com/' }) |
| 118 | + .renderTemplate({ template: 'crm.deal_assigned' }); |
| 119 | + expect(out.text).toBe('Open it at https://crm.example.com/x/1'); |
| 120 | + expect(out.html).toBe('<p>Open it at https://crm.example.com/x/1</p>'); |
| 121 | + }); |
| 122 | + |
| 123 | + it("a send's own data.baseUrl still wins over the resolved default", async () => { |
| 124 | + const out = await serviceWith({ OS_BASE_URL: 'https://crm.example.com' }) |
| 125 | + .renderTemplate({ template: 'crm.deal_assigned', data: { baseUrl: 'https://tenant.example.com' } }); |
| 126 | + expect(out.text).toBe('Open it at https://tenant.example.com/x/1'); |
| 127 | + }); |
| 128 | +}); |
0 commit comments