Add startingBlock option #138
Conversation
📝 WalkthroughWalkthroughThis pull request introduces a new JSON configuration for the Changes
Possibly related PRs
Poem
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (5)
🚧 Files skipped from review as they are similar to previous changes (4)
⏰ Context from checks skipped due to timeout of 90000ms (1)
🔇 Additional comments (3)
✨ Finishing Touches
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? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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 using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (5)
change/@apibara-indexer-00f20a26-f27d-40f3-a4f5-9ae56b471507.json(1 hunks)examples/cli/indexers/1-evm.indexer.ts(1 hunks)examples/cli/indexers/2-starknet.indexer.ts(1 hunks)examples/cli/indexers/3-starknet-factory.indexer.ts(1 hunks)packages/indexer/src/indexer.ts(3 hunks)
✅ Files skipped from review due to trivial changes (1)
- change/@apibara-indexer-00f20a26-f27d-40f3-a4f5-9ae56b471507.json
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: test
🔇 Additional comments (4)
packages/indexer/src/indexer.ts (1)
66-78: LGTM! Well-designed type safety.The union type
IndexerStartingCursoreffectively ensures that only one ofstartingCursororstartingBlockcan be set at a time, preventing potential configuration conflicts.examples/cli/indexers/1-evm.indexer.ts (1)
41-41: LGTM! Consistent with the new API.The migration from
startingCursortostartingBlockis correct and maintains the same starting point.examples/cli/indexers/2-starknet.indexer.ts (1)
36-36: LGTM! Consistent with the new API.The migration from
startingCursortostartingBlockis correct and maintains the same starting point.examples/cli/indexers/3-starknet-factory.indexer.ts (1)
17-17: Verify factory pattern compatibility with the new startingBlock option.While the migration to
startingBlockis correct, please ensure that the factory pattern's cursor handling (especially in thefactoryfunction) works correctly with the new block-based initialization.Run this script to check for potential issues:
✅ Verification successful
Factory pattern is compatible with startingBlock option
The verification confirms that the factory pattern's cursor handling works correctly with the block-based initialization. The startingBlock value is properly converted to a cursor's orderKey, and the factory mode correctly maintains cursor state persistence, as evidenced by the test coverage.
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Check if the factory pattern handles both cursor types consistently # Search for cursor handling in factory functions ast-grep --pattern 'factory($$$) { $$$ cursor $$$ }' # Search for cursor usage in factory-related code rg -A 5 'factory.*cursor|cursor.*factory'Length of output: 676
Script:
#!/bin/bash # Find factory implementation and block handling ast-grep --pattern 'factory($$$) { $$$ }' # Search for startingBlock usage in factory context rg -A 5 'startingBlock.*factory|factory.*startingBlock' # Find cursor initialization patterns rg -A 10 'new\s+Indexer.*factory|factory.*Indexer'Length of output: 156
Script:
#!/bin/bash # Find factory-related files fd -t f factory # Find indexer initialization patterns rg -l "class.*Indexer|interface.*Indexer" # Search for startingBlock usage rg -A 5 "startingBlock.*=|startingBlock.*\(" # Look for cursor handling in indexer files rg -A 5 "cursor.*=|getCursor|setCursor"Length of output: 20759
| // Give priority to startingCursor over startingBlock. | ||
| let startingCursor: Cursor | undefined; | ||
| if (indexer.options.startingCursor) { | ||
| startingCursor = indexer.options.startingCursor; | ||
| } else if (indexer.options.startingBlock !== undefined) { | ||
| startingCursor = { | ||
| orderKey: indexer.options.startingBlock, | ||
| }; | ||
| } |
There was a problem hiding this comment.
Fix inconsistent cursor initialization.
There's a bug where startingCursor is initialized but not used in the request. The request uses indexer.options.startingCursor directly, which could lead to unexpected behavior.
Apply this diff to fix the issue:
let startingCursor: Cursor | undefined;
if (indexer.options.startingCursor) {
startingCursor = indexer.options.startingCursor;
} else if (indexer.options.startingBlock !== undefined) {
startingCursor = {
orderKey: indexer.options.startingBlock,
};
}
const request = indexer.streamConfig.Request.make({
filter: isFactoryMode
? [indexer.options.filter, {} as TFilter]
: [indexer.options.filter],
finality: indexer.options.finality,
- startingCursor: indexer.options.startingCursor,
+ startingCursor,
});Also applies to: 233-239
fracek
force-pushed
the
starting-block
branch
from
d89e293 to
9653510
Compare
This is a shortcut for the most common case (specifying only the starting block without the hash).