Begin rewrite from GraphQL to REST based API

Special thanks to @javieraviles for the node-typescript-koa-rest boilerplate

https://github.com/javieraviles/node-typescript-koa-rest

Author: mitchdowney

.example.env

@@ -0,0 +1,4 @@
+PORT=3000
+NODE_ENV=development
+JWT_SECRET=your-secret-whatever
+DATABASE__URL=postgres://postgres:mysecretpw@localhost:5432/postgres

.gitignore

@@ -1,63 +1,22 @@
 /src/config/google/jwt.keys.json
 
-# Logs
-logs
-*.log
-npm-debug.log*
-yarn-debug.log*
-yarn-error.log*
-
-# Runtime data
-pids
-*.pid
-*.seed
-*.pid.lock
-
-# Directory for instrumented libs generated by jscoverage/JSCover
-lib-cov
-
-# Coverage directory used by tools like istanbul
-coverage
-
-# nyc test coverage
-.nyc_output
-
-# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
-.grunt
+# API keys and secrets
+.env
 
-# Bower dependency directory (https://bower.io/)
+# Dependency directory
+node_modules
 bower_components
 
-# node-waf configuration
-.lock-wscript
-
-# Compiled binary addons (https://nodejs.org/api/addons.html)
-build/Release
+# Editors
+.idea
+*.iml
 
-# Dependency directories
-node_modules/
-jspm_packages/
+# OS metadata
+.DS_Store
+Thumbs.db
 
-# TypeScript v1 declaration files
-typings/
-
-# Optional npm cache directory
-.npm
-
-# Optional eslint cache
-.eslintcache
-
-# Optional REPL history
-.node_repl_history
-
-# Output of 'npm pack'
-*.tgz
-
-# Yarn Integrity file
-.yarn-integrity
-
-# dotenv environment variables file
-.env
+# Ignore built ts files
+dist/**/*
 
-# next.js build output
-.next
+# Logging files
+*.log

.travis.yml

@@ -0,0 +1,8 @@
+{
+  "language": "node_js",
+  "node_js": "8",
+  "script": [
+    "npm run build",
+    "npm run test"
+  ]
+}

nodemon.json

