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

Content preview doesn't work propperly when running portal locally #101

Closed
PedroAntunesCosta opened this issue Sep 12, 2024 · 0 comments · Fixed by #102
Closed

Content preview doesn't work propperly when running portal locally #101

PedroAntunesCosta opened this issue Sep 12, 2024 · 0 comments · Fixed by #102
Assignees

Comments

@PedroAntunesCosta
Copy link
Contributor

PedroAntunesCosta commented Sep 12, 2024

Bug

Ao rodar o portal localmente usando o preview de uma branch do repositório help-center-content, o portal pode pegar o conteúdo da main ao invés da branch solicitada.

Eu vi esse comportamento com mudanças na estrutura de pastas do help-center-content de modo que gere erros na função getDocsPaths, usada para buscar caminho do conteúdo em várias páginas (src/utils/getDocsPaths.ts). Mas parece que só dá esse erro nas páginas principais de faq e ki, nos artigos fica ok (mesmo faqs e kis).

Isso impede que façamos ajustes codependentes concomitantes nos 2 repositórios.

Simulação

  1. Sincronize com a branch test-preview do repositório helpcenter.
  2. Rode o portal localmente (yarn dev).
  3. Acesse o preview local usando o preview de conteúdo da branch test-preview do repositório help-center-content (http://localhost:3000/api/preview?branch=test-preview).
  4. Vá até a página de FAQs em português (http://localhost:3000/pt/faq).
  5. Você verá que a página não carrega pois nesta branch todo o conteúdo da pasta pt foi colocado dentro de uma nova pasta test. (Se testar no locale /en verá que funciona normalmente.)
  6. Confira o código de src/utils/getDocsPaths.ts, linha 68. Esta linha foi alterada de modo que provavelmente resolveria o problema do caminho das pastas. Mas mesmo assim o erro persiste.

image

  1. Também há nessa branch alguns logs na função getDocsPaths para debugar esse comportamento.
  repoTree.tree.map((node: any) => {
    const path = node.path
    const re =
      /^(?<path>.+\/)*(?<locale>pt|es|en+)\/(?<localeDir>.+\/)*(?<filename>.+)\.(?<filetype>.+)$/
    if (path.startsWith(`docs/`)) {
      const match = path.match(re)
      const localeDir = match?.groups?.localeDir ? match?.groups?.localeDir : ''
      console.log('LOCALEDIR ------------ '+localeDir)
      console.log('PATH -------- '+path)
      console.log('BRANCH -------- '+branch)
      if (localeDir.startsWith(category) || localeDir.startsWith(`test/${category}`)) {
  1. Atualize a página de faqs e repare que os logs mostram que a função getDocsPaths está usando a branch main.

image

@PedroAntunesCosta PedroAntunesCosta self-assigned this Sep 12, 2024
PedroAntunesCosta added a commit that referenced this issue Sep 12, 2024
PedroAntunesCosta added a commit that referenced this issue Sep 12, 2024
It was not possible to preview content in the FAQ and KI pages before because the fetching of the
docs paths occurred outside of getStaticProps

fix #101
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant