fix(openapi): HATEOAS href anonymization (#8641)

* fix(openapi): fix the HATEOAS href link anonymization - step 1: enrich the operations & make the impl limitations appear

* fix(openapi): fix the HATEOAS href link anonymization - step 2: fix the anonymization implementation

* chore(openapi): changeset

* Update .changeset/social-pots-obey.md

---------

Co-authored-by: Arnaud Leymet <aleymet@bouyguestelecom.fr>
Co-authored-by: Arda TANRIKULU <ardatanrikulu@gmail.com>

Author: 3 people

.changeset/social-pots-obey.md

@@ -0,0 +1,7 @@
+---
+'@omnigraph/openapi': patch
+---
+
+When there are two operations in the OAS;
+`/products/` and `/products/{id}`
+Due to the bug in the logic, they conflict and the HATEOAS linking can choose the first one without any argument.

e2e/openapi-hateoas/__snapshots__/openapi-hateoas.test.ts.snap

@@ -99,18 +99,24 @@ type Clothing implements Product @join__type(graph: PRODUCTS) @join__implements(
 }
 
 type Query @extraSchemaDefinitionDirective(directives: {transport: [{subgraph: "Products", kind: "rest", location: "http://localhost:<OASService_port>"}]}) @extraSchemaDefinitionDirective(directives: {transport: [{subgraph: "Suppliers", kind: "rest", location: "http://localhost:<OASService_port>"}]}) @join__type(graph: PRODUCTS) @join__type(graph: SUPPLIERS) {
+  """Get all the products"""
+  getProducts: ProductList @httpOperation(subgraph: "Products", path: "/products/", operationSpecificHeaders: [["accept", "application/json"]], httpMethod: GET) @join__field(graph: PRODUCTS)
   """Get a product by ID"""
   getProductById(
     """The product ID"""
     id: Int!
-  ): Product @httpOperation(subgraph: "Products", path: "/products/{args.id}", operationSpecificHeaders: [["accept", "application/json"]], httpMethod: GET) @linkResolver(subgraph: "Products", linkResolverMap: "{\\"self\\":{\\"linkObjArgs\\":{\\"id\\":\\"{root['id']}\\"},\\"targetTypeName\\":\\"Query\\",\\"targetFieldName\\":\\"getProductById\\"}}") @join__field(graph: PRODUCTS)
+  ): Product @httpOperation(subgraph: "Products", path: "/products/{args.id}", operationSpecificHeaders: [["accept", "application/json"]], httpMethod: GET) @linkResolver(subgraph: "Products", linkResolverMap: "{\\\"self\\\":{\\\"linkObjArgs\\\":{\\\"id\\\":\\\"{root['id']}\\\"},\\\"targetTypeName\\\":\\\"Query\\\",\\\"targetFieldName\\\":\\\"getProductById\\\"}}") @join__field(graph: PRODUCTS)
   """Get a supplier by ID"""
   getSupplierById(
     """The supplier ID"""
     id: Int!
   ): Supplier @httpOperation(subgraph: "Suppliers", path: "/suppliers/{args.id}", operationSpecificHeaders: [["accept", "application/json"]], httpMethod: GET) @merge(subgraph: "Suppliers", keyField: "id", keyArg: "id") @join__field(graph: SUPPLIERS)
 }
 
+type ProductList @join__type(graph: PRODUCTS) {
+  items: [Product]
+}
+
 interface Product @discriminator(subgraph: "Products", field: "_type", mapping: [["ELECTRONICS", "Electronics"], ["CLOTHING", "Clothing"]]) @join__type(graph: PRODUCTS) {
   _links: ProductLinks
   _type: String

e2e/openapi-hateoas/products.json

@@ -5,6 +5,24 @@
     "version": "1.0.0"
   },
   "paths": {
+    "/products/": {
+      "get": {
+        "operationId": "getProducts",
+        "summary": "Get all the products",
+        "responses": {
+          "200": {
+            "description": "Success",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ProductList"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
     "/products/{id}": {
       "get": {
         "operationId": "getProductById",
@@ -37,6 +55,17 @@
   },
   "components": {
     "schemas": {
+      "ProductList": {
+        "type": "object",
+        "properties": {
+          "items": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/Product"
+            }
+          }
+        }
+      },
       "Product": {
         "type": "object",
         "discriminator": {

packages/loaders/openapi/src/getJSONSchemaOptionsFromOpenAPIOptions.ts

@@ -595,7 +595,7 @@ export async function getJSONSchemaOptionsFromOpenAPIOptions(
               ]?.find(link => link[hateOasConfig.linkNameIdentifier] === linkName);
               if (xLinkObj) {
                 const xLinkHref = xLinkObj[hateOasConfig.linkPathIdentifier];
-                const cleanXLinkHref = xLinkHref.replace(/{[^}]+}/g, '');
+                const cleanXLinkHref = xLinkHref.replace(/{[^}]+}/g, '{}');
                 const deferred = createDeferred<void>();
                 function findActualOperationAndPath(
                   possibleName: string,
@@ -605,7 +605,7 @@ export async function getJSONSchemaOptionsFromOpenAPIOptions(
                   let actualOperation: OpenAPIV3.OperationObject;
                   let actualPath: string;
                   for (const path in possibleOasDoc.paths) {
-                    const cleanPath = path.replace(/{[^}]+}/g, '');
+                    const cleanPath = path.replace(/{[^}]+}/g, '{}');
                     if (cleanPath === cleanXLinkHref) {
                       actualPath = path;
                       actualOperation = possibleOasDoc.paths[path][method];