fix(cli): Improve error logging in AsyncAPI v3 parser when parsing lo…

…cation headers. (#6175) * fix(cli): Improve error logging in AsyncAPI v3 parser when parsing location headers. * chore: update changelog
fern-api · Feb 26, 2025 · d4ae8ba · d4ae8ba
1 parent 4d14274
commit d4ae8ba
Show file tree

Hide file tree

Showing 4 changed files with 27 additions and 11 deletions.
diff --git a/fern/pages/changelogs/cli/2025-02-26.mdx b/fern/pages/changelogs/cli/2025-02-26.mdx
@@ -0,0 +1,3 @@
+## 0.54.0-rc11
+**`(fix):`** Improve error logging in AsyncAPI v3 parser when parsing location headers.
+
diff --git a/...ages/changelogs/ts-express/2025-02-25.mdx → ...ages/changelogs/ts-express/2025-02-26.mdx b/...ages/changelogs/ts-express/2025-02-25.mdx → ...ages/changelogs/ts-express/2025-02-26.mdx
diff --git a/packages/cli/api-importers/openapi/openapi-ir-parser/src/asyncapi/v3/parseAsyncAPIV3.ts b/packages/cli/api-importers/openapi/openapi-ir-parser/src/asyncapi/v3/parseAsyncAPIV3.ts
@@ -359,18 +359,25 @@ function convertChannelParameterLocation(location: string): {
     type: "header" | "path" | "payload";
     parameterKey: string;
 } {
-    const [messageType, parameterKey] = location.split("#/");
-    if (messageType == null || parameterKey == null) {
-        throw new Error(`Invalid location format: ${location}`);
-    }
-    if (!messageType.startsWith(LOCATION_PREFIX)) {
-        throw new Error(`Invalid location format: ${location}`);
-    }
-    const type = messageType.substring(LOCATION_PREFIX.length);
-    if (type !== "header" && type !== "path" && type !== "payload") {
-        throw new Error(`Invalid message type: ${type}. Must be one of: header, path, payload`);
+    try {
+        const [messageType, parameterKey] = location.split("#/");
+        if (messageType == null || parameterKey == null) {
+            throw new Error(`Invalid location format: ${location}; unable to parse message type and parameter key`);
+        }
+        if (!messageType.startsWith(LOCATION_PREFIX)) {
+            throw new Error(`Invalid location format: ${location}; expected ${LOCATION_PREFIX} prefix`);
+        }
+        const type = messageType.substring(LOCATION_PREFIX.length);
+        if (type !== "header" && type !== "path" && type !== "payload") {
+            throw new Error(`Invalid message type: ${type}. Must be one of: header, path, payload`);
+        }
+        return { type, parameterKey };
+    } catch (error) {
+        throw new Error(
+            `Invalid location format: ${location}; see here for more details: ` +
+                "https://www.asyncapi.com/docs/reference/specification/v3.0.0#runtimeExpression"
+        );
     }
-    return { type, parameterKey };
 }
 
 function getServerNameFromServerRef(

diff --git a/packages/cli/cli/versions.yml b/packages/cli/cli/versions.yml
@@ -1,3 +1,9 @@
+- changelogEntry:
+  - summary: Improve error logging in AsyncAPI v3 parser when parsing location headers.
+    type: fix
+  irVersion: 55
+  version: 0.54.0-rc11
+
 - changelogEntry:
   - summary: Migrate generators.yml without any specs.
     type: chore
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		## 0.54.0-rc11
		`(fix):` Improve error logging in AsyncAPI v3 parser when parsing location headers.