Add support for binding SSR props in Vue 3 directive (#869)

Demivan · web-flow · commit bcdd82a1761c · 2024-04-04T18:18:54.000+03:00
diff --git a/__tests__/utils/ssr.ts b/__tests__/utils/ssr.ts
@@ -0,0 +1,22 @@
+import * as TestUtils from '@vue/test-utils'
+import type { ComponentOptions } from 'vue-3'
+import { install } from 'vue-demi'
+
+import type { FluentVue } from '../../src'
+
+install()
+
+export function renderSSR<T extends object>(
+  fluent: FluentVue | null,
+  component: ComponentOptions<T>,
+): Promise<string> {
+  const { renderToString } = TestUtils
+
+  const plugins = fluent ? [fluent] : []
+
+  return renderToString(component, {
+    global: {
+      plugins,
+    },
+  })
+}
diff --git a/__tests__/vue/directive.spec.ts b/__tests__/vue/directive.spec.ts
@@ -141,6 +141,8 @@ describe('directive', () => {
       `),
     )
 
+    const warn = vi.spyOn(console, 'warn').mockImplementation(() => {})
+
     const component = {
       data: () => ({
         name: 'John',
@@ -153,6 +155,10 @@ describe('directive', () => {
 
     // Assert
     expect(mounted.html()).toEqual('<a aria-label="Hello \u{2068}John\u{2069}">Text</a>')
+    expect(warn).toHaveBeenCalledTimes(1)
+    expect(warn).toHaveBeenCalledWith(
+      '[fluent-vue] Attribute \'not-allowed\' on element <a> is not localizable. Remove it from the translation. Translation key: link',
+    )
   })
 
   it('works without fallbacks', () => {
diff --git a/__tests__/vue/ssr.spec.ts b/__tests__/vue/ssr.spec.ts
@@ -0,0 +1,48 @@
+import { beforeEach, describe, expect, it } from 'vitest'
+import { isVue3 } from 'vue-demi'
+
+import { FluentBundle, FluentResource } from '@fluent/bundle'
+import ftl from '@fluent/dedent'
+
+import { renderSSR } from '../utils/ssr'
+
+import type { FluentVue } from '../../src'
+import { createFluentVue } from '../../src'
+
+describe.skipIf(!isVue3)('sSR directive', () => {
+  let fluent: FluentVue
+  let bundle: FluentBundle
+
+  beforeEach(() => {
+    bundle = new FluentBundle('en-US')
+
+    fluent = createFluentVue({
+      bundles: [bundle],
+    })
+  })
+
+  it('translates text content', async () => {
+    // Arrange
+    bundle.addResource(
+      new FluentResource(ftl`
+      link = Link text
+        .aria-label = Link aria label
+      `),
+    )
+
+    const component = {
+      data: () => ({
+        name: 'John',
+      }),
+      template: '<a v-t:link href="/foo">Fallback text</a>',
+    }
+
+    // Act
+    const rendered = await renderSSR(fluent, component)
+
+    // Assert
+    // This has fallback text because the textContent is not supported by Vue getSSRProps
+    // Text will be translated using directive transform
+    expect(rendered).toEqual('<a href="/foo" aria-label="Link aria label">Fallback text</a>')
+  })
+})
diff --git a/src/vue/directive.ts b/src/vue/directive.ts
@@ -23,6 +23,8 @@ function translate(el: HTMLElement, fluent: TranslationContext, binding: VueDire
   for (const [attr, attrValue] of Object.entries(translation.attributes)) {
     if (isAttrNameLocalizable(attr, el, allowedAttrs))
       el.setAttribute(attr, attrValue)
+    else
+      warn(`Attribute '${attr}' on element <${el.tagName.toLowerCase()}> is not localizable. Remove it from the translation. Translation key: ${key}`)
   }
 }
 
@@ -39,6 +41,31 @@ export function createVue3Directive(rootContext: TranslationContext): Vue3Direct
       const context = getContext(rootContext, binding.instance)
       translate(el, context, binding)
     },
+
+    getSSRProps(binding) {
+      const context = getContext(rootContext, binding.instance)
+      const key = binding.arg
+      if (key === void 0) {
+        warn('v-t directive is missing arg with translation key')
+        return {}
+      }
+      const translation = context.formatWithAttrs(key, binding.value)
+      const allowedAttrs = Object.keys(binding.modifiers)
+      const attrs: Record<string, string> = {}
+      for (const [attr, attrValue] of Object.entries(translation.attributes)) {
+        // Vue 3 does not expose the element in the binding object
+        // so we can't check if the attribute is allowed
+        // we assume that all attributes are allowed
+        // this could lead to SSR hydration mismatches if translation
+        // contains attributes that are not allowed
+        // There is a runtime warning in the browser console in case translation contains not allowed attributes
+        if (isAttrNameLocalizable(attr, {} as HTMLElement, allowedAttrs))
+          attrs[attr] = attrValue
+      }
+
+      // TODO: Include textContent when https://github.com/vuejs/core/issues/8112 is resolved
+      return attrs
+    },
   }
 }
 
