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.

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

fix: regression local composer extending #45

Merged
merged 1 commit into from
Aug 24, 2023
Merged
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
7 changes: 4 additions & 3 deletions packages/vue-i18n-routing/scripts/vitest.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,14 @@ import type { InjectionKey, Ref } from 'vue-demi'

type InstanceType<V> = V extends { new (...arg: any[]): infer X } ? X : never
type VM<V> = InstanceType<V> & { unmount(): void }
type Plugins = [...any]

export function mount<V>(Comp: V, plugins: any[] = []) {
export function mount<V>(Comp: V, plugins: Plugins[] = []) {
const el = document.createElement('div')
const app = createApp(Comp as any)

for (const plugin of plugins) {
app.use(plugin)
app.use(plugin[0], plugin[1])
}

// @ts-ignore
Expand All @@ -22,7 +23,7 @@ export function mount<V>(Comp: V, plugins: any[] = []) {
return comp
}

export function useSetup<V>(setup: () => V, plugins: any[] = []) {
export function useSetup<V>(setup: () => V, plugins: Plugins[] = []) {
const Comp = defineComponent({
setup,
render() {
Expand Down
16 changes: 8 additions & 8 deletions packages/vue-i18n-routing/src/__test__/compatibles.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ describe('getRouteBaseName', () => {
history: createMemoryHistory()
})
await router.push('/en')
const vm = useSetup(() => {}, [router, i18n]) as any // FIXME:
const vm = useSetup(() => {}, [[router], [i18n]]) as any // FIXME:
const name = vm.getRouteBaseName()
assert.equal(name, 'home')
})
Expand All @@ -54,7 +54,7 @@ describe('getRouteBaseName', () => {
history: createMemoryHistory()
})
await router.push('/en')
const vm = useSetup(() => {}, [router, i18n]) as any // FIXME:
const vm = useSetup(() => {}, [[router], [i18n]]) as any // FIXME:
const name = vm.getRouteBaseName()
assert.equal(name, 'home')
})
Expand All @@ -81,7 +81,7 @@ describe('localePath', () => {
history: createMemoryHistory()
})
await router.push('/en')
const vm = useSetup(() => {}, [router, i18n]) as any // FIXME:
const vm = useSetup(() => {}, [[router], [i18n]]) as any // FIXME:

// path
assert.equal(vm.localePath('/'), '/en')
Expand Down Expand Up @@ -136,7 +136,7 @@ describe('localePath', () => {
history: createMemoryHistory()
})
await router.push('/')
const vm = useSetup(() => {}, [router, i18n]) as any // FIXME:
const vm = useSetup(() => {}, [[router], [i18n]]) as any // FIXME:

// path
assert.equal(vm.localePath('/'), '/')
Expand Down Expand Up @@ -189,7 +189,7 @@ describe('localeRoute', () => {
history: createMemoryHistory()
})
await router.push('/en')
const vm = useSetup(() => {}, [router, i18n]) as any // FIXME:
const vm = useSetup(() => {}, [[router], [i18n]]) as any // FIXME:

// path
assert.include(vm.localeRoute('/'), {
Expand Down Expand Up @@ -286,7 +286,7 @@ describe('localeLocation', () => {
history: createMemoryHistory()
})
await router.push('/en')
const vm = useSetup(() => {}, [router, i18n]) as any // FIXME:
const vm = useSetup(() => {}, [[router], [i18n]]) as any // FIXME:

// path
assert.include(vm.localeLocation('/'), {
Expand Down Expand Up @@ -408,7 +408,7 @@ describe('switchLocalePath', () => {
history: createMemoryHistory()
})
await router.push('/en/about')
const vm = useSetup(() => {}, [router, i18n]) as any // FIXME:
const vm = useSetup(() => {}, [[router], [i18n]]) as any // FIXME:
await router.push('/ja')

assert.equal(vm.switchLocalePath('ja'), '/ja')
Expand Down Expand Up @@ -482,7 +482,7 @@ describe('localeHead', () => {
history: createMemoryHistory()
})
await router.push('/en/about')
const vm = useSetup(() => {}, [router, i18n]) as any // FIXME:
const vm = useSetup(() => {}, [[router], [i18n]]) as any // FIXME:

let head = vm.localeHead({ addDirAttribute: true, addSeoAttributes: true })
expect(head).toMatchSnapshot('en')
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ describe('useLocaleHead', () => {
i18n,
head
}
}, [router, i18n])
}, [[router], [i18n]])

await router.push('/ja')
expect(vm.head).toMatchSnapshot(vm.i18n.locale.value)
Expand Down Expand Up @@ -87,7 +87,7 @@ describe('useLocaleHead', () => {
i18n,
head
}
}, [router, i18n])
}, [[router], [i18n]])

await router.push('/ja')
for (const m of vm.head.meta || []) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ describe('useRouteBaseName', () => {
const getRouteBaseName = useRouteBaseName()
const name = getRouteBaseName(route)
assert.equal(name, 'home')
}, [router, i18n])
}, [[router], [i18n]])
})
})

Expand All @@ -59,7 +59,7 @@ describe('useRouteBaseName', () => {
const getRouteBaseName = useRouteBaseName()
const name = getRouteBaseName({} as Route)
assert.equal(name, null)
}, [router, i18n])
}, [[router], [i18n]])
})
})

