2022-11-02 21:41:30 +08:00
|
|
|
# frozen_string_literal: true
|
|
|
|
|
|
|
|
|
|
# name: chat
|
|
|
|
|
# about: Chat inside Discourse
|
|
|
|
|
# version: 0.4
|
|
|
|
|
# authors: Kane York, Mark VanLandingham, Martin Brennan, Joffrey Jaffeux
|
|
|
|
|
# url: https://github.com/discourse/discourse/tree/main/plugins/chat
|
|
|
|
|
# transpile_js: true
|
|
|
|
|
|
|
|
|
|
enabled_site_setting :chat_enabled
|
|
|
|
|
|
|
|
|
|
register_asset "stylesheets/mixins/chat-scrollbar.scss"
|
|
|
|
|
register_asset "stylesheets/common/core-extensions.scss"
|
|
|
|
|
register_asset "stylesheets/common/chat-emoji-picker.scss"
|
|
|
|
|
register_asset "stylesheets/common/chat-channel-card.scss"
|
2023-01-18 20:12:08 +08:00
|
|
|
register_asset "stylesheets/common/create-channel-modal.scss"
|
2022-11-02 21:41:30 +08:00
|
|
|
register_asset "stylesheets/common/dc-filter-input.scss"
|
|
|
|
|
register_asset "stylesheets/common/common.scss"
|
|
|
|
|
register_asset "stylesheets/common/chat-browse.scss"
|
|
|
|
|
register_asset "stylesheets/common/chat-drawer.scss"
|
2022-11-29 01:38:05 +08:00
|
|
|
register_asset "stylesheets/common/chat-index.scss"
|
2022-11-02 21:41:30 +08:00
|
|
|
register_asset "stylesheets/mobile/chat-index.scss", :mobile
|
2022-12-01 21:56:04 +08:00
|
|
|
register_asset "stylesheets/desktop/chat-index-full-page.scss", :desktop
|
|
|
|
|
register_asset "stylesheets/desktop/chat-index-drawer.scss", :desktop
|
2022-11-02 21:41:30 +08:00
|
|
|
register_asset "stylesheets/common/chat-channel-preview-card.scss"
|
|
|
|
|
register_asset "stylesheets/common/chat-channel-info.scss"
|
|
|
|
|
register_asset "stylesheets/common/chat-draft-channel.scss"
|
|
|
|
|
register_asset "stylesheets/common/chat-tabs.scss"
|
|
|
|
|
register_asset "stylesheets/common/chat-form.scss"
|
|
|
|
|
register_asset "stylesheets/common/d-progress-bar.scss"
|
|
|
|
|
register_asset "stylesheets/common/incoming-chat-webhooks.scss"
|
|
|
|
|
register_asset "stylesheets/mobile/chat-message.scss", :mobile
|
|
|
|
|
register_asset "stylesheets/desktop/chat-message.scss", :desktop
|
|
|
|
|
register_asset "stylesheets/common/chat-channel-title.scss"
|
|
|
|
|
register_asset "stylesheets/desktop/chat-channel-title.scss", :desktop
|
|
|
|
|
register_asset "stylesheets/common/full-page-chat-header.scss"
|
|
|
|
|
register_asset "stylesheets/common/chat-reply.scss"
|
|
|
|
|
register_asset "stylesheets/common/chat-message.scss"
|
|
|
|
|
register_asset "stylesheets/common/chat-message-left-gutter.scss"
|
|
|
|
|
register_asset "stylesheets/common/chat-message-info.scss"
|
|
|
|
|
register_asset "stylesheets/common/chat-composer-inline-button.scss"
|
|
|
|
|
register_asset "stylesheets/common/chat-replying-indicator.scss"
|
|
|
|
|
register_asset "stylesheets/common/chat-composer.scss"
|
|
|
|
|
register_asset "stylesheets/desktop/chat-composer.scss", :desktop
|
|
|
|
|
register_asset "stylesheets/mobile/chat-composer.scss", :mobile
|
|
|
|
|
register_asset "stylesheets/common/direct-message-creator.scss"
|
|
|
|
|
register_asset "stylesheets/common/chat-message-collapser.scss"
|
|
|
|
|
register_asset "stylesheets/common/chat-message-images.scss"
|
|
|
|
|
register_asset "stylesheets/common/chat-transcript.scss"
|
|
|
|
|
register_asset "stylesheets/common/chat-composer-dropdown.scss"
|
|
|
|
|
register_asset "stylesheets/common/chat-retention-reminder.scss"
|
|
|
|
|
register_asset "stylesheets/common/chat-composer-uploads.scss"
|
|
|
|
|
register_asset "stylesheets/desktop/chat-composer-uploads.scss", :desktop
|
|
|
|
|
register_asset "stylesheets/common/chat-composer-upload.scss"
|
|
|
|
|
register_asset "stylesheets/common/chat-selection-manager.scss"
|
|
|
|
|
register_asset "stylesheets/mobile/chat-selection-manager.scss", :mobile
|
|
|
|
|
register_asset "stylesheets/common/chat-channel-selector-modal.scss"
|
|
|
|
|
register_asset "stylesheets/mobile/mobile.scss", :mobile
|
|
|
|
|
register_asset "stylesheets/desktop/desktop.scss", :desktop
|
|
|
|
|
register_asset "stylesheets/sidebar-extensions.scss"
|
|
|
|
|
register_asset "stylesheets/desktop/sidebar-extensions.scss", :desktop
|
2022-11-10 22:08:14 +08:00
|
|
|
register_asset "stylesheets/common/chat-message-actions.scss"
|
|
|
|
|
register_asset "stylesheets/desktop/chat-message-actions.scss", :desktop
|
|
|
|
|
register_asset "stylesheets/mobile/chat-message-actions.scss", :mobile
|
2022-11-02 21:41:30 +08:00
|
|
|
register_asset "stylesheets/common/chat-message-separator.scss"
|
|
|
|
|
register_asset "stylesheets/common/chat-onebox.scss"
|
|
|
|
|
register_asset "stylesheets/common/chat-skeleton.scss"
|
|
|
|
|
register_asset "stylesheets/colors.scss", :color_definitions
|
|
|
|
|
register_asset "stylesheets/common/reviewable-chat-message.scss"
|
2022-12-07 01:54:04 +08:00
|
|
|
register_asset "stylesheets/common/chat-mention-warnings.scss"
|
2022-12-06 00:03:51 +08:00
|
|
|
register_asset "stylesheets/common/chat-channel-settings-saved-indicator.scss"
|
2023-02-14 09:38:41 +08:00
|
|
|
register_asset "stylesheets/common/chat-thread.scss"
|
|
|
|
|
register_asset "stylesheets/common/chat-side-panel.scss"
|
2022-11-02 21:41:30 +08:00
|
|
|
|
|
|
|
|
register_svg_icon "comments"
|
|
|
|
|
register_svg_icon "comment-slash"
|
|
|
|
|
register_svg_icon "hashtag"
|
|
|
|
|
register_svg_icon "lock"
|
|
|
|
|
|
|
|
|
|
register_svg_icon "file-audio"
|
|
|
|
|
register_svg_icon "file-video"
|
|
|
|
|
register_svg_icon "file-image"
|
|
|
|
|
|
|
|
|
|
# route: /admin/plugins/chat
|
|
|
|
|
add_admin_route "chat.admin.title", "chat"
|
|
|
|
|
|
|
|
|
|
# Site setting validators must be loaded before initialize
|
|
|
|
|
require_relative "lib/validators/chat_default_channel_validator.rb"
|
|
|
|
|
require_relative "lib/validators/chat_allow_uploads_validator.rb"
|
|
|
|
|
require_relative "lib/validators/direct_message_enabled_groups_validator.rb"
|
|
|
|
|
require_relative "app/core_ext/plugin_instance.rb"
|
|
|
|
|
|
|
|
|
|
GlobalSetting.add_default(:allow_unsecure_chat_uploads, false)
|
|
|
|
|
|
|
|
|
|
after_initialize do
|
DEV: Chat service object initial implementation (#19814)
This is a combined work of Martin Brennan, Loïc Guitaut, and Joffrey Jaffeux.
---
This commit implements a base service object when working in chat. The documentation is available at https://discourse.github.io/discourse/chat/backend/Chat/Service.html
Generating documentation has been made as part of this commit with a bigger goal in mind of generally making it easier to dive into the chat project.
Working with services generally involves 3 parts:
- The service object itself, which is a series of steps where few of them are specialized (model, transaction, policy)
```ruby
class UpdateAge
include Chat::Service::Base
model :user, :fetch_user
policy :can_see_user
contract
step :update_age
class Contract
attribute :age, :integer
end
def fetch_user(user_id:, **)
User.find_by(id: user_id)
end
def can_see_user(guardian:, **)
guardian.can_see_user(user)
end
def update_age(age:, **)
user.update!(age: age)
end
end
```
- The `with_service` controller helper, handling success and failure of the service within a service and making easy to return proper response to it from the controller
```ruby
def update
with_service(UpdateAge) do
on_success { render_serialized(result.user, BasicUserSerializer, root: "user") }
end
end
```
- Rspec matchers and steps inspector, improving the dev experience while creating specs for a service
```ruby
RSpec.describe(UpdateAge) do
subject(:result) do
described_class.call(guardian: guardian, user_id: user.id, age: age)
end
fab!(:user) { Fabricate(:user) }
fab!(:current_user) { Fabricate(:admin) }
let(:guardian) { Guardian.new(current_user) }
let(:age) { 1 }
it { expect(user.reload.age).to eq(age) }
end
```
Note in case of unexpected failure in your spec, the output will give all the relevant information:
```
1) UpdateAge when no channel_id is given is expected to fail to find a model named 'user'
Failure/Error: it { is_expected.to fail_to_find_a_model(:user) }
Expected model 'foo' (key: 'result.model.user') was not found in the result object.
[1/4] [model] 'user' ❌
[2/4] [policy] 'can_see_user'
[3/4] [contract] 'default'
[4/4] [step] 'update_age'
/Users/joffreyjaffeux/Code/pr-discourse/plugins/chat/app/services/update_age.rb:32:in `fetch_user': missing keyword: :user_id (ArgumentError)
from /Users/joffreyjaffeux/Code/pr-discourse/plugins/chat/app/services/base.rb:202:in `instance_exec'
from /Users/joffreyjaffeux/Code/pr-discourse/plugins/chat/app/services/base.rb:202:in `call'
from /Users/joffreyjaffeux/Code/pr-discourse/plugins/chat/app/services/base.rb:219:in `call'
from /Users/joffreyjaffeux/Code/pr-discourse/plugins/chat/app/services/base.rb:417:in `block in run!'
from /Users/joffreyjaffeux/Code/pr-discourse/plugins/chat/app/services/base.rb:417:in `each'
from /Users/joffreyjaffeux/Code/pr-discourse/plugins/chat/app/services/base.rb:417:in `run!'
from /Users/joffreyjaffeux/Code/pr-discourse/plugins/chat/app/services/base.rb:411:in `run'
from <internal:kernel>:90:in `tap'
from /Users/joffreyjaffeux/Code/pr-discourse/plugins/chat/app/services/base.rb:302:in `call'
from /Users/joffreyjaffeux/Code/pr-discourse/plugins/chat/spec/services/update_age_spec.rb:15:in `block (3 levels) in <main>'
```
2023-02-13 20:09:57 +08:00
|
|
|
# Namespace for classes and modules parts of chat plugin
|
2022-11-02 21:41:30 +08:00
|
|
|
module ::Chat
|
|
|
|
|
PLUGIN_NAME = "chat"
|
|
|
|
|
HAS_CHAT_ENABLED = "has_chat_enabled"
|
|
|
|
|
|
|
|
|
|
class Engine < ::Rails::Engine
|
|
|
|
|
engine_name PLUGIN_NAME
|
|
|
|
|
isolate_namespace Chat
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
def self.allowed_group_ids
|
|
|
|
|
SiteSetting.chat_allowed_groups_map
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
def self.onebox_template
|
|
|
|
|
@onebox_template ||=
|
|
|
|
|
begin
|
|
|
|
|
path = "#{Rails.root}/plugins/chat/lib/onebox/templates/discourse_chat.mustache"
|
|
|
|
|
File.read(path)
|
|
|
|
|
end
|
|
|
|
|
end
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
register_seedfu_fixtures(Rails.root.join("plugins", "chat", "db", "fixtures"))
|
|
|
|
|
|
|
|
|
|
load File.expand_path(
|
|
|
|
|
"../app/controllers/admin/admin_incoming_chat_webhooks_controller.rb",
|
|
|
|
|
__FILE__,
|
|
|
|
|
)
|
DEV: Chat service object initial implementation (#19814)
This is a combined work of Martin Brennan, Loïc Guitaut, and Joffrey Jaffeux.
---
This commit implements a base service object when working in chat. The documentation is available at https://discourse.github.io/discourse/chat/backend/Chat/Service.html
Generating documentation has been made as part of this commit with a bigger goal in mind of generally making it easier to dive into the chat project.
Working with services generally involves 3 parts:
- The service object itself, which is a series of steps where few of them are specialized (model, transaction, policy)
```ruby
class UpdateAge
include Chat::Service::Base
model :user, :fetch_user
policy :can_see_user
contract
step :update_age
class Contract
attribute :age, :integer
end
def fetch_user(user_id:, **)
User.find_by(id: user_id)
end
def can_see_user(guardian:, **)
guardian.can_see_user(user)
end
def update_age(age:, **)
user.update!(age: age)
end
end
```
- The `with_service` controller helper, handling success and failure of the service within a service and making easy to return proper response to it from the controller
```ruby
def update
with_service(UpdateAge) do
on_success { render_serialized(result.user, BasicUserSerializer, root: "user") }
end
end
```
- Rspec matchers and steps inspector, improving the dev experience while creating specs for a service
```ruby
RSpec.describe(UpdateAge) do
subject(:result) do
described_class.call(guardian: guardian, user_id: user.id, age: age)
end
fab!(:user) { Fabricate(:user) }
fab!(:current_user) { Fabricate(:admin) }
let(:guardian) { Guardian.new(current_user) }
let(:age) { 1 }
it { expect(user.reload.age).to eq(age) }
end
```
Note in case of unexpected failure in your spec, the output will give all the relevant information:
```
1) UpdateAge when no channel_id is given is expected to fail to find a model named 'user'
Failure/Error: it { is_expected.to fail_to_find_a_model(:user) }
Expected model 'foo' (key: 'result.model.user') was not found in the result object.
[1/4] [model] 'user' ❌
[2/4] [policy] 'can_see_user'
[3/4] [contract] 'default'
[4/4] [step] 'update_age'
/Users/joffreyjaffeux/Code/pr-discourse/plugins/chat/app/services/update_age.rb:32:in `fetch_user': missing keyword: :user_id (ArgumentError)
from /Users/joffreyjaffeux/Code/pr-discourse/plugins/chat/app/services/base.rb:202:in `instance_exec'
from /Users/joffreyjaffeux/Code/pr-discourse/plugins/chat/app/services/base.rb:202:in `call'
from /Users/joffreyjaffeux/Code/pr-discourse/plugins/chat/app/services/base.rb:219:in `call'
from /Users/joffreyjaffeux/Code/pr-discourse/plugins/chat/app/services/base.rb:417:in `block in run!'
from /Users/joffreyjaffeux/Code/pr-discourse/plugins/chat/app/services/base.rb:417:in `each'
from /Users/joffreyjaffeux/Code/pr-discourse/plugins/chat/app/services/base.rb:417:in `run!'
from /Users/joffreyjaffeux/Code/pr-discourse/plugins/chat/app/services/base.rb:411:in `run'
from <internal:kernel>:90:in `tap'
from /Users/joffreyjaffeux/Code/pr-discourse/plugins/chat/app/services/base.rb:302:in `call'
from /Users/joffreyjaffeux/Code/pr-discourse/plugins/chat/spec/services/update_age_spec.rb:15:in `block (3 levels) in <main>'
```
2023-02-13 20:09:57 +08:00
|
|
|
load File.expand_path("../app/helpers/with_service_helper.rb", __FILE__)
|
2022-11-02 21:41:30 +08:00
|
|
|
load File.expand_path("../app/controllers/chat_base_controller.rb", __FILE__)
|
|
|
|
|
load File.expand_path("../app/controllers/chat_controller.rb", __FILE__)
|
|
|
|
|
load File.expand_path("../app/controllers/emojis_controller.rb", __FILE__)
|
|
|
|
|
load File.expand_path("../app/controllers/direct_messages_controller.rb", __FILE__)
|
|
|
|
|
load File.expand_path("../app/controllers/incoming_chat_webhooks_controller.rb", __FILE__)
|
|
|
|
|
load File.expand_path("../app/models/concerns/chatable.rb", __FILE__)
|
|
|
|
|
load File.expand_path("../app/models/deleted_chat_user.rb", __FILE__)
|
|
|
|
|
load File.expand_path("../app/models/user_chat_channel_membership.rb", __FILE__)
|
|
|
|
|
load File.expand_path("../app/models/chat_channel.rb", __FILE__)
|
|
|
|
|
load File.expand_path("../app/models/chat_channel_archive.rb", __FILE__)
|
|
|
|
|
load File.expand_path("../app/models/chat_draft.rb", __FILE__)
|
|
|
|
|
load File.expand_path("../app/models/chat_message.rb", __FILE__)
|
|
|
|
|
load File.expand_path("../app/models/chat_message_reaction.rb", __FILE__)
|
|
|
|
|
load File.expand_path("../app/models/chat_message_revision.rb", __FILE__)
|
|
|
|
|
load File.expand_path("../app/models/chat_mention.rb", __FILE__)
|
2023-02-01 11:50:38 +08:00
|
|
|
load File.expand_path("../app/models/chat_thread.rb", __FILE__)
|
2022-11-02 21:41:30 +08:00
|
|
|
load File.expand_path("../app/models/chat_upload.rb", __FILE__)
|
|
|
|
|
load File.expand_path("../app/models/chat_webhook_event.rb", __FILE__)
|
|
|
|
|
load File.expand_path("../app/models/direct_message_channel.rb", __FILE__)
|
2022-11-02 22:53:36 +08:00
|
|
|
load File.expand_path("../app/models/direct_message.rb", __FILE__)
|
2022-11-02 21:41:30 +08:00
|
|
|
load File.expand_path("../app/models/direct_message_user.rb", __FILE__)
|
|
|
|
|
load File.expand_path("../app/models/incoming_chat_webhook.rb", __FILE__)
|
|
|
|
|
load File.expand_path("../app/models/reviewable_chat_message.rb", __FILE__)
|
|
|
|
|
load File.expand_path("../app/models/chat_view.rb", __FILE__)
|
|
|
|
|
load File.expand_path("../app/models/category_channel.rb", __FILE__)
|
|
|
|
|
load File.expand_path("../app/serializers/structured_channel_serializer.rb", __FILE__)
|
|
|
|
|
load File.expand_path("../app/serializers/chat_webhook_event_serializer.rb", __FILE__)
|
|
|
|
|
load File.expand_path("../app/serializers/chat_in_reply_to_serializer.rb", __FILE__)
|
2022-12-22 05:30:06 +08:00
|
|
|
load File.expand_path("../app/serializers/base_chat_channel_membership_serializer.rb", __FILE__)
|
2022-11-02 21:41:30 +08:00
|
|
|
load File.expand_path("../app/serializers/user_chat_channel_membership_serializer.rb", __FILE__)
|
|
|
|
|
load File.expand_path("../app/serializers/chat_message_serializer.rb", __FILE__)
|
|
|
|
|
load File.expand_path("../app/serializers/chat_channel_serializer.rb", __FILE__)
|
|
|
|
|
load File.expand_path("../app/serializers/chat_channel_index_serializer.rb", __FILE__)
|
|
|
|
|
load File.expand_path("../app/serializers/chat_channel_search_serializer.rb", __FILE__)
|
2023-02-14 09:38:41 +08:00
|
|
|
load File.expand_path("../app/serializers/chat_thread_original_message_serializer.rb", __FILE__)
|
|
|
|
|
load File.expand_path("../app/serializers/chat_thread_serializer.rb", __FILE__)
|
2022-11-02 21:41:30 +08:00
|
|
|
load File.expand_path("../app/serializers/chat_view_serializer.rb", __FILE__)
|
|
|
|
|
load File.expand_path(
|
|
|
|
|
"../app/serializers/user_with_custom_fields_and_status_serializer.rb",
|
|
|
|
|
__FILE__,
|
|
|
|
|
)
|
2022-11-02 22:53:36 +08:00
|
|
|
load File.expand_path("../app/serializers/direct_message_serializer.rb", __FILE__)
|
2022-11-02 21:41:30 +08:00
|
|
|
load File.expand_path("../app/serializers/incoming_chat_webhook_serializer.rb", __FILE__)
|
|
|
|
|
load File.expand_path("../app/serializers/admin_chat_index_serializer.rb", __FILE__)
|
|
|
|
|
load File.expand_path("../app/serializers/user_chat_message_bookmark_serializer.rb", __FILE__)
|
|
|
|
|
load File.expand_path("../app/serializers/reviewable_chat_message_serializer.rb", __FILE__)
|
DEV: Chat service object initial implementation (#19814)
This is a combined work of Martin Brennan, Loïc Guitaut, and Joffrey Jaffeux.
---
This commit implements a base service object when working in chat. The documentation is available at https://discourse.github.io/discourse/chat/backend/Chat/Service.html
Generating documentation has been made as part of this commit with a bigger goal in mind of generally making it easier to dive into the chat project.
Working with services generally involves 3 parts:
- The service object itself, which is a series of steps where few of them are specialized (model, transaction, policy)
```ruby
class UpdateAge
include Chat::Service::Base
model :user, :fetch_user
policy :can_see_user
contract
step :update_age
class Contract
attribute :age, :integer
end
def fetch_user(user_id:, **)
User.find_by(id: user_id)
end
def can_see_user(guardian:, **)
guardian.can_see_user(user)
end
def update_age(age:, **)
user.update!(age: age)
end
end
```
- The `with_service` controller helper, handling success and failure of the service within a service and making easy to return proper response to it from the controller
```ruby
def update
with_service(UpdateAge) do
on_success { render_serialized(result.user, BasicUserSerializer, root: "user") }
end
end
```
- Rspec matchers and steps inspector, improving the dev experience while creating specs for a service
```ruby
RSpec.describe(UpdateAge) do
subject(:result) do
described_class.call(guardian: guardian, user_id: user.id, age: age)
end
fab!(:user) { Fabricate(:user) }
fab!(:current_user) { Fabricate(:admin) }
let(:guardian) { Guardian.new(current_user) }
let(:age) { 1 }
it { expect(user.reload.age).to eq(age) }
end
```
Note in case of unexpected failure in your spec, the output will give all the relevant information:
```
1) UpdateAge when no channel_id is given is expected to fail to find a model named 'user'
Failure/Error: it { is_expected.to fail_to_find_a_model(:user) }
Expected model 'foo' (key: 'result.model.user') was not found in the result object.
[1/4] [model] 'user' ❌
[2/4] [policy] 'can_see_user'
[3/4] [contract] 'default'
[4/4] [step] 'update_age'
/Users/joffreyjaffeux/Code/pr-discourse/plugins/chat/app/services/update_age.rb:32:in `fetch_user': missing keyword: :user_id (ArgumentError)
from /Users/joffreyjaffeux/Code/pr-discourse/plugins/chat/app/services/base.rb:202:in `instance_exec'
from /Users/joffreyjaffeux/Code/pr-discourse/plugins/chat/app/services/base.rb:202:in `call'
from /Users/joffreyjaffeux/Code/pr-discourse/plugins/chat/app/services/base.rb:219:in `call'
from /Users/joffreyjaffeux/Code/pr-discourse/plugins/chat/app/services/base.rb:417:in `block in run!'
from /Users/joffreyjaffeux/Code/pr-discourse/plugins/chat/app/services/base.rb:417:in `each'
from /Users/joffreyjaffeux/Code/pr-discourse/plugins/chat/app/services/base.rb:417:in `run!'
from /Users/joffreyjaffeux/Code/pr-discourse/plugins/chat/app/services/base.rb:411:in `run'
from <internal:kernel>:90:in `tap'
from /Users/joffreyjaffeux/Code/pr-discourse/plugins/chat/app/services/base.rb:302:in `call'
from /Users/joffreyjaffeux/Code/pr-discourse/plugins/chat/spec/services/update_age_spec.rb:15:in `block (3 levels) in <main>'
```
2023-02-13 20:09:57 +08:00
|
|
|
load File.expand_path("../app/services/base.rb", __FILE__)
|
2022-11-02 21:41:30 +08:00
|
|
|
load File.expand_path("../lib/chat_channel_fetcher.rb", __FILE__)
|
FEATURE: Generic hashtag autocomplete lookup and markdown cooking (#18937)
This commit fleshes out and adds functionality for the new `#hashtag` search and
lookup system, still hidden behind the `enable_experimental_hashtag_autocomplete`
feature flag.
**Serverside**
We have two plugin API registration methods that are used to define data sources
(`register_hashtag_data_source`) and hashtag result type priorities depending on
the context (`register_hashtag_type_in_context`). Reading the comments in plugin.rb
should make it clear what these are doing. Reading the `HashtagAutocompleteService`
in full will likely help a lot as well.
Each data source is responsible for providing its own **lookup** and **search**
method that returns hashtag results based on the arguments provided. For example,
the category hashtag data source has to take into account parent categories and
how they relate, and each data source has to define their own icon to use for the
hashtag, and so on.
The `Site` serializer has two new attributes that source data from `HashtagAutocompleteService`.
There is `hashtag_icons` that is just a simple array of all the different icons that
can be used for allowlisting in our markdown pipeline, and there is `hashtag_context_configurations`
that is used to store the type priority orders for each registered context.
When sending emails, we cannot render the SVG icons for hashtags, so
we need to change the HTML hashtags to the normal `#hashtag` text.
**Markdown**
The `hashtag-autocomplete.js` file is where I have added the new `hashtag-autocomplete`
markdown rule, and like all of our rules this is used to cook the raw text on both the clientside
and on the serverside using MiniRacer. Only on the server side do we actually reach out to
the database with the `hashtagLookup` function, on the clientside we just render a plainer
version of the hashtag HTML. Only in the composer preview do we do further lookups based
on this.
This rule is the first one (that I can find) that uses the `currentUser` based on a passed
in `user_id` for guardian checks in markdown rendering code. This is the `last_editor_id`
for both the post and chat message. In some cases we need to cook without a user present,
so the `Discourse.system_user` is used in this case.
**Chat Channels**
This also contains the changes required for chat so that chat channels can be used
as a data source for hashtag searches and lookups. This data source will only be
used when `enable_experimental_hashtag_autocomplete` is `true`, so we don't have
to worry about channel results suddenly turning up.
------
**Known Rough Edges**
- Onebox excerpts will not render the icon svg/use tags, I plan to address that in a follow up PR
- Selecting a hashtag + pressing the Quote button will result in weird behaviour, I plan to address that in a follow up PR
- Mixed hashtag contexts for hashtags without a type suffix will not work correctly, e.g. #ux which is both a category and a channel slug will resolve to a category when used inside a post or within a [chat] transcript in that post. Users can get around this manually by adding the correct suffix, for example ::channel. We may get to this at some point in future
- Icons will not show for the hashtags in emails since SVG support is so terrible in email (this is not likely to be resolved, but still noting for posterity)
- Additional refinements and review fixes wil
2022-11-21 06:37:06 +08:00
|
|
|
load File.expand_path("../lib/chat_channel_hashtag_data_source.rb", __FILE__)
|
2022-11-02 21:41:30 +08:00
|
|
|
load File.expand_path("../lib/chat_mailer.rb", __FILE__)
|
|
|
|
|
load File.expand_path("../lib/chat_message_creator.rb", __FILE__)
|
|
|
|
|
load File.expand_path("../lib/chat_message_processor.rb", __FILE__)
|
|
|
|
|
load File.expand_path("../lib/chat_message_updater.rb", __FILE__)
|
|
|
|
|
load File.expand_path("../lib/chat_message_rate_limiter.rb", __FILE__)
|
|
|
|
|
load File.expand_path("../lib/chat_message_reactor.rb", __FILE__)
|
2023-02-16 23:55:18 +08:00
|
|
|
load File.expand_path("../lib/chat_message_mentions.rb", __FILE__)
|
2022-11-02 21:41:30 +08:00
|
|
|
load File.expand_path("../lib/chat_notifier.rb", __FILE__)
|
|
|
|
|
load File.expand_path("../lib/chat_seeder.rb", __FILE__)
|
|
|
|
|
load File.expand_path("../lib/chat_statistics.rb", __FILE__)
|
|
|
|
|
load File.expand_path("../lib/chat_transcript_service.rb", __FILE__)
|
|
|
|
|
load File.expand_path("../lib/duplicate_message_validator.rb", __FILE__)
|
|
|
|
|
load File.expand_path("../lib/message_mover.rb", __FILE__)
|
|
|
|
|
load File.expand_path("../lib/chat_channel_membership_manager.rb", __FILE__)
|
|
|
|
|
load File.expand_path("../lib/chat_message_bookmarkable.rb", __FILE__)
|
|
|
|
|
load File.expand_path("../lib/chat_channel_archive_service.rb", __FILE__)
|
|
|
|
|
load File.expand_path("../lib/chat_review_queue.rb", __FILE__)
|
|
|
|
|
load File.expand_path("../lib/direct_message_channel_creator.rb", __FILE__)
|
|
|
|
|
load File.expand_path("../lib/guardian_extensions.rb", __FILE__)
|
|
|
|
|
load File.expand_path("../lib/extensions/user_option_extension.rb", __FILE__)
|
|
|
|
|
load File.expand_path("../lib/extensions/user_notifications_extension.rb", __FILE__)
|
|
|
|
|
load File.expand_path("../lib/extensions/user_email_extension.rb", __FILE__)
|
|
|
|
|
load File.expand_path("../lib/extensions/category_extension.rb", __FILE__)
|
|
|
|
|
load File.expand_path("../lib/extensions/user_extension.rb", __FILE__)
|
|
|
|
|
load File.expand_path("../lib/slack_compatibility.rb", __FILE__)
|
|
|
|
|
load File.expand_path("../lib/post_notification_handler.rb", __FILE__)
|
|
|
|
|
load File.expand_path("../lib/secure_uploads_compatibility.rb", __FILE__)
|
DEV: Chat service object initial implementation (#19814)
This is a combined work of Martin Brennan, Loïc Guitaut, and Joffrey Jaffeux.
---
This commit implements a base service object when working in chat. The documentation is available at https://discourse.github.io/discourse/chat/backend/Chat/Service.html
Generating documentation has been made as part of this commit with a bigger goal in mind of generally making it easier to dive into the chat project.
Working with services generally involves 3 parts:
- The service object itself, which is a series of steps where few of them are specialized (model, transaction, policy)
```ruby
class UpdateAge
include Chat::Service::Base
model :user, :fetch_user
policy :can_see_user
contract
step :update_age
class Contract
attribute :age, :integer
end
def fetch_user(user_id:, **)
User.find_by(id: user_id)
end
def can_see_user(guardian:, **)
guardian.can_see_user(user)
end
def update_age(age:, **)
user.update!(age: age)
end
end
```
- The `with_service` controller helper, handling success and failure of the service within a service and making easy to return proper response to it from the controller
```ruby
def update
with_service(UpdateAge) do
on_success { render_serialized(result.user, BasicUserSerializer, root: "user") }
end
end
```
- Rspec matchers and steps inspector, improving the dev experience while creating specs for a service
```ruby
RSpec.describe(UpdateAge) do
subject(:result) do
described_class.call(guardian: guardian, user_id: user.id, age: age)
end
fab!(:user) { Fabricate(:user) }
fab!(:current_user) { Fabricate(:admin) }
let(:guardian) { Guardian.new(current_user) }
let(:age) { 1 }
it { expect(user.reload.age).to eq(age) }
end
```
Note in case of unexpected failure in your spec, the output will give all the relevant information:
```
1) UpdateAge when no channel_id is given is expected to fail to find a model named 'user'
Failure/Error: it { is_expected.to fail_to_find_a_model(:user) }
Expected model 'foo' (key: 'result.model.user') was not found in the result object.
[1/4] [model] 'user' ❌
[2/4] [policy] 'can_see_user'
[3/4] [contract] 'default'
[4/4] [step] 'update_age'
/Users/joffreyjaffeux/Code/pr-discourse/plugins/chat/app/services/update_age.rb:32:in `fetch_user': missing keyword: :user_id (ArgumentError)
from /Users/joffreyjaffeux/Code/pr-discourse/plugins/chat/app/services/base.rb:202:in `instance_exec'
from /Users/joffreyjaffeux/Code/pr-discourse/plugins/chat/app/services/base.rb:202:in `call'
from /Users/joffreyjaffeux/Code/pr-discourse/plugins/chat/app/services/base.rb:219:in `call'
from /Users/joffreyjaffeux/Code/pr-discourse/plugins/chat/app/services/base.rb:417:in `block in run!'
from /Users/joffreyjaffeux/Code/pr-discourse/plugins/chat/app/services/base.rb:417:in `each'
from /Users/joffreyjaffeux/Code/pr-discourse/plugins/chat/app/services/base.rb:417:in `run!'
from /Users/joffreyjaffeux/Code/pr-discourse/plugins/chat/app/services/base.rb:411:in `run'
from <internal:kernel>:90:in `tap'
from /Users/joffreyjaffeux/Code/pr-discourse/plugins/chat/app/services/base.rb:302:in `call'
from /Users/joffreyjaffeux/Code/pr-discourse/plugins/chat/spec/services/update_age_spec.rb:15:in `block (3 levels) in <main>'
```
2023-02-13 20:09:57 +08:00
|
|
|
load File.expand_path("../lib/endpoint.rb", __FILE__)
|
|
|
|
|
load File.expand_path("../lib/steps_inspector.rb", __FILE__)
|
2022-11-02 21:41:30 +08:00
|
|
|
load File.expand_path("../app/jobs/regular/auto_manage_channel_memberships.rb", __FILE__)
|
|
|
|
|
load File.expand_path("../app/jobs/regular/auto_join_channel_batch.rb", __FILE__)
|
|
|
|
|
load File.expand_path("../app/jobs/regular/process_chat_message.rb", __FILE__)
|
|
|
|
|
load File.expand_path("../app/jobs/regular/chat_channel_archive.rb", __FILE__)
|
|
|
|
|
load File.expand_path("../app/jobs/regular/chat_channel_delete.rb", __FILE__)
|
|
|
|
|
load File.expand_path("../app/jobs/regular/chat_notify_mentioned.rb", __FILE__)
|
|
|
|
|
load File.expand_path("../app/jobs/regular/chat_notify_watching.rb", __FILE__)
|
|
|
|
|
load File.expand_path("../app/jobs/regular/update_channel_user_count.rb", __FILE__)
|
2022-11-29 00:32:57 +08:00
|
|
|
load File.expand_path("../app/jobs/regular/delete_user_messages.rb", __FILE__)
|
2023-01-02 22:54:52 +08:00
|
|
|
load File.expand_path("../app/jobs/regular/send_message_notifications.rb", __FILE__)
|
2022-11-02 21:41:30 +08:00
|
|
|
load File.expand_path("../app/jobs/scheduled/delete_old_chat_messages.rb", __FILE__)
|
|
|
|
|
load File.expand_path("../app/jobs/scheduled/update_user_counts_for_chat_channels.rb", __FILE__)
|
|
|
|
|
load File.expand_path("../app/jobs/scheduled/email_chat_notifications.rb", __FILE__)
|
|
|
|
|
load File.expand_path("../app/jobs/scheduled/auto_join_users.rb", __FILE__)
|
2022-12-06 06:40:46 +08:00
|
|
|
load File.expand_path("../app/jobs/scheduled/chat_periodical_updates.rb", __FILE__)
|
2022-11-02 21:41:30 +08:00
|
|
|
load File.expand_path("../app/services/chat_publisher.rb", __FILE__)
|
DEV: Chat service object initial implementation (#19814)
This is a combined work of Martin Brennan, Loïc Guitaut, and Joffrey Jaffeux.
---
This commit implements a base service object when working in chat. The documentation is available at https://discourse.github.io/discourse/chat/backend/Chat/Service.html
Generating documentation has been made as part of this commit with a bigger goal in mind of generally making it easier to dive into the chat project.
Working with services generally involves 3 parts:
- The service object itself, which is a series of steps where few of them are specialized (model, transaction, policy)
```ruby
class UpdateAge
include Chat::Service::Base
model :user, :fetch_user
policy :can_see_user
contract
step :update_age
class Contract
attribute :age, :integer
end
def fetch_user(user_id:, **)
User.find_by(id: user_id)
end
def can_see_user(guardian:, **)
guardian.can_see_user(user)
end
def update_age(age:, **)
user.update!(age: age)
end
end
```
- The `with_service` controller helper, handling success and failure of the service within a service and making easy to return proper response to it from the controller
```ruby
def update
with_service(UpdateAge) do
on_success { render_serialized(result.user, BasicUserSerializer, root: "user") }
end
end
```
- Rspec matchers and steps inspector, improving the dev experience while creating specs for a service
```ruby
RSpec.describe(UpdateAge) do
subject(:result) do
described_class.call(guardian: guardian, user_id: user.id, age: age)
end
fab!(:user) { Fabricate(:user) }
fab!(:current_user) { Fabricate(:admin) }
let(:guardian) { Guardian.new(current_user) }
let(:age) { 1 }
it { expect(user.reload.age).to eq(age) }
end
```
Note in case of unexpected failure in your spec, the output will give all the relevant information:
```
1) UpdateAge when no channel_id is given is expected to fail to find a model named 'user'
Failure/Error: it { is_expected.to fail_to_find_a_model(:user) }
Expected model 'foo' (key: 'result.model.user') was not found in the result object.
[1/4] [model] 'user' ❌
[2/4] [policy] 'can_see_user'
[3/4] [contract] 'default'
[4/4] [step] 'update_age'
/Users/joffreyjaffeux/Code/pr-discourse/plugins/chat/app/services/update_age.rb:32:in `fetch_user': missing keyword: :user_id (ArgumentError)
from /Users/joffreyjaffeux/Code/pr-discourse/plugins/chat/app/services/base.rb:202:in `instance_exec'
from /Users/joffreyjaffeux/Code/pr-discourse/plugins/chat/app/services/base.rb:202:in `call'
from /Users/joffreyjaffeux/Code/pr-discourse/plugins/chat/app/services/base.rb:219:in `call'
from /Users/joffreyjaffeux/Code/pr-discourse/plugins/chat/app/services/base.rb:417:in `block in run!'
from /Users/joffreyjaffeux/Code/pr-discourse/plugins/chat/app/services/base.rb:417:in `each'
from /Users/joffreyjaffeux/Code/pr-discourse/plugins/chat/app/services/base.rb:417:in `run!'
from /Users/joffreyjaffeux/Code/pr-discourse/plugins/chat/app/services/base.rb:411:in `run'
from <internal:kernel>:90:in `tap'
from /Users/joffreyjaffeux/Code/pr-discourse/plugins/chat/app/services/base.rb:302:in `call'
from /Users/joffreyjaffeux/Code/pr-discourse/plugins/chat/spec/services/update_age_spec.rb:15:in `block (3 levels) in <main>'
```
2023-02-13 20:09:57 +08:00
|
|
|
load File.expand_path("../app/services/trash_channel.rb", __FILE__)
|
|
|
|
|
load File.expand_path("../app/services/update_channel.rb", __FILE__)
|
|
|
|
|
load File.expand_path("../app/services/update_channel_status.rb", __FILE__)
|
2022-11-29 00:32:57 +08:00
|
|
|
load File.expand_path("../app/services/chat_message_destroyer.rb", __FILE__)
|
DEV: Chat service object initial implementation (#19814)
This is a combined work of Martin Brennan, Loïc Guitaut, and Joffrey Jaffeux.
---
This commit implements a base service object when working in chat. The documentation is available at https://discourse.github.io/discourse/chat/backend/Chat/Service.html
Generating documentation has been made as part of this commit with a bigger goal in mind of generally making it easier to dive into the chat project.
Working with services generally involves 3 parts:
- The service object itself, which is a series of steps where few of them are specialized (model, transaction, policy)
```ruby
class UpdateAge
include Chat::Service::Base
model :user, :fetch_user
policy :can_see_user
contract
step :update_age
class Contract
attribute :age, :integer
end
def fetch_user(user_id:, **)
User.find_by(id: user_id)
end
def can_see_user(guardian:, **)
guardian.can_see_user(user)
end
def update_age(age:, **)
user.update!(age: age)
end
end
```
- The `with_service` controller helper, handling success and failure of the service within a service and making easy to return proper response to it from the controller
```ruby
def update
with_service(UpdateAge) do
on_success { render_serialized(result.user, BasicUserSerializer, root: "user") }
end
end
```
- Rspec matchers and steps inspector, improving the dev experience while creating specs for a service
```ruby
RSpec.describe(UpdateAge) do
subject(:result) do
described_class.call(guardian: guardian, user_id: user.id, age: age)
end
fab!(:user) { Fabricate(:user) }
fab!(:current_user) { Fabricate(:admin) }
let(:guardian) { Guardian.new(current_user) }
let(:age) { 1 }
it { expect(user.reload.age).to eq(age) }
end
```
Note in case of unexpected failure in your spec, the output will give all the relevant information:
```
1) UpdateAge when no channel_id is given is expected to fail to find a model named 'user'
Failure/Error: it { is_expected.to fail_to_find_a_model(:user) }
Expected model 'foo' (key: 'result.model.user') was not found in the result object.
[1/4] [model] 'user' ❌
[2/4] [policy] 'can_see_user'
[3/4] [contract] 'default'
[4/4] [step] 'update_age'
/Users/joffreyjaffeux/Code/pr-discourse/plugins/chat/app/services/update_age.rb:32:in `fetch_user': missing keyword: :user_id (ArgumentError)
from /Users/joffreyjaffeux/Code/pr-discourse/plugins/chat/app/services/base.rb:202:in `instance_exec'
from /Users/joffreyjaffeux/Code/pr-discourse/plugins/chat/app/services/base.rb:202:in `call'
from /Users/joffreyjaffeux/Code/pr-discourse/plugins/chat/app/services/base.rb:219:in `call'
from /Users/joffreyjaffeux/Code/pr-discourse/plugins/chat/app/services/base.rb:417:in `block in run!'
from /Users/joffreyjaffeux/Code/pr-discourse/plugins/chat/app/services/base.rb:417:in `each'
from /Users/joffreyjaffeux/Code/pr-discourse/plugins/chat/app/services/base.rb:417:in `run!'
from /Users/joffreyjaffeux/Code/pr-discourse/plugins/chat/app/services/base.rb:411:in `run'
from <internal:kernel>:90:in `tap'
from /Users/joffreyjaffeux/Code/pr-discourse/plugins/chat/app/services/base.rb:302:in `call'
from /Users/joffreyjaffeux/Code/pr-discourse/plugins/chat/spec/services/update_age_spec.rb:15:in `block (3 levels) in <main>'
```
2023-02-13 20:09:57 +08:00
|
|
|
load File.expand_path("../app/services/update_user_last_read.rb", __FILE__)
|
2023-02-17 02:17:26 +08:00
|
|
|
load File.expand_path("../app/services/lookup_thread.rb", __FILE__)
|
2022-11-02 21:41:30 +08:00
|
|
|
load File.expand_path("../app/controllers/api_controller.rb", __FILE__)
|
|
|
|
|
load File.expand_path("../app/controllers/api/chat_channels_controller.rb", __FILE__)
|
DEV: start glimmer-ification and optimisations of chat plugin (#19531)
Note this is a very large PR, and some of it could have been splited, but keeping it one chunk made it to merge conflicts and to revert if necessary. Actual new code logic is also not that much, as most of the changes are removing js tests, adding system specs or moving things around.
To make it possible this commit is doing the following changes:
- converting (and adding new) existing js acceptances tests into system tests. This change was necessary to ensure as little regressions as possible while changing paradigm
- moving away from store. Using glimmer and tracked properties requires to have class objects everywhere and as a result works well with models. However store/adapters are suffering from many bugs and limitations. As a workaround the `chat-api` and `chat-channels-manager` are an answer to this problem by encapsulating backend calls and frontend storage logic; while still using js models.
- dropping `appEvents` as much as possible. Using tracked properties and a better local storage of channel models, allows to be much more reactive and doesn’t require arbitrary manual updates everywhere in the app.
- while working on replacing store, the existing work of a chat api (backend) has been continued to support more cases.
- removing code from the `chat` service to separate concerns, `chat-subscriptions-manager` and `chat-channels-manager`, being the largest examples of where the code has been rewritten/moved.
Future wok:
- improve behavior when closing/deleting a channel, it's already slightly buggy on live, it's rare enough that it's not a big issue, but should be improved
- improve page objects used in chat
- move more endpoints to the API
- finish temporarily skipped tests
- extract more code from the `chat` service
- use glimmer for `chat-messages`
- separate concerns in `chat-live-pane`
- eventually add js tests for `chat-api`, `chat-channels-manager` and `chat-subscriptions-manager`, they are indirectly heavy tested through system tests but it would be nice to at least test the public API
<!-- NOTE: All pull requests should have tests (rspec in Ruby, qunit in JavaScript). If your code does not include test coverage, please include an explanation of why it was omitted. -->
2022-12-21 20:21:02 +08:00
|
|
|
load File.expand_path("../app/controllers/api/chat_current_user_channels_controller.rb", __FILE__)
|
2022-11-02 21:41:30 +08:00
|
|
|
load File.expand_path(
|
DEV: start glimmer-ification and optimisations of chat plugin (#19531)
Note this is a very large PR, and some of it could have been splited, but keeping it one chunk made it to merge conflicts and to revert if necessary. Actual new code logic is also not that much, as most of the changes are removing js tests, adding system specs or moving things around.
To make it possible this commit is doing the following changes:
- converting (and adding new) existing js acceptances tests into system tests. This change was necessary to ensure as little regressions as possible while changing paradigm
- moving away from store. Using glimmer and tracked properties requires to have class objects everywhere and as a result works well with models. However store/adapters are suffering from many bugs and limitations. As a workaround the `chat-api` and `chat-channels-manager` are an answer to this problem by encapsulating backend calls and frontend storage logic; while still using js models.
- dropping `appEvents` as much as possible. Using tracked properties and a better local storage of channel models, allows to be much more reactive and doesn’t require arbitrary manual updates everywhere in the app.
- while working on replacing store, the existing work of a chat api (backend) has been continued to support more cases.
- removing code from the `chat` service to separate concerns, `chat-subscriptions-manager` and `chat-channels-manager`, being the largest examples of where the code has been rewritten/moved.
Future wok:
- improve behavior when closing/deleting a channel, it's already slightly buggy on live, it's rare enough that it's not a big issue, but should be improved
- improve page objects used in chat
- move more endpoints to the API
- finish temporarily skipped tests
- extract more code from the `chat` service
- use glimmer for `chat-messages`
- separate concerns in `chat-live-pane`
- eventually add js tests for `chat-api`, `chat-channels-manager` and `chat-subscriptions-manager`, they are indirectly heavy tested through system tests but it would be nice to at least test the public API
<!-- NOTE: All pull requests should have tests (rspec in Ruby, qunit in JavaScript). If your code does not include test coverage, please include an explanation of why it was omitted. -->
2022-12-21 20:21:02 +08:00
|
|
|
"../app/controllers/api/chat_channels_current_user_membership_controller.rb",
|
|
|
|
|
__FILE__,
|
|
|
|
|
)
|
|
|
|
|
load File.expand_path("../app/controllers/api/chat_channels_memberships_controller.rb", __FILE__)
|
|
|
|
|
load File.expand_path(
|
|
|
|
|
"../app/controllers/api/chat_channels_messages_moves_controller.rb",
|
|
|
|
|
__FILE__,
|
|
|
|
|
)
|
|
|
|
|
load File.expand_path("../app/controllers/api/chat_channels_archives_controller.rb", __FILE__)
|
|
|
|
|
load File.expand_path("../app/controllers/api/chat_channels_status_controller.rb", __FILE__)
|
|
|
|
|
load File.expand_path(
|
|
|
|
|
"../app/controllers/api/chat_channels_current_user_notifications_settings_controller.rb",
|
2022-11-02 21:41:30 +08:00
|
|
|
__FILE__,
|
|
|
|
|
)
|
|
|
|
|
load File.expand_path("../app/controllers/api/category_chatables_controller.rb", __FILE__)
|
2022-12-07 01:54:04 +08:00
|
|
|
load File.expand_path("../app/controllers/api/hints_controller.rb", __FILE__)
|
2023-02-14 09:38:41 +08:00
|
|
|
load File.expand_path("../app/controllers/api/chat_channel_threads_controller.rb", __FILE__)
|
DEV: start glimmer-ification and optimisations of chat plugin (#19531)
Note this is a very large PR, and some of it could have been splited, but keeping it one chunk made it to merge conflicts and to revert if necessary. Actual new code logic is also not that much, as most of the changes are removing js tests, adding system specs or moving things around.
To make it possible this commit is doing the following changes:
- converting (and adding new) existing js acceptances tests into system tests. This change was necessary to ensure as little regressions as possible while changing paradigm
- moving away from store. Using glimmer and tracked properties requires to have class objects everywhere and as a result works well with models. However store/adapters are suffering from many bugs and limitations. As a workaround the `chat-api` and `chat-channels-manager` are an answer to this problem by encapsulating backend calls and frontend storage logic; while still using js models.
- dropping `appEvents` as much as possible. Using tracked properties and a better local storage of channel models, allows to be much more reactive and doesn’t require arbitrary manual updates everywhere in the app.
- while working on replacing store, the existing work of a chat api (backend) has been continued to support more cases.
- removing code from the `chat` service to separate concerns, `chat-subscriptions-manager` and `chat-channels-manager`, being the largest examples of where the code has been rewritten/moved.
Future wok:
- improve behavior when closing/deleting a channel, it's already slightly buggy on live, it's rare enough that it's not a big issue, but should be improved
- improve page objects used in chat
- move more endpoints to the API
- finish temporarily skipped tests
- extract more code from the `chat` service
- use glimmer for `chat-messages`
- separate concerns in `chat-live-pane`
- eventually add js tests for `chat-api`, `chat-channels-manager` and `chat-subscriptions-manager`, they are indirectly heavy tested through system tests but it would be nice to at least test the public API
<!-- NOTE: All pull requests should have tests (rspec in Ruby, qunit in JavaScript). If your code does not include test coverage, please include an explanation of why it was omitted. -->
2022-12-21 20:21:02 +08:00
|
|
|
load File.expand_path("../app/controllers/api/chat_chatables_controller.rb", __FILE__)
|
2022-11-02 21:41:30 +08:00
|
|
|
load File.expand_path("../app/queries/chat_channel_memberships_query.rb", __FILE__)
|
|
|
|
|
|
|
|
|
|
if Discourse.allow_dev_populate?
|
|
|
|
|
load File.expand_path("../lib/discourse_dev/public_channel.rb", __FILE__)
|
|
|
|
|
load File.expand_path("../lib/discourse_dev/direct_channel.rb", __FILE__)
|
|
|
|
|
load File.expand_path("../lib/discourse_dev/message.rb", __FILE__)
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
UserNotifications.append_view_path(File.expand_path("../app/views", __FILE__))
|
|
|
|
|
|
|
|
|
|
register_category_custom_field_type(Chat::HAS_CHAT_ENABLED, :boolean)
|
|
|
|
|
|
|
|
|
|
UserUpdater::OPTION_ATTR.push(:chat_enabled)
|
|
|
|
|
UserUpdater::OPTION_ATTR.push(:only_chat_push_notifications)
|
|
|
|
|
UserUpdater::OPTION_ATTR.push(:chat_sound)
|
|
|
|
|
UserUpdater::OPTION_ATTR.push(:ignore_channel_wide_mention)
|
|
|
|
|
UserUpdater::OPTION_ATTR.push(:chat_email_frequency)
|
|
|
|
|
|
|
|
|
|
register_reviewable_type ReviewableChatMessage
|
|
|
|
|
|
|
|
|
|
reloadable_patch do |plugin|
|
|
|
|
|
ReviewableScore.add_new_types([:needs_review])
|
|
|
|
|
|
|
|
|
|
Site.preloaded_category_custom_fields << Chat::HAS_CHAT_ENABLED
|
|
|
|
|
|
|
|
|
|
Guardian.prepend Chat::GuardianExtensions
|
|
|
|
|
UserNotifications.prepend Chat::UserNotificationsExtension
|
|
|
|
|
UserOption.prepend Chat::UserOptionExtension
|
|
|
|
|
Category.prepend Chat::CategoryExtension
|
|
|
|
|
User.prepend Chat::UserExtension
|
|
|
|
|
Jobs::UserEmail.prepend Chat::UserEmailExtension
|
|
|
|
|
Bookmark.register_bookmarkable(ChatMessageBookmarkable)
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
if Oneboxer.respond_to?(:register_local_handler)
|
|
|
|
|
Oneboxer.register_local_handler("chat/chat") do |url, route|
|
2023-02-01 23:39:23 +08:00
|
|
|
if route[:message_id].present?
|
|
|
|
|
message = ChatMessage.find_by(id: route[:message_id])
|
2022-11-02 21:41:30 +08:00
|
|
|
next if !message
|
|
|
|
|
|
|
|
|
|
chat_channel = message.chat_channel
|
|
|
|
|
user = message.user
|
|
|
|
|
next if !chat_channel || !user
|
|
|
|
|
else
|
|
|
|
|
chat_channel = ChatChannel.find_by(id: route[:channel_id])
|
|
|
|
|
next if !chat_channel
|
|
|
|
|
end
|
|
|
|
|
|
2022-12-19 08:35:28 +08:00
|
|
|
next if !Guardian.new.can_preview_chat_channel?(chat_channel)
|
2022-11-02 21:41:30 +08:00
|
|
|
|
|
|
|
|
name = (chat_channel.name if chat_channel.name.present?)
|
|
|
|
|
|
|
|
|
|
users =
|
|
|
|
|
chat_channel
|
|
|
|
|
.user_chat_channel_memberships
|
|
|
|
|
.includes(:user)
|
|
|
|
|
.where(user: User.activated.not_suspended.not_staged)
|
|
|
|
|
.limit(10)
|
|
|
|
|
.map do |membership|
|
|
|
|
|
{
|
|
|
|
|
username: membership.user.username,
|
|
|
|
|
avatar_url: membership.user.avatar_template_url.gsub("{size}", "60"),
|
|
|
|
|
}
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
remaining_user_count_str =
|
|
|
|
|
if chat_channel.user_count > users.size
|
|
|
|
|
I18n.t("chat.onebox.and_x_others", count: chat_channel.user_count - users.size)
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
args = {
|
|
|
|
|
url: url,
|
|
|
|
|
channel_id: chat_channel.id,
|
|
|
|
|
channel_name: name,
|
|
|
|
|
description: chat_channel.description,
|
|
|
|
|
user_count_str: I18n.t("chat.onebox.x_members", count: chat_channel.user_count),
|
|
|
|
|
users: users,
|
|
|
|
|
remaining_user_count_str: remaining_user_count_str,
|
|
|
|
|
is_category: chat_channel.chatable_type == "Category",
|
|
|
|
|
color: chat_channel.chatable_type == "Category" ? chat_channel.chatable.color : nil,
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
if message.present?
|
|
|
|
|
args[:message_id] = message.id
|
|
|
|
|
args[:username] = message.user.username
|
|
|
|
|
args[:avatar_url] = message.user.avatar_template_url.gsub("{size}", "20")
|
|
|
|
|
args[:cooked] = message.cooked
|
|
|
|
|
args[:created_at] = message.created_at
|
|
|
|
|
args[:created_at_str] = message.created_at.iso8601
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
Mustache.render(Chat.onebox_template, args)
|
|
|
|
|
end
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
if InlineOneboxer.respond_to?(:register_local_handler)
|
|
|
|
|
InlineOneboxer.register_local_handler("chat/chat") do |url, route|
|
2023-02-01 23:39:23 +08:00
|
|
|
if route[:message_id].present?
|
|
|
|
|
message = ChatMessage.find_by(id: route[:message_id])
|
2022-11-02 21:41:30 +08:00
|
|
|
next if !message
|
|
|
|
|
|
|
|
|
|
chat_channel = message.chat_channel
|
|
|
|
|
user = message.user
|
|
|
|
|
next if !chat_channel || !user
|
|
|
|
|
|
|
|
|
|
title =
|
|
|
|
|
I18n.t(
|
|
|
|
|
"chat.onebox.inline_to_message",
|
|
|
|
|
message_id: message.id,
|
|
|
|
|
chat_channel: chat_channel.name,
|
|
|
|
|
username: user.username,
|
|
|
|
|
)
|
|
|
|
|
else
|
|
|
|
|
chat_channel = ChatChannel.find_by(id: route[:channel_id])
|
|
|
|
|
next if !chat_channel
|
|
|
|
|
|
|
|
|
|
title =
|
|
|
|
|
if chat_channel.name.present?
|
|
|
|
|
I18n.t("chat.onebox.inline_to_channel", chat_channel: chat_channel.name)
|
|
|
|
|
end
|
|
|
|
|
end
|
|
|
|
|
|
2022-12-19 08:35:28 +08:00
|
|
|
next if !Guardian.new.can_preview_chat_channel?(chat_channel)
|
2022-11-02 21:41:30 +08:00
|
|
|
|
|
|
|
|
{ url: url, title: title }
|
|
|
|
|
end
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
if respond_to?(:register_upload_in_use)
|
|
|
|
|
register_upload_in_use do |upload|
|
|
|
|
|
ChatMessage.where(
|
|
|
|
|
"message LIKE ? OR message LIKE ?",
|
|
|
|
|
"%#{upload.sha1}%",
|
|
|
|
|
"%#{upload.base62_sha1}%",
|
|
|
|
|
).exists? ||
|
|
|
|
|
ChatDraft.where(
|
|
|
|
|
"data LIKE ? OR data LIKE ?",
|
|
|
|
|
"%#{upload.sha1}%",
|
|
|
|
|
"%#{upload.base62_sha1}%",
|
|
|
|
|
).exists?
|
|
|
|
|
end
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
add_to_serializer(:user_card, :can_chat_user) do
|
|
|
|
|
return false if !SiteSetting.chat_enabled
|
|
|
|
|
return false if scope.user.blank?
|
|
|
|
|
|
2022-12-13 07:14:17 +08:00
|
|
|
scope.user.id != object.id && scope.can_chat? && Guardian.new(object).can_chat?
|
2022-11-02 21:41:30 +08:00
|
|
|
end
|
|
|
|
|
|
|
|
|
|
add_to_serializer(:current_user, :can_chat) { true }
|
|
|
|
|
|
|
|
|
|
add_to_serializer(:current_user, :include_can_chat?) do
|
|
|
|
|
return @can_chat if defined?(@can_chat)
|
|
|
|
|
|
2022-12-13 07:14:17 +08:00
|
|
|
@can_chat = SiteSetting.chat_enabled && scope.can_chat?
|
2022-11-02 21:41:30 +08:00
|
|
|
end
|
|
|
|
|
|
|
|
|
|
add_to_serializer(:current_user, :has_chat_enabled) { true }
|
|
|
|
|
|
|
|
|
|
add_to_serializer(:current_user, :include_has_chat_enabled?) do
|
|
|
|
|
return @has_chat_enabled if defined?(@has_chat_enabled)
|
|
|
|
|
|
|
|
|
|
@has_chat_enabled = include_can_chat? && object.user_option.chat_enabled
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
add_to_serializer(:current_user, :chat_sound) { object.user_option.chat_sound }
|
|
|
|
|
|
|
|
|
|
add_to_serializer(:current_user, :include_chat_sound?) do
|
|
|
|
|
include_has_chat_enabled? && object.user_option.chat_sound
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
add_to_serializer(:current_user, :needs_channel_retention_reminder) { true }
|
|
|
|
|
|
|
|
|
|
add_to_serializer(:current_user, :needs_dm_retention_reminder) { true }
|
|
|
|
|
|
|
|
|
|
add_to_serializer(:current_user, :has_joinable_public_channels) do
|
2022-12-19 15:34:07 +08:00
|
|
|
Chat::ChatChannelFetcher.secured_public_channel_search(
|
2022-11-02 21:41:30 +08:00
|
|
|
self.scope,
|
|
|
|
|
following: false,
|
|
|
|
|
limit: 1,
|
|
|
|
|
status: :open,
|
2022-12-19 15:34:07 +08:00
|
|
|
).exists?
|
2022-11-02 21:41:30 +08:00
|
|
|
end
|
|
|
|
|
|
|
|
|
|
add_to_serializer(:current_user, :chat_channels) do
|
|
|
|
|
structured = Chat::ChatChannelFetcher.structured(self.scope)
|
|
|
|
|
ChatChannelIndexSerializer.new(structured, scope: self.scope, root: false).as_json
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
add_to_serializer(:current_user, :include_needs_channel_retention_reminder?) do
|
|
|
|
|
include_has_chat_enabled? && object.staff? &&
|
|
|
|
|
!object.user_option.dismissed_channel_retention_reminder &&
|
|
|
|
|
!SiteSetting.chat_channel_retention_days.zero?
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
add_to_serializer(:current_user, :include_needs_dm_retention_reminder?) do
|
|
|
|
|
include_has_chat_enabled? && !object.user_option.dismissed_dm_retention_reminder &&
|
|
|
|
|
!SiteSetting.chat_dm_retention_days.zero?
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
add_to_serializer(:current_user, :chat_drafts) do
|
|
|
|
|
ChatDraft
|
|
|
|
|
.where(user_id: object.id)
|
2023-01-25 19:50:10 +08:00
|
|
|
.order(updated_at: :desc)
|
|
|
|
|
.limit(20)
|
2022-11-02 21:41:30 +08:00
|
|
|
.pluck(:chat_channel_id, :data)
|
|
|
|
|
.map { |row| { channel_id: row[0], data: row[1] } }
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
add_to_serializer(:current_user, :include_chat_drafts?) { include_has_chat_enabled? }
|
|
|
|
|
|
|
|
|
|
add_to_serializer(:user_option, :chat_enabled) { object.chat_enabled }
|
|
|
|
|
|
|
|
|
|
add_to_serializer(:user_option, :chat_sound) { object.chat_sound }
|
|
|
|
|
|
|
|
|
|
add_to_serializer(:user_option, :include_chat_sound?) { !object.chat_sound.blank? }
|
|
|
|
|
|
|
|
|
|
add_to_serializer(:user_option, :only_chat_push_notifications) do
|
|
|
|
|
object.only_chat_push_notifications
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
add_to_serializer(:user_option, :ignore_channel_wide_mention) do
|
|
|
|
|
object.ignore_channel_wide_mention
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
add_to_serializer(:user_option, :chat_email_frequency) { object.chat_email_frequency }
|
|
|
|
|
|
|
|
|
|
RETENTION_SETTINGS_TO_USER_OPTION_FIELDS = {
|
|
|
|
|
chat_channel_retention_days: :dismissed_channel_retention_reminder,
|
|
|
|
|
chat_dm_retention_days: :dismissed_dm_retention_reminder,
|
|
|
|
|
}
|
|
|
|
|
on(:site_setting_changed) do |name, old_value, new_value|
|
|
|
|
|
user_option_field = RETENTION_SETTINGS_TO_USER_OPTION_FIELDS[name.to_sym]
|
|
|
|
|
begin
|
|
|
|
|
if user_option_field && old_value != new_value && !new_value.zero?
|
|
|
|
|
UserOption.where(user_option_field => true).update_all(user_option_field => false)
|
|
|
|
|
end
|
|
|
|
|
rescue => e
|
|
|
|
|
Rails.logger.warn(
|
|
|
|
|
"Error updating user_options fields after chat retention settings changed: #{e}",
|
|
|
|
|
)
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
if name == :secure_uploads && old_value == false && new_value == true
|
|
|
|
|
Chat::SecureUploadsCompatibility.update_settings
|
|
|
|
|
end
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
on(:post_alerter_after_save_post) do |post, new_record, notified|
|
|
|
|
|
next if !new_record
|
|
|
|
|
Chat::PostNotificationHandler.new(post, notified).handle
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
register_presence_channel_prefix("chat") do |channel_name|
|
|
|
|
|
next nil unless channel_name == "/chat/online"
|
|
|
|
|
config = PresenceChannel::Config.new
|
|
|
|
|
config.allowed_group_ids = Chat.allowed_group_ids
|
|
|
|
|
config
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
register_presence_channel_prefix("chat-reply") do |channel_name|
|
|
|
|
|
if chat_channel_id = channel_name[%r{/chat-reply/(\d+)}, 1]
|
|
|
|
|
chat_channel = ChatChannel.find(chat_channel_id)
|
|
|
|
|
|
|
|
|
|
PresenceChannel::Config.new.tap do |config|
|
|
|
|
|
config.allowed_group_ids = chat_channel.allowed_group_ids
|
|
|
|
|
config.allowed_user_ids = chat_channel.allowed_user_ids
|
|
|
|
|
config.public = !chat_channel.read_restricted?
|
|
|
|
|
end
|
|
|
|
|
end
|
|
|
|
|
rescue ActiveRecord::RecordNotFound
|
|
|
|
|
nil
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
register_presence_channel_prefix("chat-user") do |channel_name|
|
|
|
|
|
if user_id = channel_name[%r{/chat-user/(chat|core)/(\d+)}, 2]
|
|
|
|
|
user = User.find(user_id)
|
|
|
|
|
config = PresenceChannel::Config.new
|
|
|
|
|
config.allowed_user_ids = [user.id]
|
|
|
|
|
config
|
|
|
|
|
end
|
|
|
|
|
rescue ActiveRecord::RecordNotFound
|
|
|
|
|
nil
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
CHAT_NOTIFICATION_TYPES = [Notification.types[:chat_mention], Notification.types[:chat_message]]
|
|
|
|
|
register_push_notification_filter do |user, payload|
|
|
|
|
|
if user.user_option.only_chat_push_notifications && user.user_option.chat_enabled
|
|
|
|
|
CHAT_NOTIFICATION_TYPES.include?(payload[:notification_type])
|
|
|
|
|
else
|
|
|
|
|
true
|
|
|
|
|
end
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
on(:user_seen) do |user|
|
|
|
|
|
if user.last_seen_at == user.first_seen_at
|
|
|
|
|
ChatChannel
|
|
|
|
|
.where(auto_join_users: true)
|
|
|
|
|
.each do |channel|
|
|
|
|
|
Chat::ChatChannelMembershipManager.new(channel).enforce_automatic_user_membership(user)
|
|
|
|
|
end
|
|
|
|
|
end
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
on(:user_confirmed_email) do |user|
|
|
|
|
|
if user.active?
|
|
|
|
|
ChatChannel
|
|
|
|
|
.where(auto_join_users: true)
|
|
|
|
|
.each do |channel|
|
|
|
|
|
Chat::ChatChannelMembershipManager.new(channel).enforce_automatic_user_membership(user)
|
|
|
|
|
end
|
|
|
|
|
end
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
on(:user_added_to_group) do |user, group|
|
|
|
|
|
channels_to_add =
|
|
|
|
|
ChatChannel
|
|
|
|
|
.distinct
|
|
|
|
|
.where(auto_join_users: true, chatable_type: "Category")
|
|
|
|
|
.joins(
|
|
|
|
|
"INNER JOIN category_groups ON category_groups.category_id = chat_channels.chatable_id",
|
|
|
|
|
)
|
|
|
|
|
.where(category_groups: { group_id: group.id })
|
|
|
|
|
|
|
|
|
|
channels_to_add.each do |channel|
|
|
|
|
|
Chat::ChatChannelMembershipManager.new(channel).enforce_automatic_user_membership(user)
|
|
|
|
|
end
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
on(:category_updated) do |category|
|
|
|
|
|
# TODO(roman): remove early return after 2.9 release.
|
|
|
|
|
# There's a bug on core where this event is triggered with an `#update` result (true/false)
|
|
|
|
|
return if !category.is_a?(Category)
|
|
|
|
|
category_channel = ChatChannel.find_by(auto_join_users: true, chatable: category)
|
|
|
|
|
|
|
|
|
|
if category_channel
|
|
|
|
|
Chat::ChatChannelMembershipManager.new(category_channel).enforce_automatic_channel_memberships
|
|
|
|
|
end
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
Chat::Engine.routes.draw do
|
DEV: start glimmer-ification and optimisations of chat plugin (#19531)
Note this is a very large PR, and some of it could have been splited, but keeping it one chunk made it to merge conflicts and to revert if necessary. Actual new code logic is also not that much, as most of the changes are removing js tests, adding system specs or moving things around.
To make it possible this commit is doing the following changes:
- converting (and adding new) existing js acceptances tests into system tests. This change was necessary to ensure as little regressions as possible while changing paradigm
- moving away from store. Using glimmer and tracked properties requires to have class objects everywhere and as a result works well with models. However store/adapters are suffering from many bugs and limitations. As a workaround the `chat-api` and `chat-channels-manager` are an answer to this problem by encapsulating backend calls and frontend storage logic; while still using js models.
- dropping `appEvents` as much as possible. Using tracked properties and a better local storage of channel models, allows to be much more reactive and doesn’t require arbitrary manual updates everywhere in the app.
- while working on replacing store, the existing work of a chat api (backend) has been continued to support more cases.
- removing code from the `chat` service to separate concerns, `chat-subscriptions-manager` and `chat-channels-manager`, being the largest examples of where the code has been rewritten/moved.
Future wok:
- improve behavior when closing/deleting a channel, it's already slightly buggy on live, it's rare enough that it's not a big issue, but should be improved
- improve page objects used in chat
- move more endpoints to the API
- finish temporarily skipped tests
- extract more code from the `chat` service
- use glimmer for `chat-messages`
- separate concerns in `chat-live-pane`
- eventually add js tests for `chat-api`, `chat-channels-manager` and `chat-subscriptions-manager`, they are indirectly heavy tested through system tests but it would be nice to at least test the public API
<!-- NOTE: All pull requests should have tests (rspec in Ruby, qunit in JavaScript). If your code does not include test coverage, please include an explanation of why it was omitted. -->
2022-12-21 20:21:02 +08:00
|
|
|
namespace :api, defaults: { format: :json } do
|
|
|
|
|
get "/chatables" => "chat_chatables#index"
|
|
|
|
|
get "/channels" => "chat_channels#index"
|
|
|
|
|
get "/channels/me" => "chat_current_user_channels#index"
|
|
|
|
|
post "/channels" => "chat_channels#create"
|
|
|
|
|
delete "/channels/:channel_id" => "chat_channels#destroy"
|
|
|
|
|
put "/channels/:channel_id" => "chat_channels#update"
|
|
|
|
|
get "/channels/:channel_id" => "chat_channels#show"
|
|
|
|
|
put "/channels/:channel_id/status" => "chat_channels_status#update"
|
|
|
|
|
post "/channels/:channel_id/messages/moves" => "chat_channels_messages_moves#create"
|
|
|
|
|
post "/channels/:channel_id/archives" => "chat_channels_archives#create"
|
|
|
|
|
get "/channels/:channel_id/memberships" => "chat_channels_memberships#index"
|
|
|
|
|
delete "/channels/:channel_id/memberships/me" =>
|
|
|
|
|
"chat_channels_current_user_membership#destroy"
|
|
|
|
|
post "/channels/:channel_id/memberships/me" => "chat_channels_current_user_membership#create"
|
|
|
|
|
put "/channels/:channel_id/notifications-settings/me" =>
|
|
|
|
|
"chat_channels_current_user_notifications_settings#update"
|
2022-11-02 21:41:30 +08:00
|
|
|
|
2022-12-07 01:54:04 +08:00
|
|
|
# Category chatables controller hints. Only used by staff members, we don't want to leak category permissions.
|
2022-11-02 21:41:30 +08:00
|
|
|
get "/category-chatables/:id/permissions" => "category_chatables#permissions",
|
|
|
|
|
:format => :json,
|
|
|
|
|
:constraints => StaffConstraint.new
|
2022-12-07 01:54:04 +08:00
|
|
|
|
|
|
|
|
# Hints for JIT warnings.
|
|
|
|
|
get "/mentions/groups" => "hints#check_group_mentions", :format => :json
|
2023-02-14 09:38:41 +08:00
|
|
|
|
|
|
|
|
get "/channels/:channel_id/threads/:thread_id" => "chat_channel_threads#show"
|
2022-11-02 21:41:30 +08:00
|
|
|
end
|
|
|
|
|
|
|
|
|
|
# direct_messages_controller routes
|
|
|
|
|
get "/direct_messages" => "direct_messages#index"
|
|
|
|
|
post "/direct_messages/create" => "direct_messages#create"
|
|
|
|
|
|
|
|
|
|
# incoming_webhooks_controller routes
|
|
|
|
|
post "/hooks/:key" => "incoming_chat_webhooks#create_message"
|
|
|
|
|
|
|
|
|
|
# incoming_webhooks_controller routes
|
|
|
|
|
post "/hooks/:key/slack" => "incoming_chat_webhooks#create_message_slack_compatible"
|
|
|
|
|
|
|
|
|
|
# chat_controller routes
|
|
|
|
|
get "/" => "chat#respond"
|
|
|
|
|
get "/browse" => "chat#respond"
|
|
|
|
|
get "/browse/all" => "chat#respond"
|
|
|
|
|
get "/browse/closed" => "chat#respond"
|
|
|
|
|
get "/browse/open" => "chat#respond"
|
|
|
|
|
get "/browse/archived" => "chat#respond"
|
|
|
|
|
get "/draft-channel" => "chat#respond"
|
|
|
|
|
post "/enable" => "chat#enable_chat"
|
|
|
|
|
post "/disable" => "chat#disable_chat"
|
|
|
|
|
post "/dismiss-retention-reminder" => "chat#dismiss_retention_reminder"
|
|
|
|
|
get "/:chat_channel_id/messages" => "chat#messages"
|
|
|
|
|
get "/message/:message_id" => "chat#message_link"
|
|
|
|
|
put ":chat_channel_id/edit/:message_id" => "chat#edit_message"
|
|
|
|
|
put ":chat_channel_id/react/:message_id" => "chat#react"
|
|
|
|
|
delete "/:chat_channel_id/:message_id" => "chat#delete"
|
|
|
|
|
put "/:chat_channel_id/:message_id/rebake" => "chat#rebake"
|
|
|
|
|
post "/:chat_channel_id/:message_id/flag" => "chat#flag"
|
|
|
|
|
post "/:chat_channel_id/quote" => "chat#quote_messages"
|
|
|
|
|
put "/:chat_channel_id/restore/:message_id" => "chat#restore"
|
|
|
|
|
get "/lookup/:message_id" => "chat#lookup_message"
|
|
|
|
|
put "/:chat_channel_id/read/:message_id" => "chat#update_user_last_read"
|
|
|
|
|
put "/user_chat_enabled/:user_id" => "chat#set_user_chat_status"
|
|
|
|
|
put "/:chat_channel_id/invite" => "chat#invite_users"
|
|
|
|
|
post "/drafts" => "chat#set_draft"
|
|
|
|
|
post "/:chat_channel_id" => "chat#create_message"
|
|
|
|
|
put "/flag" => "chat#flag"
|
|
|
|
|
get "/emojis" => "emojis#index"
|
2023-01-27 20:58:12 +08:00
|
|
|
|
|
|
|
|
base_c_route = "/c/:channel_title/:channel_id"
|
|
|
|
|
get base_c_route => "chat#respond", :as => "channel"
|
2023-02-01 23:39:23 +08:00
|
|
|
get "#{base_c_route}/:message_id" => "chat#respond"
|
2023-01-27 20:58:12 +08:00
|
|
|
|
|
|
|
|
%w[info info/about info/members info/settings].each do |route|
|
|
|
|
|
get "#{base_c_route}/#{route}" => "chat#respond"
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
# /channel -> /c redirects
|
|
|
|
|
get "/channel/:channel_id", to: redirect("/chat/c/-/%{channel_id}")
|
|
|
|
|
|
2023-02-14 09:38:41 +08:00
|
|
|
get "#{base_c_route}/t/:thread_id" => "chat#respond"
|
|
|
|
|
|
2023-01-27 20:58:12 +08:00
|
|
|
base_channel_route = "/channel/:channel_id/:channel_title"
|
|
|
|
|
redirect_base = "/chat/c/%{channel_title}/%{channel_id}"
|
|
|
|
|
|
|
|
|
|
get base_channel_route, to: redirect(redirect_base)
|
|
|
|
|
|
|
|
|
|
%w[info info/about info/members info/settings].each do |route|
|
|
|
|
|
get "#{base_channel_route}/#{route}", to: redirect("#{redirect_base}/#{route}")
|
|
|
|
|
end
|
2022-11-02 21:41:30 +08:00
|
|
|
end
|
|
|
|
|
|
|
|
|
|
Discourse::Application.routes.append do
|
|
|
|
|
mount ::Chat::Engine, at: "/chat"
|
|
|
|
|
get "/admin/plugins/chat" => "chat/admin_incoming_chat_webhooks#index",
|
|
|
|
|
:constraints => StaffConstraint.new
|
|
|
|
|
post "/admin/plugins/chat/hooks" => "chat/admin_incoming_chat_webhooks#create",
|
|
|
|
|
:constraints => StaffConstraint.new
|
|
|
|
|
put "/admin/plugins/chat/hooks/:incoming_chat_webhook_id" =>
|
|
|
|
|
"chat/admin_incoming_chat_webhooks#update",
|
|
|
|
|
:constraints => StaffConstraint.new
|
|
|
|
|
delete "/admin/plugins/chat/hooks/:incoming_chat_webhook_id" =>
|
|
|
|
|
"chat/admin_incoming_chat_webhooks#destroy",
|
|
|
|
|
:constraints => StaffConstraint.new
|
|
|
|
|
get "u/:username/preferences/chat" => "users#preferences",
|
|
|
|
|
:constraints => {
|
|
|
|
|
username: RouteFormat.username,
|
|
|
|
|
}
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
if defined?(DiscourseAutomation)
|
|
|
|
|
add_automation_scriptable("send_chat_message") do
|
|
|
|
|
field :chat_channel_id, component: :text, required: true
|
|
|
|
|
field :message, component: :message, required: true, accepts_placeholders: true
|
|
|
|
|
field :sender, component: :user
|
|
|
|
|
|
|
|
|
|
placeholder :channel_name
|
|
|
|
|
|
2022-11-11 22:58:05 +08:00
|
|
|
triggerables [:recurring]
|
|
|
|
|
|
2022-11-02 21:41:30 +08:00
|
|
|
script do |context, fields, automation|
|
|
|
|
|
sender = User.find_by(username: fields.dig("sender", "value")) || Discourse.system_user
|
|
|
|
|
channel = ChatChannel.find_by(id: fields.dig("chat_channel_id", "value"))
|
|
|
|
|
|
2022-11-11 22:58:05 +08:00
|
|
|
placeholders = { channel_name: channel.title(sender) }.merge(context["placeholders"] || {})
|
2022-11-02 21:41:30 +08:00
|
|
|
|
|
|
|
|
creator =
|
|
|
|
|
Chat::ChatMessageCreator.create(
|
|
|
|
|
chat_channel: channel,
|
|
|
|
|
user: sender,
|
|
|
|
|
content: utils.apply_placeholders(fields.dig("message", "value"), placeholders),
|
|
|
|
|
)
|
|
|
|
|
|
|
|
|
|
if creator.failed?
|
|
|
|
|
Rails.logger.warn "[discourse-automation] Chat message failed to send, error was: #{creator.error}"
|
|
|
|
|
end
|
|
|
|
|
end
|
|
|
|
|
end
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
add_api_key_scope(
|
|
|
|
|
:chat,
|
2022-11-04 22:06:24 +08:00
|
|
|
{ create_message: { actions: %w[chat/chat#create_message], params: %i[chat_channel_id] } },
|
2022-11-02 21:41:30 +08:00
|
|
|
)
|
|
|
|
|
|
|
|
|
|
# Dark mode email styles
|
|
|
|
|
Email::Styles.register_plugin_style do |fragment|
|
|
|
|
|
fragment.css(".chat-summary-header").each { |element| element[:dm] = "header" }
|
|
|
|
|
fragment.css(".chat-summary-content").each { |element| element[:dm] = "body" }
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
# TODO(roman): Remove `respond_to?` after 2.9 release
|
|
|
|
|
if respond_to?(:register_email_unsubscriber)
|
|
|
|
|
load File.expand_path("../lib/email_controller_helper/chat_summary_unsubscriber.rb", __FILE__)
|
|
|
|
|
register_email_unsubscriber("chat_summary", EmailControllerHelper::ChatSummaryUnsubscriber)
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
register_about_stat_group("chat_messages", show_in_ui: true) { Chat::Statistics.about_messages }
|
|
|
|
|
|
|
|
|
|
register_about_stat_group("chat_channels") { Chat::Statistics.about_channels }
|
|
|
|
|
|
|
|
|
|
register_about_stat_group("chat_users") { Chat::Statistics.about_users }
|
FEATURE: Generic hashtag autocomplete lookup and markdown cooking (#18937)
This commit fleshes out and adds functionality for the new `#hashtag` search and
lookup system, still hidden behind the `enable_experimental_hashtag_autocomplete`
feature flag.
**Serverside**
We have two plugin API registration methods that are used to define data sources
(`register_hashtag_data_source`) and hashtag result type priorities depending on
the context (`register_hashtag_type_in_context`). Reading the comments in plugin.rb
should make it clear what these are doing. Reading the `HashtagAutocompleteService`
in full will likely help a lot as well.
Each data source is responsible for providing its own **lookup** and **search**
method that returns hashtag results based on the arguments provided. For example,
the category hashtag data source has to take into account parent categories and
how they relate, and each data source has to define their own icon to use for the
hashtag, and so on.
The `Site` serializer has two new attributes that source data from `HashtagAutocompleteService`.
There is `hashtag_icons` that is just a simple array of all the different icons that
can be used for allowlisting in our markdown pipeline, and there is `hashtag_context_configurations`
that is used to store the type priority orders for each registered context.
When sending emails, we cannot render the SVG icons for hashtags, so
we need to change the HTML hashtags to the normal `#hashtag` text.
**Markdown**
The `hashtag-autocomplete.js` file is where I have added the new `hashtag-autocomplete`
markdown rule, and like all of our rules this is used to cook the raw text on both the clientside
and on the serverside using MiniRacer. Only on the server side do we actually reach out to
the database with the `hashtagLookup` function, on the clientside we just render a plainer
version of the hashtag HTML. Only in the composer preview do we do further lookups based
on this.
This rule is the first one (that I can find) that uses the `currentUser` based on a passed
in `user_id` for guardian checks in markdown rendering code. This is the `last_editor_id`
for both the post and chat message. In some cases we need to cook without a user present,
so the `Discourse.system_user` is used in this case.
**Chat Channels**
This also contains the changes required for chat so that chat channels can be used
as a data source for hashtag searches and lookups. This data source will only be
used when `enable_experimental_hashtag_autocomplete` is `true`, so we don't have
to worry about channel results suddenly turning up.
------
**Known Rough Edges**
- Onebox excerpts will not render the icon svg/use tags, I plan to address that in a follow up PR
- Selecting a hashtag + pressing the Quote button will result in weird behaviour, I plan to address that in a follow up PR
- Mixed hashtag contexts for hashtags without a type suffix will not work correctly, e.g. #ux which is both a category and a channel slug will resolve to a category when used inside a post or within a [chat] transcript in that post. Users can get around this manually by adding the correct suffix, for example ::channel. We may get to this at some point in future
- Icons will not show for the hashtags in emails since SVG support is so terrible in email (this is not likely to be resolved, but still noting for posterity)
- Additional refinements and review fixes wil
2022-11-21 06:37:06 +08:00
|
|
|
|
|
|
|
|
# Make sure to update spec/system/hashtag_autocomplete_spec.rb when changing this.
|
2022-12-19 11:46:17 +08:00
|
|
|
register_hashtag_data_source(Chat::ChatChannelHashtagDataSource)
|
|
|
|
|
register_hashtag_type_priority_for_context("channel", "chat-composer", 200)
|
|
|
|
|
register_hashtag_type_priority_for_context("category", "chat-composer", 100)
|
|
|
|
|
register_hashtag_type_priority_for_context("tag", "chat-composer", 50)
|
|
|
|
|
register_hashtag_type_priority_for_context("channel", "topic-composer", 10)
|
FEATURE: Generic hashtag autocomplete lookup and markdown cooking (#18937)
This commit fleshes out and adds functionality for the new `#hashtag` search and
lookup system, still hidden behind the `enable_experimental_hashtag_autocomplete`
feature flag.
**Serverside**
We have two plugin API registration methods that are used to define data sources
(`register_hashtag_data_source`) and hashtag result type priorities depending on
the context (`register_hashtag_type_in_context`). Reading the comments in plugin.rb
should make it clear what these are doing. Reading the `HashtagAutocompleteService`
in full will likely help a lot as well.
Each data source is responsible for providing its own **lookup** and **search**
method that returns hashtag results based on the arguments provided. For example,
the category hashtag data source has to take into account parent categories and
how they relate, and each data source has to define their own icon to use for the
hashtag, and so on.
The `Site` serializer has two new attributes that source data from `HashtagAutocompleteService`.
There is `hashtag_icons` that is just a simple array of all the different icons that
can be used for allowlisting in our markdown pipeline, and there is `hashtag_context_configurations`
that is used to store the type priority orders for each registered context.
When sending emails, we cannot render the SVG icons for hashtags, so
we need to change the HTML hashtags to the normal `#hashtag` text.
**Markdown**
The `hashtag-autocomplete.js` file is where I have added the new `hashtag-autocomplete`
markdown rule, and like all of our rules this is used to cook the raw text on both the clientside
and on the serverside using MiniRacer. Only on the server side do we actually reach out to
the database with the `hashtagLookup` function, on the clientside we just render a plainer
version of the hashtag HTML. Only in the composer preview do we do further lookups based
on this.
This rule is the first one (that I can find) that uses the `currentUser` based on a passed
in `user_id` for guardian checks in markdown rendering code. This is the `last_editor_id`
for both the post and chat message. In some cases we need to cook without a user present,
so the `Discourse.system_user` is used in this case.
**Chat Channels**
This also contains the changes required for chat so that chat channels can be used
as a data source for hashtag searches and lookups. This data source will only be
used when `enable_experimental_hashtag_autocomplete` is `true`, so we don't have
to worry about channel results suddenly turning up.
------
**Known Rough Edges**
- Onebox excerpts will not render the icon svg/use tags, I plan to address that in a follow up PR
- Selecting a hashtag + pressing the Quote button will result in weird behaviour, I plan to address that in a follow up PR
- Mixed hashtag contexts for hashtags without a type suffix will not work correctly, e.g. #ux which is both a category and a channel slug will resolve to a category when used inside a post or within a [chat] transcript in that post. Users can get around this manually by adding the correct suffix, for example ::channel. We may get to this at some point in future
- Icons will not show for the hashtags in emails since SVG support is so terrible in email (this is not likely to be resolved, but still noting for posterity)
- Additional refinements and review fixes wil
2022-11-21 06:37:06 +08:00
|
|
|
|
|
|
|
|
Site.markdown_additional_options["chat"] = {
|
|
|
|
|
limited_pretty_text_features: ChatMessage::MARKDOWN_FEATURES,
|
|
|
|
|
limited_pretty_text_markdown_rules: ChatMessage::MARKDOWN_IT_RULES,
|
|
|
|
|
hashtag_configurations: HashtagAutocompleteService.contexts_with_ordered_types,
|
|
|
|
|
}
|
2022-11-29 00:32:57 +08:00
|
|
|
|
|
|
|
|
register_user_destroyer_on_content_deletion_callback(
|
DEV: start glimmer-ification and optimisations of chat plugin (#19531)
Note this is a very large PR, and some of it could have been splited, but keeping it one chunk made it to merge conflicts and to revert if necessary. Actual new code logic is also not that much, as most of the changes are removing js tests, adding system specs or moving things around.
To make it possible this commit is doing the following changes:
- converting (and adding new) existing js acceptances tests into system tests. This change was necessary to ensure as little regressions as possible while changing paradigm
- moving away from store. Using glimmer and tracked properties requires to have class objects everywhere and as a result works well with models. However store/adapters are suffering from many bugs and limitations. As a workaround the `chat-api` and `chat-channels-manager` are an answer to this problem by encapsulating backend calls and frontend storage logic; while still using js models.
- dropping `appEvents` as much as possible. Using tracked properties and a better local storage of channel models, allows to be much more reactive and doesn’t require arbitrary manual updates everywhere in the app.
- while working on replacing store, the existing work of a chat api (backend) has been continued to support more cases.
- removing code from the `chat` service to separate concerns, `chat-subscriptions-manager` and `chat-channels-manager`, being the largest examples of where the code has been rewritten/moved.
Future wok:
- improve behavior when closing/deleting a channel, it's already slightly buggy on live, it's rare enough that it's not a big issue, but should be improved
- improve page objects used in chat
- move more endpoints to the API
- finish temporarily skipped tests
- extract more code from the `chat` service
- use glimmer for `chat-messages`
- separate concerns in `chat-live-pane`
- eventually add js tests for `chat-api`, `chat-channels-manager` and `chat-subscriptions-manager`, they are indirectly heavy tested through system tests but it would be nice to at least test the public API
<!-- NOTE: All pull requests should have tests (rspec in Ruby, qunit in JavaScript). If your code does not include test coverage, please include an explanation of why it was omitted. -->
2022-12-21 20:21:02 +08:00
|
|
|
Proc.new { |user| Jobs.enqueue(:delete_user_messages, user_id: user.id) },
|
2022-11-29 00:32:57 +08:00
|
|
|
)
|
2022-11-02 21:41:30 +08:00
|
|
|
end
|
|
|
|
|
|
|
|
|
|
if Rails.env == "test"
|
|
|
|
|
Dir[Rails.root.join("plugins/chat/spec/support/**/*.rb")].each { |f| require f }
|
|
|
|
|
end
|