feat: squash migrations

squashes all migrations to reduce migration time

Author: filipecabaco

lib/realtime/tenants/migrations.ex

@@ -81,7 +81,8 @@ defmodule Realtime.Tenants.Migrations do
     CreateMessagesReplayIndex,
     BroadcastSendIncludePayloadId,
     AddActionToSubscriptions,
-    FilterActionPostgresChanges
+    FilterActionPostgresChanges,
+    SquashMigrations
   }
 
   @migrations [
@@ -151,7 +152,8 @@ defmodule Realtime.Tenants.Migrations do
     {20_250_905_041_441, CreateMessagesReplayIndex},
     {20_251_103_001_201, BroadcastSendIncludePayloadId},
     {20_251_120_212_548, AddActionToSubscriptions},
-    {20_251_120_215_549, FilterActionPostgresChanges}
+    {20_251_120_215_549, FilterActionPostgresChanges},
+    {20_260_211_000_000, SquashMigrations}
   ]
 
   defstruct [:tenant_external_id, :settings, migrations_ran: 0]

lib/realtime/tenants/repo/migrations/20211116024918_create_realtime_subscription_table.ex

@@ -1,47 +1,5 @@
 defmodule Realtime.Tenants.Migrations.CreateRealtimeSubscriptionTable do
   @moduledoc false
-
   use Ecto.Migration
-
-  def change do
-    execute("""
-    DO $$
-    BEGIN
-        IF NOT EXISTS (SELECT 1 FROM pg_type WHERE typname = 'equality_op') THEN
-            CREATE TYPE realtime.equality_op AS ENUM(
-              'eq', 'neq', 'lt', 'lte', 'gt', 'gte'
-            );
-        END IF;
-    END$$;
-    """)
-
-    execute("""
-    DO $$
-    BEGIN
-        IF NOT EXISTS (SELECT 1 FROM pg_type WHERE typname = 'user_defined_filter') THEN
-            CREATE TYPE realtime.user_defined_filter as (
-              column_name text,
-              op realtime.equality_op,
-              value text
-            );
-        END IF;
-    END$$;
-    """)
-
-    execute("create table if not exists realtime.subscription (
-      -- Tracks which users are subscribed to each table
-      id bigint not null generated always as identity,
-      user_id uuid not null,
-      -- Populated automatically by trigger. Required to enable auth.email()
-      email varchar(255),
-      entity regclass not null,
-      filters realtime.user_defined_filter[] not null default '{}',
-      created_at timestamp not null default timezone('utc', now()),
-
-      constraint pk_subscription primary key (id),
-      unique (entity, user_id, filters)
-    )")
-
-    execute("create index if not exists ix_realtime_subscription_entity on realtime.subscription using hash (entity)")
-  end
+  def change, do: nil
 end

lib/realtime/tenants/repo/migrations/20211116045059_create_realtime_check_filters_trigger.ex

@@ -1,65 +1,5 @@
 defmodule Realtime.Tenants.Migrations.CreateRealtimeCheckFiltersTrigger do
   @moduledoc false
-
   use Ecto.Migration
