Commit 63ab7c0f authored by Sean McGivern's avatar Sean McGivern

Merge branch 'feature/#37403-clearer-email-handler' into 'master'

Make email handler clearer

Closes #37403

See merge request gitlab-org/gitlab-ce!17501
parents a2a6a5ca f68aab19
...@@ -74,6 +74,24 @@ See the [Rails guides] for more info. ...@@ -74,6 +74,24 @@ See the [Rails guides] for more info.
1. Reply by email should now be working. 1. Reply by email should now be working.
## Email namespace
If you need to implement a new feature which requires a new email handler, follow these rules:
- You must choose a namespace. The namespace cannot contain `/` or `+`, and cannot match `\h{16}`.
- If your feature is related to a project, you will append the namespace **after** the project path, separated by a `+`
- If you have different actions in the namespace, you add the actions **after** the namespace separated by a `+`. The action name cannot contain `/` or `+`, , and cannot match `\h{16}`.
- You will register your handlers in `lib/gitlab/email/handler.rb`
Therefore, these are the only valid formats for an email handler:
- `path/to/project+namespace`
- `path/to/project+namespace+action`
- `namespace`
- `namespace+action`
Please note that `path/to/project` is used in GitLab Premium as handler for the Service Desk feature.
--- ---
[Return to Development documentation](README.md) [Return to Development documentation](README.md)
...@@ -14,7 +14,7 @@ module Gitlab ...@@ -14,7 +14,7 @@ module Gitlab
end end
def can_handle? def can_handle?
!incoming_email_token.nil? !incoming_email_token.nil? && !incoming_email_token.include?("+") && !mail_key.include?(Gitlab::IncomingEmail::UNSUBSCRIBE_SUFFIX)
end end
def execute def execute
......
...@@ -14,4 +14,28 @@ describe Gitlab::Email::Handler do ...@@ -14,4 +14,28 @@ describe Gitlab::Email::Handler do
expect(described_class.for('email', '')).to be_nil expect(described_class.for('email', '')).to be_nil
end end
end end
describe 'regexps are set properly' do
let(:addresses) do
%W(sent_notification_key#{Gitlab::IncomingEmail::UNSUBSCRIBE_SUFFIX} sent_notification_key path/to/project+merge-request+user_email_token path/to/project+user_email_token)
end
it 'picks each handler at least once' do
matched_handlers = addresses.map do |address|
described_class.for('email', address).class
end
expect(matched_handlers.uniq).to match_array(Gitlab::Email::Handler::HANDLERS)
end
it 'can pick exactly one handler for each address' do
addresses.each do |address|
matched_handlers = Gitlab::Email::Handler::HANDLERS.select do |handler|
handler.new('email', address).can_handle?
end
expect(matched_handlers.count).to eq(1), "#{address} matches #{matched_handlers.count} handlers: #{matched_handlers}"
end
end
end
end end
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment