Skip to content

OpenProject is the leading open source project management software for product, project and portfolio management. A powerful Jira alternative with agile planning, issue tracking, roadmaps, Gantt charts, time tracking, collaboration features, and more. Available on premises or in the cloud. ⭐ Star us on GitHub

[#65875] Enable comments.

Pavel Balashou01c3f49a89b4
diff --git a/frontend/src/react/OpBlockNoteContainer.tsx b/frontend/src/react/OpBlockNoteContainer.tsx
index a386c4dca5e..9d3d82ff5d3 100644
--- a/frontend/src/react/OpBlockNoteContainer.tsx
+++ b/frontend/src/react/OpBlockNoteContainer.tsx
@@ -36,13 +36,19 @@ import { useEffect, useState } from "react";
import { OpColorMode } from "core-app/core/setup/globals/theme-utils";
import { HocuspocusProvider } from "@hocuspocus/provider";
import * as Y from 'yjs';
+import {
+ DefaultThreadStoreAuth,
+ YjsThreadStore,
+} from "@blocknote/core/comments";
+import { User } from "@blocknote/core/comments";
export interface OpBlockNoteContainerProps {
inputField: HTMLInputElement;
inputText?: string;
hocuspocusUrl: string;
hocuspocusAccessToken: string;
- userName: string;
+ users: Array<User>;
+ activeUser: User;
documentId: string;
}
@@ -58,15 +64,18 @@ const detectTheme = ():OpColorMode => { return window.OpenProject.theme.detectOp
export default function OpBlockNoteContainer({ inputField,
inputText,
- userName,
+ users,
+ activeUser,
hocuspocusUrl,
hocuspocusAccessToken,
documentId }: OpBlockNoteContainerProps) {
const [isLoading, setIsLoading] = useState(true);
let collaboration: any;
- const collaborationEnabled: boolean = Boolean(hocuspocusUrl && documentId && hocuspocusAccessToken && userName);
+ let comments: any;
+ const collaborationEnabled: boolean = Boolean(hocuspocusUrl && documentId && hocuspocusAccessToken && activeUser);
let provider: HocuspocusProvider | null = null;
+ let threadStore: any;
if(collaborationEnabled) {
const doc = new Y.Doc()
@@ -81,13 +90,42 @@ export default function OpBlockNoteContainer({ inputField,
provider,
fragment: doc.getXmlFragment("document-store"),
user: {
- name: userName,
+ name: activeUser.username,
color: cursorColor,
},
showCursorLabels: "activity"
}
+ console.log("ACTIVE USER", activeUser);
+ threadStore = new YjsThreadStore(
+ activeUser.id,
+ doc.getMap("threads"),
+ new DefaultThreadStoreAuth(activeUser.id, "editor"),
+ );
+ comments = {
+ threadStore: threadStore,
+ };
}
- const editor = useCreateBlockNote(collaboration ? { collaboration, schema } : { schema });
+
+ let editor: any;
+ if(collaboration) {
+ const resolveUsers = async (userIds: string[]) => {
+ return users.filter((user) => userIds.includes(user.id));
+ }
+
+ editor = useCreateBlockNote(
+ {
+ resolveUsers,
+ collaboration,
+ schema,
+ comments
+ },
+ [activeUser, threadStore]
+ );
+ } else {
+ editor = useCreateBlockNote(
+ { schema },
+ );
+ };
type EditorType = typeof editor;
const getCustomSlashMenuItems = (editor: EditorType) => {
diff --git a/frontend/src/stimulus/controllers/dynamic/block-note.controller.ts b/frontend/src/stimulus/controllers/dynamic/block-note.controller.ts
index 2cfc21e4e66..7185a5a137b 100644
--- a/frontend/src/stimulus/controllers/dynamic/block-note.controller.ts
+++ b/frontend/src/stimulus/controllers/dynamic/block-note.controller.ts
@@ -32,6 +32,7 @@ import { Controller } from '@hotwired/stimulus';
import React from 'react';
import { createRoot } from 'react-dom/client';
import OpBlockNoteContainer from '../../../react/OpBlockNoteContainer';
+import { User } from "@blocknote/core/comments";
export default class extends Controller {
static targets = [
@@ -41,7 +42,8 @@ export default class extends Controller {
static values = {
inputText: String,
- userName: String,
+ users: Array,
+ activeUser: Object,
hocuspocusUrl: String,
hocuspocusAccessToken: String,
documentId: String,
@@ -50,7 +52,8 @@ export default class extends Controller {
declare readonly blockNoteEditorTarget:HTMLElement;
declare readonly blockNoteInputFieldTarget:HTMLInputElement;
declare readonly inputTextValue:string;
- declare readonly userNameValue:string;
+ declare readonly usersValue:Array<User>;
+ declare readonly activeUserValue:User;
declare readonly hocuspocusUrlValue:string;
declare readonly hocuspocusAccessTokenValue:string;
declare readonly documentIdValue:string;
@@ -64,7 +67,8 @@ export default class extends Controller {
return React.createElement(OpBlockNoteContainer, {
inputField: this.blockNoteInputFieldTarget,
inputText: this.inputTextValue,
- userName: this.userNameValue,
+ users: this.usersValue,
+ activeUser: this.activeUserValue,
hocuspocusUrl: this.hocuspocusUrlValue,
hocuspocusAccessToken: this.hocuspocusAccessTokenValue,
documentId: this.documentIdValue,
diff --git a/lib/primer/open_project/forms/block_note_editor.html.erb b/lib/primer/open_project/forms/block_note_editor.html.erb
index 957860466aa..5f5d6d91339 100644
--- a/lib/primer/open_project/forms/block_note_editor.html.erb
+++ b/lib/primer/open_project/forms/block_note_editor.html.erb
@@ -34,7 +34,8 @@ See COPYRIGHT and LICENSE files for more details.
data: {
controller: "block-note",
block_note_input_text_value: value,
- block_note_user_name_value: user_name,
+ block_note_users_value: users,
+ block_note_active_user_value: active_user,
block_note_hocuspocus_url_value: hocuspocus_url,
block_note_hocuspocus_access_token_value: hocuspocus_access_token,
block_note_document_id_value: document_id,
diff --git a/lib/primer/open_project/forms/block_note_editor.rb b/lib/primer/open_project/forms/block_note_editor.rb
index 3fbcf0a6827..e5953382a74 100644
--- a/lib/primer/open_project/forms/block_note_editor.rb
+++ b/lib/primer/open_project/forms/block_note_editor.rb
@@ -33,9 +33,13 @@ module Primer
module Forms
# :nodoc:
class BlockNoteEditor < Primer::Forms::BaseComponent
+ include ::OpenProject::StaticRouting::UrlHelpers
+ include ::AvatarHelper
+
attr_reader :input,
:value,
- :user_name,
+ :users,
+ :active_user,
:hocuspocus_url,
:hocuspocus_access_token,
:document_id
@@ -46,7 +50,18 @@ module Primer
super()
@input = input
@value = value
- @user_name = User.current.name
+ @users = User.active.map do |user|
+ {
+ id: user.id,
+ username: user.name,
+ avatarUrl: avatar_url(user)
+ }
+ end
+ @active_user = {
+ id: User.current.id,
+ username: User.current.name,
+ avatarUrl: avatar_url(User.current)
+ }
@document_id = document_id
@hocuspocus_url = Setting.collaborative_editing_hocuspocus_url
@hocuspocus_access_token = ::CollaborativeEditing::DocumentAccessTokenGenerator.call(document_id, value)