@anthonylzq/simba.js 5.1.0 → 6.0.0

package/README.md

@@ -1,12 +1,14 @@
 <h1 align="center">
   <!-- <p align="center">Simba.js</p> -->
-  <a href="https://simbajs.notion.site/783092dc7d444067b4c56a25d671f658?v=31060f3d17524ca58870e86c2960a6df"><img src="https://i.ibb.co/QHxn7kP/Gatonowww.png" alt="Simba.js"></a>
+  <a href="https://simbajs.notion.site/783092dc7d444067b4c56a25d671f658?v=31060f3d17524ca58870e86c2960a6df"><img src="https://i.ibb.co/QFX0WnH/simba-pink.png" alt="Simba.js"></a>
 </h1>
 
 [![NPM version](https://img.shields.io/npm/v/@anthonylzq/simba.js.svg?style=flat)](https://www.npmjs.com/package/@anthonylzq/simba.js)
 [![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/AnthonyLzq/simba.js/blob/master/LICENSE)
 [![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)
 [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://reactjs.org/docs/how-to-contribute.html#your-first-pull-request)
+[![Lint](https://github.com/AnthonyLzq/simba.js/actions/workflows/lint.yml/badge.svg)](https://github.com/AnthonyLzq/simba.js/actions/workflows/lint.yml)
+[![Tests for Simba APIs](https://github.com/AnthonyLzq/simba.js/actions/workflows/test.yml/badge.svg)](https://github.com/AnthonyLzq/simba.js/actions/workflows/test.yml)
 
 Set up a modern backend app by running one command. This project has the goal to create a complete setup for a backend application using `TypeScript` and `Express` or `Fastify`. It will create many files that are usually created manually. Think about Simba.js like a [CRA](https://create-react-app.dev/), but for backend development. Check the [**project structure**](#project-structure) for more information.
 
@@ -442,6 +444,7 @@ If you want to check the content of the files, please check the [example](https:
 - If you provide a project name that contains spaces, something like 'My awesome Project',  every space will be replaced with a hyphen. So at the end your project name will be 'My-awesome-project', but in its README.md file, the hyphens will be removed and the project name will be parsed to title case (My Awesome Project).
 - Finally, `git` will be initialized and a list of libraries will be installed. Check the [**notes**](#notes).
 - Relative imports is already configured, you do not need to import a file using `../../../some/very/nested/stuff/in/other/folder`, you can use `some/very/nested/stuff/in/other/folder` assuming that your folder is under the `src` folder.
+- The Fastify version is set to v3 because Apollo Server has not yet provided support for Fastify v4 yet, and it is difficult to have support for two different major versions of Fastify, so until Apollo Server supports Fastify v4, this package will use Fastify v3.
 
 ## What is new?
 

package/lib/index.js

@@ -12,7 +12,7 @@ const argv = yargs(hideBin(process.argv))
     '"simba [options]" (if you it installed globally) or only "simba -q" if you want to be asked for the options one by one'
   )
   .example(
-    "simba -N 'Project Name' -D 'Project description' -a Anthony -e sluzquinosa@uni.pe"
+    "simba -N 'Project Name' -D 'Project description' -a Anthony -e sluzquinosa@uni.pe -l mit -F --tests --ghat"
   )
   .alias('N', 'projectName')
   .nargs('N', 1)
@@ -54,6 +54,16 @@ const argv = yargs(hideBin(process.argv))
   .describe('F', 'Whether or not you want to use Fastify for your project')
   .alias('g', 'graphql')
   .describe('g', 'Whether or not you want to use GraphQL for your project')
+  .alias('t', 'tests')
+  .describe(
+    't',
+    'Whether or not you want to have a basic suit of unit tests with Jest'
+  )
+  .alias('ghat', 'gh-action-tests')
+  .describe(
+    'ghat',
+    'Whether or not you want to have a GitHub Action with a CI for your tests. If this option is set to true, the tests flag must be set to true.'
+  )
   .default({
     H: false,
     n: false,
@@ -63,9 +73,11 @@ const argv = yargs(hideBin(process.argv))
     f: 'src/index.ts',
     q: false,
     F: false,
-    g: false
+    g: false,
+    t: false,
+    ghat: false
   })
-  .boolean(['H', 'n', 'q', 'F', 'g'])
+  .boolean(['H', 'n', 'q', 'F', 'g', 't'])
   .help('h')
   .alias('h', 'help')
   .epilog('Developed by AnthonyLzq').argv
@@ -84,7 +96,9 @@ const config = {
   manager: 'yarn add',
   mainFile: 'src/index.ts',
   fastify: false,
-  graphql: false
+  graphql: false,
+  tests: true,
+  ghat: true
 }
 const UNLICENSED = 'unlicensed'
 const LICENSES = [
@@ -216,6 +230,21 @@ const main = async () => {
       }
     )
     config.mainFile = readLineSync.question('> Main file (src/index.ts): ')
+    config.tests = readLineSync.keyInYNStrict(
+      '> Would you want to have a basic suit of tests with Jest? ',
+      {
+        caseSensitive: false
+      }
+    )
+
+    if (config.tests)
+      config.ghat = readLineSync.keyInYNStrict(
+        '> Would you want to have a basic GitHub Action for the suit of tests?',
+        {
+          caseSensitive: false
+        }
+      )
+    else config.ghat = false
   } else {
     if (!argv.author) return console.log('Error! An author is required!')
     else config.author = argv.author
@@ -289,6 +318,15 @@ const main = async () => {
 
     if (!argv.mainFile) console.log('Using src/index.ts as default main file')
     else config.mainFile = argv.mainFile
+
+    if (argv.tests) config.tests = true
+
+    if (argv.ghat) config.ghat = true
+
+    if (!config.tests && argv.ghat)
+      return console.log(
+        'GitHub Action for tests can not be set to true if the tests flag is set to false'
+      )
   }
 
   await installation(config)

package/lib/src/functions/api/database.js

@@ -5,9 +5,10 @@ const writeFile = require('../../utils/writeFile')
 
 /**
  * @param {Object} args
- * @param {String} projectName
+ * @param {String} args.projectName
+ * @param {Boolean} args.fastify
  */
-const mongoF = async ({ projectName }) => {
+const mongoF = async ({ projectName, fastify }) => {
   const createFoldersCommand = `mkdir ${projectName}/src/database/mongo \
 ${projectName}/src/database/mongo/models \
 ${projectName}/src/database/mongo/queries`
@@ -22,9 +23,126 @@ ${projectName}/src/database/mongo/queries`
       file: `${projectName}/src/database/index.ts`
     },
     mongo: {
+      connection: {
+        content: fastify
+          ? `import { connect, connection } from 'mongoose'
+import { FastifyLoggerInstance } from 'fastify'
+
+const ENVIRONMENTS_WITHOUT_RECONNECTION = ['ci', 'local']
+const dbConnection = async (
+  logger: FastifyLoggerInstance
+): Promise<{
+  connect: () => Promise<typeof import('mongoose')>
+  disconnect: () => Promise<void>
+}> => {
+  const connectionConfig = {
+    keepAlive: true,
+    useNewUrlParser: true,
+    useUnifiedTopology: true
+  }
+
+  connection.on('connected', () => {
+    logger.info('Mongo connection established.')
+  })
+  connection.on('reconnected', () => {
+    logger.info('Mongo connection reestablished')
+  })
+  connection.on('disconnected', () => {
+    if (
+      !ENVIRONMENTS_WITHOUT_RECONNECTION.includes(
+        process.env.NODE_ENV as string
+      )
+    ) {
+      logger.info(
+        'Mongo connection disconnected. Trying to reconnected to Mongo...'
+      )
+      setTimeout(() => {
+        connect(process.env.MONGO_URI as string, {
+          ...connection,
+          connectTimeoutMS: 3000,
+          socketTimeoutMS: 3000
+        })
+      }, 3000)
+    }
+  })
+  connection.on('close', () => {
+    logger.info('Mongo connection closed')
+  })
+  connection.on('error', (e: Error) => {
+    logger.info('Mongo connection error:')
+    logger.error(e)
+  })
+
+  return {
+    connect: () => connect(process.env.MONGO_URI as string, connectionConfig),
+    disconnect: () => connection.close()
+  }
+}
+
+export { dbConnection }
+`
+          : `import { connect, connection } from 'mongoose'
+import { HttpLogger } from 'express-pino-logger'
+
+const ENVIRONMENTS_WITHOUT_RECONNECTION = ['ci', 'local']
+const dbConnection = async (
+  logger: HttpLogger['logger']
+): Promise<{
+  connect: () => Promise<typeof import('mongoose')>
+  disconnect: () => Promise<void>
+}> => {
+  const connectionConfig = {
+    keepAlive: true,
+    useNewUrlParser: true,
+    useUnifiedTopology: true
+  }
+
+  connection.on('connected', () => {
+    logger.info('Mongo connection established.')
+  })
+  connection.on('reconnected', () => {
+    logger.info('Mongo connection reestablished')
+  })
+  connection.on('disconnected', () => {
+    if (
+      !ENVIRONMENTS_WITHOUT_RECONNECTION.includes(
+        process.env.NODE_ENV as string
+      )
+    ) {
+      logger.info(
+        'Mongo connection disconnected. Trying to reconnected to Mongo...'
+      )
+      setTimeout(() => {
+        connect(process.env.MONGO_URI as string, {
+          ...connection,
+          connectTimeoutMS: 3000,
+          socketTimeoutMS: 3000
+        })
+      }, 3000)
+    }
+  })
+  connection.on('close', () => {
+    logger.info('Mongo connection closed')
+  })
+  connection.on('error', (e: Error) => {
+    logger.info('Mongo connection error:')
+    logger.error(e)
+  })
+
+  return {
+    connect: () => connect(process.env.MONGO_URI as string, connectionConfig),
+    disconnect: () => connection.close()
+  }
+}
+
+export { dbConnection }
+`,
+        file: `${projectName}/src/database/mongo/connection.ts`
+      },
       index: {
         content: `export * from './models'
 export * from './queries'
+export * from './connection'
 `,
         file: `${projectName}/src/database/mongo/index.ts`
       },
@@ -72,13 +190,14 @@ export { UserModel }
           file: `${projectName}/src/database/mongo/queries/index.ts`
         },
         user: {
-          content: `import { Document, Types } from 'mongoose'
+          content: `import { Document, MergeType, Types } from 'mongoose'
 
 import { UserModel } from '..'
-import { UserDTO } from 'schemas'
+import { User, UserDTO, UserWithId } from 'schemas'
 
 const userDBOtoDTO = (
-  userDBO: Document<unknown, unknown, UserDBO> &
+  userDBO: Document<unknown, unknown, MergeType<UserDBO, UserDBO>> &
+    Omit<UserDBO, keyof UserDBO> &
     UserDBO & {
       _id: Types.ObjectId
     }
@@ -88,7 +207,7 @@ const userDBOtoDTO = (
   updatedAt: userDBO.updatedAt.toISOString()
 })
 
-const store = async (userData: UserDTO): Promise<UserDTO> => {
+const store = async (userData: User): Promise<UserDTO> => {
   const user = new UserModel(userData)
 
   await user.save()
@@ -124,7 +243,7 @@ const get = async (
   return users.map(u => userDBOtoDTO(u))
 }
 
-const update = async (userData: UserDTO): Promise<UserDTO | null> => {
+const update = async (userData: UserWithId): Promise<UserDTO | null> => {
   const { id, ...rest } = userData
   const user = await UserModel.findByIdAndUpdate(id, rest, { new: true })
 
@@ -140,21 +259,25 @@ export { store, remove, get, update }
   }
 
   await Promise.all([
-    await writeFile(database.index.file, database.index.content),
-    await writeFile(database.mongo.index.file, database.mongo.index.content),
-    await writeFile(
+    writeFile(database.index.file, database.index.content),
+    writeFile(
+      database.mongo.connection.file,
+      database.mongo.connection.content
+    ),
+    writeFile(database.mongo.index.file, database.mongo.index.content),
+    writeFile(
       database.mongo.models.index.file,
       database.mongo.models.index.content
     ),
-    await writeFile(
+    writeFile(
       database.mongo.models.user.file,
       database.mongo.models.user.content
     ),
-    await writeFile(
+    writeFile(
       database.mongo.queries.index.file,
       database.mongo.queries.index.content
     ),
-    await writeFile(
+    writeFile(
       database.mongo.queries.user.file,
       database.mongo.queries.user.content
     )
@@ -165,13 +288,14 @@ export { store, remove, get, update }
  * @param {Object} args
  * @param {Boolean|undefined} args.mongo
  * @param {String} args.projectName
+ * @param {Boolean} args.fastify
  */
-module.exports = async ({ mongo = true, projectName }) => {
+module.exports = async ({ mongo = true, projectName, fastify }) => {
   const createFoldersCommand = `mkdir ${projectName}/src/database`
 
   if (platform() === 'win32')
     await exec(createFoldersCommand.replaceAll('/', '\\'))
   else await exec(createFoldersCommand)
 
-  if (mongo) await mongoF({ projectName })
+  if (mongo) await mongoF({ projectName, fastify })
 }

package/lib/src/functions/api/index.js

@@ -9,6 +9,7 @@ const types = require('./types')
 const network = require('./network')
 const utils = require('./utils')
 const writeFile = require('../../utils/writeFile')
+const { ENVIRONMENTS_WITH_MONGO_URI } = require('../../utils/constants')
 
 /*
  * Express api:
@@ -163,7 +164,7 @@ DELETE http://localhost:1996/api/user/60e7e3b93b01c1a7aa74cd6b
     },
     '.env': {
       content: `MONGO_URI = ${
-        process.env.LOCAL
+        ENVIRONMENTS_WITH_MONGO_URI.includes(process.env.NODE_ENV)
           ? process.env.MONGO_URI
           : `mongodb://mongo:mongo@mongo:27017/${projectName}`
       }`,
@@ -194,7 +195,8 @@ Server.start()
     // /database
     database({
       mongo,
-      projectName
+      projectName,
+      fastify
     }),
     // /network
     network({