Plots2: ANTIGO FECHADO Problema de revisão do editor de comentários

Criado em 9 out. 2020  ·  14Comentários  ·  Fonte: publiclab/plots2

PROBLEMA DE PLANEJAMENTO MOVIDO AQUI -> # 9069

Decidi mover minha edição de planejamento para uma página de edição nova, principalmente por questões de legibilidade. Desculpe por qualquer confusão que isso possa causar! - @ noi5e

outreachy planning

Comentários muito úteis

@jywarren Muito obrigado por esse artigo tão útil e detalhado !!! Realmente me ajudou a descobrir muitas coisas sobre a base de código. Ainda há muito a aprender. Fiz uma tentativa de relações públicas para um teste - com muitas perguntas.

Todos 14 comentários

Para os estágios posteriores do projeto Editor de comentários, quando ele pode ser dividido em seu próprio repositório, podemos considerar cuidadosamente este fluxo de trabalho documentado por Sagarpreet para o que ajudaria a criar um ciclo de lançamento padrão!

https://publiclab.org/notes/sagarpreet_chadha/10-20-2020/first-timer-only-release-workflow

Observando este exemplo de caixas de comentário cruzadas durante o upload da imagem para um comentário que está sendo editado (não escrito recentemente): https://github.com/publiclab/plots2/issues/8670

PROBLEMA DE PLANEJAMENTO MOVIDO AQUI -> # 9069

Decidi mover minha edição de planejamento para uma página de edição nova, principalmente por questões de legibilidade. Desculpe por qualquer confusão que isso possa causar! - @ noi5e

Olá @ noi5e , o problema de planejamento parece ótimo.
Em qual problema você está trabalhando atualmente? Você pode me indicar o PR, se houver, também me avise se você estiver preso em algum lugar ou se tiver alguma clareza. Obrigado 😄

@ sagarpreet-chadha Obrigado por me acompanhar! Desde a postagem disso, tenho escrito minha postagem do blog para o Outreachy (em pedaços, quase pronto), pesquisando e trabalhando em um PR para 8618 e aprimorando o Rails - no qual eu não tenho um grande conhecimento, mas tenho aprendendo muito esta semana. Trabalhei 2 dias em meu outro emprego, então estou me sentindo um pouco atrasado, mas me recuperei muito hoje e farei mais amanhã e segunda-feira. Planejo escrever testes para comentários amanhã.

Preciso de um pequeno esclarecimento sobre os comentários de teste. Dei uma olhada em /plots2/blob/main/test/system/comment_test.rb e parece que já existem testes para inserir comentários tanto manualmente quanto via URL da API, ambos apontando para /wiki/wiki-page-path/comments .

Se vou escrever novos testes de comentários para páginas de perguntas e notas, será para um URL de API diferente ou igual ao acima ( wiki-page-path )? Executei rails routes mas não é óbvio para mim quais devo testar. Agradecemos antecipadamente, isso vai economizar algum tempo procurando pelo código. 😅

EDITAR: Informe-me também se tiver solicitações específicas de tipos de testes para eu escrever!

Olá @ noi5e, acredito que a rota dos "comentários wiki" seja diferente da das "notas" - ambos os wikis e as notas são variantes do Node - mas devem ser bastante semelhantes.

Já faz um tempo que olhei para esta área do código, mas normalmente Rails terá uma ação de controlador para cada rota, mas a exceção é quando elas são rotas com recursos: https://guides.rubyonrails.org/routing.html#resource -routing-the-rails-default

Ver esta ação é para ver os comentários:

https://github.com/publiclab/plots2/blob/cbb807ba8e2302f09dafc0060475aa118e34c2c6/app/controllers/wiki_controller.rb#L467 -L470

parece que não há uma ação do controlador para postar. Mas eu vejo que esta rota:

https://github.com/publiclab/plots2/blob/cbb807ba8e2302f09dafc0060475aa118e34c2c6/config/routes.rb#L58

aponta para essa ação de exibição. Então, onde estão as rotas e ações de criação? Vejo alguns aqui, mas não específicos do wiki:

https://github.com/publiclab/plots2/blob/cbb807ba8e2302f09dafc0060475aa118e34c2c6/config/routes.rb#L368 -L373

Então, vamos olhar para o outro lado das coisas, os modelos. Aqui está o formulário básico de comentário:

https://github.com/publiclab/plots2/blob/main/app/views/comments/_form.html.erb

Acho que os comentários das perguntas podem reutilizar este formulário, com base na lógica da tag <form> aqui?

https://github.com/publiclab/plots2/blob/cbb807ba8e2302f09dafc0060475aa118e34c2c6/app/views/comments/_form.html.erb#L3

Então, eles apontam para /comments/create/NID com um método POST, então a última rota da linha 373 de routes.rb. Esses apontam para a ação do controlador de comentários create :

https://github.com/publiclab/plots2/blob/cbb807ba8e2302f09dafc0060475aa118e34c2c6/app/controllers/comment_controller.rb#L19 -L56

Portanto, acho que é seguro dizer que a maioria dos comentários está usando o controlador de comentários create action. Mas e aqueles testes de sistema em que essa rota não é mencionada?

A outra forma de acontecer é por meio de um método JavaScript:

https://github.com/publiclab/plots2/blob/cbb807ba8e2302f09dafc0060475aa118e34c2c6/test/system/comment_test.rb#L32

Isso nos leva a este arquivo JS, que o envia para a mesma rota via AJAX:

https://github.com/publiclab/plots2/blob/484bf69ead7a1f69c9047a25b3f63b9d6f875728/app/assets/javascripts/comment.js#L62 -L70

