Merge pull request #2896 from OpenNeuroOrg/feat/api-schema-validator-…

…output feat(api): Return schema validator output for derivative datasets
OpenNeuroOrg · Sep 15, 2023 · cd5629d · cd5629d
2 parents ccf41c3 + 3f11459
commit cd5629d
Show file tree

Hide file tree

Showing 4 changed files with 35 additions and 4 deletions.
diff --git a/packages/openneuro-server/src/graphql/resolvers/datasetType.ts b/packages/openneuro-server/src/graphql/resolvers/datasetType.ts
@@ -0,0 +1,6 @@
+import { description } from './description.js'
+
+export async function datasetType(dsOrSnapshot): Promise<'schema' | 'legacy'> {
+  const dsDescription = await description(dsOrSnapshot)
+  return dsDescription.DatasetType === 'derivative' ? 'schema' : 'legacy'
+}
diff --git a/packages/openneuro-server/src/graphql/resolvers/issues.js b/packages/openneuro-server/src/graphql/resolvers/issues.js
@@ -1,13 +1,19 @@
 import Issue from '../../models/issue'
+import { datasetType } from './datasetType'
 import { revalidate } from './validation.js'
 
 /**
  * Issues resolver
  */
-export const issues = (dataset, _, { userInfo }) => {
+export const issues = async (dataset, _, { userInfo }) => {
   return Issue.findOne({
     id: dataset.revision,
     datasetId: dataset.id,
+    // Match if we have no validatorMetadata or the correct 'legacy' / 'schema' value if we do
+    $or: [
+      { 'validatorMetadata.validator': await datasetType(dataset) },
+      { validatorMetadata: { $exists: false } },
+    ],
   })
     .exec()
     .then(data => {
@@ -26,11 +32,16 @@ export const issues = (dataset, _, { userInfo }) => {
 /**
  * Snapshot issues resolver
  */
-export const snapshotIssues = snapshot => {
+export const snapshotIssues = async snapshot => {
   const datasetId = snapshot.id.split(':')[0]
   return Issue.findOne({
     id: snapshot.hexsha,
     datasetId,
+    // Match if we have no validatorMetadata or the correct 'legacy' / 'schema' value if we do
+    $or: [
+      { 'validatorMetadata.validator': await datasetType(snapshot) },
+      { validatorMetadata: { $exists: false } },
+    ],
   })
     .exec()
     .then(data => (data ? data.issues : null))

diff --git a/packages/openneuro-server/src/graphql/resolvers/summary.ts b/packages/openneuro-server/src/graphql/resolvers/summary.ts
@@ -1,4 +1,5 @@
 import Summary, { SummaryDocument } from '../../models/summary'
+import { datasetType } from './datasetType'
 
 /**
  * Summary resolver
@@ -8,6 +9,11 @@ export async function summary(dataset): Promise<Partial<SummaryDocument>> {
     await Summary.findOne({
       id: dataset.revision,
       datasetId: dataset.id,
+      // Match if we have no validatorMetadata or the correct 'legacy' / 'schema' value if we do
+      $or: [
+        { 'validatorMetadata.validator': await datasetType(dataset) },
+        { validatorMetadata: { $exists: false } },
+      ],
     }).exec()
   )?.toObject()
   if (datasetSummary) {
@@ -27,7 +33,11 @@ export async function summary(dataset): Promise<Partial<SummaryDocument>> {
  */
 export const updateSummary = (obj, args) => {
   return Summary.updateOne(
-    { id: args.summary.id, datasetId: args.summary.datasetId },
+    {
+      id: args.summary.id,
+      datasetId: args.summary.datasetId,
+      validatorMetadata: args.summary.validatorMetadata,
+    },
     args.summary,
     {
       upsert: true,

diff --git a/packages/openneuro-server/src/graphql/resolvers/validation.js b/packages/openneuro-server/src/graphql/resolvers/validation.js
@@ -12,7 +12,11 @@ import { redlock } from '../../libs/redis.js'
  */
 export const updateValidation = (obj, args) => {
   return Issue.updateOne(
-    { id: args.validation.id, datasetId: args.validation.datasetId },
+    {
+      id: args.validation.id,
+      datasetId: args.validation.datasetId,
+      validatorMetadata: args.validation.validatorMetadata,
+    },
     args.validation,
     {
       upsert: true,