apify 4.0.0-beta.31 → 4.0.0-beta.32

package/dist/actor.d.ts

@@ -319,8 +319,6 @@ export declare const EXIT_CODES: {
  */
 export declare class Actor<Data extends Dictionary = Dictionary> {
     #private;
-    /** @internal */
-    static _instance: Actor;
     /**
      * Configuration of this SDK instance (provided to its constructor). See {@link Configuration} for details.
      * @internal
@@ -340,26 +338,6 @@ export declare class Actor<Data extends Dictionary = Dictionary> {
      * Whether the Actor instance was initialized. This is set by calling {@link Actor.init}.
      */
     initialized: boolean;
-    /**
-     * Set if the Actor called a method that requires the instance to be initialized, but did not do so.
-     * A call to `init` after this warning is emitted is considered  an invalid state and will throw an error.
-     */
-    private warnedAboutMissingInitCall;
-    /**
-     * Set if the Actor is currently rebooting.
-     */
-    private isRebooting;
-    /**
-     * Set if the Actor is currently exiting. Prevents double-exit from graceful shutdown handlers.
-     */
-    private isExiting;
-    /**
-     * References to graceful shutdown handlers so they can be removed during cleanup.
-     */
-    private gracefulShutdownHandlers;
-    private chargingManager;
-    /** How Apify platform request queues are consumed; set from {@link InitOptions.requestQueueAccess}. */
-    private requestQueueAccess;
     constructor(options?: ActorOptions);
     /**
      * Runs the main user function that performs the job of the Actor
@@ -1383,11 +1361,16 @@ export declare class Actor<Data extends Dictionary = Dictionary> {
     static get configuration(): Configuration;
     /** @internal */
     static getDefaultInstance(): Actor;
+    /**
+     * Replaces or clears the cached default instance returned by {@link Actor.getDefaultInstance}.
+     * @internal
+     */
+    static setDefaultInstance(instance?: Actor): void;
     private usesPushDataInterception;
     private pushDataViaInterceptedClient;
     private pushDataWithExplicitCharging;
     private createApifyStorageBackend;
-    private _ensureActorInit;
+    private ensureActorInit;
     /**
      * Get time remaining from the Actor run timeout in seconds, rounded up to whole seconds with minimum value of 1 second.
      *

package/dist/actor.js

@@ -33,7 +33,7 @@ export const EXIT_CODES = {
  */
 export class Actor {
     /** @internal */
-    static _instance;
+    static #instance;
     /**
      * Configuration of this SDK instance (provided to its constructor). See {@link Configuration} for details.
      * @internal
@@ -57,26 +57,26 @@ export class Actor {
      * Set if the Actor called a method that requires the instance to be initialized, but did not do so.
      * A call to `init` after this warning is emitted is considered  an invalid state and will throw an error.
      */
-    warnedAboutMissingInitCall = false;
+    #warnedAboutMissingInitCall = false;
     /**
      * Set if the Actor is currently rebooting.
      */
-    isRebooting = false;
+    #isRebooting = false;
     /**
      * Set if the Actor is currently exiting. Prevents double-exit from graceful shutdown handlers.
      */
-    isExiting = false;
+    #isExiting = false;
     /**
      * References to graceful shutdown handlers so they can be removed during cleanup.
      */
-    gracefulShutdownHandlers = {};
+    #gracefulShutdownHandlers = {};
     /**
      * Reference to the crawlee status message forwarder, so it can be removed during cleanup.
      */
     #statusMessageForwarder;
-    chargingManager;
+    #chargingManager;
     /** How Apify platform request queues are consumed; set from {@link InitOptions.requestQueueAccess}. */
-    requestQueueAccess = 'single';
+    #requestQueueAccess = 'single';
     constructor(options = {}) {
         const { configuration, ...configOptions } = options;
         if (configuration) {
@@ -101,7 +101,7 @@ export class Actor {
         }
         this.apifyClient = this.newClient();
         this.eventManager = new PlatformEventManager(this.configuration);
-        this.chargingManager = new ChargingManager(this.configuration, this.apifyClient);
+        this.#chargingManager = new ChargingManager(this.configuration, this.apifyClient);
     }
     /**
      * Runs the main user function that performs the job of the Actor
@@ -192,7 +192,7 @@ export class Actor {
             return;
         }
         // If the warning about forgotten init call was emitted, we will not continue the init procedure.
-        if (this.warnedAboutMissingInitCall) {
+        if (this.#warnedAboutMissingInitCall) {
             throw new Error([
                 'Actor.init() was called after a method that would access a storage client was used.',
                 'This in an invalid state. Please make sure to call Actor.init() before such methods are called.',
@@ -206,7 +206,7 @@ export class Actor {
         // the event manager resolve the same instance (`availableMemoryRatio` /
         // `disableBrowserSandbox` at-home defaults now live in `Configuration`).
         serviceLocator.setConfiguration(this.configuration);
-        this.requestQueueAccess = options.requestQueueAccess ?? 'single';
+        this.#requestQueueAccess = options.requestQueueAccess ?? 'single';
         if (this.isAtHome()) {
             serviceLocator.setStorageBackend(this.createApifyStorageBackend());
             serviceLocator.setEventManager(this.eventManager);
@@ -223,22 +223,22 @@ export class Actor {
         // Using setTimeout to avoid deadlock with waitForAllListenersToComplete() in exit()/reboot()
         if (options.gracefulShutdown !== false) {
             const delay = options.gracefulShutdownDelayMillis ?? 0;
-            this.gracefulShutdownHandlers.aborting = () => {
+            this.#gracefulShutdownHandlers.aborting = () => {
                 setTimeout(() => {
                     this.exit().catch((err) => {
                         log.exception(err, 'Failed to exit gracefully');
                     });
                 }, delay);
             };
-            this.on(ACTOR_EVENT_NAMES.ABORTING, this.gracefulShutdownHandlers.aborting);
-            this.gracefulShutdownHandlers.migrating = () => {
+            this.on(ACTOR_EVENT_NAMES.ABORTING, this.#gracefulShutdownHandlers.aborting);
+            this.#gracefulShutdownHandlers.migrating = () => {
                 setTimeout(() => {
                     this.reboot().catch((err) => {
                         log.exception(err, 'Failed to reboot on migration');
                     });
                 }, delay);
             };
-            this.on(ACTOR_EVENT_NAMES.MIGRATING, this.gracefulShutdownHandlers.migrating);
+            this.on(ACTOR_EVENT_NAMES.MIGRATING, this.#gracefulShutdownHandlers.migrating);
         }
         // Crawlee crawlers, for instance, broadcast their status messages as `statusMessage` events.
         this.#statusMessageForwarder = async ({ message, isStatusMessageTerminal }) => this.#updateRunStatusMessage(message, isStatusMessageTerminal);
@@ -248,19 +248,19 @@ export class Actor {
             onlyPurgeOnce: true,
         });
         log.debug(`Default storages purged`);
-        await this.chargingManager.init();
-        log.debug(`ChargingManager initialized`, this.chargingManager.getPricingInfo());
+        await this.#chargingManager.init();
+        log.debug(`ChargingManager initialized`, this.#chargingManager.getPricingInfo());
     }
     /**
      * @ignore
      */
     async exit(messageOrOptions, options = {}) {
         // Prevent double-exit from graceful shutdown handlers
-        if (this.isExiting) {
+        if (this.#isExiting) {
             log.debug('Actor.exit() called while already exiting, skipping');
             return;
         }
-        this.isExiting = true;
+        this.#isExiting = true;
         options =
             typeof messageOrOptions === 'string'
                 ? { ...options, statusMessage: messageOrOptions }
@@ -268,15 +268,15 @@ export class Actor {
         options.exit ??= true;
         options.exitCode ??= EXIT_CODES.SUCCESS;
         options.timeoutSecs ??= 30;
-        this._ensureActorInit('exit');
+        this.ensureActorInit('exit');
         const client = serviceLocator.getStorageBackend();
         const events = serviceLocator.getEventManager();
         // Remove graceful shutdown handlers to prevent them from interfering with exit
-        if (this.gracefulShutdownHandlers.aborting) {
-            this.off(ACTOR_EVENT_NAMES.ABORTING, this.gracefulShutdownHandlers.aborting);
+        if (this.#gracefulShutdownHandlers.aborting) {
+            this.off(ACTOR_EVENT_NAMES.ABORTING, this.#gracefulShutdownHandlers.aborting);
         }
-        if (this.gracefulShutdownHandlers.migrating) {
-            this.off(ACTOR_EVENT_NAMES.MIGRATING, this.gracefulShutdownHandlers.migrating);
+        if (this.#gracefulShutdownHandlers.migrating) {
+            this.off(ACTOR_EVENT_NAMES.MIGRATING, this.#gracefulShutdownHandlers.migrating);
         }
         // Close the event manager and emit the final PERSIST_STATE event
         await events.close();
@@ -324,7 +324,7 @@ export class Actor {
         });
         // Reset the flag so the instance can be reused (e.g., in tests or when exit is false).
         // When process.exit() actually terminates the process, this line is never reached - which is fine.
-        this.isExiting = false;
+        this.#isExiting = false;
         if (!options.exit) {
             return;
         }
@@ -498,16 +498,16 @@ export class Actor {
      * @ignore
      */
     async reboot(options = {}) {
-        this._ensureActorInit('reboot');
+        this.ensureActorInit('reboot');
         if (!this.isAtHome()) {
             log.warning('Actor.reboot() is only supported when running on the Apify platform.');
             return;
         }
-        if (this.isRebooting) {
+        if (this.#isRebooting) {
             log.debug('Actor is already rebooting, skipping the additional reboot call.');
             return;
         }
-        this.isRebooting = true;
+        this.#isRebooting = true;
         // Waiting for all the listeners to finish, as `.reboot()` kills the container.
         await Promise.all([
             // `persistState` for individual RequestLists, RequestQueue... instances to be persisted
@@ -581,7 +581,7 @@ export class Actor {
         const { isStatusMessageTerminal, level } = options || {};
         parseArgument(statusMessage, z.string());
         parseArgument(isStatusMessageTerminal, z.boolean().optional());
-        this._ensureActorInit('setStatusMessage');
+        this.ensureActorInit('setStatusMessage');
         const loggedStatusMessage = `[Status message]: ${statusMessage}`;
         switch (level) {
             case 'DEBUG':
@@ -639,7 +639,7 @@ export class Actor {
      * @ignore
      */
     async pushData(item, eventName) {
-        this._ensureActorInit('pushData');
+        this.ensureActorInit('pushData');
         if (eventName?.startsWith('apify-')) {
             throw new Error(`Cannot charge for synthetic event '${eventName}' manually`);
         }
@@ -674,7 +674,7 @@ export class Actor {
      */
     async openDataset(datasetIdOrName, options = {}) {
         parseArgument(options, z.object({ forceCloud: z.boolean().optional() }).strict());
-        this._ensureActorInit('openDataset');
+        this.ensureActorInit('openDataset');
         return Dataset.open(datasetIdOrName ?? null, {
             storageBackend: options.forceCloud ? this.createApifyStorageBackend() : undefined,
         });
@@ -708,7 +708,7 @@ export class Actor {
      * @ignore
      */
     async getValue(key) {
-        this._ensureActorInit('getValue');
+        this.ensureActorInit('getValue');
         const store = await this.openKeyValueStore();
         return store.getValue(key);
     }
@@ -744,7 +744,7 @@ export class Actor {
      * @ignore
      */
     async setValue(key, value, options = {}) {
-        this._ensureActorInit('setValue');
+        this.ensureActorInit('setValue');
         const store = await this.openKeyValueStore();
         return store.setValue(key, value, options);
     }
@@ -778,7 +778,7 @@ export class Actor {
      * @ignore
      */
     async getInput() {
-        this._ensureActorInit('getInput');
+        this.ensureActorInit('getInput');
         const { inputSecretsPrivateKeyFile, inputSecretsPrivateKeyPassphrase } = this.configuration;
         const rawInput = await this.getValue(this.configuration.inputKey);
         let input = rawInput;
@@ -824,7 +824,7 @@ export class Actor {
      */
     async openKeyValueStore(storeIdOrName, options = {}) {
         parseArgument(options, z.object({ forceCloud: z.boolean().optional() }).strict());
-        this._ensureActorInit('openKeyValueStore');
+        this.ensureActorInit('openKeyValueStore');
         return KeyValueStore.open(storeIdOrName ?? null, {
             storageBackend: options.forceCloud ? this.createApifyStorageBackend() : undefined,
         });
@@ -850,7 +850,7 @@ export class Actor {
      */
     async openRequestQueue(queueIdOrName, options = {}) {
         parseArgument(options, z.object({ forceCloud: z.boolean().optional() }).strict());
-        this._ensureActorInit('openRequestQueue');
+        this.ensureActorInit('openRequestQueue');
         return RequestQueue.open(queueIdOrName ?? null, {
             storageBackend: options.forceCloud ? this.createApifyStorageBackend() : undefined,
         });
@@ -928,16 +928,16 @@ export class Actor {
      * @ignore
      */
     async charge(options) {
-        this._ensureActorInit('charge');
-        return this.chargingManager.charge(options);
+        this.ensureActorInit('charge');
+        return this.#chargingManager.charge(options);
     }
     /**
      * Retrieve the charging manager to access granular pricing information.
      * @ignore
      */
     getChargingManager() {
-        this._ensureActorInit('getChargingManager');
-        return this.chargingManager;
+        this.ensureActorInit('getChargingManager');
+        return this.#chargingManager;
     }
     /**
      * Modifies Actor env vars so parsing respects the structure of {@link ApifyEnv} interface.
@@ -1022,7 +1022,7 @@ export class Actor {
      * @param options An optional object parameter where a custom `keyValueStoreName` and `config` can be passed in.
      */
     async useState(name, defaultValue = {}, options) {
-        this._ensureActorInit('useState');
+        this.ensureActorInit('useState');
         const kvStore = await KeyValueStore.open(options?.keyValueStoreName, {
             configuration: options?.configuration || Configuration.getGlobalConfiguration(),
         });
@@ -1590,8 +1590,15 @@ export class Actor {
     }
     /** @internal */
     static getDefaultInstance() {
-        this._instance ??= new Actor();
-        return this._instance;
+        Actor.#instance ??= new Actor();
+        return Actor.#instance;
+    }
+    /**
+     * Replaces or clears the cached default instance returned by {@link Actor.getDefaultInstance}.
+     * @internal
+     */
+    static setDefaultInstance(instance) {
+        Actor.#instance = instance;
     }
     usesPushDataInterception(dataset) {
         return Boolean(dataset.backend[USES_PUSH_DATA_INTERCEPTION]);
@@ -1624,7 +1631,7 @@ export class Actor {
         }
         const isDefaultDataset = dataset.id === this.configuration.defaultDatasetId;
         return pushDataAndCharge({
-            chargingManager: this.chargingManager,
+            chargingManager: this.#chargingManager,
             items,
             eventName: explicitEventName,
             isDefaultDataset,
@@ -1634,19 +1641,19 @@ export class Actor {
     createApifyStorageBackend() {
         return new ApifyStorageBackend(this.apifyClient, {
             configuration: this.configuration,
-            requestQueueAccess: this.requestQueueAccess,
-            getChargingManager: () => this.chargingManager,
+            requestQueueAccess: this.#requestQueueAccess,
+            getChargingManager: () => this.#chargingManager,
         });
     }
-    _ensureActorInit(methodCalled) {
+    ensureActorInit(methodCalled) {
         // If we already warned the user once, don't do it again to prevent spam
-        if (this.warnedAboutMissingInitCall) {
+        if (this.#warnedAboutMissingInitCall) {
             return;
         }
         if (this.initialized) {
             return;
         }
-        this.warnedAboutMissingInitCall = true;
+        this.#warnedAboutMissingInitCall = true;
         log.warning([
             `Actor.${methodCalled}() was called but the Actor instance was not initialized.`,
             'Did you forget to call Actor.init()?',

package/dist/apify_dataset_backend.d.ts

@@ -9,7 +9,7 @@ import type { DatasetClient } from 'apify-client';
  * @internal
  */
 export declare class ApifyDatasetBackend implements DatasetBackend {
-    private readonly client;
+    #private;
     constructor(client: DatasetClient);
     getMetadata(): Promise<DatasetInfo>;
     drop(): Promise<void>;

package/dist/apify_dataset_backend.js

@@ -13,19 +13,19 @@ const MAX_ITEM_BYTES = EFFECTIVE_LIMIT_BYTES - 2;
  * @internal
  */
 export class ApifyDatasetBackend {
-    client;
+    #client;
     constructor(client) {
-        this.client = client;
+        this.#client = client;
     }
     async getMetadata() {
-        const metadata = await this.client.get();
+        const metadata = await this.#client.get();
         if (!metadata) {
             throw new Error('Dataset not found or has been deleted.');
         }
         return metadata;
     }
     async drop() {
-        await this.client.delete();
+        await this.#client.delete();
     }
     async purge() {
         throw new Error('Purging a dataset is not supported on the Apify platform. ' +
@@ -36,11 +36,11 @@ export class ApifyDatasetBackend {
         // that fit, pushed sequentially to preserve item order.
         const payloads = items.map((item, index) => serializeToSizeLimit(item, index));
         for (const chunk of chunkBySize(payloads, EFFECTIVE_LIMIT_BYTES)) {
-            await this.client.pushItems(chunk);
+            await this.#client.pushItems(chunk);
         }
     }
     async getData(options) {
-        return await this.client.listItems(options);
+        return await this.#client.listItems(options);
     }
 }
 /** Serializes a dataset item, throwing if it alone exceeds the payload size limit. */

package/dist/apify_key_value_store_backend.d.ts

@@ -9,7 +9,7 @@ import type { KeyValueStoreClient } from 'apify-client';
  * @internal
  */
 export declare class ApifyKeyValueStoreBackend implements KeyValueStoreBackend {
-    private readonly client;
+    #private;
     constructor(client: KeyValueStoreClient);
     getMetadata(): Promise<KeyValueStoreInfo>;
     drop(): Promise<void>;

package/dist/apify_key_value_store_backend.js

@@ -7,19 +7,19 @@
  * @internal
  */
 export class ApifyKeyValueStoreBackend {
-    client;
+    #client;
     constructor(client) {
-        this.client = client;
+        this.#client = client;
     }
     async getMetadata() {
-        const metadata = await this.client.get();
+        const metadata = await this.#client.get();
         if (!metadata) {
             throw new Error('Key-value store not found or has been deleted.');
         }
         return metadata;
     }
     async drop() {
-        await this.client.delete();
+        await this.#client.delete();
     }
     async purge() {
         throw new Error('Purging a key-value store is not supported on the Apify platform. ' +
@@ -28,16 +28,16 @@ export class ApifyKeyValueStoreBackend {
     async getValue(key) {
         // Storage backends are byte transports — the KeyValueStore frontend parses values
         // according to their content type, so the record must be returned unparsed.
-        return this.client.getRecord(key, { buffer: true });
+        return this.#client.getRecord(key, { buffer: true });
     }
     async setValue(record) {
-        await this.client.setRecord(record);
+        await this.#client.setRecord(record);
     }
     async deleteValue(key) {
-        await this.client.deleteRecord(key);
+        await this.#client.deleteRecord(key);
     }
     async listKeys(options) {
-        const result = await this.client.listKeys(options);
+        const result = await this.#client.listKeys(options);
         // The API does not report a content type for listed keys; crawlee's item shape
         // requires the field, so it is left undefined via the cast.
         return {
@@ -46,9 +46,9 @@ export class ApifyKeyValueStoreBackend {
         };
     }
     async getPublicUrl(key) {
-        return this.client.getRecordPublicUrl(key);
+        return this.#client.getRecordPublicUrl(key);
     }
     async recordExists(key) {
-        return this.client.recordExists(key);
+        return this.#client.recordExists(key);
     }
 }

package/dist/apify_request_queue_backend.d.ts

@@ -73,6 +73,6 @@ export declare abstract class ApifyRequestQueueBackend implements RequestQueueBa
  * @internal
  */
 export declare class AsyncLock {
-    private tail;
+    #private;
     runExclusive<T>(fn: () => Promise<T>): Promise<T>;
 }

package/dist/apify_request_queue_backend.js

@@ -104,11 +104,11 @@ export class ApifyRequestQueueBackend {
  * @internal
  */
 export class AsyncLock {
-    tail = Promise.resolve();
+    #tail = Promise.resolve();
     async runExclusive(fn) {
-        const run = this.tail.then(fn);
+        const run = this.#tail.then(fn);
         // Keep the chain alive even when the critical section throws.
-        this.tail = run.catch(() => { });
+        this.#tail = run.catch(() => { });
         return run;
     }
 }

package/dist/apify_request_queue_shared_backend.d.ts

@@ -13,20 +13,7 @@ import { ApifyRequestQueueBackend } from './apify_request_queue_backend.js';
  * @internal
  */
 export declare class ApifyRequestQueueSharedBackend extends ApifyRequestQueueBackend {
-    /** Ids of requests locked by this client and waiting to be handed out by `fetchNextRequest`. */
-    private readonly headIds;
-    /** Dedup records for requests known to exist on the platform, keyed by id. */
-    private readonly cachedRequestInfo;
-    /** Ids of requests currently being processed by this client. */
-    private readonly inProgressIds;
-    /** Whether the last head read reported any locked requests left in the queue (any client's). */
-    private queueHasLockedRequests?;
-    /** Set after a forefront insert — the next head read starts fresh so the insert is honored. */
-    private shouldCheckForefrontRequests;
-    /** Lock duration applied to fetched requests; raised via `setExpectedRequestProcessingTimeSecs`. */
-    private lockSecs;
-    /** Serializes head reads and reclaims — both reorder the shared head state. */
-    private readonly headLock;
+    #private;
     setExpectedRequestProcessingTimeSecs(secs: number): Promise<void>;
     addBatchOfRequests(requests: RequestSchema[], options?: RequestQueueOperationOptions): Promise<BatchAddRequestsResult>;
     getRequest(uniqueKey: string): Promise<UpdateRequestSchema | undefined>;