chore(gatsby): Migrate utils/get-latest-apis.js to ts (#22097)

* migrate get-lates-api to ts * modify require statements * use pathExistsSync * update interface of api response * Update packages/gatsby/src/utils/get-latest-apis.ts Co-Authored-By: Michaël De Boey <info@michaeldeboey.be> * use fs.exists * fix a type issue * fix lint * fix lint * fix tests Co-authored-by: Michaël De Boey <info@michaeldeboey.be> Co-authored-by: Blaine Kasten <blainekasten@gmail.com>
gatsbyjs · May 21, 2020 · b81b604 · b81b604
1 parent cb5d055
commit b81b604
Show file tree

Hide file tree

Showing 5 changed files with 26 additions and 18 deletions.
diff --git a/packages/gatsby/scripts/postinstall.js b/packages/gatsby/scripts/postinstall.js
@@ -1,5 +1,5 @@
 try {
-  const getLatestAPIs = require('../dist/utils/get-latest-apis')
+  const { getLatestAPIs } = require('../dist/utils/get-latest-apis')
   getLatestAPIs()
 } catch (e) {
   // we're probably just bootstrapping and not published yet!

diff --git a/packages/gatsby/src/bootstrap/load-plugins/__tests__/validate.js b/packages/gatsby/src/bootstrap/load-plugins/__tests__/validate.js
@@ -15,7 +15,7 @@ const {
   handleMultipleReplaceRenderers,
   warnOnIncompatiblePeerDependency,
 } = require(`../validate`)
-const getLatestAPIs = require(`../../../utils/get-latest-apis`)
+const { getLatestAPIs } = require(`../../../utils/get-latest-apis`)
 
 beforeEach(() => {
   Object.keys(reporter).forEach(key => reporter[key].mockReset())
@@ -68,7 +68,7 @@ describe(`collatePluginAPIs`, () => {
       },
     ]
 
-    let result = collatePluginAPIs({ currentAPIs: apis, flattenedPlugins })
+    const result = collatePluginAPIs({ currentAPIs: apis, flattenedPlugins })
     expect(result).toMatchSnapshot()
   })
 
@@ -95,7 +95,7 @@ describe(`collatePluginAPIs`, () => {
       },
     ]
 
-    let result = collatePluginAPIs({ currentAPIs: apis, flattenedPlugins })
+    const result = collatePluginAPIs({ currentAPIs: apis, flattenedPlugins })
     expect(result).toMatchSnapshot()
   })
 })

diff --git a/packages/gatsby/src/bootstrap/load-plugins/validate.js b/packages/gatsby/src/bootstrap/load-plugins/validate.js
@@ -4,7 +4,7 @@ const stringSimilarity = require(`string-similarity`)
 const { version: gatsbyVersion } = require(`gatsby/package.json`)
 const reporter = require(`gatsby-cli/lib/reporter`)
 const resolveModuleExports = require(`../resolve-module-exports`)
-const getLatestAPIs = require(`../../utils/get-latest-apis`)
+const { getLatestAPIs } = require(`../../utils/get-latest-apis`)
 
 const getGatsbyUpgradeVersion = entries =>
   entries.reduce((version, entry) => {
@@ -42,8 +42,8 @@ const getErrorContext = (badExports, exportType, currentAPIs, latestAPIs) => {
   })
 
   const gatsbyUpgradeVersion = getGatsbyUpgradeVersion(entries)
-  let errors = []
-  let fixes = [].concat(
+  const errors = []
+  const fixes = [].concat(
     gatsbyUpgradeVersion ? [`npm install gatsby@^${gatsbyUpgradeVersion}`] : []
   )
 

diff --git a/...by/src/utils/__tests__/get-latest-apis.js → ...by/src/utils/__tests__/get-latest-apis.ts b/...by/src/utils/__tests__/get-latest-apis.js → ...by/src/utils/__tests__/get-latest-apis.ts
@@ -1,27 +1,29 @@
+/* eslint-disable @typescript-eslint/no-var-requires */
 jest.mock(`fs-extra`, () => {
   return {
-    exists: jest.fn(),
     readJSON: jest.fn(),
     writeFile: jest.fn(),
+    pathExists: jest.fn(),
   }
 })
 jest.mock(`axios`, () => {
   return {
     get: jest.fn(),
   }
 })
+
 const path = require(`path`)
 const fs = require(`fs-extra`)
 const axios = require(`axios`)
-const getLatestAPIs = require(`../get-latest-apis`)
+import { getLatestAPIs, IAPIResponse } from "../get-latest-apis"
 
 beforeEach(() => {
   ;[fs, axios].forEach(mock =>
     Object.keys(mock).forEach(key => mock[key].mockReset())
   )
 })
 
-const getMockAPIFile = () => {
+const getMockAPIFile = (): IAPIResponse => {
   return {
     node: {},
     browser: {},
@@ -31,7 +33,7 @@ const getMockAPIFile = () => {
 
 describe(`default behavior: has network connectivity`, () => {
   beforeEach(() => {
-    fs.exists.mockResolvedValueOnce(false)
+    fs.pathExists.mockResolvedValueOnce(false)
     axios.get.mockResolvedValueOnce({ data: getMockAPIFile() })
   })
 
@@ -63,7 +65,7 @@ describe(`downloading APIs failure`, () => {
 
   it(`falls back to downloaded cached file, if it exists`, async () => {
     const apis = getMockAPIFile()
-    fs.exists.mockResolvedValueOnce(true)
+    fs.pathExists.mockResolvedValueOnce(true)
     fs.readJSON.mockResolvedValueOnce(apis)
 
     const data = await getLatestAPIs()
@@ -77,7 +79,7 @@ describe(`downloading APIs failure`, () => {
 
   it(`falls back to local api.json if latest-apis.json not cached`, async () => {
     const apis = getMockAPIFile()
-    fs.exists.mockResolvedValueOnce(false)
+    fs.pathExists.mockResolvedValueOnce(false)
     fs.readJSON.mockResolvedValueOnce(apis)
 
     await getLatestAPIs()

diff --git a/packages/gatsby/src/utils/get-latest-apis.js → packages/gatsby/src/utils/get-latest-apis.ts b/packages/gatsby/src/utils/get-latest-apis.js → packages/gatsby/src/utils/get-latest-apis.ts
@@ -1,20 +1,26 @@
-const path = require(`path`)
-const fs = require(`fs-extra`)
-const axios = require(`axios`)
+import path from "path"
+import fs from "fs-extra"
+import axios from "axios"
 
 const API_FILE = `https://unpkg.com/gatsby/apis.json`
 const ROOT = path.join(__dirname, `..`, `..`)
 const OUTPUT_FILE = path.join(ROOT, `latest-apis.json`)
 
-module.exports = async function getLatestAPI() {
+export interface IAPIResponse {
+  browser: Record<string, any>
+  node: Record<string, any>
+  ssr: Record<string, any>
+}
+
+export const getLatestAPIs = async (): Promise<IAPIResponse> => {
   try {
     const { data } = await axios.get(API_FILE, { timeout: 5000 })
 
     await fs.writeFile(OUTPUT_FILE, JSON.stringify(data, null, 2), `utf8`)
 
     return data
   } catch (e) {
-    if (await fs.exists(OUTPUT_FILE)) {
+    if (await fs.pathExists(OUTPUT_FILE)) {
       return fs.readJSON(OUTPUT_FILE)
     }
     // possible offline/network issue