feat: respect input schema defaults in Actor.getInput()
#409
Conversation
github-actions
bot
added
t-tooling
| return null; | ||
| } | ||
|
|
||
| export const readInputSchema = (): Dictionary | null => { |
There was a problem hiding this comment.
nit: can we make all of them (readJSONIfExists, readInputSchema, getDefaultsFromInputSchema) function (or make all of them const arrow function)?
|
|
||
| export const readInputSchema = (): Dictionary | null => { | ||
| const localConfig = readJSONIfExists( | ||
| join(process.cwd(), ACTOR_SPECIFICATION_FOLDER, LOCAL_CONFIG_NAME), |
There was a problem hiding this comment.
process.cwd() will likely break if the Dockerfile entry point is not npm (--prefix=app/) start, but e.g. node app/main.js
But I'm not sure how else we would refer to these files 🤔 I guess it's okay to live with this, especially since on Platform, we load this via API.
There was a problem hiding this comment.
I only gave it a quick look, but it looks like we don't copy the .actor directory in our Dockerfiles anyway, so for the "build a Docker image and run it outside of the platform" use case, the answer to "But I'm not sure how else we would refer to these files" is probably "tough luck lol" 🤷
But if we add a nice error log when there's not input schema to be found, yeah, we can live with that.
| .build(env.actorBuildId) | ||
| .get(); | ||
|
|
||
| inputSchema = buildData?.actorDefinition?.input; |
There was a problem hiding this comment.
I would at least log an error if this is not present in the response.
| inputSchema = buildData?.actorDefinition?.input; | ||
| } else { | ||
| // On local, we can get the input schema from the local config | ||
| inputSchema = readInputSchema(); |
There was a problem hiding this comment.
It'd also be nice to log something if no input schema is found.
|
|
||
| export const readInputSchema = (): Dictionary | null => { | ||
| const localConfig = readJSONIfExists( | ||
| join(process.cwd(), ACTOR_SPECIFICATION_FOLDER, LOCAL_CONFIG_NAME), |
There was a problem hiding this comment.
I only gave it a quick look, but it looks like we don't copy the .actor directory in our Dockerfiles anyway, so for the "build a Docker image and run it outside of the platform" use case, the answer to "But I'm not sure how else we would refer to these files" is probably "tough luck lol" 🤷
But if we add a nice error log when there's not input schema to be found, yeah, we can live with that.
B4nan
changed the title
Actor.getInput()
| ); | ||
| } | ||
|
|
||
| private async insertDefaultsFromInputSchema<T extends Dictionary>( |
There was a problem hiding this comment.
infer seems like a better word here
| private async insertDefaultsFromInputSchema<T extends Dictionary>( | |
| private async inferDefaultsFromInputSchema<T extends Dictionary>( |
| @@ -0,0 +1,70 @@ | |||
| // TODO: v0, move all this logic from here and apify-cli to input_schema module | |||
There was a problem hiding this comment.
I'd rather see an issue instead of a TODO in code, TODOs always rot in there.
| private async insertDefaultsFromInputSchema<T extends Dictionary>( | ||
| input: T, | ||
| ): Promise<T> { | ||
| // TODO: v0, move all this logic from here and apify-cli to input_schema module |
| let inputSchema: Dictionary | undefined | null; | ||
|
|
||
| // On platform, we can get the input schema from the build data | ||
| if (this.isAtHome() && env.actorBuildId) { |
There was a problem hiding this comment.
why do we even need this? this change was only supposed to be dealing with the local development, on platform you always get the whole input from the API
| const DEFAULT_INPUT_SCHEMA_PATHS = [ | ||
| ['.actor', 'INPUT_SCHEMA.json'], | ||
| ['INPUT_SCHEMA.json'], | ||
| ['.actor', 'input_schema.json'], | ||
| ['input_schema.json'], | ||
| ]; |
There was a problem hiding this comment.
the name of the input schema file is configurable via .actor.json, ideally we'd get it from there
|
@vladfrangu there are some unresolved comments from others too, I'd like to ship next SDK soon, including this PR, let's try to resolve them asap |
Way too overdue, closes #287