Remove idenitfier/data wrapper, take 2

modules/metastore/metastore.services.yml

@@ -39,6 +39,7 @@ services:
     arguments:
       - '@config.factory'
       - '@dkan.metastore.storage'
+      - '@dkan.metastore.service'
     calls:
       - [setLoggerFactory, ['@logger.factory']]
 
@@ -63,7 +64,7 @@ services:
     class: \Drupal\metastore\ValidMetadataFactory
     arguments:
       - '@dkan.metastore.schema_retriever'
-  
+
   dkan.metastore.metastore_item_factory:
     class: \Drupal\metastore\NodeWrapper\NodeDataFactory
     arguments:

modules/metastore/modules/metastore_admin/metastore_admin.module

@@ -49,35 +49,31 @@ function metastore_admin_preprocess_views_view_field(&$vars) {
     $entity_id = $entity->id();
 
     // Modify data titles to display the metadata title values rather than uuids.
-    $data = json_decode($entity->field_json_metadata->value);
-    $title = (array) $data;
+    $data = json_decode($entity->field_json_metadata->value, TRUE);
 
     if ($vars['field']->field == 'title') {
       switch ($entity->field_data_type->value) {
         case 'keyword':
         case 'theme':
           $vars['output'] = [
             '#markup' => Markup::create(
-              metastore_admin_create_text_link($title['data'], 'internal:/node/' . $entity_id)
+              metastore_admin_create_text_link($data, 'internal:/node/' . $entity_id)
             ),
           ];
           break;
 
         case 'publisher':
-          $name = (array) $title['data'];
-
           $vars['output'] = [
             '#markup' => Markup::create(
-              metastore_admin_create_text_link($name['name'], 'internal:/node/' . $entity_id)
+              metastore_admin_create_text_link($data['name'], 'internal:/node/' . $entity_id)
             ),
           ];
           break;
 
         case 'distribution':
-          $dist = (array) $title['data'];
-          $mediatype = isset($dist['mediaType']) ? $entity_id . ' ' . $dist['mediaType'] : '';
-          $format = isset($dist['format']) ? $entity_id . ' ' . $dist['format'] : $mediatype;
-          $title = $dist['title'] ?? $format;
+          $mediatype = isset($data['mediaType']) ? $entity_id . ' ' . $data['mediaType'] : '';
+          $format = isset($data['format']) ? $entity_id . ' ' . $data['format'] : $mediatype;
+          $title = $data['title'] ?? $format;
 
           $vars['output'] = [
             '#markup' => Markup::create(

modules/metastore/src/LifeCycle/LifeCycle.php

@@ -129,11 +129,11 @@ protected function datasetUpdate(MetastoreItemInterface $data) {
   protected function distributionLoad(MetastoreItemInterface $data) {
     $metadata = $data->getMetaData();
 
-    if (!isset($metadata->data->downloadURL)) {
+    if (!isset($metadata->downloadURL)) {
       return;
     }
 
-    $downloadUrl = $metadata->data->downloadURL;
+    $downloadUrl = $metadata->downloadURL;
 
     if (isset($downloadUrl) && !filter_var($downloadUrl, FILTER_VALIDATE_URL)) {
       $resourceIdentifier = $downloadUrl;
@@ -144,14 +144,14 @@ protected function distributionLoad(MetastoreItemInterface $data) {
       $downloadUrl = isset($original) ? $original : "";
 
       $refProperty = "%Ref:downloadURL";
-      $metadata->data->{$refProperty} = count($ref) == 0 ? NULL : $ref;
+      $metadata->{$refProperty} = count($ref) == 0 ? NULL : $ref;
     }
 
     if (is_string($downloadUrl)) {
       $downloadUrl = UrlHostTokenResolver::resolve($downloadUrl);
     }
 
-    $metadata->data->downloadURL = $downloadUrl;
+    $metadata->downloadURL = $downloadUrl;
 
     $data->setMetadata($metadata);
   }

modules/metastore/src/NodeWrapper/Data.php

@@ -6,6 +6,7 @@
 use Drupal\common\LoggerTrait;
 use Drupal\Core\Entity\EntityInterface;
 use Drupal\metastore\MetastoreItemInterface;
+use Drupal\metastore\Storage\Data as Storage;
 use Drupal\node\Entity\Node;
 
 /**
@@ -74,7 +75,10 @@ public function getDataType() {
    */
   public function getMetaData() {
     $this->fix();
-    return json_decode($this->node->get('field_json_metadata')->getString());
+    $metadata = $this->node->get('field_json_metadata')->getString();
+    // Legacy metadata could come unwrapped from the db.
+    $metadata = Storage::unwrapMetadata($metadata);
+    return json_decode($metadata);
   }
 
   /**

modules/metastore/src/Reference/Dereferencer.php

@@ -5,6 +5,7 @@
 use Contracts\FactoryInterface;
 use Drupal\Core\Config\ConfigFactoryInterface;
 use Drupal\common\LoggerTrait;
+use Drupal\metastore\Service;
 
 /**
  * Metastore dereferencer.
@@ -20,12 +21,24 @@ class Dereferencer {
    */
   private $storageFactory;
 
+  /**
+   * Metastore service.
+   *
+   * @var \Drupal\metastore\Service
+   */
+  private $service;
+
   /**
    * Constructor.
    */
-  public function __construct(ConfigFactoryInterface $configService, FactoryInterface $storageFactory) {
+  public function __construct(
+    ConfigFactoryInterface $configService,
+    FactoryInterface $storageFactory,
+    Service $service
+  ) {
     $this->setConfigService($configService);
     $this->storageFactory = $storageFactory;
+    $this->service = $service;
   }
 
   /**
@@ -48,8 +61,8 @@ public function dereference($data) {
       if (isset($data->{$propertyId})) {
         $referenceProperty = "%Ref:{$propertyId}";
         [$ref, $actual] = $this->dereferenceProperty($propertyId, $data->{$propertyId});
-        $data->{$referenceProperty} = $ref;
-        $data->{$propertyId} = $actual;
+        $data->{$referenceProperty} = is_array($ref) ? array_map('json_decode', $ref) : json_decode($ref);
+        $data->{$propertyId} = is_array($actual) ? array_map('json_decode', $actual) : json_decode($actual);
       }
     }
     return $data;
@@ -128,8 +141,9 @@ private function dereferenceSingle(string $property_id, string $uuid) {
     $value = $storage->retrieve($uuid);
 
     if ($value) {
-      $metadata = json_decode($value);
-      return [$metadata, $metadata->data];
+      $metadata = $this->service->getValidMetadataFactory()->get($property_id, $value);
+      $wrapped_metadata = $this->service->wrapMetadata($uuid, $metadata);
+      return [$wrapped_metadata, $metadata];
     }
     // If a property node was not found, it most likely means it was deleted
     // while still being referenced.

modules/metastore/src/Reference/Referencer.php

@@ -304,16 +304,14 @@ private function checkExistingReference(string $property_id, $data) {
    * @throws \Drupal\Core\Entity\EntityStorageException
    */
   private function createPropertyReference(string $property_id, $value) {
-    // Create json metadata for the reference.
-    $data = new \stdClass();
-    $data->identifier = $this->getUuidService()->generate($property_id, $value);
-    $data->data = $value;
-    $json = json_encode($data);
+    $json = json_encode($value);
+    $identifier = $this->getUuidService()->generate($property_id, $value);
 
     // Create node to store this reference.
     $storage = $this->storageFactory->getInstance($property_id);
-    $entity_uuid = $storage->store($json, $data->identifier);
+    $entity_uuid = $storage->store($json, $identifier);
     return $entity_uuid;
+
   }
 
 }

modules/metastore/src/SchemaRetriever.php

@@ -54,6 +54,7 @@ public function getAllIds() {
       'theme.ui',
       'keyword',
       'keyword.ui',
+      'legacy',
     ];
   }
 

modules/metastore/src/Service.php

@@ -73,17 +73,6 @@ public function __construct(SchemaRetriever $schemaRetriever, DataFactory $facto
     $this->validMetadataFactory = $validMetadataFactory;
   }
 
-  /**
-   * Setter to discover data modifier plugins.
-   *
-   * @param \Drupal\common\Plugin\DataModifierManager $pluginManager
-   *   Injected plugin manager.
-   */
-  public function setDataModifierPlugins(DataModifierManager $pluginManager) {
-    $this->pluginManager = $pluginManager;
-    $this->plugins = $this->discover();
-  }
-
   /**
    * Get schemas.
    */
@@ -134,20 +123,21 @@ private function getStorage(string $schema_id): StorerInterface {
   public function getAll($schema_id): array {
     $jsonStringsArray = $this->getStorage($schema_id)->retrieveAll();
 
-    $objects = array_map(
-      function ($jsonString) use ($schema_id) {
-        $data = $this->validMetadataFactory->get($schema_id, $jsonString);
-        try {
-          return $this->dispatchEvent(self::EVENT_DATA_GET, $data, function ($data) {
-            return $data instanceof RootedJsonData;
-          });
+    $objects = [];
+    foreach ($jsonStringsArray as $id => $jsonString) {
+      $data = $this->validMetadataFactory->get($schema_id, $jsonString);
+      try {
+        $object = $this->dispatchEvent(self::EVENT_DATA_GET, $data);
+        if ($schema_id != 'dataset') {
+          $object = $this->wrapMetadata($id, $object);
         }
-        catch (\Exception $e) {
-          return new RootedJsonData(json_encode(["message" => $e->getMessage()]));
-        }
-      },
-      $jsonStringsArray
-    );
+      }
+      catch (\Exception $e) {
+        $object = $this->validMetadataFactory->get(NULL, json_encode(["message" => $e->getMessage()]));
+      }
+
+      $objects[] = $object;
+    }
 
     return $this->dispatchEvent(self::EVENT_DATA_GET_ALL, $objects, function ($data) {
       if (!is_array($data)) {
@@ -175,8 +165,10 @@ function ($jsonString) use ($schema_id) {
   public function get($schema_id, $identifier): RootedJsonData {
     $json_string = $this->getStorage($schema_id)->retrievePublished($identifier);
     $data = $this->validMetadataFactory->get($schema_id, $json_string);
-
     $data = $this->dispatchEvent(self::EVENT_DATA_GET, $data);
+    if ($schema_id != 'dataset') {
+      $data = $this->wrapMetadata($identifier, $data);
+    }
     return $data;
   }
 
@@ -367,7 +359,7 @@ public function delete($schema_id, $identifier) {
    */
   public function getCatalog() {
     $catalog = $this->getSchema('catalog');
-    $catalog->dataset = $this->getAll('dataset');
+    $catalog->dataset = array_values($this->getAll('dataset'));
 
     return $catalog;
   }
@@ -429,4 +421,16 @@ public static function removeReferences(RootedJsonData $object, $prefix = "%"):
     return $object;
   }
 
+  /**
+   * Wraps metadata with [{"data":{},"identifier":""}].
+   */
+  public function wrapMetadata($uuid, RootedJsonData $metadata): RootedJsonData {
+    $wrapped_metadata = [
+      'identifier' => $uuid,
+      'data' => $metadata->get('$'),
+    ];
+
+    return $this->getValidMetadataFactory()->get('legacy', json_encode($wrapped_metadata));
+  }
+
 }

modules/metastore/src/Storage/Data.php

@@ -100,9 +100,12 @@ public function retrieveAll(): array {
     $all = [];
     foreach ($entity_ids as $nid) {
       $entity = $this->entityStorage->load($nid);
-      if ($entity->get('moderation_state')->getString() === 'published') {
-        $all[] = $entity->get('field_json_metadata')->getString();
+      if ($entity->get('moderation_state')->getString() !== 'published') {
+        continue;
       }
+      $metadata = $entity->get('field_json_metadata')->getString();
+      // Legacy metadata could come unwrapped from the db.
+      $all[$entity->uuid()] = self::unwrapMetadata($metadata);
     }
     return $all;
   }
@@ -116,7 +119,9 @@ public function retrievePublished(string $uuid) : ?string {
     $entity = $this->getEntityPublishedRevision($uuid);
 
     if ($entity && $entity->get('moderation_state')->getString() == 'published') {
-      return $entity->get('field_json_metadata')->getString();
+      $metadata = $entity->get('field_json_metadata')->getString();
+      // Legacy metadata could come unwrapped from the db.
+      return self::unwrapMetadata($metadata);
     }
 
     throw new \Exception("Error retrieving published dataset: {$uuid} not found.");
@@ -136,11 +141,13 @@ public function retrieve(string $uuid) : ?string {
       $entity = $this->getEntityLatestRevision($uuid);
     }
 
-    if ($entity) {
-      return $entity->get('field_json_metadata')->getString();
+    if (!$entity) {
+      throw new \Exception("Error retrieving dataset: {$uuid} not found.");
     }
 
-    throw new \Exception("Error retrieving dataset: {$uuid} not found.");
+    $metadata = $entity->get('field_json_metadata')->getString();
+    // Legacy metadata could come unwrapped from the db.
+    return self::unwrapMetadata($metadata);
   }
 
   /**
@@ -291,7 +298,7 @@ private function createNewEntity($uuid, $data) {
       $title = isset($data->title) ? $data->title : $data->name;
     }
     else {
-      $title = md5(json_encode($data->data));
+      $title = md5(json_encode($data));
     }
     $entity = $this->entityStorage
       ->create(
@@ -380,4 +387,21 @@ public function getDefaultModerationState() {
       ->getConfiguration()['default_moderation_state'];
   }
 
+  /**
+   * Unwraps metadata.
+   *
+   * @param string $jsonString
+   *   Metadata.
+   *
+   * @return string
+   *   Unwrapped metadata.
+   */
+  public static function unwrapMetadata(string $jsonString) {
+    $metadata = json_decode($jsonString, TRUE);
+    if (is_array($metadata) && count($metadata) == 2 && isset($metadata['identifier']) && isset($metadata['data'])) {
+      return json_encode($metadata['data']);
+    }
+    return $jsonString;
+  }
+
 }

modules/metastore/tests/src/SchemaRetrieverTest.php

@@ -59,6 +59,7 @@ public function testGetAllIds() {
       'theme.ui',
       'keyword',
       'keyword.ui',
+      'legacy'
     ];
     $this->assertEquals($expected, $ids);
   }