@@ -1,36 +1,65 @@
 {
+  "name": "podverse-api",
+  "version": "1.0.0",
+  "description": "Data API, database migration scripts, and backend services for all Podverse models.",
+  "main": "dist/server.js",
   "scripts": {
     "addAllFeedsToQueue": "ts-node -r tsconfig-paths/register ./src/scripts/queue/addAllFeedsToQueue.ts",
     "parseFeed": "ts-node -r tsconfig-paths/register ./src/scripts/parser/parseFeed.ts",
     "parseAllFeedsFromQueue": "ts-node -r tsconfig-paths/register ./src/scripts/parser/parseAllFeedsFromQueue.ts",
     "queryUniquePageviews": "ts-node -r tsconfig-paths/register ./src/scripts/stats/queryUniquePageviews.ts",
     "receiveNextFeedFromQueue": "ts-node -r tsconfig-paths/register ./src/scripts/queue/receiveNextFeedFromQueue.ts",
-    "start": "nodemon"
+    "watch-server": "nodemon --watch 'src/**/*' -e ts,tsx --exec ts-node -r tsconfig-paths/register src/server.ts"
   },
-  "dependencies": {
+  "license": "AGPLv3",
+  "homepage": "https://github.com/podverse/podverse-api#readme",
+  "keywords": [
+    "podcast",
+    "episode",
+    "RSS",
+    "Atom",
+    "feed",
+    "parser",
+    "feedparser",
+    "database",
+    "db",
+    "sequelize",
+    "podverse"
+  ],
+  "devDependencies": {
+    "@types/dotenv": "^4.0.3",
     "@types/google.analytics": "^0.0.39",
+    "@types/koa": "^2.0.46",
+    "@types/koa-bodyparser": "^5.0.1",
+    "@types/koa-helmet": "^3.1.2",
+    "@types/koa-jwt": "^3.3.0",
+    "@types/koa-router": "^7.0.31",
+    "@types/koa__cors": "^2.2.3",
     "@types/node": "^10.9.4",
-    "apollo-errors": "^1.9.0",
-    "apollo-server-koa": "^2.0.5",
-    "aws-sdk": "^2.311.0",
+    "@types/shelljs": "^0.8.0",
+    "nodemon": "^1.18.4",
+    "ts-node": "^7.0.1",
+    "tslint": "^5.11.0",
+    "tslint-config-standard": "^8.0.1",
+    "typescript": "^3.0.3"
+  },
+  "dependencies": {
+    "@koa/cors": "^2.2.2",
+    "aws-sdk": "^2.315.0",
     "class-validator": "^0.9.1",
     "googleapis": "^33.0.0",
-    "graphql": "^14.0.0",
-    "koa": "^2.5.2",
+    "koa": "^2.5.3",
     "koa-bodyparser": "^4.2.1",
+    "koa-helmet": "^4.0.0",
+    "koa-jwt": "^3.5.1",
     "koa-router": "^7.4.0",
-    "merge-graphql-schemas": "^1.5.3",
     "node-podcast-parser": "^2.3.0",
-    "nodemon": "^1.18.4",
     "pg": "^7.4.3",
-    "reflect-metadata": "^0.1.12",
+    "pg-connection-string": "^2.0.0",
     "request": "^2.88.0",
     "shortid": "^2.2.13",
-    "ts-node": "^7.0.1",
-    "tsconfig-paths": "^3.5.0",
-    "tslint": "^5.11.0",
-    "tslint-config-standard": "^8.0.1",
+    "tsconfig-paths": "^3.6.0",
     "typeorm": "^0.2.7",
-    "typescript": "^3.0.3"
+    "winston": "^3.1.0"
   }
 }

package.json

@@ -1,31 +1,35 @@
-import { ConnectionOptions } from 'typeorm'
+import * as dotenv from 'dotenv'
 
-const env = process.env
+dotenv.config({ path: '.env' })
 
-export const awsConfig = {
-  queueUrls: {
-    feedsToParse: env.AWS_QUEUE_FEED_PARSER_URL,
-    feedsToParseErrors: env.AWS_QUEUE_FEED_PARSER_ERRORS_URL
-  },
-  region: env.AWS_REGION
+interface EntityRelationships {
+  mediaRef: {
+    mustHavePodcast: boolean
+    mustHaveUser: boolean
+  }
 }
 
-export const dbConfig = {
-  database: 'postgres',
-  host: env.DB_HOST || '0.0.0.0',
-  log: {
-    query: env.DB_LOG_QUERIES || true
-  },
-  password: env.DB_PASSWORD || 'mysecretpw',
-  port: env.DB_PORT || 5432,
-  synchronize: env.DB_SYNCHRONIZE || true,
-  type: 'postgres',
-  username: env.DB_USERNAME || 'postgres'
-} as ConnectionOptions
+export interface IConfig {
+  port: number
+  debugLogging: boolean
+  dbsslconn: boolean
+  jwtSecret: string
+  databaseUrl: string
+  entityRelationships: EntityRelationships
+}
 
-export const entityRelationships = {
-  mediaRef: {
-    mustHavePodcast: env.MEDIA_REF_HAS_PODCAST || false,
-    mustHaveUser: env.MEDIA_REF_HAS_USER || false
+const config: IConfig = {
+  port: +process.env.PORT || 3000,
+  debugLogging: process.env.NODE_ENV === 'development',
+  dbsslconn: process.env.NODE_ENV !== 'development',
+  jwtSecret: process.env.JWT_SECRET || 'your-secret-whatever',
+  databaseUrl: process.env.DATABASE_URL || 'postgres://postgres:mysecretpw@localhost:5432/postgres',
+  entityRelationships: {
+    mediaRef: {
+      mustHavePodcast: process.env.MEDIA_REF_HAS_PODCAST === 'true',
+      mustHaveUser: process.env.MEDIA_REF_HAS_USER === 'true'
+    }
   }
 }
+
+export { config }

src/config/index.ts

@@ -0,0 +1,9 @@
+import { BaseContext } from 'koa'
+
+export default class GeneralController {
+
+  public static async helloWorld (ctx: BaseContext) {
+    ctx.body = 'Hellloooo world!'
+  }
+
+}

src/controller/general.ts

@@ -0,0 +1 @@
+export { default as general } from './general'

src/controller/index.ts

@@ -4,7 +4,8 @@ import { BeforeInsert, Column, CreateDateColumn, Entity, JoinColumn,
   BeforeUpdate } from 'typeorm'
 import { Author, Category, Episode, Playlist, Podcast, User } from 'entities'
 
-import { entityRelationships } from 'config'
+import { config } from 'config'
+const { entityRelationships } = config
 const { mustHavePodcast, mustHaveUser } = entityRelationships.mediaRef
 
 const shortid = require('shortid')

src/entities/mediaRef.ts

@@ -1,5 +1,6 @@
+import * as PostgressConnectionStringParser from 'pg-connection-string'
 import { createConnection, ConnectionOptions } from 'typeorm'
-import { dbConfig } from 'config'
+import { config } from 'config'
 import { Author, Category, Episode, FeedUrl, MediaRef, Playlist,
   Podcast, User } from 'entities'
 import seedDatabase from 'initializers/seedDatabase'
@@ -17,13 +18,29 @@ export const databaseInitializer = async () => {
     User
   ]
 
+  const connectionOptions = PostgressConnectionStringParser.parse(config.databaseUrl)
+
   const options: ConnectionOptions = {
-    ...dbConfig,
-    entities
+    type: 'postgres',
+    host: connectionOptions.host,
+    port: connectionOptions.port,
+    username: connectionOptions.user,
+    password: connectionOptions.password,
+    database: connectionOptions.database,
+    synchronize: true,
+    logging: false,
+    entities,
+    extra: {
+      ssl: config.dbsslconn // if not development, will use SSL
+    }
   }
 
-  let connection = await createConnection(options)
+  const connection = await createConnection(options)
+    .then(connection => connection)
+    .catch(error => console.log('TypeORM connection error: ', error))
 
-  // await seedDatabase(connection)
+  if (connection) {
+    await seedDatabase(connection)
+  }
 
 }

src/graphql/resolvers/author.ts

@@ -1,9 +1,10 @@
-import { validCategories } from 'config'
+import { Connection } from 'typeorm'
+import { validCategories } from 'config/categories'
 import { Author, Category, Episode, FeedUrl, MediaRef, Playlist,
   Podcast, User } from 'entities'
 import { parseFeed } from 'services/parser'
 
-export default async connection => {
+export default async (connection: Connection) => {
   await connection.synchronize(true)
 
   let podcast1 = new Podcast()
@@ -136,8 +137,13 @@ export default async connection => {
   await parseFeeds()
 }
 
-const generateCategories = async (connection, data, parent, shouldSave) => {
-  let newCategories = []
+const generateCategories = async (
+  connection: Connection,
+  data: any,
+  parent: any,
+  shouldSave: boolean
+): Promise<any> => {
+  let newCategories: any[] = []
   for (let category of data) {
     category.parent = parent
     let c = generateCategory(category)
@@ -153,12 +159,12 @@ const generateCategories = async (connection, data, parent, shouldSave) => {
 
   if (shouldSave) {
     await connection.manager.save(newCategories)
-  } else {
-    return newCategories
   }
+
+  return newCategories
 }
 
-const generateCategory = data => {
+const generateCategory = (data: any) => {
   let category = new Category()
   category.title = data.title
   category.category = data.parent

src/graphql/resolvers/category.ts

@@ -0,0 +1,42 @@
+import * as Koa from 'koa'
+import * as winston from 'winston'
+import { config } from './config'
+
+// TODO: does this have to be type "any"?
+export function logger (winstonInstance: any) {
+
+  return async (ctx: Koa.Context, next: () => Promise<any>) => {
+    const start = new Date().getMilliseconds()
+
+    await next()
+
+    const ms = new Date().getMilliseconds() - start
+
+    let logLevel: string
+    if (ctx.status >= 500) {
+      logLevel = 'error'
+    }
+    if (ctx.status >= 400) {
+      logLevel = 'warn'
+    }
+    if (ctx.status >= 100) {
+      logLevel = 'info'
+    }
+
+    const msg: string = `${ctx.method} ${ctx.originalUrl} ${ctx.status} ${ms}ms`
+
+    winstonInstance.configure({
+      level: config.debugLogging ? 'debug' : 'info',
+      transports: [
+        new winston.transports.File({ filename: 'error.log', level: 'error' }),
+        new winston.transports.Console({ format: winston.format.combine(
+          winston.format.colorize(),
+          winston.format.simple()
+        )})
+      ]
+    })
+
+    winstonInstance.log(logLevel, msg)
+  }
+
+}

src/graphql/resolvers/episode.ts

@@ -0,0 +1,8 @@
+import * as Router from 'koa-router'
+const controller = require('./controller')
+
+const router = new Router()
+
+router.get('/', controller.general.helloWorld)
+
+export { router }

src/graphql/resolvers/feedUrl.ts

@@ -1,19 +1,32 @@
-import { ApolloServer } from 'apollo-server-koa'
+import * as cors from '@koa/cors'
+import * as dotenv from 'dotenv'
 import * as Koa from 'koa'
-import resolvers from 'graphql/resolvers'
-import typeDefs from 'graphql/types'
+import * as bodyParser from 'koa-bodyparser'
+import * as helmet from 'koa-helmet'
+import * as jwt from 'koa-jwt'
+import * as winston from 'winston'
+
+import { config } from 'config'
+import { logger } from 'logging'
+import { router } from 'routes'
 import { databaseInitializer } from 'initializers/database'
 
 const bootstrap = async () => {
+  dotenv.config({ path: './env' })
+
   await databaseInitializer()
 
-  const server = new ApolloServer({ typeDefs, resolvers })
   const app = new Koa()
-  server.applyMiddleware({ app })
 
-  app.listen({ port: 2001 }, () => {
-    console.log(`🚀 Server ready at http://localhost:2001${server.graphqlPath}`)
-  })
+  app.use(helmet())
+  app.use(cors())
+  app.use(logger(winston))
+  app.use(bodyParser())
+  // app.use(jwt({ secret: config.jwtSecret }))
+  app.use(router.routes()).use(router.allowedMethods())
+  app.listen(config.port)
+
+  console.log(`Server running on port ${config.port}`)
 }
 
 bootstrap()

src/graphql/resolvers/index.ts

@@ -1,19 +1,62 @@
 {
     "compileOnSave": false,
     "compilerOptions": {
-        "noImplicitAny": false,
-        "emitDecoratorMetadata": true,
-        "experimentalDecorators": true,
-        "moduleResolution": "node",
+        /* Basic Options */
+        "target": "ES2017", /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017','ES2018' or 'ESNEXT'. */
+        // "module": "commonjs", /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */
         "lib": [
             "es2017"
-        ],
+        ], /* Specify library files to be included in the compilation. */
+        // "allowJs": true,                       /* Allow javascript files to be compiled. */
+        // "checkJs": true,                       /* Report errors in .js files. */
+        // "jsx": "preserve",                     /* Specify JSX code generation: 'preserve', 'react-native', or 'react'. */
+        // "declaration": true,                   /* Generates corresponding '.d.ts' file. */
+        "sourceMap": true, /* Generates corresponding '.map' file. */
+        // "outFile": "./",                       /* Concatenate and emit output to single file. */
+        "outDir": "dist", /* Redirect output structure to the directory. */
+        // "rootDir": "./",                       /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
+        // "removeComments": true,                /* Do not emit comments to output. */
+        // "noEmit": true,                        /* Do not emit outputs. */
+        // "importHelpers": true,                 /* Import emit helpers from 'tslib'. */
+        // "downlevelIteration": true,            /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */
+        // "isolatedModules": true,               /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */
+        /* Strict Type-Checking Options */
+        // "strict": true,                        /* Enable all strict type-checking options. */
+        "noImplicitAny": true,                 /* Raise error on expressions and declarations with an implied 'any' type. */
+        // "strictNullChecks": true,              /* Enable strict null checks. */
+        // "strictFunctionTypes": true,           /* Enable strict checking of function types. */
+        // "strictPropertyInitialization": true,  /* Enable strict checking of property initialization in classes. */
+        // "noImplicitThis": true,                /* Raise error on 'this' expressions with an implied 'any' type. */
+        // "alwaysStrict": true,                  /* Parse in strict mode and emit "use strict" for each source file. */
+        /* Additional Checks */
+        // "noUnusedLocals": true,                /* Report errors on unused locals. */
+        // "noUnusedParameters": true,            /* Report errors on unused parameters. */
+        // "noImplicitReturns": true,             /* Report error when not all code paths in function return a value. */
+        // "noFallthroughCasesInSwitch": true,    /* Report errors for fallthrough cases in switch statement. */
+        /* Module Resolution Options */
+        "moduleResolution": "node", /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */
+        "baseUrl": "./src", /* Base directory to resolve non-absolute module names. */
+        // "paths": {},                           /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */           
+        // "rootDirs": [],                        /* List of root folders whose combined content represents the structure of the project at runtime. */
+        // "typeRoots": [],                       /* List of folders to include type definitions from. */
         "types": [
             "node"
-        ],
-        "sourceMap": true,
-        "baseUrl": "./src"
+        ],                           /* Type declaration files to be included in compilation. */
+        // "allowSyntheticDefaultImports": true,  /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
+        // "esModuleInterop": true,               /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */
+        // "preserveSymlinks": true,              /* Do not resolve the real path of symlinks. */
+        /* Source Map Options */
+        // "sourceRoot": "./",                    /* Specify the location where debugger should locate TypeScript files instead of source locations. */
+        // "mapRoot": "./",                       /* Specify the location where debugger should locate map files instead of generated locations. */
+        // "inlineSourceMap": true,               /* Emit a single file with source maps instead of having a separate file. */
+        // "inlineSources": true,                 /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */
+        /* Experimental Options */
+        "experimentalDecorators": true, /* Enables experimental support for ES7 decorators. */
+        "emitDecoratorMetadata": true, /* Enables experimental support for emitting type metadata for decorators. */
     },
+    "include": [
+        "src/**/*"
+    ],
     "exclude": [
         "node_modules",
         "**/*.spec.ts"