refactor: Modify fetchLite() to works with options, instead of direct params

Author: david-rodrigues

src/NPM.ts

@@ -35,15 +35,15 @@ export const getPackageVersions = async (
   // This avoids loading processes via `npm view`.
   // The process is cached if it is triggered quickly, within lifetime.
   const execPromise = new Promise<string[] | null>((resolve) =>
-    fetchLite<NPMRegistryPackage>(`https://registry.npmjs.org/${name}`).then(
-      (data) => {
-        if (data?.versions) {
-          return resolve(Object.keys(data.versions))
-        }
-
-        return resolve(null)
+    fetchLite<NPMRegistryPackage>({
+      url: `https://registry.npmjs.org/${name}`,
+    }).then((data) => {
+      if (data?.versions) {
+        return resolve(Object.keys(data.versions))
       }
-    )
+
+      return resolve(null)
+    })
   )
 
   packagesCache.set(name, new Cache(execPromise))
@@ -147,11 +147,11 @@ export const getPackagesAdvisories = async (
 
   if (Object.keys(packages).length) {
     // Query advisories through the NPM Registry.
-    const responseAdvisories = await fetchLite<PackagesAdvisories | undefined>(
-      "https://registry.npmjs.org/-/npm/v1/security/advisories/bulk",
-      "post",
-      packages
-    )
+    const responseAdvisories = await fetchLite<PackagesAdvisories | undefined>({
+      body: packages,
+      method: "post",
+      url: "https://registry.npmjs.org/-/npm/v1/security/advisories/bulk",
+    })
 
     // Fills the packages with their respective advisories.
     if (responseAdvisories) {

src/TestUtils.ts

@@ -156,7 +156,7 @@ export const vscodeSimulator = async (options: SimulatorOptions = {}) => {
 
   UtilsMock.cacheEnabled = (): boolean => options.cacheEnabled === true
 
-  UtilsMock.fetchLite = (url: string): unknown => {
+  UtilsMock.fetchLite = ({ url }: { url: string }): unknown => {
     if (url.endsWith("/bulk")) {
       return options.packagesAdvisories
     }

src/Utils.test.ts

@@ -136,39 +136,39 @@ describe("utils", () => {
   it("fetchLite: access to NPM Registry (advisories)", async () => {
     expect.assertions(1)
 
-    const fetchSuccess = await fetchLite(
-      "https://registry.npmjs.org/-/npm/v1/security/advisories/bulk",
-      "post",
-      { "npm-outdated": ["2.0.3"] }
-    )
+    const fetchSuccess = await fetchLite({
+      body: { "npm-outdated": ["2.0.3"] },
+      method: "post",
+      url: "https://registry.npmjs.org/-/npm/v1/security/advisories/bulk",
+    })
 
     expect(fetchSuccess).toStrictEqual({})
   })
 
   it("fetchLite: access to NPM Registry (package)", async () => {
     expect.assertions(1)
 
-    const fetchSuccess = await fetchLite(
-      "https://registry.npmjs.org/node-fetch"
-    )
+    const fetchSuccess = await fetchLite({
+      url: "https://registry.npmjs.org/node-fetch",
+    })
 
     expect(fetchSuccess).toBeInstanceOf(Object)
   })
 
   it("fetchLite: access to a private NPM Registry without auth token", async () => {
     expect.assertions(1)
 
-    const fetchSuccess = await fetchLite<{ error: string }>(
-      "https://registry.npmjs.org/@fortawesome/pro-light-svg-icons"
-    )
+    const fetchSuccess = await fetchLite<{ error: string }>({
+      url: "https://registry.npmjs.org/@fortawesome/pro-light-svg-icons",
+    })
 
     expect(fetchSuccess?.error).toBe("Not found")
   })
 
   it("fetchLite: invalid URL", async () => {
     expect.assertions(1)
 
-    const fetchSuccess = await fetchLite("invalid")
+    const fetchSuccess = await fetchLite({ url: "invalid" })
 
     expect(fetchSuccess).toBeUndefined()
   })

src/Utils.ts

@@ -120,19 +120,21 @@ export const promiseLimit = (
 // During testing, this function is mocked to return false in some cases.
 export const cacheEnabled = (): boolean => true
 
+interface FetchLite {
+  body?: object
+  method?: "get" | "post"
+  url: string
+}
+
 // A simple post request.
 // Based on https://github.com/vasanthv/fetch-lite/blob/master/index.js
-export const fetchLite = <T>(
-  paramUrl: string,
-  method?: "get" | "post" | undefined,
-  body?: object | undefined
-): Promise<T | undefined> => {
+export const fetchLite = <T>(options: FetchLite): Promise<T | undefined> => {
   return new Promise<T | undefined>((resolve) => {
-    const { hostname, path } = url.parse(paramUrl)
+    const { hostname, path } = url.parse(options.url)
     const headers = { "content-type": "application/json" }
 
     const thisReq = https.request(
-      { headers, hostname, method: method ?? "get", path },
+      { headers, hostname, method: options.method ?? "get", path },
       (response: IncomingMessage) => {
         const responseBuffers: Buffer[] = []
 
@@ -158,8 +160,8 @@ export const fetchLite = <T>(
     thisReq.setHeader("Content-Encoding", "gzip")
     thisReq.setHeader("Accept-Encoding", "gzip")
 
-    if (body !== undefined) {
-      const bodyStringify = zlib.gzipSync(JSON.stringify(body))
+    if (options.body !== undefined) {
+      const bodyStringify = zlib.gzipSync(JSON.stringify(options.body))
 
       thisReq.setHeader("Content-Length", bodyStringify.length)
       thisReq.write(bodyStringify)