Skip to content

Ignore ResourceExists errors from bbs_apps_client #4522

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Ignore ResourceExists errors from bbs_apps_client #4522

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
81be7c7
Revert "Catch error thrown if Diego Process Sync creates a desired lr…
Gerg Aug 18, 2025
c2d496a
Ignore ResourceExists errors from bbs_apps_client
Gerg Aug 18, 2025
ff23394
Improve bbs_apps_client error logs
Gerg Aug 26, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions lib/cloud_controller/diego/bbs_apps_client.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,10 @@ def desire_app(process)
lrp = AppRecipeBuilder.new(config: @config, process: process).build_app_lrp

response = @client.desire_lrp(lrp)
logger.info('desire.app.response', process_guid: lrp.process_guid, error: response.error)
logger.info('desire.app.response', process_guid: lrp.process_guid, error: response.error&.to_s)

runner_invalid_request!(response.error.message) if response.error&.type == ::Diego::Bbs::ErrorTypes::InvalidRequest
return response if response.error&.type == ::Diego::Bbs::ErrorTypes::ResourceConflict
return response if [::Diego::Bbs::ErrorTypes::ResourceConflict, ::Diego::Bbs::ErrorTypes::ResourceExists].include?(response.error&.type)

response
end
Expand All @@ -30,7 +30,7 @@ def update_app(process, existing_lrp)

handle_diego_errors(process_guid) do
response = @client.update_desired_lrp(process_guid, lrp_update)
logger.info('update.app.response', process_guid: process_guid, error: response.error)
logger.info('update.app.response', process_guid: process_guid, error: response.error&.to_s)

runner_invalid_request!(response.error.message) if response.error&.type == ::Diego::Bbs::ErrorTypes::InvalidRequest
return response if response.error&.type == ::Diego::Bbs::ErrorTypes::ResourceConflict
Expand All @@ -45,7 +45,7 @@ def get_app(process)

result = handle_diego_errors(process_guid) do
response = @client.desired_lrp_by_process_guid(process_guid)
logger.info('get.app.response', process_guid: process_guid, error: response.error)
logger.info('get.app.response', process_guid: process_guid, error: response.error&.to_s)

return nil if response.error&.type == ::Diego::Bbs::ErrorTypes::ResourceNotFound

Expand All @@ -59,7 +59,7 @@ def stop_app(process_guid)
logger.info('stop.app.request', process_guid:)
handle_diego_errors(process_guid) do
response = @client.remove_desired_lrp(process_guid)
logger.info('stop.app.response', process_guid: process_guid, error: response.error)
logger.info('stop.app.response', process_guid: process_guid, error: response.error&.to_s)

return nil if response.error&.type == ::Diego::Bbs::ErrorTypes::ResourceNotFound

Expand All @@ -72,7 +72,7 @@ def stop_index(process_guid, index)
actual_lrp_key = ::Diego::Bbs::Models::ActualLRPKey.new(process_guid: process_guid, index: index, domain: APP_LRP_DOMAIN)
handle_diego_errors(process_guid) do
response = @client.retire_actual_lrp(actual_lrp_key)
logger.info('stop.index.response', process_guid: process_guid, index: index, error: response.error)
logger.info('stop.index.response', process_guid: process_guid, index: index, error: response.error&.to_s)

return nil if response.error&.type == ::Diego::Bbs::ErrorTypes::ResourceNotFound

Expand All @@ -85,7 +85,7 @@ def fetch_scheduling_infos

handle_diego_errors do
response = @client.desired_lrp_scheduling_infos(APP_LRP_DOMAIN)
logger.info('fetch.scheduling.infos.response', error: response.error)
logger.info('fetch.scheduling.infos.response', error: response.error&.to_s)
response
end.desired_lrp_scheduling_infos
end
Expand All @@ -95,7 +95,7 @@ def bump_freshness

