Add admin logs codebase by mrcasals · Pull Request #2604 · decidim/decidim

mrcasals · 2018-01-30T10:44:44Z

🎩 What? Why?

See #2603 for reference.

This PR intends to add a log of all actions performed by admins. It will only be visible by organization admins.

In a first iteration of this, I will only log actions on accountability results, since they are already versioned and it's simpler to start. This way I can test the whole feature, work on it, and later improve it when logging actions from other modules.

Note that this is not the MVP, this adds the codebase so the MVP can be added.

📌 Related Issues

Fixes Log all actions for admins-MVP #2603

📋 Subtasks

Add ActionLog class
Add a wrapper class to create ActionLogs
Make Decidim.traceability service log all actions
Log actions in accountability module => I will work on results first
Create presenters
Add sentence for updates
Add base log presenter
List the log with pagination
Add CHANGELOG entry

📷 Screenshots (optional)

The admin dashboard shows the last 20 logs:

The logs section shows all logs, paginated (20 per page):

codecov · 2018-01-30T11:11:45Z

Codecov Report

Merging #2604 into master will increase coverage by 0.01%.
The diff coverage is 99.57%.

@@            Coverage Diff             @@
##           master    #2604      +/-   ##
==========================================
+ Coverage   98.84%   98.85%   +0.01%     
==========================================
  Files        1504     1531      +27     
  Lines       35293    35987     +694     
==========================================
+ Hits        34884    35575     +691     
- Misses        409      412       +3

oriolgual

Looks nice!

oriolgual · 2018-02-01T10:21:45Z

decidim-admin/app/views/decidim/admin/dashboard/show.html.erb

  <p><%= t ".welcome" %></p>
+  <div class="row">
+    <ul>
+      <% Decidim::ActionLog.order(id: :desc).first(20).each do |log| %>


Shouldn't we order by date?

oriolgual · 2018-02-01T10:22:39Z

decidim-core/app/models/decidim/action_log.rb

+               optional: true,
+               polymorphic: true
+
+    validates :organization, :user, :action, :resource, presence: true


Should we also validate the the organization of all associations is the same?

This is automatically done by the system

oriolgual · 2018-02-01T10:24:03Z

decidim-core/app/services/decidim/action_logger.rb

+    end
+
+    def participatory_space
+      resource.participatory_space if resource.respond_to?(:participatory_space)


Do all resource delegate the participatory space to the feature?

If not, maybe you can try to get it from the feature too

oriolgual · 2018-02-02T13:48:14Z

decidim-core/app/presenters/decidim/log/base_presenter.rb

+      #
+      # Returns a String.
+      def action_string
+        case action


Add .to_s to prevent possible errors when comparing against Nil or if someone returns a symbol? (yay types!)

oriolgual · 2018-02-02T13:48:43Z

decidim-core/app/services/decidim/action_logger.rb

+      resource.participatory_space if resource.respond_to?(:participatory_space)
+    end
+
+    def get_title(resource)


Rename to title_for?

oriolgual · 2018-02-02T13:49:27Z

decidim-core/config/locales/en.yml

      remove_this_file: Remove this file
+    log:
+      base_presenter:
+        create: "%{user_name} created %{result_name} in %{space_name}"


oriolgual · 2018-02-02T13:50:00Z

decidim-core/lib/decidim/core/test/factories.rb

+        organization: organization || build(:organization)
+      )
+    end
+    participatory_space { build :participatory_process, organization: organization || build(:organization) }


Maybe you should get the organization from the user

oriolgual · 2018-02-02T13:52:17Z

docs/activity_log.md

+3. Create a `Presenter` for your model for the log you need. Presenters should be named as `Decidim::<your module name>::<log name>::<your model name>Presenter`. There's currently only one log, `AdminLog`. This means that if your model is `Decidim::Accountability::Result`, then your admin log presenter is must be `Decidim::Accountability::AdminLog::ResultPresenter`
+
+## Multiple logs
+Alhotugh Decidim currently only has a log for the admin section, in the future we might need an activity log for the public part. It's easy to assume we might need to render the same data in different formats, so we need to differentiate the presenters for each log. The current system handles the case for multiple logs, although we only have one.


oriolgual · 2018-02-02T13:52:29Z

docs/activity_log.md