Do jeito que nossa base de código está agora, a função sendFormSubmissionAjax() pode parecer que não precisava estar em seu próprio arquivo, mas acho que @nstjean (um fantástico aluno do Outreachy, oi !!!!!! 🎉) planejado para agilizar o envio de formulários JS em nossa base de código, que eu apoio totalmente. Aqui está!

https://github.com/publiclab/plots2/blob/876d0fc084064aaecc23f8003630d7d1ab858fa1/app/assets/javascripts/submit_form_ajax.js#L1 -L4

Espero que isso seja útil! Não é o pior que já vi em termos de organização de código, mas é definitivamente complicado. Em parte, isso se deve ao fato de ser uma grande e antiga base de código que passou por muitas fases diferentes de revisão. Na verdade, antes dos testes de sistema, que só foram instalados nos últimos 2 anos ou mais, não tínhamos como fazer o teste completo do envio de comentários de JavaScript! Portanto, estava constantemente quebrando :-(

Obrigado pessoal !!!

@jywarren Muito obrigado por esse artigo tão útil e detalhado !!! Realmente me ajudou a descobrir muitas coisas sobre a base de código. Ainda há muito a aprender. Fiz uma tentativa de relações públicas para um teste - com muitas perguntas.

Também procuramos esclarecer estes:

"Salvar e recuperar ícones Recurso principal que faz com que o Mimi tenha uma solução alternativa" (não entendo)

Não consegui encontrar isso em https://pad.publiclab.org/p/outreachy - de onde veio? Parece vagamente familiar ... desculpe!

A pré-visualização às vezes não funciona (não consigo reproduzir)

Talvez este seja um bom candidato para o tipo de "conjunto padrão de testes" que poderíamos executar automaticamente em várias variantes do editor de comentários, quando reorganizamos o código de teste? Eu me pergunto se isso pegaria ou talvez já esteja resolvido.

Os botões em negrito e itálico são "cross-wired" (não podem ser reproduzidos)

Isso parece estar em https://github.com/publiclab/plots2/issues/8478 e me pergunto se a mesma estratégia poderia ajudar, incluindo isso em um conjunto padrão de testes do editor de comentários e executando em todas as variantes.

Certifique-se de que o "arraste e solte para inserir imagens" cinza esteja em todos os lugares (não é possível reproduzir, gostaria de alguns exemplos)

O mesmo que acima, talvez ... e eu também não consegui encontrar em https://pad.publiclab.org/p/outreachy, então talvez eu possa adicionar mais, sabendo de onde veio?

Problemas ao gostar de comentários (consulte "Gostar de comentários não funciona # 5113"). Eu entendo o problema, basicamente preciso esclarecer qual é o comportamento esperado aqui.

Isso pode ser muito antigo ?? Não temos mais curtidas de comentários, pois foi substituído pelo sistema de "reações". Mas, talvez possamos esclarecer perguntando a Sasha, que fez # 5113

Obrigado, @ noi5e ! Espero que ajudem !!!!

Obrigado @jywarren definitivamente útil ... Acho que os pontos que você estava procurando estão neste documento do Google

Olá @ noi5e, não tenho certeza se você viu ou já corrigiu isso, mas percebi isso em nossos comentários - parece haver uma barra cinza desnecessária sob o formulário:

image

Além disso, acho que um pouco do espaçamento em torno dos emojis está um pouco errado. Viu como parece que tem um preenchimento branco na parte superior e inferior, especialmente quando comparado ao estilo do GitHub?

image

Apenas algumas pequenas coisas que talvez pudéssemos abordar em um próximo PR, mas nada urgente. Obrigado!

@jywarren Com certeza, eu também notei isso! Adicionando às minhas tarefas.

Eu também estava pensando, depois das otimizações de velocidade de https://github.com/publiclab/plots2/pull/9045 , lembro que o Skylight mostra que postar um comentário no PublicLab.org pode demorar um pouco ... e pensei otimizamos um pouco, mas não tanto quanto esperávamos. Você ainda acha que é um tempo de carregamento lento para postar um comentário? Eu me pergunto se essa também é uma maneira de melhorar o tempo de execução de teste do sistema, melhorando também a experiência do usuário.

Aqui está um instantâneo; aparentemente ainda leva até 10 segundos ocasionalmente, mas infelizmente nosso monitoramento não é bom o suficiente para mostrar mais do que esse tempo gasto no controlador, parece:

image

Isso também não é um requisito do seu projeto, mas achei que poderia ser interessante. O código que direciona isso está aqui e aqui .

Para ser honesto, não se preocupe muito com isso ... mas estou curioso para saber se você achou que o tempo de postagem do comentário estava lento ou não?

@jywarren Sim! Eu definitivamente acho que o tempo para postar comentários é muito lento! (também, hora de reagir a um comentário)

Interessante aprender sobre o Skylight e o que ele faz. Eu me pergunto o que exatamente está causando a desaceleração, você acha que pode ser a consulta ActiveRecord?

EDITAR: adicioná-lo à lista de desejos de metas extensas nesta edição de planejamento!

PROBLEMA DE PLANEJAMENTO MOVIDO AQUI -> # 9069

Decidi mover minha edição de planejamento para uma página de edição nova, principalmente por questões de legibilidade. Desculpe por qualquer confusão que isso possa causar! - @ noi5e

Esta página foi útil?
0 / 5 - 0 avaliações

Questões relacionadas

RuthNjeri picture RuthNjeri  ·  3Comentários

first-timers[bot] picture first-timers[bot]  ·  3Comentários

grvsachdeva picture grvsachdeva  ·  3Comentários

bronwen9 picture bronwen9  ·  3Comentários

first-timers[bot] picture first-timers[bot]  ·  3Comentários