Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Add Timeout to Finder #79

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.

Sign up for GitHub

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

Merged
merged 4 commits into from
Feb 22, 2024
Merged

Add Timeout to Finder #79

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
7eca674
add timeout
lapritchett Feb 21, 2024
c64b8e6
clearer variable name
lapritchett Feb 21, 2024
9d508c9
address feedback
lapritchett Feb 21, 2024
31c9546
update docs
lapritchett Feb 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@ const selector = finder(event.target, {
optimizedMinLength: 2,
threshold: 1000,
maxNumberOfTries: 10_000,
timeoutMs: undefined,
})
```

Expand All @@ -77,6 +78,10 @@ selectors to check. Default `1000` is good enough in most cases.
Max number of tries for the optimization. This is a trade-off between
optimization and efficiency. Default `10_000` is good enough in most cases.

### timeoutMs

Optional timeout in milliseconds. `undefined` (no timeout) by default. If `timeoutMs: 500` is provided, an error will be thrown if selector generation takes more than 500ms.

## Become a sponsor

Every line of code in my repositories 📖 signifies my unwavering commitment to open source 💡. Your support 🤝 ensures these projects keep thriving, innovating, and benefiting all 💼. If my work has ever resonated 🎵 or helped you, kindly consider showing love ❤️ by sponsoring. [**🚀 Sponsor Me Today! 🚀**](https://github.com/sponsors/antonmedv)
Expand Down
8 changes: 8 additions & 0 deletions finder.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,12 +20,15 @@ export type Options = {
optimizedMinLength: number
threshold: number
maxNumberOfTries: number
timeoutMs: number | undefined
}

let config: Options
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we could have let start: Date | undefined here

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I took start out of options but I think you meant timeoutMs could be undefined

let rootDocument: Document | Element
let start: Date

export function finder(input: Element, options?: Partial<Options>) {
start = new Date()
if (input.nodeType !== Node.ELEMENT_NODE) {
throw new Error(`Can't generate CSS selector for non-element node type.`)
}
Expand All @@ -42,6 +45,7 @@ export function finder(input: Element, options?: Partial<Options>) {
optimizedMinLength: 2,
threshold: 1000,
maxNumberOfTries: 10000,
timeoutMs: undefined,
}

config = {...defaults, ...options}
Expand Down Expand Up @@ -84,6 +88,10 @@ function bottomUpSearch(
let current: Element | null = input
let i = 0
while (current) {
const elapsedTime = new Date().getTime() - start.getTime();
if (config.timeoutMs !== undefined && elapsedTime > config.timeoutMs) {
throw new Error(`Timeout: Can't find a unique selector after ${elapsedTime}ms`)
}
let level: Knot[] = maybe(id(current)) ||
maybe(...attr(current)) ||
maybe(...classNames(current)) ||
Expand Down