✨(backend) add blocks converter to y-provider

Author: emersion

src/backend/core/services/converter_services.py

@@ -51,3 +51,43 @@ def convert(self, text):
             raise ServiceUnavailableError(
                 "Failed to connect to conversion service",
             ) from err
+
+    def convert_blocks(self, blocks):
+        """Convert a list of blocks into our internal format using an external microservice."""
+
+        try:
+            response = requests.post(
+                f"{settings.Y_PROVIDER_API_BASE_URL}{settings.BLOCKS_CONVERSION_API_ENDPOINT}/",
+                json={
+                    "blocks": blocks,
+                },
+                headers={
+                    "Authorization": self.auth_header,
+                    "Content-Type": "application/json",
+                },
+                timeout=settings.CONVERSION_API_TIMEOUT,
+                verify=settings.CONVERSION_API_SECURE,
+            )
+            response.raise_for_status()
+            conversion_response = response.json()
+
+        except requests.RequestException as err:
+            raise ServiceUnavailableError(
+                "Failed to connect to conversion service",
+            ) from err
+
+        except ValueError as err:
+            raise InvalidResponseError(
+                "Could not parse conversion service response"
+            ) from err
+
+        try:
+            document_content = conversion_response[
+                settings.CONVERSION_API_CONTENT_FIELD
+            ]
+        except KeyError as err:
+            raise MissingContentError(
+                f"Response missing required field: {settings.CONVERSION_API_CONTENT_FIELD}"
+            ) from err
+
+        return document_content

src/backend/impress/settings.py

@@ -645,6 +645,11 @@ class Base(Configuration):
         environ_name="CONVERSION_API_ENDPOINT",
         environ_prefix=None,
     )
+    BLOCKS_CONVERSION_API_ENDPOINT = values.Value(
+        default="convert-blocks",
+        environ_name="BLOCKS_CONVERSION_API_ENDPOINT",
+        environ_prefix=None,
+    )
     CONVERSION_API_CONTENT_FIELD = values.Value(
         default="content",
         environ_name="CONVERSION_API_CONTENT_FIELD",

src/frontend/servers/y-provider/src/handlers/convertBlocksHandler.ts

@@ -0,0 +1,47 @@
+//import { PartialBlock } from '@blocknote/core';
+import { ServerBlockNoteEditor } from '@blocknote/server-util';
+import { Request, Response } from 'express';
+import * as Y from 'yjs';
+
+import { logger, toBase64 } from '@/utils';
+
+interface ConversionRequest {
+  blocks: any; // TODO: PartialBlock
+}
+
+interface ConversionResponse {
+  content: string;
+}
+
+interface ErrorResponse {
+  error: string;
+}
+
+export const convertBlocksHandler = async (
+  req: Request<
+    object,
+    ConversionResponse | ErrorResponse,
+    ConversionRequest,
+    object
+  >,
+  res: Response<ConversionResponse | ErrorResponse>,
+) => {
+  const blocks = req.body?.blocks;
+  if (!blocks) {
+    res.status(400).json({ error: 'Invalid request: missing content' });
+    return;
+  }
+
+  try {
+    const editor = ServerBlockNoteEditor.create();
+
+    // Create a Yjs Document from blocks, and encode it as a base64 string
+    const yDocument = editor.blocksToYDoc(blocks, 'document-store');
+    const content = toBase64(Y.encodeStateAsUpdate(yDocument));
+
+    res.status(200).json({ content });
+  } catch (e) {
+    logger('conversion failed:', e);
+    res.status(500).json({ error: 'An error occurred' });
+  }
+};

src/frontend/servers/y-provider/src/handlers/index.ts

@@ -1,4 +1,5 @@
 export * from './collaborationResetConnectionsHandler';
 export * from './collaborationWSHandler';
 export * from './convertHandler';
+export * from './convertBlocksHandler';
 export * from './getDocumentConnectionInfoHandler';

src/frontend/servers/y-provider/src/routes.ts

@@ -2,5 +2,6 @@ export const routes = {
   COLLABORATION_WS: '/collaboration/ws/',
   COLLABORATION_RESET_CONNECTIONS: '/collaboration/api/reset-connections/',
   CONVERT: '/api/convert/',
+  CONVERT_BLOCKS: '/api/convert-blocks/',
   COLLABORATION_GET_CONNECTIONS: '/collaboration/api/get-connections/',
 };

src/frontend/servers/y-provider/src/servers/appServer.ts

@@ -8,6 +8,7 @@ import expressWebsockets from 'express-ws';
 import {
   collaborationResetConnectionsHandler,
   collaborationWSHandler,
+  convertBlocksHandler,
   convertHandler,
   getDocumentConnectionInfoHandler,
 } from '@/handlers';
@@ -61,6 +62,8 @@ export const initApp = () => {
     convertHandler,
   );
 
+  app.post(routes.CONVERT_BLOCKS, httpSecurity, convertBlocksHandler);
+
   Sentry.setupExpressErrorHandler(app);
 
   app.get('/ping', (req, res) => {