Beautiful Open-Source Form Builder
Prompt self-hosted users to star GitHub after their first form (#1386)
Julien Nahumc4609c2cb551
diff --git a/api/app/Http/Controllers/Forms/FormController.php b/api/app/Http/Controllers/Forms/FormController.phpindex d41a85b31..9e1a83306 100644--- a/api/app/Http/Controllers/Forms/FormController.php+++ b/api/app/Http/Controllers/Forms/FormController.php@@ -156,7 +156,7 @@ class FormController extends Controllerreturn $this->success(['message' => $message . ($form->visibility == 'draft' ? ' But other people won\'t be able to see the form since it\'s currently in draft mode' : ''),'form' => (new FormResource($form))->setCleanings($created['cleanings']),- 'users_first_form' => $request->user()->forms()->count() == 1,+ 'users_first_form' => $request->user()->forms()->withTrashed()->count() == 1,]);}diff --git a/api/tests/Feature/Forms/FormTest.php b/api/tests/Feature/Forms/FormTest.phpindex a6213fc71..c36de6f08 100644--- a/api/tests/Feature/Forms/FormTest.php+++ b/api/tests/Feature/Forms/FormTest.php@@ -14,6 +14,7 @@ it('can create a contact form', function () {->assertJson(['type' => 'success','message' => 'Form created.',+ 'users_first_form' => true,]);expect($workspace->forms()->count())->toBe(1);@@ -22,6 +23,26 @@ it('can create a contact form', function () {]);});+it('does not treat a subsequent form as the users first form', function (bool $deletePreviousForm) {+ $user = $this->actingAsUser();+ $workspace = $this->createUserWorkspace($user);+ $previousForm = $this->createForm($user, $workspace);++ if ($deletePreviousForm) {+ $previousForm->delete();+ }++ $form = $this->makeForm($user, $workspace);+ $formData = (new \App\Http\Resources\FormResource($form))->toArray(request());++ $this->postJson(route('open.forms.store'), $formData)+ ->assertSuccessful()+ ->assertJsonPath('users_first_form', false);+})->with([+ 'existing form' => [false],+ 'deleted form' => [true],+]);+it('can fetch forms', function () {$user = $this->actingAsUser();$workspace = $this->createUserWorkspace($user);diff --git a/client/components/open/forms/components/FormEditor.vue b/client/components/open/forms/components/FormEditor.vueindex 351465936..154cf1e7b 100644--- a/client/components/open/forms/components/FormEditor.vue+++ b/client/components/open/forms/components/FormEditor.vue@@ -200,6 +200,7 @@ const validationErrorResponse = ref(null)const hasBackgroundValidationErrors = ref(false)const backgroundValidatedFormId = ref(null)const createdFormSlug = ref(null)+const { queuePrompt: queueGithubStarPrompt } = useGithubStarPrompt()const formEditorNavbar = ref(null)const route = useRoute()const { emitFormSaved, emitNavigateBack } = useEditorEmbedBridge()@@ -530,12 +531,12 @@ const saveFormCreate = () => {console.error("Analytics error", error)}displayFormModificationAlert(response)+ queueGithubStarPrompt(response)useRouter().push({name: "forms-slug-show-share",params: {slug: createdFormSlug.value,- new_form: newForm.users_first_form ?? false,},})}).catch((error) => {diff --git a/client/components/pages/forms/show/GithubStarPrompt.vue b/client/components/pages/forms/show/GithubStarPrompt.vuenew file mode 100644index 000000000..a9be6f536--- /dev/null+++ b/client/components/pages/forms/show/GithubStarPrompt.vue@@ -0,0 +1,53 @@+<template>+ <UModal+ v-model:open="isOpen"+ title="Your first form is ready!"+ description="Help more people discover OpnForm by starring the project on GitHub."+ :ui="{ content: 'sm:max-w-md', footer: 'flex-col gap-2' }"+ >+ <template #body>+ <div class="flex flex-col items-center text-center">+ <div class="mb-5 flex size-16 items-center justify-center rounded-2xl bg-amber-50 dark:bg-amber-950">+ <Icon name="i-heroicons-star" class="size-8 text-amber-500" />+ </div>+ <p class="text-sm leading-6 text-neutral-600 dark:text-neutral-300">+ OpnForm is built by an open-source community. If it's been useful to you,+ a GitHub star is a small way to say thanks and support the project.+ </p>+ </div>+ </template>+ <template #footer>+ <UButton+ :to="opnformConfig.links.github_url"+ target="_blank"+ rel="noopener noreferrer"+ size="lg"+ block+ @click="dismissPrompt"+ >+ <Icon name="i-simple-icons-github" class="size-5" />+ Star OpnForm on GitHub+ <Icon name="i-heroicons-arrow-up-right" class="size-4" />+ </UButton>+ <UButton color="neutral" variant="ghost" size="lg" block @click="dismissPrompt">+ Maybe later+ </UButton>+ </template>+ </UModal>+</template>++<script setup>+import opnformConfig from '~/opnform.config'++const props = defineProps({+ formSlug: { type: String, required: true },+})++const { pendingFormSlug, dismissPrompt } = useGithubStarPrompt()+const isOpen = computed({+ get: () => !!useFeatureFlag('self_hosted', false) && pendingFormSlug.value === props.formSlug,+ set: (open) => {+ if (!open) dismissPrompt()+ },+})+</script>diff --git a/client/composables/useGithubStarPrompt.js b/client/composables/useGithubStarPrompt.jsnew file mode 100644index 000000000..55fa6e450--- /dev/null+++ b/client/composables/useGithubStarPrompt.js@@ -0,0 +1,17 @@+export function useGithubStarPrompt() {+ const pendingFormSlug = useState('github-star-prompt-form', () => null)++ const isSelfHosted = computed(() => !!useFeatureFlag('self_hosted', false))++ function queuePrompt(response) {+ if (isSelfHosted.value && response.users_first_form === true) {+ pendingFormSlug.value = response.form.slug+ }+ }++ function dismissPrompt() {+ pendingFormSlug.value = null+ }++ return { pendingFormSlug, queuePrompt, dismissPrompt }+}diff --git a/client/pages/forms/[slug]/show/share.vue b/client/pages/forms/[slug]/show/share.vueindex 3e13ef766..a3a3265d9 100644--- a/client/pages/forms/[slug]/show/share.vue+++ b/client/pages/forms/[slug]/show/share.vue@@ -106,10 +106,12 @@</div></DashboardPanel></PageSection>+ <GithubStarPrompt :form-slug="form.slug" /></PageContainer></template><script setup>+import GithubStarPrompt from "~/components/pages/forms/show/GithubStarPrompt.vue"import PageContainer from "~/components/dashboard/PageContainer.vue"import PageSection from "~/components/dashboard/PageSection.vue"import DashboardPanel from "~/components/dashboard/DashboardPanel.vue"diff --git a/client/test/nuxt/github-star-prompt.spec.ts b/client/test/nuxt/github-star-prompt.spec.tsnew file mode 100644index 000000000..680c3d298--- /dev/null+++ b/client/test/nuxt/github-star-prompt.spec.ts@@ -0,0 +1,63 @@+import { beforeEach, describe, expect, it } from 'vitest'+import { mount } from '@vue/test-utils'+import { useState } from '#imports'+import { useGithubStarPrompt } from '~/composables/useGithubStarPrompt'+import GithubStarPrompt from '~/components/pages/forms/show/GithubStarPrompt.vue'++function mountPrompt(slug = 'first-form') {+ return mount(GithubStarPrompt, {+ props: { formSlug: slug },+ global: {+ stubs: {+ UModal: {+ props: ['open'],+ template: '<div v-if="open"><slot name="body" /><slot name="footer" /></div>',+ },+ UButton: {+ props: ['to', 'target', 'rel'],+ template: '<a v-if="to" :href="to" :target="target" :rel="rel"><slot /></a><button v-else><slot /></button>',+ },+ Icon: true,+ },+ },+ })+}++describe('first form GitHub invitation', () => {+ beforeEach(() => {+ useState('featureFlags').value = { self_hosted: true }+ useGithubStarPrompt().dismissPrompt()+ })++ it('opens for the first self-hosted form and stays dismissed after remounting', async () => {+ useGithubStarPrompt().queuePrompt({ form: { slug: 'first-form' }, users_first_form: true })+ const wrapper = mountPrompt()+ expect(wrapper.get('a').attributes('href')).toBe('https://github.com/OpnForm/OpnForm')+ expect(wrapper.get('a').attributes('target')).toBe('_blank')+ await wrapper.get('button').trigger('click')+ expect(wrapper.text()).toBe('')+ wrapper.unmount()+ expect(mountPrompt().text()).toBe('')+ })++ it('dismisses when the GitHub link is clicked', async () => {+ useGithubStarPrompt().queuePrompt({ form: { slug: 'first-form' }, users_first_form: true })+ const wrapper = mountPrompt()+ await wrapper.get('a').trigger('click')+ expect(wrapper.text()).toBe('')+ })++ it('does not open for subsequent forms or other form pages', () => {+ useGithubStarPrompt().queuePrompt({ form: { slug: 'later-form' }, users_first_form: false })+ expect(mountPrompt('later-form').text()).toBe('')+ useGithubStarPrompt().queuePrompt({ form: { slug: 'first-form' }, users_first_form: true })+ expect(mountPrompt('other-form').text()).toBe('')+ })++ it('does not open on the hosted service', () => {+ useState('featureFlags').value = { self_hosted: false }+ useGithubStarPrompt().queuePrompt({ form: { slug: 'first-form' }, users_first_form: true })+ expect(mountPrompt().text()).toBe('')+ expect(useGithubStarPrompt().pendingFormSlug.value).toBeNull()+ })+})