feat: fail build if ref can't be resolved

Author: CountRedClaw

src/apitypes/rest/rest.operations.ts

@@ -18,7 +18,7 @@ import { OpenAPIV3 } from 'openapi-types'
 
 import { buildRestOperation } from './rest.operation'
 import type { OperationsBuilder } from '../../types'
-import { removeComponents, removeFirstSlash, slugify } from '../../utils'
+import { removeComponents, removeFirstSlash, slugify, takeIf } from '../../utils'
 import { getOperationBasePath } from './rest.utils'
 import type * as TYPE from './rest.types'
 import { HASH_FLAG, INLINE_REFS_FLAG, MESSAGE_SEVERITY, NORMALIZE_OPTIONS, ORIGINS_SYMBOL } from '../../consts'
@@ -37,6 +37,18 @@ export const buildRestOperations: OperationsBuilder<OpenAPIV3.Document> = async
         originsFlag: ORIGINS_SYMBOL,
         hashFlag: HASH_FLAG,
         source: document.data,
+        ...takeIf({
+          onRefResolveError: (message: string, path: PropertyKey[], ref: string) => {
+            // console.debug([
+            //   '[Ref Resolve Error]',
+            //   `Message: ${message}`,
+            //   `JSON path: ${path}`,
+            //   `Ref: ${ref}`,
+            // ].join('\n'))
+            // todo is this message enough? (ErrorMessage.refNotFound)
+            throw new Error(message)
+          },
+        }, !!ctx.config.strictValidation),
       },
     ) as OpenAPIV3.Document
     const refsOnlyDocument = normalize(

src/builder.ts

@@ -90,7 +90,7 @@ export class PackageVersionBuilder implements IPackageVersionBuilder {
 
   constructor(config: BuildConfig, public params: BuilderParams, fileSources?: FileSourceMap) {
     this.apiBuilders.push(restApiBuilder, graphqlApiBuilder, textApiBuilder, unknownApiBuilder)
-    this.config = { previousVersion: '', previousVersionPackageId: '', ...config }
+    this.config = { previousVersion: '', previousVersionPackageId: '', strictValidation: true, ...config }
 
     this.params.configuration = {
       batchSize: DEFAULT_BATCH_SIZE,

src/types/external/config.ts

@@ -48,6 +48,8 @@ export interface BuildConfig {
 
   metadata?: Record<string, unknown>
   format?: OperationsGroupExportFormat
+
+  strictValidation?: boolean
 }
 
 export interface BuildConfigFile {

test/bundle-dependencies.test.ts

@@ -0,0 +1,28 @@
+import { LocalRegistry } from './helpers'
+
+describe('Bundle dependencies test', () => {
+  test('components external dependencies should be bundled', async () => {
+    const pkg = LocalRegistry.openPackage('bundle-dependencies/case1')
+    const result = await pkg.publish(pkg.packageId, { packageId: pkg.packageId })
+
+    expect(result.documents.get('main.yaml')?.dependencies).toEqual(['dependency.yaml'])
+  })
+
+  // todo test transitive deps bundling (unknown document)
+
+  test('should throw on invalid ref', async () => {
+    const pkg = LocalRegistry.openPackage('bundle-dependencies/case2')
+
+    await expect(pkg.publish(pkg.packageId)).rejects.toThrowError(/\$ref can't be resolved/)
+  })
+
+  test('should not throw on invalid ref', async () => {
+    const pkg = LocalRegistry.openPackage('bundle-dependencies/case2')
+    const result = await pkg.publish(pkg.packageId, {
+      packageId: pkg.packageId,
+      strictValidation: false,
+    })
+
+    expect(result.documents.get('main.yaml')?.dependencies.length).toBe(0)
+  })
+})

test/helpers/registry/local.ts

@@ -319,7 +319,7 @@ export class LocalRegistry implements IRegistry {
     return null
   }
 
-  async publish(projectId: string, publishParams?: Partial<BuildConfig>): Promise<void> {
+  async publish(projectId: string, publishParams?: Partial<BuildConfig>): Promise<BuildResult> {
     const loadedConfig = await loadConfig(this.projectsDir, projectId) as BuildConfig
     const versionConfig = {
       ...loadedConfig,
@@ -336,6 +336,8 @@ export class LocalRegistry implements IRegistry {
     const buildResult = await builder.run()
 
     await this.publishPackage(buildResult, builder.builderContext(versionConfig), versionConfig)
+
+    return buildResult
   }
 
   async publishPackage(

test/projects/bundle-dependencies/case1/config.json

@@ -0,0 +1,19 @@
+{
+  "packageId": "bundle-dependencies",
+  "apiType": "rest",
+  "version": "v1",
+  "files": [
+    {
+      "fileId": "dependency.yaml",
+      "publish": true,
+      "labels": [],
+      "commitId": "6c778b1f44200bd19944a6a8eac10a4e5a21a1cd"
+    },
+    {
+      "fileId": "main.yaml",
+      "publish": true,
+      "labels": [],
+      "commitId": "6c778b1f44200bd19944a6a8eac10a4e5a21a1xd"
+    }
+  ]
+}

test/projects/bundle-dependencies/case1/dependency.yaml

@@ -0,0 +1,7 @@
+User:
+  type: object
+  properties:
+    id:
+      type: integer
+    name:
+      type: string

test/projects/bundle-dependencies/case1/main.yaml

@@ -0,0 +1,16 @@
+openapi: 3.0.1
+info:
+  title: API
+  version: 1.0.0
+paths:
+  /users:
+    get:
+      responses:
+        '200':
+          description: description
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: './dependency.yaml#/User'

test/projects/bundle-dependencies/case2/config.json

@@ -0,0 +1,19 @@
+{
+  "packageId": "bundle-dependencies",
+  "apiType": "rest",
+  "version": "v1",
+  "files": [
+    {
+      "fileId": "dependency.yaml",
+      "publish": true,
+      "labels": [],
+      "commitId": "6c778b1f44200bd19944a6a8eac10a4e5a21a1cd"
+    },
+    {
+      "fileId": "main.yaml",
+      "publish": true,
+      "labels": [],
+      "commitId": "6c778b1f44200bd19944a6a8eac10a4e5a21a1xd"
+    }
+  ]
+}

test/projects/bundle-dependencies/case2/dependency.yaml

@@ -0,0 +1,7 @@
+User:
+  type: object
+  properties:
+    id:
+      type: integer
+    name:
+      type: string