refactor: move server stuff to src/server

soedirgo · soedirgo · commit c5611f5f0bdd · 2021-02-07T17:52:26.000+08:00
diff --git a/src/api/columns.ts b/src/api/columns.ts
@@ -5,7 +5,7 @@ import { RunQuery } from '../lib/connectionPool'
 import sql = require('../lib/sql')
 import { DEFAULT_SYSTEM_SCHEMAS } from '../lib/constants'
 import { Tables } from '../lib/interfaces'
-import { logger } from '../lib/logger'
+import logger from '../server/logger'
 
 /**
  * @param {boolean} [include_system_schemas=false] - Return system schemas as well as user schemas
diff --git a/src/api/config.ts b/src/api/config.ts
@@ -2,7 +2,7 @@ import { Router } from 'express'
 
 import { RunQuery } from '../lib/connectionPool'
 import sql = require('../lib/sql')
-import { logger } from '../lib/logger'
+import logger from '../server/logger'
 const { configSql, versionSql } = sql
 
 const router = Router()
diff --git a/src/api/extensions.ts b/src/api/extensions.ts
@@ -4,7 +4,7 @@ import SQL from 'sql-template-strings'
 import sqlTemplates = require('../lib/sql')
 const { extensionsSql } = sqlTemplates
 import { RunQuery } from '../lib/connectionPool'
-import { logger } from '../lib/logger'
+import logger from '../server/logger'
 
 const router = Router()
 
diff --git a/src/api/functions.ts b/src/api/functions.ts
@@ -5,7 +5,7 @@ const { functionsSql } = sql
 import { RunQuery } from '../lib/connectionPool'
 import { DEFAULT_SYSTEM_SCHEMAS } from '../lib/constants'
 import { Functions } from '../lib/interfaces'
-import { logger } from '../lib/logger'
+import logger from '../server/logger'
 
 /**
  * @param {boolean} [include_system_schemas=false] - Return system schemas as well as user schemas
diff --git a/src/api/policies.ts b/src/api/policies.ts
@@ -5,7 +5,7 @@ import { RunQuery } from '../lib/connectionPool'
 import { DEFAULT_SYSTEM_SCHEMAS } from '../lib/constants'
 import { Tables } from '../lib/interfaces'
 import sqlTemplates = require('../lib/sql')
-import { logger } from '../lib/logger'
+import logger from '../server/logger'
 
 /**
  * @param {string} [include_system_schemas=false] - Return system schemas as well as user schemas
diff --git a/src/api/publications.ts b/src/api/publications.ts
@@ -2,7 +2,7 @@ import { Router } from 'express'
 import { ident, literal } from 'pg-format'
 import sql = require('../lib/sql')
 import { RunQuery } from '../lib/connectionPool'
-import { logger } from '../lib/logger'
+import logger from '../server/logger'
 
 const { publicationsSql } = sql
 const router = Router()
diff --git a/src/api/query.ts b/src/api/query.ts
@@ -1,7 +1,7 @@
 import { Router } from 'express'
 
 import { RunQuery } from '../lib/connectionPool'
-import { logger } from '../lib/logger'
+import logger from '../server/logger'
 
 const router = Router()
 router.post('/', async (req, res) => {
diff --git a/src/api/roles.ts b/src/api/roles.ts
@@ -8,7 +8,7 @@ import { coalesceRowsToArray } from '../lib/helpers'
 import { RunQuery } from '../lib/connectionPool'
 import { DEFAULT_ROLES, DEFAULT_SYSTEM_SCHEMAS } from '../lib/constants'
 import { Roles } from '../lib/interfaces'
-import { logger } from '../lib/logger'
+import logger from '../server/logger'
 
 /**
  * @param {boolean} [include_system_schemas=false] - Return system schemas as well as user schemas
diff --git a/src/api/schemas.ts b/src/api/schemas.ts
@@ -3,7 +3,7 @@ import sqlTemplates = require('../lib/sql')
 import { RunQuery } from '../lib/connectionPool'
 import { DEFAULT_SYSTEM_SCHEMAS } from '../lib/constants'
 import { Schemas as Interfaces } from '../lib/interfaces'
-import { logger } from '../lib/logger'
+import logger from '../server/logger'
 
 const { schemasSql: allSchemasSql } = sqlTemplates
 const defaultSchemasList = DEFAULT_SYSTEM_SCHEMAS.map((x) => `'${x}'`).join(', ')
diff --git a/src/api/tables.ts b/src/api/tables.ts
@@ -4,7 +4,7 @@ import { coalesceRowsToArray, toTransaction } from '../lib/helpers'
 import { RunQuery } from '../lib/connectionPool'
 import { DEFAULT_SYSTEM_SCHEMAS } from '../lib/constants'
 import { Tables } from '../lib/interfaces'
-import { logger } from '../lib/logger'
+import logger from '../server/logger'
 import sqlTemplates = require('../lib/sql')
 
 /**
diff --git a/src/api/types.ts b/src/api/types.ts
@@ -5,7 +5,7 @@ const { typesSql } = sql
 import { RunQuery } from '../lib/connectionPool'
 import { DEFAULT_SYSTEM_SCHEMAS } from '../lib/constants'
 import { Types } from '../lib/interfaces'
-import { logger } from '../lib/logger'
+import logger from '../server/logger'
 
 /**
  * @param {boolean} [include_system_schemas=false] - Return system schemas as well as user schemas
diff --git a/src/lib/connectionMiddleware.ts b/src/lib/connectionMiddleware.ts
@@ -1,11 +1,11 @@
-import CryptoJS = require('crypto-js')
-import { PG_CONNECTION, CRYPTO_KEY } from './constants'
-import { logger } from './logger'
+import CryptoJS from 'crypto-js'
+import { PG_CONNECTION, CRYPTO_KEY } from '../server/constants'
+import logger from '../server/logger'
 
 /**
  * Adds a "pg" object to the request if it doesn't exist
  */
