Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor(commands): use tab writer #7241

Merged
merged 4 commits into from Apr 27, 2024
Merged

Conversation

james-d-elliott
Copy link
Member

@james-d-elliott james-d-elliott commented Apr 26, 2024

Summary by CodeRabbit

  • New Features
    • Improved the display format of storage operation outputs by using tabular alignment, enhancing readability for users.

@authelia
Copy link

authelia bot commented Apr 26, 2024

Artifacts

These changes are published for testing on Buildkite, DockerHub and GitHub Container Registry.

Docker Container

  • docker pull authelia/authelia:refactor-cli-tablewriter
  • docker pull ghcr.io/authelia/authelia:refactor-cli-tablewriter

Copy link
Contributor

coderabbitai bot commented Apr 26, 2024

Walkthrough

The recent update aims to enhance the output formatting of storage-related commands by incorporating the text/tabwriter package into relevant files. This change is designed to improve the readability and structure of displayed data through tabular formatting, replacing basic print statements with more organized outputs.

Changes

File Change Summary
.../storage_run.go Introduced text/tabwriter for improved tabular output formatting in functions related to storage operations. Updated output formatting for better alignment and readability in functions such as NewStorageMigrateListRunE, StorageUserWebAuthnListRunE, and StorageUserWebAuthnListAllRunE.
.../acl.go Added imports for os and text/tabwriter. Refactored output formatting logic to use tabwriter for enhanced column alignment in ACL-related commands.

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
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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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.

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 as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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.

@james-d-elliott james-d-elliott force-pushed the refactor-cli-tablewriter branch 3 times, most recently from 23228a0 to 60b4d93 Compare April 26, 2024 08:11
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

Out of diff range and nitpick comments (1)
internal/commands/acl.go (1)

Line range hint 121-155: Consider adding error handling for tabwriter operations.

The current implementation of tabwriter in accessControlCheckWriteOutput function ignores errors from fmt.Fprintln and fmt.Fprintf methods. It's generally a good practice to handle these errors to avoid silent failures. Here's a suggested modification:

- _, _ = fmt.Fprintln(w, "  #\tDomain\tResource\tMethod\tNetwork\tSubject")
+ if _, err := fmt.Fprintln(w, "  #\tDomain\tResource\tMethod\tNetwork\tSubject"); err != nil {
+     return fmt.Errorf("failed to write header to tabwriter: %w", err)
+ }

- _, _ = fmt.Fprintf(w, "* %d\t%s\t%s\t%s\t%s\t%s\n", i+1, hitMissMay(result.MatchDomain), hitMissMay(result.MatchResources), hitMissMay(result.MatchMethods), hitMissMay(result.MatchNetworks), hitMissMay(result.MatchSubjects, result.MatchSubjectsExact))
+ if _, err := fmt.Fprintf(w, "* %d\t%s\t%s\t%s\t%s\t%s\n", i+1, hitMissMay(result.MatchDomain), hitMissMay(result.MatchResources), hitMissMay(result.MatchMethods), hitMissMay(result.MatchNetworks), hitMissMay(result.MatchSubjects, result.MatchSubjectsExact)); err != nil {
+     return fmt.Errorf("failed to write applied rule to tabwriter: %w", err)
+ }

- _, _ = fmt.Fprintf(w, "~ %d\t%s\t%s\t%s\t%s\t%s\n", i+1, hitMissMay(result.MatchDomain), hitMissMay(result.MatchResources), hitMissMay(result.MatchMethods), hitMissMay(result.MatchNetworks), hitMissMay(result.MatchSubjects, result.MatchSubjectsExact))
+ if _, err := fmt.Fprintf(w, "~ %d\t%s\t%s\t%s\t%s\t%s\n", i+1, hitMissMay(result.MatchDomain), hitMissMay(result.MatchResources), hitMissMay(result.MatchMethods), hitMissMay(result.MatchNetworks), hitMissMay(result.MatchSubjects, result.MatchSubjectsExact)); err != nil {
+     return fmt.Errorf("failed to write potential rule to tabwriter: %w", err)
+ }

- _, _ = fmt.Fprintf(w, "  %d\t%s\t%s\t%s\t%s\t%s\n", i+1, hitMissMay(result.MatchDomain), hitMissMay(result.MatchResources), hitMissMay(result.MatchMethods), hitMissMay(result.MatchNetworks), hitMissMay(result.MatchSubjects, result.MatchSubjectsExact))
+ if _, err := fmt.Fprintf(w, "  %d\t%s\t%s\t%s\t%s\t%s\n", i+1, hitMissMay(result.MatchDomain), hitMissMay(result.MatchResources), hitMissMay(result.MatchMethods), hitMissMay(result.MatchNetworks), hitMissMay(result.MatchSubjects, result.MatchSubjectsExact)); err != nil {
+     return fmt.Errorf("failed to write default rule to tabwriter: %w", err)
+ }

- _ = w.Flush()
+ if err := w.Flush(); err != nil {
+     return fmt.Errorf("failed to flush tabwriter: %w", err)
+ }

This change ensures that any issues during the writing process are caught and handled appropriately.

Signed-off-by: James Elliott <james-d-elliott@users.noreply.github.com>
Copy link

codecov bot commented Apr 26, 2024

Codecov Report

Attention: Patch coverage is 64.70588% with 12 lines in your changes are missing coverage. Please review.

Project coverage is 73.68%. Comparing base (029050f) to head (aa407ef).

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #7241   +/-   ##
=======================================
  Coverage   73.68%   73.68%           
=======================================
  Files         346      346           
  Lines       29986    30003   +17     
  Branches      839      839           
=======================================
+ Hits        22095    22109   +14     
- Misses       7019     7020    +1     
- Partials      872      874    +2     
Flag Coverage Δ
backend 74.55% <64.70%> (-0.01%) ⬇️
frontend 66.07% <ø> (+0.09%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files Coverage Δ
internal/commands/acl.go 78.40% <100.00%> (+0.50%) ⬆️
internal/commands/storage_run.go 42.27% <53.84%> (+0.36%) ⬆️

... and 4 files with indirect coverage changes

@james-d-elliott james-d-elliott merged commit b8264fa into master Apr 27, 2024
48 of 49 checks passed
@james-d-elliott james-d-elliott deleted the refactor-cli-tablewriter branch April 27, 2024 05:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant