Plots2: OLDCLOSEDコメントエディターのオーバーホールの問題

作成日 2020年10月09日  ·  14コメント  ·  ソース: publiclab/plots2

計画の問題をここに移動->#9069

主に読みやすさの問題のために、計画の問題を新しい問題のページに移動することにしました。 これが原因で混乱が生じてすみません! -@ noi5e

outreachy planning

最も参考になるコメント

@jywarren非常に有益で詳細な

全てのコメント14件

コメントエディタプロジェクトの後半の段階で、独自のリポジトリにスピンアウトされる可能性がある場合は、標準のリリースサイクルの作成に役立つものについて、Sagarpreetによって文書化されたこのワークフローを慎重に検討することをお勧めします。

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

編集中のコメント(新しく書き込まれていない)への画像のアップロード中のクロスワイヤードコメントボックスのこの例に注意してください//github.com/publiclab/plots2/issues/8670

計画の問題をここに移動->#9069

主に読みやすさの問題のために、計画の問題を新しい問題のページに移動することにしました。 これが原因で混乱が生じてすみません! -@ noi5e

こんにちは@ noi5e 、計画の問題は素晴らしく見えます。
現在取り組んでいる問題はどれですか? PRがある場合は、それを教えていただけますか。また、どこかで行き詰まっている場合や、明確さを気にしている場合はお知らせください。 ありがとう😄

@ sagarpreet-chadhaチェックインしていただきありがとうございます! これを投稿してから、Outreachyのブログ投稿を(少しずつ、ほぼ完了しました)書いたり、8618のPRを調査して作業したり、Railsをブラッシュアップしたりしています。今週はたくさんのことを学びました。 私の他の仕事で2日間働いたので、少し遅れを感じていますが、今日は多くのキャッチアップを行い、明日と月曜日にもっとや​​ります。 明日はコメントのテストを書く予定です。

コメントのテストについて少し説明が必要です。 /plots2/blob/main/test/system/comment_test.rbを調べたところ、手動​​とAPI URLの両方でコメントを入力するためのテストがすでにあり、どちらも/wiki/wiki-page-path/comments指しているようです。

質問ページとメモページに新しいコメントテストを作成する場合、それは別のAPI URL用ですか、それとも上記と同じですか( wiki-page-path )? rails routesが、どれをテストするのかわかりません。 事前のおかげで、これによりコードを探す時間を節約できます。 😅

編集:また、私が書くためのテストの種類について特定の要求がある場合は私に知らせてください!

こんにちは@ noi5e 「wikiコメント」ルートは「ノート」ルートとは異なると

このコード領域を見てからしばらく経ちましたが、通常、Railsにはルートごとにコントローラーアクションがありますが、例外は、それらがリソースのあるルートである場合です: https

このアクションを表示するのは、コメントを表示するためです。

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

投稿するためのコントローラーアクションがないようです。 しかし、私はこのルートがわかります:

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

そのビューアクションをポイントします。 では、作成ルートとアクションはどこにありますか? 私はここにいくつか見ますが、ウィキ固有ではありません:

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

それでは、もう一方の端であるテンプレートを見てみましょう。 基本的なコメントフォームは次のとおりです。

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

ここの<form>タグのロジックに基づいて、質問コメントがこのフォームを再利用する可能性があると思いますか?

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

つまり、POSTメソッドで/comments/create/NIDを指しているので、routes.rbの373行目からの最後のルートです。 コメントコントローラーのcreateアクションを指します。

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

したがって、ほとんどのコメントはコメントコントローラーのcreateアクションを使用していると言っても差し支えないと思います。 しかし、そのルートが言及されていないシステムテストはどうですか?

それが起こっている他の方法はここにありますJavaScriptメソッドを介して:

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

これにより、このJSファイルがAJAX経由で同じルートに送信されます。

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

コードベースの現在の外観では、 sendFormSubmissionAjax()関数は、独自のファイルにある必要はないように見えるかもしれませんが、 @ nstjean (素晴らしいOutreachyのミョウバン、こんにちは!!!!!!🎉)だと思います。私が完全にサポートしているコードベース全体でJSフォームの送信を合理化することを計画しました。 ここにあります!

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