handle_diego_errors do
response = @client.upsert_domain(domain: APP_LRP_DOMAIN, ttl: APP_LRP_DOMAIN_TTL)
logger.info('bump.freshness.response', error: response.error)
logger.info('bump.freshness.response', error: response.error&.to_s)
response
end
end
Expand Down
11 changes: 1 addition & 10 deletions lib/cloud_controller/diego/desire_app_handler.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,16 +6,7 @@ def create_or_update_app(process, client)
if (existing_lrp = client.get_app(process))
client.update_app(process, existing_lrp)
else
begin
client.desire_app(process)
rescue CloudController::Errors::ApiError => e # catch race condition if Diego Process Sync creates an LRP in the meantime
if e.name == 'RunnerError' && e.message['the requested resource already exists']
existing_lrp = client.get_app(process)
client.update_app(process, existing_lrp)
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We do lose out on this update. I think the syncer will get to it anyway (or already got to it, since this is a race condition). I'll think about it some more.

Copy link
Member Author

@Gerg Gerg Aug 20, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yea, looking at client.update_app, it's getting the LRP based on the CC process's guid and version. If the versions match between the LRP and the CC process, then no update is needed (that's the purpose of version).

Thus, I don't think this additional update is needed.

elsif e.name == 'UnprocessableEntity'
raise
end
end
client.desire_app(process)
end
end
end
Expand Down
136 changes: 135 additions & 1 deletion spec/unit/lib/cloud_controller/diego/bbs_apps_client_spec.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,9 @@ module VCAP::CloudController::Diego

describe '#desire_app' do
let(:bbs_client) { instance_double(::Diego::Client, desire_lrp: lrp_response) }
let(:lrp) { ::Diego::Bbs::Models::DesiredLRP.new }
let(:lrp) { ::Diego::Bbs::Models::DesiredLRP.new process_guid: lrp_process_guid }
let(:process) { VCAP::CloudController::ProcessModel.make }
let(:lrp_process_guid) { ProcessGuid.from_process process }
let(:lrp_response) { ::Diego::Bbs::Models::DesiredLRPLifecycleResponse.new(error: lifecycle_error) }
let(:lifecycle_error) { nil }

Expand Down Expand Up @@ -51,6 +52,14 @@ module VCAP::CloudController::Diego
end
end

context 'when the bbs response contains a resource exists error' do
let(:lifecycle_error) { ::Diego::Bbs::Models::Error.new(type: ::Diego::Bbs::Models::Error::Type::ResourceExists) }

it 'does not raise error' do
expect { client.desire_app(process) }.not_to raise_error
end
end

context 'when the bbs response contains an invalid request error' do
let(:lifecycle_error) { ::Diego::Bbs::Models::Error.new(type: ::Diego::Bbs::Models::Error::Type::InvalidRequest, message: 'bad request') }

Expand All @@ -73,6 +82,24 @@ module VCAP::CloudController::Diego
expect(e.name).to eq('RunnerError')
end
end

it 'logs the error' do
tail_logs do |logs|
expect { client.desire_app(process) }.to raise_error(CloudController::Errors::ApiError)

expect(
logs.read.find { |l| l['message'] == 'desire.app.response' }
).to match(
hash_including(
'message' => 'desire.app.response',
'data' => {
'error' => /error message/,
'process_guid' => lrp_process_guid
}
)
)
end
end
end
end

Expand Down Expand Up @@ -134,6 +161,24 @@ module VCAP::CloudController::Diego
expect(e.name).to eq('RunnerError')
end
end

it 'logs the error' do
tail_logs do |logs|
expect { client.stop_app(process_guid) }.to raise_error(CloudController::Errors::ApiError)

expect(
logs.read.find { |l| l['message'] == 'stop.app.response' }
).to match(
hash_including(
'message' => 'stop.app.response',
'data' => {
'error' => /error message/,
'process_guid' => process_guid
}
)
)
end
end
end

context 'when bbs client errors' do
Expand Down Expand Up @@ -186,6 +231,25 @@ module VCAP::CloudController::Diego
expect(e.name).to eq('RunnerError')
end
end

it 'logs the error' do
tail_logs do |logs|
expect { client.stop_index(process_guid, index) }.to raise_error(CloudController::Errors::ApiError)

expect(
logs.read.find { |l| l['message'] == 'stop.index.response' }
).to match(
hash_including(
'message' => 'stop.index.response',
'data' => {
'error' => /error message/,
'process_guid' => process_guid,
'index' => index
}
)
)
end
end
end

context 'when bbs client errors' do
Expand Down Expand Up @@ -237,6 +301,24 @@ module VCAP::CloudController::Diego
expect(e.name).to eq('RunnerError')
end
end

it 'logs the error' do
tail_logs do |logs|
expect { client.get_app(process) }.to raise_error(CloudController::Errors::ApiError)

expect(
logs.read.find { |l| l['message'] == 'get.app.response' }
).to match(
hash_including(
'message' => 'get.app.response',
'data' => {
'error' => /error message/,
'process_guid' => 'process-guid'
}
)
)
end
end
end

context 'when bbs client errors' do
Expand Down Expand Up @@ -312,6 +394,24 @@ module VCAP::CloudController::Diego
expect(e.name).to eq('RunnerError')
end
end

it 'logs the error' do
tail_logs do |logs|
expect { client.update_app(process, existing_lrp) }.to raise_error(CloudController::Errors::ApiError)

expect(
logs.read.find { |l| l['message'] == 'update.app.response' }
).to match(
hash_including(
'message' => 'update.app.response',
'data' => {
'error' => /error message/,
'process_guid' => process_guid
}
)
)
end
end
end

context 'when bbs client errors' do
Expand Down Expand Up @@ -354,6 +454,23 @@ module VCAP::CloudController::Diego
expect(e.name).to eq('RunnerError')
end
end

it 'logs the error' do
tail_logs do |logs|
expect { client.fetch_scheduling_infos }.to raise_error(CloudController::Errors::ApiError)

expect(
logs.read.find { |l| l['message'] == 'fetch.scheduling.infos.response' }
).to match(
hash_including(
'message' => 'fetch.scheduling.infos.response',
'data' => {
'error' => /error message/
}
)
)
end
end
end

context 'when bbs client errors' do
Expand Down Expand Up @@ -395,6 +512,23 @@ module VCAP::CloudController::Diego
expect(e.name).to eq('RunnerError')
end
end

it 'logs the error' do
tail_logs do |logs|
expect { client.bump_freshness }.to raise_error(CloudController::Errors::ApiError)

expect(
logs.read.find { |l| l['message'] == 'bump.freshness.response' }
).to match(
hash_including(
'message' => 'bump.freshness.response',
'data' => {
'error' => /error message/
}
)
)
end
end
end

context 'when bbs client errors' do
Expand Down
28 changes: 0 additions & 28 deletions spec/unit/lib/cloud_controller/diego/desire_app_handler_spec.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,34 +35,6 @@ module Diego
expect(client).not_to have_received(:desire_app)
end
end

context 'race condition when the Diego::ProcessesSync runs and creates a process ahead of the DesireAppHandler' do
let(:desired_lrp_update) { double(:desired_lrp_update) }
let(:get_app_response) { nil }

before do
allow(client).to receive(:update_app)
allow(client).to receive(:desire_app).and_raise CloudController::Errors::ApiError.new_from_details('RunnerError', 'the requested resource already exists')
end

it 'catches the error and updates the app' do
DesireAppHandler.create_or_update_app(process, client)
expect(client).to have_received(:update_app)
expect(client).to have_received(:get_app).exactly(2).times
end
end

context 'when root user is not permitted' do
it 'raises a CloudController::Errors::ApiError' do
allow(client).to receive(:desire_app).and_raise(CloudController::Errors::ApiError.new_from_details('UnprocessableEntity',
'Attempting to run process as root user, which is not permitted.'))
expect { DesireAppHandler.create_or_update_app(process, client) }.to(raise_error do |error|
expect(error).to be_a(CloudController::Errors::ApiError)
expect(error.name).to eq('UnprocessableEntity')
expect(error.message).to include('Attempting to run process as root user, which is not permitted')
end)
end
end
end
end
end
Expand Down
Loading