Return project status and unread feedback count (#633)

## Status

- API part for
RaspberryPiFoundation/digital-editor-issues#955

## What's changed?

- Return `status` and `has_unread_feedback` on student lessons
- Add tests

Author: jamiebenstead

app/controllers/api/lessons_controller.rb

@@ -91,11 +91,16 @@ def user_remixes(lessons)
     end
 
     def user_remix(lesson)
-      lesson.project&.remixes
-            &.where(user_id: current_user.id)
-            &.accessible_by(current_ability)
-            &.order(created_at: :asc)
-            &.first
+      remixes = lesson&.project&.remixes
+
+      remixes = remixes
+                .where(user_id: current_user.id)
+                .accessible_by(current_ability)
+                .order(created_at: :asc)
+
+      remixes = remixes.includes(school_project: :feedback) if current_user&.school_student?(school)
+
+      remixes.first
     end
 
     def lesson_params

app/models/school_project.rb

@@ -19,6 +19,10 @@ def transition_status_to!(new_status, user_id)
     state_machine.transition_to!(new_status, metadata: { changed_by: user_id })
   end
 
+  def unread_feedback?
+    feedback.exists?(read_at: nil)
+  end
+
   # Add convenience methods for each state
   def unsubmitted?
     state_machine.in_state?(:unsubmitted)

app/views/api/lessons/student_index.json.jbuilder

@@ -4,4 +4,8 @@ json.array!(@lessons_with_users_and_remixes) do |lesson_with_user, remix|
   lesson, user = lesson_with_user
   json.partial! 'lesson', lesson: lesson, user: user
   json.remix_identifier(remix.identifier) if remix.present?
+  if remix.present?
+    json.status(remix.school_project&.status)
+    json.has_unread_feedback(remix.school_project&.unread_feedback?)
+  end
 end

spec/features/lesson/listing_lessons_spec.rb

@@ -6,6 +6,7 @@
   before do
     authenticated_in_hydra_as(owner)
     stub_user_info_api_for(teacher)
+    create(:class_student, school_class:, student_id: student.id)
   end
 
   let(:headers) { { Authorization: UserProfileMock::TOKEN } }
@@ -199,6 +200,19 @@
     let!(:lesson) { create(:lesson, school_class:, name: 'Test Lesson', visibility: 'students', user_id: teacher.id) }
     let(:teacher) { create(:teacher, school:) }
 
+    let(:student_project) do
+      create(
+        :project,
+        school:,
+        lesson:,
+        parent: lesson.project,
+        remixed_from_id: lesson.project.id,
+        user_id: student.id
+      )
+    end
+
+    let(:school_project) { student_project.school_project }
+
     it 'includes the lesson when the user owns the lesson' do
       another_teacher = create(:teacher, school:)
       authenticated_in_hydra_as(another_teacher)
@@ -212,8 +226,6 @@
 
     it "includes the lesson when the user is a school-student within the lesson's class" do
       authenticated_in_hydra_as(student)
-      create(:class_student, school_class:, student_id: student.id)
-
       get('/api/lessons', headers:)
       data = JSON.parse(response.body, symbolize_names: true)
 
@@ -222,26 +234,23 @@
 
     it 'does not include the submitted_count when the user is a school-student within the lesson\'s class' do
       authenticated_in_hydra_as(student)
-      create(:class_student, school_class:, student_id: student.id)
-
       get('/api/lessons', headers:)
       data = JSON.parse(response.body, symbolize_names: true)
       expect(data.first).not_to have_key(:submitted_count)
     end
 
     it "includes the remix identifier when the user has remixed the lesson's project" do
-      student = create(:student, school:)
       authenticated_in_hydra_as(student)
-      create(:class_student, school_class:, student_id: student.id)
-      student_project = create(:project, school:, lesson:, parent: lesson.project, user_id: student.id)
+      student_project = create(:project, school:, lesson:, parent: lesson.project, remixed_from_id: lesson.project.id, user_id: student.id)
 
       get('/api/lessons', headers:)
       data = JSON.parse(response.body, symbolize_names: true)
       expect(data.first[:remix_identifier]).to eq(student_project.identifier)
     end
 
     it "does not include the lesson when the user is not a school-student within the lesson's class" do
-      authenticated_in_hydra_as(student)
+      another_student = create(:student, school:)
+      authenticated_in_hydra_as(another_student)
 
       get('/api/lessons', headers:)
       data = JSON.parse(response.body, symbolize_names: true)
@@ -258,5 +267,91 @@
 
       expect(data.size).to eq(0)
     end
+
+    it 'includes has_unread_feedback as true when there is unread feedback' do
+      authenticated_in_hydra_as(student)
+      create(
+        :feedback,
+        school_project: school_project,
+        user_id: teacher.id,
+        content: 'Unread',
+        read_at: nil
+      )
+
+      create(
+        :feedback,
+        school_project: school_project,
+        user_id: teacher.id,
+        content: 'Read',
+        read_at: Time.current
+      )
+
+      get('/api/lessons', headers:)
+      data = JSON.parse(response.body, symbolize_names: true)
+
+      expect(data.first[:has_unread_feedback]).to be(true)
+    end
+
+    it 'includes has_unread_feedback as false when there is no unread feedback' do
+      authenticated_in_hydra_as(student)
+      create(
+        :feedback,
+        school_project: school_project,
+        user_id: teacher.id,
+        content: 'Read',
+        read_at: Time.current
+      )
+
+      get('/api/lessons', headers:)
+      data = JSON.parse(response.body, symbolize_names: true)
+
+      expect(data.first[:has_unread_feedback]).to be(false)
+    end
+
+    it 'includes status when the user is a student' do
+      authenticated_in_hydra_as(student)
+      school_project.transition_status_to!(:submitted, teacher.id)
+
+      get('/api/lessons', headers:)
+      data = JSON.parse(response.body, symbolize_names: true)
+
+      expect(data.size).to eq(1)
+      expect(data.first[:status]).to eq('submitted')
+    end
+
+    it 'includes the default status when no transitions have happened' do
+      authenticated_in_hydra_as(student)
+      create(
+        :project,
+        school:,
+        lesson:,
+        parent: lesson.project,
+        remixed_from_id: lesson.project.id,
+        user_id: student.id
+      )
+
+      get('/api/lessons', headers:)
+      data = JSON.parse(response.body, symbolize_names: true)
+
+      expect(data.first[:status]).to eq('unsubmitted')
+    end
+
+    it 'does not include the status when the user is a teacher' do
+      authenticated_in_hydra_as(teacher)
+
+      get('/api/lessons', headers:)
+      data = JSON.parse(response.body, symbolize_names: true)
+
+      expect(data.first).not_to have_key(:status)
+    end
+
+    it 'does not include has_unread_feedback when the user is a teacher' do
+      authenticated_in_hydra_as(teacher)
+
+      get('/api/lessons', headers:)
+      data = JSON.parse(response.body, symbolize_names: true)
+
+      expect(data.first).not_to have_key(:has_unread_feedback)
+    end
   end
 end

spec/models/school_project_spec.rb

@@ -4,10 +4,14 @@
 
 RSpec.describe SchoolProject do
   let(:state_machine) { instance_double(SchoolProjectStateMachine) }
-  let(:school_project) { create(:school_project, school:, project:) }
-  let(:project) { create(:project, school:, user_id: student.id) }
+  let(:school_class) { create(:school_class, school:, teacher_ids: [teacher.id]) }
+  let(:lesson) { create(:lesson, school:, school_class:, user_id: teacher.id) }
+  let(:school_project) { create(:school_project, school:, project: remix) }
   let(:student) { create(:student, school:) }
   let(:school) { create(:school) }
+  let(:teacher) { create(:teacher, school:) }
+  let(:teacher_project) { create(:project, school:, user_id: teacher.id, lesson:) }
+  let(:remix) { create(:project, school:, user_id: student.id, remixed_from_id: teacher_project.id) }
 
   before do
     allow(school_project).to receive(:state_machine).and_return(state_machine)
@@ -20,7 +24,7 @@
 
   describe '#status' do
     it 'defaults to unsubmitted' do
-      new_school_project = create(:school_project, school:, project:)
+      new_school_project = create(:school_project, school:, project: teacher_project)
       expect(new_school_project.status).to eq('unsubmitted')
     end
 
@@ -73,4 +77,44 @@
       expect(state_machine).to have_received(:history)
     end
   end
+
+  describe '#unread_feedback?' do
+    it 'returns true if there is unread feedback for the school project' do
+      create_list(
+        :feedback,
+        3,
+        school_project: school_project,
+        read_at: nil,
+        content: 'Unread',
+        user_id: teacher.id
+      )
+
+      create_list(
+        :feedback,
+        2,
+        school_project: school_project,
+        read_at: Time.current,
+        content: 'Read',
+        user_id: teacher.id
+      )
+
+      expect(school_project.unread_feedback?).to be true
+    end
+
+    it 'returns false if all feedback is read' do
+      create_list(
+        :feedback,
+        2,
+        school_project: school_project,
+        read_at: Time.current,
+        content: 'Read',
+        user_id: teacher.id
+      )
+      expect(school_project.unread_feedback?).to be false
+    end
+
+    it 'returns false when there is no feedback' do
+      expect(school_project.unread_feedback?).to be false
+    end
+  end
 end