* 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
132 lines
4.3 KiB
Ruby
132 lines
4.3 KiB
Ruby
# frozen_string_literal: true
|
|
|
|
module Api
|
|
module V1
|
|
class ApiController < ActionController::API
|
|
##### Doorkeeper
|
|
include Doorkeeper::Rails::Helpers
|
|
|
|
##### Constants
|
|
COLLECTION_PER_PAGE = 15
|
|
SEARCH_PER_PAGE = 10
|
|
|
|
##### Errors
|
|
rescue_from ActiveRecord::RecordInvalid, with: :render_unprocessable_entity_response
|
|
rescue_from ActiveRecord::RecordNotDestroyed, with: :render_unprocessable_entity_response
|
|
rescue_from ActiveRecord::RecordNotFound, with: :render_not_found_response_without_object
|
|
rescue_from ActiveRecord::RecordNotSaved, with: :render_unprocessable_entity_response
|
|
rescue_from ActiveRecord::RecordNotUnique, with: :render_unprocessable_entity_response
|
|
rescue_from Api::V1::SameFavoriteUserError, with: :render_unprocessable_entity_response
|
|
rescue_from Api::V1::FavoriteAlreadyExistsError, with: :render_unprocessable_entity_response
|
|
rescue_from Api::V1::NoJobProvidedError, with: :render_unprocessable_entity_response
|
|
rescue_from Api::V1::TooManySkillsOfTypeError, with: :render_unprocessable_entity_response
|
|
rescue_from Api::V1::IncompatibleWeaponForPositionError, with: :render_unprocessable_entity_response
|
|
rescue_from Api::V1::UnauthorizedError, with: :render_unauthorized_response
|
|
rescue_from ActionController::ParameterMissing, with: :render_unprocessable_entity_response
|
|
|
|
rescue_from GranblueError do |e|
|
|
render_error(e)
|
|
end
|
|
|
|
##### Hooks
|
|
before_action :current_user
|
|
before_action :default_content_type
|
|
around_action :n_plus_one_detection, unless: -> { Rails.env.production? }
|
|
|
|
##### Responders
|
|
respond_to :json
|
|
|
|
##### Methods
|
|
# Returns the latest update
|
|
def version
|
|
render json: UpdateBlueprint.render_as_json(AppUpdate.last)
|
|
end
|
|
|
|
# Assign the current user if the Doorkeeper token isn't nil, then
|
|
# update the current user's last seen datetime and last IP address
|
|
# before returning
|
|
def current_user
|
|
@current_user ||= User.find(doorkeeper_token.resource_owner_id) if doorkeeper_token
|
|
|
|
@current_user
|
|
end
|
|
|
|
def admin_mode
|
|
if current_user&.admin? && request.headers['X-Admin-Mode']
|
|
@admin_mode ||= request.headers['X-Admin-Mode'] == 'true'
|
|
end
|
|
|
|
@admin_mode
|
|
end
|
|
|
|
def edit_key
|
|
@edit_key ||= request.headers['X-Edit-Key'] if request.headers['X-Edit-Key']
|
|
|
|
@edit_key
|
|
end
|
|
|
|
# Set the response content-type
|
|
def content_type(content_type)
|
|
response.headers['Content-Type'] = content_type
|
|
end
|
|
|
|
# Set the default response content-type to application/javascript
|
|
# with a UTF-8 charset
|
|
def default_content_type
|
|
content_type('application/javascript; charset=utf-8')
|
|
end
|
|
|
|
### Error response methods
|
|
def render_error(error)
|
|
if error
|
|
render action: 'errors', json: error.to_hash, status: error.http_status
|
|
else
|
|
render action: 'errors'
|
|
end
|
|
end
|
|
|
|
def render_unprocessable_entity_response(exception)
|
|
render json: ErrorBlueprint.render_as_json(nil, exception: exception),
|
|
status: :unprocessable_entity
|
|
end
|
|
|
|
def render_validation_error_response(object)
|
|
render json: ErrorBlueprint.render_as_json(nil, errors: object.errors),
|
|
status: :unprocessable_entity
|
|
end
|
|
|
|
def render_not_found_response_without_object
|
|
render json: ErrorBlueprint.render(nil,
|
|
error: {
|
|
message: 'Object could not be found',
|
|
code: 'not_found'
|
|
}), status: :not_found
|
|
end
|
|
|
|
def render_not_found_response(object)
|
|
render json: ErrorBlueprint.render(nil, error: {
|
|
message: "#{object.capitalize} could not be found",
|
|
code: 'not_found'
|
|
}), status: :not_found
|
|
end
|
|
|
|
def render_unauthorized_response
|
|
render json: ErrorBlueprint.render_as_json(nil),
|
|
status: :unauthorized
|
|
end
|
|
|
|
private
|
|
|
|
def restrict_access
|
|
raise UnauthorizedError unless current_user
|
|
end
|
|
|
|
def n_plus_one_detection
|
|
Prosopite.scan
|
|
yield
|
|
ensure
|
|
Prosopite.finish
|
|
end
|
|
end
|
|
end
|
|
end
|