Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ Pull requests merged to `main` are listed in the nightly pre-releases until the
- Site: AH Ledger crafting margins can be sorted and filtered, with shareable market URLs.
- Site: /search can find a character nobody has stored yet: a full "First Surname" with no match is looked up in Blizzard's character API (US, then EU) and the character is stored and listed. Off until `EVERLOOT_ARMORY_LOOKUP=1`; limited per address and site-wide, never for crawlers or the header's type-ahead.
- Site: armory character pages show completed achievements, faction standings and the number of completed quests from Blizzard's character API, each with the time of its read; the crawler keeps only those fields and deletes each part 30 days after its last read.
- Site: the armory has a guild directory at /armory/guilds: search by name, filter by region and ruleset, sort by members read, average item level or level 60 count. Guild pages show the class mix, levels and average item level, a guild hidden through /guilds/hide leaves the armory too, and ranking rows show the region as a coloured chip. Counts start once the new database migration is applied.
- Site: zone and dungeon pages show their terrain types (Desert, Snowy, Swamp, Haunted, Strongholds and Cities and the rest) and the gear whose effect works there, and `/database/terrain` lists every terrain type's zones and instances and every item, enchant and set bonus that changes run, mount or swim speed, all read from the game files.
- Site: Add daily auction reports with archived asking-price movers, house spreads, RSS and downloadable share cards.
- Site: browse Blizzard auction house data by region and house, search item names, sort and page through current prices, and read 30 days of daily unit prices per house on the ad-free item pages.
Expand Down
26 changes: 26 additions & 0 deletions kb/test/armory-guild-directory-sql.test.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
import { PGlite } from "@electric-sql/pglite";
import { readFileSync } from "node:fs";
import { expect, test } from "vitest";

const read = (path: string) => readFileSync(new URL(`../../supabase/${path}`, import.meta.url), "utf8");

test("the guild directory migration counts read members, honours both hides, and is safe twice", async () => {
const db = new PGlite();
try {
// Unrelated prerequisites are minimal stand-ins; the players, guilds and armory SQL is real.
await db.exec(`create role anon; create role authenticated; create role service_role;
create table public.users(id uuid primary key);
create table public.character_suppressions(realm text,character text);
create table public.intake_quota_buckets(bucket text primary key,count int,reset_at timestamptz);
create function public.create_api_key(uuid,text,text,text,text[]) returns text language sql as 'select null::text';`);
const links = read("migrations/20261021190000_character_links.sql");
await db.exec(links.slice(0, links.indexOf("alter table public.api_keys")));
for (const migration of [
"20261021130000_players", "20261022160000_players_realm_key", "20261025120000_guilds",
"20261109120000_armory", "20261109130000_armory_touch_members", "20261112190000_armory_profiles",
]) await db.exec(read(`migrations/${migration}.sql`));
for (let i = 0; i < 2; i++) await db.exec(read("migrations/20261117170000_armory_guild_directory.sql"));
await db.exec(read("tests/armory_guild_directory.sql"));
expect((await db.query("select count(*)::int as n from public.armory_guilds")).rows).toEqual([{ n: 0 }]);
} finally { await db.close(); }
}, 60_000);
67 changes: 67 additions & 0 deletions supabase/migrations/20261117170000_armory_guild_directory.sql
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
-- The guild directory on /guilds: every armory guild with what the armory has read of its members.
-- Apply after 20261109120000_armory.sql and 20261025120000_guilds.sql. The maintainer applies it; safe to apply twice.
-- Until it is applied the site lists armory guilds by name only (armory_search_guilds) and says the directory is not
-- ready; nothing else depends on it.
--
-- One row per armory guild: the roster size Blizzard reports, how many of its characters the armory has read, their
-- average item level and how many are level 60, and the newest read of the guild or any of them. Hidden characters
-- are left out of every count (armory hide rule, repeated at read time). A guild hidden through /guilds/hide is left
-- out in the region its realm names: the hide form asks for a realm, the armory keys guilds by region, so a hide on
-- any realm of a region hides the armory guild of that name in that region. That may hide more, never less.
set lock_timeout = '3s';

