Skip to content

Beautiful Open-Source Form Builder

Fix submission confetti after Nuxt upgrade (#1380)

Julien Nahum8c97bb251983
diff --git a/client/composables/useConfetti.js b/client/composables/useConfetti.js
index cd7ff2612..40687abf8 100644
--- a/client/composables/useConfetti.js
+++ b/client/composables/useConfetti.js
@@ -10,7 +10,9 @@ export const useConfetti = () => {
if (existingConfetti) return Promise.resolve(existingConfetti)
if (confettiPromise) return confettiPromise
- confettiPromise = import('vue-confetti').then(({ default: VueConfetti }) => {
+ confettiPromise = import('vue-confetti').then(({ default: moduleDefault }) => {
+ // The UMD build can expose its plugin under a second default export.
+ const VueConfetti = moduleDefault.install ? moduleDefault : moduleDefault.default
nuxtApp.vueApp.use(VueConfetti)
return nuxtApp.vueApp.config.globalProperties.$confetti
})
diff --git a/client/test/e2e/opnform-flows.spec.ts b/client/test/e2e/opnform-flows.spec.ts
index 01cd93a96..413887faa 100644
--- a/client/test/e2e/opnform-flows.spec.ts
+++ b/client/test/e2e/opnform-flows.spec.ts
@@ -1462,3 +1462,40 @@ for (const viewport of [{ name: "desktop", width: 1280 }, { name: "mobile", widt
expect(retryCount).toBe(1)
})
}
+
+for (const style of ["classic", "focused"] as const) {
+ for (const enabled of [true, false]) {
+ test(`${style} submission confetti enabled=${enabled}`, async ({ page, request }, testInfo) => {
+ const errors: string[] = []
+ page.on("pageerror", error => errors.push(error.message))
+ const form = await apiCreateForm(request, {
+ presentationStyle: style,
+ payloadOverrides: {
+ confetti_on_submission: enabled,
+ properties: [buildTextField("confetti_name", "Your name", { required: true })],
+ },
+ })
+ await openPublicForm(page, form.slug)
+ await expect(page.locator("#confetti-canvas")).toHaveCount(0)
+ await fillLabeledInput(page, "Your name", "Confetti Visitor")
+ await page.getByRole("button", { name: /submit/i }).click()
+ await expectSubmissionSuccess(page)
+
+ if (enabled) {
+ await expect(page.locator("#confetti-canvas")).toBeVisible()
+ // Check real painted particles, not just an empty canvas element.
+ await expect.poll(() => page.locator("#confetti-canvas").evaluate((canvas: HTMLCanvasElement) => {
+ const pixels = canvas.getContext("2d")!.getImageData(0, 0, canvas.width, canvas.height).data
+ return pixels.some((value, index) => index % 4 === 3 && value > 0)
+ })).toBe(true)
+ await testInfo.attach("confetti-after-submission", { body: await page.screenshot(), contentType: "image/png" })
+ } else {
+ await expect(page.locator("#confetti-canvas")).toHaveCount(0)
+ }
+ const token = await apiLogin(request)
+ const submissions = await apiListSubmissions(request, token, form.slug)
+ expect(JSON.stringify(submissions)).toContain("Confetti Visitor")
+ expect(errors).toEqual([])
+ })
+ }
+}
diff --git a/client/test/unit/confetti.spec.ts b/client/test/unit/confetti.spec.ts
new file mode 100644
index 000000000..88b5ef854
--- /dev/null
+++ b/client/test/unit/confetti.spec.ts
@@ -0,0 +1,59 @@
+// @vitest-environment jsdom
+import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest'
+import { mount } from '@vue/test-utils'
+import { useConfetti } from '~/composables/useConfetti'
+
+const state = vi.hoisted(() => ({ moduleDefault: null as any, app: null as any }))
+vi.mock('vue-confetti', () => ({ get default() { return state.moduleDefault } }))
+
+const wrappers: ReturnType<typeof mount>[] = []
+function fixture() {
+ let confetti: ReturnType<typeof useConfetti>
+ wrappers.push(mount({ setup() { confetti = useConfetti(); return () => null } }))
+ return confetti!
+}
+
+beforeEach(() => {
+ vi.useFakeTimers()
+ vi.stubGlobal('useNuxtApp', () => ({ vueApp: state.app }))
+ state.app = {
+ config: { globalProperties: {} },
+ use: vi.fn(plugin => plugin.install(state.app)),
+ }
+})
+afterEach(() => {
+ wrappers.splice(0).forEach(wrapper => wrapper.unmount())
+ vi.useRealTimers()
+ vi.unstubAllGlobals()
+})
+
+describe('lazy confetti loading', () => {
+ for (const nested of [false, true]) {
+ it(`plays and stops with a ${nested ? 'UMD wrapped' : 'direct'} plugin export`, async () => {
+ const confetti = { start: vi.fn(), stop: vi.fn() }
+ const plugin = { install: vi.fn(app => { app.config.globalProperties.$confetti = confetti }) }
+ state.moduleDefault = nested ? { __esModule: true, default: plugin } : plugin
+ const player = fixture()
+ expect(state.app.use).not.toHaveBeenCalled()
+ await player.play()
+ expect(state.app.use).toHaveBeenCalledWith(plugin)
+ expect(confetti.start).toHaveBeenCalledWith({ defaultSize: 6 })
+ vi.advanceTimersByTime(2999)
+ expect(confetti.stop).not.toHaveBeenCalled()
+ vi.advanceTimersByTime(1)
+ expect(confetti.stop).toHaveBeenCalledOnce()
+ await player.play(500)
+ expect(state.app.use).toHaveBeenCalledOnce()
+ vi.advanceTimersByTime(500)
+ expect(confetti.stop).toHaveBeenCalledTimes(2)
+ })
+ }
+
+ it('reuses an already installed confetti instance', async () => {
+ const confetti = { start: vi.fn(), stop: vi.fn() }
+ state.app.config.globalProperties.$confetti = confetti
+ await fixture().play()
+ expect(state.app.use).not.toHaveBeenCalled()
+ expect(confetti.start).toHaveBeenCalledOnce()
+ })
+})