Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
G
gitlab-ce
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
1
Merge Requests
1
Analytics
Analytics
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
nexedi
gitlab-ce
Commits
7aed5971
Commit
7aed5971
authored
3 years ago
by
Luke Duncalfe
Committed by
Bob Van Landuyt
3 years ago
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Protect commits/:sha from many Gitaly timeouts
parent
2b5e3a6a
Changes
4
Show whitespace changes
Inline
Side-by-side
Showing
4 changed files
with
156 additions
and
19 deletions
+156
-19
config/feature_flags/development/api_v3_commits_skip_diff_files.yml
...ture_flags/development/api_v3_commits_skip_diff_files.yml
+8
-0
lib/api/github/entities.rb
lib/api/github/entities.rb
+2
-2
lib/api/v3/github.rb
lib/api/v3/github.rb
+30
-2
spec/requests/api/v3/github_spec.rb
spec/requests/api/v3/github_spec.rb
+116
-15
No files found.
config/feature_flags/development/api_v3_commits_skip_diff_files.yml
0 → 100644
View file @
7aed5971
---
name
:
api_v3_commits_skip_diff_files
introduced_by_url
:
https://gitlab.com/gitlab-org/gitlab/-/merge_requests/67647
rollout_issue_url
:
https://gitlab.com/gitlab-org/gitlab/-/issues/344617
milestone
:
'
14.5'
type
:
development
group
:
group::integrations
default_enabled
:
false
This diff is collapsed.
Click to expand it.
lib/api/github/entities.rb
View file @
7aed5971
...
...
@@ -59,8 +59,8 @@ module API
expose
:parents
do
|
commit
|
commit
.
parent_ids
.
map
{
|
id
|
{
sha:
id
}
}
end
expose
:files
do
|
commit
|
commit
.
diffs
.
diff_files
.
flat_map
do
|
diff
|
expose
:files
do
|
_commit
,
options
|
options
[
:diff_files
]
.
flat_map
do
|
diff
|
additions
=
diff
.
added_lines
deletions
=
diff
.
removed_lines
...
...
This diff is collapsed.
Click to expand it.
lib/api/v3/github.rb
View file @
7aed5971
...
...
@@ -20,6 +20,9 @@ module API
# Jira Server user agent format: Jira DVCS Connector/version
JIRA_DVCS_CLOUD_USER_AGENT
=
'Jira DVCS Connector Vertigo'
GITALY_TIMEOUT_CACHE_KEY
=
'api:v3:Gitaly-timeout-cache-key'
GITALY_TIMEOUT_CACHE_EXPIRY
=
1
.
day
include
PaginationParams
feature_category
:integrations
...
...
@@ -93,6 +96,32 @@ module API
notes
.
select
{
|
n
|
n
.
readable_by?
(
current_user
)
}
end
# rubocop: enable CodeReuse/ActiveRecord
# Returns an empty Array instead of the Commit diff files for a period
# of time after a Gitaly timeout, to mitigate frequent Gitaly timeouts
# for some Commit diffs.
def
diff_files
(
commit
)
return
commit
.
diffs
.
diff_files
unless
Feature
.
enabled?
(
:api_v3_commits_skip_diff_files
,
commit
.
project
)
cache_key
=
[
GITALY_TIMEOUT_CACHE_KEY
,
commit
.
project
.
id
,
commit
.
cache_key
].
join
(
':'
)
return
[]
if
Rails
.
cache
.
read
(
cache_key
).
present?
begin
commit
.
diffs
.
diff_files
rescue
GRPC
::
DeadlineExceeded
=>
error
# Gitaly fails to load diffs consistently for some commits. The other information
# is still valuable for Jira. So we skip the loading and respond with a 200 excluding diffs
# Remove this when https://gitlab.com/gitlab-org/gitaly/-/issues/3741 is fixed.
Rails
.
cache
.
write
(
cache_key
,
1
,
expires_in:
GITALY_TIMEOUT_CACHE_EXPIRY
)
Gitlab
::
ErrorTracking
.
track_exception
(
error
)
[]
end
end
end
resource
:orgs
do
...
...
@@ -228,10 +257,9 @@ module API
user_project
=
find_project_with_access
(
params
)
commit
=
user_project
.
commit
(
params
[
:sha
])
not_found!
'Commit'
unless
commit
present
commit
,
with:
::
API
::
Github
::
Entities
::
RepoCommit
present
commit
,
with:
::
API
::
Github
::
Entities
::
RepoCommit
,
diff_files:
diff_files
(
commit
)
end
end
end
...
...
This diff is collapsed.
Click to expand it.
spec/requests/api/v3/github_spec.rb
View file @
7aed5971
...
...
@@ -6,7 +6,7 @@ RSpec.describe API::V3::Github do
let_it_be
(
:user
)
{
create
(
:user
)
}
let_it_be
(
:unauthorized_user
)
{
create
(
:user
)
}
let_it_be
(
:admin
)
{
create
(
:user
,
:admin
)
}
let_it_be
(
:project
)
{
create
(
:project
,
:repository
,
creator:
user
)
}
let_it_be
_with_reload
(
:project
)
{
create
(
:project
,
:repository
,
creator:
user
)
}
before
do
project
.
add_maintainer
(
user
)
...
...
@@ -506,11 +506,18 @@ RSpec.describe API::V3::Github do
describe
'GET /repos/:namespace/:project/commits/:sha'
do
let
(
:commit
)
{
project
.
repository
.
commit
}
let
(
:commit_id
)
{
commit
.
id
}
context
'authenticated'
do
it
'returns commit with github format'
do
def
call_api
(
commit_id:
commit
.
id
)
jira_get
v3_api
(
"/repos/
#{
project
.
namespace
.
path
}
/
#{
project
.
path
}
/commits/
#{
commit_id
}
"
,
user
)
end
def
response_diff_files
(
response
)
Gitlab
::
Json
.
parse
(
response
.
body
)[
'files'
]
end
context
'authenticated'
do
it
'returns commit with github format'
,
:aggregate_failures
do
call_api
expect
(
response
).
to
have_gitlab_http_status
(
:ok
)
expect
(
response
).
to
match_response_schema
(
'entities/github/commit'
)
...
...
@@ -519,36 +526,130 @@ RSpec.describe API::V3::Github do
it
'returns 200 when project path include a dot'
do
project
.
update!
(
path:
'foo.bar'
)
jira_get
v3_api
(
"/repos/
#{
project
.
namespace
.
path
}
/
#{
project
.
path
}
/commits/
#{
commit_id
}
"
,
user
)
call_api
expect
(
response
).
to
have_gitlab_http_status
(
:ok
)
end
context
'when namespace path includes a dot'
do
let
(
:group
)
{
create
(
:group
,
path:
'foo.bar'
)
}
let
(
:project
)
{
create
(
:project
,
:repository
,
group:
group
)
}
it
'returns 200 when namespace path include a dot'
do
group
=
create
(
:group
,
path:
'foo.bar'
)
project
=
create
(
:project
,
:repository
,
group:
group
)
project
.
add_reporter
(
user
)
jira_get
v3_api
(
"/repos/
#{
group
.
path
}
/
#{
project
.
path
}
/commits/
#{
commit_id
}
"
,
user
)
call_api
expect
(
response
).
to
have_gitlab_http_status
(
:ok
)
end
end
context
'when the Gitaly `CommitDiff` RPC times out'
,
:use_clean_rails_memory_store_caching
do
let
(
:commit_diff_args
)
{
[
project
.
repository_storage
,
:diff_service
,
:commit_diff
,
any_args
]
}
before
do
allow
(
Gitlab
::
GitalyClient
).
to
receive
(
:call
)
.
and_call_original
end
it
'handles the error, logs it, and returns empty diff files'
,
:aggregate_failures
do
allow
(
Gitlab
::
GitalyClient
).
to
receive
(
:call
)
.
with
(
*
commit_diff_args
)
.
and_raise
(
GRPC
::
DeadlineExceeded
)
expect
(
Gitlab
::
ErrorTracking
)
.
to
receive
(
:track_exception
)
.
with
an_instance_of
(
GRPC
::
DeadlineExceeded
)
call_api
expect
(
response
).
to
have_gitlab_http_status
(
:ok
)
expect
(
response_diff_files
(
response
)).
to
be_blank
end
it
'does not handle the error when feature flag is disabled'
,
:aggregate_failures
do
stub_feature_flags
(
api_v3_commits_skip_diff_files:
false
)
allow
(
Gitlab
::
GitalyClient
).
to
receive
(
:call
)
.
with
(
*
commit_diff_args
)
.
and_raise
(
GRPC
::
DeadlineExceeded
)
call_api
expect
(
response
).
to
have_gitlab_http_status
(
:error
)
end
it
'only calls Gitaly once for all attempts within a period of time'
,
:aggregate_failures
do
expect
(
Gitlab
::
GitalyClient
).
to
receive
(
:call
)
.
with
(
*
commit_diff_args
)
.
once
# <- once
.
and_raise
(
GRPC
::
DeadlineExceeded
)
3
.
times
do
call_api
expect
(
response
).
to
have_gitlab_http_status
(
:ok
)
expect
(
response_diff_files
(
response
)).
to
be_blank
end
end
it
'calls Gitaly again after a period of time'
,
:aggregate_failures
do
expect
(
Gitlab
::
GitalyClient
).
to
receive
(
:call
)
.
with
(
*
commit_diff_args
)
.
twice
# <- twice
.
and_raise
(
GRPC
::
DeadlineExceeded
)
call_api
expect
(
response
).
to
have_gitlab_http_status
(
:ok
)
expect
(
response_diff_files
(
response
)).
to
be_blank
travel_to
((
described_class
::
GITALY_TIMEOUT_CACHE_EXPIRY
+
1
.
second
).
from_now
)
do
call_api
expect
(
response
).
to
have_gitlab_http_status
(
:ok
)
expect
(
response_diff_files
(
response
)).
to
be_blank
end
end
it
'uses a unique cache key, allowing other calls to succeed'
do
cache_key
=
[
described_class
::
GITALY_TIMEOUT_CACHE_KEY
,
project
.
id
,
commit
.
cache_key
].
join
(
':'
)
Rails
.
cache
.
write
(
cache_key
,
1
)
expect
(
Gitlab
::
GitalyClient
).
to
receive
(
:call
)
.
with
(
*
commit_diff_args
)
.
once
# <- once
call_api
expect
(
response
).
to
have_gitlab_http_status
(
:ok
)
expect
(
response_diff_files
(
response
)).
to
be_blank
call_api
(
commit_id:
commit
.
parent
.
id
)
expect
(
response
).
to
have_gitlab_http_status
(
:ok
)
expect
(
response_diff_files
(
response
).
length
).
to
eq
(
1
)
end
end
end
context
'unauthenticated'
do
let
(
:user
)
{
nil
}
it
'returns 401'
do
jira_get
v3_api
(
"/repos/
#{
project
.
namespace
.
path
}
/
#{
project
.
path
}
/commits/
#{
commit_id
}
"
,
nil
)
call_api
expect
(
response
).
to
have_gitlab_http_status
(
:unauthorized
)
end
end
context
'unauthorized'
do
let
(
:user
)
{
unauthorized_user
}
it
'returns 404 when lower access level'
do
project
.
add_guest
(
u
nauthorized_u
ser
)
project
.
add_guest
(
user
)
jira_get
v3_api
(
"/repos/
#{
project
.
namespace
.
path
}
/
#{
project
.
path
}
/commits/
#{
commit_id
}
"
,
unauthorized_user
)
call_api
expect
(
response
).
to
have_gitlab_http_status
(
:not_found
)
end
...
...
This diff is collapsed.
Click to expand it.
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment