Plots2: ANTIGUO problema de revisión del editor de comentarios CERRADO

Creado en 9 oct. 2020  ·  14Comentarios  ·  Fuente: publiclab/plots2

ASUNTO DE PLANIFICACIÓN MUDANZADO AQUÍ -> # 9069

Decidí trasladar mi problema de planificación a una página nueva, principalmente por problemas de legibilidad. ¡Perdón por cualquier confusión que esto cause! - @ noi5e

outreachy planning

Comentario más útil

@jywarren ¡¡¡ Muchas gracias por ese informe tan útil y detallado !!! Realmente me ayudó a descubrir muchas cosas sobre el código base. Aún queda mucho por aprender. Hice un PR tentativo para una prueba, con muchas preguntas.

Todos 14 comentarios

Para las etapas posteriores del proyecto del Editor de comentarios, cuando se podría convertir en su propio repositorio, es posible que deseemos considerar cuidadosamente este flujo de trabajo documentado por Sagarpreet para lo que ayudaría a crear un ciclo de lanzamiento estándar.

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

Observando este ejemplo de cuadros de comentarios con cables cruzados durante la carga de una imagen en un comentario que se está editando (no escrito recientemente): https://github.com/publiclab/plots2/issues/8670

ASUNTO DE PLANIFICACIÓN MUDANZADO AQUÍ -> # 9069

Decidí trasladar mi problema de planificación a una página nueva, principalmente por problemas de legibilidad. ¡Perdón por cualquier confusión que esto cause! - @ noi5e

Hola @ noi5e , el problema de la planificación se ve muy bien.
¿En qué problema estás trabajando actualmente? ¿Puede indicarme el PR, si lo hay, también avíseme si está atrapado en algún lugar o si necesita algo de claridad? Gracias 😄

@ sagarpreet-chadha ¡Gracias por registrarse conmigo! Desde que publiqué esto, he estado escribiendo mi entrada de blog para Outreachy (en pedazos, casi terminado), investigando y trabajando en un PR para 8618, y repasando Rails, en el que no tengo una sólida formación, pero he estado aprendiendo mucho esta semana. Trabajé 2 días en mi otro trabajo, así que me siento un poco atrasado, pero hoy me puse al día y haré más mañana y el lunes. Planeo escribir pruebas para comentarios mañana.

Necesito una pequeña aclaración sobre los comentarios de prueba. Eché un vistazo a /plots2/blob/main/test/system/comment_test.rb y parece que ya hay pruebas para ingresar comentarios tanto manualmente como a través de la URL de la API, ambas apuntando hacia /wiki/wiki-page-path/comments .

Si voy a escribir nuevas pruebas de comentarios para las páginas de preguntas y notas, ¿será para una URL de API diferente o la misma que la anterior ( wiki-page-path )? Ejecuté rails routes pero no me resulta obvio cuáles se supone que debo probar. Gracias de antemano, esto le ahorrará algo de tiempo buscando en el código. 😅

EDITAR: ¡También avíseme si tiene solicitudes específicas de tipos de pruebas para que las escriba!

Hola @ noi5e, creo que la ruta de los "comentarios de la wiki" es distinta de la de las "notas", tanto las wikis como las notas son variantes de Node, pero deberían ser bastante similares.

Ha pasado un tiempo desde que miré esta área de código, pero normalmente Rails tendrá una acción de controlador para cada ruta, pero la excepción es cuando son rutas ingeniosas: https://guides.rubyonrails.org/routing.html#resource -enrutamiento-de-los-rieles-predeterminado

Ver esta acción es para ver comentarios:

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

parece que no hay una acción de controlador para publicar. Pero veo que esta ruta:

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

apunta a esa acción de vista. Entonces, ¿dónde están las rutas y acciones de creación? Veo algunos aquí, aunque no específicos de wiki:

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

Así que veamos el otro extremo de las cosas, las plantillas. Aquí está el formulario de comentarios básico:

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

Creo que los comentarios de las preguntas pueden reutilizar este formulario, según la lógica de la etiqueta <form> aquí.

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

Entonces, apuntan a /comments/create/NID con un método POST, por lo que es la última ruta de la línea 373 de routes.rb. Aquellos apuntan al controlador de comentarios create acción:

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

Así que creo que es seguro decir que la mayoría de los comentarios usan el controlador de comentarios create action. Pero, ¿qué pasa con las pruebas del sistema en las que no se menciona esa ruta?

La otra forma en que está sucediendo es aquí a través de un método JavaScript:

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

Eso nos lleva a este archivo JS, que lo envía a la misma ruta a través de AJAX:

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

La forma en que se ve nuestro código base ahora, la función sendFormSubmissionAjax() puede parecer que no tiene que estar en su propio archivo, pero creo que @nstjean (un alumno de Outreachy fantástico, ¡¡¡¡¡hola !!!!!! 🎉) planeado para que agilice el envío de formularios JS a través de nuestro código base, que soy totalmente compatible. ¡Aquí está!

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

