feat: Ignore HELP spam (#25)

* ignore `HELP` spam

* CHANGELOG.md update

* hotfix

CHANGELOG.md

@@ -8,7 +8,14 @@ All notable changes to this project will be documented in this file.
 
 - Try to improve performance by calling `madvise` to inform Kernel we are reading sequentially ([#24])
 
+### Changed
+- Ignore repeated `HELP` requests ([#25])
+  - Only the first 2 requests of any `parse` patch are answered
+  - Answers `Stop spamming HELP!` on the third request
+  - Doesn't respond to any further requests
+
 [#24]: https://github.com/sbernauer/breakwater/pull/24
+[#25]: https://github.com/sbernauer/breakwater/pull/25
 
 ## [0.14.0] - 2024-05-30 at GPN 22 :)
 

breakwater-core/src/lib.rs

@@ -20,3 +20,5 @@ if cfg!(feature = "alpha") {
     "PX x y rrggbbaa: Color the pixel (x,y) with the given hexadecimal color rrggbb. The alpha part is discarded for performance reasons, as breakwater was compiled without the alpha feature"
 }
 ).as_bytes();
+
+pub const ALT_HELP_TEXT: &[u8] = b"Stop spamming HELP!\n";

breakwater-parser/src/original.rs

@@ -3,7 +3,7 @@ use std::{
     sync::Arc,
 };
 
-use breakwater_core::{framebuffer::FrameBuffer, HELP_TEXT};
+use breakwater_core::{framebuffer::FrameBuffer, ALT_HELP_TEXT, HELP_TEXT};
 use tokio::io::AsyncWriteExt;
 
 use crate::{Parser, ParserError};
@@ -38,6 +38,7 @@ impl Parser for OriginalParser {
         mut stream: impl AsyncWriteExt + Send + Unpin,
     ) -> Result<usize, ParserError> {
         let mut last_byte_parsed = 0;
+        let mut help_count = 0;
 
         let mut i = 0; // We can't use a for loop here because Rust don't lets use skip characters by incrementing i
         let loop_end = buffer.len().saturating_sub(PARSER_LOOKAHEAD); // Let's extract the .len() call and the subtraction into it's own variable so we only compute it once
@@ -178,10 +179,20 @@ impl Parser for OriginalParser {
                 i += 4;
                 last_byte_parsed = i - 1;
 
-                stream
-                    .write_all(HELP_TEXT)
-                    .await
-                    .expect("Failed to write bytes to tcp socket");
+                #[allow(clippy::comparison_chain)]
+                if help_count < 3 {
+                    stream
+                        .write_all(HELP_TEXT)
+                        .await
+                        .expect("Failed to write bytes to tcp socket");
+                    help_count += 1;
+                } else if help_count == 3 {
+                    stream
+                        .write_all(ALT_HELP_TEXT)
+                        .await
+                        .expect("Failed to write bytes to tcp socket");
+                    help_count += 1;
+                }
                 continue;
             }