refactor: set storage object on dataset open (#3116)

Following up on [this recent
update](#2837) where we started
storing the full storageObject when opening a key-value store, this PR
applies the same logic when opening a dataset.

This change prepares the ground for adding a new method:
Dataset.createItemsPublicUrl, which will need access to the dataset's
urlSigningSecretKey.

Author: danpoletaev

packages/core/src/storages/dataset.ts

@@ -232,6 +232,7 @@ export class Dataset<Data extends Dictionary = Dictionary> {
     id: string;
     name?: string;
     client: DatasetClient<Data>;
+    readonly storageObject?: Record<string, unknown>;
     log: Log = log.child({ prefix: 'Dataset' });
 
     /**
@@ -244,6 +245,7 @@ export class Dataset<Data extends Dictionary = Dictionary> {
         this.id = options.id;
         this.name = options.name;
         this.client = options.client.dataset(this.id) as DatasetClient<Data>;
+        this.storageObject = options.storageObject;
     }
 
     /**
@@ -733,6 +735,7 @@ export interface DatasetOptions {
     id: string;
     name?: string;
     client: StorageClient;
+    storageObject?: Record<string, unknown>;
 }
 
 export interface DatasetContent<Data> {

test/e2e/kv-open-return-storage-object/test.mjs

@@ -1,4 +1,4 @@
-import { Actor, KeyValueStore } from 'apify';
+import { Actor, KeyValueStore, Dataset } from 'apify';
 
 const mainOptions = {
     exit: Actor.isAtHome(),
@@ -10,5 +10,9 @@ const mainOptions = {
 
 await Actor.main(async () => {
     const kv = await KeyValueStore.open();
-    await kv.setValue('storageObject', { storeObject: kv.storageObject });
+    const dataset = await Dataset.open();
+    await kv.setValue('storageObject', {
+        keyValueStorageObject: kv.storageObject,
+        datasetStorageObject: dataset.storageObject,
+    });
 }, mainOptions);

…n-storage-object/actor/.actor/actor.json …n-storage-object/actor/.actor/actor.jsontest/e2e/kv-open-return-storage-object/actor/.actor/actor.json renamed to test/e2e/storage-open-return-storage-object/actor/.actor/actor.json test/e2e/kv-open-return-storage-object/actor/.actor/actor.json renamed to test/e2e/storage-open-return-storage-object/actor/.actor/actor.json

@@ -0,0 +1,33 @@
+import { initialize, expect, getActorTestDir, runActor } from '../tools.mjs';
+
+/* This test verifies that the storageObject is correctly returned when the KeyValueStore or Dataset is opened.
+ * The storageObject is the result of the KeyValueStoreClient.get() or Dataset.get() methods,
+ * containing properties such as name, id, and other custom attributes.
+ */
+
+const testActorDirname = getActorTestDir(import.meta.url);
+await initialize(testActorDirname);
+
+const { defaultKeyValueStoreItems: items } = await runActor(testActorDirname);
+
+await expect(items !== undefined, 'Key value store exists');
+
+const item = items.find((kvItem) => kvItem.name === 'storageObject');
+
+const parsed = JSON.parse(item.raw.toString());
+
+await expect(
+    typeof parsed === 'object' && parsed !== null,
+    'Key-value contains key "storageObject" and it\'s value is a non-nullable object',
+);
+
+const datasetStorageObject = parsed.datasetStorageObject;
+const keyValueStorageObject = parsed.keyValueStorageObject;
+
+await expect(datasetStorageObject.id !== null, 'datasetStorageObject contains id');
+await expect(datasetStorageObject.name !== null, 'datasetStorageObject contains name');
+await expect(datasetStorageObject.userId !== null, 'datasetStorageObject contains userId');
+
+await expect(keyValueStorageObject.id !== null, 'keyValueStorageObject contains id');
+await expect(keyValueStorageObject.name !== null, 'keyValueStorageObject contains name');
+await expect(keyValueStorageObject.userId !== null, 'keyValueStorageObject contains userId');