Track project workflow analytics events

abcampo-iry · abcampo-iry · commit f19575cbee4d · 2026-06-16T16:22:20.000+02:00
diff --git a/app/controllers/api/feedback_controller.rb b/app/controllers/api/feedback_controller.rb
@@ -24,6 +24,7 @@ def create
 
       if result.success?
         @feedback = result[:feedback]
+        track_project_event('Project - Feedback given', project)
         render :show, formats: [:json], status: :created
       else
         render json: { error: result[:error] }, status: :unprocessable_content
diff --git a/app/controllers/api/lessons/batch_controller.rb b/app/controllers/api/lessons/batch_controller.rb
@@ -18,6 +18,7 @@ def create_batch
           lessons_params: batch_lessons_params
         )
         @user = current_user
+        @results.select(&:success?).each { |result| track_project_event('Project - Created', result[:lesson].project) }
         render :create_batch, formats: [:json], status: :created
       end
 
diff --git a/app/controllers/api/lessons_controller.rb b/app/controllers/api/lessons_controller.rb
@@ -33,6 +33,7 @@ def show
     def create
       result = Lesson::Create.call(lesson_params: create_params)
       if result.success?
+        track_project_event('Project - Created', result[:lesson].project)
         @lesson_with_user = result[:lesson].with_user
         render :show, formats: [:json], status: :created
       else
@@ -54,9 +55,11 @@ def create_copy
     def update
       # TODO: Consider removing user_id from the lesson_params for update so users can update other users' lessons without changing ownership
       # OR consider dropping user_id on lessons and using teacher id/ids on the class instead
+      previous_visibility = @lesson.visibility
       result = Lesson::Update.call(lesson: @lesson, lesson_params: update_params)
 
       if result.success?
+        track_project_event('Project - Made visible', result[:lesson].project) if previous_visibility != 'students' && result[:lesson].visibility == 'students'
         @lesson_with_user = result[:lesson].with_user
         render :show, formats: [:json], status: :ok
       else
diff --git a/app/controllers/api/projects/remixes_controller.rb b/app/controllers/api/projects/remixes_controller.rb
@@ -36,6 +36,7 @@ def create
 
         if result.success?
           @project = result[:project]
+          track_project_event('Project - Saved', @project)
           render '/api/projects/show', formats: [:json]
         else
           render json: { error: result[:error] }, status: :bad_request
diff --git a/app/controllers/api/projects_controller.rb b/app/controllers/api/projects_controller.rb
@@ -17,6 +17,8 @@ def index
     end
 
     def show
+      track_project_event('Project - Opened', @project) if current_user.present?
+
       if !@project.school_id.nil? && @project.lesson_id.nil?
         project_with_user = @project.with_student(current_user)
         @user = project_with_user[1]
@@ -31,6 +33,7 @@ def create
 
       if result.success?
         @project = result[:project]
+        track_project_event('Project - Created', @project)
         render :show, formats: [:json], status: :created
       else
         render json: { error: result[:error] }, status: :unprocessable_content
@@ -41,6 +44,7 @@ def update
       result = Project::Update.call(project: @project, update_hash: project_params, current_user:)
 
       if result.success?
+        track_project_event('Project - Saved', @project)
         render :show, formats: [:json]
       else
         render json: { error: result[:error] }, status: :unprocessable_content
diff --git a/app/controllers/api/school_projects_controller.rb b/app/controllers/api/school_projects_controller.rb
@@ -23,9 +23,11 @@ def unsubmit
 
     def submit
       authorize! :submit, school_project
+      previous_status = school_project.status
       result = SchoolProject::SetStatus.call(school_project:, status: :submitted, user_id: current_user.id)
       if result.success?
         @school_project = result[:school_project]
+        track_project_event('Project - Submitted for review', @school_project.project) if previous_status != 'submitted'
         render :show_status, formats: [:json], status: :ok
       else
         render json: { error: result[:error] }, status: :unprocessable_content
@@ -45,9 +47,11 @@ def return
 
     def complete
       authorize! :complete, school_project
+      previous_status = school_project.status
       result = SchoolProject::SetStatus.call(school_project:, status: :complete, user_id: current_user.id)
       if result.success?
         @school_project = result[:school_project]