これがお役に立てば幸いです。 これは、コード編成に関して私が見た中で最悪ではありませんが、間違いなく複雑です。 これは、これが大きくて古いコードベースであり、さまざまな改訂フェーズが行われているためです。 実際、過去2年ほどでインストールされたシステムテストの前は、JavaScriptコメント送信のフルスタックテストを行う方法がありませんでした。 だからそれは絶えず壊れていました:-(

みんなありがとう!!!

@jywarren非常に有益で詳細な

また、これらを明確にするために探しています:

「アイコンの保存と回復Mimiに回避策をもたらす主な機能」(これを取得しないでください)

https://pad.publiclab.org/p/outreachyで実際にこれを見つけることができませんでした-どこから来たのですか? 漠然と聞き覚えがあります...ごめんなさい!

プレビューが動かないことがあります(再現できません)

これは、テストコードを再編成するときに、コメントエディタの複数のバリアントで自動的に実行できる「標準的なテストスイート」の候補として適しているのではないでしょうか。 それでうまくいくのか、それともすでに解決されているのだろうか。

太字と斜体のボタンは「クロスワイヤード」です(再現できません)

これはhttps://github.com/publiclab/plots2/issues/8478にあるようです。これをコメントエディタテストの標準スイートに含め、すべてのバリアントで実行するという同じ戦略が役立つかどうか疑問に思います。

灰色の「ドラッグアンドドロップで画像を挿入」がどこにでもあることを確認します(再現できない、いくつかの例が必要です)

上記と同じかもしれません...そして私もhttps://pad.publiclab.org/p/outreachyでそれを見つけることができなかったので、それがどこから来たのかを知って、もっと追加することができますか?

コメントのいいねに関する問題(「コメントのいいねが機能しない#5113」を参照)。 私は問題を理解しています。基本的に、ここで予想される動作が何であるかを明確にする必要があります。

これは本当に古いかもしれませんか? 「リアクション」システムに置き換えられたため、コメントのいいねはもうありません。 でも、#5113を作ったサーシャに聞いて明らかにするかもしれません

ありがとう、 @ noi5e ! これらの助けを願っています!!!!

ありがとう@jywarren間違いなく役に立ちました...あなたが探していたポイントはこのGoogleドキュメントにあると思います

こんにちは@ noi5eこれを見たか、すでに修正したかは

image

また、絵文字の周りの間隔の一部が少しずれていると思います。 GitHubのスタイルと比較すると、特に上下に白いパディングがあるように見えますか?

image

今後のPRで対処できる可能性のある小さなことがいくつかありますが、緊急なことは何もありません。 ありがとう!

@jywarren間違いなく、私もそれらに気づきました! 私のやることに追加します。

また、 https://github.com/publiclab/plots2/pull/9045の速度を最適化した後、Skylightが、PublicLab.orgに実際にコメントを投稿するのにかなりの時間がかかることを示していることを覚えています...そして私は思ったある程度最適化しましたが、期待したほどではありませんでした。 コメントを投稿するのにまだ読み込み時間が遅いと思いますか? それは、ユーザーエクスペリエンスも向上させながら、システムテストの実行時間を改善する方法でもあるのだろうか。

これがスナップショットです。 それでも時折最大10秒かかるようですが、残念ながら、この時間がコントローラーで費やされている以上のことを示すには、監視が十分ではないようです。

image

これもあなたのプロジェクトの要件ではありませんが、面白いかもしれないと思いました。 これを駆動するコードはここここにあり

正直なところ、心配は無用ですが、コメント投稿時間がかなり遅いと感じたら気になりますか?

@jywarrenはい! コメントを投稿する時間はとても遅いと思います! (また、コメントに反応する時間)

スカイライトとその機能について学ぶのは興味深いことです。 正確に何が速度低下を引き起こしているのだろうか、それはActiveRecordクエリである可能性があると思いますか?

編集:この計画問題のストレッチゴールウィッシュリストに追加してください!

計画の問題をここに移動->#9069

主に読みやすさの問題のために、計画の問題を新しい問題のページに移動することにしました。 これが原因で混乱が生じてすみません! -@ noi5e

このページは役に立ちましたか?
0 / 5 - 0 評価