test: improve tests

Xstoudi · Xstoudi · commit b80771aa505a · 2024-05-09T11:51:04.000+02:00
diff --git a/.gitignore b/.gitignore
@@ -11,3 +11,4 @@ test/__app
 build
 dist
 shrinkwrap.yaml
+tmp
diff --git a/.npmrc b/.npmrc
@@ -0,0 +1 @@
+package-lock=false
diff --git a/bin/test.ts b/bin/test.ts
@@ -1,11 +1,12 @@
 import { assert } from '@japa/assert'
 import { configure, processCLIArgs, run } from '@japa/runner'
+import { fileSystem } from '@japa/file-system'
 
 processCLIArgs(process.argv.splice(2))
 
 configure({
   files: ['tests/**/*.spec.ts'],
-  plugins: [assert()],
+  plugins: [assert(), fileSystem()],
 })
 
 run()
diff --git a/index.ts b/index.ts
@@ -1,10 +1,4 @@
-/*
-|--------------------------------------------------------------------------
-| Package entrypoint
-|--------------------------------------------------------------------------
-|
-| Export values from the package entrypoint as you see fit.
-|
-*/
-
+export { GeoLite2 } from './src/geolite2.js'
 export { configure } from './configure.js'
+export { stubsRoot } from './stubs/main.js'
+export { defineConfig } from './src/define_config.js'
diff --git a/package.json b/package.json
@@ -7,11 +7,9 @@
   },
   "type": "module",
   "files": [
-    "build/src",
-    "build/providers",
-    "build/stubs",
-    "build/index.d.ts",
-    "build/index.js"
+    "build",
+    "!build/bin",
+    "!build/tests"
   ],
   "exports": {
     ".": "./build/index.js",
@@ -27,9 +25,8 @@
     "pretest": "npm run lint",
     "test": "c8 npm run quick:test",
     "prebuild": "npm run lint && npm run clean",
-    "build": "tsc",
+    "build": "tsup",
     "postbuild": "npm run copy:templates",
-    "release": "np",
     "version": "npm run build",
     "prepublishOnly": "npm run build"
   },
@@ -57,6 +54,7 @@
     "@adonisjs/prettier-config": "^1.3.0",
     "@adonisjs/tsconfig": "^1.3.0",
     "@japa/assert": "^2.1.0",
+    "@japa/file-system": "^2.3.0",
     "@japa/runner": "^3.1.1",
     "@swc/core": "^1.4.6",
     "@types/node": "^20.11.25",
@@ -67,7 +65,7 @@
     "np": "^10.0.0",
     "prettier": "^3.2.5",
     "ts-node": "^10.9.2",
-    "typescript": "^5.4.2"
+    "typescript": "5.3.3"
   },
   "peerDependencies": {
     "@adonisjs/core": "^6.2.0"
@@ -88,14 +86,16 @@
       "html"
     ],
     "exclude": [
-      "tests/**"
+      "tests/**",
+      "stubs/**"
     ]
   },
   "eslintConfig": {
     "extends": "@adonisjs/eslint-config/package"
   },
   "prettier": "@adonisjs/prettier-config",
   "dependencies": {
+    "@poppinss/utils": "^6.7.3",
     "geolite2-redist": "^3.0.4",
     "maxmind": "^4.3.19"
   },
@@ -108,7 +108,8 @@
     "outDir": "./build",
     "clean": true,
     "format": "esm",
