Skip to content

[FEATURE] Enabled User @mentions in tiptap editor component#2352

Closed
henit-chobisa wants to merge 21 commits intodevelopfrom
feat/tiptap-mentions
Closed

[FEATURE] Enabled User @mentions in tiptap editor component#2352
henit-chobisa wants to merge 21 commits intodevelopfrom
feat/tiptap-mentions

Conversation

@henit-chobisa
Copy link
Member

@henit-chobisa henit-chobisa commented Oct 3, 2023 •
edited
Loading

Description

The current pull request enables the usage of user-mentions in the tiptap editor, with features such as self highlighting, redirection and sending notifications from the backend.
image

Features

Sending Notification on being mentioned with context of being mentioned

Irrespective of a person being a subscriber of the issue or not, if he's mentioned in a particular issue, he will be sent a notification for being mentioned, along with that he will be added as a subscriber to the issue, to receive further updates on the issue. For testing the possible set of cases and scenarios please go through https://henit.notion.site/feat-mentions-c96dc6cfe53a4e2eafb0acb252cb80c4?pvs=4

image

Redirecting on the user profile, when clicked on the mention

The mention acts as a button, hence if you have provided the redirect_uri in the underlying data structure IMentionSuggestion[], you can see it redirecting to the user's profile. In future we can use this for redirecting to specific sets of views such as cycles or issues itself.

Screen.Recording.2023-10-03.at.5.36.15.PM.mov

Dynamic Highlights of entities in an issue

The mention feature also come with highlightin, which makes it extremely easy to spot a particular highlight, which can be anything from highlighting the current user from the content or highlighting a set of issues from a query of "Show me all the issues where a particular set of issues are mentioned". Currently the highlighting works only in the issues/form.tsx, and in side-peak-view.
image

For Example: : If the highlight group is for the current user, which means that in every issue, if the current user is mentioned he must be highlighted, in this case it's dynamic because for an issue where @crew and @captain both are mentioned, if @crew is signed in, he must be highlighted and so as captain, which makes us dynamically update the values. Below is the picture of the implementation, which show how dynamic highlights work for two different highlight groups.

Issue View of the Captain
image

Issue View for the Crew
image

@henit-chobisa
feat: modified issue_activity background job for handling mentions
47edd17
@henit-chobisa
feat: Extended Tiptap Mentions for adding type, id & label
fb8c339
@henit-chobisa
feat: Intialized Mentions Extension
7f5abf7
@henit-chobisa
feat: added suggestion type to be used for passing suggestions
7f8f80f
@henit-chobisa
feat: added suggestion controller & renderer
101d8a8
@henit-chobisa
feat: added mentions in tiptap extensions
7f9a38c
@henit-chobisa
feat: provided mentionSuggestion from issue creation form
d290715
@henit-chobisa
feat: added mention styles
ea9f102
@henit-chobisa
chore: added tiptap-mention dependency in package.json
7058c11
@henit-chobisa
feat: modified notification-card to provide priviledge to preconstruc…
d33045c 
…ted message from backend
@henit-chobisa
feat: removed print log from issue_activities background job
58b0b17
@henit-chobisa
feat: added mention implementation on issue form
ae91d58
@henit-chobisa
feat: added mention node custom implementation
8da9781
@henit-chobisa
feat: added self and redirect uri in list component
f5415c3
@henit-chobisa
feat: added tag based parsing in backend instead of class based
daeafee
@henit-chobisa
feat: removed saving self tag
26bc9d4
@vercel
Copy link

vercel bot commented Oct 3, 2023 •
edited
Loading

The latest updates on your projects. Learn more about Vercel for Git ↗︎

