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.

Sign up for GitHub

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

Jump to bottom

Replace prettytable-rs with comfy-table #2413

Merged
merged 1 commit into from
Feb 20, 2025
Merged

Replace prettytable-rs with comfy-table #2413

merged 1 commit into from
Feb 20, 2025

Conversation

pubmodmatt
Copy link
Contributor

Replace the prettytable-rs dependency with comfy-table.

Motivation

The table output by rover config whoami was misalgined, due to this issue in prettytable-rs:

┌───────────────┬────────────────────────────────────────────┐
│ Key Type    │ Graph                                      │
├───────────────┼────────────────────────────────────────────┤
│ Graph ID    │ SpaceOrbit3                                │
├───────────────┼────────────────────────────────────────────┤
│ Graph Title │ SpaceOrbit                                 │
├───────────────┼────────────────────────────────────────────┤
│ Origin      │ $APOLLO_KEY                                │
├───────────────┼────────────────────────────────────────────┤
│ API Key     │ ****************************************** │
└───────────────┴────────────────────────────────────────────┘

As pointed out in the comparison with other libraries in the comfy-table docs, it appears that prettytable-rs may be abandoned. The fix for the above issue has had an open PR for several months, but it has not been merged and released. comfy-table appears to be actively developed, and had a new version release 12 days ago.

Differences

Dropping in comfy-table is almost seamless. There are a few very slight differences in the output, in addition to fixing the above alignment issue:

  • The bold headers were not working with prettytable-rs, but they do work with comfy-table
  • comfy-table uses a double line between the header row and the next row, more clearly delineating the headers
  • The comfy-table preset uses dashed lines inside the table, and solid lines for the table border, provding a nice visual separation. prettytable-rs used solid lines everywhere.

Comparison

Note that the examples below do not show bold fonts or colors that would appear in the terminal.

rover config whoami

prettytable-rs

┌───────────────┬────────────────────────────────────────────┐
│ Key Type    │ Graph                                      │
├───────────────┼────────────────────────────────────────────┤
│ Graph ID    │ SpaceOrbit3                                │
├───────────────┼────────────────────────────────────────────┤
│ Graph Title │ SpaceOrbit                                 │
├───────────────┼────────────────────────────────────────────┤
│ Origin      │ $APOLLO_KEY                                │
├───────────────┼────────────────────────────────────────────┤
│ API Key     │ ****************************************** │
└───────────────┴────────────────────────────────────────────┘

comfy-table

┌─────────────┬────────────────────────────────────────────┐
│ Key Type    ┆ Graph                                      │
├╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┤
│ Graph ID    ┆ SpaceOrbit3                                │
├╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┤
│ Graph Title ┆ SpaceOrbit                                 │
├╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┤
│ Origin      ┆ $APOLLO_KEY                                │
├╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┤
│ API Key     ┆ ****************************************** │
└─────────────┴────────────────────────────────────────────┘

rover docs list

prettytable-rs

┌──────────────┬──────────────────────────────────────┐
│     Slug     │             Description              │
├──────────────┼──────────────────────────────────────┤
│ api-keys     │ Understanding Apollo's API Keys      │
├──────────────┼──────────────────────────────────────┤
│ contributing │ Contributing to Rover                │
├──────────────┼──────────────────────────────────────┤
│ docs         │ Rover's Documentation Homepage       │
├──────────────┼──────────────────────────────────────┤
│ migration    │ Migrate from the Apollo CLI to Rover │
├──────────────┼──────────────────────────────────────┤
│ start        │ Getting Started with Rover           │
└──────────────┴──────────────────────────────────────┘

comfy-table

┌──────────────┬──────────────────────────────────────┐
│     Slug     ┆              Description             │
╞══════════════╪══════════════════════════════════════╡
│ api-keys     ┆ Understanding Apollo's API Keys      │
├╌╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┤
│ contributing ┆ Contributing to Rover                │
├╌╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┤
│ docs         ┆ Rover's Documentation Homepage       │
├╌╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┤
│ migration    ┆ Migrate from the Apollo CLI to Rover │
├╌╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┤
│ start        ┆ Getting Started with Rover           │
└──────────────┴──────────────────────────────────────┘

rover subgraph list

prettytable-rs

┌───────┬───────────────────────┬────────────────────────────┐
│ Name  │      Routing Url      │        Last Updated        │
├───────┼───────────────────────┼────────────────────────────┤
│ posts │ http://localhost:4000 │ 2025-02-19 12:04:01 -07:00 │
└───────┴───────────────────────┴────────────────────────────┘

