Ir para o conteúdo principal

React Intl

[Tradução Beta Não Oficial]

Esta página foi traduzida por PageTurner AI (beta). Não é oficialmente endossada pelo projeto. Encontrou um erro? Reportar problema →

Nota

Se você deseja combinar o setupTests com outra configuração, consulte setup

Configurando Polyfills/Locales do React-Intl​

Se você está usando React-Intl em seu projeto e precisa carregar uma localidade, você tem duas opções:

  1. Ao usar Node 13 ou superior, o suporte a Intl já vem nativamente. A opção padrão de ICU (International Components for Unicode) para Node é full-icu, o que significa todos os componentes ICU.
    Tudo que você precisa fazer é incorporar o conjunto de dados ICU necessário:

    // test-utils.js

    const hasFullICU = () => {
      // That's the recommended way to test for ICU support according to Node.js docs
      try {
        const january = new Date(9e8)
        const pt = new Intl.DateTimeFormat('pt', {month: 'long'})
        return pt.format(january) === 'janeiro'
      } catch (err) {
        return false
      }
    }

    export const setupTests = () => {
      if (hasFullICU()) {
        Intl.NumberFormat.format = new Intl.NumberFormat('pt').format
        Intl.DateTimeFormat.format = new Intl.DateTimeFormat('pt').format
      } else {
        global.Intl = IntlPolyfill
      }
    }

  2. Ao usar versões anteriores do Node, a opção padrão de ICU é small-icu, o que inclui apenas um subconjunto de dados ICU (normalmente apenas o locale em inglês).
    Se você precisar carregar uma localidade, tem duas alternativas:

    1. Carregar os Polyfills específicos para o idioma:

      // test-utils.js
      import IntlPolyfill from 'intl'
      import 'intl/locale-data/jsonp/pt'

      export const setupTests = () => {
        // https://formatjs.io/docs/guides/runtime-requirements/#nodejs
        if (global.Intl) {
          Intl.NumberFormat = IntlPolyfill.NumberFormat
          Intl.DateTimeFormat = IntlPolyfill.DateTimeFormat
        } else {
          global.Intl = IntlPolyfill
        }
      }

    2. Carregar os ICUs em tempo de execução:
      Instale o pacote full-icu e injete-o no seu ambiente de teste. Você pode fazer isso definindo NODE_ICU_DATA antes de chamar o Jest: NODE_ICU_DATA=node_modules/full-icu jest. Isso fornecerá suporte full-icu conforme mostrado na opção 1.

Criando uma função de renderização personalizada​

Para testar nosso componente traduzido, podemos criar uma função render personalizada usando a opção wrapper, conforme explicado na página de configuração.
Nossa função render personalizada pode ser assim:

// test-utils.js
import React from 'react'
import {render as rtlRender} from '@testing-library/react'
import {IntlProvider} from 'react-intl'

function render(ui, {locale = 'pt', ...renderOptions} = {}) {
  function Wrapper({children}) {
    return <IntlProvider locale={locale}>{children}</IntlProvider>
  }
  return rtlRender(ui, {wrapper: Wrapper, ...renderOptions})
}

// re-export everything
export * from '@testing-library/react'

// override render method
export {render}

Um exemplo completo​

import React from 'react'
import '@testing-library/jest-dom'
// We're importing from our own created test-utils and not RTL's
import {render, screen, setupTests} from '../test-utils.js'
import {FormattedDate} from 'react-intl'

const FormatDateView = () => {
  return (
    <div data-testid="date-display">
      <FormattedDate
        value="2019-03-11"
        timeZone="utc"
        day="2-digit"
        month="2-digit"
        year="numeric"
      />
    </div>
  )
}

setupTests()

test('it should render FormattedDate and have a formatted pt date', () => {
  render(<FormatDateView />)
  expect(screen.getByTestId('date-display')).toHaveTextContent('11/03/2019')
})

Estratégia de teste para componentes traduzidos​

Ao testar um componente traduzido, podem existir diferentes abordagens para alcançar a cobertura desejada, sendo que o objetivo principal deve ser testar o componente de forma a simular o máximo possível o comportamento do usuário.

ApproachProsCons
Use strings from the default languageTest is easy to read, and asserts expected default output. If you have variables in your strings, you can test that they work properly with correct output.1. Strings hardcoded into tests mean you have to update both tests and code for any copy changes. 2. If multiple elements have the same string/substring text, find-and-replace may be hard to use reliably.
Mock the translation libraryIf your library is difficult to use in the test environment, you can mock it so it is easier. For example, you can add the message ID as a data-attribute to the text so you can query by that.Test code deviates from what runs in production. Tests may assert about message IDs but not enough about content, so errors are possible.
Use translation library in testsDecouples strings from tests, so you can update the message files in one place without worrying about breaking tests. Can run tests in another language or multiple languages. const buttonText = getNodeText(<FormattedMessage id="buttonText" defaultMessage="Hello Button" />);Overhead - it takes more lines of code to write the test, and you need to know the variables and message IDs to create the right strings. It's not obvious what the text actually is when you read the test code, making maintaining it harder.
Use translation library + inline snapshotsSame as above, but by adding an inline snapshot of the string, you can read the test code and see what strings are in use, but easily update them with jest --updateSnapshot if the messages change. expect(buttonText).toMatchInlineSnapshot("'My button text'")Tests are longer because of the extra lines. You can wrap up some of the translation-related code into a helper function to make it a little more inline-able and avoid repeating yourself, but you still need to know the message IDs and variables inside the test.