Plots2: 旧关闭评论编辑器大修问题

创建于 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

注意这个在图像上传到正在编辑的评论(不是新写的)期间交叉连线评论框的例子: https :

将规划问题移至此处 -> #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

希望这是有帮助的! 在代码组织方面,这不是我见过的最糟糕的,但它绝对令人费解。 这部分是因为这是一个庞大而古老的代码库,它经历了许多不同的修订阶段。 实际上,在系统测试之前,只有近两年才安装,我们没有办法对JavaScript评论提交进行全栈测试! 所以它一直在打破:-(

谢谢各位!!!

@jywarren非常感谢

还希望澄清这些:

“保存和恢复图标导致咪咪变通的关键功能”(不要理解这个)

我实际上无法在https://pad.publiclab.org/p/outreachy 中找到它 - 它来自哪里? 听起来有点耳熟……抱歉!

预览有时不起作用(我无法重现)

当我们重新组织测试代码时,也许这是我们可以在注释编辑器的多个变体上自动运行的那种“标准测试套件”的一个很好的候选者? 我想知道这是否会抓住它,或者它只是已经解决了。

粗体和斜体按钮“交叉连接”(无法复制)

这似乎在https://github.com/publiclab/plots2/issues/8478 中,我想知道相同的策略是否有帮助,将其包含在标准的评论编辑器测试套件中并在所有变体中运行。

确保灰色的“拖放插入图像”无处不在(无法重现,想要一些示例)

也许和上面一样......而且我也无法在https://pad.publiclab.org/p/outreachy 中找到它,所以也许我可以添加更多,知道它来自哪里?

喜欢评论的问题(请参阅“评论喜欢不起作用 #5113”)。 我理解这个问题,基本上我需要澄清这里的预期行为是什么。

这可能真的很旧? 我们不再有评论喜欢了,因为它被“反应”系统所取代。 但是,也许我们可以通过询问制作 #5113 的 Sasha 来澄清

谢谢, @noi5e ! 希望这些有帮助!!!!

谢谢@jywarren绝对有帮助...我认为您要查找的要点在此 Google 文档中

@noi5e,我不确定你是否看到了这个或已经解决了这个问题,但我在我们的评论中注意到了这一点 - 表单下似乎有一个不必要的灰色条:

image

另外,我认为表情符号周围的一些间距有点小。 看看它看起来像顶部和底部有白色填充,尤其是与 GitHub 的风格相比?

image

也许我们可以在即将到来的 PR 中解决一些小问题,但并不紧急。 谢谢!

@jywarren当然,我也注意到了! 添加到我的待办事项中。

我也想知道在https://github.com/publiclab/plots2/pull/9045的速度优化之后,我记得 Skylight 显示实际上在 PublicLab.org 上发表评论可能需要很长时间......我想我们进行了一些优化,但没有我们希望的那么优化。 您是否仍然发现发表评论的加载时间很慢? 我想知道这是否也是一种改善系统测试运行时的方法,同时也改善了用户体验。

这是一个快照; 它显然偶尔仍然需要长达 10 秒,但不幸的是,我们的监控不足以显示更多时间在控制器中花费的时间,似乎:

image

这也不是您的项目的要求,但我认为这可能很有趣。 驱动这个的代码在这里这里

老实说,不用担心这个……但我很好奇你是否觉得评论发布时间很慢?

@jywarren是的! 我绝对认为发表评论的时间很慢! (另外,是时候对评论做出反应了)

了解 Skylight 及其功能很有趣。 我想知道到底是什么导致了速度变慢,您认为这可能是 ActiveRecord 查询吗?

编辑:将其添加到本规划问题的延伸目标愿望清单中!

将规划问题移至此处 -> #9069

我决定将我的计划问题移到一个新的问题页面,主要是为了可读性问题。 对于由此引起的任何混淆,我们深表歉意! - @noi5e

此页面是否有帮助?
0 / 5 - 0 等级