-export const addConnectionToRequest = async (req, res, next) => {
+export const addConnectionToRequest = async (req: any, res: any, next: any) => {
   try {
     req.headers['pg'] = PG_CONNECTION
 
diff --git a/src/lib/constants.ts b/src/lib/constants.ts
@@ -1,30 +1,18 @@
-export const PG_API_URL = process.env.PG_API_URL || 'http://localhost'
-export const PG_API_PORT = Number(process.env.PG_API_PORT || 1337)
-export const CRYPTO_KEY = process.env.CRYPTO_KEY || 'SAMPLE_KEY'
-
-const PG_API_DB_HOST = process.env.PG_API_DB_HOST || 'localhost'
-const PG_API_DB_NAME = process.env.PG_API_DB_NAME || 'postgres'
-const PG_API_DB_USER = process.env.PG_API_DB_USER || 'postgres'
-const PG_API_DB_PORT = Number(process.env.PG_API_DB_PORT) || 5432
-const PG_API_DB_PASSWORD = process.env.PG_API_DB_PASSWORD || 'postgres'
-
-export const PG_CONNECTION = `postgres://${PG_API_DB_USER}:${PG_API_DB_PASSWORD}@${PG_API_DB_HOST}:${PG_API_DB_PORT}/${PG_API_DB_NAME}`
-
-export const DEFAULT_ROLES: string[] = [
+export const DEFAULT_ROLES = [
+  'pg_execute_server_program',
+  'pg_monitor',
   'pg_read_all_settings',
   'pg_read_all_stats',
-  'pg_stat_scan_tables',
-  'pg_monitor',
-  'pg_signal_backend',
   'pg_read_server_files',
+  'pg_signal_backend',
+  'pg_stat_scan_tables',
   'pg_write_server_files',
-  'pg_execute_server_program',
 ]
 
-export const DEFAULT_SYSTEM_SCHEMAS: string[] = [
+export const DEFAULT_SYSTEM_SCHEMAS = [
   'information_schema',
   'pg_catalog',
-  'pg_toast_temp_1',
   'pg_temp_1',
   'pg_toast',
+  'pg_toast_temp_1',
 ]
diff --git a/src/lib/logger.ts b/src/lib/logger.ts
diff --git a/src/server.ts b/src/server.ts
diff --git a/src/server/app.ts b/src/server/app.ts
@@ -0,0 +1,21 @@
+import express from 'express'
+import { PG_API_PORT } from './constants'
+import routes from './routes'
+import pkg from '../../package.json'
+import logger from './logger'
+
+const app = express()
+app.use(express.json())
+app.use(routes)
+app.get('/', (_req, res) =>
+  res.status(200).json({
+    status: 200,
+    name: pkg.name,
+    version: pkg.version,
+    documentation: 'https://supabase.github.io/pg-api/',
+  })
+)
+app.get('/health', (_req, res) => res.status(200).json({ date: new Date() }))
+app.listen(PG_API_PORT, () => {
+  logger.info(`App started on port ${PG_API_PORT}`)
+})
diff --git a/src/server/constants.ts b/src/server/constants.ts
@@ -0,0 +1,10 @@
+export const PG_API_PORT = Number(process.env.PG_API_PORT || 1337)
+export const CRYPTO_KEY = process.env.CRYPTO_KEY || 'SAMPLE_KEY'
+
+const PG_API_DB_HOST = process.env.PG_API_DB_HOST || 'localhost'
+const PG_API_DB_NAME = process.env.PG_API_DB_NAME || 'postgres'
+const PG_API_DB_USER = process.env.PG_API_DB_USER || 'postgres'
+const PG_API_DB_PORT = Number(process.env.PG_API_DB_PORT) || 5432
+const PG_API_DB_PASSWORD = process.env.PG_API_DB_PASSWORD || 'postgres'
+
+export const PG_CONNECTION = `postgres://${PG_API_DB_USER}:${PG_API_DB_PASSWORD}@${PG_API_DB_HOST}:${PG_API_DB_PORT}/${PG_API_DB_NAME}`
diff --git a/src/server/logger.ts b/src/server/logger.ts
@@ -0,0 +1,2 @@
+import { PG_CONNECTION } from './constants'
+export default require('pino')().child({ connectionString: PG_CONNECTION })
diff --git a/src/server/postgresMeta.ts b/src/server/postgresMeta.ts
@@ -0,0 +1,3 @@
+import { PostgresMeta } from '../lib'
+import { PG_CONNECTION } from './constants'
+export const pgMeta = new PostgresMeta({ connectionString: PG_CONNECTION })
diff --git a/src/server/routes/index.ts b/src/server/routes/index.ts
@@ -0,0 +1,37 @@
+import cors from 'cors'
+import CryptoJS from 'crypto-js'
+import { Router } from 'express'
+import { PG_CONNECTION, CRYPTO_KEY } from '../constants'
+import logger from '../logger'
+import oldRoutes from '../../api'
+
+/**
+ * Adds a "pg" object to the request if it doesn't exist
+ */
+const addConnectionToRequest = async (req: any, res: any, next: any) => {
+  try {
+    req.headers['pg'] = PG_CONNECTION
+
+    // Node converts headers to lowercase
+    let encryptedHeader =
+      'x-connection-encrypted' in req.headers ? req.headers['x-connection-encrypted'] : null
+
+    if (encryptedHeader) {
+      req.headers['pg'] = CryptoJS.AES.decrypt(encryptedHeader, CRYPTO_KEY).toString(
+        CryptoJS.enc.Utf8
+      )
+    }
+
+    return next()
+  } catch (error) {
+    logger.error({ error })
+    return res.status(500).json({ error: 'Server error.', status: 500 })
+  }
+}
+
+const router = Router()
+router.use(cors())
+// router.use('/schemas', addConnectionToRequest, require('./schemas'))
+router.use(oldRoutes)
+
+export default router
diff --git a/src/server/routes/schemas.ts b/src/server/routes/schemas.ts
@@ -0,0 +1,124 @@
+import { Router } from 'express'
+import format from 'pg-format'
+import SQL from 'sql-template-strings'
+import sqlTemplates = require('../../lib/sql')
+import { RunQuery } from '../../lib/connectionPool'
+import { Schemas } from '../../lib/interfaces'
+
+import { list, byId, byName } from '../../api/schemas'
+
+const { schemasSql } = sqlTemplates
+
+/**
+ * @param {boolean} [include_system_schemas=false] - Return system schemas as well as user schemas
+ */
+interface QueryParams {
+  include_system_schemas?: string
+}
+
+const router = Router()
+
+router.get('/', async (req: any, res) => {
+  try {
+    let conn: string = req.headers.pg.toString()
+    const query: QueryParams = req.query
+    const include_system_schemas = query?.include_system_schemas === 'true'
+    const { data, error } = await list(conn, { include_system_schemas })
+    if (error) throw error
+    else return res.status(200).json(data)
+  } catch (error) {
+    console.log('throwing error', error)
+    res.status(500).json({ error: 'Database error', status: 500 })
+  }
+})
+
+router.post('/', async (req: any, res) => {
+  try {
+    let conn: string = req.headers.pg.toString()
+    const name: string = req.body.name
+    const owner: string = req.body.owner
+
+    // Create the schema
+    const schemqQuery = createSchema(name, owner)
+    await RunQuery(req.headers.pg, schemqQuery)
+
+    // Return fresh details
+    let { data: schema, error } = await byName(conn, name)
+    if (error) throw error
+    else return res.status(200).json(schema)
+  } catch (error) {
+    console.log('throwing error', error)
+    res.status(500).json({ error: 'Database error', status: 500 })
+  }
+})
+
+router.patch('/:id', async (req: any, res) => {
+  try {
+    let conn: string = req.headers.pg.toString()
+    const id: number = +req.params.id
+    const name: string = req.body.name
+    const owner: string = req.body.owner
+
+    // Get schema name
+    let { data: previousSchema, error } = await byId(conn, id)
+    if (error) throw error
+
+    // Update fields
+    if (owner) {
+      const updateOwner = alterSchemaOwner(previousSchema.name, owner)
+      await RunQuery(req.headers.pg, updateOwner)
+    }
+    // NB: Run name updates last
+    if (name) {
+      const updateName = alterSchemaName(previousSchema.name, name)
+      await RunQuery(req.headers.pg, updateName)
+    }
+
+    // Return fresh details
+    let { data: updated, error: updateError } = await byId(conn, id)
+    if (updateError) throw error
+    return res.status(200).json(updated)
+  } catch (error) {
+    console.log('throwing error', error)
+    res.status(500).json({ error: 'Database error', status: 500 })
+  }
+})
+
+router.delete('/:id', async (req: any, res) => {
+  try {
+    let conn: string = req.headers.pg.toString()
+    const id: number = +req.params.id
+
+    let { data: schema, error } = await byId(conn, id)
+    if (error) throw error
+
+    const cascade = req.query.cascade === 'true'
+    const query = dropSchemaSqlize(schema.name, cascade)
+    await RunQuery(req.headers.pg, query)
+
+    return res.status(200).json(schema)
+  } catch (error) {
+    console.log('throwing error', error)
+    res.status(500).json({ error: 'Database error', status: 500 })
+  }
+})
+
+// Helpers
+const createSchema = (name: string, owner: string = 'postgres') => {
+  const query = SQL``.append(`CREATE SCHEMA IF NOT EXISTS ${name} AUTHORIZATION ${owner}`)
+  return query
+}
+const alterSchemaName = (previousName: string, newName: string) => {
+  const query = SQL``.append(`ALTER SCHEMA ${previousName} RENAME TO ${newName}`)
+  return query
+}
+const alterSchemaOwner = (schemaName: string, newOwner: string) => {
+  const query = SQL``.append(`ALTER SCHEMA ${schemaName} OWNER TO ${newOwner}`)
+  return query
+}
+const dropSchemaSqlize = (name: string, cascade: boolean) => {
+  const query = `DROP SCHEMA ${format.ident(name)} ${cascade ? 'CASCADE' : 'RESTRICT'}`
+  return query
+}
+
+export = router
diff --git a/src/start.ts b/src/start.ts
diff --git a/test/integration/index.spec.js b/test/integration/index.spec.js