+        track_project_event('Project - Marked as completed', @school_project.project) if previous_status != 'complete'
         render :show_status, formats: [:json], status: :ok
       else
         render json: { error: result[:error] }, status: :unprocessable_content
diff --git a/app/controllers/api/scratch/projects_controller.rb b/app/controllers/api/scratch/projects_controller.rb
@@ -27,6 +27,7 @@ def create
           scratch_component.content = scratch_content_params
           existing_remix.save!
           move_assets_uploaded_by_current_user_before_remix(original_project:, remix_project: existing_remix)
+          track_project_event('Project - Saved', existing_remix)
 
           return render json: { status: 'ok', 'content-name': existing_remix.identifier }, status: :ok
         end
@@ -42,6 +43,7 @@ def create
 
         if result.success?
           move_assets_uploaded_by_current_user_before_remix(original_project:, remix_project: result[:project])
+          track_project_event('Project - Saved', result[:project])
           render json: { status: 'ok', 'content-name': result[:project].identifier }, status: :ok
         else
           render json: { error: result[:error] }, status: :bad_request
@@ -51,6 +53,7 @@ def create
       def update
         @project.scratch_component&.content = scratch_content_params
         @project.save!
+        track_project_event('Project - Saved', @project)
         render json: { status: 'ok' }, status: :ok
       end
 
diff --git a/spec/features/feedback/creating_feedback_spec.rb b/spec/features/feedback/creating_feedback_spec.rb
@@ -46,6 +46,24 @@
       it 'adds the feedback to the school project' do
         expect(student_project.school_project.feedback.count).to eq(1)
       end
+
+      it 'records a project feedback given event' do
+        event = Event.last
+
+        expect(event).to have_attributes(
+          name: 'Project - Feedback given',
+          user_id: teacher.id,
+          properties: {
+            'school_id' => school.id,
+            'class_id' => school_class.id,
+            'lesson_id' => lesson.id,
+            'project_type' => Project::Types::PYTHON,
+            'user_role' => 'educator',
+            'student_id' => student.id
+          },
+          time: be_within(1.second).of(Time.current)
+        )
+      end
     end
 
     context 'when leaving feedback on a project that is not student work' do
diff --git a/spec/features/lesson/creating_a_batch_of_lessons_spec.rb b/spec/features/lesson/creating_a_batch_of_lessons_spec.rb
@@ -127,6 +127,24 @@
       expect(response).to have_http_status(:created)
     end
 
+    it 'records project created events for each created lesson project' do
+      events = Event.where(name: 'Project - Created')
+
+      expect(events.count).to eq(2)
+      expect(events.map(&:user_id)).to all(eq(teacher.id))
+      expect(events.map(&:properties)).to match_array(
+        Lesson.order(:created_at).map do |lesson|
+          {
+            'school_id' => school.id,
+            'class_id' => school_class.id,
+            'lesson_id' => lesson.id,
+            'project_type' => Project::Types::CODE_EDITOR_SCRATCH,
+            'user_role' => 'educator'
+          }
+        end
+      )
+    end
+
     context 'when school_class_id does not correspond to school_id' do
       let(:lesson_projects) { lesson_project_params.map { |entry| entry.merge(school_id: SecureRandom.uuid) } }
 
diff --git a/spec/features/lesson/creating_a_lesson_spec.rb b/spec/features/lesson/creating_a_lesson_spec.rb
@@ -148,6 +148,25 @@
       expect(response).to have_http_status(:created)
     end
 
+    it 'records a project created event' do
+      authenticated_in_hydra_as(teacher)
+
+      post('/api/lessons', headers:, params:)
+
+      expect(Event.last).to have_attributes(
+        name: 'Project - Created',
+        user_id: teacher.id,
+        properties: {
+          'school_id' => school.id,
+          'class_id' => school_class.id,
+          'lesson_id' => Lesson.last.id,
+          'project_type' => Project::Types::PYTHON,
+          'user_role' => 'educator'
+        },
+        time: be_within(1.second).of(Time.current)
+      )
+    end
+
     it 'responds 422 Unprocessable if school_id is missing' do
       new_params = { lesson: params[:lesson].without(:school_id) }
 
