Skip to content

Commit 5e3f12d

Browse files
m0rt3nlundm0rt3nlund
authored
fix: Ensure primary key migrations use prefix for multitenancy (#488)
1 parent 9b2a019 commit 5e3f12d

File tree

11 files changed

+406
-54
lines changed

11 files changed

+406
-54
lines changed

‎.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -24,4 +24,5 @@ ash_postgres-*.tar
2424

2525
test_migration_path
2626
test_snapshots_path
27+
test_tenant_migration_path
2728

‎lib/migration_generator/operation.ex

+80-42
Original file line numberDiff line numberDiff line change
@@ -1055,17 +1055,24 @@ defmodule AshPostgres.MigrationGenerator.Operation do
10551055
@moduledoc false
10561056
defstruct [:schema, :table, :keys, no_phase: true]
10571057

1058-
def up(%{schema: schema, table: table, keys: keys}) do
1058+
def up(%{schema: schema, table: table, keys: keys, multitenancy: multitenancy}) do
10591059
keys = Enum.join(keys, ", ")
10601060

1061-
if schema do
1062-
"""
1063-
execute("ALTER TABLE \\\"#{schema}.#{table}\\\" ADD PRIMARY KEY (#{keys})")
1064-
"""
1065-
else
1066-
"""
1067-
execute("ALTER TABLE \\\"#{table}\\\" ADD PRIMARY KEY (#{keys})")
1068-
"""
1061+
cond do
1062+
multitenancy.strategy == :context ->
1063+
"""
1064+
execute("ALTER TABLE \\\"\#{prefix()}\\\".\\\"#{table}\\\" ADD PRIMARY KEY (#{keys})")
1065+
"""
1066+
1067+
schema ->
1068+
"""
1069+
execute("ALTER TABLE \\\"#{schema}.#{table}\\\" ADD PRIMARY KEY (#{keys})")
1070+
"""
1071+
1072+
true ->
1073+
"""
1074+
execute("ALTER TABLE \\\"#{table}\\\" ADD PRIMARY KEY (#{keys})")
1075+
"""
10691076
end
10701077
end
10711078

@@ -1082,33 +1089,54 @@ defmodule AshPostgres.MigrationGenerator.Operation do
10821089
""
10831090
end
10841091

1085-
def down(%{schema: schema, table: table, remove_old?: remove_old?, keys: keys}) do
1092+
def down(%{
1093+
schema: schema,
1094+
table: table,
1095+
remove_old?: remove_old?,
1096+
keys: keys,
1097+
multitenancy: multitenancy
1098+
}) do
10861099
keys = Enum.join(keys, ", ")
10871100

1088-
if schema do
1089-
remove_old =
1090-
if remove_old? do
1091-
"""
1092-
execute("ALTER TABLE \\\"#{schema}.#{table}\\\" DROP constraint #{table}_pkey")
1093-
"""
1094-
end
1101+
cond do
1102+
multitenancy.strategy == :context ->
1103+
remove_old =
1104+
if remove_old? do
1105+
"""
1106+
execute("ALTER TABLE \\\"\#{prefix()}\\\".\\\"#{table}\\\" DROP constraint #{table}_pkey")
1107+
"""
1108+
end
10951109

1096-
"""
1097-
#{remove_old}
1098-
execute("ALTER TABLE \\\"#{schema}.#{table}\\\" ADD PRIMARY KEY (#{keys})")
1099-
"""
1100-
else
1101-
remove_old =
1102-
if remove_old? do
1103-
"""
1104-
execute("ALTER TABLE \\\"#{table}\\\" DROP constraint #{table}_pkey")
1105-
"""
1106-
end
1110+
"""
1111+
#{remove_old}
1112+
execute("ALTER TABLE \\\"\#{prefix()}\\\".\\\"#{table}\\\" ADD PRIMARY KEY (#{keys})")
1113+
"""
1114+
1115+
not is_nil(schema) ->
1116+
remove_old =
1117+
if remove_old? do
1118+
"""
1119+
execute("ALTER TABLE \\\"#{schema}.#{table}\\\" DROP constraint #{table}_pkey")
1120+
"""
1121+
end
1122+
1123+
"""
1124+
#{remove_old}
1125+
execute("ALTER TABLE \\\"#{schema}.#{table}\\\" ADD PRIMARY KEY (#{keys})")
1126+
"""
1127+
1128+
true ->
1129+
remove_old =
1130+
if remove_old? do
1131+
"""
1132+
execute("ALTER TABLE \\\"#{table}\\\" DROP constraint #{table}_pkey")
1133+
"""
1134+
end
11071135

1108-
"""
1109-
#{remove_old}
1110-
execute("ALTER TABLE \\\"#{table}\\\" ADD PRIMARY KEY (#{keys})")
1111-
"""
1136+
"""
1137+
#{remove_old}
1138+
execute("ALTER TABLE \\\"#{table}\\\" ADD PRIMARY KEY (#{keys})")
1139+
"""
11121140
end
11131141
end
11141142
end
@@ -1117,11 +1145,16 @@ defmodule AshPostgres.MigrationGenerator.Operation do
11171145
@moduledoc false
11181146
defstruct [:schema, :table, no_phase: true]
11191147

1120-
def up(%{schema: schema, table: table}) do
1121-
if schema do
1122-
"drop constraint(#{inspect(table)}, \"#{table}_pkey\", prefix: \"#{schema}\")"
1123-
else
1124-
"drop constraint(#{inspect(table)}, \"#{table}_pkey\")"
1148+
def up(%{schema: schema, table: table, multitenancy: multitenancy}) do
1149+
cond do
1150+
multitenancy.strategy == :context ->
1151+
"drop constraint(#{inspect(table)}, \"#{table}_pkey\", prefix: prefix())"
1152+
1153+
schema ->
1154+
"drop constraint(#{inspect(table)}, \"#{table}_pkey\", prefix: \"#{schema}\")"
1155+
1156+
true ->
1157+
"drop constraint(#{inspect(table)}, \"#{table}_pkey\")"
11251158
end
11261159
end
11271160

@@ -1138,7 +1171,7 @@ defmodule AshPostgres.MigrationGenerator.Operation do
11381171
""
11391172
end
11401173

1141-
def down(%{schema: schema, table: table, commented?: commented?}) do
1174+
def down(%{schema: schema, table: table, commented?: commented?, multitenancy: multitenancy}) do
11421175
comment =
11431176
if commented? do
11441177
"""
@@ -1149,10 +1182,15 @@ defmodule AshPostgres.MigrationGenerator.Operation do
11491182
""
11501183
end
11511184

1152-
if schema do
1153-
"#{comment}drop constraint(#{inspect(table)}, \"#{table}_pkey\", prefix: \"#{schema}\")"
1154-
else
1155-
"#{comment}drop constraint(#{inspect(table)}, \"#{table}_pkey\")"
1185+
cond do
1186+
multitenancy.strategy == :context ->
1187+
"#{comment}drop constraint(#{inspect(table)}, \"#{table}_pkey\", prefix: prefix())"
1188+
1189+
schema ->
1190+
"#{comment}drop constraint(#{inspect(table)}, \"#{table}_pkey\", prefix: \"#{schema}\")"
1191+
1192+
true ->
1193+
"#{comment}drop constraint(#{inspect(table)}, \"#{table}_pkey\")"
11561194
end
11571195
end
11581196
end

‎priv/resource_snapshots/test_repo/tenants/composite_key/20250220073135.json

+68
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
{
2+
"attributes": [
3+
{
4+
"allow_nil?": false,
5+
"default": "nil",
6+
"generated?": true,
7+
"primary_key?": true,
8+
"references": null,
9+
"size": null,
10+
"source": "id",
11+
"type": "bigint"
12+
},
13+
{
14+
"allow_nil?": false,
15+
"default": "nil",
16+
"generated?": false,
17+
"primary_key?": false,
18+
"references": null,
19+
"size": null,
20+
"source": "title",
21+
"type": "text"
22+
},
23+
{
24+
"allow_nil?": true,
25+
"default": "nil",
26+
"generated?": false,
27+
"primary_key?": false,
28+
"references": {
29+
"deferrable": false,
30+
"destination_attribute": "id",
31+
"destination_attribute_default": null,
32+
"destination_attribute_generated": null,
33+
"index?": false,
34+
"match_type": null,
35+
"match_with": null,
36+
"multitenancy": {
37+
"attribute": "id",
38+
"global": true,
39+
"strategy": "attribute"
40+
},
41+
"name": "composite_key_org_id_fkey",
42+
"on_delete": null,
43+
"on_update": null,
44+
"primary_key?": true,
45+
"schema": "public",
46+
"table": "multitenant_orgs"
47+
},
48+
"size": null,
49+
"source": "org_id",
50+
"type": "uuid"
51+
}
52+
],
53+
"base_filter": null,
54+
"check_constraints": [],
55+
"custom_indexes": [],
56+
"custom_statements": [],
57+
"has_create_action": true,
58+
"hash": "163B8B70E51926917188C902BA9E759A56F2C295D84FAA2AC02BF4F602139FA3",
59+
"identities": [],
60+
"multitenancy": {
61+
"attribute": null,
62+
"global": false,
63+
"strategy": "context"
64+
},
65+
"repo": "Elixir.AshPostgres.TestRepo",
66+
"schema": null,
67+
"table": "composite_key"
68+
}

‎priv/resource_snapshots/test_repo/tenants/composite_key/20250220073141.json

+68
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
{
2+
"attributes": [
3+
{
4+
"allow_nil?": false,
5+
"default": "nil",
6+
"generated?": true,
7+
"primary_key?": true,
8+
"references": null,
9+
"size": null,
10+
"source": "id",
11+
"type": "bigint"
12+
},
13+
{
14+
"allow_nil?": false,
15+
"default": "nil",
16+
"generated?": false,
17+
"primary_key?": true,
18+
"references": null,
19+
"size": null,
20+
"source": "title",
21+
"type": "text"
22+
},
23+
{
24+
"allow_nil?": true,
25+
"default": "nil",
26+
"generated?": false,
27+
"primary_key?": false,
28+
"references": {
29+
"deferrable": false,
30+
"destination_attribute": "id",
31+
"destination_attribute_default": null,
32+
"destination_attribute_generated": null,
33+
"index?": false,
34+
"match_type": null,
35+
"match_with": null,
36+
"multitenancy": {
37+
"attribute": "id",
38+
"global": true,
39+
"strategy": "attribute"
40+
},
41+
"name": "composite_key_org_id_fkey",
42+
"on_delete": null,
43+
"on_update": null,
44+
"primary_key?": true,
45+
"schema": "public",
46+
"table": "multitenant_orgs"
47+
},
48+
"size": null,
49+
"source": "org_id",
50+
"type": "uuid"
51+
}
52+
],
53+
"base_filter": null,
54+
"check_constraints": [],
55+
"custom_indexes": [],
56+
"custom_statements": [],
57+
"has_create_action": true,
58+
"hash": "4A793B2AE363407E93E81FA4CABF458C1F403432634A400B84ADDD7486D986BD",
59+
"identities": [],
60+
"multitenancy": {
61+
"attribute": null,
62+
"global": false,
63+
"strategy": "context"
64+
},
65+
"repo": "Elixir.AshPostgres.TestRepo",
66+
"schema": null,
67+
"table": "composite_key"
68+
}

‎priv/test_repo/tenant_migrations/20250220073135_migrate_resources5.exs

+32
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
defmodule AshPostgres.TestRepo.TenantMigrations.MigrateResources5 do
2+
@moduledoc """
3+
Updates resources based on their most recent snapshots.
4+
5+
This file was autogenerated with `mix ash_postgres.generate_migrations`
6+
"""
7+
8+
use Ecto.Migration
9+
10+
def up do
11+
create table(:composite_key, primary_key: false, prefix: prefix()) do
12+
add(:id, :bigserial, null: false, primary_key: true)
13+
add(:title, :text, null: false)
14+
15+
add(
16+
:org_id,
17+
references(:multitenant_orgs,
18+
column: :id,
19+
prefix: "public",
20+
name: "composite_key_org_id_fkey",
21+
type: :uuid
22+
)
23+
)
24+
end
25+
end
26+
27+
def down do
28+
drop(constraint(:composite_key, "composite_key_org_id_fkey"))
29+
30+
drop(table(:composite_key, prefix: prefix()))
31+
end
32+
end

‎priv/test_repo/tenant_migrations/20250220073141_migrate_resources6.exs

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
defmodule AshPostgres.TestRepo.TenantMigrations.MigrateResources6 do
2+
@moduledoc """
3+
Updates resources based on their most recent snapshots.
4+
5+
This file was autogenerated with `mix ash_postgres.generate_migrations`
6+
"""
7+
8+
use Ecto.Migration
9+
10+
def up do
11+
drop(constraint("composite_key", "composite_key_pkey", prefix: prefix()))
12+
13+
alter table(:composite_key, prefix: prefix()) do
14+
modify(:title, :text)
15+
end
16+
17+
execute("ALTER TABLE \"#{prefix()}\".\"composite_key\" ADD PRIMARY KEY (id, title)")
18+
end
19+
20+
def down do
21+
drop(constraint("composite_key", "composite_key_pkey", prefix: prefix()))
22+
23+
alter table(:composite_key, prefix: prefix()) do
24+
modify(:title, :text)
25+
end
26+
27+
execute("ALTER TABLE \"#{prefix()}\".\"composite_key\" ADD PRIMARY KEY (id)")
28+
end
29+
end

0 commit comments

Comments
 (0)