Merge pull request #2 from dancastillo/feat-add-cache-pkg-fix-tests

feat: add cache pkg and fix tests

.github/workflows/ci.yml

@@ -16,7 +16,7 @@ jobs:
         with:
           node-version-file: '.nvmrc'
       - run: |
-          npm ci
+          npm i
           npm run lint
           npm test
 

app.js

@@ -1,6 +1,7 @@
 'use strict'
 
 const fastify = require('fastify')
+const cache = require('@dancastillo/cache')
 
 const { fetchIssues, getGithubClient } = require('./fetchIssues')
 
@@ -45,7 +46,8 @@ function build(opts = {}) {
         includeBody,
         labels,
         org,
-        getGithubClient()
+        getGithubClient(),
+        cache()
       )
 
       reply.send({ results: issues })

fetchIssues.js

@@ -2,12 +2,6 @@
 
 const { Octokit } = require('@octokit/rest')
 
-let cache = {
-  org: '',
-  labels: [],
-  results: {}
-}
-
 /* istanbul ignore next */
 const getGithubClient = () => {
   /* istanbul ignore next */
@@ -16,14 +10,18 @@ const getGithubClient = () => {
   })
 }
 
-const fetchIssues = async (includeBody, labels, org, client) => {
-  if (cache.org === org && cache.labels.join('') === labels.join('')) {
-    return cache.results
+const fetchIssues = async (includeBody, labels, org, client, cache) => {
+  const data = cache.get(`${org}_${labels.join('_')}`)
+  if (data) {
+    return data
   }
   const itemSearchResults = await Promise.all(
     labels.map(async label => {
       const issues = await client.search.issuesAndPullRequests({
-        q: `is:issue is:open sort:updated-desc label:"${label}" org:"${org}"`
+        q: `is:issue is:open label:"${label}" org:"${org}"`,
+        sort: 'updated',
+        order: 'desc',
+        per_page: 100
       })
       return issues.data.items
     })
@@ -59,11 +57,7 @@ const fetchIssues = async (includeBody, labels, org, client) => {
       labels: item.labels.map(({ name }) => name)
     })
   }
-  cache = {
-    org,
-    labels,
-    results: Array.from(dedupeMap.values())
-  }
+  cache.set(`${org}_${labels.join('_')}`, Array.from(dedupeMap.values()))
   return Array.from(dedupeMap.values())
 }
 

package.json

@@ -5,9 +5,11 @@
   "main": "server.js",
   "scripts": {
     "lint": "eslint .",
-    "test": "tap test.js",
+    "lint:fix": "eslint . --fix",
+    "test": "tap test/*.js",
     "prepare": "npx husky install",
-    "start": "node ."
+    "start": "node .",
+    "dev": "nodemon ."
   },
   "repository": {
     "type": "git",
@@ -28,6 +30,7 @@
     "eslint-plugin-prettier": "^4.2.1",
     "husky": "^8.0.2",
     "lint-staged": "^13.1.0",
+    "nodemon": "^2.0.20",
     "pino-pretty": "^9.1.1",
     "prettier": "^2.8.1",
     "sinon": "^15.0.1",
@@ -37,6 +40,7 @@
     "*.{js,jsx}": "eslint --cache --fix"
   },
   "dependencies": {
+    "@dancastillo/cache": "^0.0.3",
     "@fastify/cors": "^8.2.0",
     "@octokit/rest": "^19.0.5",
     "dotenv": "^16.0.3",

test.js → test/test.js

@@ -3,7 +3,7 @@
 const tap = require('tap')
 const sinon = require('sinon')
 
-const { fetchIssues } = require('./fetchIssues')
+const { fetchIssues } = require('../fetchIssues')
 
 const mockIssue = {
   url: 'https://api.github.com/repos/fastify/help/issues/478',
@@ -107,8 +107,14 @@ tap.test('tests the "/api/find-issues" route', async t => {
     data: { ...mockIssuesData, items: [mockIssue2] }
   })
 
-  const build = t.mock('./app', {
-    './fetchIssues': {
+  const build = t.mock('../app', {
+    '@dancastillo/cache': () => ({
+      get: () => {
+        return null
+      },
+      set: () => {}
+    }),
+    '../fetchIssues': {
       fetchIssues,
       getGithubClient: () => {
         return {
@@ -185,3 +191,32 @@ tap.test('tests the "/api/find-issues" route', async t => {
   tap.equal(JSON.parse(response2.body).results[0].body, mockIssue.body)
   tap.equal(JSON.parse(response2.body).results[1].body, mockIssue.body)
 })
+
+tap.test('tests the "/api/find-issues" route with cache', async t => {
+  const build = t.mock('../app', {
+    '@dancastillo/cache': () => ({
+      get: () => {
+        return []
+      },
+      set: () => {}
+    }),
+    '../fetchIssues': {
+      fetchIssues,
+      getGithubClient: () => {
+        return {
+          search: { issuesAndPullRequests: () => undefined }
+        }
+      }
+    }
+  })
+  const app = build()
+
+  // test with defaults
+  const response = await app.inject({
+    method: 'GET',
+    url: '/api/find-issues?org=test&includeBody=true&labels=1&labels=2'
+  })
+
+  tap.equal(response.statusCode, 200, 'returns a status code of 200')
+  tap.equal(response.body, JSON.stringify({ results: [] }))
+})