Skip to content

A platform for community discussion. Free, open, simple.

FEATURE: Support OAuth authentication in Zendesk plugin (#42998)

Alan Guo Xiang Tanbaff45fe1831
diff --git a/plugins/discourse-zendesk-plugin/app/jobs/regular/zendesk_job.rb b/plugins/discourse-zendesk-plugin/app/jobs/regular/zendesk_job.rb
index 64334cdff2b..d56ccce8213 100644
--- a/plugins/discourse-zendesk-plugin/app/jobs/regular/zendesk_job.rb
+++ b/plugins/discourse-zendesk-plugin/app/jobs/regular/zendesk_job.rb
@@ -7,7 +7,7 @@ module Jobs
def execute(args)
return unless SiteSetting.zendesk_enabled?
- return if SiteSetting.zendesk_jobs_email.blank? || SiteSetting.zendesk_jobs_api_token.blank?
+ return unless DiscourseZendeskPlugin::Helper.configured?
if args[:post_id].present?
push_post!(args[:post_id])
diff --git a/plugins/discourse-zendesk-plugin/app/services/problem_check/zendesk_api_token_deprecation.rb b/plugins/discourse-zendesk-plugin/app/services/problem_check/zendesk_api_token_deprecation.rb
new file mode 100644
index 00000000000..4d6e256064a
--- /dev/null
+++ b/plugins/discourse-zendesk-plugin/app/services/problem_check/zendesk_api_token_deprecation.rb
@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+class ProblemCheck::ZendeskApiTokenDeprecation < ProblemCheck
+ self.priority = "low"
+
+ def call
+ return no_problem if !SiteSetting.zendesk_enabled?
+ return no_problem if !DiscourseZendeskPlugin::Helper.api_token_configured?
+ return no_problem if DiscourseZendeskPlugin::Helper.oauth_configured?
+
+ problem
+ end
+end
diff --git a/plugins/discourse-zendesk-plugin/config/locales/server.en.yml b/plugins/discourse-zendesk-plugin/config/locales/server.en.yml
new file mode 100644
index 00000000000..9b81331c886
--- /dev/null
+++ b/plugins/discourse-zendesk-plugin/config/locales/server.en.yml
@@ -0,0 +1,8 @@
+en:
+ site_settings:
+ zendesk_jobs_api_token: "Deprecated: Zendesk will permanently deactivate API tokens on April 30, 2027. Configure {{setting:zendesk_oauth_client_id}} and {{setting:zendesk_oauth_client_secret}} to use OAuth instead."
+ zendesk_oauth_client_id: "The unique client ID provided by your Zendesk application, used for the authentication process."
+ zendesk_oauth_client_secret: "Client secret of your Zendesk application."
+ dashboard:
+ problem:
+ zendesk_api_token_deprecation: "The Discourse Zendesk plugin uses deprecated API token authentication. Configure the <a href='%{base_path}/admin/site_settings/category/all_results?filter=zendesk_oauth'>Zendesk OAuth client ID and client secret settings</a> before April 30, 2027."
diff --git a/plugins/discourse-zendesk-plugin/config/settings.yml b/plugins/discourse-zendesk-plugin/config/settings.yml
index 638d9faa914..fd016bedda0 100644
--- a/plugins/discourse-zendesk-plugin/config/settings.yml
+++ b/plugins/discourse-zendesk-plugin/config/settings.yml
@@ -10,6 +10,11 @@ discourse_zendesk:
secret: true
zendesk_jobs_email:
default: ""
+ zendesk_oauth_client_id:
+ default: ""
+ zendesk_oauth_client_secret:
+ default: ""
+ secret: true
zendesk_autogenerate_all_categories:
default: false
zendesk_autogenerate_categories:
diff --git a/plugins/discourse-zendesk-plugin/lib/discourse_zendesk_plugin/helper.rb b/plugins/discourse-zendesk-plugin/lib/discourse_zendesk_plugin/helper.rb
index b573a97f9a5..8a9bf32f76e 100644
--- a/plugins/discourse-zendesk-plugin/lib/discourse_zendesk_plugin/helper.rb
+++ b/plugins/discourse-zendesk-plugin/lib/discourse_zendesk_plugin/helper.rb
@@ -1,13 +1,49 @@
# frozen_string_literal: true
module DiscourseZendeskPlugin
+ class InvalidOAuthTokenError < StandardError
+ end
+
module Helper
+ def self.oauth_configured?
+ SiteSetting.zendesk_oauth_client_id.present? &&
+ SiteSetting.zendesk_oauth_client_secret.present?
+ end
+
+ def self.api_token_configured?
+ SiteSetting.zendesk_jobs_email.present? && SiteSetting.zendesk_jobs_api_token.present?
+ end
+
+ def self.configured?
+ oauth_configured? || api_token_configured?
+ end
+
def zendesk_client
- ::ZendeskAPI::Client.new do |config|
- config.url = SiteSetting.zendesk_url
- config.username = SiteSetting.zendesk_jobs_email
- config.token = SiteSetting.zendesk_jobs_api_token
+ oauth_token = DiscourseZendeskPlugin::OAuthToken.new if Helper.oauth_configured?
+ oauth_access_token = oauth_token.access_token if oauth_token
+
+ client =
+ ::ZendeskAPI::Client.new do |config|
+ config.url = SiteSetting.zendesk_url
+
+ if oauth_token
+ config.access_token = oauth_access_token
+ else
+ config.username = SiteSetting.zendesk_jobs_email
+ config.token = SiteSetting.zendesk_jobs_api_token
+ end
+ end
+
+ if oauth_token
+ client.insert_callback do |environment|
+ if invalid_oauth_token_response?(environment)
+ oauth_token.invalidate(oauth_access_token)
+ raise InvalidOAuthTokenError, "Zendesk rejected the OAuth access token"
+ end
+ end
end
+
+ client
end
def self.autogeneration_category?(category_id)
@@ -24,26 +60,28 @@ module DiscourseZendeskPlugin
zendesk_user_id = fetch_submitter(post.user)&.id
if zendesk_user_id.present?
ticket =
- zendesk_client.tickets.create(
- subject: post.topic.title,
- comment: {
- html_body: get_post_content(post),
- },
- requester_id: zendesk_user_id,
- submitter_id: zendesk_user_id,
- priority: "normal",
- tags: SiteSetting.zendesk_tags.split("|"),
- external_id: post.topic.id,
- custom_fields: [
- imported_from: ::Discourse.current_hostname,
+ with_zendesk_client do |client|
+ client.tickets.create!(
+ subject: post.topic.title,
+ comment: {
+ html_body: get_post_content(post),
+ },
+ requester_id: zendesk_user_id,
+ submitter_id: zendesk_user_id,
+ priority: "normal",
+ tags: SiteSetting.zendesk_tags.split("|"),
external_id: post.topic.id,
- imported_by: "discourse_zendesk_plugin",
- ],
- )
+ custom_fields: [
+ imported_from: ::Discourse.current_hostname,
+ external_id: post.topic.id,
+ imported_by: "discourse_zendesk_plugin",
+ ],
+ )
+ end
if ticket.present?
update_topic_custom_fields(post.topic, ticket)
- update_post_custom_fields(post, ticket.comments.first)
+ update_post_custom_fields(post, comment_from_ticket_response(ticket))
end
end
end
@@ -64,19 +102,30 @@ module DiscourseZendeskPlugin
zendesk_user_id = fetch_submitter(post.user)&.id
if zendesk_user_id.present?
- ticket = ZendeskAPI::Ticket.new(zendesk_client, id: ticket_id)
- ticket.comment = { html_body: get_post_content(post), author_id: zendesk_user_id }
- ticket.save
- update_post_custom_fields(post, ticket.comments.last)
+ ticket =
+ with_zendesk_client do |client|
+ ZendeskAPI::Ticket
+ .new(client, id: ticket_id)
+ .tap do |zendesk_ticket|
+ zendesk_ticket.comment = {
+ html_body: get_post_content(post),
+ author_id: zendesk_user_id,
+ }
+ zendesk_ticket.save!
+ end
+ end
+ update_post_custom_fields(post, comment_from_ticket_response(ticket))
end
end
def get_latest_comment(ticket_id)
- ticket = ZendeskAPI::Ticket.new(zendesk_client, id: ticket_id)
- last_public_comment = nil
+ with_zendesk_client do |client|
+ ticket = ZendeskAPI::Ticket.new(client, id: ticket_id)
+ last_public_comment = nil
- ticket.comments.all! { |comment| last_public_comment = comment if comment.public }
- last_public_comment
+ ticket.comments.all! { |comment| last_public_comment = comment if comment.public }
+ last_public_comment
+ end
end
def update_topic_custom_fields(topic, ticket)
@@ -93,14 +142,16 @@ module DiscourseZendeskPlugin
end
def fetch_submitter(user)
- result = zendesk_client.users.search(query: user.email)
+ result = with_zendesk_client { |client| client.users.search(query: user.email).to_a! }
return result.first if result.present? && result.size == 1
- zendesk_client.users.create(
- name: user.name.presence || user.username,
- email: user.email,
- verified: true,
- role: "end-user",
- )
+ with_zendesk_client do |client|
+ client.users.create!(
+ name: user.name.presence || user.username,
+ email: user.email,
+ verified: true,
+ role: "end-user",
+ )
+ end
end
def get_post_content(post)
@@ -111,5 +162,34 @@ module DiscourseZendeskPlugin
"#{html} \n\n [<a href='#{post.full_url}'>Discourse post</a>]"
end
+
+ private
+
+ def comment_from_ticket_response(ticket)
+ ticket.response&.body&.dig("audit", "events")&.find { |event| event["type"] == "Comment" }
+ end
+
+ def invalid_oauth_token_response?(environment)
+ return false if environment[:status] != 401
+
+ body = environment[:body]
+ body = JSON.parse(body) if body.is_a?(String)
+ body.is_a?(Hash) && body["error"] == "invalid_token"
+ rescue JSON::ParserError
+ false
+ end
+
+ def with_zendesk_client
+ attempts = 0
+
+ begin
+ attempts += 1
+ yield zendesk_client
+ rescue InvalidOAuthTokenError
+ raise if attempts >= 2
+
+ retry
+ end
+ end
end
end
diff --git a/plugins/discourse-zendesk-plugin/lib/discourse_zendesk_plugin/oauth_token.rb b/plugins/discourse-zendesk-plugin/lib/discourse_zendesk_plugin/oauth_token.rb
new file mode 100644
index 00000000000..0faa6631a50
--- /dev/null
+++ b/plugins/discourse-zendesk-plugin/lib/discourse_zendesk_plugin/oauth_token.rb
@@ -0,0 +1,109 @@
+# frozen_string_literal: true
+
+module DiscourseZendeskPlugin
+ class OAuthToken
+ INVALIDATE_SCRIPT = DiscourseRedis::EvalHelper.new <<~LUA
+ if redis.call("get", KEYS[1]) == ARGV[1] then
+ return redis.call("del", KEYS[1])
+ end
+
+ return 0
+ LUA
+ private_constant :INVALIDATE_SCRIPT
+
+ EXPIRY_BUFFER_SECONDS = 1.minute.to_i
+ private_constant :EXPIRY_BUFFER_SECONDS
+
+ SCOPES = "tickets:read tickets:write users:read users:write"
+ private_constant :SCOPES
+
+ class RequestError < StandardError
+ end
+
+ class PermanentRequestError < RequestError
+ end
+
+ def initialize
+ @zendesk_url = SiteSetting.zendesk_url
+ @client_id = SiteSetting.zendesk_oauth_client_id
+ @client_secret = SiteSetting.zendesk_oauth_client_secret
+ end
+
+ def access_token
+ Discourse.cache.read(cache_key).presence || request_access_token
+ end
+
+ def invalidate(access_token)
+ INVALIDATE_SCRIPT.eval(
+ Discourse.cache.redis,
+ [Discourse.cache.redis.namespace_key(Discourse.cache.normalize_key(cache_key))],
+ [Marshal.dump(access_token)],
+ )
+ end
+
+ private
+
+ def request_access_token
+ response = http.request(token_request)
+ unless response.is_a?(Net::HTTPSuccess)
+ error_class = permanent_failure?(response) ? PermanentRequestError : RequestError
+ raise error_class, "Zendesk OAuth token request failed"
+ end
+
+ payload = JSON.parse(response.body)
+ access_token = payload["access_token"].presence
+ expires_in_seconds = Integer(payload["expires_in"], exception: false)
+
+ if access_token.blank? || expires_in_seconds.blank? || expires_in_seconds <= 0
+ raise RequestError, "Zendesk OAuth token response is invalid"
+ end
+
+ Discourse.cache.write(
+ cache_key,
+ access_token,
+ expires_in: [expires_in_seconds - EXPIRY_BUFFER_SECONDS, 1].max,
+ )
+ access_token
+ rescue JSON::ParserError
+ raise RequestError, "Zendesk OAuth token response is invalid"
+ end
+
+ def token_request
+ FinalDestination::HTTP::Post
+ .new(token_uri.request_uri)
+ .tap do |request|
+ request.set_form_data(
+ grant_type: "client_credentials",
+ client_id: @client_id,
+ client_secret: @client_secret,
+ scope: SCOPES,
+ )
+ end
+ end
+
+ def http
+ FinalDestination::HTTP.new(token_uri.host, token_uri.port).tap { |http| http.use_ssl = true }
+ end
+
+ def token_uri
+ zendesk_uri = URI.parse(@zendesk_url)
+ unless zendesk_uri.is_a?(URI::HTTPS) && zendesk_uri.host.present?
+ raise PermanentRequestError, "Zendesk OAuth requires an HTTPS URL"
+ end
+
+ URI::HTTPS.build(host: zendesk_uri.host, port: zendesk_uri.port, path: "/oauth/tokens")
+ rescue URI::InvalidURIError
+ raise PermanentRequestError, "Zendesk OAuth requires an HTTPS URL"
+ end
+
+ def cache_key
+ fingerprint = Digest::SHA256.hexdigest([@zendesk_url, @client_id, @client_secret].join("\0"))
+ "discourse-zendesk-oauth-token:#{fingerprint}"
+ end
+
+ def permanent_failure?(response)
+ status = response.code.to_i
+ status.between?(400, 499) && ![408, 429].include?(status)
+ end
+ end
+end
diff --git a/plugins/discourse-zendesk-plugin/plugin.rb b/plugins/discourse-zendesk-plugin/plugin.rb
index 03a12d1dea7..dd3ea87d094 100644
--- a/plugins/discourse-zendesk-plugin/plugin.rb
+++ b/plugins/discourse-zendesk-plugin/plugin.rb
@@ -26,12 +26,16 @@ end
require_relative "lib/discourse_zendesk_plugin/engine"
require_relative "lib/discourse_zendesk_plugin/helper"
+require_relative "lib/discourse_zendesk_plugin/oauth_token"
after_initialize do
require_relative "app/jobs/onceoff/migrate_zendesk_autogenerate_categories_site_settings"
require_relative "app/jobs/regular/zendesk_job"
require_relative "lib/discourse_zendesk_plugin/post_extension"
require_relative "lib/discourse_zendesk_plugin/topic_extension"
+ require_relative "app/services/problem_check/zendesk_api_token_deprecation"
+
+ register_problem_check ProblemCheck::ZendeskApiTokenDeprecation
reloadable_patch do |plugin|
Post.prepend DiscourseZendeskPlugin::PostExtension
@@ -55,7 +59,6 @@ after_initialize do
end
add_to_serializer(:current_user, :discourse_zendesk_plugin_status) do
- SiteSetting.zendesk_jobs_email.present? && SiteSetting.zendesk_jobs_api_token.present? &&
- SiteSetting.zendesk_url
+ DiscourseZendeskPlugin::Helper.configured? && SiteSetting.zendesk_url
end
end
diff --git a/plugins/discourse-zendesk-plugin/spec/integration/zendesk_plugin_spec.rb b/plugins/discourse-zendesk-plugin/spec/integration/zendesk_plugin_spec.rb
index caa670f169f..3c0b9fa300a 100644
--- a/plugins/discourse-zendesk-plugin/spec/integration/zendesk_plugin_spec.rb
+++ b/plugins/discourse-zendesk-plugin/spec/integration/zendesk_plugin_spec.rb
@@ -5,7 +5,17 @@ RSpec.describe "Discourse Zendesk Plugin" do
let(:zendesk_url_default) { "https://your-url.zendesk.com/api/v2" }
let(:zendesk_api_ticket_url) { zendesk_url_default + "/tickets" }
- let(:ticket_response) { { ticket: { id: "ticket_id", url: "ticket_url" } }.to_json }
+ let(:ticket_response) do
+ {
+ ticket: {
+ id: "ticket_id",
+ url: "ticket_url",
+ },
+ audit: {
+ events: [{ id: "comment_id", type: "Comment" }],
+ },
+ }.to_json
+ end
before do
default_header = { "Content-Type" => "application/json; charset=UTF-8" }
@@ -51,10 +61,9 @@ RSpec.describe "Discourse Zendesk Plugin" do
SiteSetting.zendesk_enabled = true
sign_in staff
default_header = { "Content-Type" => "application/json; charset=UTF-8" }
- stub_request(:get, zendesk_api_ticket_url + "/ticket_id/comments").to_return(status: 200)
stub_request(:get, zendesk_api_user_search_url).to_return(
status: 200,
- body: { user: {} }.to_json,
+ body: { users: [] }.to_json,
headers: default_header,
)
stub_request(:post, zendesk_api_user_create_url).to_return(
@@ -80,6 +89,7 @@ RSpec.describe "Discourse Zendesk Plugin" do
expect(custom_fields["discourse_zendesk_plugin_zendesk_api_url"]).to eq("ticket_url")
expect(custom_fields["discourse_zendesk_plugin_zendesk_id"]).to eq("ticket_id")
+ expect(p1.reload.custom_fields["discourse_zendesk_plugin_zendesk_id"]).to eq("comment_id")
end
end
end
diff --git a/plugins/discourse-zendesk-plugin/spec/jobs/regular/zendesk_job_spec.rb b/plugins/discourse-zendesk-plugin/spec/jobs/regular/zendesk_job_spec.rb
index 80deaf3645f..306e4e0a8b7 100644
--- a/plugins/discourse-zendesk-plugin/spec/jobs/regular/zendesk_job_spec.rb
+++ b/plugins/discourse-zendesk-plugin/spec/jobs/regular/zendesk_job_spec.rb
@@ -167,4 +167,59 @@ RSpec.describe Jobs::ZendeskJob do
end
end
end
+
+ describe "#execute" do
+ context "when only OAuth credentials are configured" do
+ let(:zendesk_enabled) { true }
+ let(:zendesk_jobs_email) { "" }
+ let(:zendesk_jobs_api_token) { "" }
+ let(:zendesk_api_url) { "https://your-url.zendesk.com/api/v2" }
+ let(:zendesk_comment_request) do
+ stub_request(:put, "#{zendesk_api_url}/tickets/#{ticket_id}").with(
+ headers: {
+ "Authorization" => "Bearer oauth-access-token",
+ },
+ ).to_return(
+ status: 200,
+ body: {
+ ticket: {
+ id: ticket_id,
+ },
+ audit: {
+ events: [{ id: "comment-id", type: "Comment" }],
+ },
+ }.to_json,
+ headers: {
+ "Content-Type" => "application/json",
+ },
+ )
+ end
+
+ before do
+ SiteSetting.zendesk_oauth_client_id = "oauth-client-id"
+ SiteSetting.zendesk_oauth_client_secret = "oauth-client-secret"
+ stub_request(:post, "https://your-url.zendesk.com/oauth/tokens").to_return(
+ status: 200,
+ body: { access_token: "oauth-access-token", expires_in: 1800 }.to_json,
+ )
+ stub_request(:get, "#{zendesk_api_url}/users/search?query=#{post.user.email}").to_return(
+ status: 200,
+ body: { users: [{ id: "zendesk-user-id" }] }.to_json,
+ headers: {
+ "Content-Type" => "application/json",
+ },
+ )
+ zendesk_comment_request
+ end
+
+ it "pushes the post with OAuth authentication" do
+ execute
+
+ expect(zendesk_comment_request).to have_been_requested.once
+ expect(post.reload.custom_fields[DiscourseZendeskPlugin::ZENDESK_ID_FIELD]).to eq(
+ "comment-id",
+ )
+ end
+ end
+ end
end
diff --git a/plugins/discourse-zendesk-plugin/spec/lib/discourse_zendesk_plugin/helper_spec.rb b/plugins/discourse-zendesk-plugin/spec/lib/discourse_zendesk_plugin/helper_spec.rb
index 15031d8a8d9..a2b716b5acc 100644
--- a/plugins/discourse-zendesk-plugin/spec/lib/discourse_zendesk_plugin/helper_spec.rb
+++ b/plugins/discourse-zendesk-plugin/spec/lib/discourse_zendesk_plugin/helper_spec.rb
@@ -1,10 +1,141 @@
# frozen_string_literal: true
-describe DiscourseZendeskPlugin::Helper do
+RSpec.describe DiscourseZendeskPlugin::Helper do
subject(:dummy) { Class.new { extend DiscourseZendeskPlugin::Helper } }
- it "Instantiates" do
- expect(dummy).to be_present
+ describe ".configured?" do
+ it "returns true when API token credentials are complete" do
+ SiteSetting.zendesk_jobs_email = "[email protected]"
+ SiteSetting.zendesk_jobs_api_token = "legacy-token"
+
+ expect(described_class.configured?).to be(true)
+ end
+
+ it "returns true when OAuth credentials are complete" do
+ SiteSetting.zendesk_oauth_client_id = "oauth-client-id"
+ SiteSetting.zendesk_oauth_client_secret = "oauth-client-secret"
+
+ expect(described_class.configured?).to be(true)
+ end
+
+ it "returns false when credential pairs are incomplete" do
+ SiteSetting.zendesk_jobs_email = "[email protected]"
+ SiteSetting.zendesk_oauth_client_id = "oauth-client-id"
+
+ expect(described_class.configured?).to be(false)
+ end
+ end
+
+ describe "#zendesk_client" do
+ before { SiteSetting.zendesk_url = "https://your-url.zendesk.com/api/v2" }
+
+ it "uses OAuth when both authentication methods are configured" do
+ SiteSetting.zendesk_jobs_email = "[email protected]"
+ SiteSetting.zendesk_jobs_api_token = "legacy-token"
+ SiteSetting.zendesk_oauth_client_id = "oauth-client-id"
+ SiteSetting.zendesk_oauth_client_secret = "oauth-client-secret"
+ stub_request(:post, "https://your-url.zendesk.com/oauth/tokens").to_return(
+ status: 200,
+ body: { access_token: "oauth-access-token", expires_in: 1800 }.to_json,
+ )
+
+ client = dummy.zendesk_client
+
+ expect(client.config.access_token).to eq("oauth-access-token")
+ expect(client.config.username).to be_nil
+ expect(client.config.token).to be_nil
+ end
+
+ it "uses API token authentication while OAuth credentials are incomplete" do
+ SiteSetting.zendesk_jobs_email = "[email protected]"
+ SiteSetting.zendesk_jobs_api_token = "legacy-token"
+ SiteSetting.zendesk_oauth_client_id = "oauth-client-id"
+
+ client = dummy.zendesk_client
+
+ expect(client.config.username).to eq("[email protected]/token")
+ expect(client.config.password).to eq("legacy-token")
+ expect(client.config.access_token).to be_nil
+ end
+
+ it "retries once with a fresh token when Zendesk rejects the cached token" do
+ SiteSetting.zendesk_jobs_email = "[email protected]"
+ SiteSetting.zendesk_jobs_api_token = "legacy-token"
+ SiteSetting.zendesk_oauth_client_id = "oauth-client-id"
+ SiteSetting.zendesk_oauth_client_secret = "oauth-client-secret"
+ user = Fabricate(:user)
+ token_request =
+ stub_request(:post, "https://your-url.zendesk.com/oauth/tokens").to_return(
+ { status: 200, body: { access_token: "rejected-token", expires_in: 1800 }.to_json },
+ { status: 200, body: { access_token: "new-token", expires_in: 1800 }.to_json },
+ )
+ user_search_request =
+ stub_request(
+ :get,
+ "https://your-url.zendesk.com/api/v2/users/search?query=#{user.email}",
+ ).to_return(
+ {
+ status: 401,
+ body: { error: "invalid_token" }.to_json,
+ headers: {
+ "Content-Type" => "application/json",
+ },
+ },
+ {
+ status: 200,
+ body: { users: [{ id: 123 }] }.to_json,
+ headers: {
+ "Content-Type" => "application/json",
+ },
+ },
+ )
+
+ zendesk_user = dummy.fetch_submitter(user)
+
+ expect(zendesk_user.id).to eq(123)
+ expect(token_request).to have_been_requested.twice
+ expect(user_search_request).to have_been_requested.twice
+ expect(WebMock).to have_requested(
+ :get,
+ "https://your-url.zendesk.com/api/v2/users/search?query=#{user.email}",
+ ).with(headers: { "Authorization" => "Bearer rejected-token" }).once
+ expect(WebMock).to have_requested(
+ :get,
+ "https://your-url.zendesk.com/api/v2/users/search?query=#{user.email}",
+ ).with(headers: { "Authorization" => "Bearer new-token" }).once
+ expect(WebMock).not_to have_requested(:get, %r{/users/search}).with(
+ basic_auth: %w[[email protected]/token legacy-token],
+ )
+ end
+
+ it "raises InvalidOAuthTokenError when Zendesk rejects the replacement token" do
+ SiteSetting.zendesk_oauth_client_id = "oauth-client-id"
+ SiteSetting.zendesk_oauth_client_secret = "oauth-client-secret"
+ user = Fabricate(:user)
+ token_request =
+ stub_request(:post, "https://your-url.zendesk.com/oauth/tokens").to_return(
+ { status: 200, body: { access_token: "first-token", expires_in: 1800 }.to_json },
+ { status: 200, body: { access_token: "second-token", expires_in: 1800 }.to_json },
+ )
+ user_search_request =
+ stub_request(
+ :get,
+ "https://your-url.zendesk.com/api/v2/users/search?query=#{user.email}",
+ ).to_return(
+ status: 401,
+ body: { error: "invalid_token" }.to_json,
+ headers: {
+ "Content-Type" => "application/json",
+ },
+ )
+
+ expect { dummy.fetch_submitter(user) }.to raise_error(
+ DiscourseZendeskPlugin::InvalidOAuthTokenError,
+ "Zendesk rejected the OAuth access token",
+ )
+ expect(token_request).to have_been_requested.twice
+ expect(user_search_request).to have_been_requested.twice
+ end
end
describe "comment_eligible_for_sync?" do
diff --git a/plugins/discourse-zendesk-plugin/spec/lib/discourse_zendesk_plugin/oauth_token_spec.rb b/plugins/discourse-zendesk-plugin/spec/lib/discourse_zendesk_plugin/oauth_token_spec.rb
new file mode 100644
index 00000000000..68e6046596d
--- /dev/null
+++ b/plugins/discourse-zendesk-plugin/spec/lib/discourse_zendesk_plugin/oauth_token_spec.rb
@@ -0,0 +1,164 @@
+# frozen_string_literal: true
+
+RSpec.describe DiscourseZendeskPlugin::OAuthToken do
+ subject(:oauth_token) { described_class.new }
+
+ let(:token_url) { "https://your-url.zendesk.com/oauth/tokens" }
+
+ before do
+ SiteSetting.zendesk_url = "https://your-url.zendesk.com/api/v2"
+ SiteSetting.zendesk_oauth_client_id = "oauth-client-id"
+ SiteSetting.zendesk_oauth_client_secret = "oauth-client-secret"
+ end
+
+ describe "#access_token" do
+ it "requests and caches a scoped short-lived token" do
+ token_request =
+ stub_request(:post, token_url).with(
+ body: {
+ "client_id" => "oauth-client-id",
+ "client_secret" => "oauth-client-secret",
+ "grant_type" => "client_credentials",
+ "scope" => "tickets:read tickets:write users:read users:write",
+ },
+ ).to_return(
+ status: 200,
+ body: { access_token: "access-token", expires_in: 1800 }.to_json,
+ headers: {
+ "Content-Type" => "application/json",
+ },
+ )
+
+ expect(oauth_token.access_token).to eq("access-token")
+ expect(oauth_token.access_token).to eq("access-token")
+ expect(token_request).to have_been_requested.once
+ end
+
+ it "expires the cached token one minute before its reported expiry" do
+ stub_request(:post, token_url).to_return(
+ status: 200,
+ body: { access_token: "access-token", expires_in: 120 }.to_json,
+ )
+
+ expect(oauth_token.access_token).to eq("access-token")
+
+ cache_keys = Discourse.cache.redis.scan_each(match: "*:discourse-zendesk-oauth-token:*").to_a
+ expect(cache_keys.size).to eq(1)
+ expect(Discourse.cache.redis.ttl(cache_keys.first)).to be_between(59, 60)
+ end
+
+ it "returns a new token after the credentials change" do
+ token_request =
+ stub_request(:post, token_url).to_return(
+ { status: 200, body: { access_token: "first-token", expires_in: 1800 }.to_json },
+ { status: 200, body: { access_token: "rotated-token", expires_in: 1800 }.to_json },
+ )
+
+ expect(oauth_token.access_token).to eq("first-token")
+
+ SiteSetting.zendesk_oauth_client_secret = "rotated-secret"
+
+ expect(described_class.new.access_token).to eq("rotated-token")
+ expect(token_request).to have_been_requested.twice
+ end
+
+ it "does not reuse a token requested with previous credentials" do
+ request_count = 0
+ token_request =
+ stub_request(:post, token_url).to_return do
+ request_count += 1
+
+ if request_count == 1
+ SiteSetting.zendesk_oauth_client_secret = "rotated-secret"
+ { status: 200, body: { access_token: "first-token", expires_in: 1800 }.to_json }
+ else
+ { status: 200, body: { access_token: "rotated-token", expires_in: 1800 }.to_json }
+ end
+ end
+
+ expect(oauth_token.access_token).to eq("first-token")
+ expect(described_class.new.access_token).to eq("rotated-token")
+ expect(token_request).to have_been_requested.twice
+ end
+
+ it "rejects an insecure Zendesk URL before sending credentials" do
+ SiteSetting.zendesk_url = "http://your-url.zendesk.com/api/v2"
+
+ expect { oauth_token.access_token }.to raise_error(
+ described_class::PermanentRequestError,
+ "Zendesk OAuth requires an HTTPS URL",
+ )
+ expect(WebMock).not_to have_requested(:post, %r{/oauth/tokens})
+ end
+
+ it "rejects an unsuccessful token response without exposing its body" do
+ stub_request(:post, token_url).to_return(status: 401, body: "oauth-client-secret")
+
+ expect { oauth_token.access_token }.to raise_error(
+ described_class::PermanentRequestError,
+ "Zendesk OAuth token request failed",
+ )
+ end
+
+ it "raises RequestError when Zendesk returns a server error" do
+ stub_request(:post, token_url).to_return(status: 500)
+
+ expect { oauth_token.access_token }.to raise_error do |error|
+ expect(error).to be_instance_of(described_class::RequestError)
+ end
+ end
+
+ it "raises RequestError when Zendesk rate limits the request" do
+ stub_request(:post, token_url).to_return(status: 429)
+
+ expect { oauth_token.access_token }.to raise_error do |error|
+ expect(error).to be_instance_of(described_class::RequestError)
+ end
+ end
+
+ it "rejects a malformed token response" do
+ stub_request(:post, token_url).to_return(status: 200, body: { expires_in: 1800 }.to_json)
+
+ expect { oauth_token.access_token }.to raise_error(
+ described_class::RequestError,
+ "Zendesk OAuth token response is invalid",
+ )
+ end
+ end
+
+ describe "#invalidate" do
+ it "removes its access token from the cache" do
+ token_request =
+ stub_request(:post, token_url).to_return(
+ { status: 200, body: { access_token: "first-token", expires_in: 1800 }.to_json },
+ { status: 200, body: { access_token: "second-token", expires_in: 1800 }.to_json },
+ )
+
+ access_token = oauth_token.access_token
+ expect(access_token).to eq("first-token")
+
+ oauth_token.invalidate(access_token)
+
+ expect(oauth_token.access_token).to eq("second-token")
+ expect(token_request).to have_been_requested.twice
+ end
+
+ it "does not remove the cached token when it differs from the token being invalidated" do
+ token_request =
+ stub_request(:post, token_url).to_return(
+ { status: 200, body: { access_token: "first-token", expires_in: 1800 }.to_json },
+ { status: 200, body: { access_token: "second-token", expires_in: 1800 }.to_json },
+ )
+
+ access_token = oauth_token.access_token
+ expect(access_token).to eq("first-token")
+ oauth_token.invalidate(access_token)
+ expect(oauth_token.access_token).to eq("second-token")
+
+ oauth_token.invalidate(access_token)
+
+ expect(described_class.new.access_token).to eq("second-token")
+ expect(token_request).to have_been_requested.twice
+ end
+ end
+end
diff --git a/plugins/discourse-zendesk-plugin/spec/requests/issues_controller_spec.rb b/plugins/discourse-zendesk-plugin/spec/requests/issues_controller_spec.rb
index acbaa5951bf..bba2296f977 100644
--- a/plugins/discourse-zendesk-plugin/spec/requests/issues_controller_spec.rb
+++ b/plugins/discourse-zendesk-plugin/spec/requests/issues_controller_spec.rb
@@ -4,7 +4,17 @@ RSpec.describe DiscourseZendeskPlugin::IssuesController do
let(:zendesk_url_default) { "https://your-url.zendesk.com/api/v2" }
let(:zendesk_api_ticket_url) { zendesk_url_default + "/tickets" }
let(:zendesk_api_user_create_url) { zendesk_url_default + "/users" }
- let(:ticket_response) { { ticket: { id: "ticket_id", url: "ticket_url" } }.to_json }
+ let(:ticket_response) do
+ {
+ ticket: {
+ id: "ticket_id",
+ url: "ticket_url",
+ },
+ audit: {
+ events: [{ id: "comment_id", type: "Comment" }],
+ },
+ }.to_json
+ end
let(:default_header) { { "Content-Type" => "application/json; charset=UTF-8" } }
before do
@@ -25,10 +35,9 @@ RSpec.describe DiscourseZendeskPlugin::IssuesController do
body: { user: { id: 24 } }.to_json,
headers: default_header,
)
- stub_request(:get, %r{/tickets/.*/comments}).to_return(status: 200)
stub_request(:get, %r{/users/search}).to_return(
status: 200,
- body: { user: {} }.to_json,
+ body: { users: [] }.to_json,
headers: default_header,
)
end
@@ -37,15 +46,23 @@ RSpec.describe DiscourseZendeskPlugin::IssuesController do
it "creates a zendesk ticket for a topic" do
moderator = Fabricate(:moderator)
topic = Fabricate(:topic)
-
Fabricate(:post, topic: topic)
-
sign_in(moderator)
+ SiteSetting.zendesk_oauth_client_id = "oauth-client-id"
+ SiteSetting.zendesk_oauth_client_secret = "oauth-client-secret"
+ stub_request(:post, "https://your-url.zendesk.com/oauth/tokens").to_return(
+ status: 200,
+ body: { access_token: "oauth-access-token", expires_in: 1800 }.to_json,
+ )
post "/zendesk-plugin/issues.json", params: { topic_id: topic.id }
expect(response.status).to eq(200)
- expect(WebMock).to have_requested(:post, zendesk_api_ticket_url)
+ expect(WebMock).to have_requested(:post, zendesk_api_ticket_url).with(
+ headers: {
+ "Authorization" => "Bearer oauth-access-token",
+ },
+ )
end
it "does not create a zendesk ticket for a topic the moderator cannot see" do
admin = Fabricate(:admin)
diff --git a/plugins/discourse-zendesk-plugin/spec/services/problem_check/zendesk_api_token_deprecation_spec.rb b/plugins/discourse-zendesk-plugin/spec/services/problem_check/zendesk_api_token_deprecation_spec.rb
new file mode 100644
index 00000000000..81d21b8edb6
--- /dev/null
+++ b/plugins/discourse-zendesk-plugin/spec/services/problem_check/zendesk_api_token_deprecation_spec.rb
@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+RSpec.describe ProblemCheck::ZendeskApiTokenDeprecation do
+ describe "#call" do
+ subject(:problem) { described_class.new.call }
+
+ before do
+ SiteSetting.zendesk_enabled = true
+ SiteSetting.zendesk_jobs_email = "[email protected]"
+ SiteSetting.zendesk_jobs_api_token = "legacy-token"
+ end
+
+ it "returns a low-priority problem when the enabled plugin relies on API token authentication" do
+ expect(problem).to be_present
+ expect(problem.priority).to eq("low")
+ end
+
+ it "returns nil when OAuth credentials are configured" do
+ SiteSetting.zendesk_oauth_client_id = "oauth-client-id"
+ SiteSetting.zendesk_oauth_client_secret = "oauth-client-secret"
+
+ expect(problem).to be_blank
+ end
+
+ it "returns nil when the plugin is disabled" do
+ SiteSetting.zendesk_enabled = false
+
+ expect(problem).to be_blank
+ end
+
+ it "returns nil when API token credentials are incomplete" do
+ SiteSetting.zendesk_jobs_api_token = ""
+
+ expect(problem).to be_blank
+ end
+ end
+end