mirror of
https://ghfast.top/https://github.com/discourse/discourse-shared-edits.git
synced 2026-05-07 18:32:26 +08:00
50d9317272
Major overhaul of the shared edits plugin to improve reliability, robustness, and developer experience: **Backend** - Extract Revise service for cleaner controller orchestration - Add StateValidator for base64/Yjs safety, corruption detection, and recovery - Centralize protocol constants (Ruby + JS) to avoid hardcoded strings - Add state hash sync verification and vector validation endpoints - Harden security (guardian checks), error handling, and resource cleanup - Resize shared edit columns migration; add state_hash column **Frontend** - Decompose shared-edit-manager into focused modules: yjs-document, markdown-sync, rich-mode-sync, network-manager, encoding-utils - Add cursor overlay and caret coordinate tracking for selection sharing - Add ProseMirror extension for rich-mode collaborative editing - Cache-busted Yjs bundle loading via hashed filenames - Fix scroll drift during sync **Testing & Tooling** - Extensive new specs: state_validator, revision_controller, model, revise service - New Ember acceptance tests: cursor, lifecycle, sync flows - Add support scripts: fake_writer (Playwright), state_corruptor, debug_recovery - Add support/lint wrapper for full CI lint suite - Update dependencies and rebuild Yjs/y-prosemirror bundles
58 lines
2.4 KiB
Ruby
58 lines
2.4 KiB
Ruby
# frozen_string_literal: true
|
|
|
|
# name: discourse-shared-edits
|
|
# about: Allows multiple users to collaboratively edit posts in real time.
|
|
# meta_topic_id: 167583
|
|
# version: 0.1.0
|
|
# authors: Sam Saffron
|
|
# url: https://github.com/discourse/discourse-shared-edits
|
|
|
|
enabled_site_setting :shared_edits_enabled
|
|
|
|
register_asset "stylesheets/common/discourse-shared-edits.scss"
|
|
|
|
after_initialize do
|
|
module ::DiscourseSharedEdits
|
|
SHARED_EDITS_ENABLED = "shared_edits_enabled"
|
|
PLUGIN_NAME = "discourse-shared-edits"
|
|
|
|
class Engine < ::Rails::Engine
|
|
engine_name PLUGIN_NAME
|
|
isolate_namespace ::DiscourseSharedEdits
|
|
end
|
|
end
|
|
|
|
require_relative "lib/discourse_shared_edits/yjs"
|
|
require_relative "lib/discourse_shared_edits/state_validator"
|
|
require_relative "lib/discourse_shared_edits/protocol"
|
|
require_relative "app/models/shared_edit_revision"
|
|
require_relative "app/controllers/discourse_shared_edits/revision_controller"
|
|
require_relative "app/services/discourse_shared_edits/revise"
|
|
require_relative "app/jobs/commit_shared_revision"
|
|
require_relative "lib/discourse_shared_edits/guardian_extension"
|
|
|
|
::DiscourseSharedEdits::Engine.routes.draw do
|
|
put "/p/:post_id/enable" => "revision#enable", :defaults => { format: :json }
|
|
put "/p/:post_id/disable" => "revision#disable", :defaults => { format: :json }
|
|
put "/p/:post_id" => "revision#revise", :defaults => { format: :json }
|
|
get "/p/:post_id" => "revision#latest", :defaults => { format: :json }
|
|
put "/p/:post_id/commit" => "revision#commit", :defaults => { format: :json }
|
|
get "/p/:post_id/health" => "revision#health", :defaults => { format: :json }
|
|
post "/p/:post_id/recover" => "revision#recover", :defaults => { format: :json }
|
|
post "/p/:post_id/reset" => "revision#reset", :defaults => { format: :json }
|
|
end
|
|
|
|
Discourse::Application.routes.append { mount ::DiscourseSharedEdits::Engine, at: "/shared_edits" }
|
|
|
|
reloadable_patch { Guardian.prepend(DiscourseSharedEdits::GuardianExtension) }
|
|
|
|
register_post_custom_field_type(DiscourseSharedEdits::SHARED_EDITS_ENABLED, :boolean)
|
|
register_post_custom_field_type("shared_edits_editor_usernames", :json)
|
|
topic_view_post_custom_fields_allowlister { [DiscourseSharedEdits::SHARED_EDITS_ENABLED] }
|
|
|
|
add_to_serializer(:post, :shared_edits_enabled) do
|
|
if SiteSetting.shared_edits_enabled
|
|
post_custom_fields[DiscourseSharedEdits::SHARED_EDITS_ENABLED]
|
|
end
|
|
end
|
|
end
|
