mirror of
https://github.com/discourse/discourse.git
synced 2024-12-21 21:24:01 +08:00
41584ab40c
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:, …)
```
91 lines
2.9 KiB
Ruby
91 lines
2.9 KiB
Ruby
# frozen_string_literal: true
|
|
|
|
RSpec.describe(Flags::CreateFlag) do
|
|
describe described_class::Contract, type: :model do
|
|
it { is_expected.to validate_presence_of(:name) }
|
|
it { is_expected.to validate_presence_of(:description) }
|
|
it { is_expected.to validate_length_of(:name).is_at_most(Flag::MAX_NAME_LENGTH) }
|
|
it { is_expected.to validate_length_of(:description).is_at_most(Flag::MAX_DESCRIPTION_LENGTH) }
|
|
it { is_expected.to validate_inclusion_of(:applies_to).in_array(Flag.valid_applies_to_types) }
|
|
end
|
|
|
|
describe ".call" do
|
|
subject(:result) { described_class.call(params:, **dependencies) }
|
|
|
|
fab!(:current_user) { Fabricate(:admin) }
|
|
|
|
let(:params) do
|
|
{ name:, description:, applies_to:, require_message:, enabled:, auto_action_type: }
|
|
end
|
|
let(:dependencies) { { guardian: current_user.guardian } }
|
|
let(:name) { "custom flag name" }
|
|
let(:description) { "custom flag description" }
|
|
let(:applies_to) { ["Topic"] }
|
|
let(:enabled) { true }
|
|
let(:require_message) { true }
|
|
let(:auto_action_type) { true }
|
|
|
|
context "when user is not allowed to perform the action" do
|
|
fab!(:current_user) { Fabricate(:user) }
|
|
|
|
it { is_expected.to fail_a_policy(:invalid_access) }
|
|
end
|
|
|
|
context "when contract is invalid" do
|
|
let(:name) { nil }
|
|
|
|
it { is_expected.to fail_a_contract }
|
|
end
|
|
|
|
context "when name is not unique" do
|
|
let!(:flag) { Fabricate(:flag, name:) }
|
|
|
|
# DO NOT REMOVE: flags have side effects and their state will leak to
|
|
# other examples otherwise.
|
|
after { flag.destroy! }
|
|
|
|
it { is_expected.to fail_a_policy(:unique_name) }
|
|
end
|
|
|
|
context "when everything's ok" do
|
|
let(:applies_to) { ["Topic::Custom"] }
|
|
let(:flag) { Flag.last }
|
|
|
|
before do
|
|
DiscoursePluginRegistry.register_flag_applies_to_type(
|
|
"Topic::Custom",
|
|
OpenStruct.new(enabled?: true),
|
|
)
|
|
end
|
|
|
|
# DO NOT REMOVE: flags have side effects and their state will leak to
|
|
# other examples otherwise.
|
|
after { flag.destroy! }
|
|
|
|
it { is_expected.to run_successfully }
|
|
|
|
it "creates the flag" do
|
|
expect { result }.to change { Flag.count }.by(1)
|
|
expect(flag).to have_attributes(
|
|
name: "custom flag name",
|
|
description: "custom flag description",
|
|
applies_to: ["Topic::Custom"],
|
|
require_message: true,
|
|
enabled: true,
|
|
notify_type: true,
|
|
auto_action_type: true,
|
|
)
|
|
end
|
|
|
|
it "logs the action" do
|
|
expect { result }.to change { UserHistory.count }.by(1)
|
|
expect(UserHistory.last).to have_attributes(
|
|
custom_type: "create_flag",
|
|
details:
|
|
"name: custom flag name\ndescription: custom flag description\napplies_to: [\"Topic::Custom\"]\nrequire_message: true\nenabled: true",
|
|
)
|
|
end
|
|
end
|
|
end
|
|
end
|