Merged
Conversation
📝 WalkthroughWalkthroughThis pull request adds a compilation step to the test Dockerfile and corrects numerous spelling, grammar, and typography errors across documentation strings, comments, and error messages throughout the codebase. No functional logic is altered. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~4 minutes Poem
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches
🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (4)
lib/sanbase/alerts/evaluator/scheduler.ex (1)
381-408:⚠️ Potential issue | 🟡 MinorMissed typo: atom key
total_sent_succesfullyon Line 405 was not fixed.The PR fixes the comment typo on line 381 (
successfully) but the map key returned from this same function still uses the misspelled atom:total_sent_succesfully: total_triggered - total_failed,Since
handle_send_results_list/2isdefpand its only call site (Line 318) only destructureslast_triggered, renaming the atom is safe.✏️ Proposed fix
- total_sent_succesfully: total_triggered - total_failed, + total_sent_successfully: total_triggered - total_failed,🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@lib/sanbase/alerts/evaluator/scheduler.ex` around lines 381 - 408, The returned map from handle_send_results_list/2 contains a misspelled atom key total_sent_succesfully; rename it to total_sent_successfully in the map returned by handle_send_results_list/2 (and update any references if present) so the correct key is emitted; locate the atom in the function handle_send_results_list/2 and change total_sent_succesfully: total_triggered - total_failed to total_sent_successfully: total_triggered - total_failed.lib/sanbase_web/graphql/cache/cache.ex (1)
4-5:⚠️ Potential issue | 🟡 MinorTwo remaining typos in the module docstring were missed.
"for a some time"→"for some time""precalculating itt"→"precalculating it"✏️ Proposed fix
- caches the result of the resolver for a some time instead of precalculating itt + caches the result of the resolver for some time instead of precalculating it🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@lib/sanbase_web/graphql/cache/cache.ex` around lines 4 - 5, The module docstring in the Cache module contains two typos; update the documentation string in the module (module Cache in lib/sanbase_web/graphql/cache/cache.ex) to change "for a some time" to "for some time" and "precalculating itt" to "precalculating it" so the docstring reads correctly.lib/sanbase/discord_bot/command_handler.ex (2)
432-432:⚠️ Potential issue | 🟡 MinorMissed typo:
"reactiing"→"reacting"in the embed description.Since this PR is specifically fixing typos, this one slipped through.
✏️ Proposed fix
-"<@#{to_string(msg.author.id)}> I am still learning and improving, please let me know how I did by reactiing below" +"<@#{to_string(msg.author.id)}> I am still learning and improving, please let me know how I did by reacting below"🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@lib/sanbase/discord_bot/command_handler.ex` at line 432, In the embed description string sent in the command handler (the text beginning "<@#{to_string(msg.author.id)}> I am still learning and improving, please let me know how I did by reactiing below"), fix the typo "reactiing" to "reacting" so the message reads "...please let me know how I did by reacting below"; this change is located in the command handling code that constructs the reply embed string (refer to the description literal containing to_string(msg.author.id)).
623-623:⚠️ Potential issue | 🟠 MajorPre-existing bug:
"last 2 weeks"shifts by-14weeks instead of-2.
Timex.shift(DateTime.utc_now(), weeks: -14)shifts back ~3.5 months rather than 2 weeks. This is almost certainly a copy-paste typo.🐛 Proposed fix
-defp text_to_datetime("last 2 weeks"), do: Timex.shift(DateTime.utc_now(), weeks: -14) +defp text_to_datetime("last 2 weeks"), do: Timex.shift(DateTime.utc_now(), weeks: -2)🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@lib/sanbase/discord_bot/command_handler.ex` at line 623, The clause in the text_to_datetime function for the literal "last 2 weeks" uses Timex.shift(DateTime.utc_now(), weeks: -14) which is incorrect; update the clause (the defp text_to_datetime("last 2 weeks") pattern) to call Timex.shift with weeks: -2 so it shifts back two weeks instead of fourteen.
🧹 Nitpick comments (1)
lib/sanbase_web/plug/basic_auth.ex (1)
2-5: Typo fix is correct, but the moduledoc content appears inaccurate.The "coming" typo fix is good. However, the moduledoc describes checking a path "coming from telegram" with a secret endpoint — this seems copied from
TelegramMatchPlug. Since this is theBasicAuthplug (which delegates toPlug.BasicAuth.basic_auth/2), consider updating the description to accurately reflect what this module does.📝 Suggested moduledoc fix
`@moduledoc` ~s""" - Checks the path if it is really coming from telegram. The endpoint is a secret - and is only known by telegram. + Applies HTTP Basic Authentication using credentials from the application config. """🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@lib/sanbase_web/plug/basic_auth.ex` around lines 2 - 5, The moduledoc in the BasicAuth plug incorrectly describes Telegram-specific behavior; update it to state that the module enforces HTTP Basic Authentication by delegating to Plug.BasicAuth.basic_auth/2 (i.e., performs basic auth check against configured username/password), remove any mention of Telegram or secret endpoints, and briefly document expected options/usage for the BasicAuth plug (module name BasicAuth and its delegation to Plug.BasicAuth.basic_auth/2).
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Outside diff comments:
In `@lib/sanbase_web/graphql/cache/cache.ex`:
- Around line 4-5: The module docstring in the Cache module contains two typos;
update the documentation string in the module (module Cache in
lib/sanbase_web/graphql/cache/cache.ex) to change "for a some time" to "for some
time" and "precalculating itt" to "precalculating it" so the docstring reads
correctly.
In `@lib/sanbase/alerts/evaluator/scheduler.ex`:
- Around line 381-408: The returned map from handle_send_results_list/2 contains
a misspelled atom key total_sent_succesfully; rename it to
total_sent_successfully in the map returned by handle_send_results_list/2 (and
update any references if present) so the correct key is emitted; locate the atom
in the function handle_send_results_list/2 and change total_sent_succesfully:
total_triggered - total_failed to total_sent_successfully: total_triggered -
total_failed.
In `@lib/sanbase/discord_bot/command_handler.ex`:
- Line 432: In the embed description string sent in the command handler (the
text beginning "<@#{to_string(msg.author.id)}> I am still learning and
improving, please let me know how I did by reactiing below"), fix the typo
"reactiing" to "reacting" so the message reads "...please let me know how I did
by reacting below"; this change is located in the command handling code that
constructs the reply embed string (refer to the description literal containing
to_string(msg.author.id)).
- Line 623: The clause in the text_to_datetime function for the literal "last 2
weeks" uses Timex.shift(DateTime.utc_now(), weeks: -14) which is incorrect;
update the clause (the defp text_to_datetime("last 2 weeks") pattern) to call
Timex.shift with weeks: -2 so it shifts back two weeks instead of fourteen.
---
Nitpick comments:
In `@lib/sanbase_web/plug/basic_auth.ex`:
- Around line 2-5: The moduledoc in the BasicAuth plug incorrectly describes
Telegram-specific behavior; update it to state that the module enforces HTTP
Basic Authentication by delegating to Plug.BasicAuth.basic_auth/2 (i.e.,
performs basic auth check against configured username/password), remove any
mention of Telegram or secret endpoints, and briefly document expected
options/usage for the BasicAuth plug (module name BasicAuth and its delegation
to Plug.BasicAuth.basic_auth/2).
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Changes
Ticket
Checklist:
Summary by CodeRabbit
Documentation
Chores