do $$
begin
if to_regclass('public.armory_guilds') is null or to_regclass('public.guild_suppressions') is null then
raise exception 'Apply 20261109120000_armory.sql and 20261025120000_guilds.sql first';
end if;
end $$;

-- The per-guild counts read the characters of one region by guild without touching the table rows.
create index if not exists armory_characters_guild_directory on public.armory_characters(region,guild_slug)
include (slug,level,item_level,fetched_at) where guild_slug is not null;

-- Filters: a literal guild-name prefix (2 characters or more, as armory_search_guilds), a region, a ruleset.
-- Sort: 'members' (characters read, the default), 'item_level' (their average) or 'level_60' (how many are 60).
-- At most 100 rows a page; `total` is the number of guilds the filters match, repeated on every row.
create or replace function public.armory_guild_directory(p_prefix text, p_region text, p_ruleset_id smallint, p_sort text, p_limit integer, p_offset integer)
returns table (region text, slug text, name text, faction text, ruleset_id smallint, ruleset text, member_count integer,
members_read integer, average_item_level numeric, level_60 integer, fetched_at timestamptz, total integer)
language sql stable security definer set search_path = '' set lock_timeout = '3s'
as $$
with read as (
select c.region,c.guild_slug,count(*)::integer as members_read,round(avg(c.item_level),1) as average_item_level,
(count(*) filter (where c.level=60))::integer as level_60,max(c.fetched_at) as newest
from public.armory_characters c
where c.guild_slug is not null and (p_region is null or c.region=p_region)
and not exists(select 1 from public.armory_hides h where h.region=c.region and h.slug=c.slug)
group by c.region,c.guild_slug
), listed as (
select g.region,g.slug,g.name,g.faction,g.ruleset_id,g.ruleset,g.member_count,coalesce(r.members_read,0) as members_read,
r.average_item_level,coalesce(r.level_60,0) as level_60,greatest(g.fetched_at,r.newest) as fetched_at
from public.armory_guilds g left join read r on r.region=g.region and r.guild_slug=g.slug
where (p_region is null or g.region=p_region) and (p_ruleset_id is null or g.ruleset_id=p_ruleset_id)
and (p_prefix is null or (char_length(p_prefix)>=2 and p_prefix ~ '^[^%_\\]+$' and lower(g.name) like lower(p_prefix)||'%'))
and not exists(select 1 from public.guild_suppressions s
where s.guild_key=lower(g.name) and s.realm_key ~ ('(^| )' || g.region || '[0-9]*( |$)'))
)
select l.region,l.slug,l.name,l.faction,l.ruleset_id,l.ruleset,l.member_count,l.members_read,l.average_item_level,l.level_60,
l.fetched_at,(count(*) over())::integer
from listed l
order by case p_sort when 'item_level' then l.average_item_level when 'level_60' then l.level_60 else l.members_read end desc nulls last,
l.members_read desc,l.name,l.region,l.slug
limit least(greatest(coalesce(p_limit,50),0),100) offset greatest(coalesce(p_offset,0),0);
$$;
revoke all on function public.armory_guild_directory(text, text, smallint, text, integer, integer) from public, anon, authenticated;
grant execute on function public.armory_guild_directory(text, text, smallint, text, integer, integer) to service_role;
notify pgrst, 'reload schema';
reset lock_timeout;

-- Readback (every row t):
-- select has_function_privilege('service_role','public.armory_guild_directory(text,text,smallint,text,integer,integer)','EXECUTE')
-- and not has_function_privilege('anon','public.armory_guild_directory(text,text,smallint,text,integer,integer)','EXECUTE') as ok;
-- select count(*) >= 0 as ok from public.armory_guild_directory(null,null,null,'members',1,0);
-- Rollback:
-- drop function if exists public.armory_guild_directory(text, text, smallint, text, integer, integer);
-- drop index if exists public.armory_characters_guild_directory;
-- notify pgrst, 'reload schema';
82 changes: 82 additions & 0 deletions supabase/tests/armory_guild_directory.sql
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
-- Disposable database with the armory and guilds migrations and the guild directory applied. Invented identities only.
begin;

