View source for Tool:Fix Suggester Bot

{{Tool
| name = fixsuggesterbot
| title = Fix Suggester Bot
| description = Generate fix suggestions using code quality tools, and post suggestions to patches in code review
| keywords = bot, code quality
| author = Kosta Harlan
| username = Kosta Harlan
| repository = https://gitlab.wikimedia.org/KostaHarlan/fix-suggester-bot/
| license = GPL-3.0+
| phabricator = Fix-Suggester-Bot
}}

A set of scripts running on Toolforge to analyze patches and offer fix suggestions when the patches fail code quality tool analysis.
{| class="wikitable"
|+'''Code review system / code quality tools'''
!'''Code review system'''
!phpcs
!eslint
|-
|Gerrit
|{{Check mark}}
|
|-
|GitLab
|
|
|}

== How does it work ==

=== Gerrit ===
Two jobs are running the Toolforge jobs framework environment {{Phabricator|T285944}}.

The first one subscribes to "patchset-created" events via [[gerrit:Documentation/cmd-stream-events.html|Gerrit stream events]] using an SSH key associated with the Fix Suggester Bot account in Gerrit:

{{Codesample
| code = toolforge-jobs run fix-suggester-bot-subscribe --command "php fix-suggester-bot/bin/console fix-suggester-bot:subscribe:gerrit -v" --image tf-php74 --continuous
| lang = sh
}}

The above command puts the JSON stream message from Gerrit into a MySQL database table.

Another process is responsible for consuming the messages in the queue:

{{Codesample
| code = toolforge-jobs run fix-suggester-bot-consume --command "php fix-suggester-bot/bin/console messenger:consume --time-limit=3600 gerrit_async -vv" --image tf-php74 --continuous
| lang = sh
}}

This command runs configured code quality tools (phpcs, currently) and generates fix suggestions in a JSON file. These are then posted as fix suggestion in Gerrit.

At the moment, it only listens to events for the mediawiki/extensions/GrowthExperiments project.

Both commands are configuring using an env.local file in /data/project/fixsuggesterbot/fix-suggester-bot

=== GitLab ===

* TBD

== Source code ==
{{SourceLinks|url=https://gitlab.wikimedia.org/KostaHarlan/fix-suggester-bot|text=Fix Suggester Bot|url2=https://gitlab.wikimedia.org/KostaHarlan/fix-suggestions|text2=Fix Suggestions library}}