+
+In order to make your component compatible with the activity log, you need to follow these steps:
+
+1. Make your model include the `Decidim::Traceable` module. This will enable Decidim to create versions every time your model records are changed. It uses [`paper_trail`](https://github.com/airblade/paper_trail) to generate the versions.


Is this really mandatory or recommended?

It will be needed because the Product team wants to see all changes in all fields when the user updates a resource. For this, the best way is to have paper_trail included though the Traceable module

Then maybe we need some kind of validation?

Done, logs are not saved if the resource is not traceable.

oriolgual · 2018-02-02T13:52:41Z

docs/activity_log.md

+1. Make your model include the `Decidim::Traceable` module. This will enable Decidim to create versions every time your model records are changed. It uses [`paper_trail`](https://github.com/airblade/paper_trail) to generate the versions.
+2. Make your commands use `Decidim.traceability` to create and update records. Documentation can be found in `Decidim::Traceability`. This should properly set the author of the change in your record.
+3. Create a `Presenter` for your model for the log you need. Presenters should be named as `Decidim::<your module name>::<log name>::<your model name>Presenter`. There's currently only one log, `AdminLog`. This means that if your model is `Decidim::Accountability::Result`, then your admin log presenter is must be `Decidim::Accountability::AdminLog::ResultPresenter`
+


An example would be nice.

Requested changes solved

mrcasals self-assigned this Jan 30, 2018

ghost added the in-progress label Jan 30, 2018

mrcasals changed the title ~~[WIP} Log all actions for admins~~ [WIP] Log all actions for admins Jan 30, 2018

mrcasals force-pushed the admin/log-actions branch 2 times, most recently from 832e2f1 to 1eab324 Compare January 30, 2018 14:40

mrcasals mentioned this pull request Jan 31, 2018

Log all actions for admins-MVP #2603

Closed

mrcasals force-pushed the admin/log-actions branch 7 times, most recently from ea8bb1f to dc80397 Compare February 1, 2018 10:14

oriolgual suggested changes Feb 1, 2018

View reviewed changes

mrcasals force-pushed the admin/log-actions branch 7 times, most recently from e34a382 to f506ae1 Compare February 2, 2018 13:22

oriolgual previously requested changes Feb 2, 2018

View reviewed changes

mrcasals force-pushed the admin/log-actions branch 4 times, most recently from f6a5c02 to c6f5915 Compare February 5, 2018 09:56

mrcasals force-pushed the admin/log-actions branch 2 times, most recently from 182ecf4 to 9581f66 Compare February 5, 2018 14:23

mrcasals added 17 commits February 16, 2018 11:55

Show user nicknames in tooltips

7eeb43c

Update docs

de2e980

Refactor log presenter

5527d93

Add dumb diff presenter

184b3e9

Improve diff renderer

8400f8c

Let diffs handle different types of data

0e13808

Add value type presenters

df020f5

Fix codeclimate issues

eedd866

Fix tests

1c30dff

Add more dev docs

3d7f84f

Add method docs

147d46e

Check the date appears correctly in the logs

9ff15c2

Check diff is presented when conditions apply

82a58ea

Add value type presenters specs

540d276

Add missing specs

6a632f9

Add scope presenter

b1e49d8

Fix Rubocop complains

c13d54f

mrcasals force-pushed the admin/log-actions branch from f0543c3 to c13d54f Compare February 16, 2018 10:55

Fix specs

2313ad4

oriolgual approved these changes Feb 16, 2018

View reviewed changes

mrcasals merged commit 4382b2a into master Feb 16, 2018

ghost removed the in-review label Feb 16, 2018

mrcasals deleted the admin/log-actions branch February 16, 2018 13:38

mrcasals mentioned this pull request Feb 16, 2018

Log actions on static pages #2754

Merged

2 tasks

xabier mentioned this pull request Feb 19, 2018

Activity audit #129

Closed

mrcasals mentioned this pull request Feb 23, 2018

Refactor the codebase for logs creation #2808

Merged

3 tasks

arnaumonty mentioned this pull request Mar 12, 2018

Activity log for administrators (2nd iteration) #2978

Closed

42 tasks

mrcasals modified the milestones: CDP1, CdP2 Dec 7, 2018


		In order to make your component compatible with the activity log, you need to follow these steps:

		1. Make your model include the `Decidim::Traceable` module. This will enable Decidim to create versions every time your model records are changed. It uses [`paper_trail`](https://github.com/airblade/paper_trail) to generate the versions.

Uh oh!

Conversation

mrcasals commented Jan 30, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🎩 What? Why?

📌 Related Issues

📋 Subtasks

📷 Screenshots (optional)

Uh oh!

codecov bot commented Jan 30, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

oriolgual left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

mrcasals commented Jan 30, 2018 •

edited

Loading

codecov bot commented Jan 30, 2018 •

edited

Loading