6 Ignored Deployments
Name Status Preview Comments Updated (UTC)
plane ⬜️ Ignored (Inspect) Visit Preview Oct 27, 2023 5:22am
plane-dev ⬜️ Ignored (Inspect) Visit Preview Oct 27, 2023 5:22am
plane-sh ⬜️ Ignored (Inspect) Visit Preview Oct 27, 2023 5:22am
plane-sh-dev ⬜️ Ignored (Inspect) Visit Preview Oct 27, 2023 5:22am
plane-sh-stage ⬜️ Ignored (Inspect) Visit Preview Oct 27, 2023 5:22am
plane-staging ⬜️ Ignored (Inspect) Visit Preview Oct 27, 2023 5:22am

pablohashescobar
pablohashescobar requested changes Oct 8, 2023
View reviewed changes
apiserver/plane/bgtasks/issue_activites_task.py Outdated
mention_notifications.append(
Notification(
workspace=project.workspace,
sender="in_app:issue_activities",
Copy link
Member

@pablohashescobar pablohashescobar Oct 8, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here can we add an addtional identifier in_app:issue_activities:mention

Copy link
Member Author

@henit-chobisa henit-chobisa Oct 9, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've modified it ✌🏼

@henit-chobisa henit-chobisa self-assigned this Oct 9, 2023
@pablohashescobar
Copy link
Member

pablohashescobar commented Nov 2, 2023

Closing this PR as updated changes are already merged

@sriramveeraghanta sriramveeraghanta deleted the feat/tiptap-mentions branch November 10, 2023 13:50
aaryan610 pushed a commit that referenced this pull request Apr 9, 2025
@Saurabhkmr98 @henit-chobisa @sriramveeraghanta
[SILO] : Importer and integrations db migration changes (#2363)
207e85e 
* `silo` refactoring changes  (#2304)

* add sdk and services for workspace connection and import jobs

* rename service

* move worker folder to root + remove controller folder

* remove controller folder

* add external api service in silo

* fix params in service

* fix params in service

* fix services + remove projectid in job endpoints

* chore: added generic config types for job store (#2158)

* chore: made import job as generic

* chore: added generic parameter inside the job service

* chore: added generic parameter inside the job service

* feat: remove projectId from jobs endpoint

* chore: modified job store for new services

* chore: revert go.mod.sum

* chore: spaces

* gitlab auth callback

* github controllers update with plane api

* create api client fix

* base integration importer store

* remove junk store

* silo external api token middleware + plane api to generate user tokens

* add ahmac permission method in apiserver + ahmac sign flow on silo

* remove junk

* getapi client remove unwanted options

* modify api route for silo access + github gitlab and slack controller clean up

* types modify + jira importer cleanup

* fix: nodemon setup

* make getAPIClient as a singleton

* chore: added new definitions in base-import-worker

* chore: modified jira migrator to adhere to the modified types

* feat: modified base migrator to adhere new types

* chore: modified jira-server-migrator to adhere new changes

* chore: modified asana importer to adhere to new types

* fix: migrated importer controllers for new schema

* fix: build

* chore: asana and linear controller

* feat: updated job controller for new schema changes

* chore: added permissions

* integrations api migrations changes (#2193)

* chore: added workspace_slug inside job data

* replaced ahmac with hmac implementation

* add new service base api view for microservices

* fix: apiserver changes and base view

* feat: added changes to services

* feat: modified engine controller for using api services

* feat: modified UI stores for modified jira importer

* remove-log

* resolve hmac issue + silo endpoint url fixes

* add silo target access token rotation in get

* integration ui migration changes

* revert changes in il8n

* fix crud for api

* fix crud for api

* fix: batch lock config

* fix silo bundler issue (#2233)

* chore: combined common dashboard components for silo (#2166)

* chore: added new types to job store

* feat: updated job store dependencies for new params

* feat: created common components for importers dashboard

* feat: modified jira importer to comply with new common components

* feat: modified jira server dashboard to comply with the new component changes

* feat: modified asana to comply with the common dashboard changes

* fix: linear to comply with the new changes

* reset job store

* feat: migrated importers to new schema

* fix: removed unused code

* fix: base job importer model and serializer

* fix-lint-errors

---------

Co-authored-by: Saurabh Kumar <70131915+Saurabhkmr98@users.noreply.github.com>

* fix api serialisers

* fix: stabilized all integrations and jira importer

* fix: linear, asana and jira-server importers

* fix: reinstantiated hmac permission

* chore: removed the db folder for silo

* feat: added types for integration config

* feat: added check for supported integration in silo and web

* feat: added self hosted and cloud message differences

* add en translations for importers and jira importer (#2264)

* feat: Added language support for integrations (#2277)

* feat: added translations for github, slack and gitlab integrations

* fix: slack integration project modal

* fix: gitlab organization disconnect

* fix: silo build fixes

* feat: added more language to integration language support

* fix: review

* feat: modified caddy and compose for silo selfhosted changes (#2276)

* silo - fixes for keys and integrations form reset (#2283)

* fix hardcoded values for integration importer keys

* reset state after integration form submit

* fix missing key integration

* fix gitlab connection update

* fix: added slack images being updated while creating issues (#2288)

Co-authored-by: Saurabh Kumar <70131915+Saurabhkmr98@users.noreply.github.com>

* silo - fix integration lang support (#2291)

* fix hardcoded values for integration importer keys

* reset state after integration form submit

* fix missing translation key integration

* fix gitlab connection update

* fix integration lang support

* fix integration lang support

---------

Co-authored-by: Saurabhkmr98 <saurabhkapur73@gmail.com>
Co-authored-by: Saurabh Kumar <70131915+Saurabhkmr98@users.noreply.github.com>

* [SILO-71] flatfile importer v1 (#2156)

* feat: initialized CSV importer

* feat: added flatfile components

* feat: setup workbook and listener for csv importer

* feat: added store structure for flatfile importer

* chore: translated csv importer to flatfile importer

* feat: setup listener

* fix: event listener for creating agent

* feat: added flatfile importer skeleton

* feat: added flatfile etl logic for pulling and transforming data

* feat: added flatfile controller and migrator

* feat: curated flatfile root store and importer UI

* feat: initialized flatfile migrator

* fix: flatfile

* feat: added transformers for cycles and issues

* feat: added mapping and transformation for flatfile

* feat: added assignee field for fixing migrator bugs

* fix:build

* feat: added metrics inside the data import task'

* fix:workbook

* feat: added validation of email and date for flatfile

* add sdk and services for workspace connection and import jobs

* rename service

* move worker folder to root + remove controller folder

* remove controller folder

* feat: added modules and issue types inside flatfile

* fix: build

* fix:response-handler

* fix:errors

* fix:deleted-file

* fix: readded jobs route

* add external api service in silo

* fix params in service

* fix params in service

* fix services + remove projectid in job endpoints

* chore: added generic config types for job store (#2158)

* chore: made import job as generic

* chore: added generic parameter inside the job service

* chore: added generic parameter inside the job service

* feat: remove projectId from jobs endpoint

* chore: modified job store for new services

* chore: revert go.mod.sum

* chore: spaces

* gitlab auth callback

* github controllers update with plane api

* create api client fix

* base integration importer store

* remove junk store

* silo external api token middleware + plane api to generate user tokens

* add ahmac permission method in apiserver + ahmac sign flow on silo

* remove junk

* getapi client remove unwanted options

* modify api route for silo access + github gitlab and slack controller clean up

* types modify + jira importer cleanup

* fix: nodemon setup

* make getAPIClient as a singleton

* chore: added new definitions in base-import-worker

* chore: modified jira migrator to adhere to the modified types

* feat: modified base migrator to adhere new types

* chore: modified jira-server-migrator to adhere new changes

* chore: modified asana importer to adhere to new types

* fix: migrated importer controllers for new schema

* fix: build

* chore: asana and linear controller

* feat: updated job controller for new schema changes

* chore: added permissions

* integrations api migrations changes (#2193)

* chore: added workspace_slug inside job data

* replaced ahmac with hmac implementation

* add new service base api view for microservices

* fix: apiserver changes and base view

* feat: added changes to services

* feat: modified engine controller for using api services

* feat: modified UI stores for modified jira importer

* remove-log

* resolve hmac issue + silo endpoint url fixes

* add silo target access token rotation in get

* integration ui migration changes

* revert changes in il8n

* fix crud for api

* fix crud for api

* fix: batch lock config

* fix silo bundler issue (#2233)

* chore: combined common dashboard components for silo (#2166)

* chore: added new types to job store

* feat: updated job store dependencies for new params

* feat: created common components for importers dashboard

* feat: modified jira importer to comply with new common components

* feat: modified jira server dashboard to comply with the new component changes

* feat: modified asana to comply with the common dashboard changes

* fix: linear to comply with the new changes

* reset job store

* feat: migrated importers to new schema

* fix: removed unused code

* fix: base job importer model and serializer

* fix-lint-errors

---------

Co-authored-by: Saurabh Kumar <70131915+Saurabhkmr98@users.noreply.github.com>

* fix api serialisers

* fix: stabilized all integrations and jira importer

* fix: linear, asana and jira-server importers

* fix: reinstantiated hmac permission

* chore: removed the db folder for silo

* feat: added types for integration config

* feat: added check for supported integration in silo and web

* feat: added self hosted and cloud message differences

* add en translations for importers and jira importer (#2264)

* feat: Added language support for integrations (#2277)

* feat: added translations for github, slack and gitlab integrations

* fix: slack integration project modal

* fix: gitlab organization disconnect

* fix: silo build fixes

* feat: added more language to integration language support

* fix: review

* feat: modified caddy and compose for silo selfhosted changes (#2276)

* silo - fixes for keys and integrations form reset (#2283)

* fix hardcoded values for integration importer keys

* reset state after integration form submit

* fix missing key integration

* fix gitlab connection update

* fix: added slack images being updated while creating issues (#2288)

Co-authored-by: Saurabh Kumar <70131915+Saurabhkmr98@users.noreply.github.com>

* silo - fix integration lang support (#2291)

* fix hardcoded values for integration importer keys

* reset state after integration form submit

* fix missing translation key integration

* fix gitlab connection update

* fix integration lang support

* fix integration lang support

* feat: added controllers as default exports

* feat: modified flatfile worker and controller to adhere new changes

* feat: modified flatfile importer to ahere silo api migration

* fix: source project and workspace hide props

---------

Co-authored-by: Saurabhkmr98 <saurabhkapur73@gmail.com>
Co-authored-by: Saurabh Kumar <70131915+Saurabhkmr98@users.noreply.github.com>

* add fuzzy find in state and priority mapping (#2310)

Co-authored-by: Saurabhkmr98 <saurabhkapur73@gmail.com>
Co-authored-by: sriram veeraghanta <veeraghanta.sriram@gmail.com>

* fix: build

* chore: moved flatfile agent to external

* chore:build-fixes

* fix: credential breaking for slack

* fix: credential route for api

* SILO - chore: Importers translation (#2352)

* add en translations for importers and jira importer

* add en translations for all the importers

* add importers language translation changes

* chore silo importer translation

* chore silo importer translation

* fix: env removing trailing slashes

* fix: trailing slashed env

* fix duplicate entity connection issue (#2362)

---------

Co-authored-by: Henit Chobisa <chobisa.henit@gmail.com>
Co-authored-by: sriram veeraghanta <veeraghanta.sriram@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@sriramveeraghanta sriramveeraghanta Awaiting requested review from sriramveeraghanta

@aaryan610 aaryan610 Awaiting requested review from aaryan610

@pablohashescobar pablohashescobar Awaiting requested review from pablohashescobar

Assignees

@henit-chobisa henit-chobisa

Labels

⚙️backend ✨feature 🌐frontend

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@henit-chobisa @pablohashescobar