hensei-api/sig/api/v1/parties_controller.rbs
Justin Edmund 6cf11e6517
Jedmund/fix image embeds 4 (#177)
* Update gitignore

There is a mystery postgres folder and we are going to ignore it

* Add migrations

* Update preview state default to pending
* Adds indexes
* Adds PgHero and PgStatements

* Update .gitignore

* Update Gemfile

Production:
- `newrelic_rpm`

Development:
- `pg_query`
- `prosopite`

* Configure Sidekiq

Create job for cleaning up party previews

* Configure Prosopite and remove CacheFreeLogger

* Enable query logging

* Update api_controller.rb

Add N+1 detectioin via Prosopite in development/test environments

* Refactor canonical object blueprints

* Refactor grid object blueprints

* Remove N+1 from grid object models

Reimplementing `character` `summon` and `weapon` was making N+1s which made queries really slow

* Add counter caches to party

* Add preview generation helpers

The Party model can respond to queries about its preview state with the following models:
- `schedule_preview_generation`
- `preview_content_changed?`
- `preview_expired?`
- `should_generate_preview?`
- `ready_for_preview?`
- `needs_preview_generation?`
- `preview_relevant_attributes`

Removes the following methods:
- `schedule_preview_regeneration`
- `preview_relevant_changes?`

* Add cache to is_favorited(user)

* Refactored PartyBlueprint to minimize N+1s

* Remove preview expiry constants

These are defined in the Coordinator instead

* Add method comments

* Create parties_controller.rbs

* Update logic and logs

* Updates excluded methods and calculate_count

* Use `includes` instead of `joins`
* Use a less-insane way of counting

* Adds a helper method for party privacy

* Update filter condition helpers

Just minor refactoring

* Fix old view name in PartyBlueprint

* Refactor parties#create

* Remove redundant return

* Update parties_controller.rbs

* Update parties#index

* Update parties_controller.rb

Updates apply_includes and apply_excludes, along with modifying id_to_table and build_query

* Update parties_controller.rb

Adds the rest of the changes, too tired to write them all out. Some preview generation, some filtering

* Refactor parties#index and parties#favorites

These are mostly the same methods, so we remove common code into build_parties_query and render_paginated_parties

* Alias table name to object to maintain API consistency

* Maintain API consistency with raid blueprint

* Optimize party loading by adding eager loading to `set_from_slug`

- Refactored `set_from_slug` to use `includes` for eager loading associated models:
  - `user`, `job`, `raid` (with `group`)
  - `characters` (with `character` and `awakening`)
  - `weapons` (with `weapon`, `awakenings`, `weapon_key1`, `weapon_key2`, `weapon_key3`)
  - `summons` (with `summon`)
  - `guidebooks` (`guidebook1`, `guidebook2`, `guidebook3`)
  - `source_party`, `remixes`, `skills`, and `accessory`
- This change improves query efficiency by reducing N+1 queries and ensures all relevant associations are preloaded.
- Removed redundant favorite check as it was not necessary in this context.

* Refactor grid blueprints

- **GridCharacterBlueprint:**
  - Removed `:minimal` view restriction on `party` association.
  - Improved nil checks for `ring1`, `ring2`, and `earring` to prevent errors.
  - Converted string values in `awakening_level`, `over_mastery`, and `aetherial_mastery` fields to integers for consistency.
  - Ensured `over_mastery` and `aetherial_mastery` only include valid entries, filtering out blank or zero-modifier values.

- **GridWeaponBlueprint:**
  - Removed `:minimal` view restriction on `party` association.
  - Ensured `weapon` association exists before accessing `ax`, `series`, or `awakening`.
  - Improved conditional checks for `weapon_keys` to prevent errors when `weapon` or `series` is nil.
  - Converted `awakening_level` field to integer for consistency.

- **GridCharacterBlueprint:**
  - Removed `:minimal` view restriction on `party` association.

* Update raid blueprints

- Show flat representation of raid group in RaidBlueprint's nested view
- Show nested representation of raid in RaidGroupBlueprint's full view

* Move n+1 detection to around_action hook

* Improve handling mastery bonuses

- Improved handling of nested attributes:
  - Replaced old mastery structure with new `rings` and `awakening` assignments.
  - Added `new_rings` and `new_awakening` virtual attributes for easier updates.
  - Updated `assign_attributes` to exclude `rings` and `awakening` to prevent conflicts.

- Enhanced parameter transformation:
  - Introduced `transform_character_params` to process `rings`, `awakening`, and `earring` more reliably.
  - Ensured proper type conversion (`to_i`) for numeric values in `uncap_level`, `transcendence_step`, and `awakening_level`.
  - Improved error handling for missing values by setting defaults where needed.

- Optimized database queries:
  - Added `.includes(:awakening)` to `set` to prevent N+1 query issues.

- Updated strong parameters:
  - Changed `rings` from individual keys (`ring1`, `ring2`, etc.) to a structured array format.
  - Refactored permitted attributes to align with the new nested structure.

* Eager-load jobs when querying job skills

* Eager load raids/groups when querying

* Update users_controller.rb

More efficient way of denoting favorited parties.

* Update awakening.rb

- Removes explicitly defined associations and adds ActiveRecord associations instead

* Update party.rb

- Removes favorited accessor
- Renames derivative_parties to remixes and adds in-built sort

* Update weapon_awakening.rb

- Removes redefined explicit associations

* Update grid_character.rb

- Adds code transforming incoming ring and awakening values into something the db understands

* Update character.rb

Add explicit Awakenings enum

* Update coordinator.rb

Adds 'queued' as a state for generation
2025-02-09 22:50:18 -08:00

111 lines
2.8 KiB
Text

module Api
module V1
class PartiesController < Api::V1::ApiController
@parties: ActiveRecord::Relation[Party]
MAX_CHARACTERS: Integer
MAX_SUMMONS: Integer
MAX_WEAPONS: Integer
DEFAULT_MIN_CHARACTERS: Integer
DEFAULT_MIN_SUMMONS: Integer
DEFAULT_MIN_WEAPONS: Integer
DEFAULT_MAX_CLEAR_TIME: Integer
def create: () -> void
def show: () -> void
def update: () -> void
def destroy: () -> void
def remix: () -> void
def index: () -> void
def favorites: () -> void
def preview: () -> void
def preview_status: () -> void
def regenerate_preview: () -> void
private
def authorize: () -> void
def grid_table_and_object_table: (String) -> [String?, String?]
def not_owner: () -> bool
def schedule_preview_generation: () -> void
def apply_filters: (ActiveRecord::Relation[Party]) -> ActiveRecord::Relation[Party]
def apply_privacy_settings: (ActiveRecord::Relation[Party]) -> ActiveRecord::Relation[Party]
def apply_includes: (ActiveRecord::Relation[Party], String) -> ActiveRecord::Relation[Party]
def apply_excludes: (ActiveRecord::Relation[Party], String) -> ActiveRecord::Relation[Party]
def build_filters: () -> Hash[Symbol, untyped]
def build_date_range: () -> Range[DateTime]?
def build_start_time: (String?) -> DateTime?
def build_count: (String?, Integer) -> Integer
def build_max_clear_time: (String?) -> Integer
def build_element: (String?) -> Integer?
def build_option: (String?) -> Integer?
def build_query: (Hash[Symbol, untyped], bool) -> ActiveRecord::Relation[Party]
def fetch_parties: (ActiveRecord::Relation[Party]) -> ActiveRecord::Relation[Party]
def calculate_count: (ActiveRecord::Relation[Party]) -> Integer
def calculate_total_pages: (Integer) -> Integer
def paginate_parties: (
ActiveRecord::Relation[Party],
?page: Integer?,
?per_page: Integer
) -> ActiveRecord::Relation[Party]
def excluded_characters: () -> ActiveRecord::Relation[GridCharacter]?
def excluded_summons: () -> ActiveRecord::Relation[GridSummon]?
def excluded_weapons: () -> ActiveRecord::Relation[GridWeapon]?
def render_party_json: (ActiveRecord::Relation[Party]) -> void
def privacy: (?favorites: bool) -> String?
def user_quality: () -> String?
def name_quality: () -> String?
def original: () -> String?
def includes: (String) -> String
def excludes: (String) -> String
def id_to_table: (String) -> String
def remixed_name: (String) -> String
def set_from_slug: () -> void
def set: () -> void
def party_params: () -> Hash[Symbol, untyped]?
end
end
end