Pass HTTP status code & errcode from CS-API errors

Author: AndrewFerr

src/ClientWidgetApi.ts

@@ -22,7 +22,7 @@ import { WidgetApiDirection } from "./interfaces/WidgetApiDirection";
 import { IWidgetApiRequest, IWidgetApiRequestEmptyData } from "./interfaces/IWidgetApiRequest";
 import { IContentLoadedActionRequest } from "./interfaces/ContentLoadedAction";
 import { WidgetApiFromWidgetAction, WidgetApiToWidgetAction } from "./interfaces/WidgetApiAction";
-import { IWidgetApiErrorResponseData } from "./interfaces/IWidgetApiErrorResponse";
+import { IWidgetApiErrorResponseData, isMatrixError } from "./interfaces/IWidgetApiErrorResponse";
 import { Capability, MatrixCapabilities } from "./interfaces/Capabilities";
 import { IOpenIDUpdate, ISendEventDetails, ISendDelayedEventDetails, WidgetDriver } from "./driver/WidgetDriver";
 import {
@@ -554,10 +554,13 @@ export class ClientWidgetApi extends EventEmitter {
                     delay_id: sentEvent.delayId,
                 }),
             });
-        }).catch(e => {
+        }).catch((e: unknown) => {
             console.error("error sending event: ", e);
             return this.transport.reply<IWidgetApiErrorResponseData>(request, {
-                error: {message: "Error sending event"},
+                error: {
+                    message: "Error sending event",
+                    ...(isMatrixError(e) && e),
+                },
             });
         });
     }
@@ -581,10 +584,13 @@ export class ClientWidgetApi extends EventEmitter {
             case UpdateDelayedEventAction.Send:
                 this.driver.updateDelayedEvent(request.data.delay_id, request.data.action).then(() => {
                     return this.transport.reply<IWidgetApiAcknowledgeResponseData>(request, {});
-                }).catch(e => {
+                }).catch((e: unknown) => {
                     console.error("error updating delayed event: ", e);
                     return this.transport.reply<IWidgetApiErrorResponseData>(request, {
-                        error: {message: "Error updating delayed event"},
+                        error: {
+                            message: "Error updating delayed event",
+                            ...(isMatrixError(e) && e),
+                        },
                     });
                 });
                 break;
@@ -736,7 +742,10 @@ export class ClientWidgetApi extends EventEmitter {
         } catch (e) {
             console.error("error getting the relations", e);
             await this.transport.reply<IWidgetApiErrorResponseData>(request, {
-                error: { message: "Unexpected error while reading relations" },
+                error: {
+                    message: "Unexpected error while reading relations",
+                    ...(isMatrixError(e) && e),
+                },
             });
         }
     }
@@ -779,7 +788,10 @@ export class ClientWidgetApi extends EventEmitter {
         } catch (e) {
             console.error("error searching in the user directory", e);
             await this.transport.reply<IWidgetApiErrorResponseData>(request, {
-                error: { message: "Unexpected error while searching in the user directory" },
+                error: {
+                    message: "Unexpected error while searching in the user directory",
+                    ...(isMatrixError(e) && e),
+                },
             });
         }
     }
@@ -801,7 +813,10 @@ export class ClientWidgetApi extends EventEmitter {
         } catch (e) {
             console.error("error while getting the media configuration", e);
             await this.transport.reply<IWidgetApiErrorResponseData>(request, {
-                error: { message: "Unexpected error while getting the media configuration" },
+                error: {
+                    message: "Unexpected error while getting the media configuration",
+                    ...(isMatrixError(e) && e),
+                },
             });
         }
     }
@@ -823,7 +838,10 @@ export class ClientWidgetApi extends EventEmitter {
         } catch (e) {
             console.error("error while uploading a file", e);
             await this.transport.reply<IWidgetApiErrorResponseData>(request, {
-                error: { message: "Unexpected error while uploading a file" },
+                error: {
+                    message: "Unexpected error while uploading a file",
+                    ...(isMatrixError(e) && e),
+                },
             });
         }
     }

src/interfaces/IWidgetApiErrorResponse.ts

@@ -16,10 +16,24 @@
 
 import { IWidgetApiResponse, IWidgetApiResponseData } from "./IWidgetApiResponse";
 
+interface IWidgetApiErrorData {
+    message: string;
+}
+
+interface IMatrixErrorData {
+    httpStatus?: number;
+    errcode?: string;
+}
+
 export interface IWidgetApiErrorResponseData extends IWidgetApiResponseData {
-    error: {
-        message: string;
-    };
+    error: IWidgetApiErrorData & IMatrixErrorData;
+}
+
+export function isMatrixError(err: unknown): err is IMatrixErrorData {
+    return typeof err === "object" && err !== null && (
+        "httpStatus" in err && typeof err.httpStatus === "number" ||
+        "errcode" in err && typeof err.errcode === "string"
+    );
 }
 
 export interface IWidgetApiErrorResponse extends IWidgetApiResponse {

src/transport/PostmessageTransport.ts

@@ -35,6 +35,16 @@ interface IOutboundRequest {
     reject: (err: Error) => void;
 }
 
+class MatrixError extends Error {
+    public constructor(
+        msg: string,
+        public readonly httpStatus?: number,
+        public readonly errcode?: string,
+    ) {
+        super(msg);
+    }
+}
+
 /**
  * Transport for the Widget API over postMessage.
  */
@@ -195,7 +205,11 @@ export class PostmessageTransport extends EventEmitter implements ITransport {
 
         if (isErrorResponse(response.response)) {
             const err = <IWidgetApiErrorResponseData>response.response;
-            req.reject(new Error(err.error.message));
+            req.reject(
+                err.error.httpStatus !== undefined || err.error.errcode !== undefined
+                    ? new MatrixError(err.error.message, err.error.httpStatus, err.error.errcode)
+                    : new Error(err.error.message),
+            );
         } else {
             req.resolve(response);
         }