create-epic-graphql-server 0.6.0 → 0.8.0

package/README.md

@@ -89,6 +89,7 @@ also add any additional variables your project needs
 # optional but recommended
 NODE_ENV=development
 PORT={port number}
+SESSION_SECRET=mySecret!
 # optional
 JSON_SERVER_PORT={dev db port, default 3210}
 ```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-epic-graphql-server",
-  "version": "0.6.0",
+  "version": "0.8.0",
   "description": "a configured graphql server",
   "main": "index.js",
   "bin": {
@@ -50,12 +50,14 @@
     "dotenv-cli": "8.0.0",
     "dotenv-flow": "4.1.0",
     "express": "5.1.0",
+    "express-session": "1.18.2",
     "graphql": "16.11.0",
     "graphql-http": "1.22.4",
     "helmet": "8.1.0",
     "husky": "9.1.7",
     "json-server": "1.0.0-beta.3",
-    "ruru": "2.0.0-beta.22",
+    "memorystore": "1.6.7",
+    "ruru": "2.0.0-beta.30",
     "winston": "3.17.0",
     "winston-daily-rotate-file": "5.0.0",
     "yargs": "17.7.2",
@@ -66,6 +68,7 @@
     "@types/chalk": "0.4.31",
     "@types/dotenv-flow": "3.3.3",
     "@types/express": "5.0.2",
+    "@types/express-session": "1.18.2",
     "@types/mocha": "10.0.10",
     "@types/node": "22.15.18",
     "@types/sinon": "17.0.4",
@@ -75,7 +78,6 @@
     "chai": "4.3.10",
     "eslint": "8.57.1",
     "mocha": "11.7.2",
-    "npm": "11.6.0",
     "sinon": "21.0.0",
     "supertest": "7.1.1",
     "ts-node": "10.9.2",

package/specs/schema.spec.ts

@@ -4,26 +4,23 @@ const sinon = require('sinon')
 const express = require('express')
 const { createHandler } = require('graphql-http/lib/use/express')
 const { schema } = require('../src/schema/schema')
-const db = require('../src/config/db')
-import type { SinonStub } from 'sinon' 
-
-const app = express()
-app.use('/graphql', createHandler({ schema }))
+import type { SinonStub } from 'sinon'
 
 describe('GraphQL Schema', () => {
   let saveStub: SinonStub
   let findStub: SinonStub
+  let app
 
   beforeEach(() => {
-    // Stub db methods
-    saveStub = sinon.stub(db.customers, 'save').resolves({
+    // create fresh stubs for each test
+    saveStub = sinon.stub().resolves({
       id: '1',
       name: 'Alice',
       email: 'alice@example.com',
       phone: '123-456',
     })
 
-    findStub = sinon.stub(db.customers, 'find').resolves([
+    findStub = sinon.stub().resolves([
       {
         id: '1',
         name: 'Alice',
@@ -31,6 +28,23 @@ describe('GraphQL Schema', () => {
         phone: '123-456',
       },
     ])
+
+    // build express app, inject stubbed db into context
+    app = express()
+    app.use(
+      '/graphql',
+      createHandler({
+        schema,
+        context: () => ({
+          db: {
+            customers: {
+              save: saveStub,
+              find: findStub,
+            },
+          },
+        }),
+      })
+    )
   })
 
   afterEach(() => {
@@ -64,6 +78,8 @@ describe('GraphQL Schema', () => {
       email: 'alice@example.com',
       phone: '123-456',
     })
+
+    expect(findStub.calledOnce).to.be.true
   })
 
   it('adds a customer', async () => {

package/src/index.ts

@@ -1,4 +1,6 @@
 const express = require('express')
+const session = require('express-session')
+const MemoryStore = require('memorystore')(session)
 const graphqlRouter = express.Router()
 const cors = require('cors')
 const helmet = require('helmet')
@@ -6,20 +8,44 @@ const chalk = require('chalk')
 const { createHandler } = require('graphql-http/lib/use/express')
 const { ruruHTML } = require('ruru/server')
 const routes = require('./routes')
+const db = require('./config/db')
 const { schema } = require('./schema/schema')
 const logger = require('./utilities/logger')
+const { getUserFromReq } = require('./utilities/getUserFromReq')
 import type { Application, Request, Response } from 'express'
 import { NodeEnv } from './typing/enums'
+import type { User } from './typing/interfaces'
 
 require('dotenv-flow').config()
 
+export interface Context {
+  user: User,
+  db: typeof db,
+}
+
 const { production, development } = NodeEnv
 
 const PORT = process.env.PORT || 3000
 const NODE_ENV = process.env.NODE_ENV || development
+const SESSION_SECRET = process.env.SESSION_SECRET || 'secret'
 
 const app: Application = express()
 
+app.use(session({
+  cookie: {
+    maxAge: 24*60*60*1000,  // 24 hrs
+  },
+  // it's recommended that compatible, robust npm modules be 
+  // explored before choosing a production app's memory store:
+  // https://www.npmjs.com/package/express-session#compatible-session-stores
+  store: new MemoryStore({
+    checkPeriod: 24*60*60*1000,
+  }),
+  resave: false,
+  secret: SESSION_SECRET,
+  saveUninitialized: false,
+}))
+
 app.use(cors())
 
 if (NODE_ENV === production) {
@@ -37,6 +63,14 @@ app.use(routes)
 graphqlRouter.all('/',
   createHandler({
     schema,
+    context: (req: Request): Context => {
+      const user = getUserFromReq({ req })
+
+      return {
+        user,
+        db,
+      }
+    },
   })
 )
 

package/src/schema/schema.ts

@@ -7,8 +7,10 @@ const {
   GraphQLList,
   GraphQLNonNull,
   GraphQLEnumType,
+  // GraphQLResolveInfo,
+  // SelectionSetNode,
 } = require('graphql')
-const db = require('../config/db')
+import type { Context } from '../index'
 import type { Customer } from '../models/Customer'
 import type { Order } from '../models/Order'
 import { Product, Status } from '../typing/enums'
@@ -35,7 +37,7 @@ const orderType = new GraphQLObjectType({
     // NOTE creates relationship with other type
     customer: {
       type: customerType,
-      resolve(parent: Order, args: Customer) {
+      resolve(parent: Order, args: Customer, { db }: Context) {
         return db.customers.findById(parent.customerId)
       },
     },
@@ -68,7 +70,7 @@ const queryType = new GraphQLObjectType({
       args: {
         filter: { type: orderFilterInput },
       },
-      resolve(parent: unknown, { filter }: { filter: Order }) {
+      resolve(parent: unknown, { filter }: { filter: Order }, { db }: Context) {
         return db.orders.find({ filter })
       },
       // NOTE:
@@ -79,13 +81,31 @@ const queryType = new GraphQLObjectType({
       // the example resolver implementation shown below 
       // may avoid over fetching from a database or API
       //
-      // resolve(parent, { filter }, context, info) {
-      //   const fields = info
+      // resolve(
+      //   parent: unknown,
+      //   { filter }: { filter: Order },
+      //   { db }: Context,
+      //   info: typeof GraphQLResolveInfo
+      // ) {
+      //
+      //   const selections = info
       //     .fieldNodes[0]
       //     .selectionSet
-      //     .selections
-      //     .map(s => s.name.value)
+      //     ?.selections || []
+      //
+      //   const fields = selections.reduce((
+      //     acc: Record<string, number>,
+      //     selection: typeof SelectionSetNode
+      //   ) => {
+      //     if (selection.kind === 'Field') {
+      //       acc[selection.name.value] = 1
+      //     }
+      //
+      //     return acc
+      //   }, {})
       //
+      //   // filter = query criteria (docs, rows, etc.)
+      //   // fields = projection (fields, columns, etc.)
       //   return db.orders.find(filter, fields)
       // },
     },
@@ -94,7 +114,7 @@ const queryType = new GraphQLObjectType({
       args: {
         id: { type: new GraphQLNonNull(GraphQLID) },
       },
-      resolve: (parent: unknown, { id }: Order) => {
+      resolve: (parent: unknown, { id }: Order, { db }: Context) => {
         return db.orders.findById(id)
       },
     },
@@ -103,7 +123,7 @@ const queryType = new GraphQLObjectType({
       args: {
         filter: { type: customerFilterInput },
       },
-      resolve(parent: unknown, { filter }: { filter: Customer }) {
+      resolve(parent: unknown, { filter }: { filter: Customer }, { db }: Context) {
         return db.customers.find({ filter })
       },
     },
@@ -112,7 +132,7 @@ const queryType = new GraphQLObjectType({
       args: {
         id: { type: new GraphQLNonNull(GraphQLID) },
       },
-      resolve: (parent: unknown, { id }: Customer) => {
+      resolve: (parent: unknown, { id }: Customer, { db }: Context) => {
         return db.customers.findById(id)
       },
     },
@@ -130,7 +150,7 @@ const mutation = new GraphQLObjectType({
         email: { type: new GraphQLNonNull(GraphQLString) },
         phone: { type: new GraphQLNonNull(GraphQLString) },
       },
-      resolve(parent: unknown, args: Customer) {
+      resolve(parent: unknown, args: Customer, { db }: Context) {
         return db.customers.save(args)
       },
     },
@@ -140,7 +160,7 @@ const mutation = new GraphQLObjectType({
       args: {
         id: { type: new GraphQLNonNull(GraphQLID) },
       },
-      async resolve(parent: unknown, args: Customer) {
+      async resolve(parent: unknown, args: Customer, { db }: Context) {
         const orders = await db.orders.find({
           filter: { customerId: args.id },
         })
@@ -181,7 +201,7 @@ const mutation = new GraphQLObjectType({
         },
         customerId: { type: new GraphQLNonNull(GraphQLID) },
       },
-      resolve(parent: unknown, args: Order) {
+      resolve(parent: unknown, args: Order, { db }: Context) {
         return db.orders.save(args)
       },
     },
@@ -203,7 +223,7 @@ const mutation = new GraphQLObjectType({
           }),
         },
       },
-      resolve(parent: unknown, { id, ...update }: Order) {
+      resolve(parent: unknown, { id, ...update }: Order, { db }: Context) {
         return db.orders.findByIdAndUpdate(id, { update })
       },
     },
@@ -213,7 +233,7 @@ const mutation = new GraphQLObjectType({
       args: {
         id: { type: new GraphQLNonNull(GraphQLID) },
       },
-      resolve(parent: unknown, { id }: Order) {
+      resolve(parent: unknown, { id }: Order, { db }: Context) {
         return db.orders.findByIdAndRemove(id)
       },
     },

package/src/typing/interfaces.ts

@@ -42,3 +42,8 @@ export interface LogErr extends ErrorHandler {
   meta?: object,
   level?: enums.LogLevel.warn | enums.LogLevel.error,
 }
+
+export interface User {
+  id: string,
+  roles: string[],
+}

package/src/utilities/getUserFromReq.ts

@@ -0,0 +1,38 @@
+import type { Request } from 'express'
+import type { User } from 'typing/interfaces'
+
+// NOTE this is a DUMMY pattern to demo how 
+// one might pass request info into GraphQL 
+// via a callback like "getUserFromReq"
+
+const setDummySession = ({
+  req,
+}:{
+  req: Request,
+}) => {
+  // in a production app user info might 
+  // be set upstream via a security model
+
+  const { session } = req
+
+  return {
+    ...session,
+    user: {
+      id: 'user123',
+      roles: ['readWrite'],
+    },
+  }
+}
+
+export const getUserFromReq = ({
+  req,
+}:{
+  req: Request,
+}): User => {
+  const session = setDummySession({ req })
+
+  return {
+    id: session.user.id,
+    roles: session.user.roles,
+  }
+}

package/tsconfig.json

@@ -23,7 +23,8 @@
       "@types/mocha",
       "@types/node",
       "@types/sinon",
-      "@types/supertest"
+      "@types/supertest",
+      "@types/express-session"
     ],
   },
   "include": [