Do not throw when the server responds with something we do not have in the schema yet

Mentioning @mifi @remcohaszing @Acconut @tim-kos because this may be controversial, but i think when retrofitting types and schemas on a big api like ours, this is the least evil and still a good step forward.

Author: kvz

src/Transloadit.ts

@@ -28,6 +28,8 @@ import {
   assemblyStatusSchema,
   assemblyIndexItemSchema,
   type AssemblyIndexItem,
+  assemblyIndexSchema,
+  AssemblyIndex,
 } from './alphalib/types/assemblyStatus.js'
 import type {
   BaseResponse,
@@ -398,10 +400,21 @@ export class Transloadit {
 
     const parsedResult = zodParseWithContext(assemblyStatusSchema, rawResult)
     if (!parsedResult.success) {
-      throw new InconsistentResponseError(
+      const err = new InconsistentResponseError(
         `The API responded with data that does not match the expected schema.\n${parsedResult.humanReadable}`
       )
+      // eslint-disable-next-line no-console
+      console.error(
+        `---\nPlease report this error to Transloadit ([email protected]). We are working on better schemas for our API and this looks like something we do not cover yet: \n\n${err}\nThank you in advance!---\n`
+      )
+      // @TODO, once our schemas have matured, we should throw the error here.
+      // But as it stands, schemas are new, and we can't easily update all customer's node-sdks,
+      // so there will be a long tail of throws if we enable this now.
+      checkAssemblyUrls(rawResult as AssemblyStatus)
+      return rawResult as AssemblyStatus
     }
+
+    checkAssemblyUrls(parsedResult.safe)
     return parsedResult.safe
   }
 
@@ -471,12 +484,23 @@ export class Transloadit {
       )
     }
 
-    const parsedResult = zodParseWithContext(z.array(assemblyIndexItemSchema), rawResponse.items)
+    const parsedResult = zodParseWithContext(assemblyIndexSchema, rawResponse.items)
 
     if (!parsedResult.success) {
-      throw new InconsistentResponseError(
+      const err = new InconsistentResponseError(
         `API response for listAssemblies contained items that do not match the expected schema.\n${parsedResult.humanReadable}`
       )
+      // eslint-disable-next-line no-console
+      console.error(
+        `---\nPlease report this error to Transloadit ([email protected]). We are working on better schemas for our API and this looks like something we do not cover yet: \n\n${err}\nThank you in advance!---\n`
+      )
+      return {
+        // @TODO, once our schemas have matured, we should throw the error here.
+        // But as it stands, schemas are new, and we can't easily update all customer's node-sdks,
+        // so there will be a long tail of throws if we enable this now.
+        items: rawResponse.items as AssemblyIndex,
+        count: rawResponse.count,
+      }
     }
 
     return {
@@ -503,9 +527,18 @@ export class Transloadit {
     const parsedResult = zodParseWithContext(assemblyStatusSchema, rawResult)
 
     if (!parsedResult.success) {
-      throw new InconsistentResponseError(
+      const err = new InconsistentResponseError(
         `The API responded with data that does not match the expected schema.\n${parsedResult.humanReadable}`
       )
+      // eslint-disable-next-line no-console
+      console.error(
+        `---\nPlease report this error to Transloadit ([email protected]). We are working on better schemas for our API and this looks like something we do not cover yet: \n\n${err}\nThank you in advance!---\n`
+      )
+      // @TODO, once our schemas have matured, we should throw the error here.
+      // But as it stands, schemas are new, and we can't easily update all customer's node-sdks,
+      // so there will be a long tail of throws if we enable this now.
+      checkAssemblyUrls(rawResult as AssemblyStatus)
+      return rawResult as AssemblyStatus
     }
 
     checkAssemblyUrls(parsedResult.safe)

src/alphalib/types/assemblyStatus.ts

@@ -381,8 +381,8 @@ const assemblyStatusBaseSchema = z.object({
     .optional(),
   is_infinite: z.boolean().optional(),
   has_dupe_jobs: z.boolean().optional(),
-  execution_start: z.string().optional(),
-  execution_duration: z.number().optional(),
+  execution_start: z.string().nullable().optional(),
+  execution_duration: z.number().nullable().optional(),
   queue_duration: z.number().optional(),
   jobs_queue_duration: z.number().optional(),
   notify_start: z.string().nullable().optional(),
@@ -606,3 +606,6 @@ export const assemblyIndexItemSchema = z
   .strict()
 
 export type AssemblyIndexItem = z.infer<typeof assemblyIndexItemSchema>
+
+export const assemblyIndexSchema = z.array(assemblyIndexItemSchema)
+export type AssemblyIndex = z.infer<typeof assemblyIndexSchema>