mirror of
https://gh.wpcy.net/https://github.com/discourse/discourse.git
synced 2026-05-17 15:23:00 +08:00
f79dd5c8b5
Currently, when calling a service with its block form, a `#result`
method is automatically created on the caller object. Even if it never
clashed so far, this could happen.
This patch removes that method, and instead use a more classical way of
doing things: the result object is now provided as an argument to the
main block. This means if we need to access the result object in an
outcome block, it will be done like this from now on:
```ruby
MyService.call(params) do |result|
on_success do
# do something with the result object
do_something(result)
end
end
```
In the same vein, this patch introduces the ability to match keys from
the result object in the outcome blocks, like we already do with step
definitions in a service. For example:
```ruby
on_success do |model:, contract:|
do_something(model, contract)
end
```
Instead of
```ruby
on_success do
do_something(result.model, result.contract)
end
```
104 lines
4.4 KiB
Ruby
104 lines
4.4 KiB
Ruby
# frozen_string_literal: true
|
||
|
||
module ChatSDK
|
||
class Thread
|
||
# Updates the title of a specified chat thread.
|
||
#
|
||
# @param title [String] The new title for the chat thread.
|
||
# @param thread_id [Integer] The ID of the chat thread to be updated.
|
||
# @param guardian [Guardian] The guardian object representing the user's permissions.
|
||
# @return [Chat::Thread] The updated thread object with the new title.
|
||
#
|
||
# @example Updating the title of a chat thread
|
||
# ChatSDK::Thread.update_title(title: "New Thread Title", thread_id: 1, guardian: Guardian.new)
|
||
#
|
||
def self.update_title(thread_id:, guardian:, title:)
|
||
new.update(title: title, thread_id: thread_id, guardian: guardian)
|
||
end
|
||
|
||
# Retrieves messages from a specified thread.
|
||
#
|
||
# @param thread_id [Integer] The ID of the chat thread from which to fetch messages.
|
||
# @param guardian [Guardian] The guardian object representing the user's permissions.
|
||
# @return [Array<Chat::Message>] An array of message objects from the specified thread.
|
||
#
|
||
# @example Fetching messages from a thread with additional parameters
|
||
# ChatSDK::Thread.messages(thread_id: 1, guardian: Guardian.new)
|
||
#
|
||
def self.messages(thread_id:, guardian:, **params)
|
||
new.messages(thread_id: thread_id, guardian: guardian, **params)
|
||
end
|
||
|
||
# Fetches the first messages from a specified chat thread, starting from the first available message.
|
||
#
|
||
# @param thread_id [Integer] The ID of the chat thread from which to fetch messages.
|
||
# @param guardian [Guardian] The guardian object representing the user's permissions.
|
||
# @param page_size [Integer] (optional) The number of messages to fetch, defaults to 10.
|
||
# @return [Array<Chat::Message>] An array of message objects representing the first messages in the thread.
|
||
#
|
||
# @example Fetching the first 15 messages from a thread
|
||
# ChatSDK::Thread.first_messages(thread_id: 1, guardian: Guardian.new, page_size: 15)
|
||
#
|
||
def self.first_messages(thread_id:, guardian:, page_size: 10)
|
||
new.messages(
|
||
thread_id: thread_id,
|
||
guardian: guardian,
|
||
page_size: page_size,
|
||
direction: "future",
|
||
fetch_from_first_message: true,
|
||
)
|
||
end
|
||
|
||
# Fetches the last messages from a specified chat thread, starting from the last available message.
|
||
#
|
||
# @param thread_id [Integer] The ID of the chat thread from which to fetch messages.
|
||
# @param guardian [Guardian] The guardian object representing the user's permissions.
|
||
# @param page_size [Integer] (optional) The number of messages to fetch, defaults to 10.
|
||
# @return [Array<Chat::Message>] An array of message objects representing the last messages in the thread.
|
||
#
|
||
# @example Fetching the last 20 messages from a thread
|
||
# ChatSDK::Thread.last_messages(thread_id: 2, guardian: Guardian.new, page_size: 20)
|
||
#
|
||
def self.last_messages(thread_id:, guardian:, page_size: 10)
|
||
new.messages(
|
||
thread_id: thread_id,
|
||
guardian: guardian,
|
||
page_size: page_size,
|
||
direction: "past",
|
||
fetch_from_last_message: true,
|
||
)
|
||
end
|
||
|
||
def self.update(**params)
|
||
new.update(**params)
|
||
end
|
||
|
||
def messages(thread_id:, guardian:, direction: "future", **params)
|
||
Chat::ListChannelThreadMessages.call(thread_id:, guardian:, direction:, **params) do
|
||
on_success { |messages:| messages }
|
||
on_failed_policy(:can_view_thread) { raise "Guardian can't view thread" }
|
||
on_failed_policy(:target_message_exists) { raise "Target message doesn't exist" }
|
||
on_failure { raise "Unexpected error" }
|
||
end
|
||
end
|
||
|
||
def update(**params)
|
||
Chat::UpdateThread.call(params) do
|
||
on_model_not_found(:channel) do
|
||
raise "Couldn’t find channel with id: `#{params[:channel_id]}`"
|
||
end
|
||
on_model_not_found(:thread) do
|
||
raise "Couldn’t find thread with id: `#{params[:thread_id]}`"
|
||
end
|
||
on_failed_policy(:can_view_channel) { raise "Guardian can't view channel" }
|
||
on_failed_policy(:can_edit_thread) { raise "Guardian can't edit thread" }
|
||
on_failed_policy(:threading_enabled_for_channel) do
|
||
raise "Threading is not enabled for this channel"
|
||
end
|
||
on_failed_contract { |contract| raise contract.errors.full_messages.join(", ") }
|
||
on_success { |thread:| thread }
|
||
on_failure { raise "Unexpected error" }
|
||
end
|
||
end
|
||
end
|
||
end
|
