feat: allow overriding timeout of KVS.setRecord calls (#692)

Related: https://apify.slack.com/archives/C0L33UM7Z/p1747043120071539

Author: B4nan

src/resource_clients/key_value_store.ts

@@ -166,7 +166,7 @@ export class KeyValueStoreClient extends ResourceClient {
      *
      * https://docs.apify.com/api/v2#/reference/key-value-stores/record/put-record
      */
-    async setRecord(record: KeyValueStoreRecord<JsonValue>): Promise<void> {
+    async setRecord(record: KeyValueStoreRecord<JsonValue>, options: KeyValueStoreRecordOptions = {}): Promise<void> {
         ow(
             record,
             ow.object.exactShape({
@@ -176,8 +176,17 @@ export class KeyValueStoreClient extends ResourceClient {
             }),
         );
 
+        ow(
+            options,
+            ow.object.exactShape({
+                timeoutSecs: ow.optional.number,
+                doNotRetryTimeouts: ow.optional.boolean,
+            }),
+        );
+
         const { key } = record;
         let { value, contentType } = record;
+        const { timeoutSecs, doNotRetryTimeouts } = options;
 
         const isValueStreamOrBuffer = isStream(value) || isBuffer(value);
         // To allow saving Objects to JSON without providing content type
@@ -203,8 +212,13 @@ export class KeyValueStoreClient extends ResourceClient {
             params: this._params(),
             data: value,
             headers: contentType ? { 'content-type': contentType } : undefined,
+            doNotRetryTimeouts,
         };
 
+        if (timeoutSecs != null) {
+            uploadOpts.timeout = timeoutSecs * 1000;
+        }
+
         await this.httpClient.call(uploadOpts);
     }
 
@@ -280,6 +294,11 @@ export interface KeyValueStoreRecord<T> {
     contentType?: string;
 }
 
+export interface KeyValueStoreRecordOptions {
+    timeoutSecs?: number;
+    doNotRetryTimeouts?: boolean;
+}
+
 export type ReturnTypeFromOptions<Options extends KeyValueClientGetRecordOptions> = Options['stream'] extends true
     ? Readable
     : Options['buffer'] extends true

test/key_value_stores.test.js

@@ -425,6 +425,41 @@ describe('Key-Value Store methods', () => {
             validateRequest({}, { storeId, key }, value, expectedHeaders);
         });
 
+        test('setRecord() works with custom timeout options', async () => {
+            const key = 'some-key';
+            const storeId = 'some-id';
+            const value = { foo: 'bar', one: 1 };
+            const expectedHeaders = {
+                'content-type': 'application/json; charset=utf-8',
+            };
+
+            const res = await client.keyValueStore(storeId).setRecord(
+                { key, value },
+                {
+                    timeoutSecs: 1,
+                    doNotRetryTimeouts: true,
+                },
+            );
+            expect(res).toBeUndefined();
+            validateRequest({}, { storeId, key }, value, expectedHeaders);
+
+            const browserRes = await page.evaluate(
+                (id, key, value) =>
+                    client.keyValueStore(id).setRecord(
+                        { key, value },
+                        {
+                            timeoutSecs: 1,
+                            doNotRetryTimeouts: true,
+                        },
+                    ),
+                storeId,
+                key,
+                value,
+            );
+            expect(browserRes).toBeUndefined();
+            validateRequest({}, { storeId, key }, value, expectedHeaders);
+        });
+
         test('setRecord() works with buffer', async () => {
             const key = 'some-key';
             const storeId = 'some-id';

website/versioned_docs/version-2.12/api-packages.json

@@ -5,6 +5,6 @@
         "packagePath": ".",
         "packageSlug": ".",
         "packageName": "apify-client",
-        "packageVersion": "2.12.2"
+        "packageVersion": "2.12.4"
     }
 ]