Merge pull request #192 from bastelfreak/blargh2

document gh notification flow / fix queue validation

.rubocop_todo.yml

@@ -20,7 +20,7 @@ Metrics/BlockLength:
 # Offense count: 2
 # Configuration parameters: CountComments.
 Metrics/ClassLength:
-  Max: 123
+  Max: 129
 
 # Offense count: 1
 # Configuration parameters: IgnoredMethods.

README.md

@@ -29,6 +29,7 @@
     * [Events](#events)
 * [Contribution and Development](#contribution-and-development)
   * [Add/Drop new Operating system checks](#adddrop-new-operating-system-checks)
+* [Flowchart](#flowchart)
 * [License](#license)
 * [Docker Tricks](#docker-tricks)
 * [Sponsor](#sponsor)
@@ -359,6 +360,15 @@ Based on those arrays of version numbers, the application parses the
 metadata.json and checks if a module supports EOL operating systems or doesn't
 support the latest versions.
 
+## Flowchart
+
+The following flowchart displays what happens when we receive a GitHub
+notification about a pull request. The diagram was created with
+[draw.io](https://draw.io). You can import the `vpt.drawio` from the `/images/`
+directory.
+
+[![flowchart](images/vpt.png)](https://voxpupu.li)
+
 ## License
 
 This project is licensed under [GNU Affero General Public License version 3](LICENSE)

app/models/pull_request.rb

@@ -176,8 +176,14 @@ def validate(saved_changes)
   # validate() might use update() to change attributes which would trigger a new job
   # To prevent loops, we filter `saved_changed` of those attributes and won't create new job if those are the only changed attributes
   def queue_validation
-    attributes = %w[eligible_for_merge_comment eligible_for_ci_comment]
-    return unless (saved_changes.stringify_keys.keys & attributes).empty?
+    case saved_changes.stringify_keys.keys.sort
+    when %w[eligible_for_merge_comment eligible_for_ci_comment].sort
+      return
+    when %w[eligible_for_ci_comment]
+      return
+    when %w[eligible_for_merge_comment]
+      return
+    end
 
     ValidatePullRequestWorker.perform_async(id, saved_changes)
   end

images/vpt.drawio

@@ -0,0 +1 @@
+<mxfile host="app.diagrams.net" modified="2020-06-27T20:31:00.661Z" agent="5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/83.0.4103.116 Safari/537.36" etag="IzeEGSVqx6Hyk4rRzUBL" version="13.3.5" type="device"><diagram id="rWuEJd1KMj-C7G-JBGPM" name="Page-1">7V1bc5s4FP41nmkfkuEmLo9Jml522qabdDdtXzwYZFsNIAoisfvrV1xkA8I29QXErGc8NgghxNH3HZ1zdMAj9cZfvIvscP4Ju9AbKZK7GKlvRooia4oySj+Su8xLDEvPC2YRcotK64IH9BsWhVJRmiAXxpWKBGOPoLBa6OAggA6plNlRhF+q1abYq141tGeQK3hwbI8vfUQumRelsm6tD7yHaDZnl9aBlh/xbVa7uJV4brv4pVSk3o7Umwhjkm/5ixvopdJjgsnPe7vh6KpnEQxImxPUu7/e/nCJv3A8Az49ST+/LJ4uiuGJyZLdMXSpAIpdHJE5nuHA9m7XpdcRTgIXpq1KdG9d5yPGIS2UaeFPSMiyGE07IZgWzYnvFUfhApFv6emXABS737Ndi+2+WRStZzvL0s4XGCEfEhixsoBEy6Ixtvu9fGzdVLbH2srvO73ZjeIsimKcRE5R68enO//z3+43L7y/Xcwn5Jv9uLhguLSjGSRb6qmrQad0gZjeRbSk50XQswl6rvbDLnA7W9VbjyzdKAa3eaC3dfLZ9pLiSp/hCy14h8j7ZEI3viRZI/fwVwJjwsPC8yjn0uGnOA7TQsfDCb3i9cscEfgQ2pmMXqgaqA72Rrk+w4jARamIF01xVJd0OrjZSS8lEjJizUv8M6UTyU/h5NcHc/YHqdoSpKCRGH2hVuWk/iFwsI+C2Q2mdMaelyqCK/qZITJPcVwbk7XE5U6gCkyVQXXJZjKJh66u89DVTwVdbeDQBS2hawgFXcBJPVe1t8+ZAFLMogARZHupxATErdUSt9qpcKv3bJuUTBN2pNku2R/aRktoW0JB29gN7dSaYKYEh3Xdo4XXk4huzdKtV+WDEorTr2BODT1CR5Ia7RH2V5ZK6RrXdgxf988cvc4cxeCZo0hdanxzKMw5zHrfh3FWS8bJslCUs/agXBhhB8axgAxR9ZYMUU7FEBZfOFNkM/R3ckQRy1mQeR+X40QSujaB4xfqLYxFcRk4emgNLkO3E4jcd1xIZHpobacQXSx6qOcxPXxMxbLEZd6351QePYZSpSegojMVPqzXsaIDZ1Ls0l+77QBVLFLo7Ukx9iG9OXvi9U8PQ67Tw9J6p4dxpsdG2Zht6SGWK8n6XaLHPZxGMJ6XWPKIoycWWg9hNMWRP0ZB7xyxTKseppTNBpKATuPrMieXM0lq9tJOkrAosigk4QMum+eQmNgk6T/OorFoiTDTh9JrlEUu8WLNkh3MkCu8WNPk6MxQ2kZZBItErnBZCUWmgZSMFI6HVhHJkDJmHG1IKBBg6lCb4iydTh2qxAlzKIw5APltcxGYpSII8nV+sALkNY7XR3sCvaqM6WQxC+i2Q+WVWlbXKXSRY3tXxQEfuW4+nDBGvzOXJJd0iFFAspsB1yPwplH229FVJ8kqX664yqickdZEHunSMFnK27LSUGvRF21/SW+mVAVPpzEk3NisunAAt/jkERIlvJ93ttX+lJeqIhQvFX6gt3j1c+xPqLHWiUdv6FwykMZPOWaneWzamQAbZdM200gRKwqs8LlGnLNCNxM4LlwWhPt35RuWvRoyjjr2V/pJOeoe6G3zjtj6gihA5zOP/i2c8Ersigtd2fEycPqHvCbXIG/ITR5Iw3xwOsifc4V2qvnd84FYqacKH7xiSXcueq4Mtv4rSZ8/uZ7igFzE2XBd0QqyFi7oTyY9yUMBvGBgTI+mehqsz2VpfOwaYeMVuFZkK73Gpkbi0A4a25nYztMsA+CFgz0c5Y1Fs8krBYC0zwoVmlTbfs1f6FVsP0N37MztYAbjy5hEKJih6XL8BJfxZfqVNgBuWIfoSOR9qvaTFofDFAD9tf1UyQWTOCzv598pMAkVyiQhMH59Cf2QUEa93UMctCyDHSvt0SLXtGqIFJi8/tWAyuvfVRb/8UNAg1mB3l+RModxt2cplr3B+r3NsIZBnERw7KURnzGKxy4ktjNPE5d7tjZ00xRvrUzt1dwQe0VAbZuEdPy8y+zUqyiyl6UKRdyRj92xiLrOR9TV2jOoO08B1adW6UbejeOGAhsMIjqVrT7cEwkfHmjtr++zn6v7+7tH+ntzd39/e/OVr1xtStxoMFv3P0I0WDGlWkb3SPRocItMuX9CIfLkDE2vsarpEUKWddBNikO/uaP7qO3OvERmUu5OcRArbA54pSj2chYD4VGWs3RVF11lafwAxYnT+EiPoB5DiYyaYfwJHbO9+rseuuCoWEvOoNdnYMU2l1uPKRDrMSXAB7GnNvKoEymw7mVAPFz3XlBMWCyvuLBwLnRDeGXMJ39sSvvrMp5lqlVTsff1ZY1Pvu9DhR2gVtrGqjSx1Arr9xDTumW1GpYVIFCl9fvkw14eT2czb9s8CcFSVzU+T2IQqascPfpPXAW8thmYmm/79A4QDMP80zvDWZJYPdi+Xc+bXQJ5gJGtrvQ8g/5QFiRUq64n66/E3HEC2LF8AXRtW/3TLF6Ahve3/e8WL8ARY3+KZVYXL9jLMff1PpeNJ5zOF2W8HMBahga4RWil6cVyna5m6HzC+LCMF9DWANcVoYwX0CJRuW682EQQ40W1qspf1kCTFd6l8aLzocRhAVlva2HoYgVb9BYa2HbdsYPGDvb9VC7Cwddoek1ht/AdzLMoByC8bThRF8vPZP0uIbxBJUtc0mg9h5QFyaU80bZBjXcZLpfMKgeAofEcUBvi5TJ7qczxBd2UrD0oHd7aGBFrbVXnjRFI/RdE/YjxFEdbdXenKctyFbNm44uZNR6z1qn0Nps4xI+Z7I9q4+jquGVIQa6NWk6r4qz1wP1pbMSsRjqo6tse6qjVZ906aaTD4OecganCtkHl46PrMFXYIqicmbOC2rKKpPZtyxotPIJEjJgMJ73VP6mcQHp0d/0XR7miWP9TlHr7Hw==</diagram></mxfile>