feat(store-sync): adjust DB schema/table names for consistency (#2379)

latticexyz · Mar 11, 2024 · adc6822 · adc6822
1 parent 307abab
commit adc6822
Show file tree

Hide file tree

Showing 12 changed files with 125 additions and 96 deletions.
diff --git a/.changeset/wise-bees-repair.md b/.changeset/wise-bees-repair.md
@@ -0,0 +1,27 @@
+---
+"@latticexyz/store-indexer": major
+"@latticexyz/store-sync": major
+---
+
+PostgreSQL sync/indexer now uses `{storeAddress}` for its database schema names and `{namespace}__{tableName}` for its database table names (or just `{tableName}` for root namespace), to be more consistent with the rest of the MUD codebase.
+
+For namespaced tables:
+
+```diff
+- SELECT * FROM 0xfff__some_ns.some_table
++ SELECT * FROM 0xfff.some_ns__some_table
+```
+
+For root tables:
+
+```diff
+- SELECT * FROM 0xfff__.some_table
++ SELECT * FROM 0xfff.some_table
+```
+
+SQLite sync/indexer now uses snake case for its table names and column names for easier writing of queries and to better match PostgreSQL sync/indexer naming.
+
+```diff
+- SELECT * FROM 0xfFf__someNS__someTable
++ SELECT * FROM 0xfff__some_ns__some_table
+```
diff --git a/packages/store-sync/src/postgres-decoded/buildTable.test.ts b/packages/store-sync/src/postgres-decoded/buildTable.test.ts
@@ -14,8 +14,8 @@ describe("buildTable", () => {
       valueSchema: { name: "string", walletAddress: "address" },
     });
 
-    expect(getTableConfig(table).schema).toMatch(/0xffffffffffffffffffffffffffffffffffffffff__testNS$/);
-    expect(getTableConfig(table).name).toMatchInlineSnapshot('"users_table"');
+    expect(getTableConfig(table).schema).toMatch(/0xffffffffffffffffffffffffffffffffffffffff$/);
+    expect(getTableConfig(table).name).toMatchInlineSnapshot('"test_ns__users_table"');
     expect(
       mapObject(getTableColumns(table), (column) => ({
         name: column.name,
@@ -74,8 +74,8 @@ describe("buildTable", () => {
       valueSchema: { addrs: "address[]" },
     });
 
-    expect(getTableConfig(table).schema).toMatch(/0xffffffffffffffffffffffffffffffffffffffff__testNS$/);
-    expect(getTableConfig(table).name).toMatchInlineSnapshot('"users_table"');
+    expect(getTableConfig(table).schema).toMatch(/0xffffffffffffffffffffffffffffffffffffffff$/);
+    expect(getTableConfig(table).name).toMatchInlineSnapshot('"test_ns__users_table"');
     expect(
       mapObject(getTableColumns(table), (column) => ({
         name: column.name,

diff --git a/packages/store-sync/src/postgres-decoded/buildTable.ts b/packages/store-sync/src/postgres-decoded/buildTable.ts
@@ -1,5 +1,5 @@
 import { PgColumnBuilderBase, PgTableWithColumns, pgSchema } from "drizzle-orm/pg-core";
-import { Address, getAddress } from "viem";
+import { Address } from "viem";
 import { snakeCase } from "change-case";
 import { KeySchema, ValueSchema } from "@latticexyz/protocol-parser";
 import { asBigInt, asHex } from "../postgres/columnTypes";
@@ -50,8 +50,8 @@ export function buildTable<TKeySchema extends KeySchema, TValueSchema extends Va
   // We intentionally do not snake case the namespace due to potential conflicts
   // with namespaces of a similar name (e.g. `MyNamespace` vs. `my_namespace`).
   // TODO: consider snake case when we resolve https://github.com/latticexyz/mud/issues/1991
-  const schemaName = transformSchemaName(`${address.toLowerCase()}__${namespace}`);
-  const tableName = snakeCase(name);
+  const schemaName = transformSchemaName(address.toLowerCase());
+  const tableName = namespace ? `${snakeCase(namespace)}__${snakeCase(name)}` : snakeCase(name);
 
   // Column names, however, are safe to snake case because they're scoped to tables, defined once per table, and there's a limited number of fields in total.
 

diff --git a/packages/store-sync/src/postgres-decoded/createStorageAdapter.test.ts b/packages/store-sync/src/postgres-decoded/createStorageAdapter.test.ts
@@ -53,7 +53,7 @@ describe("createStorageAdapter", async () => {
         {
           "blockNumber": 21n,
           "chainId": 31337,
-          "version": "0.0.6",
+          "version": "0.0.7",
         },
       ]
     `);

diff --git a/packages/store-sync/src/postgres/cleanDatabase.ts b/packages/store-sync/src/postgres/cleanDatabase.ts
@@ -12,9 +12,10 @@ const schemata = pgSchema("information_schema").table("schemata", {
 });
 
 function isMudSchemaName(schemaName: string): boolean {
-  // address-prefixed schemas like {address}__{namespace} used by decoded postgres tables
+  // each store address has its own schema used by decoded postgres tables
   // optional prefix for schemas created in tests
-  if (/(^|__)0x[0-9a-f]{40}__/i.test(schemaName)) {
+  // optional suffix for schemas that used to also include namespace (pre 0.0.7)
+  if (/(^|__)0x[0-9a-f]{40}($|__)/i.test(schemaName)) {
     return true;
   }
   // schema for internal tables

diff --git a/packages/store-sync/src/postgres/createStorageAdapter.test.ts b/packages/store-sync/src/postgres/createStorageAdapter.test.ts
@@ -51,7 +51,7 @@ describe("createStorageAdapter", async () => {
         {
           "blockNumber": 21n,
           "chainId": 31337,
-          "version": "0.0.6",
+          "version": "0.0.7",
         },
       ]
     `);

diff --git a/packages/store-sync/src/postgres/version.ts b/packages/store-sync/src/postgres/version.ts
@@ -1 +1 @@
-export const version = "0.0.6";
+export const version = "0.0.7";