Local/global config for user name and email (#99)

* set_config

* local config

* experiimental config fns

* rename

* undo nonsense

* remove commented code

Co-authored-by: Misha Kaletsky <[email protected]>

Author: mmkal

.eslintrc.js

@@ -20,4 +20,12 @@ module.exports = {
     'prettier/prettier': ['warn', require('./.prettierrc')],
     'codegen/codegen': 'error',
   },
+  overrides: [
+    {
+      files: ['**/*.md'],
+      rules: {
+        'prettier/prettier': 'off',
+      },
+    },
+  ],
 }

package.json

@@ -39,7 +39,7 @@
     "docker-exec": "docker exec plv8-git_postgres_1",
     "eslint": "eslint --max-warnings 0",
     "generate": "yarn tsn scripts/generate-queries",
-    "lint": "yarn eslint . && tsc -p .",
+    "lint": "tsc -p . && yarn eslint . ",
     "prepare": "patch-package",
     "psql": "yarn --silent docker-exec psql -h localhost -U postgres postgres",
     "test": "jest",
@@ -66,7 +66,7 @@
     "path-browserify": "1.0.1",
     "prettier": "2.2.1",
     "process": "0.11.10",
-    "slonik": "23.6.1",
+    "slonik": "23.8.5",
     "stream-browserify": "3.0.0",
     "ts-jest": "26.5.2",
     "ts-loader": "9.1.1",

readme.md

