refactor: exclude default roles by default

Author: soedirgo

src/api/roles.ts

@@ -4,13 +4,14 @@ import sql = require('../lib/sql')
 const { grants, roles } = sql
 import { coalesceRowsToArray } from '../lib/helpers'
 import { RunQuery } from '../lib/connectionPool'
-import { DEFAULT_SYSTEM_SCHEMAS } from '../lib/constants/schemas'
+import { DEFAULT_ROLES, DEFAULT_SYSTEM_SCHEMAS } from '../lib/constants'
 import { Roles } from '../lib/interfaces'
 
 /**
  * @param {boolean} [includeSystemSchemas=false] - Return system schemas as well as user schemas
  */
 interface GetRolesQueryParams {
+  includeDefaultRoles?: boolean
   includeSystemSchemas?: boolean
 }
 
@@ -29,6 +30,7 @@ FROM
     const query: GetRolesQueryParams = req.query
     let payload: Roles.Role[] = data
     if (!query?.includeSystemSchemas) payload = removeSystemSchemas(data)
+    if (!query?.includeDefaultRoles) payload = removeDefaultRoles(payload)
 
     return res.status(200).json(payload)
   } catch (error) {
@@ -104,4 +106,8 @@ const removeSystemSchemas = (data: Roles.Role[]) => {
   })
 }
 
+const removeDefaultRoles = (data: Roles.Role[]) => {
+  return data.filter((role) => !DEFAULT_ROLES.includes(role.name))
+}
+
 export = router

src/api/schemas.ts

@@ -3,7 +3,7 @@ import { Router } from 'express'
 import sql = require('../lib/sql')
 const { schemas } = sql
 import { RunQuery } from '../lib/connectionPool'
-import { DEFAULT_SYSTEM_SCHEMAS } from '../lib/constants/schemas'
+import { DEFAULT_SYSTEM_SCHEMAS } from '../lib/constants'
 import { Schemas } from '../lib/interfaces'
 
 /**

src/api/tables.ts

@@ -4,7 +4,7 @@ import sql = require('../lib/sql')
 const { columns, grants, primary_keys, relationships, tables } = sql
 import { coalesceRowsToArray, formatColumns } from '../lib/helpers'
 import { RunQuery } from '../lib/connectionPool'
-import { DEFAULT_SYSTEM_SCHEMAS } from '../lib/constants/schemas'
+import { DEFAULT_SYSTEM_SCHEMAS } from '../lib/constants'
 import { Tables } from '../lib/interfaces'
 
 const router = Router()

src/api/types.ts

@@ -3,7 +3,7 @@ import { Router } from 'express'
 import sql = require('../lib/sql')
 const { types } = sql
 import { RunQuery } from '../lib/connectionPool'
-import { DEFAULT_SYSTEM_SCHEMAS } from '../lib/constants/schemas'
+import { DEFAULT_SYSTEM_SCHEMAS } from '../lib/constants'
 import { Types } from '../lib/interfaces'
 
 const router = Router()

src/lib/constants.ts

@@ -2,3 +2,22 @@ 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'
 export const PG_CONNECTION = 'postgres://postgres:postgres@localhost:5432/postgres'
+
+export const DEFAULT_ROLES: string[] = [
+  'pg_read_all_settings',
+  'pg_read_all_stats',
+  'pg_stat_scan_tables',
+  'pg_monitor',
+  'pg_signal_backend',
+  'pg_read_server_files',
+  'pg_write_server_files',
+  'pg_execute_server_program',
+]
+
+export const DEFAULT_SYSTEM_SCHEMAS: string[] = [
+  'information_schema',
+  'pg_catalog',
+  'pg_toast_temp_1',
+  'pg_temp_1',
+  'pg_toast',
+]