Merge remote-tracking branch 'thesis/seemantsingh/thesis/main' into feature/ChatGPTIntegration

Author: koelibri

AI_INTEGRATION_README.md

@@ -0,0 +1,82 @@
+# AI Feedback Integration in CodeOcean
+
+This project integrates ChatGPT into CodeOcean to provide automated feedback for both **Request for Comments (RFCs)** and **test results**.
+
+## Prerequisites
+
+- **API Key:** Stored securely via Rails credentials
+- **Internal User:** Requires an internal user (`chatgpt@example.org`) to create comments
+- **Gem Required:** `gem 'ruby-openai'`
+
+## Overview
+
+- **AI API:** OpenAI Chat Completions
+- **Jobs:** Asynchronous processing via Solid Queue
+- **Frontend:** Adds "Request Feedback from AI" buttons for test results on Score
+
+## Key Components
+
+###  ChatGPT Service
+
+Encapsulates API communication with ChatGPT.
+
+- **Implementation:** [`app/services/chat_gpt_service/chat_gpt_request.rb`](app/services/chat_gpt_service/chat_gpt_request.rb)
+- **Prompt files:** [`app/services/chat_gpt_service/chat_gpt_prompts/`](app/services/chat_gpt_service/chat_gpt_prompts/) (EN and DE versions)
+- **Structured Output Schema:** [`app/services/chat_gpt_service/chat_gpt_prompts/response_format.json`](app/services/chat_gpt_service/chat_gpt_prompts/response_format.json)
+
+**Key Method:**
+- `execute(prompt, structured_output)`: Sends prompt and receives response
+
+###  ChatGPT Helper
+
+Responsible for formatting prompts and parsing responses.
+
+- [`app/helpers/chat_gpt_helper.rb`](app/helpers/chat_gpt_helper.rb)
+- `format_prompt`: Loads locale-specific templates and replaces placeholders in the prompt from application
+- `format_response`: Parses structured JSON response from chatGPT to create general commenta(line 0) and line comments for RFC.
+
+###  Automatic Comment Job (RFC)
+
+Handles background comment generation when students submit a Request for Comments.
+
+- **Job class:** [`GenerateAutomaticCommentsJob`](app/jobs/generate_automatic_comments_job.rb)
+- **Service:** Uses `ChatGptRequest` to communicate with the API
+- **Process:**
+  1. Prompts are built from student code and context
+  2. API response is parsed
+  3. General and line-specific comments are created
+  4. Emails are sent using Solid Queue
+
+### ️Request Feedback From AI
+
+Allows students to request feedback per test result after scoring.
+
+- **Output modification:**  
+  [`app/models/submission.rb`](app/models/submission.rb)  
+  Adds `testrun_id` to each test result:
+  ```ruby
+  output.merge!(filename:, message: feedback_message(file, output), weight: file.weight, hidden_feedback: file.hidden_feedback, testrun_id: testrun.id)
+  ```
+
+- **Frontend integration:**  
+  [`app/assets/javascripts/editor/editor.js.erb`](app/assets/javascripts/editor/editor.js.erb)  
+  ```js
+  card.attr('data-testrun-id', result.testrun_id); // Add testrun_id to the card
+  ```
+
+- **Triggering feedback request:**  
+  [`app/assets/javascripts/editor.js`](app/assets/javascripts/editor.js)  
+  Handles button click, calls backend route, and updates the UI with the ChatGPT feedback.
+
+- **Route and logic:**  
+  - [`app/controllers/submissions_controller.rb`](app/controllers/submissions_controller.rb): Handles `/testrun_ai_feedback_message` route  
+  - [`app/models/testrun.rb`](app/models/testrun.rb): Contains `generate_ai_feedback` method that builds prompt and fetches response
+
+###  Exercise-Level Controls
+
+Instructors can toggle AI features per exercise using boolean flags:
+
+- `allow_ai_comment_for_rfc`: Enables RFC-based AI feedback
+- `allow_ai_feedback_on_score`: Enables test-based feedback
+
+---

Gemfile

@@ -57,6 +57,8 @@ gem 'turbolinks'
 gem 'webauthn'
 gem 'whenever', require: false
 gem 'zxcvbn-ruby', require: 'zxcvbn'
+gem 'ruby-openai'
+
 
 # Error Tracing
 gem 'mnemosyne-ruby'

Gemfile.lock

