mirror of
https://github.com/discourse/discourse.git
synced 2025-06-03 02:48:28 +08:00
DEV: Move chat service objects into core (#26506)
This commit is contained in:
@ -1,129 +0,0 @@
|
||||
# frozen_string_literal: true
|
||||
|
||||
module Chat
|
||||
# = Chat::StepsInspector
|
||||
#
|
||||
# This class takes a {Service::Base::Context} object and inspects it.
|
||||
# It will output a list of steps and what is their known state.
|
||||
class StepsInspector
|
||||
# @!visibility private
|
||||
class Step
|
||||
attr_reader :step, :result, :nesting_level
|
||||
|
||||
delegate :name, to: :step
|
||||
delegate :failure?, :success?, :error, to: :step_result, allow_nil: true
|
||||
|
||||
def self.for(step, result, nesting_level: 0)
|
||||
class_name =
|
||||
"#{module_parent_name}::#{step.class.name.split("::").last.sub(/^(\w+)Step$/, "\\1")}"
|
||||
class_name.constantize.new(step, result, nesting_level: nesting_level)
|
||||
end
|
||||
|
||||
def initialize(step, result, nesting_level: 0)
|
||||
@step = step
|
||||
@result = result
|
||||
@nesting_level = nesting_level
|
||||
end
|
||||
|
||||
def type
|
||||
self.class.name.split("::").last.downcase
|
||||
end
|
||||
|
||||
def emoji
|
||||
"#{result_emoji}#{unexpected_result_emoji}"
|
||||
end
|
||||
|
||||
def steps
|
||||
[self]
|
||||
end
|
||||
|
||||
def inspect
|
||||
"#{" " * nesting_level}[#{type}] '#{name}' #{emoji}".rstrip
|
||||
end
|
||||
|
||||
private
|
||||
|
||||
def step_result
|
||||
result["result.#{type}.#{name}"]
|
||||
end
|
||||
|
||||
def result_emoji
|
||||
return "❌" if failure?
|
||||
return "✅" if success?
|
||||
""
|
||||
end
|
||||
|
||||
def unexpected_result_emoji
|
||||
" ⚠️#{unexpected_result_text}" if step_result.try(:[], "spec.unexpected_result")
|
||||
end
|
||||
|
||||
def unexpected_result_text
|
||||
return " <= expected to return true but got false instead" if failure?
|
||||
" <= expected to return false but got true instead"
|
||||
end
|
||||
end
|
||||
|
||||
# @!visibility private
|
||||
class Model < Step
|
||||
def error
|
||||
return result[name].errors.inspect if step_result.invalid
|
||||
step_result.exception.full_message
|
||||
end
|
||||
end
|
||||
|
||||
# @!visibility private
|
||||
class Contract < Step
|
||||
def error
|
||||
step_result.errors.inspect
|
||||
end
|
||||
end
|
||||
|
||||
# @!visibility private
|
||||
class Policy < Step
|
||||
def error
|
||||
step_result.reason
|
||||
end
|
||||
end
|
||||
|
||||
# @!visibility private
|
||||
class Transaction < Step
|
||||
def steps
|
||||
[self, *step.steps.map { Step.for(_1, result, nesting_level: nesting_level + 1).steps }]
|
||||
end
|
||||
|
||||
def inspect
|
||||
"#{" " * nesting_level}[#{type}]"
|
||||
end
|
||||
|
||||
def step_result
|
||||
nil
|
||||
end
|
||||
end
|
||||
|
||||
attr_reader :steps, :result
|
||||
|
||||
def initialize(result)
|
||||
@steps = result.__steps__.map { Step.for(_1, result).steps }.flatten
|
||||
@result = result
|
||||
end
|
||||
|
||||
# Inspect the provided result object.
|
||||
# Example output:
|
||||
# [1/4] [model] 'channel' ✅
|
||||
# [2/4] [contract] 'default' ✅
|
||||
# [3/4] [policy] 'check_channel_permission' ❌
|
||||
# [4/4] [step] 'change_status'
|
||||
# @return [String] the steps of the result object with their state
|
||||
def inspect
|
||||
steps
|
||||
.map
|
||||
.with_index { |step, index| "[#{index + 1}/#{steps.size}] #{step.inspect}" }
|
||||
.join("\n")
|
||||
end
|
||||
|
||||
# @return [String, nil] the first available error, if any.
|
||||
def error
|
||||
steps.detect(&:failure?)&.error
|
||||
end
|
||||
end
|
||||
end
|
@ -2,7 +2,7 @@
|
||||
|
||||
module ChatSDK
|
||||
class Channel
|
||||
include Chat::WithServiceHelper
|
||||
include WithServiceHelper
|
||||
|
||||
# Retrieves messages from a specified channel.
|
||||
#
|
||||
|
@ -2,7 +2,7 @@
|
||||
|
||||
module ChatSDK
|
||||
class Message
|
||||
include Chat::WithServiceHelper
|
||||
include WithServiceHelper
|
||||
|
||||
# Creates a new message in a chat channel.
|
||||
#
|
||||
@ -159,7 +159,7 @@ module ChatSDK
|
||||
end
|
||||
|
||||
class StreamHelper
|
||||
include Chat::WithServiceHelper
|
||||
include WithServiceHelper
|
||||
|
||||
attr_reader :message
|
||||
attr_reader :guardian
|
||||
|
@ -2,7 +2,7 @@
|
||||
|
||||
module ChatSDK
|
||||
class Thread
|
||||
include Chat::WithServiceHelper
|
||||
include WithServiceHelper
|
||||
|
||||
# Updates the title of a specified chat thread.
|
||||
#
|
||||
|
Reference in New Issue
Block a user