fix: external files in same directory are not resolved. (#2129)

Co-authored-by: AayushSaini101 <kumaraayush9810@gmail.com>
Co-authored-by: Chan <bot+chan@asyncapi.io>

Author: AayushSaini101

src/domains/services/generator.service.ts

@@ -10,14 +10,16 @@ import AsyncAPIGenerator from '@asyncapi/generator';
 import { spinner } from '@clack/prompts';
 import path from 'path';
 import os from 'os';
+import { pathToFileURL } from 'url';
 import { yellow, magenta } from 'picocolors';
 import { getErrorMessage } from '@utils/error-handler';
 
 /**
  * Options passed to the generator for code generation.
+ * `path` must be a string (document base URI) for @asyncapi/generator to resolve local $ref files.
  */
 interface GeneratorRunOptions {
-  path?: Specification;
+  path?: string;
   [key: string]: unknown;
 }
 
@@ -72,6 +74,20 @@ export class GeneratorService extends BaseService {
     }
   }
 
+  /**
+   * Base URI for parsing, required so relative file $refs resolve next to the spec file (not cwd).
+   */
+  private getGeneratorParseSource(spec: Specification): string | undefined {
+    const filePath = spec.getFilePath();
+    if (filePath !== undefined) {
+      const absolute = path.isAbsolute(filePath)
+        ? filePath
+        : path.resolve(filePath);
+      return pathToFileURL(absolute).href;
+    }
+    return spec.getFileURL();
+  }
+
   /**
    * Generates code from an AsyncAPI specification using the specified template.
    *
@@ -107,9 +123,12 @@ export class GeneratorService extends BaseService {
       : { start: () => null, stop: (message: string) => logs.push(message) };
     s.start('Generation in progress. Keep calm and wait a bit');
     try {
+      const parseSource =
+        this.getGeneratorParseSource(asyncapi) ??
+        (typeof genOption.path === 'string' ? genOption.path : undefined);
       await generator.generateFromString(asyncapi.text(), {
         ...genOption,
-        path: asyncapi,
+        ...(parseSource !== undefined ? { path: parseSource } : {}),
       });
     } catch (err: unknown) {
       s.stop('Generation failed');

test/fixtures/generate-same-dir-ref/asyncapi.yaml

@@ -0,0 +1,9 @@
+asyncapi: "2.6.0"
+info:
+  title: Same-dir ref fixture
+  version: 1.0.0
+channels:
+  test:
+    publish:
+      message:
+        $ref: "./messages.yaml#/messages/TestMessage"

test/fixtures/generate-same-dir-ref/messages.yaml

@@ -0,0 +1,4 @@
+messages:
+  TestMessage:
+    payload:
+      type: string

test/integration/generate/fromTemplate.test.ts

@@ -228,4 +228,27 @@ describe('template', () => {
         }
       );
   });
+
+  describe('same-directory file $ref', () => {
+    test
+      .stdout()
+      .command([
+        'generate:fromTemplate',
+        './test/fixtures/generate-same-dir-ref/asyncapi.yaml',
+        '@asyncapi/minimaltemplate',
+        '--output=./test/docs/same-dir-ref-out',
+        '--force-write',
+        nonInteractive,
+      ])
+      .it(
+        'resolves relative file refs next to the spec file, not cwd (issue #1839)',
+        (ctx, done) => {
+          expect(ctx.stdout).to.contain(
+            'Check out your shiny new generated files at ./test/docs/same-dir-ref-out.\n\n'
+          );
+          cleanup('./test/docs/same-dir-ref-out');
+          done();
+        }
+      );
+  }).timeout(200000);
 });