@@ -11,6 +11,7 @@ The implementation uses [plv8](https://github.com/plv8/plv8) to run JavaScript i
    - [Deletions](#deletions)
    - [Options](#options)
       - [Commit messages](#commit-messages)
+      - [Git config](#git-config)
       - [Log depth](#log-depth)
       - [Tags](#tags)
    - [Restoring previous versions](#restoring-previous-versions)
@@ -33,9 +34,7 @@ To paraphrase [@mayfer's twitter thread](https://twitter.com/mayfer/status/13086
 - with just 1 extra column, you 
 can add multiuser versioning to *any* indexed column!
 
-- how cool this will be for large JSON or other text blob columns that get overwritten a lot during the app's lifetime
-
-- since all commits are controlled by the main app, it's trivial to integrate commit authors directly into any regular application's user auth system
+- how cool this will be for large JSON or other text blob c get overwritten a lot duringall commits are controlled by the main app, it's trivial to integrate commit authors directly into any regular application's user auth system
 
 - due to the git standard, this repo then can easily be fed into any generic git UI for all sorts of diffing, logging & visualizing
 
@@ -50,7 +49,6 @@ psql -c "
   create extension if not exists plv8;
   select plv8_version();
 "
-
 psql -f node_modules/plv8-git/queries/create-git-functions.sql
 ```
 
@@ -342,6 +340,49 @@ where id = 2
 }
 ```
 
+#### Git config
+
+You can configure git using `git_set_local_config` or `git_set_global_config`:
+
+```sql
+select git_set_local_config('user.name', 'Bob');
+select git_set_local_config('user.email', '[email protected]');
+
+insert into test_table(id, text)
+values(201, 'value set by bob')
+```
+
+```sql
+select git_log(git)
+from test_table
+where id = 201
+```
+
+```json
+{
+  "git_log": [
+    {
+      "message": "test_table_git_track_trigger: BEFORE INSERT ROW on public.test_table",
+      "author": "Bob ([email protected])",
+      "timestamp": "2000-12-25T12:00:00.000Z",
+      "oid": "[oid]",
+      "changes": [
+        {
+          "field": "id",
+          "new": 201
+        },
+        {
+          "field": "text",
+          "new": "value set by bob"
+        }
+      ]
+    }
+  ]
+}
+```
+
+Under the hood these use `set_config` with the `is_local` parameter respectively true/false for the local/global variants.
+
 #### Log depth
 
 `git_log` also accepts a `depth` parameter to limit the amount of history that is fetched:

scripts/docs.js

@@ -13,7 +13,7 @@ module.exports = params => {
   }
   const end = lines.findIndex((line, i) => i > start && line.startsWith('})'))
 
-  const codeBlockLinePrefix = 'CODE_BLOCK_LINE:'
+  let codeBlockLinePrefix = 'CODE_BLOCK_LINE:'
 
   return lines
     .slice(start, end)
@@ -32,6 +32,14 @@ module.exports = params => {
     .split('\n')
     .filter(line => !line.startsWith('// todo') && !line.startsWith('// TODO'))
     .map((line, i) => {
+      if (line.endsWith('=> {')) {
+        codeBlockLinePrefix += '  '
+        return null
+      }
+      if (line.endsWith('})')) {
+        codeBlockLinePrefix = codeBlockLinePrefix.replace(/  $/, '')
+        return null
+      }
       if (line.includes('sql`')) return '```sql'
       if (line.includes('.toMatchInlineSnapshot(`')) return '```json'
       if (line.trim().endsWith('`)')) return '```'
@@ -51,5 +59,6 @@ module.exports = params => {
       }
       return line
     })
+    .filter(line => line !== null)
     .join('\n')
 }

scripts/generate-queries.ts

@@ -78,6 +78,24 @@ export const getQuery = (js: string) => {
 
     $$
     language plpgsql;
+
+    create or replace function git_set_local_config(name text, value text) returns text as
+    $$
+      select set_config('git.' || name, value, /* is_local */ true);
+    $$
+    language sql;
+
+    create or replace function git_set_global_config(name text, value text) returns text as
+    $$
+      select set_config('git.' || name, value, /* is_local */ false);
+    $$
+    language sql;
+
+    create or replace function git_get_config(name text) returns text as
+    $$
+      select current_setting('git.' || name, /* missing_ok */ true);
+    $$
+    language sql;
   `
 }
 

src/git.ts

@@ -6,6 +6,9 @@ import {PG_Vars} from './pg-types'
 import {setupMemfs} from './fs'
 
 function writeGitFiles(gitFiles: any, fs: memfs.IFs) {
+  if (!gitFiles) {
+    throw new Error(`Expected gitFiles as object, got ${gitFiles}`)
+  }
   Object.keys(gitFiles).map(filepath => {
     fs.mkdirSync(path.dirname(filepath), {recursive: true})
     fs.writeFileSync(filepath, Buffer.from(gitFiles[filepath]))
@@ -25,8 +28,19 @@ export const rowToRepo = ({OLD, NEW, ...pg}: PG_Vars) => {
     throw new Error(`Invalid column name ${repoColumn}`)
   }
 
-  const setupGitFolder =
-    pg.TG_OP === 'INSERT' ? () => git.init({...repo, defaultBranch: 'main'}) : () => writeGitFiles(OLD![repoColumn], fs)
+  const setupGitFolder = () => {
+    if (pg.TG_OP === 'INSERT') {
+      return git.init({...repo, defaultBranch: 'main'})
+    }
+
+    if (!OLD![repoColumn]) {
+      throw new Error(`expected ${repoColumn} column on ${pg.TG_OP} old value: ${JSON.stringify(OLD, null, 2)}.`)
+    }
+
+    return writeGitFiles(OLD![repoColumn], fs)
+  }
+
+  const gitParams = NEW?.[repoColumn] || {}
 
   const commitMessage = `${pg.TG_NAME}: ${pg.TG_WHEN} ${pg.TG_OP} ${pg.TG_LEVEL} on ${pg.TG_TABLE_SCHEMA}.${pg.TG_TABLE_NAME}`.trim()
 
@@ -46,13 +60,16 @@ export const rowToRepo = ({OLD, NEW, ...pg}: PG_Vars) => {
         .then(() =>
           git.commit({
             ...repo,
-            message: [NEW?.[repoColumn]?.commit?.message, commitMessage].filter(Boolean).join('\n\n'),
-            author: {name: 'pguser', email: '[email protected]', ...NEW?.[repoColumn]?.commit?.author},
+            message: [gitParams.commit?.message, commitMessage].filter(Boolean).join('\n\n'),
+            author: {
+              name: gitParams.commit?.author?.name || getSetting('user.name') || 'pguser',
+              email: gitParams.commit?.author?.email || getSetting('user.email') || '[email protected]',
+            },
           }),
         )
         .then(commit =>
           Promise.all(
-            (NEW?.git?.tags || []).map((tag: string) => {
+            (gitParams.tags || []).map((tag: string) => {
               return git.tag({...repo, ref: tag, object: commit})
             }),
           ),
@@ -75,6 +92,15 @@ export const rowToRepo = ({OLD, NEW, ...pg}: PG_Vars) => {
     }))
 }
 
+declare const plv8: {
+  execute(sql: string, args?: unknown[]): Record<string, unknown>[]
+}
+const getSetting = (name: string) => {
+  // https://www.postgresql.org/docs/9.4/functions-admin.html
+  const [{git_get_config}] = plv8.execute('select git_get_config($1)', [name])
+  return git_get_config
+}
+
 type TreeInfo = {type: string; content: string; oid: string}
 type WalkResult = {filepath: string; ChildInfo: TreeInfo; ParentInfo?: TreeInfo}
 

test/walkthrough.test.ts

@@ -1,7 +1,6 @@
 import {createPool, sql} from 'slonik'
 import {readFileSync} from 'fs'
 import * as path from 'path'
-import {createHash} from 'crypto'
 import {fuzzifyDate, readableJson} from './result-printer'
 
 // NOTE! This file is used to auto-generate the readme.
@@ -34,6 +33,14 @@ beforeAll(async () => {
     drop function if exists git_log cascade;
     drop function if exists git_resolve cascade;
     drop function if exists git_call_sync cascade;
+    drop function if exists git_set_config cascade;
+    drop function if exists git_set_local_config cascade;
+    drop function if exists git_set_global_config cascade;
+    drop function if exists git_get_config cascade;
+    drop function if exists set_local_git_config;
+    drop function if exists set_global_git_config;
+    drop function if exists get_git_config;
+    drop function if exists git_get_config;
   `)
 
   await client.query({
@@ -329,6 +336,51 @@ test('walkthrough', async () => {
     }
   `)
 
+  // #### Git config
+
+  // You can configure git using `git_set_local_config` or `git_set_global_config`:
+
+  result = await client.transaction(async transaction => {
+    await transaction.query(sql`
+      select git_set_local_config('user.name', 'Bob');
+      select git_set_local_config('user.email', '[email protected]');
+
+      insert into test_table(id, text)
+      values(201, 'value set by bob')
+    `)
+
+    return transaction.one(sql`
+      select git_log(git)
+      from test_table
+      where id = 201
+    `)
+  })
+
+  expect(result).toMatchInlineSnapshot(`
+    {
+      "git_log": [
+        {
+          "message": "test_table_git_track_trigger: BEFORE INSERT ROW on public.test_table",
+          "author": "Bob ([email protected])",
+          "timestamp": "2000-12-25T12:00:00.000Z",
+          "oid": "[oid]",
+          "changes": [
+            {
+              "field": "id",
+              "new": 201
+            },
+            {
+              "field": "text",
+              "new": "value set by bob"
+            }
+          ]
+        }
+      ]
+    }
+  `)
+
+  // Under the hood these use `set_config` with the `is_local` parameter respectively true/false for the local/global variants.
+
   // #### Log depth
 
   // `git_log` also accepts a `depth` parameter to limit the amount of history that is fetched: