タグ説明移行 (#422) (#423)

Reviewed-on: #423
Co-authored-by: miteruzo <miteruzo@naver.com>

backend/app/controllers/tag_descriptions_controller.rb

@@ -0,0 +1,57 @@
+class TagDescriptionsController < ApplicationController
+  def show
+    description = TagDescription.find_by(tag_id: params[:id], language_code: 'ja')
+    return head :not_found unless description
+
+    render json: representation(description)
+  end
+
+  def show_by_title
+    tag_name = TagName.find_by(language_code: 'ja', name: params[:name].to_s.strip)
+    description = tag_name&.tag && TagDescription.find_by(tag: tag_name.tag, language_code: 'ja')
+    return head :not_found unless description
+
+    render json: representation(description)
+  end
+
+  def update
+    return head :unauthorized unless current_user
+    return head :forbidden unless current_user.gte_member?
+
+    body = params[:body].to_s
+    return render_unprocessable_entity('本文は必須です．', field: :body) if body.blank?
+
+    tag = Tag.find_by(id: params[:id])
+    return head :not_found unless tag
+
+    description = TagDescription.find_by(tag:, language_code: 'ja')
+
+    if description
+      TagDescriptionOperation.update!(tag:, body:, updated_by_user: current_user)
+      description.reload
+      render json: representation(description)
+    else
+      TagDescriptionOperation.create!(tag:, body:, created_by_user: current_user)
+      description = TagDescription.find_by!(tag:, language_code: 'ja')
+      render json: representation(description), status: :created
+    end
+  rescue ActiveRecord::RecordInvalid => e
+    render_validation_error e.record
+  rescue ActiveRecord::RecordNotUnique
+    render_record_not_unique
+  end
+
+  private
+
+  def representation description
+    description.as_json(only: [
+        :tag_id,
+        :language_code,
+        :body,
+        :version_no,
+        :created_by_user_id,
+        :updated_by_user_id,
+        :created_at,
+        :updated_at])
+  end
+end

backend/app/controllers/tags_controller.rb

@@ -464,7 +464,6 @@ class TagsController < ApplicationController
 
       old_name = tag.name(locale.language_code)
       name_changed = name != old_name
-      wiki_page = tag.tag_name(locale.language_code)&.wiki_page if name_changed
 
       if tag.deprecated? == deprecated
         tag.update!(category:)
@@ -485,9 +484,7 @@ class TagsController < ApplicationController
           tag,
           event_type: :update,
           created_by_user: current_user,
-          language_code: locale.language_code,
-          name_changed:,
-          wiki_page:)
+          language_code: locale.language_code)
     end
 
     render json: TagRepr.base(tag.reload, language_code: locale.language_code)
@@ -518,7 +515,6 @@ class TagsController < ApplicationController
 
       old_name = tag.name(locale.language_code)
       name_changed = name.present? && name != old_name
-      wiki_page = tag.tag_name(locale.language_code)&.wiki_page if name_changed
 
       rename_tag_name!(locale, tag, name) if name_changed
       tag.update!(category:) if category.present?
@@ -532,9 +528,7 @@ class TagsController < ApplicationController
           tag,
           event_type: :update,
           created_by_user: current_user,
-          language_code: locale.language_code,
-          name_changed:,
-          wiki_page:)
+          language_code: locale.language_code)
     end
 
     render json: TagRepr.base(tag.reload, language_code: locale.language_code)
@@ -722,19 +716,8 @@ class TagsController < ApplicationController
             language_code:))
   end
 
-  def record_tag_version! tag, event_type:, created_by_user:, language_code: 'ja',
-                          name_changed: false, wiki_page: nil
+  def record_tag_version! tag, event_type:, created_by_user:, language_code: 'ja'
     TagVersionRecorder.record!(tag:, event_type:, created_by_user:, language_code:)
