0
0
Fork 1
Spiegel von https://github.com/paviliondev/discourse-custom-wizard.git synchronisiert 2024-11-10 04:12:53 +01:00

Fix spec (mostly)

Dieser Commit ist enthalten in:
angusmcleod 2021-11-02 15:29:31 +08:00
Ursprung 81bb7e56c2
Commit 98061c14e8
6 geänderte Dateien mit 141 neuen und 65 gelöschten Zeilen

Datei anzeigen

@ -41,6 +41,7 @@ export default {
subscribe() { subscribe() {
this.unsubscribe(); this.unsubscribe();
this.messageBus.subscribe("/custom-wizard/notices", (data) => { this.messageBus.subscribe("/custom-wizard/notices", (data) => {
if (isPresent(data.active_notice_count)) { if (isPresent(data.active_notice_count)) {
this.loadCriticalNotices(); this.loadCriticalNotices();
} }

Datei anzeigen

@ -43,24 +43,30 @@ class CustomWizard::Notice
def dismiss! def dismiss!
if dismissable? if dismissable?
self.dismissed_at = Time.now self.dismissed_at = Time.now
self.save self.save_and_publish
self.class.publish_notice_count
end end
end end
def hide! def hide!
if can_hide? if can_hide?
self.hidden_at = Time.now self.hidden_at = Time.now
self.save self.save_and_publish
self.class.publish_notice_count
end end
end end
def expire! def expire!
if !expired? if !expired?
self.expired_at = Time.now self.expired_at = Time.now
self.save self.save_and_publish
end
end
def save_and_publish
if self.save
self.class.publish_notice_count self.class.publish_notice_count
true
else
false
end end
end end
@ -95,7 +101,6 @@ class CustomWizard::Notice
updated_at: updated_at, updated_at: updated_at,
retrieved_at: retrieved_at, retrieved_at: retrieved_at,
created_at: created_at, created_at: created_at,
hidden_at: hidden_at,
title: title, title: title,
message: message, message: message,
type: type, type: type,
@ -104,6 +109,7 @@ class CustomWizard::Notice
if current = self.class.find(self.id) if current = self.class.find(self.id)
attrs[:dismissed_at] = current.dismissed_at || self.dismissed_at attrs[:dismissed_at] = current.dismissed_at || self.dismissed_at
attrs[:hidden_at] = current.hidden_at || self.hidden_at
end end
self.class.store(id, attrs) self.class.store(id, attrs)
@ -146,7 +152,6 @@ class CustomWizard::Notice
end end
if notices.any? if notices.any?
notices.each do |notice_data| notices.each do |notice_data|
notice = new(notice_data) notice = new(notice_data)
notice.retrieved_at = Time.now notice.retrieved_at = Time.now
@ -166,18 +171,16 @@ class CustomWizard::Notice
def self.convert_subscription_messages_to_notices(messages) def self.convert_subscription_messages_to_notices(messages)
messages.reduce([]) do |result, message| messages.reduce([]) do |result, message|
notice_id = generate_notice_id(message[:title], message[:created_at]) id = generate_notice_id(message[:title], message[:created_at])
result.push(
unless exists?(notice_id) id: id,
result.push( title: message[:title],
title: message[:title], message: message[:message],
message: message[:message], type: types[message[:type].to_sym],
type: types[message[:type].to_sym], archetype: archetypes[:subscription_message],
archetype: archetypes[:subscription_message], created_at: message[:created_at],
created_at: message[:created_at], expired_at: message[:expired_at]
expired_at: message[:expired_at] )
)
end
result result
end end
end end
@ -298,11 +301,11 @@ class CustomWizard::Notice
PluginStore.set(namespace, id, raw_notice) PluginStore.set(namespace, id, raw_notice)
end end
def self.list_query(type: nil, archetype: nil, title: nil, include_all: false, include_recently_expired: false, page: nil, visible: false) def self.list_query(type: nil, archetype: nil, title: nil, include_all: false, page: nil, visible: false)
query = PluginStoreRow.where(plugin_name: namespace) query = PluginStoreRow.where(plugin_name: namespace)
query = query.where("(value::json->>'hidden_at') IS NULL") if visible query = query.where("(value::json->>'hidden_at') IS NULL") if visible
query = query.where("(value::json->>'dismissed_at') IS NULL") unless include_all query = query.where("(value::json->>'dismissed_at') IS NULL") unless include_all
query = query.where("(value::json->>'expired_at') IS NULL#{include_recently_expired ? " OR (value::json->>'expired_at')::date > now()::date - 1" : ""}") unless include_all query = query.where("(value::json->>'expired_at') IS NULL") unless include_all
query = query.where("(value::json->>'archetype')::integer = ?", archetype) if archetype query = query.where("(value::json->>'archetype')::integer = ?", archetype) if archetype
if type if type
type_query_str = type.is_a?(Array) ? "(value::json->>'type')::integer IN (?)" : "(value::json->>'type')::integer = ?" type_query_str = type.is_a?(Array) ? "(value::json->>'type')::integer IN (?)" : "(value::json->>'type')::integer = ?"
@ -313,8 +316,8 @@ class CustomWizard::Notice
query.order("value::json->>'expired_at' DESC, value::json->>'updated_at' DESC,value::json->>'dismissed_at' DESC, value::json->>'created_at' DESC") query.order("value::json->>'expired_at' DESC, value::json->>'updated_at' DESC,value::json->>'dismissed_at' DESC, value::json->>'created_at' DESC")
end end
def self.list(type: nil, archetype: nil, title: nil, include_all: false, include_recently_expired: false, page: 0, visible: false) def self.list(type: nil, archetype: nil, title: nil, include_all: false, page: 0, visible: false)
list_query(type: type, archetype: archetype, title: title, include_all: include_all, include_recently_expired: include_recently_expired, page: page, visible: visible) list_query(type: type, archetype: archetype, title: title, include_all: include_all, page: page, visible: visible)
.map { |r| self.new(JSON.parse(r.value).symbolize_keys) } .map { |r| self.new(JSON.parse(r.value).symbolize_keys) }
end end

Datei anzeigen

@ -10,9 +10,9 @@ class CustomWizard::Notice::ConnectionError
def create! def create!
if attrs = current_error if attrs = current_error
key = "#{archetype.to_s}_error_#{attrs["id"]}" key = "#{archetype.to_s}_error_#{attrs[:id]}"
attrs['updated_at'] = Time.now attrs[:updated_at] = Time.now
attrs['count'] = attrs['count'].to_i + 1 attrs[:count] = attrs[:count].to_i + 1
else else
domain = CustomWizard::Notice.send("#{archetype.to_s}_domain") domain = CustomWizard::Notice.send("#{archetype.to_s}_domain")
id = SecureRandom.hex(8) id = SecureRandom.hex(8)
@ -27,7 +27,8 @@ class CustomWizard::Notice::ConnectionError
end end
PluginStore.set(namespace, key, attrs) PluginStore.set(namespace, key, attrs)
@errors = nil
@current_error = nil
end end
def expire! def expire!
@ -54,7 +55,7 @@ class CustomWizard::Notice::ConnectionError
def reached_limit? def reached_limit?
return false unless current_error.present? return false unless current_error.present?
current_error['count'].to_i >= limit current_error[:count].to_i >= limit
end end
def namespace def namespace
@ -64,11 +65,13 @@ class CustomWizard::Notice::ConnectionError
def current_error(query_only: false) def current_error(query_only: false)
@current_error ||= begin @current_error ||= begin
query = PluginStoreRow.where(plugin_name: namespace) query = PluginStoreRow.where(plugin_name: namespace)
query = query.where("(value::json->>'archetype')::integer = ?", CustomWizard::Notice.archetypes[archetype]) query = query.where("(value::json->>'archetype')::integer = ?", CustomWizard::Notice.archetypes[archetype.to_sym])
query = query.where("(value::json->>'expired_at') IS NULL") query = query.where("(value::json->>'expired_at') IS NULL")
return nil if !query.exists? return nil if !query.exists?
return query if query_only return query if query_only
JSON.parse(query.first.value)
JSON.parse(query.first.value).deep_symbolize_keys
end end
end end
end end

Datei anzeigen

@ -6,6 +6,7 @@ describe CustomWizard::Notice do
fab!(:user) { Fabricate(:user) } fab!(:user) { Fabricate(:user) }
let(:subscription_message) { let(:subscription_message) {
{ {
title: "Title of message about subscription",
message: "Message about subscription", message: "Message about subscription",
type: "info", type: "info",
created_at: Time.now - 3.day, created_at: Time.now - 3.day,
@ -23,7 +24,7 @@ describe CustomWizard::Notice do
context "subscription message" do context "subscription message" do
before do before do
freeze_time freeze_time
stub_request(:get, described_class.subscription_messages_url).to_return(status: 200, body: { messages: [subscription_message] }.to_json) stub_request(:get, described_class.subscription_message_url).to_return(status: 200, body: { messages: [subscription_message] }.to_json)
described_class.update(skip_plugin: true) described_class.update(skip_plugin: true)
end end
@ -36,46 +37,73 @@ describe CustomWizard::Notice do
it "expires notice if subscription message is expired" do it "expires notice if subscription message is expired" do
subscription_message[:expired_at] = Time.now subscription_message[:expired_at] = Time.now
stub_request(:get, described_class.subscription_messages_url).to_return(status: 200, body: { messages: [subscription_message] }.to_json) stub_request(:get, described_class.subscription_message_url).to_return(status: 200, body: { messages: [subscription_message] }.to_json)
described_class.update(skip_plugin: true) described_class.update(skip_plugin: true)
notice = described_class.list(include_recently_expired: true).first notice = described_class.list(include_all: true).first
expect(notice.expired?).to eq(true) expect(notice.expired?).to eq(true)
end end
it "dismisses informational subscription notices" do
notice = described_class.list(include_all: true).first
expect(notice.dismissed?).to eq(false)
notice.dismiss!
expect(notice.dismissed?).to eq(true)
end
it "dismisses all informational subscription notices" do
4.times do |index|
subscription_message[:title] += " #{index}"
stub_request(:get, described_class.subscription_message_url).to_return(status: 200, body: { messages: [subscription_message] }.to_json)
described_class.update(skip_plugin: true)
end
expect(described_class.list.count).to eq(5)
described_class.dismiss_all
expect(described_class.list.count).to eq(0)
end
end end
context "plugin status" do context "plugin status" do
before do before do
freeze_time freeze_time
stub_request(:get, described_class.plugin_status_url).to_return(status: 200, body: { status: plugin_status }.to_json) stub_request(:get, described_class.plugin_status_url).to_return(status: 200, body: plugin_status.to_json)
described_class.update(skip_subscription: true) described_class.update(skip_subscription: true)
end end
it "converts warning into notice" do it "converts warning into notice" do
notice = described_class.list.first notice = described_class.list.first
expect(notice.type).to eq(described_class.types[:plugin_status_warning]) expect(notice.type).to eq(described_class.types[:warning])
expect(notice.message).to eq(I18n.t("wizard.notice.compatibility_issue", domain: described_class.plugin_status_domain)) expect(notice.message).to eq(I18n.t("wizard.notice.compatibility_issue.message", domain: described_class.plugin_status_domain))
expect(notice.created_at.to_datetime).to be_within(1.second).of (plugin_status[:status_changed_at].to_datetime) expect(notice.created_at.to_datetime).to be_within(1.second).of (plugin_status[:status_changed_at].to_datetime)
end end
it "expires warning notices if status is recommended or compatible" do it "expires warning notices if status is recommended or compatible" do
plugin_status[:status] = 'compatible' plugin_status[:status] = 'compatible'
plugin_status[:status_changed_at] = Time.now plugin_status[:status_changed_at] = Time.now
stub_request(:get, described_class.plugin_status_url).to_return(status: 200, body: { status: plugin_status }.to_json) stub_request(:get, described_class.plugin_status_url).to_return(status: 200, body: plugin_status.to_json)
described_class.update(skip_subscription: true) described_class.update(skip_subscription: true)
notice = described_class.list(type: described_class.types[:plugin_status_warning], include_recently_expired: true).first notice = described_class.list(type: described_class.types[:warning], include_all: true).first
expect(notice.expired?).to eq(true) expect(notice.expired?).to eq(true)
end end
it "hides plugin status warnings" do
notice = described_class.list.first
expect(notice.hidden?).to eq(false)
notice.hide!
expect(notice.hidden?).to eq(true)
end
end end
it "lists notices not expired more than a day ago" do it "lists notices not expired more than a day ago" do
subscription_message[:expired_at] = Time.now - 8.hours subscription_message[:expired_at] = Time.now - 8.hours
stub_request(:get, described_class.subscription_messages_url).to_return(status: 200, body: { messages: [subscription_message] }.to_json) stub_request(:get, described_class.subscription_message_url).to_return(status: 200, body: { messages: [subscription_message] }.to_json)
stub_request(:get, described_class.plugin_status_url).to_return(status: 200, body: { status: plugin_status }.to_json) stub_request(:get, described_class.plugin_status_url).to_return(status: 200, body: plugin_status.to_json)
described_class.update described_class.update
expect(described_class.list(include_recently_expired: true).length).to eq(2) expect(described_class.list(include_all: true).length).to eq(2)
end end
context "connection errors" do context "connection errors" do
@ -84,47 +112,47 @@ describe CustomWizard::Notice do
end end
it "creates an error if connection to notice server fails" do it "creates an error if connection to notice server fails" do
stub_request(:get, described_class.plugin_status_url).to_return(status: 400, body: { status: plugin_status }.to_json) stub_request(:get, described_class.plugin_status_url).to_return(status: 400, body: plugin_status.to_json)
described_class.update(skip_subscription: true) described_class.update(skip_subscription: true)
error = CustomWizard::Notice::ConnectionError.new(:plugin_status) error = CustomWizard::Notice::ConnectionError.new(:plugin_status)
expect(error.errors.exists?).to eq(true) expect(error.current_error.present?).to eq(true)
end end
it "only creates one connection error per type at a time" do it "only creates one connection error per type at a time" do
stub_request(:get, described_class.subscription_messages_url).to_return(status: 400, body: { messages: [subscription_message] }.to_json) stub_request(:get, described_class.subscription_message_url).to_return(status: 400, body: { messages: [subscription_message] }.to_json)
stub_request(:get, described_class.plugin_status_url).to_return(status: 400, body: { status: plugin_status }.to_json) stub_request(:get, described_class.plugin_status_url).to_return(status: 400, body: plugin_status.to_json)
5.times { described_class.update } 5.times { described_class.update }
plugin_status_errors = CustomWizard::Notice::ConnectionError.new(:plugin_status) plugin_status_errors = CustomWizard::Notice::ConnectionError.new(:plugin_status)
subscription_message_errors = CustomWizard::Notice::ConnectionError.new(:subscription_messages) subscription_message_errors = CustomWizard::Notice::ConnectionError.new(:subscription_message)
expect(plugin_status_errors.errors.length).to eq(1) expect(plugin_status_errors.current_error[:count]).to eq(5)
expect(subscription_message_errors.errors.length).to eq(1) expect(subscription_message_errors.current_error[:count]).to eq(5)
end end
it "creates a connection error notice if connection errors reach limit" do it "creates a connection error notice if connection errors reach limit" do
stub_request(:get, described_class.plugin_status_url).to_return(status: 400, body: { status: plugin_status }.to_json) stub_request(:get, described_class.plugin_status_url).to_return(status: 400, body: plugin_status.to_json)
error = CustomWizard::Notice::ConnectionError.new(:plugin_status) error = CustomWizard::Notice::ConnectionError.new(:plugin_status)
error.limit.times { described_class.update(skip_subscription: true) } error.limit.times { described_class.update(skip_subscription: true) }
notice = described_class.list(type: described_class.types[:plugin_status_connection_error]).first notice = described_class.list(type: described_class.types[:connection_error]).first
expect(error.current_error['count']).to eq(error.limit) expect(error.current_error[:count]).to eq(error.limit)
expect(notice.type).to eq(described_class.types[:plugin_status_connection_error]) expect(notice.type).to eq(described_class.types[:connection_error])
end end
it "expires a connection error notice if connection succeeds" do it "expires a connection error notice if connection succeeds" do
stub_request(:get, described_class.plugin_status_url).to_return(status: 400, body: { status: plugin_status }.to_json) stub_request(:get, described_class.plugin_status_url).to_return(status: 400, body: plugin_status.to_json)
error = CustomWizard::Notice::ConnectionError.new(:plugin_status) error = CustomWizard::Notice::ConnectionError.new(:plugin_status)
error.limit.times { described_class.update(skip_subscription: true) } error.limit.times { described_class.update(skip_subscription: true) }
stub_request(:get, described_class.plugin_status_url).to_return(status: 200, body: { status: plugin_status }.to_json) stub_request(:get, described_class.plugin_status_url).to_return(status: 200, body: plugin_status.to_json)
described_class.update(skip_subscription: true) described_class.update(skip_subscription: true)
notice = described_class.list(type: described_class.types[:plugin_status_connection_error], include_recently_expired: true).first notice = described_class.list(type: described_class.types[:connection_error], include_all: true).first
expect(notice.type).to eq(described_class.types[:plugin_status_connection_error]) expect(notice.type).to eq(described_class.types[:connection_error])
expect(notice.expired_at.present?).to eq(true) expect(notice.expired_at.present?).to eq(true)
end end
end end

Datei anzeigen

@ -20,7 +20,7 @@ describe Jobs::CustomWizardUpdateNotices do
} }
it "updates the notices" do it "updates the notices" do
stub_request(:get, CustomWizard::Notice.subscription_messages_url).to_return(status: 200, body: { messages: [subscription_message] }.to_json) stub_request(:get, CustomWizard::Notice.subscription_message_url).to_return(status: 200, body: { messages: [subscription_message] }.to_json)
stub_request(:get, CustomWizard::Notice.plugin_status_url).to_return(status: 200, body: { status: plugin_status }.to_json) stub_request(:get, CustomWizard::Notice.plugin_status_url).to_return(status: 200, body: { status: plugin_status }.to_json)
described_class.new.execute described_class.new.execute

Datei anzeigen

@ -3,29 +3,70 @@ require_relative '../../../plugin_helper'
describe CustomWizard::AdminNoticeController do describe CustomWizard::AdminNoticeController do
fab!(:admin_user) { Fabricate(:user, admin: true) } fab!(:admin_user) { Fabricate(:user, admin: true) }
let(:subscription_message_notice) {
{
title: "Title of message about subscription",
message: "Message about subscription",
type: 0,
created_at: Time.now.iso8601(3),
expired_at: nil
}
}
let(:plugin_status_notice) {
{
title: "The Custom Wizard Plugin is incompatibile with the latest version of Discourse.",
message: "Please check the Custom Wizard Plugin status on [localhost:3000](http://localhost:3000) before updating Discourse.",
type: 1,
archetype: 1,
created_at: Time.now.iso8601(3),
expired_at: nil
}
}
before do before do
sign_in(admin_user) sign_in(admin_user)
@notice = CustomWizard::Notice.new(
message: "Message about subscription",
type: "info",
created_at: Time.now - 3.day,
expired_at: nil
)
@notice.save
end end
it "lists notices" do it "lists notices" do
@notice = CustomWizard::Notice.new(subscription_message_notice)
@notice.save
get "/admin/wizards/notice.json" get "/admin/wizards/notice.json"
expect(response.status).to eq(200) expect(response.status).to eq(200)
expect(response.parsed_body.length).to eq(1) expect(response.parsed_body.length).to eq(1)
end end
it "dismisses notices" do it "dismisses notices" do
put "/admin/wizards/notice/#{@notice.id}.json" @notice = CustomWizard::Notice.new(subscription_message_notice)
@notice.save
put "/admin/wizards/notice/#{@notice.id}/dismiss.json"
expect(response.status).to eq(200) expect(response.status).to eq(200)
updated = CustomWizard::Notice.find(@notice.id) updated = CustomWizard::Notice.find(@notice.id)
expect(updated.dismissed?).to eq(true) expect(updated.dismissed?).to eq(true)
end end
it "dismisses all notices" do
5.times do |index|
subscription_message_notice[:title] += " #{index}"
@notice = CustomWizard::Notice.new(subscription_message_notice)
@notice.save
end
put "/admin/wizards/notice/dismiss.json"
expect(response.status).to eq(200)
expect(CustomWizard::Notice.list.size).to eq(0)
end
it "hides notices" do
@notice = CustomWizard::Notice.new(plugin_status_notice)
@notice.save
put "/admin/wizards/notice/#{@notice.id}/hide.json"
expect(response.status).to eq(200)
updated = CustomWizard::Notice.find(@notice.id)
expect(updated.hidden?).to eq(true)
end
end end