Linear is deprecating long-lived OAuth2 access tokens (valid for 10 years) in favor of short-lived access tokens with refresh tokens. Starting October 1, 2025, all new OAuth2 apps will default to refresh tokens. Linear will no longer issue long-lived access tokens. Please read more details [here](https://linear.app/developers/oauth-2-0-authentication#migrate-to-using-refresh-tokens) We currently use long-lived tokens in our Linear integration (valid for up to 10 years). To remain compatible, this PR ensures compatibility by supporting refresh-token-based auth and migrating existing legacy tokens. Fixes https://linear.app/chatwoot/issue/CW-5541/migrate-linear-oauth2-integration-to-support-refresh-tokens
191 lines
6.2 KiB
Ruby
191 lines
6.2 KiB
Ruby
require 'rails_helper'
|
|
|
|
RSpec.describe Linear::CallbacksController, type: :request do
|
|
let(:account) { create(:account) }
|
|
let(:code) { SecureRandom.hex(10) }
|
|
let(:client_secret) { 'test_linear_secret' }
|
|
let(:state) { JWT.encode({ sub: account.id, iat: Time.current.to_i }, client_secret, 'HS256') }
|
|
let(:linear_redirect_uri) { "#{ENV.fetch('FRONTEND_URL', '')}/app/accounts/#{account.id}/settings/integrations/linear" }
|
|
|
|
describe 'GET /linear/callback' do
|
|
let(:access_token) { SecureRandom.hex(10) }
|
|
let(:refresh_token) { SecureRandom.hex(10) }
|
|
let(:response_body) do
|
|
{
|
|
'access_token' => access_token,
|
|
'refresh_token' => refresh_token,
|
|
'token_type' => 'Bearer',
|
|
'expires_in' => 7200,
|
|
'scope' => 'read,write'
|
|
}
|
|
end
|
|
|
|
before do
|
|
stub_const('ENV', ENV.to_hash.merge('FRONTEND_URL' => 'http://www.example.com'))
|
|
allow(GlobalConfigService).to receive(:load).and_call_original
|
|
allow(GlobalConfigService).to receive(:load).with('LINEAR_CLIENT_SECRET', nil).and_return(client_secret)
|
|
allow(GlobalConfigService).to receive(:load).with('LINEAR_CLIENT_ID', nil).and_return('test_client_id')
|
|
end
|
|
|
|
context 'when successful' do
|
|
before do
|
|
stub_request(:post, 'https://api.linear.app/oauth/token')
|
|
.to_return(
|
|
status: 200,
|
|
body: response_body.to_json,
|
|
headers: { 'Content-Type' => 'application/json' }
|
|
)
|
|
end
|
|
|
|
it 'creates a new integration hook', :aggregate_failures do
|
|
expect do
|
|
get linear_callback_path, params: { code: code, state: state }
|
|
end.to change(Integrations::Hook, :count).by(1)
|
|
|
|
hook = Integrations::Hook.last
|
|
expect(hook.access_token).to eq(access_token)
|
|
expect(hook.app_id).to eq('linear')
|
|
expect(hook.status).to eq('enabled')
|
|
expect(hook.settings['token_type']).to eq('Bearer')
|
|
expect(hook.settings['expires_in']).to eq(7200)
|
|
expect(hook.settings['scope']).to eq('read,write')
|
|
expect(hook.settings['refresh_token']).to eq(refresh_token)
|
|
expect(hook.settings['expires_on']).to be_present
|
|
expect(response).to redirect_to(linear_redirect_uri)
|
|
end
|
|
end
|
|
|
|
context 'when the code is missing' do
|
|
before do
|
|
stub_request(:post, 'https://api.linear.app/oauth/token')
|
|
.to_return(
|
|
status: 200,
|
|
body: response_body.to_json,
|
|
headers: { 'Content-Type' => 'application/json' }
|
|
)
|
|
end
|
|
|
|
it 'redirects to the linear_redirect_uri' do
|
|
get linear_callback_path, params: { state: state }
|
|
expect(response).to redirect_to(linear_redirect_uri)
|
|
end
|
|
end
|
|
|
|
context 'when state is missing' do
|
|
it 'redirects to frontend root' do
|
|
get linear_callback_path, params: { code: code }
|
|
expect(response).to redirect_to('http://www.example.com')
|
|
end
|
|
end
|
|
|
|
context 'when state is invalid' do
|
|
it 'redirects to frontend root' do
|
|
get linear_callback_path, params: { code: code, state: 'invalid-state' }
|
|
expect(response).to redirect_to('http://www.example.com')
|
|
end
|
|
end
|
|
|
|
context 'when hook exists and response omits refresh_token' do
|
|
let!(:existing_hook) do
|
|
create(
|
|
:integrations_hook,
|
|
:linear,
|
|
account: account,
|
|
settings: {
|
|
'refresh_token' => 'existing_refresh_token',
|
|
'token_type' => 'Bearer',
|
|
'scope' => 'read,write',
|
|
'expires_on' => 1.day.from_now.utc.to_s
|
|
}
|
|
)
|
|
end
|
|
let(:response_body) do
|
|
{
|
|
'access_token' => access_token,
|
|
'token_type' => 'Bearer',
|
|
'expires_in' => 7200,
|
|
'scope' => 'read,write'
|
|
}
|
|
end
|
|
|
|
before do
|
|
stub_request(:post, 'https://api.linear.app/oauth/token')
|
|
.to_return(
|
|
status: 200,
|
|
body: response_body.to_json,
|
|
headers: { 'Content-Type' => 'application/json' }
|
|
)
|
|
end
|
|
|
|
it 'preserves existing refresh token', :aggregate_failures do
|
|
get linear_callback_path, params: { code: code, state: state }
|
|
|
|
existing_hook.reload
|
|
expect(existing_hook.access_token).to eq(access_token)
|
|
expect(existing_hook.settings['refresh_token']).to eq('existing_refresh_token')
|
|
end
|
|
end
|
|
|
|
context 'when hook exists and response omits access_token' do
|
|
let!(:existing_hook) do
|
|
create(
|
|
:integrations_hook,
|
|
:linear,
|
|
account: account,
|
|
access_token: 'existing_access_token',
|
|
settings: {
|
|
'refresh_token' => 'existing_refresh_token',
|
|
'token_type' => 'Bearer',
|
|
'scope' => 'read,write',
|
|
'expires_on' => 1.day.from_now.utc.to_s
|
|
}
|
|
)
|
|
end
|
|
let(:response_body) do
|
|
{
|
|
'refresh_token' => refresh_token,
|
|
'token_type' => 'Bearer',
|
|
'expires_in' => 7200,
|
|
'scope' => 'read,write'
|
|
}
|
|
end
|
|
|
|
before do
|
|
stub_request(:post, 'https://api.linear.app/oauth/token')
|
|
.to_return(
|
|
status: 200,
|
|
body: response_body.to_json,
|
|
headers: { 'Content-Type' => 'application/json' }
|
|
)
|
|
end
|
|
|
|
it 'does not overwrite the existing hook', :aggregate_failures do
|
|
expect do
|
|
get linear_callback_path, params: { code: code, state: state }
|
|
end.not_to change(Integrations::Hook, :count)
|
|
|
|
existing_hook.reload
|
|
expect(existing_hook.access_token).to eq('existing_access_token')
|
|
expect(existing_hook.settings['refresh_token']).to eq('existing_refresh_token')
|
|
expect(response).to redirect_to(linear_redirect_uri)
|
|
end
|
|
end
|
|
|
|
context 'when the token is invalid' do
|
|
before do
|
|
stub_request(:post, 'https://api.linear.app/oauth/token')
|
|
.to_return(
|
|
status: 400,
|
|
body: { error: 'invalid_grant' }.to_json,
|
|
headers: { 'Content-Type' => 'application/json' }
|
|
)
|
|
end
|
|
|
|
it 'redirects to the linear_redirect_uri' do
|
|
get linear_callback_path, params: { code: code, state: state }
|
|
expect(response).to redirect_to(linear_redirect_uri)
|
|
end
|
|
end
|
|
end
|
|
end
|