- {{#each model.fields as |field|}}
+ {{#each model.columns as |column|}}
diff --git a/assets/stylesheets/common/wizard-admin.scss b/assets/stylesheets/common/wizard-admin.scss
index 7027950a..7c6cd95d 100644
--- a/assets/stylesheets/common/wizard-admin.scss
+++ b/assets/stylesheets/common/wizard-admin.scss
@@ -66,10 +66,10 @@
}
}
-.wizard-submissions {
+.wizard-table {
overflow: scroll;
- table td {
+ table td:not(.small) {
min-width: 150px;
}
@@ -77,25 +77,26 @@
text-transform: capitalize;
}
- .submission-icon-item {
+ .wizard-table-icon-item {
display: flex;
align-items: center;
+
svg {
margin-right: 5px;
}
}
- .submission-checkbox-true {
+ .wizard-table-checkbox-true {
text-transform: capitalize;
color: var(--success);
}
- .submission-checkbox-false {
+ .wizard-table-checkbox-false {
text-transform: capitalize;
color: var(--danger);
}
- .submission-long-text {
+ .wizard-table-long-text {
&-content {
white-space: nowrap;
word-wrap: break-word;
@@ -114,25 +115,11 @@
}
}
- .submission-composer-text {
+ .wizard-table-composer-text {
font-family: monospace;
}
}
-.admin-wizards-logs {
- .admin-wizard-controls {
- h3 {
- margin: 0 7px;
- }
- }
-
- .wizard-logs {
- .date {
- width: 100px;
- }
- }
-}
-
.wizard-settings-parent {
padding: 20px;
border: 1px solid var(--primary-low);
@@ -215,6 +202,10 @@
margin-bottom: 0;
}
+ button {
+ font-size: 1rem;
+ }
+
.download-link {
font-size: 1rem;
line-height: 20px;
@@ -230,10 +221,6 @@
font-size: 1rem;
background-color: var(--primary-low);
}
-
- button {
- font-size: 1rem;
- }
}
}
diff --git a/config/locales/client.en.yml b/config/locales/client.en.yml
index ae2594d2..cb30cf76 100644
--- a/config/locales/client.en.yml
+++ b/config/locales/client.en.yml
@@ -58,6 +58,9 @@ en:
select_type: "Select a type"
condition: "Condition"
index: "Index"
+ edit_columns: "Edit Columns"
+ expand_text: "Read More"
+ collapse_text: "Show Less"
pro_support_button:
title: "Request Pro Support"
@@ -108,6 +111,7 @@ en:
viewing: "You're viewing the submissions of the %{wizardName}"
documentation: "Check out the submissions documentation"
logs:
+ select: "Select a wizard to see its logs"
viewing: "View recent logs for wizards on the forum"
documentation: "Check out the logs documentation"
@@ -378,9 +382,6 @@ en:
nav_label: "Submissions"
title: "{{name}} Submissions"
download: "Download"
- edit_columns: "Edit Columns"
- expand_text: "Read More"
- collapse_text: "Show Less"
group_id: "Group ID"
category_id: "Category ID"
composer_preview: "Composer Preview"
@@ -437,9 +438,14 @@ en:
log:
label: "Logs"
-
+
log:
nav_label: "Logs"
+ title: "{{name}} Logs"
+ date: Date
+ action: Action
+ user: User
+ message: Message
manager:
nav_label: Manager
diff --git a/config/routes.rb b/config/routes.rb
index abe36479..3a37a137 100644
--- a/config/routes.rb
+++ b/config/routes.rb
@@ -38,6 +38,7 @@ Discourse::Application.routes.append do
get 'admin/wizards/api/:name/authorize' => 'admin_api#authorize'
get 'admin/wizards/logs' => 'admin_logs#index'
+ get 'admin/wizards/logs/:wizard_id' => 'admin_logs#show'
get 'admin/wizards/manager' => 'admin_manager#index'
get 'admin/wizards/manager/export' => 'admin_manager#export'
diff --git a/controllers/custom_wizard/admin/logs.rb b/controllers/custom_wizard/admin/logs.rb
index 976814f8..7ca37bb2 100644
--- a/controllers/custom_wizard/admin/logs.rb
+++ b/controllers/custom_wizard/admin/logs.rb
@@ -1,9 +1,44 @@
# frozen_string_literal: true
class CustomWizard::AdminLogsController < CustomWizard::AdminController
+ before_action :find_wizard, except: [:index]
+
def index
- render_serialized(
- CustomWizard::Log.list(params[:page].to_i, params[:limit].to_i),
- CustomWizard::LogSerializer
+ render json: ActiveModel::ArraySerializer.new(
+ CustomWizard::Wizard.list(current_user),
+ each_serializer: CustomWizard::BasicWizardSerializer
)
end
+
+ def show
+ render_json_dump(
+ wizard: CustomWizard::BasicWizardSerializer.new(@wizard, root: false),
+ logs: ActiveModel::ArraySerializer.new(
+ log_list.logs,
+ each_serializer: CustomWizard::LogSerializer
+ ),
+ total: log_list.total
+ )
+ end
+
+ protected
+
+ def log_list
+ @log_list ||= begin
+ list = CustomWizard::Log.list(params[:page].to_i, params[:limit].to_i, params[:wizard_id])
+
+ if list.logs.any? && (usernames = list.logs.map(&:username)).present?
+ user_map = User.where(username: usernames)
+ .reduce({}) do |result, user|
+ result[user.username] = user
+ result
+ end
+
+ list.logs.each do |log_item|
+ log_item.user = user_map[log_item.username]
+ end
+ end
+
+ list
+ end
+ end
end
diff --git a/coverage/.last_run.json b/coverage/.last_run.json
index cff5740b..23e2ecb9 100644
--- a/coverage/.last_run.json
+++ b/coverage/.last_run.json
@@ -1,5 +1,5 @@
{
"result": {
- "line": 91.96
+ "line": 92.14
}
}
diff --git a/db/migrate/20210806135416_split_custom_wizard_log_fields.rb b/db/migrate/20210806135416_split_custom_wizard_log_fields.rb
index 984a7a23..8107bc07 100644
--- a/db/migrate/20210806135416_split_custom_wizard_log_fields.rb
+++ b/db/migrate/20210806135416_split_custom_wizard_log_fields.rb
@@ -1,51 +1,56 @@
# frozen_string_literal: true
class SplitCustomWizardLogFields < ActiveRecord::Migration[6.1]
+ KEY_MAP = {
+ wizard: "wizard_id",
+ action: "action",
+ user: "username",
+ date: "date",
+ message: "message"
+ }
+
def change
reversible do |dir|
dir.up do
# separate wizard/action/user into their own keys
- wizard_logs = PluginStoreRow.where("
- plugin_name = 'custom_wizard_log'
- ")
+ wizard_logs = PluginStoreRow.where("plugin_name = 'custom_wizard_log'")
- if wizard_logs.exists?
- wizard_logs.each do |row|
- begin
- log_json = JSON.parse(row.value)
- rescue TypeError, JSON::ParserError
- next
- end
+ if wizard_logs.exists?
+ wizard_logs.each do |row|
+ begin
+ log_json = JSON.parse(row.value)
+ rescue TypeError, JSON::ParserError
+ next
+ end
- if log_json.key?('message') && log_json['message'].is_a?(String)
+ if log_json.key?('message') && log_json['message'].is_a?(String)
- attr_strs = []
+ attr_strs = []
- # assumes no whitespace in the values
- attr_strs << log_json['message'].slice!(/(wizard: \S*; )/, 1)
- attr_strs << log_json['message'].slice!(/(action: \S*; )/, 1)
- attr_strs << log_json['message'].slice!(/(user: \S*; )/, 1)
+ # assumes no whitespace in the values
+ attr_strs << log_json['message'].slice!(/(wizard: \S*; )/, 1)
+ attr_strs << log_json['message'].slice!(/(action: \S*; )/, 1)
+ attr_strs << log_json['message'].slice!(/(user: \S*; )/, 1)
- attr_strs.each do |attr_str|
- if attr_str.is_a? String
- attr_str.gsub!(/[;]/ , "")
- key, value = attr_str.split(': ')
- value.strip! if value
- log_json[key] = value ? value : ''
- end
+ attr_strs.each do |attr_str|
+ if attr_str.is_a? String
+ attr_str.gsub!(/[;]/ , "")
+ key, value = attr_str.split(': ')
+ value.strip! if value
+ key = KEY_MAP[key.to_sym] ? KEY_MAP[key.to_sym] : key
+ log_json[key] = value ? value : ''
end
-
- row.value = log_json.to_json
- row.save
-
end
+
+ row.value = log_json.to_json
+ row.save
end
end
+ end
end
+
dir.down do
- wizard_logs = PluginStoreRow.where("
- plugin_name = 'custom_wizard_log'
- ")
+ wizard_logs = PluginStoreRow.where("plugin_name = 'custom_wizard_log'")
if wizard_logs.exists?
wizard_logs.each do |row|
@@ -56,19 +61,26 @@ class SplitCustomWizardLogFields < ActiveRecord::Migration[6.1]
end
# concatenate wizard/action/user to start of message
- prefixes = log_json.extract!('wizard', 'action', 'user')
+ prefixes = log_json.extract!('wizard_id', 'action', 'username')
+ message_prefix = ""
- message_prefix = prefixes.map { |k, v| "#{k}: #{v}" }.join('; ')
+ if prefixes.present?
+ message_prefix = prefixes.map do |k, v|
+ key = KEY_MAP.key(k) ? KEY_MAP.key(k) : k
+ "#{key.to_s}: #{v};"
+ end.join(' ')
+ end
if log_json.key?('message')
- log_json['message'] = "#{message_prefix}; #{log_json['message']}"
+ message = log_json['message']
+ message = "#{message_prefix} #{message}" if message_prefix.present?
+ log_json['message'] = message
else
log_json['message'] = message_prefix
end
row.value = log_json.to_json
row.save
-
end
end
end
diff --git a/lib/custom_wizard/log.rb b/lib/custom_wizard/log.rb
index c50a5712..cb5b78c7 100644
--- a/lib/custom_wizard/log.rb
+++ b/lib/custom_wizard/log.rb
@@ -2,46 +2,51 @@
class CustomWizard::Log
include ActiveModel::Serialization
- attr_accessor :date, :wizard, :action, :user, :message
+ attr_reader :date, :wizard_id, :action, :username, :message
+ attr_accessor :user
PAGE_LIMIT = 100
def initialize(attrs)
@date = attrs['date']
- @wizard = attrs['wizard']
@action = attrs['action']
- @user = attrs['user']
@message = attrs['message']
+ @wizard_id = attrs['wizard_id']
+ @username = attrs['username']
end
- def self.create(wizard, action, user, message)
+ def self.create(wizard_id, action, username, message)
log_id = SecureRandom.hex(12)
PluginStore.set('custom_wizard_log',
log_id.to_s,
{
date: Time.now,
- wizard: wizard,
+ wizard_id: wizard_id,
action: action,
- user: user,
+ username: username,
message: message
}
)
end
- def self.list_query
- PluginStoreRow.where("
- plugin_name = 'custom_wizard_log' AND
- (value::json->'date') IS NOT NULL
- ").order("value::json->>'date' DESC")
+ def self.list_query(wizard_id = nil)
+ query = PluginStoreRow.where("plugin_name = 'custom_wizard_log' AND (value::json->'date') IS NOT NULL")
+ query = query.where("(value::json->>'wizard_id') = ?", wizard_id) if wizard_id
+ query.order("value::json->>'date' DESC")
end
- def self.list(page = 0, limit = nil)
+ def self.list(page = 0, limit = nil, wizard_id = nil)
limit = limit.to_i > 0 ? limit.to_i : PAGE_LIMIT
page = page.to_i
+ logs = self.list_query(wizard_id)
- self.list_query.limit(limit)
+ result = OpenStruct.new(logs: [], total: nil)
+ result.total = logs.size
+ result.logs = logs.limit(limit)
.offset(page * limit)
.map { |r| self.new(JSON.parse(r.value)) }
+
+ result
end
end
diff --git a/serializers/custom_wizard/log_serializer.rb b/serializers/custom_wizard/log_serializer.rb
index c4683ba8..56c5fd8f 100644
--- a/serializers/custom_wizard/log_serializer.rb
+++ b/serializers/custom_wizard/log_serializer.rb
@@ -1,4 +1,10 @@
# frozen_string_literal: true
+
class CustomWizard::LogSerializer < ApplicationSerializer
- attributes :date, :wizard, :action, :user, :message
+ attributes :date,
+ :action,
+ :username,
+ :message
+
+ has_one :user, serializer: ::BasicUserSerializer, embed: :objects
end
diff --git a/spec/components/custom_wizard/log_spec.rb b/spec/components/custom_wizard/log_spec.rb
index 62f2e6df..0b4832c0 100644
--- a/spec/components/custom_wizard/log_spec.rb
+++ b/spec/components/custom_wizard/log_spec.rb
@@ -10,19 +10,25 @@ describe CustomWizard::Log do
it "creates logs" do
expect(
- CustomWizard::Log.list.length
+ CustomWizard::Log.list.logs.length
).to eq(3)
end
it "lists logs by time created" do
expect(
- CustomWizard::Log.list.first.message
+ CustomWizard::Log.list.logs.first.message
).to eq("Third log message")
end
it "paginates logs" do
expect(
- CustomWizard::Log.list(0, 2).length
+ CustomWizard::Log.list(0, 2).logs.length
).to eq(2)
end
+
+ it "lists logs by wizard" do
+ expect(
+ CustomWizard::Log.list(0, 2, 'third-test-wizard').logs.length
+ ).to eq(1)
+ end
end
diff --git a/spec/requests/custom_wizard/admin/logs_controller_spec.rb b/spec/requests/custom_wizard/admin/logs_controller_spec.rb
index 5aaf9578..1559fa6f 100644
--- a/spec/requests/custom_wizard/admin/logs_controller_spec.rb
+++ b/spec/requests/custom_wizard/admin/logs_controller_spec.rb
@@ -3,21 +3,40 @@ require_relative '../../../plugin_helper'
describe CustomWizard::AdminLogsController do
fab!(:admin_user) { Fabricate(:user, admin: true) }
+ let(:template) { get_wizard_fixture("wizard") }
before do
- CustomWizard::Log.create('first-test-wizard', 'perform_first_action', 'first_test_user', 'First log message')
- CustomWizard::Log.create('second-test-wizard', 'perform_second_action', 'second_test_user', 'Second log message')
- CustomWizard::Log.create('third-test-wizard', 'perform_third_action', 'third_test_user', 'Third log message')
+ ["first", "second", "third"].each_with_index do |key, index|
+ temp = template.dup
+ temp["id"] = "#{key}_test_wizard"
+ CustomWizard::Template.save(temp, skip_jobs: true)
+ CustomWizard::Log.create("#{key}_test_wizard", "perform_#{key}_action", "#{key}_test_user", "#{key} log message")
+ end
sign_in(admin_user)
end
- it "returns a list of logs" do
+ it "returns a list of wizards" do
get "/admin/wizards/logs.json"
expect(response.parsed_body.length).to eq(3)
end
+ it "returns a list of logs for a wizard" do
+ get "/admin/wizards/logs/first_test_wizard.json"
+ expect(response.parsed_body['logs'].length).to eq(1)
+ end
+
it "paginates" do
- get "/admin/wizards/logs.json", params: { page: 1, limit: 2 }
- expect(response.parsed_body.length).to eq(1)
+ get "/admin/wizards/logs/first_test_wizard.json", params: { page: 1 }
+ expect(response.parsed_body['logs'].length).to eq(0)
+ end
+
+ it "returns total logs for a wizard" do
+ get "/admin/wizards/logs/first_test_wizard.json"
+ expect(response.parsed_body['total']).to eq(1)
+ end
+
+ it "returns basic wizard" do
+ get "/admin/wizards/logs/first_test_wizard.json"
+ expect(response.parsed_body['wizard']['id']).to eq("first_test_wizard")
end
end
diff --git a/spec/serializers/custom_wizard/log_serializer_spec.rb b/spec/serializers/custom_wizard/log_serializer_spec.rb
index b452b9c5..d520fefa 100644
--- a/spec/serializers/custom_wizard/log_serializer_spec.rb
+++ b/spec/serializers/custom_wizard/log_serializer_spec.rb
@@ -10,13 +10,12 @@ describe CustomWizard::LogSerializer do
CustomWizard::Log.create('second-test-wizard', 'perform_second_action', 'second_test_user', 'Second log message')
json_array = ActiveModel::ArraySerializer.new(
- CustomWizard::Log.list(0),
+ CustomWizard::Log.list(0).logs,
each_serializer: CustomWizard::LogSerializer
).as_json
expect(json_array.length).to eq(2)
- expect(json_array[0][:wizard]).to eq("second-test-wizard")
expect(json_array[0][:action]).to eq("perform_second_action")
- expect(json_array[0][:user]).to eq("second_test_user")
+ expect(json_array[0][:username]).to eq('second_test_user')
expect(json_array[0][:message]).to eq("Second log message")
end
end