feat: tests succeed in multiple environemnts

Author: SgtPooki

.envrc

@@ -3,4 +3,4 @@ use asdf
 export PATH=$(npm bin):${PATH}
 export MOCK_PINNING_SERVER_PORT=3000
 export MOCK_PINNING_SERVER_SECRET=secret
-export DEBUG=1
+export DEBUG=0

CONTRIBUTING.md

@@ -0,0 +1,30 @@
+## @ipfs-shipyard/pinning-service-client@1.0.0
+
+This generator creates TypeScript/JavaScript client that utilizes fetch-api.
+
+### Building
+
+To build and compile the typescript sources to javascript use:
+```
+npm install
+npm run build
+```
+
+### Publishing
+
+First build the package then run ```npm publish```
+
+### Consuming
+
+navigate to the folder of your consuming project and run one of the following commands.
+
+_published:_
+
+```
+npm install @ipfs-shipyard/[email protected] --save
+```
+
+_unPublished (not recommended):_
+
+```
+npm install PATH_TO_GENERATED_PACKAGE --save

MockServer.ts

@@ -125,8 +125,7 @@ export class MockServer {
         // MockServer.portsInUse.remove(this.port)
         MockServer.debug(`${Date.now()}: MockServer stopped listening on port ${port}`)
         delete this._server
-      }
-      if (err != null) {
+      } else if (err != null) {
         MockServer.error(err.name)
         MockServer.error(err.message)
         MockServer.error(err.stack)
@@ -148,7 +147,7 @@ export class MockServer {
   }
 
   private static debug (...logObjects: unknown[]) {
-    if (process.env.DEBUG != null) {
+    if (process.env.DEBUG != null && Number(process.env.DEBUG) !== 0) {
       MockServer.log('debug', ...logObjects)
     }
   }

MockServerController.ts

@@ -91,14 +91,14 @@ class MockServerController {
 
     // To prevent duplicated cleanup, remove the process listeners on server close.
     this.server.on('close', () => {
-      process.off('beforeExit', this.shutdown)
-      process.off('SIGTERM', this.shutdown)
-      process.off('SIGINT', this.shutdown)
-      process.off('SIGHUP', this.shutdown)
     })
   }
 
   async shutdown () {
+    process.off('beforeExit', this.shutdown)
+    process.off('SIGTERM', this.shutdown)
+    process.off('SIGINT', this.shutdown)
+    process.off('SIGHUP', this.shutdown)
     await new Promise<void>((resolve, reject) => {
       this.server.close((err) => {
         if (err != null) {

README.md

@@ -1,30 +1,36 @@
 ## @ipfs-shipyard/pinning-service-client@1.0.0
 
-This generator creates TypeScript/JavaScript client that utilizes fetch-api.
+This client was generated using [openapi-generator](https://github.com/OpenAPITools/openapi-generator) from the [ipfs pinning services API spec](https://raw.githubusercontent.com/ipfs/pinning-services-api-spec/main/ipfs-pinning-service.yaml).
 
-### Building
+You can see the commands used to generate the client in the `gen:fetch` npm script.
 
-To build and compile the typescript sources to javascript use:
-```
-npm install
-npm run build
-```
+### Usage
 
-### Publishing
+This client only has a programmatic API at the moment (no CLI). You use it like so:
 
-First build the package then run ```npm publish```
+```ts
 
-### Consuming
+import { Configuration, PinsApi, Status } from '@ipfs-shipyard/pinning-service-client'
+import type { PinsGetRequest, PinResults } from '@ipfs-shipyard/pinning-service-client'
 
-navigate to the folder of your consuming project and run one of the following commands.
+const config = new Configuration({
+  basePath, // the URI for your pinning provider, e.g. `http://localhost:3000`
+  accessToken, // the secret token/key given to you by your pinning provider
+  // fetchApi: fetch, // You can pass your own fetchApi implementation, but we use fetch-ponyfill by default.
+})
 
-_published:_
+const client = new PinsApi(config)
 
