Plots2: ANCIEN FERMÉ Problème de révision de l'éditeur de commentaires

Créé le 9 oct. 2020  ·  14Commentaires  ·  Source: publiclab/plots2

PROBLÈME DE PLANIFICATION DÉPLACÉ ICI -> #9069

J'ai décidé de déplacer mon problème de planification vers une nouvelle page de problème, principalement pour des problèmes de lisibilité. Désolé pour toute confusion que cela cause! - @noi5e

outreachy planning

Commentaire le plus utile

@jywarren Merci beaucoup pour cet article très utile et détaillé !!! Cela m'a vraiment aidé à comprendre beaucoup de choses sur la base de code. Encore beaucoup à apprendre. J'ai fait une tentative de PR pour un test - avec beaucoup de questions.

Tous les 14 commentaires

Pour les étapes ultérieures du projet d'éditeur de commentaires, lorsqu'il pourrait être déployé dans son propre référentiel, nous souhaiterons peut-être examiner attentivement ce flux de travail documenté par Sagarpreet pour savoir ce qui aiderait à créer un cycle de publication standard !

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

Notant cet exemple de boîtes de commentaires câblées lors du téléchargement d'une image vers un commentaire en cours de modification (pas nouvellement écrit) : https://github.com/publiclab/plots2/issues/8670

PROBLÈME DE PLANIFICATION DÉPLACÉ ICI -> #9069

J'ai décidé de déplacer mon problème de planification vers une nouvelle page de problème, principalement pour des problèmes de lisibilité. Désolé pour toute confusion que cela cause! - @noi5e

Salut @noi5e , le problème de planification a l'air génial.
Sur quel problème travaillez-vous actuellement ? Pouvez-vous m'indiquer le PR le cas échéant, faites-moi également savoir si vous êtes coincé quelque part ou si vous avez besoin de clarté. Merci

@sagarpreet-chadha Merci de m'avoir contacté ! Depuis que j'ai posté ceci, j'ai écrit mon article de blog pour Outreachy (en petits morceaux, presque terminé), j'ai fait des recherches et travaillé sur un PR pour 8618 et je me suis perfectionné sur Rails - dans lequel je n'ai pas une solide expérience, mais j'ai été beaucoup appris cette semaine. J'ai travaillé 2 jours à mon autre emploi, donc je me sens un peu en retard, mais j'ai fait beaucoup de rattrapage aujourd'hui et je ferai plus demain et lundi. Je prévois d'écrire des tests pour les commentaires demain.

J'ai besoin d'une petite précision sur les commentaires de test. J'ai jeté un œil à /plots2/blob/main/test/system/comment_test.rb et il semble qu'il existe déjà des tests pour saisir des commentaires à la fois manuellement et via l'URL de l'API, les deux pointant vers /wiki/wiki-page-path/comments .

Si je dois écrire de nouveaux tests de commentaires pour les pages de questions et de notes, est-ce que ce sera pour une URL API différente ou la même que ci-dessus ( wiki-page-path ) ? J'ai couru rails routes mais ce n'est pas évident pour moi lesquels je suis censé tester. Merci d'avance, cela vous fera gagner du temps à chercher dans le code. ??

EDIT : Faites-moi également savoir si vous avez des demandes spécifiques pour des types de tests à rédiger !

Salut @noi5e, je pense que la route des "commentaires wiki" est distincte de celle des "notes" - les wikis et les notes sont des variantes de Node - mais devraient être assez similaires.

Cela fait un moment que je n'ai pas regardé cette zone de code, mais généralement Rails aura une action de contrôleur pour chaque route, mais l'exception est quand ce sont des routes ingénieuses : https://guides.rubyonrails.org/routing.html#resource -routing-the-rails-default

Voir cette action sert à voir les commentaires :

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

il semble qu'il n'y ait pas d'action de contrôleur pour la publication. Mais je vois que cette route:

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

indique cette action de vue. Alors où sont les parcours de création et les actions ? J'en vois ici, pas spécifiques au wiki cependant :

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

Voyons donc l'autre extrémité des choses, les modèles. Voici le formulaire de commentaire de base :

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

Je pense que les commentaires sur les questions peuvent réutiliser ce formulaire, en fonction de la logique de la balise <form> ici ?

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

Ainsi, ils pointent vers /comments/create/NID avec une méthode POST, donc le tout dernier itinéraire de la ligne 373 de routes.rb. Ceux-ci pointent vers l'action create du contrôleur de commentaire :

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

Je pense donc qu'il est prudent de dire que la plupart des commentaires utilisent l'action create du contrôleur de commentaire. Mais qu'en est-il de ces tests système où cette route n'est pas mentionnée ?

L'autre façon de procéder est ici via une méthode JavaScript :

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

Cela nous amène à ce fichier JS, qui le soumet à la même route via AJAX :

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

La façon dont notre base de code ressemble maintenant, la fonction sendFormSubmissionAjax() peut sembler ne pas avoir à être dans son propre fichier, mais je pense que @nstjean (un fantastique alun Outreachy, salut !!!!!! 🎉 ) prévu de rationaliser la soumission de formulaires JS dans notre base de code, que je soutiens pleinement. C'est ici!

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

