discourse/app/services/flags/destroy_flag.rb
Loïc Guitaut 41584ab40c DEV: Provide user input to services using params key
Currently in services, we don’t make a distinction between input
parameters, options and dependencies.

This can lead to user input modifying the service behavior, whereas it
was not the developer intention.

This patch addresses the issue by changing how data is provided to
services:
- `params` is now used to hold all data coming from outside (typically
  user input from a controller) and a contract will take its values from
  `params`.
- `options` is a new key to provide options to a service. This typically
  allows changing a service behavior at runtime. It is, of course,
  totally optional.
- `dependencies` is actually anything else provided to the service (like
  `guardian`) and available directly from the context object.

The `service_params` helper in controllers has been updated to reflect
those changes, so most of the existing services didn’t need specific
changes.

The options block has the same DSL as contracts, as it’s also based on
`ActiveModel`. There aren’t any validations, though. Here’s an example:
```ruby
options do
  attribute :allow_changing_hidden, :boolean, default: false
end
```
And here’s an example of how to call a service with the new keys:
```ruby
MyService.call(params: { key1: value1, … }, options: { my_option: true }, guardian:, …)
```
2024-10-25 09:57:59 +02:00

44 lines
694 B
Ruby

# frozen_string_literal: true
class Flags::DestroyFlag
include Service::Base
model :flag
policy :not_system
policy :not_used
policy :invalid_access
transaction do
step :destroy
step :log
end
private
def fetch_flag(params:)
Flag.find_by(id: params[:id])
end
def not_system(flag:)
!flag.system?
end
def not_used(flag:)
!flag.used?
end
def invalid_access(guardian:, flag:)
guardian.can_edit_flag?(flag)
end
def destroy(flag:)
flag.destroy!
end
def log(guardian:, flag:)
StaffActionLogger.new(guardian.user).log_custom(
"delete_flag",
flag.slice(:name, :description, :applies_to, :enabled),
)
end
end