chore: make 'http' param required (#1030)

BREAKING CHANGE: isomorphic-git no longer has a node HTTP client hard-coded into the `main` file and a browser HTTP client hard-coded into the `module` file. The HTTP clients are now in their own files; users pick one, import it, and provide it to functions that make requests.
isomorphic-git · Feb 7, 2020 · 47abb7a · 47abb7a
1 parent 8aaa232
commit 47abb7a
Show file tree

Hide file tree

Showing 30 changed files with 124 additions and 65 deletions.
diff --git a/README.md b/README.md
@@ -64,7 +64,7 @@ At the time of writing, the following breaking changes are planned:
 - [ ] To go along with that, I'm experimenting with a way to make the API more aesthetic, eliminating the `emitter` plugin/argument and letting you chain event listeners onto running commands directly. NOTE: need to make sure there's no race condition between adding the event listeners and starting running the command.
   - [ ] This also provides an aesthetic way to cancel / stop running commands.
 - [x] break `config` into `getConfig` and `setConfig` or something.
-- [ ] Make `http` an external required dependency just like `fs` [#938](https://github.com/isomorphic-git/isomorphic-git/issues/938)
+- [x] Make `http` an external required dependency just like `fs` [#938](https://github.com/isomorphic-git/isomorphic-git/issues/938)
 - [ ] I should probably normalize on timestamps and get rid of the `date` options.
 - [x] Remove the `noOverwrite` option from `init` and make that the new behavior.
 - [ ] Oh, and I should move all the error strings into a separate JSON file that can be fetched lazily in production.

diff --git a/__tests__/__helpers__/generate-docs.js b/__tests__/__helpers__/generate-docs.js
@@ -148,9 +148,10 @@ async function gendoc (file, filepath) {
           if (param.name === '_' || param.name === 'args') continue
 
           let name = param.name.replace('_.', '').replace('args.', '')
-          const shouldLink = name.startsWith('on')
+          const actualName = name
+          const shouldLink =
+            actualName.startsWith('on') || name === 'http' || name === 'fs'
           if (!param.optional) name = `**${name}**`
-          if (shouldLink) name = `[${name}](./${name})`
 
           let type = param.type.names.map(escapeType).join(' | ')
           if (param.type.names[0] === 'function') {
@@ -180,6 +181,7 @@ async function gendoc (file, filepath) {
               name = `**${name}**`
             }
           }
+          if (shouldLink) name = `[${name}](./${actualName})`
           rows.push([name, escapeType(type), escapeType(description)])
         }
       }

diff --git a/__tests__/test-clone.js b/__tests__/test-clone.js
@@ -2,6 +2,7 @@
 const { makeFixture } = require('./__helpers__/FixtureFS.js')
 
 const { clone } = require('isomorphic-git')
+const { http } = require('isomorphic-git/http')
 
 // this is so it works with either Node local tests or Browser WAN tests
 const localhost =
@@ -16,6 +17,7 @@ describe('clone', () => {
     const { fs, dir, gitdir } = await makeFixture('isomorphic-git')
     await clone({
       fs,
+      http,
       dir,
       gitdir,
       depth: 1,
@@ -37,6 +39,7 @@ describe('clone', () => {
     const { fs, dir, gitdir } = await makeFixture('isomorphic-git')
     await clone({
       fs,
+      http,
       dir,
       gitdir,
       depth: 1,
@@ -58,6 +61,7 @@ describe('clone', () => {
     const { fs, dir, gitdir } = await makeFixture('isomorphic-git')
     await clone({
       fs,
+      http,
       dir,
       gitdir,
       depth: 1,
@@ -82,6 +86,7 @@ describe('clone', () => {
     try {
       await clone({
         fs,
+        http,
         dir,
         gitdir,
         depth: 1,
@@ -101,6 +106,7 @@ describe('clone', () => {
     const { fs, dir, gitdir } = await makeFixture('test-clone-karma')
     await clone({
       fs,
+      http,
       dir,
       gitdir,
       depth: 1,
@@ -123,6 +129,7 @@ describe('clone', () => {
     const { fs, dir, gitdir } = await makeFixture('test-clone-empty')
     await clone({
       fs,
+      http,
       dir,
       gitdir,
       depth: 1,

diff --git a/__tests__/test-fetch.js b/__tests__/test-fetch.js
@@ -2,6 +2,7 @@
 const { makeFixture } = require('./__helpers__/FixtureFS.js')
 
 const { sleep } = require('isomorphic-git/internal-apis')
+const { http } = require('isomorphic-git/http')
 const { E, setConfig, fetch } = require('isomorphic-git')
 
 // this is so it works with either Node local tests or Browser WAN tests
@@ -20,6 +21,7 @@ describe('fetch', () => {
     // Smoke Test
     await fetch({
       fs,
+      http,
       gitdir,
       singleBranch: true,
       remote: 'origin',
@@ -44,6 +46,7 @@ describe('fetch', () => {
     // Test
     await fetch({
       fs,
+      http,
       gitdir,
       onMessage: async x => {
         output.push(x)
@@ -65,6 +68,7 @@ describe('fetch', () => {
     // Now test deepen
     await fetch({
       fs,
+      http,
       gitdir,
       depth: 2,
       singleBranch: true,
@@ -89,6 +93,7 @@ describe('fetch', () => {
     try {
       await fetch({
         fs,
+        http,
         gitdir,
         depth: 1,
         singleBranch: true,
@@ -115,6 +120,7 @@ describe('fetch', () => {
     try {
       await fetch({
         fs,
+        http,
         gitdir,
         depth: 1,
         singleBranch: true,
@@ -142,6 +148,7 @@ describe('fetch', () => {
     // Test
     await fetch({
       fs,
+      http,
       gitdir,
       since: new Date(1506571200000),
       singleBranch: true,
@@ -164,6 +171,7 @@ describe('fetch', () => {
     // Test
     await fetch({
       fs,
+      http,
       gitdir,
       exclude: ['v0.0.5'],
       singleBranch: true,
@@ -186,6 +194,7 @@ describe('fetch', () => {
     // Test
     await fetch({
       fs,
+      http,
       gitdir,
       depth: 1,
       singleBranch: true,
@@ -198,6 +207,7 @@ describe('fetch', () => {
     // Now test deepen
     await fetch({
       fs,
+      http,
       gitdir,
       relative: true,
       depth: 1,
@@ -223,6 +233,7 @@ describe('fetch', () => {
     try {
       await fetch({
         fs,
+        http,
         gitdir,
         since: new Date(1506571200000),
         singleBranch: true,
@@ -239,8 +250,9 @@ describe('fetch', () => {
   it('fetch empty repository from git-http-mock-server', async () => {
     const { fs, dir, gitdir } = await makeFixture('test-empty')
     await fetch({
-      dir,
       fs,
+      http,
+      dir,
       gitdir,
       depth: 1,
       url: `http://${localhost}:8888/test-empty.git`
@@ -265,8 +277,9 @@ describe('fetch', () => {
       true
     )
     const { pruned } = await fetch({
-      dir,
       fs,
+      http,
+      dir,
       gitdir,
       depth: 1,
       prune: true
@@ -289,8 +302,9 @@ describe('fetch', () => {
     const oldValue = await fs.read(`${gitdir}/refs/tags/v1.0.0`, 'utf8')
     try {
       await fetch({
-        dir,
         fs,
+        http,
+        dir,
         gitdir,
         depth: 1,
         tags: true,

diff --git a/__tests__/test-getRemoteInfo.js b/__tests__/test-getRemoteInfo.js
@@ -3,6 +3,7 @@
 const snapshots = require('./__snapshots__/test-getRemoteInfo.js.snap')
 const registerSnapshots = require('./__helpers__/jasmine-snapshots')
 const { E, getRemoteInfo } = require('isomorphic-git')
+const { http } = require('isomorphic-git/http')
 
 // this is so it works with either Node local tests or Browser WAN tests
 const localhost =
@@ -14,6 +15,7 @@ describe('getRemoteInfo', () => {
   })
   it('getRemoteInfo', async () => {
     const info = await getRemoteInfo({
+      http,
       url: `http://${localhost}:8888/test-dumb-http-server.git`
     })
     expect(info).not.toBeNull()
@@ -27,6 +29,7 @@ describe('getRemoteInfo', () => {
       let error = null
       try {
         await getRemoteInfo({
+          http,
           url: `http://${localhost}:9876/base/__tests__/__fixtures__/test-dumb-http-server.git`
         })
       } catch (err) {

diff --git a/__tests__/test-hosting-providers.js b/__tests__/test-hosting-providers.js
@@ -2,6 +2,7 @@
 const { makeFixture } = require('./__helpers__/FixtureFS.js')
 
 const { fetch, push } = require('isomorphic-git')
+const { http } = require('isomorphic-git/http')
 
 // this is so it works with either Node local tests or Browser WAN tests
 const localhost =
@@ -23,6 +24,7 @@ describe('Hosting Providers', () => {
       // Test
       const res = await fetch({
         fs,
+        http,
         gitdir,
         corsProxy: process.browser ? `http://${localhost}:9999` : undefined,
         username: 'tester-at-260687965765',
@@ -48,6 +50,7 @@ describe('Hosting Providers', () => {
       // Test
       const res = await push({
         fs,
+        http,
         gitdir,
         corsProxy: process.browser ? `http://${localhost}:9999` : undefined,
         username: 'tester-at-260687965765',
@@ -75,6 +78,7 @@ describe('Hosting Providers', () => {
       // Test
       const res = await fetch({
         fs,
+        http,
         noGitSuffix: true,
         gitdir,
         // corsProxy: process.browser ? `http://${localhost}:9999` : undefined,
@@ -99,6 +103,7 @@ describe('Hosting Providers', () => {
       // Test
       const res = await push({
         fs,
+        http,
         noGitSuffix: true,
         gitdir,
         // corsProxy: process.browser ? `http://${localhost}:9999` : undefined,
@@ -129,6 +134,7 @@ describe('Hosting Providers', () => {
       // Test
       const res = await push({
         fs,
+        http,
         gitdir,
         corsProxy: process.browser ? `http://${localhost}:9999` : undefined,
         username: 'isomorphic-git',
@@ -156,6 +162,7 @@ describe('Hosting Providers', () => {
       // Test
       const res = await fetch({
         fs,
+        http,
         gitdir,
         corsProxy: process.browser ? `http://${localhost}:9999` : undefined,
         username: 'isomorphic-git',
@@ -183,6 +190,7 @@ describe('Hosting Providers', () => {
       // Test
       const res = await fetch({
         fs,
+        http,
         gitdir,
         corsProxy: process.browser ? `http://${localhost}:9999` : undefined,
         token: token,
@@ -207,6 +215,7 @@ describe('Hosting Providers', () => {
       // Test
       const res = await push({
         fs,
+        http,
         gitdir,
         corsProxy: process.browser ? `http://${localhost}:9999` : undefined,
         token: token,
@@ -235,6 +244,7 @@ describe('Hosting Providers', () => {
       // Test
       const res = await fetch({
         fs,
+        http,
         gitdir,
         corsProxy: process.browser ? `http://${localhost}:9999` : undefined,
         username: 'isomorphic-git-test-push',
@@ -260,6 +270,7 @@ describe('Hosting Providers', () => {
       // Test
       const res = await push({
         fs,
+        http,
         gitdir,
         corsProxy: process.browser ? `http://${localhost}:9999` : undefined,
         username: 'isomorphic-git-test-push',

diff --git a/__tests__/test-plugin-http.js b/__tests__/test-plugin-http.js
@@ -2,7 +2,7 @@
 const { makeFixture } = require('./__helpers__/FixtureFS.js')
 
 const { clone } = require('isomorphic-git')
-const { http } = require('isomorphic-git/internal-apis')
+const { http } = require('isomorphic-git/http')
 
 // this is so it works with either Node local tests or Browser WAN tests
 const localhost =

diff --git a/__tests__/test-plugin_credentialManager.js b/__tests__/test-plugin_credentialManager.js
@@ -2,6 +2,7 @@
 const { makeFixture } = require('./__helpers__/FixtureFS.js')
 
 const { setConfig, push, E } = require('isomorphic-git')
+const { http } = require('isomorphic-git/http')
 
 // this is so it works with either Node local tests or Browser WAN tests
 const localhost =
@@ -23,6 +24,7 @@ describe('credentialManager', () => {
     let rejectedCalled = false
     await push({
       fs,
+      http,
       gitdir,
       remote: 'auth',
       ref: 'master',
@@ -61,6 +63,7 @@ describe('credentialManager', () => {
     try {
       await push({
         fs,
+        http,
         gitdir,
         remote: 'auth',
         ref: 'master',