feat(/functions): implements PATCH /functions

Currently only supports changing function name. Working on changing function name, extensions and
schema at once

#115

Author: i-pip

src/lib/PostgresMetaFunctions.ts

@@ -94,6 +94,45 @@ export default class PostgresMetaFunctions {
     return await this.retrieve({ name, schema })
   }
 
+  async update(
+    id: number,
+    {
+      name,
+      schema,
+      params,
+      extension,
+    }: {
+      name: string
+      schema?: string
+      params?: string[] //optional params for overloaded functions
+      extension?: string //e.g. sqrt DEPENDS ON EXTENSION mathlib
+    }
+  ): Promise<PostgresMetaResult<PostgresFunction>> {
+    const { data: old, error: retrieveError } = await this.retrieve({ id })
+    if (retrieveError) {
+      return { data: null, error: retrieveError }
+    }
+
+    const alter = `ALTER FUNCTION ${ident(old!.schema)}.${ident(old!.name)}${
+      params && params.length ? `(${params.join(',')})` : ''
+    }`
+
+    const schemaSql =
+      schema === undefined || name == old!.schema ? '' : `${alter} SET SCHEMA ${ident(schema)};`
+    const extSql = extension === undefined ? '' : `${alter} DEPENDS ON EXTENSION ${extension};`
+    const nameSql =
+      name === undefined || name == old!.name ? '' : `${alter} RENAME TO ${ident(name)};`
+    //Note: leaving out search_path and owner - should these be alterable from this api?
+
+    const sql = `BEGIN; ${schemaSql} ${extSql} ${nameSql} COMMIT;`
+
+    const { error } = await this.query(sql)
+    if (error) {
+      return { data: null, error }
+    }
+    return await this.retrieve({ id })
+  }
+
   async remove(
     id: number,
     { cascade = false } = {}

src/server/routes/functions.ts

@@ -61,6 +61,28 @@ export default async (fastify: FastifyInstance) => {
     return data
   })
 
+  fastify.patch<{
+    Headers: { pg: string }
+    Params: {
+      id: string
+    }
+    Body: any
+  }>('/:id(\\d+)', async (request, reply) => {
+    const connectionString = request.headers.pg
+    const id = Number(request.params.id)
+
+    const pgMeta = new PostgresMeta({ connectionString, max: 1 })
+    const { data, error } = await pgMeta.functions.update(id, request.body)
+    await pgMeta.end()
+    if (error) {
+      request.log.error(JSON.stringify({ error, req: request.body }))
+      reply.code(400)
+      if (error.message.startsWith('Cannot find')) reply.code(404)
+      return { error: error.message }
+    }
+    return data
+  })
+
   fastify.delete<{
     Headers: { pg: string }
     Params: {

test/integration/index.spec.js

@@ -206,6 +206,19 @@ describe('/functions', () => {
     assert.equal(newFunc.return_type, 'int4')
     func.id = newFunc.id
   })
+  it('PATCH', async () => {
+    const updates = {
+      name: 'test_func_renamed',
+      params: ['integer', 'integer'],
+      // schema: 'test_schema' // TODO: test patching function schema
+      // extension: 'mathlib', // TODO: test patching function extension
+    }
+
+    let { data: updated } = await axios.patch(`${URL}/functions/${func.id}`, updates)
+    assert.equal(updated.id, func.id)
+    assert.equal(updated.name, 'test_func_renamed')
+    //assert.equal(updated.schema, 'test_schema')
+  })
   it('DELETE', async () => {
     await axios.delete(`${URL}/functions/${func.id}`)
     const { data: functions } = await axios.get(`${URL}/functions`)