Fix 404 and 403 pulls of files leaving files on disk.

Author: jameswilddev

react-native/services/Request/index.tsx

@@ -278,7 +278,8 @@ export class Request implements RequestInterface {
     queryParameters: QueryParameters,
     abortSignal: null,
     fileUri: string,
-    expectedStatusCodes: ReadonlyArray<T>
+    successfulStatusCodes: ReadonlyArray<T>,
+    unsuccessfulStatusCodes: ReadonlyArray<T>
   ): Promise<T> {
     // Not yet possible with FileSystem.downloadAsync.
     abortSignal;
@@ -293,7 +294,16 @@ export class Request implements RequestInterface {
         },
       });
 
-      this.checkStatusCode(method, url, response.status, expectedStatusCodes);
+      this.checkStatusCode(method, url, response.status, [
+        ...successfulStatusCodes,
+        ...unsuccessfulStatusCodes,
+      ]);
+
+      // It's possible that the application will close before we hit this line,
+      // but this is the best we can do unfortunately.
+      if (unsuccessfulStatusCodes.includes(String(response.status) as T)) {
+        await FileSystem.deleteAsync(fileUri, { idempotent: true });
+      }
 
       return String(response.status) as T;
     } catch (e) {

react-native/services/Request/unit.tsx

@@ -1450,7 +1450,8 @@ test(`get request empty response file`, async () => {
     },
     null,
     `Example File Uri`,
-    [`244`, `123`, `89`]
+    [`244`, `123`, `89`],
+    [`800`, `222`, `347`, `844`]
   );
 
   expect(response).toEqual(`123`);
@@ -1469,6 +1470,58 @@ test(`get request empty response file`, async () => {
   expect(FileSystem.deleteAsync).not.toHaveBeenCalled();
 });
 
+test(`get request empty response file failure status code`, async () => {
+  const fetch = jest.fn();
+  (global as unknown as { fetch: unknown }).fetch = fetch;
+  (
+    FileSystem.downloadAsync as unknown as {
+      mockResolvedValue(value: unknown): void;
+    }
+  ).mockResolvedValue({
+    status: 347,
+  });
+  const request = new Request(
+    `https://example-base-url.com/example/sub/path/`,
+    1000,
+    () => `Example Authorization Header`
+  );
+
+  const response = await request.returningFile(
+    `GET`,
+    `example/route`,
+    { type: `empty` },
+    {
+      "Example Query Parameter A Key": `Example Query Parameter A Value`,
+      "Example Query Parameter B Key": 12.34,
+      "Example Query Parameter C Key": false,
+      "Example Query Parameter D Key": true,
+    },
+    null,
+    `Example File Uri`,
+    [`244`, `123`, `89`],
+    [`800`, `222`, `347`, `844`]
+  );
+
+  expect(response).toEqual(`347`);
+
+  expect(FileSystem.downloadAsync).toBeCalledTimes(1);
+  expect(FileSystem.downloadAsync).toBeCalledWith(
+    `https://example-base-url.com/example/sub/path/example/route?Example%20Query%20Parameter%20A%20Key=Example%20Query%20Parameter%20A%20Value&Example%20Query%20Parameter%20B%20Key=12.34&Example%20Query%20Parameter%20D%20Key`,
+    `Example File Uri`,
+    {
+      headers: { Authorization: `Example Authorization Header` },
+    }
+  );
+
+  expect(FileSystem.deleteAsync).toBeCalledTimes(1);
+  expect(FileSystem.deleteAsync).toBeCalledWith(`Example File Uri`, {
+    idempotent: true,
+  });
+
+  expect(FileSystem.createUploadTask).not.toHaveBeenCalled();
+  expect(fetch).not.toHaveBeenCalled();
+});
+
 test(`get request empty response file invalid status code`, async () => {
   const fetch = jest.fn();
   (global as unknown as { fetch: unknown }).fetch = fetch;
@@ -1497,7 +1550,8 @@ test(`get request empty response file invalid status code`, async () => {
     },
     null,
     `Example File Uri`,
-    [`244`, `123`, `89`]
+    [`244`, `123`, `89`],
+    [`800`, `222`, `347`, `844`]
   );
 
   await expect(promise).rejects.toEqual(

react-native/services/Sync/index.tsx

@@ -556,7 +556,8 @@ export class Sync<
                 {},
                 null,
                 this.fileStore.generatePath(file.uuid),
-                [`200`, `404`, `403`]
+                [`200`],
+                [`404`, `403`]
               );
 
               if (statusCode === `200`) {

react-native/services/Sync/unit.tsx

@@ -88,7 +88,8 @@ type PullFileStep = {
   readonly requestBody: EmptyRequestBody | JsonRequestBody | FileRequestBody;
   readonly queryParameters: QueryParameters;
   readonly fileUri: string;
-  readonly expectedStatusCodes: ReadonlyArray<string>;
+  readonly successfulStatusCodes: ReadonlyArray<string>;
+  readonly failureStatusCodes: ReadonlyArray<string>;
   readonly statusCode: string;
 };
 
@@ -423,7 +424,8 @@ function scenario(
           queryParameters,
           abortSignal,
           fileUri,
-          expectedStatusCodes
+          successfulStatusCodes,
+          failureStatusCodes
         ) => {
           const expectedStep = expectedSteps[actualSteps.length];
 
@@ -434,7 +436,8 @@ function scenario(
             requestBody,
             queryParameters,
             fileUri,
-            expectedStatusCodes,
+            successfulStatusCodes,
+            failureStatusCodes,
             statusCode: expect.anything(),
           });
 
@@ -4886,7 +4889,8 @@ scenario(
       requestBody: { type: `empty` },
       queryParameters: {},
       fileUri: `Example File Path For Uuid dab5ac6d-0ecc-4af9-9022-dda2414bf8b6 Generated By File Store`,
-      expectedStatusCodes: [`200`, `404`, `403`],
+      successfulStatusCodes: [`200`],
+      failureStatusCodes: [`404`, `403`],
       statusCode: `200`,
     },
     {
@@ -4938,7 +4942,8 @@ scenario(
       requestBody: { type: `empty` },
       queryParameters: {},
       fileUri: `Example File Path For Uuid 286b57fd-1551-4899-9f90-07e8727e4823 Generated By File Store`,
-      expectedStatusCodes: [`200`, `404`, `403`],
+      successfulStatusCodes: [`200`],
+      failureStatusCodes: [`404`, `403`],
       statusCode: `200`,
     },
     {
@@ -5695,7 +5700,8 @@ scenario(
       requestBody: { type: `empty` },
       queryParameters: {},
       fileUri: `Example File Path For Uuid 40d92d2c-631f-4a42-ba5e-a70a82bea897 Generated By File Store`,
-      expectedStatusCodes: [`200`, `404`, `403`],
+      successfulStatusCodes: [`200`],
+      failureStatusCodes: [`404`, `403`],
       statusCode: `200`,
     },
     {
@@ -5747,7 +5753,8 @@ scenario(
       requestBody: { type: `empty` },
       queryParameters: {},
       fileUri: `Example File Path For Uuid c2df927b-74be-4d78-8705-7f0a664ba53b Generated By File Store`,
-      expectedStatusCodes: [`200`, `404`, `403`],
+      successfulStatusCodes: [`200`],
+      failureStatusCodes: [`404`, `403`],
       statusCode: `200`,
     },
     {
@@ -7135,7 +7142,8 @@ scenario(
       requestBody: { type: `empty` },
       queryParameters: {},
       fileUri: `Example File Path For Uuid bdf19add-072c-4fd6-bca7-8468f8b80a76 Generated By File Store`,
-      expectedStatusCodes: [`200`, `404`, `403`],
+      successfulStatusCodes: [`200`],
+      failureStatusCodes: [`404`, `403`],
       statusCode: `200`,
     },
     {
@@ -16071,7 +16079,8 @@ scenario(
       requestBody: { type: `empty` },
       queryParameters: {},
       fileUri: `Example File Path For Uuid dab5ac6d-0ecc-4af9-9022-dda2414bf8b6 Generated By File Store`,
-      expectedStatusCodes: [`200`, `404`, `403`],
+      successfulStatusCodes: [`200`],
+      failureStatusCodes: [`404`, `403`],
       statusCode: `403`,
     },
     {
@@ -16392,7 +16401,8 @@ scenario(
       requestBody: { type: `empty` },
       queryParameters: {},
       fileUri: `Example File Path For Uuid 40d92d2c-631f-4a42-ba5e-a70a82bea897 Generated By File Store`,
-      expectedStatusCodes: [`200`, `404`, `403`],
+      successfulStatusCodes: [`200`],
+      failureStatusCodes: [`404`, `403`],
       statusCode: `403`,
     },
     {

react-native/types/RequestInterface/index.tsx

@@ -78,17 +78,19 @@ export interface RequestInterface {
   /**
    * Performs a request which returns a file.  NOTE: timeouts are not yet
    * available for this method.
-   * @template T                The expected response status code(s).
-   * @param method              The HTTP method to use.
-   * @param route               The URL path relative to the base URL.
-   * @param requestBody         The request body to send.
-   * @param queryParameters     The query parameters to include in the URL.
-   * @param abortSignal         When non-null, an AbortController's signal which
-   *                            may be used to remotely cancel the request.
-   * @param fileUri             The URI to which the returned file is to be
-   *                            downloaded.
-   * @param expectedStatusCodes The status codes expected to be returned.
-   * @returns                   The returned status code.
+   * @template T                    The expected response status code(s).
+   * @param method                  The HTTP method to use.
+   * @param route                   The URL path relative to the base URL.
+   * @param requestBody             The request body to send.
+   * @param queryParameters         The query parameters to include in the URL.
+   * @param abortSignal             When non-null, an AbortController's signal
+   *                                which may be used to remotely cancel the
+   *                                request.
+   * @param fileUri                 The URI to which the returned file is to be
+   *                                downloaded.
+   * @param successfulStatusCodes   The status codes which indicate success.
+   * @param unsuccessfulStatusCodes The status codes which indicate failure.
+   * @returns                       The returned status code.
    */
   returningFile<T extends string>(
     method: `GET`,
@@ -97,6 +99,7 @@ export interface RequestInterface {
     queryParameters: QueryParameters,
     abortSignal: null,
     fileUri: string,
-    expectedStatusCodes: ReadonlyArray<T>
+    successfulStatusCodes: ReadonlyArray<T>,
+    unsuccessfulStatusCodes: ReadonlyArray<T>
   ): Promise<T>;
 }