diff --git a/spec/features/lesson/updating_a_lesson_spec.rb b/spec/features/lesson/updating_a_lesson_spec.rb
@@ -129,5 +129,27 @@
       lesson.reload
       expect(lesson.school_class_id).not_to eq(school_class.id)
     end
+
+    context "when changing visibility to 'students'" do
+      let!(:lesson) { create(:lesson, school_class:, name: 'Test Lesson', visibility: 'teachers', user_id: teacher.id) }
+      let(:params) { { lesson: { visibility: 'students' } } }
+
+      it 'records a project made visible event' do
+        put("/api/lessons/#{lesson.id}", headers:, params:)
+
+        expect(Event.last).to have_attributes(
+          name: 'Project - Made visible',
+          user_id: teacher.id,
+          properties: {
+            'school_id' => school.id,
+            'class_id' => school_class.id,
+            'lesson_id' => lesson.id,
+            'project_type' => Project::Types::PYTHON,
+            'user_role' => 'educator'
+          },
+          time: be_within(1.second).of(Time.current)
+        )
+      end
+    end
   end
 end
diff --git a/spec/features/project/creating_a_project_spec.rb b/spec/features/project/creating_a_project_spec.rb
@@ -125,7 +125,8 @@
 
   context 'when the project is associated with a lesson' do
     let(:school) { create(:school) }
-    let(:lesson) { create(:lesson, school:, user_id: teacher.id) }
+    let(:school_class) { create(:school_class, school:, teacher_ids: [teacher.id]) }
+    let(:lesson) { create(:lesson, school:, school_class:, user_id: teacher.id) }
     let(:lesson_created_by_owner) { create(:lesson, school:, user_id: owner.id) }
     let(:teacher) { create(:teacher, school:) }
 
@@ -146,6 +147,23 @@
       expect(response).to have_http_status(:created)
     end
 
+    it 'records a project created event' do
+      post('/api/projects', headers:, params:)
+
+      expect(Event.last).to have_attributes(
+        name: 'Project - Created',
+        user_id: teacher.id,
+        properties: {
+          'school_id' => school.id,
+          'class_id' => school_class.id,
+          'lesson_id' => lesson.id,
+          'project_type' => Project::Types::PYTHON,
+          'user_role' => 'educator'
+        },
+        time: be_within(1.second).of(Time.current)
+      )
+    end
+
     it 'responds 201 Created when the current user is the owner of the lesson' do
       authenticated_in_hydra_as(teacher)
       lesson.update!(user_id: teacher.id)
diff --git a/spec/features/school_project/complete_spec.rb b/spec/features/school_project/complete_spec.rb
@@ -44,6 +44,7 @@
 
     context('when transition is valid') do
       before do
+        class_student
         student_project.school_project.transition_status_to!(:submitted, student.id)
         post("/api/projects/#{student_project.identifier}/complete", headers:)
       end
@@ -59,6 +60,22 @@
       it 'sets the status to complete' do
         expect(student_project.school_project).to be_complete
       end
+
+      it 'records a project marked as completed event' do
+        expect(Event.last).to have_attributes(
+          name: 'Project - Marked as completed',
+          user_id: teacher.id,
+          properties: {
+            'school_id' => school.id,
+            'class_id' => school_class.id,
+            'lesson_id' => lesson.id,
+            'project_type' => Project::Types::PYTHON,
+            'user_role' => 'educator',
+            'student_id' => student.id
+          },
+          time: be_within(1.second).of(Time.current)
+        )
+      end
     end
   end
 
diff --git a/spec/features/school_project/submit_spec.rb b/spec/features/school_project/submit_spec.rb
@@ -29,6 +29,7 @@
 
     context('when transition is valid') do
       before do
+        class_student
         post("/api/projects/#{student_project.identifier}/submit", headers:)
       end
 
@@ -43,10 +44,26 @@
       it 'sets the status to submitted' do
         expect(student_project.school_project).to be_submitted
       end