¡Espero que esto sea útil! No es lo peor que he visto en términos de organización de código, pero definitivamente es complicado. Esto se debe en parte a que se trata de una base de código grande y antigua que ha pasado por muchas fases de revisión diferentes. En realidad, antes de las pruebas del sistema, que solo se instalaron en los últimos 2 años, ¡no teníamos forma de realizar pruebas completas del envío de comentarios de JavaScript! Entonces se rompía constantemente :-(

¡¡¡Gracias amigos!!!

@jywarren ¡¡¡ Muchas gracias por ese informe tan útil y detallado !!! Realmente me ayudó a descubrir muchas cosas sobre el código base. Aún queda mucho por aprender. Hice un PR tentativo para una prueba, con muchas preguntas.

También buscando aclarar estos:

"Guardar y recuperar íconos Característica clave que hace que Mimi solucione el problema" (no entienda esto)

En realidad, no pude encontrar esto en https://pad.publiclab.org/p/outreachy , ¿de dónde vino? Suena vagamente familiar ... ¡lo siento!

La vista previa no funciona a veces (no puedo reproducir)

¿Quizás este sea un buen candidato para el tipo de "conjunto estándar de pruebas" que podríamos ejecutar automáticamente en múltiples variantes del editor de comentarios, cuando reorganizamos el código de prueba? Me pregunto si eso lo detectaría, o tal vez ya esté resuelto.

Los botones en negrita y cursiva están "entrelazados" (no se pueden reproducir)

Esto parece estar en https://github.com/publiclab/plots2/issues/8478 y me pregunto si la misma estrategia podría ayudar, de incluir esto en un conjunto estándar de pruebas de editor de comentarios y ejecutarlo en todas las variantes.

Asegúrese de que el "arrastrar y soltar para insertar imágenes" gris esté en todas partes (no se puede reproducir, me gustaría algunos ejemplos)

Igual que el anterior, tal vez ... y tampoco pude encontrarlo en https://pad.publiclab.org/p/outreachy, así que tal vez pueda agregar más, ¿sabiendo de dónde vino?

Problemas con dar me gusta a los comentarios (consulte "Los me gusta de comentarios no funcionan # 5113"). Entiendo el problema, básicamente necesito aclarar cuál es el comportamiento esperado aquí.

¿Esto podría ser realmente viejo? Ya no tenemos me gusta en los comentarios, ya que fue reemplazado por el sistema de "reacciones". Pero, tal vez aclaremos preguntándole a Sasha, quien hizo el # 5113

¡Gracias, @ noi5e ! ¡Espero que estos ayuden!

Gracias @jywarren definitivamente útil ... Creo que los puntos que buscaba están en este documento de Google

Hola @ noi5e, no estoy seguro de si vio esto o ya lo solucionó, pero lo noté en nuestros comentarios; parece que hay una barra gris innecesaria debajo del formulario:

image

Además, creo que algunos de los espacios alrededor de los emojis están un poco fuera de lugar. ¿Ves cómo parece que tiene un relleno blanco en la parte superior e inferior, especialmente en comparación con el estilo de GitHub?

image

Solo un par de cosas pequeñas que quizás podamos abordar en un próximo RP, pero nada urgente. ¡Gracias!

@jywarren ¡ Definitivamente, yo también los he notado! Añadiendo a mis tareas pendientes.

También me preguntaba después de las optimizaciones de velocidad de https://github.com/publiclab/plots2/pull/9045 , recuerdo que Skylight muestra que publicar un comentario en PublicLab.org puede llevar bastante tiempo ... y pensé habíamos optimizado un poco, pero no tanto como esperábamos. ¿Sigues considerando que es un tiempo de carga lento para publicar un comentario? Me pregunto si esa también es una forma de mejorar el tiempo de ejecución de las pruebas del sistema, al tiempo que mejora la experiencia del usuario.

Aquí hay una instantánea; Aparentemente, todavía toma hasta 10 segundos ocasionalmente, pero desafortunadamente nuestro monitoreo no es lo suficientemente bueno como para mostrar más de lo que este tiempo se pasa en el controlador, parece:

image

Esto tampoco es un requisito de su proyecto, pero pensé que podría ser interesante. El código que impulsa esto está aquí y aquí .

Realmente no te preocupes por esto para ser honesto ... pero tengo curiosidad si sentiste que el tiempo de publicación de comentarios fue bastante lento o no.

@jywarren ¡Sí! ¡Definitivamente creo que el tiempo para publicar comentarios es muy lento! (también, es hora de reaccionar a un comentario)

Interesante aprender sobre Skylight y lo que hace. Me pregunto qué está causando exactamente la desaceleración, ¿cree que podría ser la consulta de ActiveRecord?

EDITAR: ¡ agregarlo a la lista de deseos de objetivos ambiciosos en este número de planificación!

ASUNTO DE PLANIFICACIÓN MUDANZADO AQUÍ -> # 9069

Decidí trasladar mi problema de planificación a una página nueva, principalmente por problemas de legibilidad. ¡Perdón por cualquier confusión que esto cause! - @ noi5e

¿Fue útil esta página
0 / 5 - 0 calificaciones