feat: input schema defaults in getInput

package.json

@@ -61,7 +61,7 @@
         "test/**/*": [
             "eslint --fix"
         ],
-        "*": "prettier --write"
+        "*": "prettier --write --ignore-unknown"
     },
     "devDependencies": {
         "@apify/consts": "^2.29.0",

packages/apify/src/actor.ts

@@ -47,6 +47,10 @@ import { addTimeoutToPromise } from '@apify/timeout';
 import type { ChargeOptions, ChargeResult } from './charging.js';
 import { ChargingManager } from './charging.js';
 import { Configuration } from './configuration.js';
+import {
+    getDefaultsFromInputSchema,
+    readInputSchema,
+} from './input-schemas.js';
 import { KeyValueStore } from './key_value_store.js';
 import { PlatformEventManager } from './platform_event_manager.js';
 import type { ProxyConfigurationOptions } from './proxy_configuration.js';
@@ -1219,18 +1223,27 @@ export class Actor<Data extends Dictionary = Dictionary> {
         const inputSecretsPrivateKeyPassphrase = this.config.get(
             'inputSecretsPrivateKeyPassphrase',
         );
-        const input = await this.getValue<T>(this.config.get('inputKey'));
+        const rawInput = await this.getValue<T>(this.config.get('inputKey'));
+
+        let input = rawInput as T;
+
         if (
-            ow.isValid(input, ow.object.nonEmpty) &&
+            ow.isValid(rawInput, ow.object.nonEmpty) &&
             inputSecretsPrivateKeyFile &&
             inputSecretsPrivateKeyPassphrase
         ) {
             const privateKey = createPrivateKey({
                 key: Buffer.from(inputSecretsPrivateKeyFile, 'base64'),
                 passphrase: inputSecretsPrivateKeyPassphrase,
             });
-            return decryptInputSecrets<T>({ input, privateKey });
+
+            input = decryptInputSecrets({ input: rawInput, privateKey });
+        }
+
+        if (ow.isValid(input, ow.object.nonEmpty) && !Buffer.isBuffer(input)) {
+            input = await this.insertDefaultsFromInputSchema(input);
         }
+
         return input;
     }
 
@@ -2273,4 +2286,33 @@ export class Actor<Data extends Dictionary = Dictionary> {
             ].join('\n'),
         );
     }
+
+    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
+
+        const env = this.getEnv();
+        let inputSchema: Dictionary | undefined | null;
+
+        // On platform, we can get the input schema from the build data
+        if (this.isAtHome() && env.actorBuildId) {
+            const buildData = await this.apifyClient
+                .build(env.actorBuildId)
+                .get();
+
+            inputSchema = buildData?.actorDefinition?.input;
+        } else {
+            // On local, we can get the input schema from the local config
+            inputSchema = readInputSchema();
+        }
+
+        if (!inputSchema) {
+            return input;
+        }
+
+        const defaults = getDefaultsFromInputSchema(inputSchema);
+
+        return { ...defaults, ...input };
+    }
 }

packages/apify/src/input-schemas.ts

@@ -0,0 +1,70 @@
+// TODO: v0, move all this logic from here and apify-cli to input_schema module
+
+import { existsSync, readFileSync } from 'node:fs';
+import { join } from 'node:path';
+import process from 'node:process';
+
+import type { Dictionary } from '@crawlee/utils';
+
+const DEFAULT_INPUT_SCHEMA_PATHS = [
+    ['.actor', 'INPUT_SCHEMA.json'],
+    ['INPUT_SCHEMA.json'],
+    ['.actor', 'input_schema.json'],
+    ['input_schema.json'],
+];
+
+const ACTOR_SPECIFICATION_FOLDER = '.actor';
+
+const LOCAL_CONFIG_NAME = 'actor.json';
+
+function readJSONIfExists(path: string): Dictionary | null {
+    if (existsSync(path)) {
+        const content = readFileSync(path, 'utf8');
+        return JSON.parse(content);
+    }
+
+    return null;
+}
+
+export const readInputSchema = (): Dictionary | null => {
+    const localConfig = readJSONIfExists(
+        join(process.cwd(), ACTOR_SPECIFICATION_FOLDER, LOCAL_CONFIG_NAME),
+    );
+
+    if (typeof localConfig?.input === 'object') {
+        return localConfig.input;
+    }
+
+    if (typeof localConfig?.input === 'string') {
+        const fullPath = join(
+            process.cwd(),
+            ACTOR_SPECIFICATION_FOLDER,
+            localConfig.input,
+        );
+
+        return readJSONIfExists(fullPath);
+    }
+
+    for (const path of DEFAULT_INPUT_SCHEMA_PATHS) {
+        const fullPath = join(process.cwd(), ...path);
+        if (existsSync(fullPath)) {
+            return readJSONIfExists(fullPath);
+        }
+    }
+
+    return null;
+};
+
+export const getDefaultsFromInputSchema = (inputSchema: any) => {
+    const defaults: Record<string, unknown> = {};
+
+    for (const [key, fieldSchema] of Object.entries<any>(
+        inputSchema.properties,
+    )) {
+        if (fieldSchema.default !== undefined) {
+            defaults[key] = fieldSchema.default;
+        }
+    }
+
+    return defaults;
+};

