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

Spike: Rust Cleanup #3926

Closed
cpyle0819 opened this issue Nov 8, 2022 · 2 comments
Closed

Spike: Rust Cleanup #3926

cpyle0819 opened this issue Nov 8, 2022 · 2 comments
Assignees

Comments

@cpyle0819
Copy link
Contributor

cpyle0819 commented Nov 8, 2022

Identify the set of changes necessary for #3465

@DavidSouther
Copy link
Contributor

DavidSouther commented Nov 9, 2022

  • Folder, crate, and service names should all be the same.
    • sitewise != iotsitewise
  • Tracing for all binaries
    • All binaries should at minimum have tracing_subscriber::fmt::init();
    • Describe common RUST_LOG idioms, like aws_smithy_http_tower::dispatch=trace
    • Provide guidance on a tracing_subscriber configuration that works with AWS CloudWatch Agent
  • StructOpt is deprecated in favor of clap_macro.
  • Error handling is a lot of upwrap()s and expect()s.
  • All examples are "CLI Apps", which adds a lot of unnecessary cognitive overhead to understanding the examples.
    • Minimize args to the bare minimum for the example
    • Batch two or three examples into mini-scenarios
      • Confirm with wider team
  • No unit testing.
    • Most MVPs have little to no logic, and would be better suited to integration testing.
    • Scenarios should have a high level structure, and allow mocking the clients.
  • No integration testing.
    • Integration tests should call scenarios' high level structure functions, and assert that appropriate changes have happened in AWS resources.
    • Integration tests should be #[ignored] by default, as they will incur AWS usage charges.

@DavidSouther DavidSouther changed the title Spike (Rust Cleaup) Stub Spike: Rust Cleanup Nov 9, 2022
@DavidSouther
Copy link
Contributor

Closing for the sprint and building tickets from identified bullets

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

No branches or pull requests

2 participants