-
-  def change do
-    execute("create or replace function realtime.subscription_check_filters()
-      returns trigger
-      language plpgsql
-    as $$
-    /*
-    Validates that the user defined filters for a subscription:
-    - refer to valid columns that 'authenticated' may access
-    - values are coercable to the correct column type
-    */
-    declare
-      col_names text[] = coalesce(
-        array_agg(c.column_name order by c.ordinal_position),
-        '{}'::text[]
-      )
-        from
-          information_schema.columns c
-        where
-          (quote_ident(c.table_schema) || '.' || quote_ident(c.table_name))::regclass = new.entity
-          and pg_catalog.has_column_privilege('authenticated', new.entity, c.column_name, 'SELECT');
-      filter realtime.user_defined_filter;
-      col_type text;
-    begin
-      for filter in select * from unnest(new.filters) loop
-        -- Filtered column is valid
-        if not filter.column_name = any(col_names) then
-          raise exception 'invalid column for filter %', filter.column_name;
-        end if;
-
-        -- Type is sanitized and safe for string interpolation
-        col_type = (
-          select atttypid::regtype
-          from pg_catalog.pg_attribute
-          where attrelid = new.entity
-            and attname = filter.column_name
-        )::text;
-        if col_type is null then
-          raise exception 'failed to lookup type for column %', filter.column_name;
-        end if;
-        -- raises an exception if value is not coercable to type
-        perform format('select %s::%I', filter.value, col_type);
-      end loop;
-
-      -- Apply consistent order to filters so the unique constraint on
-      -- (user_id, entity, filters) can't be tricked by a different filter order
-      new.filters = coalesce(
-        array_agg(f order by f.column_name, f.op, f.value),
-        '{}'
-      ) from unnest(new.filters) f;
-
-      return new;
-    end;
-    $$;")
-
-    execute("create trigger tr_check_filters
-    before insert or update on realtime.subscription
-    for each row
-    execute function realtime.subscription_check_filters();")
-  end
+  def change, do: nil
 end

lib/realtime/tenants/repo/migrations/20211116050929_create_realtime_quote_wal2json_function.ex

@@ -1,43 +1,5 @@
 defmodule Realtime.Tenants.Migrations.CreateRealtimeQuoteWal2jsonFunction do
   @moduledoc false
-
   use Ecto.Migration
-
-  def change do
-    execute("create function realtime.quote_wal2json(entity regclass)
-      returns text
-      language sql
-      immutable
-      strict
-    as $$
-      select
-        (
-          select string_agg('\' || ch,'')
-          from unnest(string_to_array(nsp.nspname::text, null)) with ordinality x(ch, idx)
-          where
-            not (x.idx = 1 and x.ch = '\"')
-            and not (
-              x.idx = array_length(string_to_array(nsp.nspname::text, null), 1)
-              and x.ch = '\"'
-            )
-        )
-        || '.'
-        || (
-          select string_agg('\' || ch,'')
-          from unnest(string_to_array(pc.relname::text, null)) with ordinality x(ch, idx)
-          where
-            not (x.idx = 1 and x.ch = '\"')
-            and not (
-              x.idx = array_length(string_to_array(nsp.nspname::text, null), 1)
-              and x.ch = '\"'
-            )
-          )
-      from
-        pg_class pc
-        join pg_namespace nsp
-          on pc.relnamespace = nsp.oid
-      where
-        pc.oid = entity
-    $$;")
-  end
+  def change, do: nil
 end

lib/realtime/tenants/repo/migrations/20211116051442_create_realtime_check_equality_op_function.ex

@@ -1,39 +1,5 @@
 defmodule Realtime.Tenants.Migrations.CreateRealtimeCheckEqualityOpFunction do
   @moduledoc false
-
   use Ecto.Migration
-
-  def change do
-    execute("create function realtime.check_equality_op(
-      op realtime.equality_op,
-      type_ regtype,
-      val_1 text,
-      val_2 text
-    )
-      returns bool
-      immutable
-      language plpgsql
-    as $$
-    /*
-    Casts *val_1* and *val_2* as type *type_* and check the *op* condition for truthiness
-    */
-    declare
-      op_symbol text = (
-        case
-          when op = 'eq' then '='
-          when op = 'neq' then '!='
-          when op = 'lt' then '<'
-          when op = 'lte' then '<='
-          when op = 'gt' then '>'
-          when op = 'gte' then '>='
-          else 'UNKNOWN OP'
-        end
-      );
-      res boolean;
-    begin
-      execute format('select %L::'|| type_::text || ' ' || op_symbol || ' %L::'|| type_::text, val_1, val_2) into res;
-      return res;
-    end;
-    $$;")
-  end
+  def change, do: nil
 end

lib/realtime/tenants/repo/migrations/20211116212300_create_realtime_build_prepared_statement_sql_function.ex

@@ -1,56 +1,5 @@
 defmodule Realtime.Tenants.Migrations.CreateRealtimeBuildPreparedStatementSqlFunction do
   @moduledoc false
-
   use Ecto.Migration
-
-  def change do
-    execute("""
-    DO $$
-    BEGIN
-        IF NOT EXISTS (SELECT 1 FROM pg_type WHERE typname = 'wal_column') THEN
-            CREATE TYPE realtime.wal_column AS (
-              name text,
-              type text,
-              value jsonb,
-              is_pkey boolean,
-              is_selectable boolean
-            );
-        END IF;
-    END$$;
-    """)
-
-    execute("create function realtime.build_prepared_statement_sql(
-      prepared_statement_name text,
-      entity regclass,
-      columns realtime.wal_column[]
-    )
-      returns text
-      language sql
-    as $$
-    /*
-    Builds a sql string that, if executed, creates a prepared statement to
-    tests retrive a row from *entity* by its primary key columns.
-
-    Example
-      select realtime.build_prepared_statment_sql('public.notes', '{\"id\"}'::text[], '{\"bigint\"}'::text[])
-    */
-      select
-    'prepare ' || prepared_statement_name || ' as
-      select
-        exists(
-          select
-            1
-          from
-            ' || entity || '
-          where
-            ' || string_agg(quote_ident(pkc.name) || '=' || quote_nullable(pkc.value) , ' and ') || '
-        )'
-      from
-        unnest(columns) pkc
-      where
-        pkc.is_pkey
-      group by
-        entity
-    $$;")
-  end
+  def change, do: nil
 end

lib/realtime/tenants/repo/migrations/20211116213355_create_realtime_cast_function.ex

@@ -1,20 +1,5 @@
 defmodule Realtime.Tenants.Migrations.CreateRealtimeCastFunction do
   @moduledoc false
-
   use Ecto.Migration
-
-  def change do
-    execute("create function realtime.cast(val text, type_ regtype)
-      returns jsonb
-      immutable
-      language plpgsql
-    as $$
-    declare
-      res jsonb;
-    begin
-      execute format('select to_jsonb(%L::'|| type_::text || ')', val)  into res;
-      return res;
-    end
-    $$;")
-  end
+  def change, do: nil
 end

lib/realtime/tenants/repo/migrations/20211116213934_create_realtime_is_visible_through_filters_function.ex

@@ -1,37 +1,5 @@
 defmodule Realtime.Tenants.Migrations.CreateRealtimeIsVisibleThroughFiltersFunction do
   @moduledoc false
-
   use Ecto.Migration
-
-  def change do
-    execute(
-      "create function realtime.is_visible_through_filters(columns realtime.wal_column[], filters realtime.user_defined_filter[])
-      returns bool
-      language sql
-      immutable
-    as $$
-    /*
-    Should the record be visible (true) or filtered out (false) after *filters* are applied
-    */
-    select
-      -- Default to allowed when no filters present
-      coalesce(
-        sum(
-          realtime.check_equality_op(
-            op:=f.op,
-            type_:=col.type::regtype,
-            -- cast jsonb to text
-            val_1:=col.value #>> '{}',
-            val_2:=f.value
-          )::int
-        ) = count(1),
-        true
-      )
-    from
-      unnest(filters) f
-      join unnest(columns) col
-          on f.column_name = col.name;
-    $$;"
-    )
-  end
+  def change, do: nil
 end