Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Coverage report not showing certain content #98

Open
wexxlee opened this issue Mar 15, 2024 · 8 comments
Open

Coverage report not showing certain content #98

wexxlee opened this issue Mar 15, 2024 · 8 comments
Labels
enhancement New feature or change to existing functionality fix-me Bug report validated or feature request planned help wanted No one working on this yet - PRs welcome!

Comments

@wexxlee
Copy link
Collaborator

wexxlee commented Mar 15, 2024

https://overlayplugin.github.io/cactbot/util/coverage/coverage.html

Does not currently show Eureka/Bozja (including BA, CLL, DR/DRS, etc.), deep dungeons, hunts, or treasure map dungeons. Could/should probably add those for completeness.

@wexxlee wexxlee added enhancement New feature or change to existing functionality help wanted No one working on this yet - PRs welcome! fix-me Bug report validated or feature request planned labels Mar 15, 2024
@wexxlee
Copy link
Collaborator Author

wexxlee commented Apr 3, 2024

Adding ref to prior comment about this in quisquous#5069

@xiashtra
Copy link
Collaborator

Masked Carnivale could be included here as well.

@valarnin
Copy link
Collaborator

Would it make sense to add a secondary pass through timelines and triggers, collecting anything not already represented by the pre-built tables, and print those under an Other category at the end maybe?

@xiashtra
Copy link
Collaborator

It might get excessively long; just the Deep Dungeon trigger sets are going to add 40 entries alone. There might also be a desire to add more free-form annotations to some entries; for instance, because of how the zone works, all of the Masked Carnivale stages are lumped into one file, whereas it might be nice to list exactly which stages are supported.

@valarnin
Copy link
Collaborator

Perhaps a new optional property on TriggerSet which can be used to add new entries to coverage?

(I'm just spitballing ideas right now)

@xiashtra
Copy link
Collaborator

xiashtra commented Jun 10, 2024

Would it make sense to add a secondary pass through timelines and triggers, collecting anything not already represented by the pre-built tables, and print those under an Other category at the end maybe?

Maybe this is an idea to start with, to see what the output looks like, and get an idea if anything needs to change to make it more useable.

We could start with an Other main category with sub categories based on the entries in

cactbot/ui/config/config.ts

Lines 132 to 214 in 079eb89

// Translating data subfolders to encounter type.
const kDirectoryToCategory = {
alliance: {
en: 'Alliance Raid',
de: 'Allianz-Raid',
fr: 'Raid en Alliance',
ja: 'アライアンスレイド',
cn: '团队任务',
ko: '연합 레이드',
},
dungeon: {
en: 'Dungeon',
de: 'Dungeon',
fr: 'Donjon',
ja: 'ダンジョン',
cn: '迷宫挑战',
ko: '던전',
},
eureka: {
en: 'Adventuring Forays',
de: 'Feldexkursion',
fr: 'Missions d\'exploration',
ja: '特殊フィールド探索',
cn: '特殊场景探索',
ko: '특수 필드 임무',
},
raid: {
en: 'Raid',
de: 'Raid',
fr: 'Raid',
ja: 'レイド',
cn: '大型任务',
ko: '레이드',
},
pvp: {
en: 'PVP',
de: 'PvP',
fr: 'JcJ',
ja: 'PvP',
cn: 'PvP',
ko: 'PvP',
},
trial: {
en: 'Trial',
de: 'Prüfung',
fr: 'Défi',
ja: '討伐・討滅戦',
cn: '讨伐歼灭战',
ko: '토벌전',
},
ultimate: {
en: 'Ultimate',
de: 'Fatale Raids',
fr: 'Raid fatal',
ja: '絶シリーズ',
cn: '绝境战',
ko: '절 난이도',
},
hunts: {
en: 'Hunts & FATEs',
de: 'Hohe Jagd & FATEs',
fr: 'Chasse & Aléas',
ja: 'モブハント & フェイト',
cn: '怪物狩猎 & 危命任务',
ko: '마물 & 돌발',
},
map: {
en: 'Treasure Map',
de: 'Schatzkarten',
fr: 'Cartes au trésor',
ja: '宝箱地図',
cn: '宝物地图',
ko: '보물 지도',
},
deepdungeon: {
en: 'Deep Dungeon',
de: 'Tiefes Gewölbe',
fr: 'Donjon sans fond',
ja: 'ディープダンジョン',
cn: '深层迷宫',
ko: '딥 던전',
},
};
(to match the config UI).

I could see possibly extending the output to give more detailed information on say, which Critical Engagements are/are not covered in the Bozja areas (for instance), but at some point we start to exceed the limits of reasonable automation and drift into manually updated entries.

@wexxlee
Copy link
Collaborator Author

wexxlee commented Jun 10, 2024

Would it make sense to add a secondary pass through timelines and triggers, collecting anything not already represented by the pre-built tables, and print those under an Other category at the end maybe?

Maybe this is an idea to start with, to see what the output looks like, and get an idea if anything needs to change to make it more useable.

Yeah, this makes sense to me.

Perhaps a new optional property on TriggerSet which can be used to add new entries to coverage?

I think this would be an elegant way to override default handling in the "Other" category - like suppressing it from the list, changing its subcategory, changing its listed name, etc. Probably, as xiashtra says, something to do after we do a pass and see how fugly the unmodified output is, but this seems like the right approach, at least for triggers/oopsy coverage.

For timelines, I don't think (?) there's any timelines that don't have corresponding triggers, so we could probably base it on the triggerSet props for the trigger file? (I could be wrong about that, but I'm in between meetings and can't check rn.)

(Sort of tangential and probably a separate PR?, but I think it'd be worth a little UX touchup on the coverage report. There's probably a better way to display the content -- at a minimum, with some filters at the top so it isn't always necessary to scroll through a massive list with no section headers.)

@valarnin
Copy link
Collaborator

For timelines, I don't think (?) there's any timelines that don't have corresponding triggers, so we could probably base it on the triggerSet props for the trigger file? (I could be wrong about that, but I'm in between meetings and can't check rn.)

It's impossible to have a timeline load without a corresponding triggerset file, but that triggerset file could have 0 triggers in it. (ab)using raidemulator's exposure of the full cactbot data model via console shows that there is one fight with 0 triggers, and plenty of fights with just one trigger.

image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or change to existing functionality fix-me Bug report validated or feature request planned help wanted No one working on this yet - PRs welcome!
Projects
None yet
Development

No branches or pull requests

3 participants