Enhance report overview #8239

tclaus · 2021-04-28T06:27:08Z

This PR enhances the admin/moderators report overview by

adding a view that shows recent reports and the action done (Item Deleted or not)
adding a statistics view (Who reports and who is the originator of a reported item)
a once 'reviewed report can be deleted retrospectively
let podsmins show the originator even /after/ a reported item was deleted
links to the originator profile directly (and not to the Search view)

Heads up!
It needs a migration!
Two fields are added: a 'action' textfield that is used to describe what happened to the report. Its free text, but filled based on the action.
The second fields holds the diaspora_handel for the originator. This is needed because after deleting a report this information is gone.

What is the outcome?
A Podmin now has more insights in old reports and in most reporter and most originators. A valuable base for more decisions what to do.

Future
List of reports grows without limits - a paginated view would be nice, but that was currently above my skill level.

Screenshots

(Added date time)

( deleted or reviewed reports)

(statistics with links to the authors / originators)

Comments, Ideas, critics... welcome!

tclaus · 2021-04-28T06:35:17Z

This Feature was requested in this discussion:
https://discourse.diasporafoundation.org/t/better-abilities-for-podmins-for-spam-analytics-and-controls/3896/6
and on this Issue: #8222

It is also IMHO a pre-work and touches issue #7847 "handling fake accounts / forward to pod".

diaspora-code-review · 2021-08-22T04:57:42Z

app/helpers/report_helper.rb

@@ -8,17 +8,36 @@ module ReportHelper
 def report_content(report)
 case (item = report.item)
 when Post
- raw t("report.post_label", content: link_to(post_message(item), post_path(item.id)))
+ raw t("report.post_label", content: link_to(truncated_post_message(item), post_path(item.id)))


Rails/OutputSafety: Tagging a string as html safe may be a security risk.

@Flaburgan Here is the old ugly diaspora link-inside-translated text part. I did not care to change anything here

Flaburgan · 2021-08-24T22:40:38Z

Hey! This is very needed, thank you for working on this. I'm going to try it and do a review, but two quick remarks:

I guess the reports only appear in the "Reviewed" tab if they have been reviewed, meaning they have been either "marked as reviewed" or "deleted". That means a boolean "deleted" or if you prefer an enum ["ignored", "deleted"] should be enough to be stored in the database, instead of a free text field. Strings displayed in the interface shouldn't be stored in the DB, it makes them untranslatable, and is bad practice anyway
Originator isn't clear to me. Why not using "Author" as everywhere else?

tclaus · 2021-08-25T06:40:23Z

The Images in the first comment are not matching the text.

Originator isn't clear to me. Why not using "Author" as everywhere else?

"Reporter" and "Author" then - I missed this.

Do you mean to use the Database' ENUM type? Like the Idea.

Flaburgan · 2021-08-25T07:47:54Z

Do you mean to use the Database' ENUM type? Like the Idea.

I mean your mockup gave the impression that "No action" was the text stored in the database. This must be avoided, the state (deleted or ignored) has to be stored in the DB, then the UI will display a label depending of the state.

tclaus · 2021-08-26T16:38:57Z

@Flaburgan Can you make a re-Review? I have abstracted the action - text from database to UI.

Wouldn't it be more convenient to open the github "Reviewers" - section?

Flaburgan · 2021-08-26T16:41:18Z

@Flaburgan Can you make a re-Review? I have abstracted the action - text from database to UI.

I was actually doing it right now 😄

Flaburgan

This is GREAT, I love it!

I did some remarks but that's mostly in good shape already. But you would need to also add tests. I started to add them in #8035 but I'm actually not able to navigate to /report in my PR. If you help me fix that PR you should then be able to rebase on me and complete the tests there.

app/controllers/report_controller.rb

Flaburgan · 2021-08-26T16:57:10Z

app/controllers/report_controller.rb

+ end
+
+ def statistics_by_reporter
+ sql = "select count(*), diaspora_handle, guid from reports


Couldn't that query be written with ActiveRecord?

