Move recording of available-signing-keys metric inside a deferred function

[m-Peter]

Description

If the relevant function errors out early, because there are no keys available, then we wouldn't record that there are 0 available signing keys. This would skew the related data.
Also made some improvements regarding logging errors.

---

For contributor use:

• Targeted PR against master branch
• Linked to Github issue with discussion and accepted design OR link to spec that describes this work.
• Code follows the standards mentioned here.
• Updated relevant documentation
• Re-reviewed Files changed in the Github PR explorer
• Added appropriate labels

Summary by CodeRabbit

• Chores
  • Updated Makefile configuration for emulator arguments
  • Added new internal error handling in server API
  • Modified transaction building process to defer logging of available signing keys

[coderabbitai]

Walkthrough

This pull request introduces minor modifications across three files: the Makefile, api/server.go, and services/requester/requester.go. The changes include removing a transaction state validation argument from the emulator configuration, adding a new internal error constant, and adjusting the timing of logging available signing keys in the transaction building process. These modifications appear to be focused on refining error handling and logging mechanisms.

Changes

File	Change Summary
Makefile	Removed --tx-state-validation=local-index argument from EMULATOR_ARGS
api/server.go	Added new error constant errs.ErrInternal to knownErrors slice
services/requester/requester.go	Modified buildTransaction method to defer logging of available signing keys

Suggested labels

Technical Debt

Suggested reviewers

• peterargue
• sideninja
• zhangchiqing

Possibly related PRs

• Fix API version shown in build details #731: Changes to Makefile variables and build process configuration

Poem

🐰 A rabbit's tale of code refined,
Tweaks and changes, neatly designed,
Errors logged, arguments trimmed,
With precision, our code is limned!
Hop along, pull request divine! 🚀

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 8326189 and 5290086.

📒 Files selected for processing (3)

• Makefile (1 hunks)
• api/server.go (1 hunks)
• services/requester/requester.go (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (2)

• GitHub Check: Test
• GitHub Check: Lint

🔇 Additional comments (3)

api/server.go (1)

433-433: LGTM!

Adding errs.ErrInternal to knownErrors ensures that internal errors are properly handled and not logged as warnings.

services/requester/requester.go (1)

565-568: LGTM! The change improves metric accuracy.

Moving the recording of available signing keys into a deferred function ensures that the metric is accurately recorded even if the function encounters an early error.

Makefile (1)

30-30: Verify the removal of --tx-state-validation=local-index from EMULATOR_ARGS.

The --tx-state-validation=local-index argument is still used in docker-run and docker-run-local targets. Consider keeping it in EMULATOR_ARGS for consistency or removing it from all targets if it's no longer needed.

Run the following script to verify the usage of the argument:

✨ Finishing Touches

• 📝 Generate Docstrings (Beta)

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.