-
-    return unless name_changed
-
-    wiki_page ||= tag.tag_name('ja')&.wiki_page
-    return unless wiki_page&.wiki_versions&.exists?
-
-    WikiVersionRecorder.record!(
-        page: wiki_page,
-        event_type: :update,
-        created_by_user:)
   end
 
   def validate_tag_rename locale, tag, name

backend/app/controllers/wiki_pages_controller.rb

@@ -2,47 +2,67 @@ class WikiPagesController < ApplicationController
   rescue_from Wiki::Commit::Conflict, with: :render_wiki_conflict
 
   def index
+    # 互換性のための化石リソース
+    # TODO: ヘルプおよびタグ・グループ追加後に，
+    # TODO: タグ説明とヘルプ、タグ・グループから取得する作りに変更する．
+    #
     title = params[:title].to_s.strip
-    if title.blank?
-      return render json: WikiPageRepr.base(
-          WikiPage.joins(:tag_name).includes(tag_name: :tag))
+    descriptions = TagDescription.where(language_code: 'ja')
+        .includes(tag: :tag_names)
+    pages = unmigrated_wiki_pages.includes(tag_name: :tag)
+
+    if title.present?
+      pattern = "%#{ ApplicationRecord.sanitize_sql_like(title) }%"
+      descriptions = descriptions.joins(tag: :tag_names)
+          .where(tag_names: { language_code: 'ja', primary_flg: true })
+          .where('tag_names.name LIKE ?', pattern).limit(20)
+      pages = pages.where('tag_names.name LIKE ?', pattern).limit(20)
     end
 
-    q = WikiPage.joins(:tag_name).includes(tag_name: :tag)
-        .where('tag_names.name LIKE ?', "%#{ WikiPage.sanitize_sql_like(title) }%")
-    render json: WikiPageRepr.base(q.limit(20))
+    json = descriptions.map { |description| WikiPageRepr.tag_description(description) }
+    json.concat(WikiPageRepr.base(pages))
+    json = json.first(20) if title.present?
+    render json:
   end
 
   def show
+    tag_description = TagDescription.find_by(id: params[:id])
+
+    return render_wiki_page_by_tag_description tag_description if tag_description
+
     page = WikiPage.joins(:tag_name)
                    .includes(tag_name: :tag)
                    .find_by(id: params[:id])
+
     render_wiki_page_or_404 page
   end
 
   def show_by_title
     title = params[:title].to_s.strip
+
+    tag_description = tag_description_by_title(title)
+
+    return render_wiki_page_by_tag_description tag_description if tag_description
+
     page = WikiPage.joins(:tag_name)
                    .includes(tag_name: :tag)
                    .find_by(tag_name: { name: title })
+
     render_wiki_page_or_404 page
   end
 
   def exists
-    if WikiPage.exists?(id: params[:id])
-      head :no_content
-    else
-      head :not_found
-    end
+    return head :no_content if TagDescription.exists?(id: params[:id])
+
+    head WikiPage.exists?(id: params[:id]) ? :no_content : :not_found
   end
 
   def exists_by_title
     title = params[:title].to_s.strip
-    if WikiPage.joins(:tag_name).exists?(tag_names: { name: title })
-      head :no_content
-    else
-      head :not_found
-    end
+    return head :no_content if tag_description_by_title(title)
+
+    exists = WikiPage.joins(:tag_name).exists?(tag_names: { name: title })
+    head exists ? :no_content : :not_found
   end
 
   def diff
@@ -52,12 +72,20 @@ class WikiPagesController < ApplicationController
     from = params[:from].presence
     to = params[:to].presence
 