@@ -155,6 +155,7 @@ GEM
     erubi (1.13.1)
     et-orbi (1.2.11)
       tzinfo
+    event_stream_parser (1.0.0)
     eventmachine (1.2.7)
     excon (1.2.3)
     execjs (2.10.0)
@@ -167,6 +168,10 @@ GEM
       faraday-net_http (>= 2.0, < 3.5)
       json
       logger
+    faraday-multipart (1.0.4)
+      multipart-post (~> 2)
+    faraday-net_http (3.3.0)
+      net-http
     faraday-net_http (3.4.0)
       net-http (>= 0.5.0)
     faraday-net_http_persistent (2.3.0)
@@ -281,6 +286,7 @@ GEM
     multi_json (1.15.0)
     multi_xml (0.7.1)
       bigdecimal (~> 3.1)
+    multipart-post (2.4.1)
     nested_form (0.3.2)
     net-http (0.6.0)
       uri
@@ -466,6 +472,10 @@ GEM
     rubocop-rspec_rails (2.30.0)
       rubocop (~> 1.61)
       rubocop-rspec (~> 3, >= 3.0.1)
+    ruby-openai (7.3.1)
+      event_stream_parser (>= 0.3.0, < 2.0.0)
+      faraday (>= 1)
+      faraday-multipart (>= 1)
     ruby-progressbar (1.13.0)
     ruby-vips (2.2.2)
       ffi (~> 1.12)
@@ -676,6 +686,7 @@ DEPENDENCIES
   rubocop-rails
   rubocop-rspec
   rubocop-rspec_rails
+  ruby-openai
   rubytree
   rubyzip
   sassc-rails

app/assets/javascripts/editor.js

@@ -82,3 +82,50 @@ $(document).on('turbolinks:load', function(event) {
 
   $(document).on('theme:change', handleThemeChangeEvent.bind(this));
 });
+
+$(document).on('click', '.ai-feedback-link', function (e) {
+  e.preventDefault();
+
+  const testrunId = $(this).data('testrun_id');
+  const $button = $(this);
+
+  if (!testrunId) {
+    alert("No Testrun ID available for this feedback.");
+    return;
+  }
+
+  $.ajax({
+    url: `/submissions/testrun_ai_feedback`,
+    type: 'POST',
+    data: { testrun_id: testrunId },
+    beforeSend: function () {
+      $button.html(
+          '<div class="spinner-border spinner-border-sm" role="status"><span class="visually-hidden">Loading...</span></div>'
+      );
+      $button.prop('disabled', true);
+    },
+    success: function (response) {
+      // Find the card containing the button
+      const card = $button.closest('.card');
+
+      if (card.length) {
+        // Update the feedback message in the card
+        card.find('.row .col-md-9').eq(2).html(response);
+
+        // Hide or remove the button after feedback is displayed
+        $button.remove();
+      } else {
+        console.error("Card not found for testrun_id:", testrunId);
+      }
+    },
+    error: function (xhr) {
+      alert(`Failed to fetch feedback: ${xhr.responseText}`);
+      // Re-enable the button in case of an error
+      $button.html("Request Feedback from AI");
+      $button.prop('disabled', false);
+    },
+    complete: function () {
+      // No action needed here since button is removed on success
+    }
+  });
+});

app/assets/javascripts/editor/editor.js.erb