Expand Down Expand Up @@ -87,7 +87,7 @@ describe('useRouteBaseName', () => {
const getRouteBaseName = useRouteBaseName({ route, routesNameSeparator: '---' })
const name = getRouteBaseName()
assert.equal(name, 'home')
}, [router, i18n])
}, [[router], [i18n]])
})
})
})
Expand Down Expand Up @@ -122,7 +122,7 @@ describe('useLocalePath', () => {
assert.equal(localePath('not-found'), '/en')
// object
assert.equal(localePath({ name: 'about' }, 'ja'), '/ja/about')
}, [router, i18n])
}, [[router], [i18n]])
})
})
})
Expand Down Expand Up @@ -155,7 +155,7 @@ describe('useLocalePath', () => {
assert.equal(localePath('not-found'), '/')
// object
assert.equal(localePath({ name: 'about' }, 'ja'), '/about')
}, [router, i18n])
}, [[router], [i18n]])
})
})
})
Expand Down Expand Up @@ -229,7 +229,7 @@ describe('useLocaleRoute', () => {
name: 'about___ja',
href: '/ja/about'
})
}, [router, i18n])
}, [[router], [i18n]])
})
})

Expand Down Expand Up @@ -302,7 +302,7 @@ describe('useLocaleLocation', () => {
name: 'about___ja',
href: '/ja/about'
})
}, [router, i18n])
}, [[router], [i18n]])
})
})

Expand Down Expand Up @@ -333,7 +333,7 @@ describe('useSwitchLocalePath', () => {
return {
switchLocalePath: change
}
}, [router, i18n])
}, [[router], [i18n]])

await router.push('/ja')
assert.equal(vm.switchLocalePath('ja'), '/ja')
Expand Down
61 changes: 56 additions & 5 deletions packages/vue-i18n-routing/src/extends/__test__/i18n.test.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/* eslint-disable @typescript-eslint/no-explicit-any */

import { createI18n } from '@intlify/vue-i18n-bridge'
import { createI18n, useI18n } from '@intlify/vue-i18n-bridge'
import { vi, describe, it, assert, expect } from 'vitest'
import { ref, nextTick } from 'vue-demi'

Expand All @@ -19,7 +19,7 @@ describe('extendI18n', () => {
localeCodes: ['en', 'ja']
})

const vm = useSetup(() => {}, [i18n])
const vm = useSetup(() => {}, [[i18n]])
const composer = i18n.global as unknown as Composer
assert.deepEqual(composer.locales.value, [{ code: 'en' }, { code: 'ja' }])
assert.deepEqual(composer.localeCodes.value, ['en', 'ja'])
Expand All @@ -36,7 +36,7 @@ describe('extendI18n', () => {
localeCodes: ['en', 'ja']
})

const vm = useSetup(() => {}, [i18n])
const vm = useSetup(() => {}, [[i18n]])
const vueI18n = i18n.global as unknown as VueI18n
assert.deepEqual(vueI18n.locales, [{ code: 'en' }, { code: 'ja' }])
assert.deepEqual(vueI18n.localeCodes, ['en', 'ja'])
Expand Down Expand Up @@ -69,7 +69,7 @@ describe('extendI18n', () => {
}
}
})
const vm = useSetup(() => {}, [i18n])
const vm = useSetup(() => {}, [[i18n]])
const $i18n = (vm as any).$i18n
const composer = i18n.global as unknown as Composer

Expand Down Expand Up @@ -119,7 +119,7 @@ describe('extendI18n', () => {
}
}
})
const vm = useSetup(() => {}, [i18n])
const vm = useSetup(() => {}, [[i18n]])
const $i18n = (vm as any).$i18n
const vueI18n = i18n.global as unknown as VueI18n

Expand All @@ -134,6 +134,57 @@ describe('extendI18n', () => {
})
})
})

describe('__composerExtend include in plugin options', () => {
test('should be extended', async () => {
const extendFn = vi.fn()
const disposeFn = vi.fn()

const i18n = createI18n({ legacy: false, globalInjection: true, locale: 'en' })
extendI18n(i18n, {
locales: [{ code: 'en' }, { code: 'ja' }],
localeCodes: ['en', 'ja'],
hooks: {
onExtendComposer(composer: Composer) {
;(composer as any).fn = extendFn
},
onExtendExportedGlobal(g) {
return {
fn: {
get() {
return (g as any).fn
}
}
}
}
}
})
const pluginOptions = {
__composerExtend: (c: Composer) => {
;(c as any).fn = (i18n.global as any).fn
return disposeFn
}
}
const vm = useSetup(() => {
const i18n = useI18n({
useScope: 'local'
})
;(i18n as any).fn()
return {}
}, [[i18n, pluginOptions]])
const $i18n = (vm as any).$i18n
const composer = i18n.global as any

$i18n.fn()
composer.fn()

await nextTick()
expect(extendFn).toHaveBeenCalledTimes(3)

vm.unmount()
expect(disposeFn).toBeCalledTimes(1)
})
})
})

/* eslint-enable @typescript-eslint/no-explicit-any */
2 changes: 1 addition & 1 deletion packages/vue-i18n-routing/src/extends/i18n.ts
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ export function extendI18n<Context = unknown, TI18n extends I18n = I18n>(
localComposer.baseUrl = computed(() => globalComposer.baseUrl.value)
let orgComposerDispose: Disposer | undefined
if (isFunction(orgComposerExtend)) {
orgComposerDispose = Reflect.apply(orgComposerExtend, pluginOptions, [globalComposer])
orgComposerDispose = Reflect.apply(orgComposerExtend, pluginOptions, [localComposer])
}
return () => {
orgComposerDispose && orgComposerDispose()
Expand Down