-    page = WikiPage.joins(:tag_name).includes(tag_name: :tag).find(id)
-
-    from_rev = from && page.wiki_revisions.find(from)
-    to_rev = to ? page.wiki_revisions.find(to) : page.current_revision
-    if ((from_rev && !(from_rev.content?)) || !(to_rev&.content?))
-      return render_unprocessable_entity('差分を表示できない版です．')
+    description = TagDescription.find_by(id:)
+    if description
+      versions = description_versions(description)
+      from_rev = from && versions.find(from)
+      to_rev = to ? versions.find(to) : versions.find_by!(version_no: description.version_no)
+      resource = WikiPageRepr.tag_description(description)
+    else
+      page = WikiPage.joins(:tag_name).includes(tag_name: :tag).find(id)
+      from_rev = from && page.wiki_revisions.find(from)
+      to_rev = to ? page.wiki_revisions.find(to) : page.current_revision
+      if ((from_rev && !from_rev.content?) || !to_rev&.content?)
+        return render_unprocessable_entity('差分を表示できない版です．')
+      end
+      resource = WikiPageRepr.base(page)
     end
 
     diffs = Diff::LCS.sdiff(from_rev&.body&.lines || [], to_rev.body.lines)
@@ -75,9 +103,9 @@ class WikiPagesController < ApplicationController
       end
     }.flatten.compact
 
