small cleanup

Author: abcampo-iry

src/scratch.test.js

@@ -4,6 +4,11 @@ jest.mock("./components/ScratchEditor/ScratchIntegrationHOC.jsx", () => ({
   __esModule: true,
   default: (WrappedComponent) => WrappedComponent,
 }));
+const mockScratchProjectSave = jest.fn();
+jest.mock("./utils/scratchProjectSave.js", () => ({
+  __esModule: true,
+  default: (params) => mockScratchProjectSave(params),
+}));
 jest.mock("@scratch/scratch-gui", () => {
   const MockGui = jest.fn(() => null);
   MockGui.setAppElement = jest.fn();
@@ -72,6 +77,8 @@ describe("scratch handshake retries", () => {
     jest.useFakeTimers();
     jest.resetModules();
     mockRenderRoot.mockReset();
+    mockScratchProjectSave.mockReset();
+    mockScratchProjectSave.mockResolvedValue({ id: "project-123" });
     process.env = {
       ...originalEnv,
       ASSETS_URL: "https://assets.example.com",
@@ -156,16 +163,14 @@ describe("scratch handshake retries", () => {
       "Authorization",
       "token-123",
     );
-    expect(scratchStorage.scratchFetch.scratchFetch).toHaveBeenCalledWith(
-      "https://api.example.com/api/scratch/projects/project-123?title=Saved+from+test",
-      {
-        method: "put",
-        body: '{"targets":[]}',
-        headers: {
-          "Content-Type": "application/json",
-        },
-        credentials: "include",
-      },
+    expect(mockScratchProjectSave).toHaveBeenCalledWith(
+      expect.objectContaining({
+        scratchFetchApi: scratchStorage.scratchFetch,
+        apiUrl: "https://api.example.com",
+        currentProjectId: "project-123",
+        vmState: '{"targets":[]}',
+        params: { title: "Saved from test" },
+      }),
     );
   });
 
@@ -190,27 +195,25 @@ describe("scratch handshake retries", () => {
     };
 
     scratchGuiElement.props.onStorageInit(scratchStorage);
-    const response = await scratchGuiElement.props.onUpdateProjectData(
+    await scratchGuiElement.props.onUpdateProjectData(
       undefined,
       '{"targets":[]}',
       { originalId: "source-project", isRemix: 1, title: "Created from test" },
     );
 
-    expect(scratchStorage.scratchFetch.scratchFetch).toHaveBeenCalledWith(
-      "https://api.example.com/api/scratch/projects/?original_id=source-project&is_remix=1&title=Created+from+test",
-      {
-        method: "post",
-        body: '{"targets":[]}',
-        headers: {
-          "Content-Type": "application/json",
+    expect(mockScratchProjectSave).toHaveBeenCalledWith(
+      expect.objectContaining({
+        scratchFetchApi: scratchStorage.scratchFetch,
+        apiUrl: "https://api.example.com",
+        currentProjectId: undefined,
+        vmState: '{"targets":[]}',
+        params: {
+          originalId: "source-project",
+          isRemix: 1,
+          title: "Created from test",
         },
-        credentials: "include",
-      },
+      }),
     );
-    expect(response).toEqual({
-      "content-name": "created-project-id",
-      id: "created-project-id",
-    });
   });
 
   test("keeps retrying when auth is required but token is missing", () => {

src/utils/scratchProjectSave.js

@@ -1,4 +1,10 @@
-const buildQueryString = (params = {}) => {
+const buildScratchProjectSaveRequest = ({
+  apiUrl,
+  currentProjectId,
+  params = {},
+}) => {
+  const creatingProject =
+    currentProjectId === null || typeof currentProjectId === "undefined";
   const searchParams = new URLSearchParams(
     Object.entries({
       original_id: params.originalId,
@@ -7,9 +13,32 @@ const buildQueryString = (params = {}) => {
       title: params.title,
     }).filter(([, value]) => value !== undefined),
   );
-
   const queryString = searchParams.toString();
-  return queryString ? `?${queryString}` : "";
+  const baseUrl = creatingProject
+    ? `${apiUrl}/api/scratch/projects/`
+    : `${apiUrl}/api/scratch/projects/${currentProjectId}`;
+
+  return {
+    creatingProject,
+    method: creatingProject ? "post" : "put",
+    url: queryString ? `${baseUrl}?${queryString}` : baseUrl,
+  };
+};
+
+const normalizeScratchProjectSaveResponse = async ({
+  response,
+  creatingProject,
+  currentProjectId,
+}) => {
+  if (response.status !== 200) {
+    throw response.status;
+  }
+
+  const body = await response.json();
+  return {
+    ...body,
+    id: creatingProject ? body["content-name"] : currentProjectId,
+  };
 };
 
 const scratchProjectSave = async ({
@@ -19,29 +48,25 @@ const scratchProjectSave = async ({
   vmState,
   params,
 }) => {
-  const creatingProject =
-    currentProjectId === null || typeof currentProjectId === "undefined";
-  const queryString = buildQueryString(params);
-  const url = creatingProject
-    ? `${apiUrl}/api/scratch/projects/${queryString}`
-    : `${apiUrl}/api/scratch/projects/${currentProjectId}${queryString}`;
-
+  const { creatingProject, method, url } = buildScratchProjectSaveRequest({
+    apiUrl,
+    currentProjectId,
+    params,
+  });
   const response = await scratchFetchApi.scratchFetch(url, {
-    method: creatingProject ? "post" : "put",
+    method,
     body: vmState,
     headers: {
       "Content-Type": "application/json",
     },
     credentials: "include",
   });
 
-  if (response.status !== 200) {
-    throw response.status;
-  }
-
-  const body = await response.json();
-  body.id = creatingProject ? body["content-name"] : currentProjectId;
-  return body;
+  return normalizeScratchProjectSaveResponse({
+    response,
+    creatingProject,
+    currentProjectId,
+  });
 };
 
 export default scratchProjectSave;

src/utils/scratchProjectSave.test.js

@@ -0,0 +1,91 @@
+import scratchProjectSave from "./scratchProjectSave";
+
+describe("scratchProjectSave", () => {
+  const buildScratchFetchApi = () => ({
+    scratchFetch: jest.fn(),
+  });
+
+  test("updates an existing project through scratchFetch", async () => {
+    const scratchFetchApi = buildScratchFetchApi();
+    scratchFetchApi.scratchFetch.mockResolvedValue({
+      status: 200,
+      json: jest.fn().mockResolvedValue({ ok: true }),
+    });
+
+    const response = await scratchProjectSave({
+      scratchFetchApi,
+      apiUrl: "https://api.example.com",
+      currentProjectId: "project-123",
+      vmState: '{"targets":[]}',
+      params: { title: "Saved from test" },
+    });
+
+    expect(scratchFetchApi.scratchFetch).toHaveBeenCalledWith(
+      "https://api.example.com/api/scratch/projects/project-123?title=Saved+from+test",
+      {
+        method: "put",
+        body: '{"targets":[]}',
+        headers: {
+          "Content-Type": "application/json",
+        },
+        credentials: "include",
+      },
+    );
+    expect(response).toEqual({ ok: true, id: "project-123" });
+  });
+
+  test("creates a project and returns the created id", async () => {
+    const scratchFetchApi = buildScratchFetchApi();
+    scratchFetchApi.scratchFetch.mockResolvedValue({
+      status: 200,
+      json: jest
+        .fn()
+        .mockResolvedValue({ "content-name": "created-project-id" }),
+    });
+
+    const response = await scratchProjectSave({
+      scratchFetchApi,
+      apiUrl: "https://api.example.com",
+      currentProjectId: undefined,
+      vmState: '{"targets":[]}',
+      params: {
+        originalId: "source-project",
+        isRemix: 1,
+        title: "Created from test",
+      },
+    });
+
+    expect(scratchFetchApi.scratchFetch).toHaveBeenCalledWith(
+      "https://api.example.com/api/scratch/projects/?original_id=source-project&is_remix=1&title=Created+from+test",
+      {
+        method: "post",
+        body: '{"targets":[]}',
+        headers: {
+          "Content-Type": "application/json",
+        },
+        credentials: "include",
+      },
+    );
+    expect(response).toEqual({
+      "content-name": "created-project-id",
+      id: "created-project-id",
+    });
+  });
+
+  test("rejects with the response status when the save fails", async () => {
+    const scratchFetchApi = buildScratchFetchApi();
+    scratchFetchApi.scratchFetch.mockResolvedValue({
+      status: 401,
+      json: jest.fn(),
+    });
+
+    await expect(
+      scratchProjectSave({
+        scratchFetchApi,
+        apiUrl: "https://api.example.com",
+        currentProjectId: "project-123",
+        vmState: '{"targets":[]}',
+      }),
+    ).rejects.toBe(401);
+  });
+});