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

Feature/add snackbars #62

Merged
merged 3 commits into from
Nov 4, 2024
Merged

Feature/add snackbars #62

merged 3 commits into from
Nov 4, 2024

Conversation

werlleyg
Copy link
Owner

@werlleyg werlleyg commented Nov 4, 2024

Summary by CodeRabbit

  • Novos Recursos

    • Adição da biblioteca react-toastify para notificações em toast.
    • Implementação de mensagens de erro estruturadas para sugestões de filmes.
  • Melhorias

    • A funcionalidade de sugestão de filmes agora inclui tratamento de erros com notificações visuais.
  • Correções de Bugs

    • Melhoria no gerenciamento de estados de carregamento durante a sugestão de filmes.

@werlleyg werlleyg self-assigned this Nov 4, 2024
Copy link

coderabbitai bot commented Nov 4, 2024

Walkthrough

As parte das mudanças, o arquivo package.json foi atualizado para incluir a nova dependência react-toastify e manter a versão existente de react-dom. Um novo enum chamado snackbarMessage foi adicionado para gerenciar mensagens de erro relacionadas a sugestões de filmes. Além disso, o componente principal da aplicação foi modificado para incluir o ToastContainer, permitindo a exibição global de notificações. Por fim, a lógica de tratamento de erros na função handleGetSuggestMovie foi aprimorada para disparar notificações em caso de falha.

Changes

Arquivo Resumo da Mudança
package.json Adicionada a dependência "react-toastify": "^10.0.6"; react-dom permanece inalterado.
src/domain/enums/snackbar.enum.ts Adicionado o enum snackbarMessage com o membro SUGGEST_MOVIE_ERROR.
src/pages/_app.tsx Importado o CSS do react-toastify e adicionado o ToastContainer ao componente App.
src/pages/index.tsx Atualizada a função handleGetSuggestMovie para incluir tratamento de erros com notificação de toast.

Possibly related issues

  • feature/add-snackbars #61: A adição de snackbars está diretamente relacionada ao objetivo de implementar mensagens de notificação na aplicação.

Poem

🐇 No mundo dos filmes, um novo som,
Toasts de alegria, não há como não,
Erros agora são tratados com cuidado,
Com mensagens doces, nunca mais frustrado!
Com snackbarMessage, tudo em harmonia,
A mágica do cinema, em cada sinfonia! 🎬✨


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@werlleyg werlleyg linked an issue Nov 4, 2024 that may be closed by this pull request
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (6)
src/domain/enums/snackbar.enum.ts (2)

1-3: Considere um nome mais específico para o enum

O nome atual snackbarMessage é muito genérico. Como este enum está sendo usado especificamente para mensagens de erro, sugiro renomear para algo mais específico como SnackbarErrorMessages ou ToastErrorMessages.

Sugestão de refatoração:

-export enum snackbarMessage {
+export enum SnackbarErrorMessages {
   SUGGEST_MOVIE_ERROR = "Ocorreu um erro na consulta. Tente novamente.",
 }

1-3: Considere estruturar o enum para diferentes tipos de mensagens

Para melhor organização e escalabilidade, sugiro estruturar o enum para acomodar diferentes tipos de mensagens (erro, sucesso, aviso, etc.).

Exemplo de estruturação:

export enum SnackbarMessages {
  // Mensagens de Erro
  ERROR_SUGGEST_MOVIE = "Ocorreu um erro na consulta. Tente novamente.",
  
  // Mensagens de Sucesso
  SUCCESS_SUGGEST_MOVIE = "Sugestão de filme obtida com sucesso!",
  
  // Mensagens de Aviso
  WARNING_SUGGEST_MOVIE = "Atenção: Esta funcionalidade está em fase beta.",
}
src/pages/_app.tsx (2)

7-12: Considere personalizar as configurações do ToastContainer

A implementação está correta, porém seria interessante configurar as propriedades do ToastContainer para melhor adequação ao design do projeto.

Sugestão de implementação com configurações personalizadas:

-      <ToastContainer />
+      <ToastContainer
+        position="top-right"
+        autoClose={3000}
+        hideProgressBar={false}
+        closeOnClick
+        pauseOnHover
+        draggable
+        theme="light"
+      />

7-12: Boa escolha arquitetural!

A implementação do ToastContainer no componente App garante que as notificações estarão disponíveis globalmente na aplicação, seguindo as melhores práticas do React para elementos de UI globais.

package.json (1)

26-27: Aprovado com sugestão de melhoria na gestão de versões!

As alterações estão corretas e alinhadas com o objetivo de adicionar snackbars usando react-toastify. No entanto, para garantir maior consistência e previsibilidade nas builds, considere fixar as versões exatas das dependências removendo o caractere ^. Isso evita atualizações automáticas que podem introduzir incompatibilidades.

-    "react-dom": "^18",
-    "react-toastify": "^10.0.6"
+    "react-dom": "18.2.0",
+    "react-toastify": "10.0.6"
src/pages/index.tsx (1)

72-80: Sugestões de melhorias no tratamento de erros

O tratamento de erros pode ser aprimorado das seguintes formas:

  1. Tipagem do erro no bloco catch
  2. Mensagens de erro mais específicas baseadas no tipo do erro
  3. Prevenção de múltiplos cliques durante o carregamento

Considere aplicar estas melhorias:

 try {
   const result = await makeGetMovieSuggestionUsecase().exec(listMovies);
   setSuggestedMovie(new MovieEntity(result));
-} catch (e) {
+} catch (error: unknown) {
+  if (error instanceof Error) {
+    toast.error(error.message || snackbarMessage.SUGGEST_MOVIE_ERROR);
+  } else {
   toast.error(snackbarMessage.SUGGEST_MOVIE_ERROR);
+  }
 } finally {
   setLoading(false);
 }

Além disso, para prevenir múltiplos cliques durante o carregamento, você pode desabilitar o botão:

 <Button
   icon={<Puzzle />}
   onClick={handleGetSuggestMovie}
   fullWidth
-  disabled={selectedMovies.length === 0}
+  disabled={selectedMovies.length === 0 || loading}
 >
📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between fd766e5 and 4bff4e5.

📒 Files selected for processing (4)
  • package.json (1 hunks)
  • src/domain/enums/snackbar.enum.ts (1 hunks)
  • src/pages/_app.tsx (1 hunks)
  • src/pages/index.tsx (2 hunks)
🔇 Additional comments (3)
src/pages/_app.tsx (2)

2-2: Importação do CSS do react-toastify está correta!

A importação do arquivo CSS está posicionada adequadamente junto com outros imports de estilo.


4-4: Importação do componente ToastContainer está correta!

A importação do componente está bem estruturada e segue o padrão de importações do projeto.

src/pages/index.tsx (1)

26-27: Importações adequadas para o sistema de notificações!

As importações necessárias para o sistema de notificações foram adicionadas corretamente.

@werlleyg werlleyg merged commit ba8d729 into develop Nov 4, 2024
1 check passed
@werlleyg werlleyg deleted the feature/add-snackbars branch November 4, 2024 23:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

feature/add-snackbars
1 participant