-    render json: { wiki_page_id:      page.id,
-                   title:             page.title,
-                   deprecated_at:     page.deprecated_at,
+    render json: { wiki_page_id:      resource.fetch('id'),
+                   title:             resource.fetch('title'),
+                   deprecated_at:     resource.fetch('deprecated_at'),
                    older_revision_id: from_rev&.id,
                    newer_revision_id: to_rev.id,
                    diff:              diff_json }
@@ -94,18 +122,24 @@ class WikiPagesController < ApplicationController
     return render_unprocessable_entity('タイトルは必須です．', field: :title) if title.blank?
     return render_unprocessable_entity('本文は必須です．', field: :body) if body.blank?
 
-    tag_name = TagName.find_or_create_by!(language_code: 'ja', name: title) do |name|
-      name.script_code = 'Jpan'
-      name.primary_flg = true
-      name.auto_generated = false
-    end
+    page = if title.include?(':')
+      ApplicationRecord.transaction do
+        tag_name = TagName.find_or_create_by!(language_code: 'ja', name: title) do |name|
+          name.script_code = 'Jpan'
+          name.primary_flg = true
+          name.auto_generated = false
+        end
 
-    page =
-        Wiki::Commit.create_content!(
-            tag_name:,
-            body:,
-            created_by_user: current_user,
-            message:)
+        Wiki::Commit.create_legacy_content!(
+            tag_name:, body:, created_by_user: current_user, message:)
+      end
+    else
+      tag_name = TagName.find_by(language_code: 'ja', name: title)
+      return render_unprocessable_entity field: :title unless tag_name&.tag
+
+      TagDescriptionOperation.create!(
+          tag: tag_name.tag, body:, created_by_user: current_user, message:)
+    end
 
     render json: WikiPageRepr.base(page), status: :created
   rescue ActiveRecord::RecordInvalid => e
@@ -132,7 +166,7 @@ class WikiPagesController < ApplicationController
 
       old_title = page.title
 
-      tag = Tag.find_by(tag_name_id: page.tag_name_id)
+      tag = page.tag_name.tag
 
       if tag && title != old_title
         TagVersioning.ensure_snapshot!(tag, created_by_user: current_user)
@@ -156,29 +190,35 @@ class WikiPagesController < ApplicationController
     head :ok
   end
 
-  def search
-    index
-  end
-
   def changes
     id = params[:id].presence
-    q = WikiRevision.joins(wiki_page: :tag_name)
-                    .includes(:created_user, wiki_page: { tag_name: :tag })
-                    .order(id: :desc)
-    q = q.where(wiki_page_id: id) if id
+    description = id && TagDescription.find_by(id:)
+    if description
+      return render json: description_changes(TagDescription.where(id: description.id))
+    end
 
-    render json: q.limit(200).map { |rev|
-      { revision_id:  rev.id,
-        pred:         rev.base_revision_id,
-        succ:         nil,
-        wiki_page:    { id: rev.wiki_page_id,
-                        title: rev.wiki_page.title,
-                        deprecated_at: rev.wiki_page.deprecated_at },
-        user:         rev.created_user && { id: rev.created_user.id, name: rev.created_user.name },
-        kind:         rev.kind,
-        message:      rev.message,
-        timestamp:    rev.created_at }
-    }.compact
+    pages = id ? WikiPage.where(id:) : unmigrated_wiki_pages
+    revisions = WikiRevision.joins(wiki_page: :tag_name)
+        .where(wiki_page_id: pages.select(:id))
+        .includes(:created_user, wiki_page: { tag_name: :tag })
+        .order(id: :desc).limit(200)
+    json = revisions.map { |rev|
+      { revision_id: rev.id,
+        pred: rev.base_revision_id,
+        succ: nil,
+        wiki_page: { id: rev.wiki_page_id,
+                     title: rev.wiki_page.title,
+                     deprecated_at: rev.wiki_page.deprecated_at },
+        user: rev.created_user && { id: rev.created_user.id, name: rev.created_user.name },
+        kind: rev.kind,
+        message: rev.message,
+        timestamp: rev.created_at }
+    }
+    unless id
+      json.concat(description_changes(TagDescription.where(language_code: 'ja')))
+      json.sort_by! { |row| -row[:revision_id] }
+    end
+    render json: json.first(200)
   end
 
   private
@@ -204,6 +244,67 @@ class WikiPagesController < ApplicationController
     render json: WikiPageRepr.base(page).merge(body:, revision_id:, pred:, succ:, updated_at:)
   end
 
+  def render_wiki_page_by_tag_description description
+    versions = description_versions(description)
+    historical = params[:version].present?
+    rev = historical ? versions.find_by(id: params[:version]) :
+        versions.find_by(version_no: description.version_no)
+    return head :not_found unless rev
+
+    pred = versions.find_by(version_no: rev.version_no - 1)&.id
+    succ = versions.find_by(version_no: rev.version_no + 1)&.id
+    body = historical ? rev.body : description.body
+    updated_at = historical ? rev.created_at : description.updated_at
+    render json: WikiPageRepr.tag_description(description).merge(
+        body:, revision_id: rev.id, pred:, succ:, updated_at:)
+  end
+
+  def description_versions description
+    TagDescriptionVersion.where(tag_id: description.tag_id,
+                                language_code: description.language_code)
+  end
+
+  def tag_description_by_title title
+    TagDescription.joins(tag: :tag_names)
+        .find_by(language_code: 'ja', tag_names: { language_code: 'ja', name: title })
+  end
+
+  def unmigrated_wiki_pages
+    descriptions = TagDescription.where(language_code: 'ja')
+    WikiPage.joins(:tag_name).where.not(id: descriptions.select(:id))
+        .where('tag_names.tag_id IS NULL OR tag_names.tag_id NOT IN (?)',
+               descriptions.select(:tag_id))
+  end
+
+  def description_changes descriptions
+    versions = TagDescriptionVersion.where(language_code: 'ja',
+                                           tag_id: descriptions.select(:tag_id))
+        .order(id: :desc).limit(200).to_a
+    return [] if versions.empty?
+
+    by_tag = descriptions.where(tag_id: versions.map(&:tag_id))
+        .includes(tag: :tag_names).index_by(&:tag_id)
+    users = User.where(id: versions.map(&:created_by_user_id)).index_by(&:id)
+    predecessors = TagDescriptionVersion.where(
+        language_code: 'ja', tag_id: by_tag.keys,
+        version_no: versions.map { |version| version.version_no - 1 })
+        .pluck(:tag_id, :version_no, :id)
+        .to_h { |tag_id, version_no, id| [[tag_id, version_no], id] }
+    versions.map do |version|
+      description = by_tag.fetch(version.tag_id)
+      user = users[version.created_by_user_id]
+      { revision_id: version.id,
+        pred: predecessors[[version.tag_id, version.version_no - 1]],
+        succ: nil,
+        wiki_page: { id: description.id, title: description.tag.name('ja'),
+                     deprecated_at: description.tag.deprecated_at },
+        user: user && { id: user.id, name: user.name },
+        kind: 'content',
+        message: nil,
+        timestamp: version.created_at }
+    end
+  end
+
   def find_revision page
     if params[:version].present?
       page.wiki_revisions.find_by(id: params[:version])

backend/app/models/tag_description.rb

@@ -0,0 +1,3 @@
+class TagDescription < ApplicationRecord
+  belongs_to :tag
+end

backend/app/models/tag_description_version.rb

@@ -0,0 +1,3 @@
+class TagDescriptionVersion < ApplicationRecord
+  ;
+end

backend/app/models/wiki_page.rb

@@ -48,8 +48,11 @@ class WikiPage < ApplicationRecord
     page
   end
 
-  def pred_revision_id(revision_id) =
-      wiki_revisions.where('id < ?', revision_id).order(id: :desc).limit(1).pick(:id)
-  def succ_revision_id(revision_id) =
-      wiki_revisions.where('id > ?', revision_id).order(id: :asc).limit(1).pick(:id)
+  def pred_revision_id revision_id
+    wiki_revisions.where('id < ?', revision_id).order(id: :desc).limit(1).pick(:id)
+  end
+
+  def succ_revision_id revision_id
+    wiki_revisions.where('id > ?', revision_id).order(id: :asc).limit(1).pick(:id)
+  end
 end

backend/app/representations/wiki_page_repr.rb

@@ -10,6 +10,21 @@ module WikiPageRepr
     wiki_page.as_json(BASE)
   end
 
+  def tag_description description
+    tag = description.tag
+    { 'id' => description.id,
+      'tag_name_id' => tag.tag_name('ja')&.id,
+      'body' => description.body,
+      'created_user_id' => description.created_by_user_id,
+      'updated_user_id' => description.updated_by_user_id,
+      'created_at' => description.created_at,
+      'updated_at' => description.updated_at,
+      'discarded_at' => nil,
+      'version_no' => description.version_no,
+      'title' => tag.name('ja'),
+      'deprecated_at' => tag.deprecated_at }
+  end
+
   def many wiki_pages
     wiki_pages.map { |p| base(p) }
   end

backend/app/services/tag_description_operation.rb

@@ -0,0 +1,54 @@
+class TagDescriptionOperation
+  LANGUAGE_CODE = 'ja'
+
+  def self.create!(tag:, body:, created_by_user:, message: nil)
+    ApplicationRecord.transaction do
+      tag.lock!
+      raise ActiveRecord::RecordNotUnique if TagDescription.exists?(
+          tag_id: tag.id, language_code: LANGUAGE_CODE)
+
+      page = Wiki::CompatibilityWriter.create!(
+          tag_name: tag.tag_name(LANGUAGE_CODE), body:, created_by_user:, message:)
+      revision = page.wiki_revisions.order(id: :desc).first
+      record_version!(tag:, revision:, body:, user: created_by_user,
+                      description: nil)
+      page
+    end
+  end
+
+  def self.update!(tag:, body:, updated_by_user:, message: nil,
+                   base_revision_id: nil)
+    ApplicationRecord.transaction do
+      tag.lock!
+      description = TagDescription.lock.find_by!(
+          tag_id: tag.id, language_code: LANGUAGE_CODE)
+      page = WikiPage.lock.find(description.id)
+      revision = Wiki::CompatibilityWriter.update!(
+          page:, body:, updated_by_user:, message:,
+          base_revision_id:)
+      next unless revision
+
+      record_version!(tag:, revision:, body: revision.body,
+                      user: updated_by_user, description:)
+      revision
+    end
+  end
+
+  def self.record_version! tag:, revision:, body:, user:, description:
+    version_no = description ? description.version_no + 1 : 1
+    TagDescriptionVersion.create!(
+        id: revision.id, tag_id: tag.id, language_code: LANGUAGE_CODE,
+        version_no:, event_type: description ? 'update' : 'create', body:,
+        created_by_user_id: user.id, created_at: revision.created_at)
+    if description
+      description.update!(body:, version_no:, updated_by_user_id: user.id)
+    else
+      TagDescription.create!(
+          id: revision.wiki_page_id, tag_id: tag.id,
+          language_code: LANGUAGE_CODE, version_no:, body:,
+          created_by_user_id: user.id, updated_by_user_id: user.id)
+    end
+  end
+
+  private_class_method :record_version!
+end

backend/app/services/wiki/commit.rb

@@ -8,6 +8,15 @@ module Wiki
     end
 
     def self.create_content! tag_name:, body:, created_by_user:, message: nil
+      if tag_name.tag && tag_name.language_code == 'ja'
+        return TagDescriptionOperation.create!(
+            tag: tag_name.tag, body:, created_by_user:, message:)
+      end
+
+      create_legacy_content!(tag_name:, body:, created_by_user:, message:)
+    end
+
+    def self.create_legacy_content! tag_name:, body:, created_by_user:, message: nil
       normalised = normalise_body(body)
 
       page = WikiPage.new(tag_name:,
@@ -33,6 +42,18 @@ module Wiki
     end
 
     def self.content! page:, body:, created_user:, message: nil, base_revision_id: nil
+      description = TagDescription.find_by(id: page.id)
+      if description
+        return TagDescriptionOperation.update!(
+            tag: description.tag, body:, updated_by_user: created_user,
+            message:, base_revision_id:)
+      end
+
+      legacy_content!(page:, body:, created_user:, message:, base_revision_id:)
+    end
+
+    def self.legacy_content! page:, body:, created_user:, message: nil,
+                             base_revision_id: nil
       new(page:, created_user:).content!(body:, message:, base_revision_id:)
     end
 
@@ -57,9 +78,6 @@ module Wiki
       line_shas = lines.map { |line| Digest::SHA256.hexdigest(line) }
       tree_sha = Digest::SHA256.hexdigest(line_shas.join(','))
 
-      line_id_by_sha = upsert_lines!(lines, line_shas)
-      line_ids = line_shas.map { |sha| line_id_by_sha.fetch(sha) }
-
       ActiveRecord::Base.transaction do
         @page.lock!
 
@@ -72,6 +90,8 @@ module Wiki
           end
         end
 
+        line_id_by_sha = upsert_lines!(lines, line_shas)
+        line_ids = line_shas.map { |sha| line_id_by_sha.fetch(sha) }
         @page.update!(body: normalised)
 
         WikiVersionRecorder.record!(
@@ -94,7 +114,6 @@ module Wiki
           { wiki_revision_id: rev.id, wiki_line_id: line_id, position: pos }
         end
         WikiRevisionLine.insert_all!(rows) if rows.any?
-
         rev
       end
     end

backend/app/services/wiki/compatibility_writer.rb

@@ -0,0 +1,33 @@
+module Wiki
+  class CompatibilityWriter
+    def self.create! tag_name:, body:, created_by_user:, message: nil
+      Commit.create_legacy_content!(
+          tag_name:, body:, created_by_user:, message:)
+    end
+
+    def self.update! page:, body:, updated_by_user:, message: nil,
+                     base_revision_id: nil
+      normalised = Commit.normalise_body(body)
+      if normalised.blank?
+        return Commit.legacy_content!(
+            page:, body: normalised, created_user: updated_by_user, message:,
+            base_revision_id:)
+      end
+
+      if base_revision_id.present?
+        current_id = page.wiki_revisions.maximum(:id)
+        if current_id && current_id != base_revision_id.to_i
+          raise Commit::Conflict,
+              "競合が発生してゐます" +
+              "（現在の Id.：#{ current_id }，ベース Id.：#{ base_revision_id }）．"
+        end
+      end
+
+      return if Commit.normalise_body(page.body) == normalised
+
+      Commit.legacy_content!(
+          page:, body: normalised, created_user: updated_by_user, message:,
+          base_revision_id:)
+    end
+  end
+end