test/e2e/runSdkTests.mjs

@@ -8,7 +8,7 @@ import { isMainThread, Worker, workerData } from 'node:worker_threads';
 import { ApifyClient } from 'apify-client';
 
 import { ACTOR_SOURCE_TYPES } from '@apify/consts';
-import { log } from '@apify/log';
+import log from '@apify/log';
 import { cryptoRandomObjectId } from '@apify/utilities';
 
 const rootPath = dirname(fileURLToPath(import.meta.url));

test/e2e/sdk/actorInput/.actor/Dockerfile

@@ -0,0 +1,26 @@
+FROM node:22 AS builder
+
+COPY /package*.json ./
+RUN npm --quiet set progress=false \
+    && npm install --only=prod --no-optional --no-audit \
+    && npm update
+
+COPY /apify.tgz /apify.tgz
+RUN npm --quiet install /apify.tgz
+
+FROM apify/actor-node:22
+
+RUN rm -r node_modules
+COPY --from=builder /node_modules ./node_modules
+COPY --from=builder /package*.json ./
+COPY /.actor ./.actor
+COPY /src ./src
+
+RUN echo "Installed NPM packages:" \
+    && (npm list --only=prod --no-optional --all || true) \
+    && echo "Node.js version:" \
+    && node --version \
+    && echo "NPM version:" \
+    && npm --version
+
+CMD npm start --silent

test/e2e/sdk/actorInput/.actor/actor.json

@@ -0,0 +1,19 @@
+{
+    "actorSpecification": 1,
+    "name": "apify-sdk-js-test-input",
+    "version": "0.0",
+    "input": {
+        "title": "Actor Input",
+        "description": "Test input",
+        "type": "object",
+        "schemaVersion": 1,
+        "properties": {
+            "foo": {
+                "title": "Foo",
+                "type": "string",
+                "description": "Foo",
+                "default": "bar"
+            }
+        }
+    }
+}

test/e2e/sdk/actorInput/package.json

@@ -0,0 +1,17 @@
+{
+    "name": "apify-sdk-js-test-harness",
+    "version": "0.0.1",
+    "type": "module",
+    "description": "This is an example of an Apify actor.",
+    "engines": {
+        "node": ">=22.0.0"
+    },
+    "dependencies": {
+        "apify": "*"
+    },
+    "scripts": {
+        "start": "node ./src/main.mjs"
+    },
+    "author": "It's not you it's me",
+    "license": "ISC"
+}

test/e2e/sdk/actorInput/src/main.mjs

@@ -0,0 +1,11 @@
+import { Actor, log } from 'apify';
+
+await Actor.init();
+
+const input = await Actor.getInput();
+
+log.info(`Input: ${JSON.stringify(input)}`);
+
+await Actor.setValue('RECEIVED_INPUT', input);
+
+await Actor.exit();

test/e2e/sdk/actorInput/test.mjs

@@ -0,0 +1,44 @@
+import assert from 'node:assert/strict';
+import test from 'node:test';
+
+import { ApifyClient, KeyValueStore } from 'apify';
+import { sleep } from 'crawlee';
+
+const client = new ApifyClient({
+    token: process.env.APIFY_TOKEN,
+});
+
+const actor = client.actor(process.argv[2]);
+
+const runActor = async (input, options) => {
+    const { id: runId } = await actor.call(input, options);
+    await client.run(runId).waitForFinish();
+    await sleep(6000); // wait for updates to propagate to MongoDB
+    return await client.run(runId).get();
+};
+
+test('defaults work', async () => {
+    const run = await runActor({}, {});
+
+    assert.strictEqual(run.status, 'SUCCEEDED');
+
+    const store = await KeyValueStore.open(run.defaultKeyValueStoreId, {
+        storageClient: client,
+    });
+
+    const receivedInput = await store.getValue('RECEIVED_INPUT');
+    assert.deepEqual(receivedInput, { foo: 'bar' });
+});
+
+test('input is passed through', async () => {
+    const run = await runActor({ foo: 'baz' }, {});
+
+    assert.strictEqual(run.status, 'SUCCEEDED');
+
+    const store = await KeyValueStore.open(run.defaultKeyValueStoreId, {
+        storageClient: client,
+    });
+
+    const receivedInput = await store.getValue('RECEIVED_INPUT');
+    assert.deepEqual(receivedInput, { foo: 'baz' });
+});