fix(reference): fix bug in reference predicate logic

char0n · char0n · commit 8b5176a211fb · 2021-01-07T15:57:34.000+01:00
Refs swagger-api/oss-planning#133
diff --git a/apidom/packages/apidom-reference/src/resolve-strategies/openapi-3-1/reference-objects/index.ts b/apidom/packages/apidom-reference/src/resolve-strategies/openapi-3-1/reference-objects/index.ts
@@ -93,6 +93,7 @@ const ReferenceObjectsResolveStrategy: stampit.Stamp<IResolveStrategy> = stampit
     return [
       'application/vnd.oai.openapi;version=3.1.0',
       'application/vnd.oai.openapi+json;version=3.1.0',
+      'application/vnd.oai.openapi+yaml;version=3.1.0',
     ].includes(file.mediaType);
   };
 
diff --git a/apidom/packages/apidom-reference/src/resolve-strategies/openapi-3-1/reference-objects/predicates.ts b/apidom/packages/apidom-reference/src/resolve-strategies/openapi-3-1/reference-objects/predicates.ts
@@ -1,4 +1,5 @@
 import { startsWith } from 'ramda';
+import { isNonEmptyString } from 'ramda-adjunct';
 import { isStringElement, isObjectElement } from 'apidom';
 import { isReferenceElement } from 'apidom-ns-openapi-3-1';
 
@@ -16,7 +17,9 @@ export const isExternalReferenceElement = (element: any): boolean => {
     return false;
   }
 
