feat: GET /views

Author: soedirgo

src/lib/PostgresMeta.ts

@@ -12,6 +12,7 @@ import PostgresMetaTables from './PostgresMetaTables'
 import PostgresMetaTriggers from './PostgresMetaTriggers'
 import PostgresMetaTypes from './PostgresMetaTypes'
 import PostgresMetaVersion from './PostgresMetaVersion'
+import PostgresMetaViews from './PostgresMetaViews'
 import { init } from './db'
 import { PostgresMetaResult } from './types'
 export default class PostgresMeta {
@@ -29,6 +30,7 @@ export default class PostgresMeta {
   triggers: PostgresMetaTriggers
   types: PostgresMetaTypes
   version: PostgresMetaVersion
+  views: PostgresMetaViews
 
   parse = Parser.Parse
   deparse = Parser.Deparse
@@ -50,5 +52,6 @@ export default class PostgresMeta {
     this.triggers = new PostgresMetaTriggers(this.query)
     this.types = new PostgresMetaTypes(this.query)
     this.version = new PostgresMetaVersion(this.query)
+    this.views = new PostgresMetaViews(this.query)
   }
 }

src/lib/PostgresMetaViews.ts

@@ -0,0 +1,34 @@
+import { literal } from 'pg-format'
+import { DEFAULT_SYSTEM_SCHEMAS } from './constants'
+import { viewsSql } from './sql'
+import { PostgresMetaResult, PostgresView } from './types'
+
+export default class PostgresMetaViews {
+  query: (sql: string) => Promise<PostgresMetaResult<any>>
+
+  constructor(query: (sql: string) => Promise<PostgresMetaResult<any>>) {
+    this.query = query
+  }
+
+  async list({
+    includeSystemSchemas = false,
+    limit,
+    offset,
+  }: {
+    includeSystemSchemas?: boolean
+    limit?: number
+    offset?: number
+  } = {}): Promise<PostgresMetaResult<PostgresView[]>> {
+    let sql = viewsSql
+    if (!includeSystemSchemas) {
+      sql = `${sql} AND n.nspname NOT IN (${DEFAULT_SYSTEM_SCHEMAS.map(literal).join(',')})`
+    }
+    if (limit) {
+      sql = `${sql} LIMIT ${limit}`
+    }
+    if (offset) {
+      sql = `${sql} OFFSET ${offset}`
+    }
+    return await this.query(sql)
+  }
+}

src/lib/sql/index.ts

@@ -16,3 +16,4 @@ export const tablesSql = readFileSync(resolve(__dirname, 'tables.sql'), 'utf-8')
 export const triggersSql = readFileSync(resolve(__dirname, 'triggers.sql'), 'utf-8')
 export const typesSql = readFileSync(resolve(__dirname, 'types.sql'), 'utf-8')
 export const versionSql = readFileSync(resolve(__dirname, 'version.sql'), 'utf-8')
+export const viewsSql = readFileSync(resolve(__dirname, 'views.sql'), 'utf-8')

src/lib/sql/views.sql

@@ -0,0 +1,10 @@
+SELECT
+  c.oid :: int8 AS id,
+  n.nspname AS schema,
+  c.relname AS name,
+  obj_description(c.oid) AS comment
+FROM
+  pg_class c
+  JOIN pg_namespace n ON n.oid = c.relnamespace
+WHERE
+  c.relkind = 'v'

src/lib/types.ts

@@ -297,3 +297,11 @@ export const postgresVersionSchema = Type.Object({
   max_connections: Type.Integer(),
 })
 export type PostgresVersion = Static<typeof postgresVersionSchema>
+
+export const postgresViewSchema = Type.Object({
+  id: Type.Integer(),
+  schema: Type.String(),
+  name: Type.String(),
+  comment: Type.Union([Type.String(), Type.Null()]),
+})
+export type PostgresView = Static<typeof postgresViewSchema>

src/server/routes/index.ts

@@ -17,16 +17,17 @@ export default async (fastify: FastifyInstance) => {
     done()
   })
 
-  fastify.register(require('./config'), { prefix: '/config' })
   fastify.register(require('./columns'), { prefix: '/columns' })
