perf(arns): cache resolution for non-existent name #208
Conversation
|
Warning Rate limit exceeded@djwhitt has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 19 minutes and 27 seconds before requesting another review. How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. WalkthroughWalkthroughThe pull request includes modifications to the Changes
Possibly related PRs
Suggested reviewers
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 (
|
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## develop #208 +/- ##
========================================
Coverage 70.13% 70.13%
========================================
Files 32 32
Lines 7834 7834
Branches 429 429
========================================
Hits 5494 5494
Misses 2340 2340 ☔ View full report in Codecov by Sentry. |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
Outside diff range and nitpick comments (2)
src/resolution/on-demand-arns-resolver.ts (2)
70-70: Acknowledged the TODO comment.The comment indicates a future plan to replace the
getArNSRecordmethod withgetRecords. This is a valid TODO and does not affect the current functionality.Let me know if you need any assistance with this future improvement or want me to open a GitHub issue to track this task.
94-105: Changes align with the PR objectives and improve resilience against DoS attacks.The updated error handling logic returns a structured object with default values when the
arnsRecordis undefined, null, or itsprocessIdis undefined. This change provides a consistent response format for non-existent names and prevents the method from throwing errors and terminating execution.The caching of non-existent name resolutions for 5 minutes, as indicated by the hardcoded
ttlvalue of 300 seconds, reduces the load on the system and improves performance by avoiding unnecessary processing of repeated invalid requests. This aligns with the PR objectives of enhancing the system's resilience against DoS attacks.Consider making the
ttlvalue configurable for flexibility. This can be done by introducing a new configuration variable in theconfig.jsfile and using that variable instead of the hardcoded value. For example:import * as config from '../config.js'; // ... return { name, resolvedId: undefined, resolvedAt: Date.now(), ttl: config.ARNS_NON_EXISTENT_NAME_CACHE_TTL, processId: undefined, };In the
config.jsfile:export const ARNS_NON_EXISTENT_NAME_CACHE_TTL = 300; // 5 minutes
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (3)
- src/resolution/composite-arns-resolver.ts (2 hunks)
- src/resolution/on-demand-arns-resolver.ts (2 hunks)
- src/types.d.ts (1 hunks)
Additional comments not posted (3)
src/resolution/composite-arns-resolver.ts (2)
52-52: LGTM!The comment provides useful context about the purpose of the
cachedResolutionvariable.
74-74: Verify the impact of the change in the if condition.The if condition has been changed from checking
resolution.resolvedIdto checkingresolution.resolvedAt. This change may alter the logic flow related to caching and logging resolved names.Please ensure that this change aligns with the expected behavior and does not introduce any unintended consequences. Consider the following:
- What is the purpose of checking
resolution.resolvedAtinstead ofresolution.resolvedId?- How does this change affect the determination of a valid resolution?
- Are there any other parts of the codebase that rely on the previous behavior of checking
resolution.resolvedId?To help verify the impact, you can run the following script to search for other occurrences of
resolution.resolvedIdandresolution.resolvedAtin the codebase:Review the search results to ensure that the change in the if condition is consistent with the usage of
resolution.resolvedIdandresolution.resolvedAtthroughout the codebase.Verification successful
This script uses multiple methods to search for the relevant terms, which should provide us with the necessary information to verify the impact of the change, even if one method fails.
Verification confirms the change is consistent and purposeful.
The change from checking
resolution.resolvedIdtoresolution.resolvedAtin the composite-arns-resolver.ts file is verified to be consistent with the usage of these properties throughout the codebase. This modification serves to improve the precision of cache validation:
resolvedAtis a timestamp that allows for more accurate determination of cache validity based on time elapsed.- The change aligns with the existing pattern of using both
resolvedIdandresolvedAtin resolution objects across various files.- No inconsistencies or unintended consequences were found as a result of this change.
The updated condition enhances the caching mechanism by using a time-based approach, which is generally more reliable for determining the freshness of cached data compared to using only the
resolvedId.Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Search for occurrences of `resolution.resolvedId` and `resolution.resolvedAt` in the codebase. # Test 1: Search for occurrences of `resolution.resolvedId`. rg --type typescript $'resolution\.resolvedId' # Test 2: Search for occurrences of `resolution.resolvedAt`. rg --type typescript $'resolution\.resolvedAt'Length of output: 165
Script:
#!/bin/bash # Description: Search for occurrences of `resolvedId` and `resolvedAt` in the codebase using multiple methods. # Method 1: Use rg without specifying file type echo "=== Method 1: Using rg without file type specification ===" echo "Searching for 'resolvedId':" rg 'resolvedId' echo -e "\nSearching for 'resolvedAt':" rg 'resolvedAt' # Method 2: Use fd to find TypeScript files and xargs with grep echo -e "\n=== Method 2: Using fd and grep ===" echo "Searching for 'resolvedId':" fd -e ts -e tsx | xargs grep -n 'resolvedId' echo -e "\nSearching for 'resolvedAt':" fd -e ts -e tsx | xargs grep -n 'resolvedAt' # Method 3: Search for 'resolvedAt' property in general echo -e "\n=== Method 3: Searching for 'resolvedAt' property ===" rg '\.resolvedAt'Length of output: 9747
src/types.d.ts (1)
617-620: Ensure consistent typing acrossNameResolutionunion typeWith the addition of
MissingNameResolutionandFailedNameResolutionto theNameResolutiontype, ensure that all interfaces in the union have consistent property definitions. Using optional properties allows for better type safety and cleaner code when handling different resolution states.
| // An error occured while resolving the name | ||
| export interface FailedNameResolution { | ||
| name: string; | ||
| resolvedId: undefined; | ||
| resolvedAt: undefined; | ||
| ttl: undefined; | ||
| processId: undefined; | ||
| } |
There was a problem hiding this comment.
Correct typo in comment and use optional properties in FailedNameResolution
- The comment on line 608 has a typo: "occured" should be "occurred".
- Similar to the previous interface, consider using optional properties instead of assigning
undefinedto the properties.
Here is the suggested diff:
-// An error occured while resolving the name
+// An error occurred while resolving the name
export interface FailedNameResolution {
name: string;
- resolvedId: undefined;
- resolvedAt: undefined;
- ttl: undefined;
- processId: undefined;
+ resolvedId?: string;
+ resolvedAt?: number;
+ ttl?: number;
+ processId?: string;
}Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| // An error occured while resolving the name | |
| export interface FailedNameResolution { | |
| name: string; | |
| resolvedId: undefined; | |
| resolvedAt: undefined; | |
| ttl: undefined; | |
| processId: undefined; | |
| } | |
| // An error occurred while resolving the name | |
| export interface FailedNameResolution { | |
| name: string; | |
| resolvedId?: string; | |
| resolvedAt?: number; | |
| ttl?: number; | |
| processId?: string; | |
| } |
| // Name resolved, but is missing | ||
| export interface MissingNameResolution { | ||
| name: string; | ||
| resolvedId: undefined; | ||
| resolvedAt: number; | ||
| ttl: number; | ||
| processId: undefined; | ||
| } |
There was a problem hiding this comment.
Typo in comment and suggest using optional properties for better TypeScript practices
- There's a typo in the comment on line 599: "occured" should be "occurred".
- Instead of assigning properties to
undefined, consider making these properties optional using?, which is more idiomatic in TypeScript.
Apply this diff to correct the typo and update the interface:
-// Name resolved, but is missing
+// Name resolved, but is missing details
export interface MissingNameResolution {
name: string;
- resolvedId: undefined;
+ resolvedId?: string;
resolvedAt: number;
ttl: number;
- processId: undefined;
+ processId?: string;
}Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| // Name resolved, but is missing | |
| export interface MissingNameResolution { | |
| name: string; | |
| resolvedId: undefined; | |
| resolvedAt: number; | |
| ttl: number; | |
| processId: undefined; | |
| } | |
| // Name resolved, but is missing details | |
| export interface MissingNameResolution { | |
| name: string; | |
| resolvedId?: string; | |
| resolvedAt: number; | |
| ttl: number; | |
| processId?: string; | |
| } |
| if (arnsRecord === undefined || arnsRecord.processId === undefined) { | ||
| throw new Error('Invalid name, arns record not found'); | ||
| if ( | ||
| arnsRecord === undefined || |
There was a problem hiding this comment.
Keep throwing on arnsRecord === undefined
djwhitt
force-pushed
the
cache-non-existent-name-resolutions
branch
from
5ea9906
to
3754d37
Compare
Without this it's easy for non-existent names to DOS the CUs we're using to resolve names. This change caches non-existent name resolutions for 5 minutes in the in-memory/Redis cache.
djwhitt
force-pushed
the
cache-non-existent-name-resolutions
branch
from
3754d37
to
8a92d91
Compare
Without this it's easy for non-existent names to DOS the CUs we're using to resolve names. This change caches non-existent name resolutions for 5 minutes in the in-memory/Redis cache.