@@ -573,6 +573,7 @@ var CodeOceanEditor = {
         card.find('.card-title .number').text(index + 1);
         card.find('.row .col-md-9').eq(0).find('.number').eq(0).text(result.passed);
         card.find('.row .col-md-9').eq(0).find('.number').eq(1).text(result.count);
+        card.attr('data-testrun-id', result.testrun_id); // Add testrun_id to the card
         if (result.weight !== 0) {
             card.find('.row .col-md-9').eq(1).find('.number').eq(0).text(parseFloat((result.score * result.weight).toFixed(2)));
             card.find('.row .col-md-9').eq(1).find('.number').eq(1).text(result.weight);
@@ -581,6 +582,10 @@ var CodeOceanEditor = {
             card.find('.attribute-row.row').eq(1).addClass('d-none');
         }
         card.find('.row .col-md-9').eq(2).html(result.message);
+        if (result.testrun_id) {
+            const aiFeedbackLink = card.find('.ai-feedback-link');
+            aiFeedbackLink.data('testrun_id', result.testrun_id);
+        }
 
         // Add error message from code to card
         if (result.error_messages) {

app/assets/javascripts/request_for_comments.js

@@ -66,11 +66,12 @@ $(document).on('turbolinks:load', function () {
         // set editor mode (used for syntax highlighting
         currentEditor.getSession().setMode($(editor).data('mode'));
         currentEditor.setTheme(CodeOceanEditor.THEME);
-
         currentEditor.commentVisualsByLine = {};
         setAnnotations(currentEditor, $(editor).data('file-id'));
         currentEditor.on("guttermousedown", handleSidebarClick);
         currentEditor.on("guttermousemove", showPopover);
+        currentEditor.getSession().setOption("useWorker", false);
+
     });
 
     const handleAceThemeChangeEvent = function() {

app/controllers/exercises_controller.rb

@@ -210,6 +210,8 @@ def exercise_params
                              :hide_file_tree,
                              :allow_file_creation,
                              :allow_auto_completion,
+                             :allow_ai_comment_for_rfc,
+                             :allow_ai_feedback_on_score,
                              :title,
                              :internal_title,
                              :expected_difficulty,

app/controllers/request_for_comments_controller.rb

@@ -153,6 +153,9 @@ def create
           format.json { render json: {danger: t('exercises.editor.depleted'), status: :container_depleted}, status: :service_unavailable }
         else
           format.json { render :show, status: :created, location: @request_for_comment }
+          if @request_for_comment.submission.exercise.allow_ai_comment_for_rfc
+            GenerateAutomaticCommentsJob.perform_later(@request_for_comment, current_user)
+          end
         end
       else
         format.html { render :new }

app/controllers/submissions_controller.rb

@@ -21,6 +21,7 @@ class SubmissionsController < ApplicationController
   skip_before_action :verify_authenticity_token, only: %i[render_file download_file]
   skip_before_action :deny_access_from_render_host, only: :render_file
   skip_before_action :require_fully_authenticated_user!, only: :render_file
+  skip_after_action :verify_authorized, only: :testrun_ai_feedback_message
 
   def index
     @search = policy_scope(Submission).ransack(params[:q])
@@ -335,6 +336,19 @@ def test
     kill_client_socket(client_socket)
   end
 
+  def testrun_ai_feedback_message
+    testrun = Testrun.find(params[:testrun_id])
+
+    # Use the generate_feedback method from the Testrun model
+    feedback_message = testrun.generate_ai_feedback
+
+    if feedback_message.present?
+      render plain: feedback_message, status: :ok
+    else
+      render plain: 'Failed to generate feedback.', status: :unprocessable_entity
+    end
+  end
+
   private
 
   def authorize!

app/helpers/chat_gpt_helper.rb

@@ -0,0 +1,47 @@
+
+module ChatGptHelper
+
+  def self.format_prompt(options)
+    if I18n.locale == :en
+      file_path = Rails.root.join('app', 'services/chat_gpt_service/chat_gpt_prompts', 'prompt_en.xml')
+      prompt = File.read(file_path)
+      prompt.gsub!("[Learner's Code]", options[:learner_solution] || "")
+      prompt.gsub!("[Task]", options[:exercise] || "")
+      prompt.gsub!("[Error Message]", options[:test_results] || "")
+      prompt.gsub!("[Student Question]", options[:question] || "")
+    else
+      file_path = Rails.root.join('app', 'services/chat_gpt_service/chat_gpt_prompts', 'prompt_de.xml')
+      prompt = File.read(file_path)
+      prompt.gsub!("[Code des Lernenden]", options[:learner_solution] || "")
+      prompt.gsub!("[Aufgabenstellung]", options[:exercise] || "")
+      prompt.gsub!("[Fehlermeldung]", options[:test_results] || "")
+      prompt.gsub!("[Frage des Studierenden]", options[:question] || "")
+    end
+
+    prompt
+  end
+
+  def self.format_response(response)
+    parsed_response = JSON.parse(response)
+    requirements_comments = ''
+    if parsed_response['requirements']
+      requirements_comments = parsed_response['requirements'].map { |req| req['comment'] }.join("\n")
+    end
+
+    line_specific_comments = []
+    if parsed_response['line_specific_comments']
+      line_specific_comments = parsed_response['line_specific_comments'].map do |line_comment|
+        {
+          line_number: line_comment['line_number'],
+          comment: line_comment['comment']
+        }
+      end
+    end
+
+    {
+      requirements_comments: requirements_comments,
+      line_specific_comments: line_specific_comments
+    }
+  end
+
+end