feat: better error handling for cloud sketches

Signed-off-by: Akos Kitta <[email protected]>

Author: Akos Kitta

arduino-ide-extension/src/browser/create/typings.ts

@@ -82,6 +82,13 @@ export function isNotFound(err: unknown): err is NotFoundError {
   return isErrorWithStatusOf(err, 404);
 }
 
+export type UnprocessableContentError = CreateError & { status: 422 };
+export function isUnprocessableContent(
+  err: unknown
+): err is UnprocessableContentError {
+  return isErrorWithStatusOf(err, 422);
+}
+
 function isErrorWithStatusOf(
   err: unknown,
   status: number

arduino-ide-extension/src/test/browser/create-api.test.ts

@@ -5,17 +5,23 @@ import {
 } from '@theia/core/shared/inversify';
 import { assert, expect } from 'chai';
 import fetch from 'cross-fetch';
+import { rejects } from 'node:assert';
 import { posix } from 'node:path';
+import queryString from 'query-string';
 import { v4 } from 'uuid';
 import { ArduinoPreferences } from '../../browser/arduino-preferences';
 import { AuthenticationClientService } from '../../browser/auth/authentication-client-service';
 import { CreateApi } from '../../browser/create/create-api';
 import { splitSketchPath } from '../../browser/create/create-paths';
-import { Create, CreateError } from '../../browser/create/typings';
+import {
+  Create,
+  CreateError,
+  isNotFound,
+  isUnprocessableContent,
+} from '../../browser/create/typings';
 import { SketchCache } from '../../browser/widgets/cloud-sketchbook/cloud-sketch-cache';
 import { SketchesService } from '../../common/protocol';
 import { AuthenticationSession } from '../../node/auth/types';
-import queryString from 'query-string';
 
 /* eslint-disable @typescript-eslint/no-non-null-asserted-optional-chain */
 /* eslint-disable @typescript-eslint/no-non-null-assertion */
@@ -229,6 +235,49 @@ describe('create-api', () => {
     expect(findByName(otherName, sketches)).to.be.not.undefined;
   });
 
+  it('should fail with HTTP 422 when reading a file but is a directory', async () => {
+    const name = v4();
+    const content = 'void setup(){} void loop(){}';
+    const posixPath = toPosix(name);
+
+    await createApi.createSketch(posixPath, content);
+    const resources = await createApi.readDirectory(posixPath);
+    expect(resources.length > 0).to.be.true;
+
+    await rejects(createApi.readFile(posixPath), (thrown) =>
+      isUnprocessableContent(thrown)
+    );
+  });
+
+  it('should fail with HTTP 422 when listing a directory but is a file', async () => {
+    const name = v4();
+    const content = 'void setup(){} void loop(){}';
+    const posixPath = toPosix(name);
+
+    await createApi.createSketch(posixPath, content);
+    const sketchContent = await createApi.readFile(
+      posixPath + posixPath + '.ino'
+    );
+    expect(sketchContent).to.be.equal(content);
+
+    await rejects(createApi.deleteDirectory(posixPath), (thrown) =>
+      isUnprocessableContent(thrown)
+    );
+  });
+
+  it("should fail with HTTP 404 when deleting a non-existing directory via the '/files/d' endpoint", async () => {
+    const name = v4();
+    const posixPath = toPosix(name);
+
+    const sketches = await createApi.sketches();
+    const sketch = findByName(name, sketches);
+    expect(sketch).to.be.undefined;
+
+    await rejects(createApi.deleteDirectory(posixPath), (thrown) =>
+      isNotFound(thrown)
+    );
+  });
+
   ['.', '-', '_'].map((char) => {
     it(`should create a new sketch with '${char}' in the sketch folder name although it's disallowed from the Create Editor`, async () => {
       const name = `sketch${char}`;