Add GitHub syncer (exercism#7839)

* WIP

* WIP

* WIP

* Add basic building blocks

* Add pause/delete functionality

* Add confirmation modals and other stuff

* Break out DangerZone

* Add more sections

* Break out more components

* Update console messages

* WIP

* Add syncing of solution

* WIP

* Include solution files if needed

* Align things properly

* Update nav path

* Various improvements

* Hide main branch on PR option

* Add revert to default option

* Reposition input

* Add minimal status section

* Add `repo_full_name`

* Handle users being insiders or not

* Rearrange files, change fetch fn

* Adjust imports, insider bubble styling

* Improve Danger zone

* Change error message path

* Improve processing method section

* Improve IterationFiles and ProcessingMethods seciont

* Show more toasts, show invalid template format

* Style StatusSection a bit

* Add ManualSyncSection

* Various tweaks

* Add mock sync for visual testing, Move things around between DangerZone and Status sections

* Add syncerbehaviour section, apply various tweaks

* Wire in more data

* Wire in path template + default

* Improve resetting templates

* Add fn to ManualSyncSection

* Update pull request language

* Reset settings

* Tweaks

* Add update route

* Update usecb

* Add extra syncers

* Fix

* Change text color on inputs

* Add headers

* Add sycning of things

* Add syncing ability

* Fix routes

* Make syncing more responsive

* Add queue fns

* Update things to use git

* WIP

* Disable manual syncing on paused syncer

* Conditionally render h1 on settings

* Use correct syntax

* Add widget (exercism#7881)

* Add widget to iteration list

* Wire in more stuff

* Update types

* Make widget more flexible

* Add Ruby widget

* Make things work nicely

* Only show gh-syncer to lifetime insiders

* Bump setup-ruby sha

* Add local settings file

* Add better disabled sections

* Fix various tesrts

* Add some styling

* Add type to sync object

* Tweak advert

* Small tweaks

* Guard serverside for settings

* Fix config

* Disable revert if it's at default value

* Only show gh-syncer to admins

* Add modal

* Tweaks

* Refine text

* Fix migration

---------

Co-authored-by: Jeremy Walker <[email protected]>

Author: dem4ron

.github/workflows/tests.yml

@@ -43,7 +43,7 @@ jobs:
         run: echo -e "//npm.pkg.github.com/:_authToken=${{ secrets.NPM_TOKEN }}\n@juliangarnierorg:registry=https://npm.pkg.github.com" > ~/.npmrc
 
       - name: Set up Ruby
-        uses: ruby/setup-ruby@6bd3d993c602f6b675728ebaecb2b569ff86e99b
+        uses: ruby/setup-ruby@13e7a03dc3ac6c3798f4570bfead2aed4d96abfb
         with:
           ruby-version: .ruby-version
 
@@ -182,7 +182,7 @@ jobs:
         run: echo -e "//npm.pkg.github.com/:_authToken=${{ secrets.NPM_TOKEN }}\n@juliangarnierorg:registry=https://npm.pkg.github.com" > ~/.npmrc
 
       - name: Set up Ruby
-        uses: ruby/setup-ruby@6bd3d993c602f6b675728ebaecb2b569ff86e99b
+        uses: ruby/setup-ruby@13e7a03dc3ac6c3798f4570bfead2aed4d96abfb
         with:
           ruby-version: .ruby-version
           bundler-cache: true
@@ -343,7 +343,7 @@ jobs:
       ###
       # Setup Ruby - this needs to match the version in the Gemfile
       - name: Set up Ruby
-        uses: ruby/setup-ruby@6bd3d993c602f6b675728ebaecb2b569ff86e99b
+        uses: ruby/setup-ruby@13e7a03dc3ac6c3798f4570bfead2aed4d96abfb
         with:
           ruby-version: .ruby-version
           bundler-cache: true
@@ -441,7 +441,7 @@ jobs:
       ###
       # Setup Ruby - this needs to match the version in the Gemfile
       - name: Set up Ruby
-        uses: ruby/setup-ruby@6bd3d993c602f6b675728ebaecb2b569ff86e99b
+        uses: ruby/setup-ruby@13e7a03dc3ac6c3798f4570bfead2aed4d96abfb
         with:
           ruby-version: .ruby-version
           bundler-cache: true

.gitignore

@@ -52,4 +52,6 @@ dump.rdb
 # Ignore vendored local databases
 /vendor/*mmdb
 
-.npmrc
+.npmrc
+
+config/settings.local.yml

Gemfile

@@ -38,7 +38,7 @@ gem 'kaminari'
 gem 'oj', '~> 3.14.0'
 
 # Setup dependencies
-gem 'exercism-config', '>= 0.119.0' # gem 'exercism-config', path: '../config'
+gem 'exercism-config', '>= 0.121.0'
 
 # Model-level dependencies
 gem 'image_processing', '~> 1.2'

Gemfile.lock

@@ -171,7 +171,7 @@ GEM
     et-orbi (1.2.7)
       tzinfo
     event_stream_parser (1.0.0)
-    exercism-config (0.119.0)
+    exercism-config (0.121.0)
       aws-sdk-dynamodb (~> 1.0)
       aws-sdk-secretsmanager (~> 1.0)
       mandate
@@ -576,7 +576,7 @@ DEPENDENCIES
   cssbundling-rails
   devise (~> 4.7)
   discourse_api
-  exercism-config (>= 0.119.0)
+  exercism-config (>= 0.121.0)
   factory_bot_rails
   friendly_id (~> 5.4.0)
   geocoder (~> 1.8)

app/commands/iteration/create.rb

@@ -32,6 +32,7 @@ def call
       record_activity!(iteration)
       award_badges!(iteration)
       award_trophies!(iteration)
+      sync_to_github!(iteration)
       log_metric!(iteration)
     end
   rescue ActiveRecord::RecordNotUnique
@@ -68,6 +69,12 @@ def award_trophies!(iteration)
     AwardTrophyJob.perform_later(user, track, :iterated_twenty_exercises, context: iteration)
   end
 
+  def sync_to_github!(iteration)
+    return unless user.github_solution_syncer&.sync_on_iteration_creation?
+
+    User::GithubSolutionSyncer::SyncIteration.defer(iteration)
+  end
+
   def log_metric!(iteration)
     Metric::Queue.(:submit_iteration, iteration.created_at, iteration:, track:, user:)
   end

app/commands/user/github_solution_syncer/create.rb

@@ -0,0 +1,39 @@
+class User::GithubSolutionSyncer::Create
+  include Mandate
+
+  initialize_with :user, :installation_id do
+    raise GithubSolutionSyncerCreationError, "Missing installation ID" unless installation_id.present?
+  end
+
+  def call
+    user.github_solution_syncer&.destroy
+
+    user.create_github_solution_syncer!(
+      installation_id:,
+      repo_full_name: repo.full_name
+    )
+  rescue Octokit::Unauthorized
+    raise GithubSolutionSyncerCreationError, "GitHub authorization failed"
+  rescue Octokit::Error => e
+    raise GithubSolutionSyncerCreationError, "GitHub API error: #{e.message}"
+  end
+
+  private
+  memoize
+  def client = Octokit::Client.new(access_token: token)
+
+  memoize
+  def repo
+    repos = client.list_app_installation_repositories.repositories
+    raise GithubSolutionSyncerCreationError, "Please grant access to exactly one repository" unless repos.size == 1
+
+    repos.first
+  end
+
+  memoize
+  def token
+    User::GithubSolutionSyncer::GithubApp.generate_installation_token!(installation_id).tap do |token|
+      raise GithubSolutionSyncerCreationError, "Failed to retrieve GitHub installation token" if token.blank?
+    end
+  end
+end

app/commands/user/github_solution_syncer/create_commit.rb

@@ -0,0 +1,41 @@
+class User::GithubSolutionSyncer
+  class CreateCommit
+    include Mandate
+
+    # Expects files to be an array of hashes, with the
+    # keys path, mode, type and content.
+    initialize_with :syncer, :files, :commit_message, :branch_name, token: nil
+
+    def call
+      return false unless files.present?
+
+      base_branch = client.branch(repo, branch_name.to_s)
+      base_commit_sha = base_branch.commit.sha
+      base_tree_sha = base_branch.commit.commit.tree.sha
+
+      new_tree = client.create_tree(repo, files, base_tree: base_tree_sha)
+
+      # If the tree hasn't changed, we don't create the commit and return false
+      # so that anything upstream can be aware
+      return false if new_tree.sha == base_tree_sha
+
+      new_commit = client.create_commit(repo, commit_message, new_tree.sha, base_commit_sha)
+      client.update_ref(repo, "heads/#{branch_name}", new_commit.sha)
+
+      # Let's keep this as always a boolean response.
+      true
+    end
+
+    private
+    memoize
+    def repo = syncer.repo_full_name
+
+    memoize
+    def client = Octokit::Client.new(access_token: token)
+
+    memoize
+    def token
+      @token || GithubApp.generate_installation_token!(syncer.installation_id)
+    end
+  end
+end

app/commands/user/github_solution_syncer/create_pull_request.rb

@@ -0,0 +1,42 @@
+class User::GithubSolutionSyncer
+  class CreatePullRequest
+    include Mandate
+
+    def initialize(syncer, pr_title, pr_message, &commit_block)
+      @syncer = syncer
+      @pr_title = pr_title
+      @pr_message = pr_message
+      @commit_block = commit_block
+    end
+
+    def call
+      repo = syncer.repo_full_name
+      client = Octokit::Client.new(access_token: token)
+
+      base_branch = client.repository(repo).default_branch
+      base_sha = client.branch(repo, base_branch).commit.sha
+
+      new_branch = "exercism-sync/#{SecureRandom.hex(8)}"
+      client.create_ref(repo, "heads/#{new_branch}", base_sha)
+
+      commits_created = commit_block.(new_branch, token)
+      return unless commits_created
+
+      client.create_pull_request(
+        repo,
+        base_branch,
+        new_branch,
+        pr_title,
+        pr_message
+      )
+    end
+
+    private
+    attr_reader :syncer, :pr_title, :pr_message, :commit_block
+
+    memoize
+    def token
+      GithubApp.generate_installation_token!(syncer.installation_id)
+    end
+  end
+end

app/commands/user/github_solution_syncer/files_for_iteration.rb

@@ -0,0 +1,51 @@
+class User::GithubSolutionSyncer
+  class FilesForIteration
+    include Mandate
+
+    initialize_with :syncer, :iteration
+
+    def call
+      files.map do |filename, content|
+        next unless content.present?
+
+        {
+          path: "#{path}/#{filename}",
+          mode: "100644",
+          type: "blob",
+          content:
+        }
+      end.compact
+    end
+
+    private
+    delegate :user, :track, :exercise, to: :iteration
+
+    def files
+      exercise_files.merge(submission_files)
+    end
+
+    def exercise_files
+      return {} unless syncer.sync_exercise_files?
+
+      iteration.solution.git_exercise.cli_files
+    end
+
+    def submission_files
+      iteration.submission.files.each_with_object({}) do |file, hash|
+        hash[file.filename] = file.content
+      end
+    end
+
+    memoize
+    def path
+      syncer.path_template.
+        gsub("$track_title", track.title).
+        gsub("$track_slug", track.slug).
+        gsub("$exercise_title", exercise.title).
+        gsub("$exercise_slug", exercise.slug).
+        gsub("$iteration_idx", iteration.idx.to_s).
+        gsub("//", "/").
+        gsub(%r{/$}, "")
+    end
+  end
+end

app/commands/user/github_solution_syncer/generate_commit_message.rb

@@ -0,0 +1,20 @@
+class User::GithubSolutionSyncer::GenerateCommitMessage
+  include Mandate
+
+  initialize_with :syncer, :iteration
+
+  def call
+    template = syncer.commit_message_template
+
+    template.
+      gsub("$track_title", track.title).
+      gsub("$track_slug", track.slug).
+      gsub("$exercise_title", exercise.title).
+      gsub("$exercise_slug", exercise.slug).
+      gsub("$iteration_idx", iteration.idx.to_s).
+      gsub("$sync_object", "Iteration").
+      gsub("//", "/")
+  end
+
+  delegate :user, :exercise, :track, to: :iteration
+end