-  return !startsWith('#', $refElement.toValue());
+  const value = $refElement.toValue();
+
+  return isNonEmptyString(value) && !startsWith('#', value);
 };
 
 /**
diff --git a/apidom/packages/apidom-reference/test/index.ts b/apidom/packages/apidom-reference/test/index.ts
@@ -2,7 +2,7 @@ import { assert } from 'chai';
 import { isParseResultElement } from 'apidom';
 import path from 'path';
 
-import { parse, resolve } from '../src';
+import { parse, resolve, resolveApiDOM } from '../src';
 
 describe('apidom-reference', function () {
   context('parse', function () {
@@ -38,4 +38,19 @@ describe('apidom-reference', function () {
       });
     });
   });
+
+  context('resolveApiDOM', function () {
+    context('given ApiDOM data', function () {
+      specify('should resolve ApiDOM', async function () {
+        const uri = path.join(__dirname, 'fixtures', 'resolve', 'sample-openapi-3-1-api.json');
+        const options = {
+          parse: { mediaType: 'application/vnd.oai.openapi+json;version=3.1.0' },
+        };
+        const parseResult = await parse(uri, options);
+        const refSet = await resolveApiDOM(parseResult, options);
+
+        assert.strictEqual(refSet.size, 1);
+      });
+    });
+  });
 });
diff --git a/apidom/packages/apidom-reference/test/resolve-strategies/openapi-3-1/fixtures/sample-api.yaml b/apidom/packages/apidom-reference/test/resolve-strategies/openapi-3-1/fixtures/sample-api.yaml
@@ -0,0 +1,138 @@
+# stream comment
+---
+openapi: 3.1.0
+x-top-level: value
+info:
+  title: Sample API
+  unknownFixedField: value
+  description: Optional multiline or single-line description in [CommonMark](http://commonmark.org/help/)
+    or HTML.
+  summary: example summary
+  termsOfService: Terms of service
+  version: 0.1.9
+  x-version: 0.1.9-beta
+  license:
+    name: Apache License 2.0
+    x-fullName: Apache License 2.0
+    identifier: Apache License 2.0
+    url: https://www.apache.org/licenses/LICENSE-2.0
+  contact:
+    name: Vladimir Gorej
+    x-username: char0n
+    url: https://www.linkedin.com/in/vladimirgorej/
+    email: vladimir.gorej@gmail.com
+servers:
+  - url: http://api.example.com/v1
+    description: Optional server description, e.g. Main (production) server
+  - url: http:{port}//staging-api.example.com
+    description: Optional server description, e.g. Internal staging server for testing
+    variables:
+      port:
+        enum:
+          - 8443
+          - 443
+        default: 8443
+        description: Port description
+components:
+  x-extension: value
+  schemas:
+    x-model:
+      type: object
+      properties:
+        id:
+          type: integer
+    User:
+      type: object
+      properties:
+        id:
+          type: integer
+        name:
+          type: string
+        profile:
+          $ref: #/components/schemas/UserProfile
+    UserProfile:
+      type: object
+      properties:
+        email:
+          type: string
+          x-nullable: true
+  parameters:
+    userId:
+      $ref: #/components/parameters/userIdRef
+    userIdRef:
+      name: userId,
+      in: query,
+      description: ID of the user,
+      required: true
+security:
+  - {}
+  - petstore_auth:
+      - write:pets
+      - read:pets
+paths:
+  /users:
+    summary: path item summary
+    description: path item description
+    get:
+      tags:
+        - tag1
+        - tag2
+      summary: Returns a list of users.
+      description: Optional extended description in CommonMark or HTML.
+      externalDocs:
+        description: Find more info here
+        url: https://example.com
+      operationId: getUserList
+      parameters:
+        - "$ref": #/components/parameters/userId
+      requestBody:
+        content: {}
+      responses:
+        200:
+          description: A JSON array of user names
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  type: string
+        201:
+          description: A response
+          content:
+            application/json:
+              schema:
+                $ref: #/components/schemas/User
+        xxx:
+          key: val
+      callbacks:
+        myCallback:
+          '{$request.query.queryUrl}':
+            post:
+              requestBody:
+                description: Callback payload
+                content:
+                  application/json:
+                    schema:
+                      $ref: #/components/schemas/User
+              responses:
+                200:
+                  description: callback successfully processed
+      deprecated: true
+      security:
+        - {}
+        - petstore_auth:
+            - write:pets
+            - read:pets
+      servers:
+        - url: http://api.example.com/v3
+          description: Redundant server description, e.g. redundant server
+    servers:
+      - url: http://api.example.com/v2
+        description: Redundant server description, e.g. redundant server
+    parameters:
+      - name: userId
+        in: query
+        description: ID of the user
+        required: true
+...
+prop: value
diff --git a/apidom/packages/apidom-reference/test/resolve-strategies/openapi-3-1/index.ts b/apidom/packages/apidom-reference/test/resolve-strategies/openapi-3-1/index.ts
@@ -256,6 +256,31 @@ describe('resolve-strategies', function () {
           });
         });
       });
+
+      context('given YAML OpenApi 3.1.x document with no external reference', function () {
+        let rootFile: IFile;
+        let refSet: IReferenceSet;
+
+        beforeEach(async function () {
+          const uri = path.join(__dirname, 'fixtures', 'sample-api.yaml');
+          const mediaType = 'application/vnd.oai.openapi+yaml;version=3.1.0';
+          const data = fs.readFileSync(uri);
+          const parseResult = await parse(uri, { parse: { mediaType } });
+
+          rootFile = File({ uri, mediaType, data, parseResult });
+          refSet = await strategy.resolve(rootFile, defaultOptions);
+        });
+
+        specify('should have 1 reference in reference set', async function () {
+          assert.strictEqual(refSet.size, 1);
+        });
+
+        specify('should have root reference set to baseURI', async function () {
+          const { rootRef } = refSet;
+
+          assert.strictEqual(rootRef.uri, rootFile.uri);
+        });
+      });
     });
   });
 });
diff --git a/apidom/packages/apidom-reference/test/resolvers/HttpResolverAxios.ts b/apidom/packages/apidom-reference/test/resolvers/HttpResolverAxios.ts
@@ -78,6 +78,8 @@ describe('resolvers', function () {
 
         specify('should throw on timeout', async function () {
           resolver = HttpResolverAxios({ timeout: 1 });
+          axiosInstance = resolver.getHttpClient();
+          axiosMock = new MockAdapter(resolver.getHttpClient());
           const url = 'https://httpbin.org/anything';
 
           axiosMock.onGet(url).timeout();
@@ -108,18 +110,17 @@ describe('resolvers', function () {
         });
 
         context('given withCredentials option', function () {
-          specify('should allow cross-site Access-Control requests', function (done) {
+          specify('should allow cross-site Access-Control requests', async function () {
             resolver = HttpResolverAxios({ withCredentials: true });
             axiosInstance = resolver.getHttpClient();
             axiosMock = new MockAdapter(axiosInstance);
             const url = 'https://httpbin.org/anything';
 
             axiosMock.onGet(url).reply((config: AxiosRequestConfig) => {
               assert.isTrue(config.withCredentials);
-              done();
-              return [200];
+              return [200, Buffer.from('data')];
             });
-            resolver.read(File({ uri: url }));
+            await resolver.read(File({ uri: url }));
           });
         });
 
