feat(action): add support for headers

Author: AdriVanHoudt

action.yml

@@ -30,6 +30,14 @@ inputs:
       An url to the GraphQL API. It should represent the "before" schema.
 
       When using an endpoint, 'schema' should point to a file (without a reference - branch name for example)
+  headers:
+    description: |
+      Pass headers when fetching the "before" schema.
+      This only applies when `endpoint` is defined and only applies to the "before" schema.
+  method:
+    description: |
+      Pass headers when fetching the "before" schema.
+      This only applies when `endpoint` is defined and only applies to the "before" schema.
   github-token:
     default: '${{ github.token }}'
     required: false

packages/action/src/run.ts

@@ -7,6 +7,7 @@ import {
   CheckConclusion,
   createSummary,
   diff,
+  EndpointMethod,
   printSchemaFromEndpoint,
   produceSchema,
 } from '@graphql-inspector/github';
@@ -40,6 +41,8 @@ export async function run() {
   const useAnnotations = castToBoolean(core.getInput('annotations'));
   const failOnBreaking = castToBoolean(core.getInput('fail-on-breaking'));
   const endpoint: string = core.getInput('endpoint');
+  const headers: string = core.getInput('headers');
+  const method = core.getInput('method') as EndpointMethod;
   const approveLabel: string = core.getInput('approve-label') || 'approved-breaking-change';
   const rulesList = getInputAsArray('rules') || [];
   const onUsage = core.getInput('getUsage');
@@ -131,7 +134,14 @@ export async function run() {
 
   const [oldFile, newFile] = await Promise.all([
     endpoint
-      ? printSchemaFromEndpoint(endpoint)
+      ? printSchemaFromEndpoint({
+          url: endpoint,
+          method,
+          headers: headers
+            ? // Go from "name:value,name:value" to { name: value, name: value}
+              Object.fromEntries(headers.split(',').map(header => header.split(':')))
+            : undefined,
+        })
       : loadFile({
           ref: schemaRef,
           path: schemaPath,

packages/github/src/helpers/config.ts

@@ -5,12 +5,14 @@ export type Endpoint =
   | string
   | {
       url: string;
-      method?: 'get' | 'GET' | 'post' | 'POST';
+      method?: EndpointMethod;
       headers?: {
         [name: string]: string;
       };
     };
 
+export type EndpointMethod = 'get' | 'GET' | 'post' | 'POST';
+
 export interface SchemaPointer {
   ref: string;
   path: string;

packages/github/src/helpers/utils.ts

@@ -1,5 +1,5 @@
 import { Change, CriticalityLevel } from '@graphql-inspector/core';
-import { Endpoint } from './config';
+import { Endpoint, EndpointMethod } from './config';
 
 export function bolderize(msg: string): string {
   return quotesTransformer(msg, '**');
@@ -103,7 +103,7 @@ export function isNil(val: any): val is undefined | null {
 
 export function parseEndpoint(endpoint: Endpoint): {
   url: string;
-  method: 'GET' | 'get' | 'post' | 'POST';
+  method: EndpointMethod;
   headers?: {
     [name: string]: string;
   };

packages/github/src/index.ts

@@ -1,5 +1,5 @@
 export { default, default as app } from './app';
-export { createConfig, NormalizedConfig, SchemaPointer } from './helpers/config';
+export { createConfig, NormalizedConfig, SchemaPointer, EndpointMethod } from './helpers/config';
 export { setDiagnostics } from './helpers/diagnostics';
 export { diff } from './helpers/diff';
 export { createFileLoader, printSchemaFromEndpoint } from './helpers/loaders';

website/src/pages/docs/products/action.mdx

@@ -117,6 +117,32 @@ If you want to use GraphQL API endpoint as source of "after" schema:
     endpoint: 'https://my-app.com/graphql'
 ```
 
+### `headers`
+
+Pass headers when fetching the "before" schema.
+This only applies when `endpoint` is defined and only applies to the "before" schema.
+
+```yaml
+- uses: kamilkisiela/graphql-inspector@master
+  with:
+    schema: schema.graphql # important to define a path to schema file, without a branch
+    endpoint: 'https://my-app.com/graphql'
+    headers: 'Authorization: Bearer ${{ secrets.token }},X-My-Header:${{ secrets.secret_header_value }}'
+```
+
+### `method`
+
+Set a custom method to fetch the "before" schema with.
+This only applies when `endpoint` is defined and only applies to the "before" schema.
+
+```yaml
+- uses: kamilkisiela/graphql-inspector@master
+  with:
+    schema: schema.graphql # important to define a path to schema file, without a branch
+    endpoint: 'https://my-app.com/graphql'
+    method: 'GET' # Can be any of [GET, get, POST, post]
+```
+
 ### `rules`
 
 Apply [rules](../essentials/diff#rules) included with the Inspector as well as your own