comfy-table

┌───────┬───────────────────────┬────────────────────────────┐
│  Name ┆      Routing Url      ┆        Last Updated        │
╞═══════╪═══════════════════════╪════════════════════════════╡
│ posts ┆ http://localhost:4000 ┆ 2025-02-19 12:04:01 -07:00 │
└───────┴───────────────────────┴────────────────────────────┘

@pubmodmatt pubmodmatt self-assigned this Feb 20, 2025
@pubmodmatt pubmodmatt requested a review from a team as a code owner February 20, 2025 14:21
@svc-apollo-docs
Copy link
Collaborator

svc-apollo-docs commented Feb 20, 2025 •
edited
Loading

✅ Docs preview has no changes

The preview was not built because there were no changes.

Build ID: fb4078d0e5b2347794871e1d

@pubmodmatt pubmodmatt force-pushed the pubmodmatt/table_impl branch from 76ff8f4 to 1443213 Compare February 20, 2025 14:22
aaronArinder
aaronArinder approved these changes Feb 20, 2025
View reviewed changes
Copy link
Contributor

@aaronArinder aaronArinder left a comment

Choose a reason for hiding this comment

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

lgtm! though, what was the check_workflow.rs file? just... empty? was it used for anything?

@pubmodmatt pubmodmatt force-pushed the pubmodmatt/table_impl branch from 1443213 to 4b2aee3 Compare February 20, 2025 14:34
@pubmodmatt
Copy link
Contributor Author

what was the check_workflow.rs file? just... empty? was it used for anything?

As far as I could tell, it was an empty module not used anywhere, so just some code cleanup there.

@jonathanrainer jonathanrainer added this to the vNext milestone Feb 20, 2025
@pubmodmatt pubmodmatt merged commit 132ce31 into main Feb 20, 2025
32 checks passed
@pubmodmatt pubmodmatt deleted the pubmodmatt/table_impl branch February 20, 2025 15:32
@pubmodmatt pubmodmatt added fix 🩹 fixes a bug and removed maintenance 🛠️ labels Mar 10, 2025
@pubmodmatt pubmodmatt mentioned this pull request Mar 10, 2025
Merged
pubmodmatt added a commit that referenced this pull request Mar 12, 2025
@pubmodmatt
release: v0.28.0 (#2439)
d35046d 
# [0.28.0] - 2025-03-12

## 🚀 Features

- **Default to Apollo Router 2.x for `rover dev` - @pubmodmatt PR
#2433**

The default version of Apollo Router used by `rover dev` is now 2.x
instead of 1.x. The default can be overridden by
setting `APOLLO_ROVER_DEV_ROUTER_VERSION`, for example
`APOLLO_ROVER_DEV_ROUTER_VERSION=1.61.0`.

- **Implement supergraph config schema command - @jonathanrainer PR
#2418**

Adds a new `rover supergraph config schema` command to output the
JSONSchema for `supergraph.yaml`. This can be used to configure editor
support for the file.

## 🐛 Fixes

- **Add specific CompositionError handling - @jonathanrainer PR #2422**
- **Pass log_level through to Router binary - @monkpow PR #2426**
- **Fix formatting of table output by `rover config whoami` -
@pubmodmatt PR #2413**
- **Better error on missing environment variable - @pubmodmatt PR
#2442**

## 🛠 Maintenance

- **Add Apollo Router 2.x dependency to renovate - @pubmodmatt PR
#2430**
- **Fix CI post update to Rustup 1.28 - @jonathanrainer PR #2431**
- **Replace backoff with backon - @pubmodmatt PR #2437**
- **Add exemption for unmaintained humantime dependency - @pubmodmatt PR
#2440**

## 📚 Documentation

- **Add docs on using the native GitHub actions - @lleadbet PR #2419**
- **Add changelog entry for new behaviour w.r.t subgraph_url -
@jonathanrainer PR #2420**
- **GitHub CI/CD - @shorgi PR #2427**
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@aaronArinder aaronArinder aaronArinder approved these changes

Assignees

@pubmodmatt pubmodmatt

Labels
fix 🩹 fixes a bug
Projects
None yet
Milestone
v0.28.0
Development

Successfully merging this pull request may close these issues.
4 participants
@pubmodmatt @svc-apollo-docs @aaronArinder @jonathanrainer