+  fastify.register(require('./config'), { prefix: '/config' })
   fastify.register(require('./extensions'), { prefix: '/extensions' })
   fastify.register(require('./functions'), { prefix: '/functions' })
   fastify.register(require('./policies'), { prefix: '/policies' })
   fastify.register(require('./publications'), { prefix: '/publications' })
   fastify.register(require('./query'), { prefix: '/query' })
   fastify.register(require('./schemas'), { prefix: '/schemas' })
+  fastify.register(require('./roles'), { prefix: '/roles' })
   fastify.register(require('./tables'), { prefix: '/tables' })
   fastify.register(require('./triggers'), { prefix: '/triggers' })
   fastify.register(require('./types'), { prefix: '/types' })
-  fastify.register(require('./roles'), { prefix: '/roles' })
+  fastify.register(require('./views'), { prefix: '/views' })
 }

src/server/routes/views.ts

@@ -0,0 +1,31 @@
+import { FastifyInstance } from 'fastify'
+import { PostgresMeta } from '../../lib'
+import { DEFAULT_POOL_CONFIG } from '../constants'
+import { extractRequestForLogging } from '../utils'
+
+export default async (fastify: FastifyInstance) => {
+  fastify.get<{
+    Headers: { pg: string }
+    Querystring: {
+      include_system_schemas?: string
+      limit?: number
+      offset?: number
+    }
+  }>('/', async (request, reply) => {
+    const connectionString = request.headers.pg
+    const includeSystemSchemas = request.query.include_system_schemas === 'true'
+    const limit = request.query.limit
+    const offset = request.query.offset
+
+    const pgMeta = new PostgresMeta({ ...DEFAULT_POOL_CONFIG, connectionString })
+    const { data, error } = await pgMeta.views.list({ includeSystemSchemas, limit, offset })
+    await pgMeta.end()
+    if (error) {
+      request.log.error({ error, request: extractRequestForLogging(request) })
+      reply.code(500)
+      return { error: error.message }
+    }
+
+    return data
+  })
+}

test/db/00-init.sql

@@ -49,3 +49,5 @@ begin
     return new;
 end;
 $$ language plpgsql;
+
+CREATE VIEW todos_view AS SELECT * FROM public.todos;

test/lib/index.test.ts

@@ -13,3 +13,4 @@ import './roles'
 import './policies'
 import './publications'
 import './triggers'
+import './views'

test/lib/roles.ts

@@ -209,6 +209,69 @@ test('list', async () => {
           "table_name": "users_audit",
           "with_hierarchy": false,
         },
+        Object {
+          "grantee": "postgres",
+          "grantor": "postgres",
+          "is_grantable": true,
+          "privilege_type": "INSERT",
+          "schema": "public",
+          "table_name": "todos_view",
+          "with_hierarchy": false,
+        },
+        Object {
+          "grantee": "postgres",
+          "grantor": "postgres",
+          "is_grantable": true,
+          "privilege_type": "SELECT",
+          "schema": "public",
+          "table_name": "todos_view",
+          "with_hierarchy": true,
+        },
+        Object {
+          "grantee": "postgres",
+          "grantor": "postgres",
+          "is_grantable": true,
+          "privilege_type": "UPDATE",
+          "schema": "public",
+          "table_name": "todos_view",
+          "with_hierarchy": false,
+        },
+        Object {
+          "grantee": "postgres",
+          "grantor": "postgres",
+          "is_grantable": true,
+          "privilege_type": "DELETE",
+          "schema": "public",
+          "table_name": "todos_view",
+          "with_hierarchy": false,
+        },
+        Object {
+          "grantee": "postgres",
+          "grantor": "postgres",
+          "is_grantable": true,
+          "privilege_type": "TRUNCATE",
+          "schema": "public",
+          "table_name": "todos_view",
+          "with_hierarchy": false,
+        },
+        Object {
+          "grantee": "postgres",
+          "grantor": "postgres",
+          "is_grantable": true,
+          "privilege_type": "REFERENCES",
+          "schema": "public",
+          "table_name": "todos_view",
+          "with_hierarchy": false,
+        },
+        Object {
+          "grantee": "postgres",
+          "grantor": "postgres",
+          "is_grantable": true,
+          "privilege_type": "TRIGGER",
+          "schema": "public",
+          "table_name": "todos_view",
+          "with_hierarchy": false,
+        },
         Object {
           "grantee": "postgres",
           "grantor": "postgres",