Merge pull request #21 from GiovanniCardamone/dev

Release 1.0.8
GiovanniCardamone · Aug 9, 2020 · c0fb334 · c0fb334
2 parents 23f10b7 + 639c5eb
commit c0fb334
Show file tree

Hide file tree

Showing 8 changed files with 250 additions and 139 deletions.
diff --git a/.github/workflows/ci-coverage.yml b/.github/workflows/ci-coverage.yml
@@ -1,7 +1,10 @@
 name: CI Coverage
-on: [push, pull_request]
+on:
+    push:
+        branches:
+            - master
 jobs:
-    test:
+    coverage:
         name: ${{ matrix.node-version }} ${{ matrix.os }}
         runs-on: ${{ matrix.os }}
         strategy:

diff --git a/README.md b/README.md
@@ -9,7 +9,7 @@
 [![GitHub license](https://img.shields.io/github/license/GiovanniCardamone/fastify-autoroutes.svg)](https://github.com/GiovanniCardamone/fastify-autoroutes/blob/master/LICENSE)
 
 ![CI Test](https://github.com/GiovanniCardamone/fastify-autoroutes/workflows/CI%20Test/badge.svg)
-[![codecov](https://codecov.io/gh/GiovanniCardamone/fastify-autoroutes/branch/dev/graph/badge.svg)](https://codecov.io/gh/GiovanniCardamone/fastify-autoroutes)
+[![codecov](https://codecov.io/gh/GiovanniCardamone/fastify-autoroutes/branch/master/graph/badge.svg)](https://codecov.io/gh/GiovanniCardamone/fastify-autoroutes)
 
 [![NPM downloads](https://img.shields.io/npm/dm/fastify-autoroutes.svg?style=flat)](https://www.npmjs.com/package/fastify-autoroutes)
 [![Known Vulnerabilities](https://snyk.io/test/github/GiovanniCardamone/fastify-autoroutes/badge.svg)](https://snyk.io/test/github/GiovanniCardamone/fastify-autoroutes)

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
     "name": "fastify-autoroutes",
-    "version": "1.0.6",
+    "version": "1.0.8",
     "description": "Map directory structure to routes",
     "main": "dist/index.js",
     "scripts": {
@@ -11,6 +11,7 @@
         "test": "npm run build && npm run tap",
         "test:watch": "nodemon --exec 'npm run tap'",
         "coverage": "tap --coverage-report=text-lcov | codecov -t $CODECOV_TOKEN",
+        "coverage:show": "tap --cov --coverage-report=html tests",
         "deploy": "npm run test && npm publish"
     },
     "repository": {

diff --git a/src/index.ts b/src/index.ts
@@ -5,6 +5,8 @@ import process from 'process'
 import path from 'path'
 import fs from 'fs'
 
+export const errorLabel = '[ERROR] fastify-autoload:'
+
 export type ValidMethods =
   | 'DELETE'
   | 'GET'
@@ -112,7 +114,9 @@ function autoload(
   const module = loadModule(fullPath, log)
 
   if (typeof module !== 'function') {
-    throw new Error(`module ${fullPath} must export default function`)
+    throw new Error(
+      `${errorLabel} module ${fullPath} must export default function`
+    )
   }
 
   const routes = module(fastify)
@@ -143,10 +147,9 @@ function loadModule(path: string, log: boolean) {
       return module.default
     }
 
-    throw new Error('unable to find any entrypoint for module')
+    return
   } catch (error) {
-    log &&
-      console.error(`[ERROR] fastify-autoload: unable to load module ${path}`)
+    log && console.error(`${errorLabel} unable to load module ${path}`)
 
     throw error
   }
@@ -157,15 +160,15 @@ export default fastifyPlugin<FastifyAutoroutesOptions>(
     const log = options.log ?? true
 
     if (!options.dir) {
-      const message = 'dir must be specified'
-      log && console.error(`[ERROR] fastify-autoload: ${message}`)
+      const message = `${errorLabel} dir must be specified`
+      log && console.error(message)
 
       return next(new Error(message))
     }
 
     if (typeof options.dir !== 'string') {
-      const message = 'dir must be the path of autoroutes-directory'
-      log && console.error(`[ERROR] fastify-autoload: ${message}`)
+      const message = `${errorLabel} dir must be the path of autoroutes-directory`
+      log && console.error(message)
 
       return next(new Error(message))
     }
@@ -181,24 +184,23 @@ export default fastifyPlugin<FastifyAutoroutesOptions>(
     }
 
     if (!fs.existsSync(dirPath)) {
-      const message = `dir ${dirPath} does not exists`
-      log && console.error(`[ERROR] fastify-autoload: ${message}`)
+      const message = `${errorLabel} dir ${dirPath} does not exists`
+      log && console.error(message)
 
       return next(new Error(message))
     }
 
     if (!fs.statSync(dirPath).isDirectory()) {
-      const message = `dir ${dirPath} must be a directory`
-      log && console.error(`[ERROR] fastify-autoload: ${message}`)
+      const message = `${errorLabel} dir ${dirPath} must be a directory`
+      log && console.error(message)
 
       return next(new Error(message))
     }
 
     try {
       scan(fastify, dirPath, '', options.log)
     } catch (error) {
-      const message = error.message
-      log && console.error(`[ERROR] fastify-autoload: ${message}`)
+      log && console.error(error.message)
 
       return next(error)
     } finally {

diff --git a/tests/invalid-routes-test-invalid-type-routes-directory/dirAsFile b/tests/invalid-routes-test-invalid-type-routes-directory/dirAsFile
@@ -0,0 +1 @@
+routes
diff --git a/tests/invalid-routes.test.js b/tests/invalid-routes.test.js
@@ -0,0 +1,50 @@
+const tap = require('tap')
+const path = require('path')
+
+const fastify = require('fastify')
+const autoroutes = require('../dist')
+
+const errorLabel = autoroutes.errorLabel
+
+tap.test('invalid type routes directory', { saveFixture: true }, (t) => {
+  const server = fastify()
+
+  const invalidDir = t.testdir({
+    'dirAsFile': t.fixture('file', 'routes')
+  })
+
+  server.register(autoroutes, {
+    dir: path.join(invalidDir, 'dirAsFile'),
+    log: false
+  })
+
+  server.inject({
+    method: 'GET',
+    url: '/',
+  }, (err, res) => {
+      t.assert(err.message.startsWith(errorLabel))
+      t.end()
+  })
+
+})
+
+tap.test('empty routes module', { saveFixture: false }, (t) => {
+  const server = fastify()
+
+  const dir = t.testdir({
+    'index.js': '' // empty
+  })
+
+  server.register(autoroutes, {
+    dir: dir,
+    log: false
+  })
+
+  server.inject({
+    method: 'GET',
+    url: '/',
+  }, (err, res) => {
+      t.assert(err.message.startsWith(errorLabel))
+      t.end()
+  })
+})
diff --git a/tests/options.test.js b/tests/options.test.js
@@ -3,154 +3,52 @@ const tap = require('tap')
 const fastify = require('fastify')
 const autoroutes = require('../dist')
 
-const exampleGetRoute =
-`module.exports = function (server) {
-  return {
-    get: {
-      handler: function (request, reply) {
-        reply.send('get')
-      }
-    }
-  }
-}
-`
+const errorLabel = autoroutes.errorLabel
 
-const exampleGetRouteUrlParam =
-`module.exports = function (server) {
-  return {
-    get: {
-      handler: function (request, reply) {
-        reply.send(request.params.PARAM)
-      }
-    }
-  }
-}
-`
-
-tap.test('simple index', { saveFixture: false }, (t) => {
-  const server = fastify()
-
-  const dir = t.testdir({
-    'index.js': exampleGetRoute
-  })
-
-  server.register(autoroutes, {
-    dir: dir,
-    log: false
-  })
-
-  server.inject({
-    method: 'GET',
-    url: '/',
-  }, (err, res) => {
-      t.is(err, null)
-      t.is(res.payload, 'get')
-      t.end()
-  })
-})
-
-tap.test('nested routes', { saveFixture: false }, (t) => {
-  const server = fastify()
-
-  const dir = t.testdir({
-    'users': {
-      'foo.js': exampleGetRoute
-    }
-  })
-
-  server.register(autoroutes, {
-    dir: dir,
-    log: false
-  })
-
-  server.inject({
-    method: 'GET',
-    url: '/users/foo',
-  }, (err, res) => {
-      t.is(err, null)
-      t.is(res.payload, 'get')
-      t.end()
-  })
-})
-
-tap.test('nested routes with trailing slashes', { saveFixture: false }, (t) => {
+tap.test('no dir parameters', (t) => {
   const server = fastify()
 
-  const dir = t.testdir({
-    'users': {
-      'foo': {
-        'index.js': exampleGetRoute
-      }
-    }
-  })
-
-  server.register(autoroutes, {
-    dir: dir,
-    log: false
-  })
+  server.register(autoroutes, { log: false })
 
   server.inject({
     method: 'GET',
-    url: '/users/foo/',
-  }, (err, res) => {
-      t.is(err, null)
-      t.is(res.payload, 'get')
-      t.end()
+    url: '/does-not-really-matter'
+  }, (error) => {
+    t.assert(error.message.startsWith(errorLabel))
+    t.end()
   })
 })
 
-tap.test('nested routes with url parameter', { saveFixture: false }, (t) => {
+tap.test('ivalid dir parameters', (t) => {
   const server = fastify()
 
-  const dir = t.testdir({
-    'users': {
-      '{PARAM}.js': exampleGetRouteUrlParam
-    }
-  })
-
   server.register(autoroutes, {
-    dir: dir,
+    dir: 33,
     log: false
   })
 
-  const userId = 'foo'
-
   server.inject({
     method: 'GET',
-    url: `/users/${userId}`,
-  }, (err, res) => {
-      t.is(err, null)
-      t.is(res.payload, userId)
-      t.end()
+    url: '/does-not-really-matter'
+  }, (error) => {
+    t.assert(error.message.startsWith(errorLabel))
+    t.end()
   })
-
 })
 
-tap.test('nested routes with url parameter with trailing slashes', { saveFixture: false }, (t) => {
+tap.test('dir does not exists', (t) => {
   const server = fastify()
 
-  const dir = t.testdir({
-    'users': {
-      '{PARAM}': {
-        'index.js': exampleGetRouteUrlParam
-      }
-    }
-  })
-
   server.register(autoroutes, {
-    dir: dir,
+    dir: './this-directory-does-not-exists',
     log: false
   })
 
-  const userId = 'foo'
-
   server.inject({
     method: 'GET',
-    url: `/users/${userId}/`,
-  }, (err, res) => {
-      t.is(err, null)
-      t.is(res.payload, userId)
-      t.end()
+    url: '/does-not-really-matter'
+  }, (error) => {
+    t.assert(error.message.startsWith(errorLabel))
+    t.end()
   })
-
 })