fix(XHR): typings for processResponse callback

Xmader · Xmader · commit 01cb0847a72a · 2023-08-31T22:57:47.000Z
diff --git a/python/pythonmonkey/builtin_modules/XMLHttpRequest-internal.d.ts b/python/pythonmonkey/builtin_modules/XMLHttpRequest-internal.d.ts
@@ -5,6 +5,24 @@
  * @date    August 2023
  */
 
+/**
+ * `processResponse` callback's argument type
+ */
+export declare interface XHRResponse {
+  /** Response URL */
+  url: string;
+  /** HTTP status */
+  status: number;
+  /** HTTP status message */
+  statusText: string;
+  /** The `Content-Type` header value */
+  contentLength: number;
+  /** Implementation of the `xhr.getResponseHeader` method */
+  getResponseHeader(name: string): string | undefined;
+  /** Implementation of the `xhr.getAllResponseHeaders` method */
+  getAllResponseHeaders(): string;
+}
+
 /**
  * Send request
  */
@@ -17,7 +35,7 @@ export declare function request(
   processRequestBodyChunkLength: (bytesLength: number) => void,
   processRequestEndOfBody: () => void,
   // callbacks for response progress
-  processResponse: (response: any) => void,
+  processResponse: (response: XHRResponse) => void,
   processBodyChunk: (bytes: Uint8Array) => void,
   processEndOfBody: () => void,
 ): Promise<void>;
diff --git a/python/pythonmonkey/builtin_modules/XMLHttpRequest-internal.py b/python/pythonmonkey/builtin_modules/XMLHttpRequest-internal.py
@@ -6,7 +6,18 @@
 import aiohttp
 import yarl
 import io
-from typing import Union, ByteString, Callable, Any
+from typing import Union, ByteString, Callable, TypedDict
+
+class XHRResponse(TypedDict, total=True):
+    """
+    See definitions in `XMLHttpRequest-internal.d.ts`
+    """
+    url: str
+    status: int
+    statusText: str
+    contentLength: int
+    getResponseHeader: Callable[[str], Union[str, None]]
+    getAllResponseHeaders: Callable[[], str]
 
 async def request(
     method: str,
@@ -17,7 +28,7 @@ async def request(
     processRequestBodyChunkLength: Callable[[int], None],
     processRequestEndOfBody: Callable[[], None],
     # callbacks for response progress
-    processResponse: Callable[[Any], None],
+    processResponse: Callable[[XHRResponse], None],
     processBodyChunk: Callable[[bytearray], None],
     processEndOfBody: Callable[[], None],
     /
@@ -52,15 +63,15 @@ def getAllResponseHeaders():
             return "\r\n".join(headers)
 
         # readyState HEADERS_RECEIVED
-        responseData = { # FIXME: PythonMonkey bug: the dict will be GCed if directly as an argument
+        responseData: XHRResponse = { # FIXME: PythonMonkey bug: the dict will be GCed if directly as an argument
             'url': str(res.real_url),
             'status': res.status,
-            'statusText': res.reason,
+            'statusText': str(res.reason or ''),
 
             'getResponseHeader': getResponseHeader,
             'getAllResponseHeaders': getAllResponseHeaders,
             
-            'contentLength': res.content_length,
+            'contentLength': res.content_length or 0,
         }
         processResponse(responseData)
 
diff --git a/python/pythonmonkey/builtin_modules/XMLHttpRequest.js b/python/pythonmonkey/builtin_modules/XMLHttpRequest.js
@@ -488,6 +488,7 @@ class XMLHttpRequest extends XMLHttpRequestEventTarget
   #uploadCompleteFlag = false; // A flag, initially unset.
   #uploadListenerFlag = false; // A flag, initially unset.
   #timedOutFlag = false; // A flag, initially unset.
+  /** @type {import('./XMLHttpRequest-internal').XHRResponse} */
   #response = null;
   /** @type {Uint8Array[]} */
   #receivedBytes = [];