J'espère que cela vous sera utile ! Ce n'est pas le pire que j'ai vu en termes d'organisation du code, mais c'est définitivement compliqué. C'est en partie juste parce qu'il s'agit d'une grande et ancienne base de code qui a connu de nombreuses phases de révision différentes. En fait, avant les tests système, qui n'ont été installés qu'au cours des 2 dernières années environ, nous n'avions aucun moyen de faire des tests complets de la soumission de commentaires JavaScript ! Donc, il cassait constamment :-(

Merci les gens!!!

@jywarren Merci beaucoup pour cet article très utile et détaillé !!! Cela m'a vraiment aidé à comprendre beaucoup de choses sur la base de code. Encore beaucoup à apprendre. J'ai fait une tentative de PR pour un test - avec beaucoup de questions.

Je cherche également à clarifier ceux-ci:

"Enregistrer et récupérer les icônes Fonctionnalité clé provoquant la solution de contournement de Mimi" (ne comprends pas)

Je n'ai pas pu trouver cela sur https://pad.publiclab.org/p/outreachy - d'où cela vient-il ? Cela semble vaguement familier... désolé !

L'aperçu ne fonctionne pas parfois (je ne peux pas reproduire)

C'est peut-être un bon candidat pour le genre de "suite standard de tests" que nous pourrions exécuter automatiquement sur plusieurs variantes de l'éditeur de commentaires, lorsque nous réorganisons le code de test ? Je me demande si cela l'attraperait, ou peut-être que c'est juste déjà résolu.

Les boutons en gras et en italique sont "croisés" (ne peuvent pas être reproduits)

Cela semble être dans https://github.com/publiclab/plots2/issues/8478 et je me demande si la même stratégie pourrait aider, en l'incluant dans une suite standard de tests d'éditeur de commentaires et en s'exécutant sur toutes les variantes.

Assurez-vous que le "glisser-déposer pour insérer des images" gris est partout (impossible de reproduire, j'aimerais quelques exemples)

Comme ci-dessus peut-être... et je ne l'ai pas trouvé non plus dans https://pad.publiclab.org/p/outreachy donc je peux peut-être en ajouter plus, sachant d'où il vient ?

Problèmes d'appréciation des commentaires (voir « Les commentaires que j'aime ne fonctionnent pas #5113 »). Je comprends le problème, fondamentalement, je dois clarifier quel est le comportement attendu ici.

C'est peut-être vraiment vieux ?? Nous n'avons plus de likes de commentaires, car il a été remplacé par le système de "réactions". Mais, peut-être que nous clarifions en demandant à Sasha, qui a fait #5113

Merci @noi5e ! J'espère que ces aide !!!!

Merci @jywarren vraiment utile... Je pense que les points que vous recherchiez se trouvent dans ce document Google

Salut @noi5e, je ne sais pas si vous avez déjà vu ou corrigé cela, mais j'ai remarqué cela dans nos commentaires - il semble y avoir une barre grise inutile sous le formulaire :

image

De plus, je pense qu'une partie de l'espacement autour des emojis est un peu décalée. Voyez-vous comment il semble qu'il y ait un rembourrage blanc en haut et en bas, surtout par rapport au style de GitHub ?

image

Juste quelques petites choses que nous pourrions peut-être aborder dans un prochain PR, mais rien d'urgent. Merci!

@jywarren Certainement, je les ai remarqués aussi! Ajout à mes tâches.

Je me demandais aussi après les optimisations de vitesse de https://github.com/publiclab/plots2/pull/9045 , je me souviens que Skylight montre que publier un commentaire sur PublicLab.org peut prendre un certain temps... et je pensais nous avions quelque peu optimisé mais pas autant que nous l'avions espéré. Trouvez-vous toujours que le temps de chargement est lent pour publier un commentaire ? Je me demande si c'est aussi un moyen d'améliorer l'exécution des tests du système, tout en améliorant également l'expérience utilisateur.

Voici un instantané ; cela prend apparemment encore jusqu'à 10 secondes de temps en temps, mais malheureusement notre surveillance n'est pas assez bonne pour montrer plus que ce temps est passé dans le contrôleur, il semble :

image

Ce n'est pas non plus une exigence de votre projet, mais j'ai pensé que cela pourrait être intéressant. Le code qui pilote ceci est ici et ici .

Pour être honnête, ne vous inquiétez pas vraiment... mais je suis curieux de savoir si vous avez pensé que le temps de publication des commentaires était assez lent ou non ?

@jywarren Oui ! Je pense vraiment que le temps de poster des commentaires est très lent! (aussi, le temps de réagir à un commentaire)

Intéressant d'en savoir plus sur Skylight et ce qu'il fait. Je me demande ce qui cause exactement le ralentissement, pensez-vous que cela pourrait être la requête ActiveRecord ?

EDIT : ajoutez-le à la liste de souhaits des objectifs ambitieux dans ce numéro de planification !

PROBLÈME DE PLANIFICATION DÉPLACÉ ICI -> #9069

J'ai décidé de déplacer mon problème de planification vers une nouvelle page de problème, principalement pour des problèmes de lisibilité. Désolé pour toute confusion que cela cause! - @noi5e

Cette page vous a été utile?
0 / 5 - 0 notes