Refactor: Simplify input handling #66
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jirispilka
approved these changes
Mar 27, 2025
Collaborator
jirispilka
left a comment
jirispilka
left a comment
There was a problem hiding this comment.
Thank you!
Looks great.
As Lukas suggested, can you also remove table with query params from README.md?
Since the inputs for normal mode and standby are 1:1. It will greatly shorten the README.
Otherwise, LGTM.
src/utils.ts
Outdated
| type SchemaKey = keyof typeof inputSchema.properties; | ||
|
|
||
| const typedKey = key as SchemaKey; | ||
| // const inputKey = key as keyof typeof parsedInput; |
Collaborator
There was a problem hiding this comment.
I would remove this commented out code
Collaborator
Author
|
@jirispilka I have removed the dead code and remove the table from README.md. |
matyascimbulka
requested review from
MQ37
and removed request for
metalwarrior665
Collaborator
Author
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Based on this comment by @metalwarrior665 I've decided to have a look at simplifying input handling.
To simplify things I have decided to remove the
defaultsobject and rewrite thevalidateAndFillInputfunction to use the input schema directly.How it works
Normal mode
In normal mode the input is received via
Actor.getInput()which is then processed using theprocessInputfunction where its validated and completed. This function then returns the necessary crawler options to complete the query.Standby mode
When standby mode is initiated it will receive its initial input via
Actor.getInput(). This input is processed using theprocessStandbyInputwhich returns crawler options for all possible crawlers which is then used to start them. Then it waits for request.When a request arrives its parameters are parsed using the
parseParametersfunction which returnsPartial<Input>object. This object is then directly fed into theparseInputfunction where its validated and completed like standby input.Here are example runs: