Include withCredentials config option to enable credentials in cross…

[theigwe]

In reference to Issue 487,
this is to enable withCredentials config option available in axios for cross-site Access-Control with credentials in requests.

I used this in my project by creating custom driver to enable cookie authentication.

[klis87]

Thank you very much for this PR, it will make graphql driver much more flexible!

[klis87]

Because you added ...rest in the actual implementation, could we also support here more axios options? Maybe axios has some ready to use interface so it would not be too time-consuming?

[klis87]

could we also here support more axios attrs (like requestConfig.headers for instance)? Then it would be possible to add things like withCredentials also per request, not only globally. I think the most safe for now would be just to support requestConfig.axiosOptions and spread it like that:

    const responsePromise = axiosInstance({
      cancelToken: abortSource.token,
      method: 'post',
      data,
      headers: requestConfig.headers,
      onDownloadProgress:
        driverActions.setDownloadProgress &&
        (progressEvent => {
          if (progressEvent.lengthComputable) {
            driverActions.setDownloadProgress(calculateProgress(progressEvent));
          }
        }),
      onUploadProgress:
        driverActions.setUploadProgress &&
        (progressEvent => {
          if (progressEvent.lengthComputable) {
            driverActions.setUploadProgress(calculateProgress(progressEvent));
          }
        }),
     ...requestConfig.axiosOptions,
    })

[theigwe]

I will update as soon as possible. I actually implemented more options in my custom driver.

[theigwe]

Looking at the axios API AxiosRequestConfig interface, I doubt if throwing all the options might be great. I considered doing this for the GraphqlDriverConfig interface:

/*
url,
transformRequest,
transformResponse,
headers,
timeout,
withCredentials,
adapter,
auth,
xsrfCookieName,
xsrfHeaderName,
maxContentLength,
validateStatus,
maxRedirects,
socketPath,
httpAgent,
httpsAgent,
proxy,
*/
type GraphqlDriverConfig = Omit<
  AxiosRequestConfig,
  | 'baseURL'
  | 'method'
  | 'cancelToken'
  | 'onDownloadProgress'
  | 'onUploadProgress'
  | 'data'
  | 'params'
  | 'responseType'
  | 'paramsSerializer'
> & {
  url: string;
};

Then any of the options can still be configured per request with axiosOptions

[klis87]

Thanks for your research and apologies for late reply! Could we please use https://www.typescriptlang.org/docs/handbook/utility-types.html#picktype-keys instead of omit? So we will be strict and new axios types won't be added without our knowledge.

Rgarding attrs I would actually support are:

• headers
• timeout
• withCredentials
• auth
• xsrfCookieName
• xsrfHeaderName
• proxy

I think only those would be handy for graphql driver, what do you think?

Then any of the options can still be configured per request with axiosOptions

That would be excellent!