From 5422bb0e153b44d8e606bfca0e9a78d4f31498c2 Mon Sep 17 00:00:00 2001
From: Mayank Singh <mayank.singh081997@gmail.com>
Date: Wed, 26 Jul 2023 14:22:59 +0000
Subject: [PATCH] Remove description from explain vulnerability prompt
Changelog: changed
EE: true
---
ee/lib/gitlab/llm/templates/explain_vulnerability.rb | 6 +++---
.../gitlab/llm/templates/explain_vulnerability_spec.rb | 10 +++-------
.../api/graphql/explain_vulnerability_prompt_spec.rb | 6 +++---
3 files changed, 9 insertions(+), 13 deletions(-)
diff --git a/ee/lib/gitlab/llm/templates/explain_vulnerability.rb b/ee/lib/gitlab/llm/templates/explain_vulnerability.rb
index f607cc8a87a3..2284b5a70172 100644
--- a/ee/lib/gitlab/llm/templates/explain_vulnerability.rb
+++ b/ee/lib/gitlab/llm/templates/explain_vulnerability.rb
@@ -98,7 +98,7 @@ def eligible_code?
def prompt_with_code
<<~PROMPT
You are a software vulnerability developer.
- Explain the vulnerability "#{title} - #{description} (#{identifiers})".
+ Explain the vulnerability "#{title} - (#{identifiers})".
The file "#{filename}" has this vulnerable code:
```
@@ -116,7 +116,7 @@ def prompt_without_code
<<~PROMPT
You are a software vulnerability developer.
- Explain the vulnerability "#{title} - #{description} (#{identifiers})".
+ Explain the vulnerability "#{title} - (#{identifiers})".
The vulnerable code is in the file "#{filename}".
Provide a code example with syntax highlighting on how an attacker can take advantage of the vulnerability.
Provide a code example with syntax highlighting on how to fix it.
@@ -127,7 +127,7 @@ def prompt_without_code
def prompt_without_file_or_code
<<~PROMPT
You are a software vulnerability developer.
- Explain the vulnerability "#{title} - #{description} (#{identifiers})".
+ Explain the vulnerability "#{title} - (#{identifiers})".
Provide a code example with syntax highlighting on how an attacker can take advantage of the vulnerability.
Provide a code example with syntax highlighting on how to fix it.
Provide the response in markdown format with headers.
diff --git a/ee/spec/lib/gitlab/llm/templates/explain_vulnerability_spec.rb b/ee/spec/lib/gitlab/llm/templates/explain_vulnerability_spec.rb
index b00ef620a3f4..186150a3859a 100644
--- a/ee/spec/lib/gitlab/llm/templates/explain_vulnerability_spec.rb
+++ b/ee/spec/lib/gitlab/llm/templates/explain_vulnerability_spec.rb
@@ -86,10 +86,6 @@
expect(subject.to_prompt).to include(vulnerability.title)
end
- it 'includes the description' do
- expect(subject.to_prompt).to include(vulnerability.description)
- end
-
it 'includes the identifiers' do
expect(subject.to_prompt).to include(identifiers)
end
@@ -105,7 +101,7 @@
it 'customizes the prompt' do
expect(subject.to_prompt).to eq(<<~PROMPT)
You are a software vulnerability developer.
- Explain the vulnerability "#{vulnerability.title} - #{vulnerability.description} (#{identifiers})".
+ Explain the vulnerability "#{vulnerability.title} - (#{identifiers})".
The file "#{File.basename(vulnerability.file)}" has this vulnerable code:
```
@@ -238,7 +234,7 @@
let(:expected) do
<<~PROMPT
You are a software vulnerability developer.
- Explain the vulnerability "#{vulnerability.title} - #{vulnerability.description} (#{identifiers})".
+ Explain the vulnerability "#{vulnerability.title} - (#{identifiers})".
The vulnerable code is in the file "#{File.basename(vulnerability.file)}".
Provide a code example with syntax highlighting on how an attacker can take advantage of the vulnerability.
Provide a code example with syntax highlighting on how to fix it.
@@ -268,7 +264,7 @@
let(:expected) do
<<~PROMPT
You are a software vulnerability developer.
- Explain the vulnerability "#{vulnerability.title} - #{vulnerability.description} (#{identifiers})".
+ Explain the vulnerability "#{vulnerability.title} - (#{identifiers})".
Provide a code example with syntax highlighting on how an attacker can take advantage of the vulnerability.
Provide a code example with syntax highlighting on how to fix it.
Provide the response in markdown format with headers.
diff --git a/ee/spec/requests/api/graphql/explain_vulnerability_prompt_spec.rb b/ee/spec/requests/api/graphql/explain_vulnerability_prompt_spec.rb
index 01145b6fe696..eb3e8073dcc9 100644
--- a/ee/spec/requests/api/graphql/explain_vulnerability_prompt_spec.rb
+++ b/ee/spec/requests/api/graphql/explain_vulnerability_prompt_spec.rb
@@ -103,7 +103,7 @@
is_expected.to eq(
<<~PROMPT
You are a software vulnerability developer.
- Explain the vulnerability \"#{vulnerability.title} - #{vulnerability.description} ()\".
+ Explain the vulnerability \"#{vulnerability.title} - ()\".
The file \"main.c\" has this vulnerable code:
```
@@ -135,7 +135,7 @@
is_expected.to eq(
<<~PROMPT
You are a software vulnerability developer.
- Explain the vulnerability \"#{vulnerability.title} - #{vulnerability.description} ()\".
+ Explain the vulnerability \"#{vulnerability.title} - ()\".
The vulnerable code is in the file "main.c".
Provide a code example with syntax highlighting on how an attacker can take advantage of the vulnerability.
Provide a code example with syntax highlighting on how to fix it.
@@ -152,7 +152,7 @@
is_expected.to eq(
<<~PROMPT
You are a software vulnerability developer.
- Explain the vulnerability \"#{vulnerability.title} - #{vulnerability.description} (CVE-2018-1234)\".
+ Explain the vulnerability \"#{vulnerability.title} - (CVE-2018-1234)\".
The vulnerable code is in the file "App.java".
Provide a code example with syntax highlighting on how an attacker can take advantage of the vulnerability.
Provide a code example with syntax highlighting on how to fix it.
--
GitLab