select public.armory_upsert_characters('us', jsonb_build_array(
jsonb_build_object('slug','arla-quill','character_id',11,'name','Arla','surname','Quill','level',60,'ruleset_id',1,'ruleset','PvP',
'race_id',1,'race','Human','class_id',8,'class','Mage','faction','Alliance','guild_slug','quill-watch','guild_name','Quill Watch','item_level',70,'equipment','[]'::jsonb),
jsonb_build_object('slug','brin-quill','character_id',12,'name','Brin','surname','Quill','level',42,'ruleset_id',1,'ruleset','PvP',
'race_id',1,'race','Human','class_id',1,'class','Warrior','faction','Alliance','guild_slug','quill-watch','guild_name','Quill Watch','item_level',50,'equipment','[]'::jsonb),
jsonb_build_object('slug','cass-quill','character_id',13,'name','Cass','surname','Quill','level',60,'ruleset_id',1,'ruleset','PvP',
'race_id',1,'race','Human','class_id',5,'class','Priest','faction','Alliance','guild_slug','quill-watch','guild_name','Quill Watch','item_level',90,'equipment','[]'::jsonb),
jsonb_build_object('slug','dorn-mire','character_id',14,'name','Dorn','surname','Mire','level',60,'ruleset_id',1,'ruleset','PvP',
'race_id',2,'race','Orc','class_id',3,'class','Hunter','faction','Horde','guild_slug','mire-band','guild_name','Mire Band','item_level',85,'equipment','[]'::jsonb),
jsonb_build_object('slug','erra-mire','character_id',15,'name','Erra','surname','Mire','level',60,'ruleset_id',1,'ruleset','PvP',
'race_id',2,'race','Orc','class_id',3,'class','Hunter','faction','Horde','guild_slug','mire-band','guild_name','Mire Band','item_level',85,'equipment','[]'::jsonb)
));
select public.armory_upsert_characters('eu', jsonb_build_array(
jsonb_build_object('slug','fenn-quay','character_id',21,'name','Fenn','surname','Quay','level',30,'ruleset_id',2,'ruleset','Normal',
'race_id',1,'race','Human','class_id',2,'class','Paladin','faction','Alliance','guild_slug','quay-hall','guild_name','Quay Hall','equipment','[]'::jsonb)
));
select public.armory_upsert_guild('us','{"slug":"quill-watch","guild_id":1,"name":"Quill Watch","faction":"Alliance","ruleset_id":1,"ruleset":"PvP","member_count":40}','[]');
select public.armory_upsert_guild('us','{"slug":"mire-band","guild_id":2,"name":"Mire Band","faction":"Horde","ruleset_id":1,"ruleset":"PvP","member_count":9}','[]');
select public.armory_upsert_guild('eu','{"slug":"quay-hall","guild_id":3,"name":"Quay Hall","faction":"Alliance","ruleset_id":2,"ruleset":"Normal","member_count":5}','[]');
select public.armory_upsert_guild('eu','{"slug":"quiet-few","guild_id":4,"name":"Quiet Few","faction":"Horde","ruleset_id":2,"ruleset":"Normal","member_count":2}','[]');

do $$
declare r record;
begin
-- Default sort: characters read, then name. A guild with none read is still listed, with zeros and no average.
if (select array_agg(slug order by ordinality) from (select slug, row_number() over() as ordinality
from public.armory_guild_directory(null,null,null,'members',10,0)) x) <> array['quill-watch','mire-band','quay-hall','quiet-few'] then
raise exception 'members order';
end if;
select * into r from public.armory_guild_directory(null,'us',null,'members',10,0) where slug='quill-watch';
if r.members_read<>3 or r.level_60<>2 or r.average_item_level<>70.0 or r.member_count<>40 or r.total<>2 or r.fetched_at is null then
raise exception 'quill counts %', r;
end if;
select * into r from public.armory_guild_directory(null,'eu',null,'members',10,0) where slug='quiet-few';
if r.members_read<>0 or r.level_60<>0 or r.average_item_level is not null then raise exception 'empty guild %', r; end if;
-- Item level: highest average first; a guild with no item level read sorts last.
if (select slug from public.armory_guild_directory(null,null,null,'item_level',1,0))<>'mire-band' then raise exception 'item level sort'; end if;
if (select slug from public.armory_guild_directory(null,null,null,'item_level',1,3)) not in ('quay-hall','quiet-few') then raise exception 'item level nulls last'; end if;
-- Level 60 count, with characters read breaking the tie (2 and 2: Quill Watch has 3 read).
if (select slug from public.armory_guild_directory(null,null,null,'level_60',1,0))<>'quill-watch' then raise exception 'level 60 sort'; end if;
-- Filters and paging.
if (select count(*) from public.armory_guild_directory(null,null,2::smallint,'members',10,0))<>2 then raise exception 'ruleset filter'; end if;
if (select count(*) from public.armory_guild_directory('Qu',null,null,'members',10,0))<>3 then raise exception 'prefix'; end if;
if (select count(*) from public.armory_guild_directory('qUi',null,null,'members',10,0))<>2 then raise exception 'prefix case'; end if;
if exists(select 1 from public.armory_guild_directory('Q',null,null,'members',10,0)) then raise exception 'one-letter prefix'; end if;
if exists(select 1 from public.armory_guild_directory('Q%',null,null,'members',10,0)) then raise exception 'wildcard prefix'; end if;
if (select array_agg(slug) from public.armory_guild_directory(null,null,null,'members',2,2)) <> array['quay-hall','quiet-few'] then raise exception 'page 2'; end if;
if (select min(total) from public.armory_guild_directory(null,null,null,'members',2,2))<>4 then raise exception 'total on a later page'; end if;
if (select count(*) from public.armory_guild_directory(null,null,null,'members',500,0))<>4 then raise exception 'limit cap'; end if;
end $$;

-- A hidden character leaves every count at once.
select public.armory_hide('us','cass-quill');
do $$
declare r record;
begin
select * into r from public.armory_guild_directory(null,'us',null,'members',10,0) where slug='quill-watch';
if r.members_read<>2 or r.level_60<>1 or r.average_item_level<>60.0 then raise exception 'hidden member counted %', r; end if;
end $$;

-- A guild hide on a US realm hides the US guild of that name, not an EU one.
insert into public.guild_suppressions(realm_key,guild_key) values('camwow us1 realm 4 pvp','mire band');
insert into public.guild_suppressions(realm_key,guild_key) values('camwow us1 realm 2 normal','quay hall');
do $$
begin
if exists(select 1 from public.armory_guild_directory(null,null,null,'members',10,0) where slug='mire-band') then raise exception 'hidden guild listed'; end if;
if not exists(select 1 from public.armory_guild_directory(null,null,null,'members',10,0) where slug='quay-hall') then raise exception 'hide crossed regions'; end if;
if (select min(total) from public.armory_guild_directory(null,null,null,'members',10,0))<>3 then raise exception 'total with a hidden guild'; end if;
end $$;

do $$
declare f text := 'public.armory_guild_directory(text,text,smallint,text,integer,integer)';
begin
if has_function_privilege('anon',f,'EXECUTE') or has_function_privilege('authenticated',f,'EXECUTE') then raise exception 'public directory access'; end if;
if not has_function_privilege('service_role',f,'EXECUTE') then raise exception 'missing server directory access'; end if;
if not (select prosecdef and proconfig @> array['search_path=""','lock_timeout=3s'] from pg_proc where oid=f::regprocedure) then raise exception 'unsafe function'; end if;
if to_regclass('public.armory_characters_guild_directory') is null then raise exception 'missing index'; end if;
end $$;
rollback;
Loading
Loading