Add retries to editor builds (#507)

closes #506

---------

Co-authored-by: create-issue-branch[bot] <53036503+create-issue-branch[bot]@users.noreply.github.com>
Co-authored-by: Dan Halson <[email protected]>

Author: create-issue-branch[bot]

app/jobs/create_students_job.rb

@@ -3,6 +3,25 @@
 class ConcurrencyExceededForSchool < StandardError; end
 
 class CreateStudentsJob < ApplicationJob
+  retry_on StandardError, wait: :polynomially_longer, attempts: 3 do |_job, e|
+    Sentry.capture_exception(e)
+    raise e
+  end
+
+  # Don't retry...
+  rescue_from ConcurrencyExceededForSchool do |e|
+    Rails.logger.error "Only one job per school can be enqueued at a time: #{school_id}"
+    Sentry.capture_exception(e)
+    raise e
+  end
+
+  # Don't retry...
+  rescue_from ActiveRecord::RecordInvalid do |e|
+    Rails.logger.error "Failed to create student role: #{e.record.errors.full_messages.join(', ')}"
+    Sentry.capture_exception(e)
+    raise e
+  end
+
   include GoodJob::ActiveJobExtensions::Concurrency
 
   queue_as :default
@@ -36,23 +55,4 @@ def perform(school_id:, students:, token:)
       Role.student.create!(school_id:, user_id:)
     end
   end
-
-  # Don't retry...
-  rescue_from ConcurrencyExceededForSchool do |e|
-    Rails.logger.error "Only one job per school can be enqueued at a time: #{school_id}"
-    Sentry.capture_exception(e)
-    raise e
-  end
-
-  # Don't retry...
-  rescue_from ActiveRecord::RecordInvalid do |e|
-    Rails.logger.error "Failed to create student role: #{e.record.errors.full_messages.join(', ')}"
-    Sentry.capture_exception(e)
-    raise e
-  end
-
-  retry_on StandardError, attempts: 3 do |_job, e|
-    Sentry.capture_exception(e)
-    raise e
-  end
 end

app/jobs/upload_job.rb

@@ -3,7 +3,21 @@
 require 'open-uri'
 require 'github_api'
 
+class InvalidDirectoryStructureError < StandardError; end
+class RepositoryNotFoundError < StandardError; end
+
 class UploadJob < ApplicationJob
+  retry_on StandardError, wait: :polynomially_longer, attempts: 3 do |_job, e|
+    Sentry.capture_exception(e)
+    raise e
+  end
+
+  # Don't retry...
+  rescue_from RepositoryNotFoundError, InvalidDirectoryStructureError do |e|
+    Sentry.capture_exception(e)
+    raise e
+  end
+
   @skip_job = false
 
   ProjectContentQuery = GithubApi::Client.parse <<-GRAPHQL
@@ -40,6 +54,7 @@ class UploadJob < ApplicationJob
   def perform(payload)
     modified_locales(payload).each do |locale|
       projects_data = load_projects_data(locale, repository(payload), owner(payload))
+      raise RepositoryNotFoundError, "Repository not found: #{repository(payload)}" if projects_data.data&.repository&.object.nil?
 
       projects_data.data.repository.object.entries.each do |project_dir|
         project = format_project(project_dir, locale, repository(payload), owner(payload))
@@ -51,9 +66,6 @@ def perform(payload)
         project_importer = ProjectImporter.new(**project)
         project_importer.import!
       end
-    rescue StandardError => e
-      Sentry.capture_exception(e)
-      raise e # Re-raise the error to make the job fail
     end
   end
 
@@ -159,5 +171,3 @@ def file_mime_type(file)
     Marcel::MimeType.for(file.object, name: file.name)
   end
 end
-
-class InvalidDirectoryStructureError < StandardError; end

spec/jobs/upload_job_spec.rb

@@ -3,6 +3,8 @@
 require 'rails_helper'
 
 RSpec.describe UploadJob do
+  include ActiveJob::TestHelper
+
   around do |example|
     ClimateControl.modify GITHUB_AUTH_TOKEN: 'secret', GITHUB_WEBHOOK_REF: 'branches/whatever' do
       example.run
@@ -122,18 +124,16 @@
     }
   end
 
