This is a document.
\nI am mentioning another user @andrei4
', 31 | mentioned_users: [ 32 | { 33 | id: mentionedUserId, 34 | username: "andrei4", 35 | name: "andrei", 36 | avatar_template: 37 | "/letter_avatar_proxy/v4/letter/a/a87d85/{size}.png", 38 | assign_icon: "user-plus", 39 | assign_path: "/u/andrei4/activity/assigned", 40 | }, 41 | ], 42 | }, 43 | ], 44 | stream: [427], 45 | }, 46 | }; 47 | 48 | return helper.response(docsFixtures); 49 | }); 50 | }); 51 | 52 | test("user status on mentions is live", async function (assert) { 53 | await visit("/docs?topic=1"); 54 | assert.dom(".mention .user-status").doesNotExist(); 55 | 56 | const newStatus = { emoji: "surfing_man", description: "surfing" }; 57 | await publishToMessageBus(`/user-status`, { [mentionedUserId]: newStatus }); 58 | 59 | assert 60 | .dom(`.mention .user-status-message .emoji[alt='${newStatus.emoji}']`) 61 | .exists(); 62 | await publishToMessageBus(`/user-status`, { [mentionedUserId]: null }); 63 | assert.dom(".mention .user-status").doesNotExist(); 64 | }); 65 | }); 66 | -------------------------------------------------------------------------------- /test/javascripts/acceptance/docs-sidebar-test.js: -------------------------------------------------------------------------------- 1 | import { click, currentURL, visit } from "@ember/test-helpers"; 2 | import { test } from "qunit"; 3 | import { cloneJSON } from "discourse/lib/object"; 4 | import { 5 | acceptance, 6 | exists, 7 | query, 8 | } from "discourse/tests/helpers/qunit-helpers"; 9 | import { i18n } from "discourse-i18n"; 10 | import docsFixtures from "../fixtures/docs"; 11 | 12 | let DOCS_URL_PATH = "docs"; 13 | 14 | acceptance("Docs - Sidebar with docs disabled", function (needs) { 15 | needs.user(); 16 | needs.site({ docs_path: DOCS_URL_PATH }); 17 | needs.settings({ 18 | docs_enabled: false, 19 | navigation_menu: "sidebar", 20 | }); 21 | 22 | test("docs sidebar link is hidden", async function (assert) { 23 | await visit("/"); 24 | 25 | await click( 26 | ".sidebar-section[data-section-name='community'] .sidebar-more-section-links-details-summary" 27 | ); 28 | 29 | assert.notOk( 30 | exists(".sidebar-section-link[data-link-name='docs']"), 31 | "it does not display the docs link in sidebar" 32 | ); 33 | }); 34 | }); 35 | 36 | acceptance("Docs - Sidebar with docs enabled", function (needs) { 37 | needs.user(); 38 | needs.site({ docs_path: DOCS_URL_PATH }); 39 | needs.settings({ 40 | docs_enabled: true, 41 | navigation_menu: "sidebar", 42 | }); 43 | 44 | needs.pretender((server, helper) => { 45 | server.get("/" + DOCS_URL_PATH + ".json", () => 46 | helper.response(cloneJSON(docsFixtures)) 47 | ); 48 | }); 49 | 50 | test("clicking on docs link", async function (assert) { 51 | await visit("/"); 52 | 53 | await click( 54 | ".sidebar-section[data-section-name='community'] .sidebar-more-section-links-details-summary" 55 | ); 56 | 57 | assert.strictEqual( 58 | query(".sidebar-section-link[data-link-name='docs']").textContent.trim(), 59 | i18n("sidebar.docs_link_text"), 60 | "displays the right text for the link" 61 | ); 62 | 63 | assert.strictEqual( 64 | query(".sidebar-section-link[data-link-name='docs']").title, 65 | i18n("sidebar.docs_link_title"), 66 | "displays the right title for the link" 67 | ); 68 | 69 | await click(".sidebar-section-link[data-link-name='docs']"); 70 | 71 | assert.strictEqual( 72 | currentURL(), 73 | "/" + DOCS_URL_PATH, 74 | "it navigates to the right page" 75 | ); 76 | }); 77 | }); 78 | -------------------------------------------------------------------------------- /spec/system/docs_index_spec.rb: -------------------------------------------------------------------------------- 1 | # frozen_string_literal: true 2 | 3 | describe "Discourse Docs | Index", type: :system do 4 | fab!(:category) 5 | fab!(:topic_1) { Fabricate(:topic, category: category) } 6 | fab!(:topic_2) { Fabricate(:topic, category: category) } 7 | fab!(:post_1) { Fabricate(:post, topic: topic_1) } 8 | fab!(:post_2) { Fabricate(:post, topic: topic_2) } 9 | 10 | before do 11 | SiteSetting.docs_enabled = true 12 | SiteSetting.docs_categories = category.id.to_s 13 | 14 | if SiteSetting.respond_to?(:tooltips_enabled) 15 | # Unfortunately this plugin is enabled by default, and it messes with the docs specs 16 | SiteSetting.tooltips_enabled = false 17 | end 18 | end 19 | 20 | it "does not error when showing the index" do 21 | visit("/docs") 22 | expect(page).to have_css(".raw-topic-link", text: topic_1.title) 23 | expect(page).to have_css(".raw-topic-link", text: topic_2.title) 24 | end 25 | 26 | describe "topic excerpts" do 27 | before do 28 | topic_1.update_excerpt(post_1.excerpt_for_topic) 29 | topic_2.update_excerpt(post_2.excerpt_for_topic) 30 | end 31 | 32 | context "when docs_show_topic_excerpts is false" do 33 | before { SiteSetting.always_include_topic_excerpts = false } 34 | 35 | it "does not show the topic excerpts by default" do 36 | visit("/docs") 37 | expect(page).to have_css(".topic-list-item", count: 2) 38 | expect(page).to have_no_css(".topic-excerpt") 39 | end 40 | end 41 | 42 | context "when docs_show_topic_excerpts is true" do 43 | before { SiteSetting.always_include_topic_excerpts = true } 44 | 45 | it "shows the excerpts" do 46 | visit("/docs") 47 | expect(page).to have_css(".topic-excerpt", text: topic_1.excerpt) 48 | expect(page).to have_css(".topic-excerpt", text: topic_2.excerpt) 49 | end 50 | end 51 | 52 | context "when the theme modifier serialize_topic_excerpts is true" do 53 | before do 54 | ThemeModifierSet.find_by(theme_id: SiteSetting.default_theme_id).update!( 55 | serialize_topic_excerpts: true, 56 | ) 57 | Theme.clear_cache! 58 | end 59 | 60 | after { Theme.clear_cache! } 61 | 62 | it "shows the excerpts" do 63 | visit("/docs") 64 | expect(page).to have_css(".topic-excerpt", text: topic_1.excerpt) 65 | expect(page).to have_css(".topic-excerpt", text: topic_2.excerpt) 66 | end 67 | end 68 | end 69 | end 70 | -------------------------------------------------------------------------------- /assets/javascripts/discourse/models/docs.js: -------------------------------------------------------------------------------- 1 | import EmberObject from "@ember/object"; 2 | import { ajax } from "discourse/lib/ajax"; 3 | import Site from "discourse/models/site"; 4 | import Topic from "discourse/models/topic"; 5 | import User from "discourse/models/user"; 6 | import { getDocs } from "../../lib/get-docs"; 7 | 8 | class Docs extends EmberObject {} 9 | const docsPath = getDocs(); 10 | 11 | Docs.reopenClass({ 12 | list(params) { 13 | let filters = []; 14 | 15 | if (params.filterCategories) { 16 | filters.push(`category=${params.filterCategories}`); 17 | } 18 | if (params.filterTags) { 19 | filters.push(`tags=${params.filterTags}`); 20 | } 21 | if (params.filterSolved) { 22 | filters.push(`solved=${params.filterSolved}`); 23 | } 24 | if (params.searchTerm) { 25 | filters.push(`search=${params.searchTerm}`); 26 | } 27 | if (params.ascending) { 28 | filters.push("ascending=true"); 29 | } 30 | if (params.orderColumn) { 31 | filters.push(`order=${params.orderColumn}`); 32 | } 33 | if (params.page) { 34 | filters.push(`page=${params.page}`); 35 | } 36 | if (params.selectedTopic) { 37 | filters.push(`topic=${params.selectedTopic}`); 38 | filters.push("track_visit=true"); 39 | } 40 | 41 | return ajax(`/${docsPath}.json?${filters.join("&")}`).then((data) => { 42 | const site = Site.current(); 43 | data.categories?.forEach((category) => site.updateCategory(category)); 44 | data.topics.topic_list.categories?.forEach((category) => 45 | site.updateCategory(category) 46 | ); 47 | data.topics.topic_list.topics = data.topics.topic_list.topics.map( 48 | (topic) => Topic.create(topic) 49 | ); 50 | data.topic = Topic.create(data.topic); 51 | data.topic.post_stream?.posts.forEach((post) => 52 | this._initUserModels(post) 53 | ); 54 | return data; 55 | }); 56 | }, 57 | 58 | loadMore(loadMoreUrl) { 59 | return ajax(loadMoreUrl).then((data) => { 60 | const site = Site.current(); 61 | data.topics.topic_list.categories?.forEach((category) => 62 | site.updateCategory(category) 63 | ); 64 | data.topics.topic_list.topics = data.topics.topic_list.topics.map( 65 | (topic) => Topic.create(topic) 66 | ); 67 | return data; 68 | }); 69 | }, 70 | 71 | _initUserModels(post) { 72 | if (post.mentioned_users) { 73 | post.mentioned_users = post.mentioned_users.map((u) => User.create(u)); 74 | } 75 | }, 76 | }); 77 | 78 | export default Docs; 79 | -------------------------------------------------------------------------------- /test/javascripts/fixtures/docs.js: -------------------------------------------------------------------------------- 1 | export default { 2 | tags: [ 3 | { 4 | id: "something", 5 | count: 74, 6 | active: false, 7 | }, 8 | ], 9 | categories: [ 10 | { 11 | id: 1, 12 | count: 119, 13 | active: false, 14 | }, 15 | ], 16 | topics: { 17 | users: [ 18 | { 19 | id: 2, 20 | username: "cvx", 21 | name: "Jarek", 22 | avatar_template: "/letter_avatar/cvx/{size}/2.png", 23 | }, 24 | ], 25 | primary_groups: [], 26 | topic_list: { 27 | can_create_topic: true, 28 | draft: null, 29 | draft_key: "new_topic", 30 | draft_sequence: 94, 31 | per_page: 30, 32 | top_tags: ["something"], 33 | topics: [ 34 | { 35 | id: 54881, 36 | title: "Importing from Software X", 37 | fancy_title: "Importing from Software X", 38 | slug: "importing-from-software-x", 39 | posts_count: 112, 40 | reply_count: 72, 41 | highest_post_number: 122, 42 | image_url: null, 43 | created_at: "2016-12-28T14:59:29.396Z", 44 | last_posted_at: "2020-11-14T16:21:35.720Z", 45 | bumped: true, 46 | bumped_at: "2020-11-14T16:21:35.720Z", 47 | archetype: "regular", 48 | unseen: false, 49 | pinned: false, 50 | unpinned: null, 51 | visible: true, 52 | closed: false, 53 | archived: false, 54 | bookmarked: null, 55 | liked: null, 56 | tags: ["something"], 57 | views: 15222, 58 | like_count: 167, 59 | has_summary: true, 60 | last_poster_username: "cvx", 61 | category_id: 1, 62 | pinned_globally: false, 63 | featured_link: null, 64 | has_accepted_answer: false, 65 | posters: [ 66 | { 67 | extras: null, 68 | description: "Original Poster", 69 | user_id: 2, 70 | primary_group_id: null, 71 | }, 72 | { 73 | extras: null, 74 | description: "Frequent Poster", 75 | user_id: 2, 76 | primary_group_id: null, 77 | }, 78 | { 79 | extras: "latest", 80 | description: "Most Recent Poster", 81 | user_id: 2, 82 | primary_group_id: null, 83 | }, 84 | ], 85 | }, 86 | ], 87 | }, 88 | load_more_url: "/docs.json?page=1", 89 | }, 90 | search_count: null, 91 | }; 92 | -------------------------------------------------------------------------------- /app/controllers/docs/docs_controller.rb: -------------------------------------------------------------------------------- 1 | # frozen_string_literal: true 2 | 3 | module Docs 4 | class DocsController < ApplicationController 5 | requires_plugin PLUGIN_NAME 6 | 7 | skip_before_action :check_xhr, only: [:index] 8 | 9 | def index 10 | if params[:tags].is_a?(Array) || params[:tags].is_a?(ActionController::Parameters) 11 | raise Discourse::InvalidParameters.new("Only strings are accepted for tag lists") 12 | end 13 | 14 | filters = { 15 | topic: params[:topic], 16 | tags: params[:tags], 17 | category: params[:category], 18 | solved: params[:solved], 19 | search_term: params[:search], 20 | ascending: params[:ascending], 21 | order: params[:order], 22 | page: params[:page], 23 | } 24 | 25 | query = Docs::Query.new(guardian, filters).list 26 | 27 | if filters[:topic].present? 28 | begin 29 | @topic = Topic.find(filters[:topic]) 30 | rescue StandardError 31 | raise Discourse::NotFound 32 | end 33 | 34 | @excerpt = 35 | @topic.posts[0].excerpt(500, { strip_links: true, text_entities: true }) if @topic.posts[ 36 | 0 37 | ].present? 38 | @excerpt = (@excerpt || "").gsub(/\n/, " ").strip 39 | 40 | query["topic"] = get_topic(@topic, current_user) 41 | end 42 | 43 | respond_to do |format| 44 | format.html do 45 | @title = set_title 46 | render :get_topic 47 | end 48 | 49 | format.json { render json: query } 50 | end 51 | end 52 | 53 | def get_topic(topic, current_user) 54 | return nil unless Docs.topic_in_docs(topic.category_id, topic.tags) 55 | 56 | topic_view = TopicView.new(topic.id, current_user) 57 | guardian = Guardian.new(current_user) 58 | 59 | ip = request.remote_ip 60 | user_id = (current_user.id if current_user) 61 | 62 | TopicsController.defer_track_visit(topic.id, user_id) if should_track_visit_to_topic? 63 | TopicsController.defer_topic_view(topic.id, ip, user_id) 64 | 65 | TopicViewSerializer.new(topic_view, scope: guardian, root: false) 66 | end 67 | 68 | def should_track_visit_to_topic? 69 | !!((!request.format.json? || params[:track_visit]) && current_user) 70 | end 71 | 72 | def set_title 73 | title = "#{I18n.t("js.docs.title")} - #{SiteSetting.title}" 74 | if @topic 75 | topic_title = @topic["unicode_title"] || @topic["title"] 76 | title = "#{topic_title} - #{title}" 77 | end 78 | title 79 | end 80 | end 81 | end 82 | -------------------------------------------------------------------------------- /assets/javascripts/discourse/components/docs-topic.gjs: -------------------------------------------------------------------------------- 1 | import Component from "@ember/component"; 2 | import { reads } from "@ember/object/computed"; 3 | import { service } from "@ember/service"; 4 | import { htmlSafe } from "@ember/template"; 5 | import { classNames } from "@ember-decorators/component"; 6 | import DButton from "discourse/components/d-button"; 7 | import PluginOutlet from "discourse/components/plugin-outlet"; 8 | import Post from "discourse/components/post"; 9 | import icon from "discourse/helpers/d-icon"; 10 | import discourseDebounce from "discourse/lib/debounce"; 11 | import computed, { bind } from "discourse/lib/decorators"; 12 | import transformPost from "discourse/lib/transform-post"; 13 | import { i18n } from "discourse-i18n"; 14 | 15 | @classNames("docs-topic") 16 | export default class DocsTopic extends Component { 17 | @service currentUser; 18 | @service site; 19 | 20 | @reads("post.cooked") originalPostContent; 21 | 22 | @computed("currentUser", "model") 23 | post() { 24 | return transformPost(this.currentUser, this.site, this.model); 25 | } 26 | 27 | @computed("topic", "topic.post_stream") 28 | model() { 29 | const post = this.store.createRecord( 30 | "post", 31 | this.topic.post_stream?.posts[0] 32 | ); 33 | 34 | if (!post.topic) { 35 | post.set("topic", this.topic); 36 | } 37 | 38 | return post; 39 | } 40 | 41 | @bind 42 | _emitScrollEvent() { 43 | this.appEvents.trigger("docs-topic:current-post-scrolled"); 44 | } 45 | 46 | @bind 47 | debounceScrollEvent() { 48 | discourseDebounce(this, this._emitScrollEvent, 200); 49 | } 50 | 51 | didInsertElement() { 52 | super.didInsertElement(...arguments); 53 | 54 | document.body.classList.add("archetype-docs-topic"); 55 | document.addEventListener("scroll", this.debounceScrollEvent); 56 | } 57 | 58 | willDestroyElement() { 59 | super.willDestroyElement(...arguments); 60 | 61 | document.body.classList.remove("archetype-docs-topic"); 62 | document.removeEventListener("scroll", this.debounceScrollEvent); 63 | } 64 | 65 | 66 |