feat: change escapePointer-unescapePointer logic

Author: DmitryAnansky

packages/core/src/__tests__/ref-utils.test.ts

@@ -1,6 +1,6 @@
 import outdent from 'outdent';
 import { parseYamlToDocument } from '../../__tests__/utils.js';
-import { escapePointer, parseRef, refBaseName, unescapePointerFromURI } from '../ref-utils.js';
+import { escapePointer, parseRef, refBaseName, unescapePointer } from '../ref-utils.js';
 import { lintDocument } from '../lint.js';
 import { createConfig } from '../config/index.js';
 import { BaseResolver } from '../resolve.js';
@@ -35,7 +35,7 @@ describe('ref-utils', () => {
   });
 
   it(`should unescape complex urlencoded paths`, () => {
-    const referene = 'somefile.yaml#/components/schemas/scope%2Fcomplex~name';
+    const referene = 'somefile.yaml#/components/schemas/scope~1complex~0name';
     expect(parseRef(referene)).toMatchInlineSnapshot(`
       {
         "pointer": [
@@ -155,21 +155,17 @@ describe('ref-utils', () => {
 
     it('should not URI-encode special characters when escaping pointers', () => {
       // escapePointer should only handle JSON Pointer escaping, not URI encoding
-      expect(escapePointer('activity_level_%')).toStrictEqual('activity_level_%');
+      expect(escapePointer('activity_level_%')).toStrictEqual('activity_level_%25');
     });
   });
 
-  describe('unescapePointerFromURI', () => {
+  describe('unescapePointer', () => {
     it('should unescape a pointer with a percent sign correctly', () => {
-      expect(unescapePointerFromURI('activity_level_%25')).toStrictEqual('activity_level_%');
-    });
-
-    it('should unescape a pointer with a number correctly', () => {
-      expect(unescapePointerFromURI('123')).toStrictEqual('123');
+      expect(unescapePointer('activity_level_%25')).toStrictEqual('activity_level_%');
     });
 
     it('should unescape a pointer correctly', () => {
-      expect(unescapePointerFromURI('scope~1complex~0name')).toStrictEqual('scope/complex~name');
+      expect(unescapePointer('scope~1complex~0name')).toStrictEqual('scope/complex~name');
     });
   });
 });

packages/core/src/index.ts

@@ -53,7 +53,6 @@ export { YamlParseError } from './errors/yaml-parse-error.js';
 export { parseYaml, stringifyYaml } from './js-yaml/index.js';
 export {
   unescapePointer,
-  unescapePointerFromURI,
   isRef,
   isAbsoluteUrl,
   escapePointer,

packages/core/src/ref-utils.ts

@@ -36,28 +36,35 @@ export class Location {
   }
 
   get absolutePointer() {
-    return this.source.absoluteRef + (this.pointer === '#/' ? '' : encodeURI(this.pointer));
+    return this.source.absoluteRef + (this.pointer === '#/' ? '' : this.pointer);
   }
 }
 
 export function unescapePointer(fragment: string): string {
-  return fragment.replace(/~1/g, '/').replace(/~0/g, '~');
-}
-
-export function unescapePointerFromURI(fragment: string): string {
-  return unescapePointer(decodeURIComponent(fragment));
+  return decodeURIComponent(fragment).replaceAll('~1', '/').replaceAll('~0', '~');
 }
 
 export function escapePointer<T extends string | number>(fragment: T): T {
   if (typeof fragment === 'number') return fragment;
-  return fragment.replace(/~/g, '~0').replace(/\//g, '~1') as T;
+  return encodeURIFragmentIdentifier(fragment.replaceAll('~', '~0').replaceAll('/', '~1')) as T;
+}
+
+// RFC 6901: https://datatracker.ietf.org/doc/html/rfc6901#section-6
+function encodeURIFragmentIdentifier(fragment: string): string {
+  return fragment
+    .replaceAll('%', '%25')
+    .replaceAll('^', '%5E')
+    .replaceAll('|', '%7C')
+    .replaceAll('\\\\', '%5C')
+    .replaceAll('\\', '%22')
+    .replaceAll(' ', '%20');
 }
 
 export function parseRef(ref: string): { uri: string | null; pointer: string[] } {
   const [uri, pointer = ''] = ref.split('#/');
   return {
     uri: (uri.endsWith('#') ? uri.slice(0, -1) : uri) || null,
-    pointer: pointer.split('/').map(unescapePointerFromURI).filter(isTruthy),
+    pointer: parsePointer(pointer),
   };
 }
 

packages/core/src/rules/oas3/__tests__/spec-components-invalid-map-name.test.ts

@@ -43,7 +43,7 @@ describe('Oas3 spec-components-invalid-map-name', () => {
         {
           "location": [
             {
-              "pointer": "#/components/parameters/my Param",
+              "pointer": "#/components/parameters/my%20Param",
               "reportOnKey": true,
               "source": Source {
                 "absoluteRef": "",
@@ -79,7 +79,7 @@ describe('Oas3 spec-components-invalid-map-name', () => {
         {
           "location": [
             {
-              "pointer": "#/components/schemas/first schema",
+              "pointer": "#/components/schemas/first%20schema",
               "reportOnKey": true,
               "source": Source {
                 "absoluteRef": "",
@@ -115,7 +115,7 @@ describe('Oas3 spec-components-invalid-map-name', () => {
         {
           "location": [
             {
-              "pointer": "#/components/responses/400 status",
+              "pointer": "#/components/responses/400%20status",
               "reportOnKey": true,
               "source": Source {
                 "absoluteRef": "",
@@ -151,7 +151,7 @@ describe('Oas3 spec-components-invalid-map-name', () => {
         {
           "location": [
             {
-              "pointer": "#/components/examples/invalid identifier",
+              "pointer": "#/components/examples/invalid%20identifier",
               "reportOnKey": true,
               "source": Source {
                 "absoluteRef": "",
@@ -251,7 +251,7 @@ describe('Oas3 spec-components-invalid-map-name', () => {
         {
           "location": [
             {
-              "pointer": "#/components/parameters/my Param",
+              "pointer": "#/components/parameters/my%20Param",
               "reportOnKey": true,
               "source": Source {
                 "absoluteRef": "",

tests/e2e/lint/no-invalid-schema-examples-oas3.1-error/openapi.yaml

@@ -39,6 +39,10 @@ paths:
                   examples:
                     - test
                     - 25
+                three_%:
+                  type: number
+                  example: wrong
+
       responses:
         '200':
           description: My 200 response

tests/e2e/lint/no-invalid-schema-examples-oas3.1-error/snapshot.txt

@@ -20,22 +20,38 @@ Error was generated by the no-invalid-schema-examples rule.
 
 Example value must conform to the schema: type must be string.
 
-39 |             examples:
-40 |               - test
-41 |               - 25
-   |                 ^^
-42 | responses:
-43 |   '200':
+39 |   examples:
+40 |     - test
+41 |     - 25
+   |       ^^
+42 | three_%:
+43 |   type: number
 
 referenced from openapi.yaml:36:19 at #/paths/~1my_post/post/requestBody/content/application~1json/schema/properties/two 
 
 Error was generated by the no-invalid-schema-examples rule.
 
 
+[3] openapi.yaml:44:28 at #/paths/~1my_post/post/requestBody/content/application~1json/schema/properties/three_%25/example
+
+Example value must conform to the schema: type must be number.
+
+42 |           three_%:
+43 |             type: number
+44 |             example: wrong
+   |                      ^^^^^
+45 |
+46 | responses:
+
+referenced from openapi.yaml:43:19 at #/paths/~1my_post/post/requestBody/content/application~1json/schema/properties/three_%25 
+
+Error was generated by the no-invalid-schema-examples rule.
+
+
 
 validating openapi.yaml using lint rules for api 'main'...
 openapi.yaml: validated in <test>ms
 
-❌ Validation failed with 2 errors.
+❌ Validation failed with 3 errors.
 run `redocly lint --generate-ignore-file` to add all problems to the ignore file.