-  before do
-    stub_request(:get, 'https://github.com/me/my-amazing-repo/raw/branches/whatever/ja-JP/code/dont-collide-starter/astronaut1.png').to_return(status: 200, body: '', headers: {})
-    stub_request(:get, 'https://github.com/me/my-amazing-repo/raw/branches/whatever/ja-JP/code/dont-collide-starter/music.mp3').to_return(status: 200, body: '', headers: {})
-    stub_request(:get, 'https://github.com/me/my-amazing-repo/raw/branches/whatever/ja-JP/code/dont-collide-starter/video.mp4').to_return(status: 200, body: '', headers: {})
-  end
-
   context 'with the build flag undefined' do
     let(:raw_response) { modifiable_response }
 
     before do
       allow(GithubApi::Client).to receive(:query).and_return(graphql_response)
       allow(ProjectImporter).to receive(:new).and_call_original
+
+      stub_request(:get, 'https://github.com/me/my-amazing-repo/raw/branches/whatever/ja-JP/code/dont-collide-starter/astronaut1.png').to_return(status: 200, body: '', headers: {})
+      stub_request(:get, 'https://github.com/me/my-amazing-repo/raw/branches/whatever/ja-JP/code/dont-collide-starter/music.mp3').to_return(status: 200, body: '', headers: {})
+      stub_request(:get, 'https://github.com/me/my-amazing-repo/raw/branches/whatever/ja-JP/code/dont-collide-starter/video.mp4').to_return(status: 200, body: '', headers: {})
     end
 
     it 'enqueues the job' do
@@ -188,6 +188,10 @@
     let(:raw_response) { modifiable_response.deep_dup }
 
     before do
+      stub_request(:get, 'https://github.com/me/my-amazing-repo/raw/branches/whatever/ja-JP/code/dont-collide-starter/astronaut1.png').to_return(status: 200, body: '', headers: {})
+      stub_request(:get, 'https://github.com/me/my-amazing-repo/raw/branches/whatever/ja-JP/code/dont-collide-starter/music.mp3').to_return(status: 200, body: '', headers: {})
+      stub_request(:get, 'https://github.com/me/my-amazing-repo/raw/branches/whatever/ja-JP/code/dont-collide-starter/video.mp4').to_return(status: 200, body: '', headers: {})
+
       project_dir_entry = raw_response['data']['repository']['object']['entries'].find do |entry|
         entry['name'] == 'dont-collide-starter'
       end
@@ -207,26 +211,31 @@
     end
   end
 
-  context 'with a graphql error response' do
-    let(:raw_response) do
-      {
-        errors: [
-          {
-            'message' => 'Simulated INTERNAL_SERVER_ERROR message',
-            'locations' => [{ 'line' => 2, 'column' => 4 }],
-            'path' => %w[query repository object],
-            'extensions' => { 'code' => 'INTERNAL_SERVER_ERROR' }
-          }
-        ]
-      }
+  context 'when repository is not found' do
+    let(:graphql_response) do
+      GraphQL::Client::Response.new(
+        {
+          'errors' => [
+            {
+              'message' => 'Simulated NOT_FOUND error message',
+              'locations' => [{ 'line' => 2, 'column' => 4 }],
+              'path' => %w[query repository],
+              'extensions' => { 'code' => 'NOT_FOUND' }
+            }
+          ]
+        },
+        data: nil
+      )
     end
 
     before do
-      stub_request(:post, 'https://api.github.com/graphql').to_return(status: 200, body: raw_response.to_json, headers: {})
+      allow(GithubApi::Client).to receive(:query).and_return(graphql_response)
     end
 
-    it 'raises a GraphQL::Client::Error' do
-      expect { described_class.perform_now(payload) }.to raise_error(GraphQL::Client::Error, /Simulated INTERNAL_SERVER_ERROR message/)
+    it 'raises RepositoryNotFoundError' do
+      expect do
+        described_class.perform_now(payload)
+      end.to raise_error(RepositoryNotFoundError, 'Repository not found: my-amazing-repo')
     end
   end
 end