2023-03-15 16:02:20 -04:00
# frozen_string_literal: true
RSpec . describe DiscourseAi :: AiHelper :: AssistantController do
2024-06-19 17:01:35 -04:00
before { assign_fake_provider_to ( :ai_helper_model ) }
2024-01-29 14:04:25 -05:00
2023-03-15 16:02:20 -04:00
describe " # suggest " do
2023-11-27 07:33:31 -05:00
let ( :text_to_proofread ) { " The rain in spain stays mainly in the plane. " }
2024-01-19 06:51:26 -05:00
let ( :proofread_text ) { " The rain in Spain, stays mainly in the Plane. " }
2023-11-27 07:33:31 -05:00
let ( :mode ) { CompletionPrompt :: PROOFREAD }
2023-03-15 16:02:20 -04:00
context " when not logged in " do
it " returns a 403 response " do
2023-11-27 07:33:31 -05:00
post " /discourse-ai/ai-helper/suggest " , params : { text : text_to_proofread , mode : mode }
2023-03-15 16:02:20 -04:00
expect ( response . status ) . to eq ( 403 )
end
end
context " when logged in as an user without enough privileges " do
fab! ( :user ) { Fabricate ( :newuser ) }
before do
sign_in ( user )
2024-08-12 18:40:23 -04:00
SiteSetting . composer_ai_helper_allowed_groups = Group :: AUTO_GROUPS [ :staff ]
2023-03-15 16:02:20 -04:00
end
it " returns a 403 response " do
2023-11-27 07:33:31 -05:00
post " /discourse-ai/ai-helper/suggest " , params : { text : text_to_proofread , mode : mode }
2023-03-15 16:02:20 -04:00
expect ( response . status ) . to eq ( 403 )
end
end
context " when logged in as an allowed user " do
2024-03-05 10:48:28 -05:00
fab! ( :user )
2023-03-15 16:02:20 -04:00
before do
sign_in ( user )
user . group_ids = [ Group :: AUTO_GROUPS [ :trust_level_1 ] ]
2024-08-12 18:40:23 -04:00
SiteSetting . composer_ai_helper_allowed_groups = Group :: AUTO_GROUPS [ :trust_level_1 ]
2023-03-15 16:02:20 -04:00
end
it " returns a 400 if the helper mode is invalid " do
invalid_mode = " asd "
2023-11-27 07:33:31 -05:00
post " /discourse-ai/ai-helper/suggest " ,
params : {
text : text_to_proofread ,
mode : invalid_mode ,
}
2023-03-15 16:02:20 -04:00
expect ( response . status ) . to eq ( 400 )
end
it " returns a 400 if the text is blank " do
post " /discourse-ai/ai-helper/suggest " , params : { mode : mode }
expect ( response . status ) . to eq ( 400 )
end
2023-03-22 15:00:28 -04:00
it " returns a generic error when the completion call fails " do
2023-11-28 23:17:46 -05:00
DiscourseAi :: Completions :: Llm
2023-11-27 07:33:31 -05:00
. any_instance
2024-01-04 07:53:47 -05:00
. expects ( :generate )
2023-11-27 07:33:31 -05:00
. raises ( DiscourseAi :: Completions :: Endpoints :: Base :: CompletionFailed )
2023-03-22 15:00:28 -04:00
2023-11-27 07:33:31 -05:00
post " /discourse-ai/ai-helper/suggest " , params : { mode : mode , text : text_to_proofread }
2023-03-22 15:00:28 -04:00
expect ( response . status ) . to eq ( 502 )
end
2023-03-15 16:02:20 -04:00
it " returns a suggestion " do
2023-11-27 07:33:31 -05:00
expected_diff =
" <div class= \" inline-diff \" ><p>The rain in <ins>Spain</ins><ins>,</ins><ins> </ins><del>spain </del>stays mainly in the <ins>Plane</ins><del>plane</del>.</p></div> "
2023-03-15 16:02:20 -04:00
2024-01-19 06:51:26 -05:00
DiscourseAi :: Completions :: Llm . with_prepared_responses ( [ proofread_text ] ) do
2023-11-27 07:33:31 -05:00
post " /discourse-ai/ai-helper/suggest " , params : { mode : mode , text : text_to_proofread }
2023-03-15 16:02:20 -04:00
2023-11-27 07:33:31 -05:00
expect ( response . status ) . to eq ( 200 )
2024-01-19 06:51:26 -05:00
expect ( response . parsed_body [ " suggestions " ] . first ) . to eq ( proofread_text )
2023-11-27 07:33:31 -05:00
expect ( response . parsed_body [ " diff " ] ) . to eq ( expected_diff )
end
2023-03-15 16:02:20 -04:00
end
2023-12-11 17:26:56 -05:00
it " uses custom instruction when using custom_prompt mode " do
translated_text = " Un usuario escribio esto "
expected_diff =
" <div class= \" inline-diff \" ><p><ins>Un </ins><ins>usuario </ins><ins>escribio </ins><ins>esto</ins><del>A </del><del>user </del><del>wrote </del><del>this</del></p></div> "
2024-01-29 14:04:25 -05:00
DiscourseAi :: Completions :: Llm . with_prepared_responses ( [ translated_text ] ) do
2023-12-11 17:26:56 -05:00
post " /discourse-ai/ai-helper/suggest " ,
params : {
mode : CompletionPrompt :: CUSTOM_PROMPT ,
text : " A user wrote this " ,
custom_prompt : " Translate to Spanish " ,
}
expect ( response . status ) . to eq ( 200 )
expect ( response . parsed_body [ " suggestions " ] . first ) . to eq ( translated_text )
expect ( response . parsed_body [ " diff " ] ) . to eq ( expected_diff )
end
end
2024-10-02 13:36:35 -04:00
2024-11-27 18:12:27 -05:00
it " prevents double render when mode is ILLUSTRATE_POST " do
DiscourseAi :: Completions :: Llm . with_prepared_responses ( [ proofread_text ] ) do
expect {
post " /discourse-ai/ai-helper/suggest " ,
params : {
mode : CompletionPrompt :: ILLUSTRATE_POST ,
text : text_to_proofread ,
force_default_locale : true ,
}
} . not_to raise_error
expect ( response . status ) . to eq ( 200 )
end
end
2024-10-02 13:36:35 -04:00
context " when performing numerous requests " do
it " rate limits " do
RateLimiter . enable
rate_limit = described_class :: RATE_LIMITS [ " default " ]
amount = rate_limit [ :amount ]
amount . times do
post " /discourse-ai/ai-helper/suggest " , params : { mode : mode , text : text_to_proofread }
expect ( response . status ) . to eq ( 200 )
end
DiscourseAi :: Completions :: Llm . with_prepared_responses ( [ proofread_text ] ) do
post " /discourse-ai/ai-helper/suggest " , params : { mode : mode , text : text_to_proofread }
expect ( response . status ) . to eq ( 429 )
end
end
end
2023-03-15 16:02:20 -04:00
end
end
2024-02-19 12:56:28 -05:00
describe " # caption_image " do
2024-06-27 15:24:44 -04:00
let ( :image ) { plugin_file_from_fixtures ( " 100x100.jpg " ) }
let ( :upload ) { UploadCreator . new ( image , " image.jpg " ) . create_for ( Discourse . system_user . id ) }
2024-02-19 21:43:39 -05:00
let ( :image_url ) { " #{ Discourse . base_url } #{ upload . url } " }
2024-02-19 12:56:28 -05:00
let ( :caption ) { " A picture of a cat sitting on a table " }
2024-02-21 13:10:22 -05:00
let ( :caption_with_attrs ) do
" A picture of a cat sitting on a table ( #{ I18n . t ( " discourse_ai.ai_helper.image_caption.attribution " ) } ) "
end
2024-10-23 17:38:29 -04:00
let ( :bad_caption ) { " A picture of a cat \n sitting on a |table| " }
2024-02-19 12:56:28 -05:00
2024-07-24 15:29:47 -04:00
before { assign_fake_provider_to ( :ai_helper_image_caption_model ) }
2024-10-23 17:38:29 -04:00
def request_caption ( params , caption = " A picture of a cat sitting on a table " )
2024-07-24 15:29:47 -04:00
DiscourseAi :: Completions :: Llm . with_prepared_responses ( [ caption ] ) do
post " /discourse-ai/ai-helper/caption_image " , params : params
yield ( response )
end
end
2024-02-19 12:56:28 -05:00
context " when logged in as an allowed user " do
2024-02-19 21:43:39 -05:00
fab! ( :user ) { Fabricate ( :user , refresh_auto_groups : true ) }
2024-02-19 12:56:28 -05:00
before do
sign_in ( user )
2024-08-12 18:40:23 -04:00
SiteSetting . composer_ai_helper_allowed_groups = Group :: AUTO_GROUPS [ :trust_level_1 ]
2024-02-19 12:56:28 -05:00
end
it " returns the suggested caption for the image " do
2024-07-24 15:29:47 -04:00
request_caption ( { image_url : image_url , image_url_type : " long_url " } ) do | r |
expect ( r . status ) . to eq ( 200 )
expect ( r . parsed_body [ " caption " ] ) . to eq ( caption_with_attrs )
2024-10-23 17:38:29 -04:00
end
end
it " returns a cleaned up caption from the LLM " do
request_caption ( { image_url : image_url , image_url_type : " long_url " } , bad_caption ) do | r |
expect ( r . status ) . to eq ( 200 )
expect ( r . parsed_body [ " caption " ] ) . to eq ( caption_with_attrs )
2024-07-24 15:29:47 -04:00
end
2024-02-19 12:56:28 -05:00
end
2024-11-12 13:52:46 -05:00
it " truncates the caption from the LLM " do
request_caption ( { image_url : image_url , image_url_type : " long_url " } , caption * 10 ) do | r |
expect ( r . status ) . to eq ( 200 )
expect ( r . parsed_body [ " caption " ] . size ) . to be < caption . size * 10
end
end
2024-05-27 13:49:24 -04:00
context " when the image_url is a short_url " do
let ( :image_url ) { upload . short_url }
it " returns the suggested caption for the image " do
2024-07-24 15:29:47 -04:00
request_caption ( { image_url : image_url , image_url_type : " short_url " } ) do | r |
expect ( r . status ) . to eq ( 200 )
expect ( r . parsed_body [ " caption " ] ) . to eq ( caption_with_attrs )
end
2024-05-27 13:49:24 -04:00
end
end
context " when the image_url is a short_path " do
let ( :image_url ) { " #{ Discourse . base_url } #{ upload . short_path } " }
it " returns the suggested caption for the image " do
2024-07-24 15:29:47 -04:00
request_caption ( { image_url : image_url , image_url_type : " short_path " } ) do | r |
expect ( r . status ) . to eq ( 200 )
expect ( r . parsed_body [ " caption " ] ) . to eq ( caption_with_attrs )
end
end
end
it " returns a 502 error when the completion call fails " do
DiscourseAi :: Completions :: Llm . with_prepared_responses (
[ DiscourseAi :: Completions :: Endpoints :: Base :: CompletionFailed . new ] ,
) do
2024-05-27 13:49:24 -04:00
post " /discourse-ai/ai-helper/caption_image " ,
params : {
image_url : image_url ,
2024-07-24 15:29:47 -04:00
image_url_type : " long_url " ,
2024-05-27 13:49:24 -04:00
}
2024-07-24 15:29:47 -04:00
expect ( response . status ) . to eq ( 502 )
2024-05-27 13:49:24 -04:00
end
end
2024-02-19 12:56:28 -05:00
it " returns a 400 error when the image_url is blank " do
post " /discourse-ai/ai-helper/caption_image "
expect ( response . status ) . to eq ( 400 )
end
2024-02-19 21:43:39 -05:00
it " returns a 404 error if no upload is found " do
post " /discourse-ai/ai-helper/caption_image " ,
params : {
image_url : " http://blah.com/img.jpeg " ,
2024-05-27 13:49:24 -04:00
image_url_type : " long_url " ,
2024-02-19 21:43:39 -05:00
}
expect ( response . status ) . to eq ( 404 )
end
context " for secure uploads " do
2024-03-05 10:48:28 -05:00
fab! ( :group )
2024-02-19 21:43:39 -05:00
fab! ( :private_category ) { Fabricate ( :private_category , group : group ) }
2024-06-27 15:24:44 -04:00
let ( :image ) { plugin_file_from_fixtures ( " 100x100.jpg " ) }
let ( :upload ) { UploadCreator . new ( image , " image.jpg " ) . create_for ( Discourse . system_user . id ) }
2024-02-19 21:43:39 -05:00
let ( :image_url ) { " #{ Discourse . base_url } /secure-uploads/ #{ upload . url } " }
2024-06-27 15:24:44 -04:00
before do
Jobs . run_immediately!
# this is done so the after_save callbacks for site settings to make
# UploadReference records works
@original_provider = SiteSetting . provider
SiteSetting . provider = SiteSettings :: DbProvider . new ( SiteSetting )
setup_s3
stub_s3_store
2024-07-24 15:29:47 -04:00
assign_fake_provider_to ( :ai_helper_image_caption_model )
2024-06-27 15:24:44 -04:00
SiteSetting . secure_uploads = true
2024-08-12 18:40:23 -04:00
SiteSetting . composer_ai_helper_allowed_groups = Group :: AUTO_GROUPS [ :trust_level_1 ]
2024-07-24 15:29:47 -04:00
2024-08-12 18:40:23 -04:00
Group . find ( SiteSetting . composer_ai_helper_allowed_groups_map . first ) . add ( user )
2024-06-27 15:24:44 -04:00
user . reload
stub_request (
:get ,
" http://s3-upload-bucket.s3.dualstack.us-west-1.amazonaws.com/original/1X/ #{ upload . sha1 } . #{ upload . extension } " ,
) . to_return ( status : 200 , body : " " , headers : { } )
end
after { SiteSetting . provider = @original_provider }
2024-02-19 21:43:39 -05:00
it " returns a 403 error if the user cannot access the secure upload " do
2024-11-13 14:58:24 -05:00
# hosted-site plugin edge case, it enables embeddings
SiteSetting . ai_embeddings_enabled = false
2024-06-27 15:24:44 -04:00
create_post (
title : " Secure upload post " ,
raw : " This is a new post <img src= \" #{ upload . url } \" /> " ,
category : private_category ,
user : Discourse . system_user ,
)
2024-05-27 13:49:24 -04:00
post " /discourse-ai/ai-helper/caption_image " ,
params : {
image_url : image_url ,
image_url_type : " long_url " ,
}
2024-02-19 21:43:39 -05:00
expect ( response . status ) . to eq ( 403 )
end
it " returns a 200 message and caption if user can access the secure upload " do
group . add ( user )
2024-06-27 15:24:44 -04:00
2024-07-24 15:29:47 -04:00
request_caption ( { image_url : image_url , image_url_type : " long_url " } ) do | r |
expect ( r . status ) . to eq ( 200 )
expect ( r . parsed_body [ " caption " ] ) . to eq ( caption_with_attrs )
end
2024-02-19 21:43:39 -05:00
end
context " if the input URL is for a secure upload but not on the secure-uploads path " do
let ( :image_url ) { " #{ Discourse . base_url } #{ upload . url } " }
it " creates a signed URL properly and makes the caption " do
group . add ( user )
2024-07-24 15:29:47 -04:00
request_caption ( { image_url : image_url , image_url_type : " long_url " } ) do | r |
expect ( r . status ) . to eq ( 200 )
expect ( r . parsed_body [ " caption " ] ) . to eq ( caption_with_attrs )
end
2024-02-19 21:43:39 -05:00
end
end
end
2024-10-02 13:36:35 -04:00
context " when performing numerous requests " do
it " rate limits " do
RateLimiter . enable
rate_limit = described_class :: RATE_LIMITS [ " caption_image " ]
amount = rate_limit [ :amount ]
amount . times do
request_caption ( { image_url : image_url , image_url_type : " long_url " } ) do | r |
expect ( r . status ) . to eq ( 200 )
end
end
request_caption ( { image_url : image_url , image_url_type : " long_url " } ) do | r |
expect ( r . status ) . to eq ( 429 )
end
end
end
2024-02-19 12:56:28 -05:00
end
end
2023-03-15 16:02:20 -04:00
end