Separate libelb-log-parser

[simnalamburt]

Closes #3

[gemini-code-assist]

Hello @simnalamburt, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

Summary of Changes

This pull request transforms the existing elb-log-parser project into a workspace project, incorporating a new libelb-log-parser crate. The main application elb-log-parser now depends on this new library, which contains the core logic for parsing ELB logs. This change promotes code reuse and separation of concerns.

Highlights

• Workspace Transformation: The project is converted into a Rust workspace with two members: elb-log-parser (the main application) and libelb-log-parser (a new library crate).
• Code Reorganization: Core parsing logic is moved from the elb-log-parser crate into the new libelb-log-parser crate.
• Dependency Management: Dependencies related to parsing (regex, serde, thiserror) are moved to libelb-log-parser, while elb-log-parser depends on libelb-log-parser.

Changelog

Click here to see the changelog

• .gitignore
  • Added a trailing slash to the /target entry to ensure the entire directory is ignored.
• Cargo.lock
  • Removed direct dependencies (regex, regex-automata, serde, thiserror) from the main application's lock file.
  • Added libelb-log-parser as a dependency with its own set of dependencies.
• Cargo.toml
  • Replaced the package definition with a workspace definition, including elb-log-parser and libelb-log-parser as members.
  • Added workspace-level settings for authors, edition, license, and repository.
• elb-log-parser/Cargo.toml
  • Created a new Cargo.toml file for the elb-log-parser crate within the workspace.
  • Defined the package with workspace-inherited settings and a dependency on libelb-log-parser.
• elb-log-parser/src/main.rs
  • Removed the internal module declarations (mod alb;, mod classic_lb;, mod parse;).
  • Updated imports to use the new libelb-log-parser crate instead of internal modules.
  • Replaced local types (e.g., crate::alb::LogParser) with types from libelb-log-parser (e.g., libelb_log_parser::ALBLogParser).
  • Replaced Type with LBType.
• libelb-log-parser/Cargo.toml
  • Created a new Cargo.toml file for the libelb-log-parser crate.
  • Defined the package with workspace-inherited settings and dependencies required for parsing (regex, serde, thiserror).
• libelb-log-parser/src/alb.rs
  • Updated import to use LBType from the crate itself instead of the parent crate.
  • Updated references to external links to use angle brackets.
• libelb-log-parser/src/classic_lb.rs
  • Updated import to use LBType from the crate itself instead of the parent crate.
• libelb-log-parser/src/lib.rs
  • Created a new lib.rs file to define the library's modules and public API.
  • Re-exports the necessary types and structs for parsing ELB logs.
• libelb-log-parser/src/parse.rs
  • Moved the LBLogParser trait and related definitions from the original parse.rs module to this new location.
  • Added LBType enum.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in issue comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

---

A workspace born,
Code finds a new form,
Libraries rise high.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[gemini-code-assist]

Code Review

This pull request introduces a new libelb-log-parser crate to separate the log parsing logic from the main elb-log-parser application. This improves modularity and reusability. The changes look good overall, but there are a few areas that could be improved.

Summary of Findings

• Dependency Management: The libelb-log-parser crate's serde_json dependency is only used for testing and should be moved to dev-dependencies.
• Code Duplication: The Type enum is duplicated in both elb-log-parser and libelb-log-parser. Consider defining it in libelb-log-parser and re-exporting it.
• Error Handling: The TODO comments indicate areas where error handling could be improved, particularly in the worker threads and output thread.

Merge Readiness

The pull request is a good step towards improving the project's structure. However, addressing the dependency management and code duplication issues would make it more maintainable. The error handling TODOs should also be considered before merging. I am unable to approve this pull request, and recommend that others review and approve this code before merging.