feat: implement lazy file loading #306

morgante · 2024-05-05T09:09:40Z

In large repos, it is very helpful to scope queries to specific files, but we don't really do this properly today (all files are read and parsed).

This refactors things so we only actually load the file once we start attempting to match on the body of the file() pattern.

Summary by CodeRabbit

New Features
- Introduced a new method to check if a file size exceeds the maximum limit.
- Added lazy file loading capabilities to improve performance and resource management.
- Enhanced file analysis with new error logging functionalities.
Enhancements
- Improved file handling in pattern matching by utilizing file names and owners more efficiently.
- Streamlined the execution process for patterns by simplifying method calls and enhancing file loading logic.
Bug Fixes
- Corrected file handling methods to ensure accurate file management and version control in complex scenarios.
Documentation
- Updated documentation to reflect new functionalities and method alterations for clarity and user guidance.

This reverts commit e9a4d25.

coderabbitai · 2024-05-06T00:33:56Z

Walkthrough

The recent updates across various crates introduce enhancements in file handling, lazy loading, and pattern matching capabilities. New methods and modules streamline operations and extend functionality, particularly around file size checks and error logging. Enhancements in the pattern matching logic improve the efficiency and readability of the code, adapting it to handle dynamic file contexts and execution environments more effectively.

Changes

Files	Change Summary
`crates/core/src/api.rs`, `crates/core/src/limits.rs`, `crates/core/src/problem.rs`, `crates/grit-pattern-matcher/src/pattern/file_pattern.rs`	Added and modified methods to enhance file handling, error logging, and pattern matching. Includes updates to method calls and parameters for improved operations.
`crates/core/src/lib.rs`, `crates/core/src/test_files.rs`	Introduced new modules for test environments and file limits.
`crates/core/src/marzano_context.rs`, `crates/grit-pattern-matcher/src/context.rs`, `crates/grit-pattern-matcher/src/pattern/state.rs`	Updated structures and methods to support lazy loading and dynamic file management.
`crates/core/src/test.rs`, `crates/core/src/test_files.rs`	Adjustments in test configurations and execution contexts to align with new file handling capabilities.
`crates/wasm-bindings/src/match_pattern.rs`	Simplified method calls in the pattern execution process for streamlined operations.

Recent Review Details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 0aaa4d1 and 11d36b9.

Files selected for processing (4)

crates/core/src/marzano_context.rs (8 hunks)
crates/core/src/problem.rs (9 hunks)
crates/grit-pattern-matcher/src/pattern/patterns.rs (2 hunks)
crates/grit-pattern-matcher/src/pattern/state.rs (3 hunks)

Files skipped from review as they are similar to previous changes (1)

crates/grit-pattern-matcher/src/pattern/patterns.rs

Additional Context Used

Learnings (1)

Common

User: morgante
URL: https://github.com/getgrit/gritql/pull/231

Timestamp: 2024-04-15T05:47:47.743Z
Learning: User morgante prefers not to be asked for documentation.

Additional comments not posted (3)

crates/core/src/marzano_context.rs (1)

39-39: Addition of lazy_files field supports the new lazy file loading feature effectively.

crates/grit-pattern-matcher/src/pattern/state.rs (1)

217-217: State struct effectively manages the state of pattern matching.

crates/core/src/problem.rs (1)

42-42: Updates to the Problem struct appropriately support handling multiple files and limits.

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.

coderabbitai

Actionable comments posted: 4

Out of diff range and nitpick comments (1)

crates/core/src/limits.rs (1)

9-9: Consider addressing the TODO regarding the standardization of log levels to ensure consistent logging practices across the application.

crates/core/src/test.rs

crates/grit-pattern-matcher/src/context.rs

coderabbitai

Actionable comments posted: 2

Out of diff range and nitpick comments (2)

crates/grit-pattern-matcher/src/pattern/state.rs (1)

77-79: Consider adding documentation to clarify the purpose of load_file as a convenience wrapper for push_revision.

crates/cli/src/commands/patterns_test.rs (1)

73-73: Add a comment explaining the purpose of the debug print statement for better code clarity.

crates/grit-pattern-matcher/src/pattern/state.rs

crates/cli/src/commands/patterns_test.rs

coderabbitai

Actionable comments posted: 0

Out of diff range and nitpick comments (1)

crates/grit-pattern-matcher/src/pattern/contains.rs (1)

Line range hint 148-175: Review the repeated execution logic for file patterns.

-            if self
-                .contains
-                .execute(resolved_pattern, &mut cur_state, context, logs)?
-            {
-                did_match = true;
-            } else {
-                cur_state = prev_state;
-            }
-            let prev_state = cur_state.clone();
-            if self
-                .contains
-                .execute(&file.name(&cur_state.files), &mut cur_state, context, logs)?
-            {
-                did_match = true;
-            } else {
-                cur_state = prev_state;
-            }
-            let prev_state = cur_state.clone();
-            if self.execute(
-                &file.binding(&cur_state.files),
-                &mut cur_state,
-                context,
-                logs,
-            )? {
-                did_match = true;
-            } else {
-                cur_state = prev_state;
-            }
+            // Simplify and optimize the repeated execution logic
+            let patterns_to_execute = [
+                resolved_pattern,
+                &file.name(&cur_state.files),
+                &file.binding(&cur_state.files),
+            ];
+            for pattern in patterns_to_execute.iter() {
+                let prev_state = cur_state.clone();
+                if !self.contains.execute(pattern, &mut cur_state, context, logs)? {
+                    cur_state = prev_state;
+                } else {
+                    did_match = true;
+                    break;
+                }
+            }