-```
-npm install @ipfs-shipyard/[email protected] --save
-```
+(async () => {
+  // Get 10 failed Pins
+  const pinsGetOptions: PinsGetRequest = {
+    limit: 10,
+    status: Status.Failed
+  }
+  const {count, results}: PinResults = await client.pinsGet(pinsGetOptions)
+
+  console.log(count, results)
 
-_unPublished (not recommended):_
+})()
 
 ```
-npm install PATH_TO_GENERATED_PACKAGE --save

package.json

@@ -145,6 +145,8 @@
     "build:main": "aegir build -- -p tsconfig.json --suppress 6133@generated 6192@generated --stats",
     "build:docs": "aegir ts docs",
     "test": "run-s test:*",
+    "test:browser": "aegir test --target browser",
+    "test:webworker": "aegir test --target webworker",
     "test:electron": "aegir test --target electron-main",
     "test:node": "aegir test --target node --cov && npx nyc report",
     "pregen": "openapi-generator-cli validate -i https://raw.githubusercontent.com/ipfs/pinning-services-api-spec/main/ipfs-pinning-service.yaml",
@@ -155,6 +157,7 @@
     "gen:ts": "openapi-generator-cli generate --generator-key ts"
   },
   "dependencies": {
+    "fetch-ponyfill": "^7.1.0",
     "patch-package": "^6.4.7"
   },
   "devDependencies": {
@@ -174,9 +177,7 @@
     "dotenvrc": "^1.0.1",
     "express": "^4.17.3",
     "express-promise-router": "^4.1.1",
-    "fetch-ponyfill": "^7.1.0",
     "mock-ipfs-pinning-service": "^0.4.0",
-    "node-fetch": "^2.6.1",
     "npm-run-all": "^4.1.5",
     "openapi-typescript": "^5.1.1",
     "portscanner": "^2.2.0",

src/index.ts

@@ -1 +1,17 @@
+import fetchPonyfill from 'fetch-ponyfill'
+import { Configuration as GeneratedConfiguration, ConfigurationParameters } from '../generated/fetch/src/index'
+
+class Configuration extends GeneratedConfiguration {
+  constructor (options: ConfigurationParameters) {
+    /**
+     * Prevent the need for everyone to have to override the fetch API...
+     */
+    if (options.fetchApi == null) {
+      options.fetchApi = fetchPonyfill().fetch
+    }
+    super(options)
+  }
+}
+
 export * from '../generated/fetch/src/index'
+export { Configuration }

test/browser-tests/.gitkeep

@@ -1,17 +1,17 @@
-/* eslint-disable no-console */
+// /* eslint-disable no-console */
 
-import clientTests from './isomorphic-tests/client'
-// import configurationTests from './configuration.spec'
-import fetchPonyfill from 'fetch-ponyfill'
+// import clientTests from './isomorphic-tests/client'
+// // import configurationTests from './configuration.spec'
+// import fetchPonyfill from 'fetch-ponyfill'
 
-const setup = async () => {
-  return {
-    fetch: fetchPonyfill().fetch as GlobalFetch['fetch']
-  }
-}
+// const setup = async () => {
+//   return {
+//     fetch: fetchPonyfill().fetch as GlobalFetch['fetch']
+//   }
+// }
 
-// eslint-disable-next-line @typescript-eslint/no-misused-promises
-describe('browser', async (): Promise<void> => {
-  // await configurationTests(setup)
-  await clientTests(setup)
-})
+// // eslint-disable-next-line @typescript-eslint/no-misused-promises
+// describe('browser', async (): Promise<void> => {
+//   // await configurationTests(setup)
+//   await clientTests(setup)
+// })

test/browser.ts

@@ -0,0 +1,74 @@
+/* eslint-env browser, node, mocha */
+
+import { expect } from 'aegir/utils/chai'
+import { Configuration, PinsApi, Status } from '../src'
+import type { Pin } from '../src'
+import fetchPonyfill from 'fetch-ponyfill'
+
+// export default async (setup: () => Promise<{fetch: GlobalFetch['fetch']}>) => {
+const { fetch } = fetchPonyfill()
+
+let Config = new Configuration({
+  basePath: `http://127.0.0.1:${process.env.MOCK_PINNING_SERVER_PORT ?? '3000'}`,
+  // fetchApi: fetch,
+  accessToken: process.env.MOCK_PINNING_SERVER_SECRET
+})
+describe('Client', () => {
+  it('Can be instantiated', () => {
+    expect(() => new PinsApi(Config)).not.to.throw()
+  })
+
+  describe('Operations', () => {
+    // let mockServer: MockServer
+    // let Config: Configuration
+    beforeEach(async () => {
+      const response = await fetch('http://localhost:3000/start')
+      const { basePath, accessToken } = await response.json()
+      Config = new Configuration({
+        basePath,
+        accessToken
+        // fetchApi: fetch
+      })
+    })
+
+    afterEach(async () => {
+      const [,,port] = Config.basePath.split(':')
+      const response = await fetch(`http://localhost:3000/stop/${port}`)
+
+      const { success } = await response.json()
+
+      if (success === false) {
+        throw new Error(`Unexpected error when attempting to stop the mockServer on port ${port}`)
+      }
+    })
+
+    it('GET: Can get failed Pins', async () => {
+      const Client = new PinsApi(Config)
+      const response = await Client.pinsGet({ limit: 1, status: new Set([Status.Failed]) })
+      expect(response).to.deep.eq({ count: 0, results: new Set() })
+    })
+
+    it('GET: Can add a Pin successfully', async () => {
+      const Client = new PinsApi(Config)
+      const pin: Pin = {
+        cid: 'abc123',
+        name: 'pinned-test1'
+      }
+      const response = await Client.pinsPost({ pin })
+      expect(response).to.deep.includes({ status: Status.Pinned })
+      expect(response.pin).to.deep.include({ ...pin })
+    })
+
+    it('POST: Can handle a failed pinning', async () => {
+      const Client = new PinsApi(Config)
+      const pin: Pin = {
+        cid: 'abc123',
+        name: 'failed-test2'
+      }
+      const response = await Client.pinsPost({ pin })
+      expect(response).to.deep.includes({ status: Status.Failed })
+      expect(response.pin).to.deep.include({ ...pin })
+    })
+  })
+})
+// }