🏗️ Add api for integration tests

.github/workflows/integration-tests.yml

@@ -0,0 +1,43 @@
+name: Run Integration Tests
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  integration-tests:
+    runs-on: ubuntu-latest
+    services:
+      registry:
+        image: registry:2
+        ports:
+          - 5000:5000
+    steps:
+      - name: Check out the repo
+        uses: actions/checkout@v4
+
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v3
+
+      - name: Set up Docker Buildx
+        id: buildx
+        uses: docker/setup-buildx-action@v3
+        with:
+          driver-opts: network=host
+
+      - name: Copy patches for Docker Buildx
+        run: cp -r patches/* packages/graphql-mesh/patches
+
+      - name: Build and push on local registry
+        id: docker_build
+        uses: docker/build-push-action@v5
+        with:
+          context: ./packages/graphql-mesh
+          push: true
+          tags: localhost:5000/test/graphql-mesh:latest
+          platforms: linux/amd64
+
+      - name: Setup services for testing purpose
+        run: export IMAGE_TAG=localhost:5000/test/graphql-mesh:latest && cd ./test/integration && docker compose up -d

.github/workflows/unit-tests.yml

@@ -15,8 +15,6 @@ jobs:
     steps:
       - name: Checkout code
         uses: actions/checkout@v3
-        with:
-          node-version: ${{ matrix.node-version }}
 
       - name: Set up Node.js
         uses: actions/setup-node@v3

packages/directive-spl/package.json

@@ -19,7 +19,6 @@
     "build:cjs": "tsc --project tsconfig-cjs.json",
     "build:esm": "tsc --project tsconfig-esm.json",
     "build": "rm -rf _build && npm run build:esm && npm run build:cjs && node ./scripts/prepare-package-json",
-    "dev": "vite",
     "pack": "npm run build && npm pack --pack-destination ../graphql-mesh/local-pkg",
     "test": "vitest"
   },

packages/graphql-mesh/Dockerfile

@@ -31,5 +31,6 @@ VOLUME /app/sources
 VOLUME /app/config.yaml
 VOLUME /app/transforms
 VOLUME /app/plugins
+VOLUME /app/resolvers
 
 CMD [ "npm", "run", "serve" ]

packages/graphql-mesh/utils/ConfigFromSwaggers.ts

@@ -72,7 +72,8 @@ export default class ConfigFromSwaggers {
           spec,
           availableTypes,
           this.getInterfacesWithChildren(),
-          this.catalog
+          this.catalog,
+          this.config
         )
         acc.typeDefs += typeDefs
         acc.resolvers = mergeObjects(acc.resolvers, resolvers)

packages/graphql-mesh/utils/swaggers/index.ts

@@ -1,4 +1,5 @@
 import { Spec, ConfigExtension, Resolvers } from '../../types'
+import { getSourceName } from '../config'
 import { trimLinks, anonymizePathAndGetParams } from '../helpers'
 /**
  * This function creates, for a Swagger file, the additional typeDefs for each schema having at least one x-link, and one resolver for each x-link
@@ -10,7 +11,8 @@ export const generateTypeDefsAndResolversFromSwagger = (
   spec: Spec,
   availableTypes: string[],
   interfacesWithChildren: { [key: string]: string[] },
-  catalog: { [key: string]: [string, string, string] }
+  catalog: { [key: string]: [string, string, string] },
+  config: any
 ): ConfigExtension => {
   if (!spec.components) {
     return {
@@ -93,7 +95,7 @@ export const generateTypeDefsAndResolversFromSwagger = (
 
           const query = targetedOperationName
           const type = targetedOperationType
-          const source = targetedSwaggerName
+          const source = getSourceName(targetedSwaggerName, config)
 
           if (
             targetedOperationType !== 'TYPE_NOT_FOUND' &&
@@ -124,6 +126,7 @@ export const generateTypeDefsAndResolversFromSwagger = (
                   root = { ...root, followLink: hateoasLink.href }
                 }
 
+                // @TODO: Fix type checking for interger params
                 if (paramsToSend.length) {
                   paramsToSend.forEach((param, i) => {
                     args[param] = root[param] || root[paramsFromLink[i]] || ''

test/api/.gitignore

@@ -0,0 +1,2 @@
+dist
+node_modules

test/api/Dockerfile

@@ -0,0 +1,21 @@
+
+# Use a base image with Node.js
+FROM node:18-alpine
+
+# Set the working directory inside the container
+WORKDIR /app
+
+# Copy package.json and package-lock.json to the working directory
+COPY package*.json ./
+
+# Install dependencies
+RUN npm install
+
+# Copy the rest of the code to the working directory
+COPY . .
+
+# Expose the port on which your API will run
+#EXPOSE 5000
+
+# Define the command to start your API
+CMD ["npm", "run", "start"]

test/api/api-docs/products.yml

@@ -0,0 +1,82 @@
+openapi: 3.0.0
+info:
+  title: Products API
+  description: API to manage products with HATEOAS.
+  version: "1.0"
+servers:
+  - url: http://localhost:3000/
+paths:
+  /products:
+    get:
+      operationId: getProducts
+      summary: List all products
+      responses:
+        "200":
+          description: A list of products with HATEOAS links
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Products"
+  /products/{id}:
+    get:
+      operationId: getProductById
+      summary: Get a product by ID
+      parameters:
+        - name: id
+          in: path
+          required: true
+          schema:
+            type: integer
+          description: The product ID
+      responses:
+        "200":
+          description: A list of products with HATEOAS links
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Product"
+components:
+  schemas:
+    Product:
+      type: object
+      properties:
+        _links:
+          $ref: "#/components/schemas/ProductLinks"
+        id:
+          type: integer
+        name:
+          type: string
+        price:
+          type: number
+        supplierId:
+          type: integer
+    ProductLinks:
+      type: object
+      required:
+        - self
+        - supplier
+      properties:
+        self:
+          $ref: "#/components/schemas/Link"
+        supplier:
+          $ref: "#/components/schemas/Link"
+      x-links:
+        - rel: self
+          hrefPattern: "/products/{id}"
+        - rel: supplier
+          hrefPattern: "/suppliers/{id}"
+
+    Products:
+      type: object
+      properties:
+        items:
+          type: array
+          items:
+            $ref: "#/components/schemas/Product"
+    Link:
+      type: object
+      required:
+        - href
+      properties:
+        href:
+          type: string

test/api/api-docs/suppliers.yml

@@ -0,0 +1,60 @@
+openapi: 3.0.0
+info:
+  title: Suppliers API
+  description: API to manage suppliers with HATEOAS.
+  version: "1.0"
+servers:
+  - url: http://localhost:3000/
+paths:
+  /suppliers:
+    get:
+      operationId: getSuppliers
+      summary: List all suppliers
+      responses:
+        "200":
+          description: A list of suppliers with HATEOAS links
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Suppliers"
+  /suppliers/{id}:
+    get:
+      operationId: getSupplierById
+      summary: Get a supplier by ID
+      parameters:
+        - name: id
+          in: path
+          required: true
+          schema:
+            type: integer
+          description: The supplier ID
+      responses:
+        "200":
+          description: A list of suppliers with HATEOAS links
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Supplier"
+components:
+  schemas:
+    Supplier:
+      type: object
+      properties:
+        id:
+          type: integer
+        name:
+          type: string
+    Link:
+      type: object
+      required:
+        - href
+      properties:
+        href:
+          type: string
+    Suppliers:
+      type: object
+      properties:
+        items:
+          type: array
+          items:
+            $ref: "#/components/schemas/Supplier"

test/api/models/products.ts

@@ -0,0 +1,39 @@
+type Product = {
+  id: number
+  name: string
+  price: number
+  supplierId: number
+  _links: {
+    supplier: {
+      href: string
+    }
+    self?: {
+      href: string
+    }
+  }
+}
+
+function generateProducts() {
+  const _products: Product[] = []
+  for (let i = 1; i <= 50; i++) {
+    const supplierId = Math.floor(Math.random() * 10) + 1
+    const product: Product = {
+      id: i,
+      name: `Product ${i}`,
+      price: Math.floor(Math.random() * 100),
+      supplierId,
+      _links: {
+        self: {
+          href: `/products/${i}`
+        },
+        supplier: {
+          href: `/suppliers/${supplierId}`
+        }
+      }
+    }
+    _products.push(product)
+  }
+  return _products
+}
+
+export const products = generateProducts()

test/api/models/suppliers.ts

@@ -0,0 +1,18 @@
+export type Supplier = {
+  id: number
+  name: string
+}
+
+const generateSuppliers = () => {
+  const _suppliers: Supplier[] = []
+  for (let i = 1; i <= 10; i++) {
+    const supplier: Supplier = {
+      id: i,
+      name: `Supplier ${i}`
+    }
+    _suppliers.push(supplier)
+  }
+  return _suppliers
+}
+
+export const suppliers = generateSuppliers()