v2.22.1: Add support for custom microshard schema naming; fix replication lag waiting during microshards move; improve tests;

Author: dimikot

docs/functions/cli.md

@@ -8,7 +8,7 @@
 
 > **cli**(): `void`
 
-Defined in: [src/cli.ts:212](https://github.com/clickup/pg-microsharding/blob/master/src/cli.ts#L212)
+Defined in: [src/cli.ts:230](https://github.com/clickup/pg-microsharding/blob/master/src/cli.ts#L230)
 
 A wrapper around main() to call it from a bin script.
 

docs/functions/install.md

@@ -16,8 +16,9 @@ Installs/updates microsharding schema and functions.
 
 | Parameter | Type |
 | ------ | ------ |
-| `__namedParameters` | \{ `dsn`: `string`; \} |
+| `__namedParameters` | \{ `dsn`: `string`; `schemaNameFmt`: `string`; \} |
 | `__namedParameters.dsn` | `string` |
+| `__namedParameters.schemaNameFmt`? | `string` |
 
 ## Returns
 

docs/functions/main.md

@@ -8,7 +8,7 @@
 
 > **main**(`argsIn`): `Promise`\<`boolean`\>
 
-Defined in: [src/cli.ts:145](https://github.com/clickup/pg-microsharding/blob/master/src/cli.ts#L145)
+Defined in: [src/cli.ts:158](https://github.com/clickup/pg-microsharding/blob/master/src/cli.ts#L158)
 
 Tool main function.
 

docs/functions/move.md

@@ -8,7 +8,7 @@
 
 > **move**(`__namedParameters`): `Promise`\<`void`\>
 
-Defined in: [src/api/move.ts:29](https://github.com/clickup/pg-microsharding/blob/master/src/api/move.ts#L29)
+Defined in: [src/api/move.ts:32](https://github.com/clickup/pg-microsharding/blob/master/src/api/move.ts#L32)
 
 Moves a shard from one master DB to another.
 

package-lock.json

@@ -1,7 +1,7 @@
 {
   "name": "@clickup/pg-microsharding",
   "description": "Microshards support for PostgreSQL",
-  "version": "2.20.2",
+  "version": "2.22.1",
   "license": "MIT",
   "keywords": [
     "postgresql",
@@ -18,6 +18,7 @@
     "dev": "internal/dev.sh",
     "lint": "internal/lint.sh",
     "test": "PGPORT=54833 internal/with-docker-compose-up.postgres.sh 'f() { internal/test.sh \"$@\" && if [ \"$1\" == \"\" ]; then for f in sql/__tests__/test_*.sql; do echo == $f; echo; psql -f $f; echo; echo; done; fi; }; f'",
+    "test:db": "PGPORT=54833 internal/with-docker-compose-up.postgres.sh 'for f in sql/__tests__/test_*.sql; do echo == $f; echo; psql -f $f; echo; echo; done'",
     "psql": "PGPORT=54833 internal/with-docker-compose-up.postgres.sh psql",
     "docs": "internal/update-readme.js && internal/docs.sh",
     "clean": "internal/clean.sh",

package.json

@@ -24,19 +24,9 @@ SET search_path TO test_microsharding;
 SET client_min_messages TO NOTICE;
 \set ON_ERROR_STOP on
 
+\setenv PG_MICROSHARDING_SCHEMA_NAME_FMT 'test_microsharding%04d'
 \ir ../pg-microsharding-up.sql
 
-
-CREATE OR REPLACE FUNCTION microsharding_schema_name_(
-  shard integer
-) RETURNS text
-LANGUAGE sql
-SET search_path FROM CURRENT
-AS $$
-  SELECT 'test_microsharding' || lpad($1::text, 4, '0')
-$$;
-
-
 CREATE FUNCTION expect(sql text, exp text, msg text) RETURNS void LANGUAGE plpgsql AS $$
 DECLARE
   got text;
@@ -47,3 +37,20 @@ BEGIN
   END IF;
 END;
 $$;
+
+CREATE FUNCTION expect_raise(sql text, exp text, msg text) RETURNS void LANGUAGE plpgsql AS $$
+DECLARE
+  got text;
+BEGIN
+  BEGIN
+    EXECUTE sql INTO got;
+    RAISE EXCEPTION 'Expected to raise an exception (%)', msg;
+  EXCEPTION
+    WHEN OTHERS THEN
+      GET STACKED DIAGNOSTICS got = MESSAGE_TEXT;
+      IF got NOT LIKE exp THEN
+        RAISE EXCEPTION 'Expected exception matching "%", got "%"', exp, got;
+      END IF;
+  END;
+END;
+$$;

sql/__tests__/begin.sql

@@ -6,6 +6,7 @@ SELECT array_agg(s) FROM microsharding_debug_fdw_drop('test_microsharding_fdw')
 \ir ../pg-microsharding-down.sql
 
 DROP FUNCTION expect(text, text, text);
+DROP FUNCTION expect_raise(text, text, text);
 
 SET search_path TO public;
 DROP SCHEMA test_microsharding;

sql/__tests__/rollback.sql

@@ -0,0 +1,33 @@
+\ir ./begin.sql
+
+SELECT expect(
+  $$ SELECT microsharding_fmt_('sh%04d', 1) $$,
+  'sh0001',
+  'zero-padding'
+) \gset
+
+SELECT expect(
+  $$ SELECT microsharding_fmt_('my_%d', 1) $$,
+  'my_1',
+  'non zero-padding'
+) \gset
+
+SELECT expect(
+  $$ SELECT microsharding_fmt_('my_%05d_sfx', 1) $$,
+  'my_00001_sfx',
+  'with suffix'
+) \gset
+
+SELECT expect_raise(
+  $$ SELECT microsharding_fmt_('sh%s', 1) $$,
+  'Invalid format specifier%',
+  'error'
+) \gset
+
+SELECT expect_raise(
+  $$ SELECT microsharding_fmt_('sh%2d', 1) $$,
+  'Invalid format specifier%',
+  'error'
+) \gset
+
+\ir ./rollback.sql

sql/__tests__/test_fmt.sql

@@ -0,0 +1,30 @@
+CREATE OR REPLACE FUNCTION microsharding_fmt_(
+  fmt text,
+  arg integer
+) RETURNS text
+LANGUAGE plpgsql
+SET search_path FROM CURRENT
+AS $$
+DECLARE
+  m text[];
+  prefix text;
+  width text;
+  suffix text;
+BEGIN
+  m := regexp_match(fmt, '^([^%]*)%(0[0-9]+)?d([^%]*)$');
+  IF m IS NULL THEN
+    RAISE EXCEPTION 'Invalid format specifier: "%" (valid examples: "sh%%04d", "some_%%d", "some%%04d_my")', fmt;
+  END IF;
+  prefix := m[1];
+  width := m[2];
+  suffix := m[3];
+  IF COALESCE(width, '') = '' THEN
+    RETURN prefix || arg || suffix;
+  ELSE
+    RETURN prefix || lpad(arg::text, width::integer, '0') || suffix;
+  END IF;
+END;
+$$;
+
+COMMENT ON FUNCTION microsharding_fmt_(text, integer)
+  IS 'A poor man''s sprintf() implementation limited to only one integer substitution.';