+
+      it 'records a project submitted for review event' do
+        expect(Event.last).to have_attributes(
+          name: 'Project - Submitted for review',
+          user_id: student.id,
+          properties: {
+            'school_id' => school.id,
+            'class_id' => school_class.id,
+            'lesson_id' => lesson.id,
+            'project_type' => Project::Types::PYTHON,
+            'user_role' => 'student'
+          },
+          time: be_within(1.second).of(Time.current)
+        )
+      end
     end
 
     context 'when attempting an invalid status transition' do
       before do
+        class_student
         student_project.school_project.transition_status_to!(:complete, student.id)
         post("/api/projects/#{student_project.identifier}/submit", headers:)
       end
@@ -62,6 +79,10 @@
       it 'does not change the status' do
         expect(student_project.school_project).to be_complete
       end
+
+      it 'does not record an event' do
+        expect(Event.where(name: 'Project - Submitted for review')).to be_empty
+      end
     end
   end
 
diff --git a/spec/features/scratch/creating_a_scratch_project_spec.rb b/spec/features/scratch/creating_a_scratch_project_spec.rb
@@ -22,11 +22,12 @@
     }
   end
   let(:lesson) { create(:lesson, school:, user_id: teacher.id) }
+  let(:school_class) { create(:school_class, school:, teacher_ids: [teacher.id]) }
   let(:original_project) do
     create(
       :project,
       school:,
-      lesson:,
+      lesson: lesson,
       user_id: teacher.id,
       project_type: Project::Types::CODE_EDITOR_SCRATCH,
       locale: nil
@@ -124,6 +125,25 @@ def make_request(query: request_query, request_headers: headers, request_params:
       expect(remixed_project.scratch_component.content.to_h).to eq(scratch_project.deep_stringify_keys)
     end
 
+    it 'records a project saved event when creating a remix' do
+      original_project.update!(lesson: create(:lesson, school:, school_class:, user_id: teacher.id, visibility: 'students'))
+
+      make_request
+
+      expect(Event.last).to have_attributes(
+        name: 'Project - Saved',
+        user_id: teacher.id,
+        properties: {
+          'school_id' => school.id,
+          'class_id' => school_class.id,
+          'lesson_id' => original_project.lesson.id,
+          'project_type' => Project::Types::CODE_EDITOR_SCRATCH,
+          'user_role' => 'educator'
+        },
+        time: be_within(1.second).of(Time.current)
+      )
+    end
+
     it 'moves the current user pending original-project assets onto the new remix' do
       student = create(:student, school:)
       school_class = create(:school_class, school:, teacher_ids: [teacher.id])
diff --git a/spec/features/scratch/updating_a_scratch_project_spec.rb b/spec/features/scratch/updating_a_scratch_project_spec.rb
@@ -35,6 +35,18 @@
     expect(data[:status]).to eq('ok')
 
     expect(project.reload.scratch_component.content.to_h['targets']).to eq(['some update'])
+    expect(Event.last).to have_attributes(
+      name: 'Project - Saved',
+      user_id: teacher.id,
+      properties: {
+        'school_id' => school.id,
+        'class_id' => school_class.id,
+        'lesson_id' => lesson.id,
+        'project_type' => Project::Types::CODE_EDITOR_SCRATCH,
+        'user_role' => 'educator'
+      },
+      time: be_within(1.second).of(Time.current)
+    )
   end
 
   it 'returns 403 Forbidden when trying to update a project user does not have access to' do
diff --git a/spec/requests/projects/remix_spec.rb b/spec/requests/projects/remix_spec.rb
diff --git a/spec/requests/projects/show_spec.rb b/spec/requests/projects/show_spec.rb
diff --git a/spec/requests/projects/update_spec.rb b/spec/requests/projects/update_spec.rb

Original file line number	Diff line number	Diff line change
`@@ -18,6 +18,7 @@ def create_batch`
`18`	`18`	`lessons_params: batch_lessons_params`
`19`	`19`	`)`
`20`	`20`	`@user = current_user`
	`21`	`+ @results.select(&:success?).each { \|result\| track_project_event('Project - Created', result[:lesson].project) }`
`21`	`22`	`render :create_batch, formats: [:json], status: :created`
`22`	`23`	`end`
`23`	`24`