Skip to content

Commit 10e4317

Browse files
zcf0508zcf0508
committed
feat(caddy): improve base path handling and route grouping
- Normalize base paths to ensure consistent formatting - Group routes by host and sort by base path length - Add support for multiple routes with different base paths on same host - Update caddyfile template to handle grouped routes - Add tests for base path functionality
1 parent fdb662a commit 10e4317

8 files changed

Lines changed: 342 additions & 104 deletions

File tree

‎examples/vite/vite.config.ts‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ import Inspect from 'vite-plugin-inspect'
33
import Unplugin from '../../src/vite'
44

55
export default defineConfig({
6+
base: '/test',
67
plugins: [
78
Inspect(),
89
Unplugin({

‎src/caddy/caddyfile.ts‎

Lines changed: 58 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -46,33 +46,72 @@ export const caddyTemplate = `{
4646
}
4747
}
4848
49-
{% for p in proxies %}
50-
{{ p.target }}{{ p.portSuffix }} {
51-
{{ p.tls }}
52-
reverse_proxy http://{{ p.source }} {% if p.healthCheck %} {
53-
health_uri {{ p.base }}
54-
health_interval 2s
55-
health_timeout 5s
56-
fail_duration 2s
57-
unhealthy_status 502 503 504 404
58-
lb_try_duration 3s
59-
lb_try_interval 300ms
60-
61-
@error status 502 503 504 404
62-
handle_response @error {
63-
respond * 503 {
64-
body "Service Unavailable"
65-
close
49+
{% for host in hosts %}
50+
{{ host.host }}{{ host.portSuffix }} {
51+
{{ host.tls }}
52+
53+
{% for route in host.routes %}
54+
handle {{ route.base }}* {
55+
reverse_proxy http://{{ route.source }} {% if route.healthCheck %} {
56+
health_uri {{ route.base }}
57+
health_interval 2s
58+
health_timeout 5s
59+
health_headers {
60+
User-Agent {http.request.header.User-Agent}
61+
Accept text/html,application/json,*/*
62+
}
63+
fail_duration 2s
64+
unhealthy_status 502 503 504 404
65+
lb_try_duration 3s
66+
lb_try_interval 300ms
67+
68+
@error status 502 503 504 404
69+
handle_response @error {
70+
respond * 503 {
71+
body "Service Unavailable"
72+
close
73+
}
6674
}
6775
}
76+
{% endif %}
6877
}
69-
{% endif %}
78+
{% endfor %}
7079
}
7180
{% endfor %}
7281
`
7382

7483
const liquid = new Liquid()
7584

7685
export async function genCaddyfile(ctx: typeof CaddyContext.infer): Promise<string> {
77-
return await liquid.parseAndRender(caddyTemplate, ctx)
86+
const hostsMap = new Map<string, {
87+
host: string
88+
portSuffix: string
89+
tls: string
90+
routes: typeof ProxyType.infer[]
91+
}>()
92+
93+
for (const proxy of ctx.proxies) {
94+
const key = `${proxy.target}${proxy.portSuffix}`
95+
if (!hostsMap.has(key)) {
96+
hostsMap.set(key, {
97+
host: proxy.target,
98+
portSuffix: proxy.portSuffix,
99+
tls: proxy.tls,
100+
routes: [],
101+
})
102+
}
103+
let base = proxy.base || '/'
104+
if (!base.startsWith('/'))
105+
base = `/${base}`
106+
if (base !== '/' && !base.endsWith('/'))
107+
base = `${base}/`
108+
hostsMap.get(key)!.routes.push({ ...proxy, base })
109+
}
110+
111+
for (const host of hostsMap.values())
112+
host.routes.sort((a, b) => b.base.length - a.base.length)
113+
114+
const hosts = Array.from(hostsMap.values())
115+
116+
return await liquid.parseAndRender(caddyTemplate, { ...ctx, hosts })
78117
}

‎src/caddy/config.ts‎

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,8 +44,13 @@ export function useCaddyConfig(): {
4444
const proxies = configJsonRef() || {}
4545

4646
_proxies.forEach((p) => {
47-
const index = `${p.target}${p.portSuffix}`
48-
proxies[index] = p
47+
let base = p.base || '/'
48+
if (!base.startsWith('/'))
49+
base = `/${base}`
50+
if (base !== '/' && !base.endsWith('/'))
51+
base = `${base}/`
52+
const index = `${p.target}${p.portSuffix}${base}`
53+
proxies[index] = { ...p, base }
4954
})
5055

5156
const content = JSON.stringify(proxies, null, 2)

‎src/caddy/index.ts‎

Lines changed: 17 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -199,14 +199,23 @@ export class CaddyInstant {
199199
consola.success('update host success\n')
200200

201201
const targetHost = target.split(':')[0]
202+
const normalizeBase = (b: string): string => {
203+
let out = b || '/'
204+
if (!out.startsWith('/'))
205+
out = `/${out}`
206+
if (out !== '/' && !out.endsWith('/'))
207+
out = `${out}/`
208+
return out
209+
}
210+
const baseNormalized = normalizeBase(base)
202211

203212
const proxies = [
204213
{
205214
target: targetHost,
206215
portSuffix: https ? '' : ':80',
207216
tls: https ? 'tls internal' : '',
208217
source,
209-
base,
218+
base: baseNormalized,
210219
healthCheck,
211220
},
212221
]
@@ -218,15 +227,13 @@ export class CaddyInstant {
218227
effect(async () => {
219228
const { configJsonRef } = getCaddyConfig()
220229
const proxies = Object.values(configJsonRef() || {})
221-
if (!(this.caddyfile || '').includes(`${target.split(':')[0]}${https ? '' : ':80'}`)) {
222-
const ctx = validateTemplateContext({
223-
caddy_root: this.caddyRoot,
224-
proxies,
225-
})
226-
227-
this.caddyfile = await genCaddyfile(ctx)
228-
await this.writeCaddyfile()
229-
}
230+
const ctx = validateTemplateContext({
231+
caddy_root: this.caddyRoot,
232+
proxies,
233+
})
234+
235+
this.caddyfile = await genCaddyfile(ctx)
236+
await this.writeCaddyfile()
230237
}),
231238
)
232239

‎src/index.ts‎

Lines changed: 24 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -160,6 +160,16 @@ export const unpluginFactory: UnpluginFactory<Options> = options => ({
160160
if (caddy)
161161
return
162162

163+
let base = '/'
164+
const publicPath = compiler.options.output?.publicPath as unknown
165+
if (typeof publicPath === 'string' && publicPath) {
166+
base = publicPath
167+
}
168+
if (!base.startsWith('/'))
169+
base = `/${base}`
170+
if (base !== '/' && !base.endsWith('/'))
171+
base = `${base}/`
172+
163173
// https://github.com/webpack/webpack-dev-server/blob/master/lib/Server.js#L1913
164174
const _close = compiler.close?.bind(compiler)
165175
if (_close) {
@@ -177,12 +187,13 @@ export const unpluginFactory: UnpluginFactory<Options> = options => ({
177187
caddy = new CaddyInstant()
178188

179189
caddy.run(source, target, {
190+
base,
180191
...options,
181192
}).then(() => {
182193
compiler.hooks.done.tap('unplugin-https-reverse-proxy', async () => {
183194
await printForwardProxy()
184195

185-
consola.success(` ${c.green('➜')} ${c.bold('run caddy reverse proxy success')}: ${colorUrl(`${options.https ? 'https' : 'http'}://${target}`)}`)
196+
consola.success(` ${c.green('➜')} ${c.bold('run caddy reverse proxy success')}: ${colorUrl(`${options.https ? 'https' : 'http'}://${target}${base}`)}`)
186197
})
187198
}).catch((e) => {
188199
throw e
@@ -231,12 +242,23 @@ export const unpluginFactory: UnpluginFactory<Options> = options => ({
231242

232243
caddy = new CaddyInstant()
233244

245+
let base = '/'
246+
const publicPath = compiler.options.output?.publicPath as unknown
247+
if (typeof publicPath === 'string' && publicPath) {
248+
base = publicPath
249+
}
250+
if (!base.startsWith('/'))
251+
base = `/${base}`
252+
if (base !== '/' && !base.endsWith('/'))
253+
base = `${base}/`
254+
234255
caddy.run(source, target, {
256+
base,
235257
...options,
236258
}).then(async () => {
237259
await printForwardProxy()
238260

239-
consola.success(` ${c.green('➜')} ${c.bold('run caddy reverse proxy success')}: ${colorUrl(`${options.https ? 'https' : 'http'}://${target}`)}`)
261+
consola.success(` ${c.green('➜')} ${c.bold('run caddy reverse proxy success')}: ${colorUrl(`${options.https ? 'https' : 'http'}://${target}${base}`)}`)
240262
}).catch((e) => {
241263
throw e
242264
})

‎test/caddy-config.test.ts‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
import { afterEach, describe, expect, it } from 'vitest'
2+
import { useCaddyConfig } from '../src/caddy/config'
3+
4+
describe('caddy config write with base path', () => {
5+
afterEach(async () => {
6+
const { cleanUp } = useCaddyConfig()
7+
await cleanUp()
8+
})
9+
10+
it('should not override when same host with different base', () => {
11+
const { writeCaddyConfig, configJsonRef } = useCaddyConfig()
12+
13+
writeCaddyConfig([
14+
{
15+
target: 'example.com',
16+
portSuffix: ':80',
17+
tls: '',
18+
source: 'localhost:5173',
19+
base: '/app',
20+
healthCheck: true,
21+
},
22+
{
23+
target: 'example.com',
24+
portSuffix: ':80',
25+
tls: '',
26+
source: 'localhost:5174',
27+
base: '/api',
28+
healthCheck: true,
29+
},
30+
])
31+
32+
const cfg = configJsonRef()
33+
expect(cfg).toBeTruthy()
34+
const keys = Object.keys(cfg!)
35+
expect(keys).toContain('example.com:80/app/')
36+
expect(keys).toContain('example.com:80/api/')
37+
expect(cfg!['example.com:80/app/'].source).toEqual('localhost:5173')
38+
expect(cfg!['example.com:80/api/'].source).toEqual('localhost:5174')
39+
})
40+
})

0 commit comments

Comments
 (0)