Improve files handling

Author: ValentaTomas

openapi.yaml

@@ -90,6 +90,17 @@ paths:
               schema:
                 type: string
           description: Contents of the file as a string
+        '404':
+          content:
+            application/json:
+              schema:
+                properties:
+                  reason:
+                    type: string
+                required:
+                - reason
+                type: object
+          description: Response to send if the file is not found
       summary: Read the contents of a file at the given path
     put:
       operationId: WriteFile

src/generated/routes.ts

@@ -71,6 +71,7 @@ export function RegisterRoutes(app: Router) {
             const args = {
                     env: {"default":"Nodejs","in":"query","name":"env","ref":"Environment"},
                     path: {"in":"query","name":"path","required":true,"dataType":"string"},
+                    notFoundResponse: {"in":"res","name":"404","required":true,"dataType":"nestedObjectLiteral","nestedProperties":{"reason":{"dataType":"string","required":true}}},
                     conversationID: {"in":"header","name":"openai-conversation-id","dataType":"string"},
             };
 

src/plugin/filesController.ts

@@ -6,6 +6,8 @@ import {
   Query,
   Route,
   Consumes,
+  TsoaResponse,
+  Res,
   Body,
   Produces,
 } from 'tsoa'
@@ -22,24 +24,33 @@ export class FilesystemController extends Controller {
    * 
    * @param env Environment where to read the file from
    * @param path Path to the file to read
+   * @param notFoundResponse Response to send if the file is not found
    * @returns Contents of the file as a string
    */
   @Get()
   @Produces(textPlainMIME)
   public async readFile(
     @Query() env: Environment = defaultEnvironment,
     @Query() path: string,
+    @Res() notFoundResponse: TsoaResponse<404, { reason: string }>,
     @Header(openAIConversationIDHeader) conversationID?: string,
   ): Promise<string> {
     const sessionID = getUserSessionID(conversationID, env)
     const session = await CachedSession.findOrStartSession({ sessionID, envID: env })
 
     this.setHeader('Content-Type', textPlainMIME)
 
-    return await session
-      .session
-      .filesystem!
-      .read(path)
+    try {
+      return await session
+        .session
+        .filesystem!
+        .read(path)
+    } catch (err) {
+      console.error(err)
+      return notFoundResponse(404, { 
+        reason: `File on path "${path}" not found`,
+      })
+    }
   }
 
   /**