chore: upgrade flowtype to 0.131.0 (#1603)

* chore: upgrade flowtype to 0.131.0 and yarn to 1.22.4

* refactor: build headers as single string value

* test: fix assertion

* chore: remove unnecessary eslint-disable

* chore: update lockfile

Author: emmenko

.flowconfig

@@ -1,5 +1,5 @@
 [version]
-^0.126.1
+^0.131.0
 
 [ignore]
 <PROJECT_ROOT>/_book/.*
@@ -55,8 +55,24 @@ packages/*/src
 
 [libs]
 
+[lints]
+# https://dev.to/wgao19/making-flow-happy-after-0-98-32bb
+# NOTE: express flow-typed currently contain some `$Subtype` types.
+deprecated-utility=off
+
 [options]
-module.name_mapper='^types/\(.*\)$' -> '<PROJECT_ROOT>/types/\1.js'
-include_warnings=true
 emoji=true
+include_warnings=true
 esproposal.optional_chaining=enable
+esproposal.nullish_coalescing=enable
+
+server.max_workers=2
+
+module.name_mapper='^types/\(.*\)$' -> '<PROJECT_ROOT>/types/\1.js'
+
+suppress_type=$FlowIssue
+suppress_type=$FlowFixMe
+
+# https://medium.com/flow-type/types-first-a-scalable-new-architecture-for-flow-3d8c7ba1d4eb
+well_formed_exports=true
+types_first=true

integration-tests/sdk/auth-middleware.it.js

@@ -218,7 +218,7 @@ describe('Auth Middleware Flows', () => {
             body: { results: carts },
             request: {
               headers: {
-                Authorization: [token],
+                Authorization: token,
               },
             },
           }) => {

packages/product-json-to-csv/src/main.js

@@ -197,7 +197,7 @@ export default class ProductJsonToCsv {
     )
   }
 
-  async _resolveVariantReferences(variant: Variant) {
+  async _resolveVariantReferences(variant: Variant): Promise<Variant> {
     if (!variant) return variant
 
     return {

packages/product-json-to-csv/src/map-product-data.js

@@ -305,7 +305,7 @@ export default class ProductMapping {
    * @returns Object
    * @private
    */
-  _joinMappedSetValues(setValues: Array<Object>) {
+  _joinMappedSetValues(setValues: Array<Object>): Object {
     // when there is an object property missing in first N objects, we should
     // prepend value from N+1 object with delimiters:
     // [{attrName.en: 'AA'}, {attrName.en: 'BB'},{attrName.de: '12'}]

packages/product-json-to-xlsx/src/writer.js

@@ -43,7 +43,7 @@ export function finishWorksheetsAndArchive(
   dir: string,
   output: stream$Writable,
   logger: Object
-) {
+): void {
   if (exports.length === 0) return archiveDir(dir, output, logger)
 
   const writeStreams: Array<stream$Writable> = exports.map(

packages/resource-deleter/src/main.js

@@ -21,6 +21,7 @@ import type {
   ClientRequest,
   ClientResult,
   MethodType,
+  ServiceBuilderInstance,
 } from 'types/sdk'
 import silentLogger from './utils/silent-logger'
 import pkg from '../package.json'
@@ -153,7 +154,7 @@ export default class ResourceDeleter {
       })
   }
 
-  createService() {
+  createService(): ServiceBuilderInstance {
     return createRequestBuilder({
       projectKey: this.apiConfig.projectKey,
     })[this.resource]

packages/sdk-auth/src/auth.js

@@ -4,7 +4,6 @@ import type {
   AuthOptions,
   CustomAuthOptions,
   ClientAuthOptions,
-  ConfigFetch,
   HttpErrorType,
   AuthRequest,
   UserAuthOptions,
@@ -17,7 +16,7 @@ import * as constants from './constants'
 export default class SdkAuth {
   // Set flowtype annotations
   config: AuthOptions
-  fetcher: ConfigFetch
+  fetcher: typeof fetch
   ANONYMOUS_FLOW_URI: string
   BASE_AUTH_FLOW_URI: string
   CUSTOMER_PASSWORD_FLOW_URI: string
@@ -53,12 +52,21 @@ export default class SdkAuth {
     this.INTROSPECT_URI = '/oauth/introspect'
   }
 
-  static _getFetcher(configFetch: ?ConfigFetch): ConfigFetch {
-    if (!configFetch && typeof fetch === 'undefined')
+  static _getFetcher(fetcher: ?typeof fetch): typeof fetch {
+    if (!fetcher && typeof fetch === 'undefined')
       throw new Error(
         '`fetch` is not available. Please pass in `fetch` as an option or have it globally available.'
       )
-    return configFetch || fetch
+    let fetchFunction: typeof fetch
+    if (fetcher) {
+      fetchFunction = fetcher
+    } else {
+      // `fetcher` is set here rather than the destructuring to ensure fetch is
+      // declared before referencing it otherwise it would cause a `ReferenceError`.
+      // For reference of this pattern: https://github.com/apollographql/apollo-link/blob/498b413a5b5199b0758ce898b3bb55451f57a2fa/packages/apollo-link-http/src/httpLink.ts#L49
+      fetchFunction = fetch
+    }
+    return fetchFunction
   }
 
   static _checkRequiredConfiguration(config: AuthOptions) {
@@ -78,11 +86,11 @@ export default class SdkAuth {
   static _encodeClientCredentials({
     clientId,
     clientSecret,
-  }: ClientAuthOptions) {
+  }: ClientAuthOptions): string {
     return Buffer.from(`${clientId}:${clientSecret}`).toString('base64')
   }
 
-  static _getScopes(scopes: ?Array<string>, projectKey: ?string) {
+  static _getScopes(scopes: ?Array<string>, projectKey: ?string): string {
     return scopes
       ? scopes.join(' ')
       : [constants.MANAGE_PROJECT, projectKey].filter(Boolean).join(':') // generate a default scope manage_project:projectKey
@@ -108,11 +116,20 @@ export default class SdkAuth {
     const authType = config.authType || constants.DEFAULT_AUTH_TYPE
 
     const isNotRefreshTokenGrantType = grantType !== 'refresh_token'
-    const initialBody = encode({
+    const queryParams: {
+      grant_type: string,
+      refresh_token?: boolean,
+      scope?: string,
+    } = {
       grant_type: grantType,
-      ...(disableRefreshToken && { refresh_token: false }),
-      ...(isNotRefreshTokenGrantType && { scope }),
-    })
+    }
+    if (disableRefreshToken) {
+      queryParams.refresh_token = false
+    }
+    if (isNotRefreshTokenGrantType) {
+      queryParams.scope = scope
+    }
+    const initialBody = encode(queryParams)
 
     return { basicAuth, authType, uri, body: initialBody, headers }
   }
@@ -131,7 +148,7 @@ export default class SdkAuth {
     return request
   }
 
-  _process(request: AuthRequest) {
+  _process(request: AuthRequest): Promise<Object> {
     return this._performRequest(request).then((response) =>
       SdkAuth._handleResponse(request.uri, response)
     )
@@ -173,7 +190,7 @@ export default class SdkAuth {
     return response
   }
 
-  static _handleResponse(uri: string, response: Object) {
+  static _handleResponse(uri: string, response: Response): Promise<Object> {
     return SdkAuth._parseResponseJson(response).then((jsonResponse) => {
       if (SdkAuth._isErrorResponse(response))
         throw SdkAuth._createResponseError(jsonResponse, uri, response.status)
@@ -199,7 +216,7 @@ export default class SdkAuth {
     return uri.replace('--projectKey--', projectKey)
   }
 
-  _performRequest(request: AuthRequest) {
+  _performRequest(request: AuthRequest): Promise<Response> {
     const { uri, body, basicAuth, authType, headers } = request
     const fetchHeaders = headers || {
       Authorization: `${authType || constants.DEFAULT_AUTH_TYPE} ${basicAuth}`,
@@ -228,7 +245,10 @@ export default class SdkAuth {
     return mergedConfig
   }
 
-  anonymousFlow(anonymousId: string = '', config: CustomAuthOptions = {}) {
+  anonymousFlow(
+    anonymousId: string = '',
+    config: CustomAuthOptions = {}
+  ): Promise<Object> {
     const _config = this._getRequestConfig(config)
     let request = SdkAuth._buildRequest(
       _config,
@@ -246,7 +266,7 @@ export default class SdkAuth {
     return this._process(request)
   }
 
-  clientCredentialsFlow(config: CustomAuthOptions = {}) {
+  clientCredentialsFlow(config: CustomAuthOptions = {}): Promise<Object> {
     const _config = this._getRequestConfig(config)
     const request = SdkAuth._buildRequest(_config, this.BASE_AUTH_FLOW_URI)
 
@@ -257,7 +277,7 @@ export default class SdkAuth {
     credentials: UserAuthOptions,
     config: AuthOptions,
     url: string
-  ) {
+  ): Promise<Object> {
     const { username, password } = credentials || {}
     let request = SdkAuth._buildRequest(config, url, 'password')
 
@@ -269,7 +289,7 @@ export default class SdkAuth {
   customerPasswordFlow(
     credentials: UserAuthOptions,
     config: CustomAuthOptions = {}
-  ) {
+  ): Promise<Object> {
     const _config = this._getRequestConfig(config)
     const url = SdkAuth._enrichUriWithProjectKey(
       this.CUSTOMER_PASSWORD_FLOW_URI,
@@ -282,13 +302,16 @@ export default class SdkAuth {
   clientPasswordFlow(
     credentials: UserAuthOptions,
     config: CustomAuthOptions = {}
-  ) {
+  ): Promise<Object> {
     const _config = this._getRequestConfig(config)
 
     return this._passwordFlow(credentials, _config, this.BASE_AUTH_FLOW_URI)
   }
 
-  refreshTokenFlow(token: string, config: CustomAuthOptions = {}) {
+  refreshTokenFlow(
+    token: string,
+    config: CustomAuthOptions = {}
+  ): Promise<Object> {
     if (!token) throw new Error('Missing required token value')
 
     const _config = this._getRequestConfig(config)
@@ -300,7 +323,10 @@ export default class SdkAuth {
     return this._process(request)
   }
 
-  introspectToken(token: string, config: CustomAuthOptions = {}) {
+  introspectToken(
+    token: string,
+    config: CustomAuthOptions = {}
+  ): Promise<Object> {
     if (!token) throw new Error('Missing required token value')
 
     const _config = this._getRequestConfig(config)
@@ -312,7 +338,7 @@ export default class SdkAuth {
     return this._process(request)
   }
 
-  customFlow(requestConfig: Object) {
+  customFlow(requestConfig: Object): Promise<Object> {
     const {
       credentials,
       host,

packages/sdk-middleware-http/src/http.js

@@ -1,6 +1,7 @@
 /* @flow */
 
 import type {
+  HttpHeaders,
   HttpErrorType,
   HttpMiddlewareOptions,
   Middleware,
@@ -44,9 +45,9 @@ function calcDelayDuration(
 function maskAuthData(request: Object, maskSensitiveHeaderData: ?boolean) {
   if (maskSensitiveHeaderData) {
     if (request.headers.authorization)
-      request.headers.authorization = ['Bearer ********']
+      request.headers.authorization = 'Bearer ********'
     if (request.headers.Authorization)
-      request.headers.Authorization = ['Bearer ********']
+      request.headers.Authorization = 'Bearer ********'
   }
 }
 
@@ -76,14 +77,15 @@ export default function createHttpMiddleware({
     throw new Error(
       '`AbortController` is not available. Please pass in `AbortController` as an option or have it globally available when using timeout.'
     )
-
-  if (!fetcher)
+  let fetchFunction: typeof fetch
+  if (fetcher) {
+    fetchFunction = fetcher
+  } else {
     // `fetcher` is set here rather than the destructuring to ensure fetch is
     // declared before referencing it otherwise it would cause a `ReferenceError`.
     // For reference of this pattern: https://github.com/apollographql/apollo-link/blob/498b413a5b5199b0758ce898b3bb55451f57a2fa/packages/apollo-link-http/src/httpLink.ts#L49
-
-    // eslint-disable-next-line
-    fetcher = fetch
+    fetchFunction = fetch
+  }
 
   let abortController
   if (timeout || _abortController)
@@ -100,21 +102,28 @@ export default function createHttpMiddleware({
         ? request.body
         : // NOTE: `stringify` of `null` gives the String('null')
           JSON.stringify(request.body || undefined)
-    // $FlowFixMe
-    const requestHeader = {
-      'Content-Type': ['application/json'],
-      ...request.headers,
-      ...(body
-        ? { 'Content-Length': Buffer.byteLength(body).toString() }
-        : null),
+
+    const requestHeader: HttpHeaders = { ...request.headers }
+    if (
+      !Object.prototype.hasOwnProperty.call(request.headers, 'Content-Type')
+    ) {
+      requestHeader['Content-Type'] = 'application/json'
     }
-    // $FlowFixMe
-    const fetchOptions: Object = {
+    if (body) {
+      requestHeader['Content-Length'] = Buffer.byteLength(body).toString()
+    }
+    const fetchOptions: RequestOptions = {
       method: request.method,
       headers: requestHeader,
-      ...(credentialsMode ? { credentials: credentialsMode } : {}),
-      ...(timeout || abortController ? { signal: abortController.signal } : {}),
-      ...(body ? { body } : null),
+    }
+    if (credentialsMode) {
+      fetchOptions.credentials = credentialsMode
+    }
+    if (timeout || abortController) {
+      fetchOptions.signal = abortController.signal
+    }
+    if (body) {
+      fetchOptions.body = body
     }
     let retryCount = 0
     // wrap in a fn so we can retry if error occur
@@ -125,8 +134,7 @@ export default function createHttpMiddleware({
         timer = setTimeout(() => {
           abortController.abort()
         }, timeout)
-      // $FlowFixMe
-      fetcher(url, fetchOptions)
+      fetchFunction(url, fetchOptions)
         .then(
           (res: Response) => {
             if (res.ok) {