-    "dts": true,
+    "dts": false,
+    "sourcemap": true,
     "target": "esnext"
   },
   "volta": {
diff --git a/providers/geolite2_provider.ts b/providers/geolite2_provider.ts
@@ -8,21 +8,21 @@ import { RuntimeException } from '@poppinss/utils'
 
 declare module '@adonisjs/core/types' {
   export interface ContainerBindings {
-    'geolite2.manager': GeoLite2Service
+    geolite2: GeoLite2Service
   }
 }
 
 export default class GeoLite2Provider {
   constructor(protected app: ApplicationService) {}
 
   register() {
-    this.app.container.singleton('geolite2.manager', async () => {
+    this.app.container.singleton('geolite2', async () => {
       const geolite2Config = this.app.config.get<GeoLite2Config>('geolite2')
       const config = await configProvider.resolve<ResolvedGeoLite2Config>(this.app, geolite2Config)
 
       if (!config) {
         throw new RuntimeException(
-          'Invalid config exported from "config/geolite2.ts" file. Make sure to use the defineConfig method'
+          'Invalid default export from "config/geolite2.ts" file. Make sure to use defineConfig method'
         )
       }
 
@@ -31,7 +31,7 @@ export default class GeoLite2Provider {
   }
 
   async boot() {
-    const manager = await this.app.container.make('geolite2.manager')
+    const manager = await this.app.container.make('geolite2')
     await manager.init()
 
     HttpContext.getter(
@@ -44,7 +44,7 @@ export default class GeoLite2Provider {
   }
 
   async shutdown() {
-    const manager = await this.app.container.make('geolite2.manager')
+    const manager = await this.app.container.make('geolite2')
     manager.close()
   }
 }
diff --git a/src/define_config.ts b/src/define_config.ts
@@ -1,11 +1,12 @@
+import { resolve } from 'node:path'
 import { configProvider } from '@adonisjs/core'
 import { GeoLite2Config, ResolvedGeoLite2Config } from './types.js'
 import { ConfigProvider } from '@adonisjs/core/types'
 
 export function defineConfig(config: GeoLite2Config): ConfigProvider<ResolvedGeoLite2Config> {
   return configProvider.create(async (_app) => {
     return {
-      downloadDirectory: config.downloadDirectory,
+      downloadDirectory: resolve(config.downloadDirectory),
       cache: config.cache,
     }
   })
diff --git a/src/geolite2.ts b/src/geolite2.ts
@@ -1,5 +1,5 @@
-import { AllReaders, GeoLite2Contract } from './types.js'
-import { AsnResponse, CityResponse, CountryResponse } from 'maxmind'
+import type { AllReaders, GeoLite2Contract } from './types.js'
+import type { AsnResponse, CityResponse, CountryResponse } from 'maxmind'
 import { HttpContext } from '@adonisjs/core/http'
 
 declare module '@adonisjs/core/http' {
diff --git a/src/manager.ts b/src/manager.ts
@@ -1,5 +1,5 @@
 import * as geolite2 from 'geolite2-redist'
-import { type AllReaders, type GeoLite2Service, type ResolvedGeoLite2Config } from './types.js'
+import type { AllReaders, GeoLite2Service, ResolvedGeoLite2Config } from './types.js'
 import maxmind, { type CountryResponse, type CityResponse, type AsnResponse } from 'maxmind'
 import { GeoIpDbName } from 'geolite2-redist'
 
@@ -47,10 +47,6 @@ export default class GeoLite2Manager implements GeoLite2Service {
   }
 
   close() {
-    if (this.readers === null) {
-      return
-    }
-
     this.onClose()
   }
 
diff --git a/src/types.ts b/src/types.ts
@@ -1,4 +1,4 @@
-import { type AsnResponse, type CityResponse, type CountryResponse, type Reader } from 'maxmind'
+import type { AsnResponse, CityResponse, CountryResponse, Reader } from 'maxmind'
 
 export type AllReaders = {
   country: Reader<CountryResponse>
diff --git a/stubs/config.stub b/stubs/config.stub
@@ -4,5 +4,6 @@
 import { defineConfig } from '@stouder-io/adonis-geolite2'
 
 export default defineConfig({
-  downloadDir: path.resolve(path.dirname(fileURLToPath(import.meta.url)), '..', 'dbs')
+  downloadDirectory: '../dbs',
+  cache: 6000
 })
diff --git a/tests/configure.spec.ts b/tests/configure.spec.ts
@@ -0,0 +1,43 @@
+import { test } from '@japa/runner'
+import { fileURLToPath } from 'node:url'
+import { IgnitorFactory } from '@adonisjs/core/factories'
+import Configure from '@adonisjs/core/commands/configure'
+
+const BASE_URL = new URL('./tmp/', import.meta.url)
+
+test.group('Configure', (group) => {
+  group.each.setup(({ context }) => {
+    context.fs.baseUrl = BASE_URL
+    context.fs.basePath = fileURLToPath(BASE_URL)
+  })
+
+  test('create config file, register provider and update meta files', async ({ fs, assert }) => {
+    const ignitor = new IgnitorFactory()
+      .withCoreProviders()
+      .withCoreConfig()
+      .create(BASE_URL, {
+        importer: (filePath) => {
+          if (filePath.startsWith('./') || filePath.startsWith('../')) {
+            return import(new URL(filePath, BASE_URL).href)
+          }
+
+          return import(filePath)
+        },
+      })
+
+    await fs.create('.env', '')
+    await fs.createJson('tsconfig.json', {})
+    await fs.create('start/kernel.ts', `router.use([])`)
+    await fs.create('adonisrc.ts', `export default defineConfig({}) {}`)
+
+    const app = ignitor.createApp('web')
+    await app.init()
+    await app.boot()
+
+    const ace = await app.container.make('ace')
+    const command = await ace.create(Configure, ['../../index.js'])
+    await command.exec()
+
+    await assert.fileExists('config/geolite2.ts')
+  }).timeout(60 * 1000)
+})
diff --git a/tests/example.spec.ts b/tests/example.spec.ts
diff --git a/tests/geolite2_provider.spec.ts b/tests/geolite2_provider.spec.ts
@@ -0,0 +1,54 @@
+import { test } from '@japa/runner'
+import { IgnitorFactory } from '@adonisjs/core/factories'
+import { defineConfig } from '../src/define_config.js'
+import GeoLite2Manager from '../src/manager.js'
+
+const BASE_URL = new URL('./tmp/', import.meta.url)
+
+test.group('GeoLite2 Provider', () => {
+  test('register geolite2 provider', async ({ assert }) => {
+    const ignitor = new IgnitorFactory()
+      .withCoreConfig()
+      .withCoreProviders()
+      .merge({
+        config: {
+          geolite2: defineConfig({
+            downloadDirectory: './tmp',
+            cache: 6000,
+          }),
+        },
+        rcFileContents: {
+          providers: [() => import('../providers/geolite2_provider.js')],
+        },
+      })
+      .create(BASE_URL)
+
+    const app = ignitor.createApp('web')
+    await app.init()
+    await app.boot()
+    assert.instanceOf(await app.container.make('geolite2'), GeoLite2Manager)
+    await app.terminate()
+  })
+
+  test('throw error when config is invalid', async () => {
+    const ignitor = new IgnitorFactory()
+      .withCoreConfig()
+      .withCoreProviders()
+      .merge({
+        config: {
+          geolite2: {},
+        },
+        rcFileContents: {
+          providers: [() => import('../providers/geolite2_provider.js')],
+        },
+      })
+      .create(BASE_URL)
+
+    const app = ignitor.createApp('web')
+    await app.init()
+    await app.boot()
+    await app.container.make('geolite2')
+  }).throws(
+    'Invalid default export from "config/geolite2.ts" file. Make sure to use defineConfig method'
+  )
+})
diff --git a/tsconfig.json b/tsconfig.json
@@ -2,7 +2,6 @@
   "extends": "@adonisjs/tsconfig/tsconfig.package.json",
   "compilerOptions": {
     "rootDir": "./",
-    "outDir": "./build",
-    "preserveSymlinks": true
+    "outDir": "./build"
   }
 }

-Original file line number
+Diff line change
 build
 dist
 shrinkwrap.yaml
 +tmp
Original file line number	Diff line number	Diff line change
`@@ -8,21 +8,21 @@ import { RuntimeException } from '@poppinss/utils'`
`8`	`8`
`9`	`9`	`declare module '@adonisjs/core/types' {`
`10`	`10`	`export interface ContainerBindings {`
`11`		`- 'geolite2.manager': GeoLite2Service`
	`11`	`+ geolite2: GeoLite2Service`
`12`	`12`	`}`
`13`	`13`	`}`
`14`	`14`
`15`	`15`	`export default class GeoLite2Provider {`
`16`	`16`	`constructor(protected app: ApplicationService) {}`
`17`	`17`
`18`	`18`	`register() {`
`19`		`- this.app.container.singleton('geolite2.manager', async () => {`
	`19`	`+ this.app.container.singleton('geolite2', async () => {`
`20`	`20`	`const geolite2Config = this.app.config.get<GeoLite2Config>('geolite2')`
`21`	`21`	`const config = await configProvider.resolve<ResolvedGeoLite2Config>(this.app, geolite2Config)`
`22`	`22`
`23`	`23`	`if (!config) {`
`24`	`24`	`throw new RuntimeException(`
`25`		`- 'Invalid config exported from "config/geolite2.ts" file. Make sure to use the defineConfig method'`
	`25`	`+ 'Invalid default export from "config/geolite2.ts" file. Make sure to use defineConfig method'`
`26`	`26`	`)`
`27`	`27`	`}`
`28`	`28`
`@@ -31,7 +31,7 @@ export default class GeoLite2Provider {`
`31`	`31`	`}`
`32`	`32`
`33`	`33`	`async boot() {`
`34`		`- const manager = await this.app.container.make('geolite2.manager')`
	`34`	`+ const manager = await this.app.container.make('geolite2')`
`35`	`35`	`await manager.init()`
`36`	`36`
`37`	`37`	`HttpContext.getter(`
`@@ -44,7 +44,7 @@ export default class GeoLite2Provider {`
`44`	`44`	`}`
`45`	`45`
`46`	`46`	`async shutdown() {`
`47`		`- const manager = await this.app.container.make('geolite2.manager')`
	`47`	`+ const manager = await this.app.container.make('geolite2')`
`48`	`48`	`manager.close()`
`49`	`49`	`}`
`50`	`50`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`import * as geolite2 from 'geolite2-redist'`
`2`		`-import { type AllReaders, type GeoLite2Service, type ResolvedGeoLite2Config } from './types.js'`
	`2`	`+import type { AllReaders, GeoLite2Service, ResolvedGeoLite2Config } from './types.js'`
`3`	`3`	`import maxmind, { type CountryResponse, type CityResponse, type AsnResponse } from 'maxmind'`
`4`	`4`	`import { GeoIpDbName } from 'geolite2-redist'`
`5`	`5`
`@@ -47,10 +47,6 @@ export default class GeoLite2Manager implements GeoLite2Service {`
`47`	`47`	`}`
`48`	`48`
`49`	`49`	`close() {`
`50`		`- if (this.readers === null) {`
`51`		`- return`
`52`		`- }`
`53`		`-`
`54`	`50`	`this.onClose()`
`55`	`51`	`}`
`56`	`52`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-import { type AsnResponse, type CityResponse, type CountryResponse, type Reader } from 'maxmind'`
	`1`	`+import type { AsnResponse, CityResponse, CountryResponse, Reader } from 'maxmind'`
`2`	`2`
`3`	`3`	`export type AllReaders = {`
`4`	`4`	`country: Reader<CountryResponse>`