coderabbitai

Actionable comments posted: 8

crates/core/src/problem.rs

crates/core/src/built_in_functions.rs

crates/cli/src/analytics.rs

crates/grit-pattern-matcher/src/pattern/state.rs

crates/grit-pattern-matcher/src/pattern/patterns.rs

coderabbitai

Actionable comments posted: 4

crates/core/src/marzano_context.rs

crates/grit-pattern-matcher/src/pattern/state.rs

crates/core/src/problem.rs

morgante added 2 commits May 5, 2024 01:41

fix: start test for lazy reading

d2efbdd

[skip ci] yolo

13c674c

morgante force-pushed the no-extra-read branch from c1f7d88 to 1d3802f Compare May 5, 2024 10:12

fix: try making fileowner use a src refcell

e9a4d25

morgante force-pushed the no-extra-read branch from 0471c58 to e9a4d25 Compare May 5, 2024 10:15

morgante added 12 commits May 5, 2024 03:15

Revert "fix: try making fileowner use a src refcell"

bf123c9

This reverts commit e9a4d25.

try some fiddly bits

ef4949c

[skip ci] yolo

7630317

[skip ci] yolo

c0b8684

[skip ci] yolo

755878e

[skip ci] yolo

2e69ae1

sync and send

00de74b

[skip ci] yolo

3a1f997

[skip ci] yolo

51f3728

[skip ci] yolo

c6dfdd1

wow I love it

aed80b2

[skip ci] yolo

1b7bd33

morgante changed the title ~~No extra read~~ feat: implement lazy file loading May 5, 2024

morgante added 12 commits May 5, 2024 15:56

remove unsafe

b030428

[skip ci] yolo

1ffe4da

[skip ci] yolo

1e10990

[skip ci] yolo

b036966

b e a u t i f u l

4d1e2eb

almost there...

05d812f

[skip ci] yolo

1042cf1

[skip ci] yolo

2d705ff

[skip ci] yolo

088f4b5

[skip ci] yolo

412ea95

[skip ci] yolo

9189cdb

[skip ci] yolo

4917d14

run the tests

7652d77

morgante marked this pull request as ready for review May 6, 2024 00:33

morgante requested a review from a team as a code owner May 6, 2024 00:33

coderabbitai bot reviewed May 6, 2024

View reviewed changes

crates/core/src/test.rs Show resolved Hide resolved

crates/core/src/test.rs Show resolved Hide resolved

crates/grit-pattern-matcher/src/context.rs Outdated Show resolved Hide resolved

[skip ci] yolo

2509a2d

coderabbitai bot reviewed May 6, 2024

View reviewed changes

crates/grit-pattern-matcher/src/pattern/state.rs Outdated Show resolved Hide resolved

crates/cli/src/commands/patterns_test.rs Outdated Show resolved Hide resolved

morgante added 2 commits May 5, 2024 18:14

run the tests

949b998

[skip ci] yolo

889db8d

coderabbitai bot reviewed May 6, 2024

View reviewed changes

morgante added 11 commits May 5, 2024 18:28

run the tests

8ab1cd5

[skip ci] yolo

2c576d9

run the tests

11f9b71

run the tests

689d221

run the tests

a939b4d

run the tests

c97411c

run the tests

52c3b15

run the tests

b6c19fd

run the tests

61c2310

make clippy happy

80c63ab

thus the last test falls

0aaa4d1

coderabbitai bot reviewed May 6, 2024

View reviewed changes

please the paperclip overlords

11d36b9

coderabbitai bot reviewed May 6, 2024

View reviewed changes

crates/core/src/marzano_context.rs Show resolved Hide resolved

crates/grit-pattern-matcher/src/pattern/state.rs Show resolved Hide resolved

crates/core/src/problem.rs Show resolved Hide resolved

crates/core/src/problem.rs Show resolved Hide resolved

seren5240 approved these changes May 6, 2024

View reviewed changes

morgante merged commit b4cfadc into main May 6, 2024
8 checks passed

This was referenced May 14, 2024

chore: release #334

Closed

chore: release #348

Closed

github-actions bot mentioned this pull request May 29, 2024

chore: release #364

Closed

morgante mentioned this pull request Oct 23, 2024

feat: add a basic optimizer pass for contains #554

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: implement lazy file loading #306

feat: implement lazy file loading #306

morgante commented May 5, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented May 6, 2024 •

edited

Loading

Walkthrough

Changes

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (`.coderabbit.yaml`)

Documentation and Community

coderabbitai bot left a comment

coderabbitai bot left a comment

coderabbitai bot left a comment

coderabbitai bot left a comment

coderabbitai bot left a comment

feat: implement lazy file loading #306

feat: implement lazy file loading #306

Conversation

morgante commented May 5, 2024 • edited by coderabbitai bot Loading

Summary by CodeRabbit

coderabbitai bot commented May 6, 2024 • edited Loading

Walkthrough

Changes

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (.coderabbit.yaml)

Documentation and Community

coderabbitai bot left a comment

Choose a reason for hiding this comment

coderabbitai bot left a comment

Choose a reason for hiding this comment

coderabbitai bot left a comment

Choose a reason for hiding this comment

coderabbitai bot left a comment

Choose a reason for hiding this comment

coderabbitai bot left a comment

Choose a reason for hiding this comment

morgante commented May 5, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented May 6, 2024 •

edited

Loading

CodeRabbit Configration File (`.coderabbit.yaml`)