Maybe, But I don't have an idea how. The trick here is: the group by counts all reports, and adds the diaspora_handle from people's table. If this is possible, I think the sql is more straight-forward.

Flaburgan · 2021-08-26T16:57:30Z

app/controllers/report_controller.rb

+ end
+
+ def statistics_by_author
+ sql = "select count(*), originator_diaspora_handle, guid from reports


Same as above, is there any reason why you use SQL?

See above, it seems SQL is easier to read (and I don't have a clue how to build this in ActiveRecored) If this can be done, make a proposal without changing the returning data. (haml files rely on that)

app/helpers/notifier_helper.rb

app/models/report.rb

db/migrate/20210421064041_add_action_to_report.rb

app/views/report/_pending.haml

app/assets/javascripts/app/views.js

db/migrate/20210421064041_add_action_to_report.rb

features/step_definitions/report_steps.rb

tclaus · 2021-08-28T17:58:31Z

@Flaburgan I rebased this on Enhance Report Form

With undecided / reviewed and statistics page. Already reviewed reports stay visible. Enhances Spam/user control fixes diaspora#8239

tclaus · 2022-06-10T09:34:03Z

@Flaburgan , @SuperTux88
Besides the (old and already existing) issues in Linter and Rubocop, is there anything which blocks a review?

Flaburgan · 2022-06-10T09:41:56Z

#8035 is adding tests on that part of the code so we said we should merge it first, but it's blocked by some weird Jasmine flickering tests. If you want to help there you're welcome!

SuperTux88

As this is depending on #8035, this isn't a full review yet (I maybe have missed some things between all the changes of the other PR), and you might also want to wait until #8035 is done before working on some of my comments (as there will be conflicts). But there is also already some feedback you can work on without having conflicts, so I already wanted to submit that before the other PR is done.

Also, I couldn't add a comment to that file, as it doesn't have a single line, but you accidentally deleted tmp/pids/.gitkeep.

db/migrate/20210424054604_add_user_fields_to_reports.rb

SuperTux88 · 2022-08-28T23:15:54Z

db/migrate/20210424054604_add_user_fields_to_reports.rb

+
+class AddUserFieldsToReports < ActiveRecord::Migration[5.2]
+ def change
+ add_column :reports, :originator_diaspora_handle, :string, index: true


First, please don't use the term "diaspora handle" anymore, it's called "diaspora* ID" now. There are still some really old columns that are called diaspora_handle but that's just because nobody renamed them yet.

Second, instead of storing the diaspora ID, you should just store the person ID.

I'm also not sure about "originator", I think reported_person_id or reported_author_id is clearer, that it's about the reported content not about the reporter (the originator of the report).

With ID you mean the numeric id column or the unique guid?

with "person ID" I mean the numeric id column of the people table.

app/models/report.rb

app/helpers/notifier_helper.rb

app/models/report.rb

app/views/report/_pending.haml

app/views/report/_checked.haml

With undecided / reviewed and statistics page Already reviewed reports stay visible Enhances Spam/user control fixes diaspora#8239

diaspora-code-review · 2022-10-30T23:30:15Z

app/assets/javascripts/app/app.js

+ $("#reportModal").modal("hide");
+ let textarea = document.getElementById("report-reason-field");
+ let report = {
+ item_id: form.dataset.reportId,


Identifier 'item_id' is not in camel case.

diaspora-code-review · 2022-10-30T23:30:15Z

app/assets/javascripts/app/app.js

+ let textarea = document.getElementById("report-reason-field");
+ let report = {
+ item_id: form.dataset.reportId,
+ item_type: form.dataset.reportType,


Identifier 'item_type' is not in camel case.

diaspora-code-review · 2022-10-30T23:30:15Z

app/models/report.rb


 def reported_author
- item.author if item
+ return Person.find(reported_author_id) if reported_author_id.present?


Layout/EmptyLineAfterGuardClause: Add empty line after guard clause.

diaspora-code-review · 2022-10-30T23:30:15Z

app/models/report.rb

- return unless Report.where(item_id: item_id, item_type: item_type).exists?(user_id: user_id)
-
- errors.add(:base, "You cannot report the same post twice.")
+ if Report.where(item_id: item_id, item_type: item_type).exists?(user_id: user_id)


Style/GuardClause: Use a guard clause (return unless Report.where(item_id: item_id, item_type: item_type).exists?(user_id: user_id)) instead of wrapping the code inside a conditional expression.

diaspora-code-review · 2022-10-30T23:30:16Z

app/models/report.rb

- return unless Post.find_by(id: item_id).nil? && Comment.find_by(id: item_id).nil?
-
- errors.add(:base, "Post or comment was already deleted or doesn't exists.")
+ if Post.find_by(id: item_id).nil? && Comment.find_by(id: item_id).nil?


Style/GuardClause: Use a guard clause (return unless Post.find_by(id: item_id).nil? && Comment.find_by(id: item_id).nil?) instead of wrapping the code inside a conditional expression.

diaspora-code-review · 2022-10-30T23:30:16Z

db/migrate/20221030224657_add_action_fields_to_reports.rb

@@ -0,0 +1,20 @@
+class AddActionFieldsToReports < ActiveRecord::Migration[6.1]


Style/FrozenStringLiteralComment: Missing frozen string literal comment.

diaspora-code-review · 2022-10-30T23:30:16Z

db/migrate/20221030224657_add_action_fields_to_reports.rb

@@ -0,0 +1,20 @@
+class AddActionFieldsToReports < ActiveRecord::Migration[6.1]
+


Layout/EmptyLinesAroundClassBody: Extra empty line detected at class body beginning.

diaspora-code-review · 2022-10-30T23:30:16Z

db/migrate/20221030224657_add_action_fields_to_reports.rb

+
+ Report.find_each do |report|
+ # get reported author id from item before item gets deleted
+ if report.reported_author.present?


Style/IfUnlessModifier: Favor modifier if usage when having a single-line body. Another good alternative is the usage of control flow &&/||.

diaspora-code-review · 2022-10-30T23:30:16Z

db/migrate/20221030224657_add_action_fields_to_reports.rb

+ if report.reported_author.present?
+ report.reported_author_id = report.reported_author.id
+ end
+ if report.item.present?


Style/IfUnlessModifier: Favor modifier if usage when having a single-line body. Another good alternative is the usage of control flow &&/||.

db/migrate/20221030224657_add_action_fields_to_reports.rb

tclaus · 2022-10-30T23:40:45Z

@Flaburgan I rebased this to your #8035 and fixed most of my issues here.

With undecided / reviewed and statistics page Already reviewed reports stay visible Enhances Spam/user control fixes diaspora#8239

github-actions · 2023-11-13T22:28:12Z

app/views/report/_checked.haml

+ = t("report.decision")
+ %th
+ = t("report.action")
+ - @reviewed_reports.each do |report|


Avoid using instance variables in partials views

github-actions · 2023-11-13T22:28:13Z

app/views/report/_pending.haml

@@ -0,0 +1,43 @@
+- @unreviewed_reports.each do |report|


Avoid using instance variables in partials views

github-actions · 2023-11-13T22:28:13Z

app/views/report/_pending.haml

+ data: {confirm: t("report.confirm_deletion")},
+ class: "btn pull-right btn-danger btn-small col-md-3 col-xs-12",
+ method: :delete
+- if @unreviewed_reports.empty?


Avoid using instance variables in partials views

github-actions · 2023-11-13T22:28:13Z

app/views/report/_pending.haml

@@ -0,0 +1,43 @@
+- @unreviewed_reports.each do |report|
+ .panel.panel-default
+ - reported_by = report.user.username


Lint/UselessAssignment: Useless assignment to variable - reported_by. Did you mean report?

github-actions · 2023-11-13T22:28:13Z

app/views/report/_pending.haml

+ != t("report.reported_label", person: link_to(reported_by, user_profile_path(reported_by)))
+ .author
+ %span.reason-label
+ != "#{t('report.reported_author')}:"


Style/StringLiterals: Prefer double-quoted strings unless you need single quotes to avoid extra backslashes for escaping.

github-actions · 2023-11-13T22:28:13Z

app/views/report/_statistics.haml

+ = t("report.count")
+ %th
+ = t("report.reported_author")
+ - @statistics_by_author.rows.each do |count, author_diaspora_handle, guid|


Avoid using instance variables in partials views

github-actions · 2023-11-13T22:28:14Z

app/models/report.rb

@@ -4,33 +4,44 @@ class Report < ApplicationRecord
 validates :user_id, presence: true
 validates :item_id, presence: true
 validates :item_type, presence: true, inclusion: {
- in: %w(Post Comment), message: "Type should match `Post` or `Comment`!"}
+ in: %w[Post Comment], message: "Type should match `Post` or `Comment`!"


Rails/I18nLocaleTexts: Move locale texts to the locale files in the config/locales directory.

github-actions · 2023-11-13T22:28:14Z

app/models/report.rb

 end

 def entry_does_not_exist
 return unless Report.where(item_id: item_id, item_type: item_type).exists?(user_id: user_id)

- errors.add(:base, "You cannot report the same post twice.")
+ errors[:base] << "You cannot report the same post twice."


Rails/DeprecatedActiveModelErrorsMethods: Avoid manipulating ActiveModel errors as hash directly.

github-actions · 2023-11-13T22:28:14Z

app/models/report.rb

 end

 def post_or_comment_does_exist
 return unless Post.find_by(id: item_id).nil? && Comment.find_by(id: item_id).nil?

- errors.add(:base, "Post or comment was already deleted or doesn't exists.")
+ errors[:base] << "Post or comment was already deleted or doesn't exists."


Rails/DeprecatedActiveModelErrorsMethods: Avoid manipulating ActiveModel errors as hash directly.

github-actions · 2023-11-13T22:28:14Z

app/models/report.rb

@@ -50,12 +61,16 @@ def destroy_reported_item
 item.destroy
 end
 end
- mark_as_reviewed
+ mark_as_reviewed(STATUS_DELETED)


Metrics/AbcSize: Assignment Branch Condition size for destroy_reported_item is too high. [<0, 32, 7> 32.76/20]

Flaburgan · 2023-11-13T22:30:49Z

So because the report modal got merged, I rebased this MR, squashed the commits and fixed the front-end pronto problems. There are still a lot of them but I'd like help to resolve those.
I did not even run the code yet, I will obviously try this and polish the UI as we said in the other PR.

With undecided / reviewed and statistics page Already reviewed reports stay visible Enhances Spam/user control fixes diaspora#8239

Flaburgan · 2023-11-26T21:11:25Z

@SuperTux88 about the remark you made about the design now that multi lines reports are possible.

It looks fine (the design isn't broken) but we are losing the line break:

Is there anything else you want me to check on the front-end side?

SuperTux88

This isn't a full review, I only had a quick look. But it looks like something went wrong when rebasing this, as at least the migration was dropped (which probably also explains why the tests failed).

It looks fine (the design isn't broken) but we are losing the line break

Well, the reports contain plain newlines, you would need to replace them with html-newlines (but ensure that no other html tags can be injected, so not just mark the string as html-safe)

SuperTux88 · 2024-06-03T01:17:55Z

app/models/report.rb

+
+ def mark_as_reviewed(with_action=STATUS_NO_ACTION)
+ Report.where(item_id: item_id, item_type: item_type)
+ .update_all(reviewed: true, action: with_action)


There is no action column anymore, did you accidentally drop the migrations?

SuperTux88 · 2024-06-03T01:22:46Z

app/helpers/notifier_helper.rb

+ # @param opts [Hash] Optional hash. Accepts :length parameters.
 # @return [String] The formatted post.
 def post_message(post, opts={})
- rendered = opts[:html] ? post.message&.markdownified_for_mail : post.message&.plain_text_without_markdown
- rendered.presence || post_page_title(post)
+ if post.respond_to? :message
+ post.message.try(:plain_text_without_markdown).presence || post_page_title(post)
+ else
+ I18n.t "notifier.a_post_you_shared"
+ end
 end

 # @param comment [Comment] The comment to process.
- # @param opts [Hash] Optional hash. Accepts :html parameter.
 # @return [String] The formatted comment.
 def comment_message(comment, opts={})
 if comment.post.public?
- opts[:html] ? comment.message.markdownified_for_mail : comment.message.plain_text_without_markdown
+ comment.message.plain_text_without_markdown
 else
- I18n.translate "notifier.a_limited_post_comment"
+ I18n.t "notifier.a_limited_post_comment"
 end
 end


These helpers also get used for the notification mails (hence the name "NotifierHelper"), you can't just completely change it's functionality and drop html support. But it looks like you aren't even using these helpers anymore, so maybe just revert these changes?

tclaus mentioned this pull request May 22, 2021

Let podmin send private messages to local users #8246

Closed

tclaus added a commit to tclaus/diaspora that referenced this pull request Aug 22, 2021

diaspora#8239 Shorten Report text in reported posts list

41631c5

diaspora-code-review reviewed Aug 22, 2021

View reviewed changes

tclaus added a commit to tclaus/diaspora that referenced this pull request Aug 22, 2021

diaspora#8239 Shorten Report text in reported posts list

6bb5180

tclaus force-pushed the enhance_reports branch from 41631c5 to 6bb5180 Compare August 22, 2021 05:09

tclaus added a commit to tclaus/diaspora that referenced this pull request Aug 22, 2021

diaspora#8239 Enhance Reports

d1c6616

tclaus added a commit to tclaus/diaspora that referenced this pull request Aug 22, 2021

diaspora#8239 Shorten Report text in reported posts list

6e71eee

tclaus added a commit to tclaus/diaspora that referenced this pull request Aug 22, 2021

diaspora#8239 Shorten Report text in reported posts list

7c5c7c4

tclaus force-pushed the enhance_reports branch from 6bb5180 to 7c5c7c4 Compare August 22, 2021 19:34

tclaus added a commit to tclaus/diaspora that referenced this pull request Aug 23, 2021

diaspora#8239 Enhance Reports

ec588e7

tclaus added a commit to tclaus/diaspora that referenced this pull request Aug 23, 2021

diaspora#8239 Shorten Report text in reported posts list

0241a7a

Flaburgan suggested changes Aug 26, 2021

View reviewed changes

Flaburgan mentioned this pull request Aug 26, 2021

Add a more detailed modal when reporting a post or a comment #8035

Merged

tclaus added a commit to tclaus/diaspora that referenced this pull request Aug 28, 2021

diaspora#8239 Shorten Report text in reported posts list

6062a9b

tclaus force-pushed the enhance_reports branch from 8706cc2 to 0adc2aa Compare August 28, 2021 17:55

diaspora-code-review reviewed Aug 28, 2021

View reviewed changes

tclaus added a commit to tclaus/diaspora that referenced this pull request Sep 19, 2021

Adds a detailed report overview

307053f

With undecided / reviewed and statistics page. Already reviewed reports stay visible. Enhances Spam/user control fixes diaspora#8239

tclaus force-pushed the enhance_reports branch from f2f5232 to 307053f Compare September 19, 2021 15:41

tclaus added a commit to tclaus/diaspora that referenced this pull request Oct 5, 2021

diaspora#8239 Enhance Reports

bd49a84

tclaus added a commit to tclaus/diaspora that referenced this pull request Oct 5, 2021

diaspora#8239 Shorten Report text in reported posts list

01fca6d

tclaus added a commit to tclaus/diaspora that referenced this pull request Oct 5, 2021

diaspora#8239 Shorten Report text in reported posts list

291abb5

tclaus added a commit to tclaus/diaspora that referenced this pull request Nov 9, 2021

diaspora#8239 Enhance Reports

e875832

tclaus added a commit to tclaus/diaspora that referenced this pull request Nov 9, 2021

diaspora#8239 Shorten Report text in reported posts list

6bf67bd

tclaus added a commit to tclaus/diaspora that referenced this pull request Nov 9, 2021

diaspora#8239 Shorten Report text in reported posts list

0073812

tclaus requested a review from Flaburgan December 19, 2021 17:41

tclaus requested a review from SuperTux88 June 10, 2022 09:34

SuperTux88 requested changes Aug 29, 2022

View reviewed changes

tclaus changed the title ~~Enhance Reports~~ Enhance report overview Oct 30, 2022

tclaus added a commit to tclaus/diaspora that referenced this pull request Oct 30, 2022

Adds a detailed report overview

1901bc2

With undecided / reviewed and statistics page Already reviewed reports stay visible Enhances Spam/user control fixes diaspora#8239

tclaus force-pushed the enhance_reports branch from de58572 to a0c1d84 Compare October 30, 2022 23:29

diaspora-code-review reviewed Oct 30, 2022

View reviewed changes

tclaus requested a review from SuperTux88 October 30, 2022 23:30

tclaus force-pushed the enhance_reports branch from a0c1d84 to 96153c0 Compare October 30, 2022 23:37

diaspora-code-review reviewed Oct 30, 2022

View reviewed changes

db/migrate/20221030224657_add_action_fields_to_reports.rb Outdated Show resolved Hide resolved

Flaburgan pushed a commit to tclaus/diaspora that referenced this pull request Nov 13, 2023

Adds a detailed report overview

98d5180

With undecided / reviewed and statistics page Already reviewed reports stay visible Enhances Spam/user control fixes diaspora#8239

Flaburgan force-pushed the enhance_reports branch from 96153c0 to 98d5180 Compare November 13, 2023 22:26

github-actions bot reviewed Nov 13, 2023

View reviewed changes

Adds a detailed report overview

9d89f2a

With undecided / reviewed and statistics page Already reviewed reports stay visible Enhances Spam/user control fixes diaspora#8239

Flaburgan force-pushed the enhance_reports branch from 98d5180 to 9d89f2a Compare November 13, 2023 22:32

SuperTux88 requested changes Jun 3, 2024

View reviewed changes

		@@ -0,0 +1,20 @@
		class AddActionFieldsToReports < ActiveRecord::Migration[6.1]

Enhance report overview #8239

Are you sure you want to change the base?

Enhance report overview #8239

Conversation

tclaus commented Apr 28, 2021 • edited

tclaus commented Apr 28, 2021 • edited

Choose a reason for hiding this comment

tclaus Aug 26, 2021 • edited

Choose a reason for hiding this comment

Flaburgan commented Aug 24, 2021

tclaus commented Aug 25, 2021

Flaburgan commented Aug 25, 2021 • edited

tclaus commented Aug 26, 2021

Flaburgan commented Aug 26, 2021 • edited

Flaburgan left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tclaus commented Aug 28, 2021

tclaus commented Jun 10, 2022

Flaburgan commented Jun 10, 2022

SuperTux88 left a comment • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tclaus commented Oct 30, 2022

github-actions bot Nov 13, 2023

Choose a reason for hiding this comment

github-actions bot Nov 13, 2023

Choose a reason for hiding this comment

github-actions bot Nov 13, 2023

Choose a reason for hiding this comment

github-actions bot Nov 13, 2023

Choose a reason for hiding this comment

github-actions bot Nov 13, 2023

Choose a reason for hiding this comment

github-actions bot Nov 13, 2023

Choose a reason for hiding this comment

github-actions bot Nov 13, 2023

Choose a reason for hiding this comment

github-actions bot Nov 13, 2023

Choose a reason for hiding this comment

github-actions bot Nov 13, 2023

Choose a reason for hiding this comment

github-actions bot Nov 13, 2023

Choose a reason for hiding this comment

Flaburgan commented Nov 13, 2023

Flaburgan commented Nov 26, 2023

SuperTux88 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tclaus commented Apr 28, 2021 •

edited

tclaus commented Apr 28, 2021 •

edited

tclaus Aug 26, 2021 •

edited

Flaburgan commented Aug 25, 2021 •

edited

Flaburgan commented Aug 26, 2021 •

edited

SuperTux88 left a comment •

edited