-
-
Notifications
You must be signed in to change notification settings - Fork 103
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
WIP: refactor to separate server and hocuspocus #686
Draft
timoisik
wants to merge
15
commits into
release/3.0.0
Choose a base branch
from
refactor/hocuspocus-server
base: release/3.0.0
Could not load branches
Branch not found: {{ refName }}
Could not load tags
Nothing to show
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
timoisik
changed the title
WIP: refactorto seperate server and hocuspocus
WIP: refactor to seperate server and hocuspocus
Aug 22, 2023
janthurau
changed the title
WIP: refactor to seperate server and hocuspocus
WIP: refactor to separate server and hocuspocus
Aug 24, 2023
janthurau
previously approved these changes
Sep 4, 2023
nperez0111
approved these changes
Apr 17, 2024
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This looks great to me, what do we need to get this merged?
We can put it in a branch to queue for next release if there are other breaking changes we want to make.
Thanks so much for this @timoisik. Will be giving it a go shortly. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The following PR has breaking changes and is thus intended for a major release. Feedback is highly appreciated.
With this PR we moved the server logic into it's own server class (
Server.ts
). The server class then will use hocuspocus like you would mostly also use it as a library in other frameworks. This changes the way how you use hocuspocus though.The goal is to make hocuspocus more flexible for further development. Without any server logic, hocuspocus could potentially run on edge services like cloudflare workers in the future. Also it is easier to extend the server with new functionalities such as additional APIs.
New usages
There are two ways on how you can use hocuspocus.
We also changed the parameters of the
.listen()
method:This simplifies the usage of hocuspocus while you can still reach the same behavior as before. You are also still able to configure port and callbacks within the constructor of the Server.
Breaking
.configure()
still exists on hocuspocus but not on the server. We also do not export instances anymore but only the classes. Thus, it is no longer possible to use hocuspocus like:Because the
.listen()
method was removed from hocuspocus and moved to the server, you can no longer use it like:TODO: