search

alkem-io / whiteboard-collaboration-service

Excalidraw web socket sync server
European Union Public License 1.2
0 stars 0 forks source link

Serverside whiteboards #20

Closed hero101 closed 1 month ago

hero101 commented 1 month ago

Changes

image

Summary by CodeRabbit

Summary by CodeRabbit

coderabbitai[bot] commented 1 month ago

Walkthrough

The changes involve significant updates across multiple files, including the configuration file config.yml, modifications to the Server class for room management and socket handling, and the introduction of new types for Excalidraw content and files. New functionalities for saving and fetching data have been added to the WhiteboardIntegrationAdapterService, along with enhancements to error handling and logging. Additional utility functions for JSON processing have also been introduced, improving the overall structure and capabilities of the application.

Changes

File Path Change Summary
config.yml Updated save_interval to 10 seconds; removed save_timeout and save_consecutive_failed_attempts; updated queue from ${QUEUE}:auth to ${QUEUE}:alkemio-whiteboards.
src/excalidraw-backend/server.ts Introduced throttled save mechanism, snapshot management, updated socket event handling, and removed auto-save logic.
src/excalidraw-backend/types/excalidraw.content.ts Added new type ExcalidrawContent for managing Excalidraw-specific content structure.
src/excalidraw-backend/types/excalidraw.file.ts Introduced types ExcalidrawFile and ExcalidrawFileStore for managing Excalidraw files.
src/excalidraw-backend/types/in.memory.snapshot.ts Added InMemorySnapshot class for managing immutable snapshots of Excalidraw content.
src/services/whiteboard-integration/outputs/save.output.data.ts Introduced SaveOutputData, SaveContentData, and SaveErrorData classes for structured save operations.
src/services/whiteboard-integration/whiteboard.integration.adapter.service.ts Added save and fetch methods, improved error handling and logging.
src/util/index.ts Added exports for json.to.arraybuffer and excalidraw.init.data; removed array.random.element.
src/util/json-to-arraybuffer/json.to.arraybuffer.ts Introduced jsonToArrayBuffer function for converting JSON objects to ArrayBuffer.
src/util/json-to-arraybuffer/json.to.arraybuffer.spec.ts Added unit tests for jsonToArrayBuffer function covering various JSON scenarios.

Sequence Diagram(s)

(No sequence diagram is necessary as the changes are primarily structural and do not alter the control flow of the application.)

🐇 In the meadow, changes abound,
New features and fixes, joyfully found.
With saves and fetches, our work's a delight,
Hopping along, everything feels right!
Let's cheer for the code, so clever and bright! 🌼

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: -- `I pushed a fix in commit , please review it.` -- `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: -- `@coderabbitai generate unit testing code for this file.` -- `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: -- `@coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.` -- `@coderabbitai read src/utils.ts and generate unit testing code.` -- `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` -- `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (Invoked using PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. ### Other keywords and placeholders - Add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. - Add `@coderabbitai summary` to generate the high-level summary at a specific location in the PR description. - Add `@coderabbitai` anywhere in the PR title to generate the title automatically. ### CodeRabbit Configuration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.