release implementation (#109)

* release implementation * Add duplicate key release collision tests
projecttacoma · Sep 3, 2024 · 03319f5 · 03319f5
1 parent f103013
commit 03319f5
Show file tree

Hide file tree

Showing 10 changed files with 668 additions and 6 deletions.
diff --git a/service/README.md b/service/README.md
@@ -217,6 +217,14 @@ And takes the following optional parameters:
 - artifactAssessmentRelatedArtifact
 - artifactAssessmentAuthor
 
+### Release
+
+The Measure Repository Service Authoring Repository Service server supports the `Measure` and `Library` `$release` operations as defined by the [Canonical Resource Management Infrastructure IG](https://hl7.org/fhir/uv/crmi/OperationDefinition-crmi-release.html). It requires the following parameters:
+
+- id
+- version
+- [versionBehavior](https://hl7.org/fhir/uv/crmi/ValueSet-crmi-release-version-behavior.html)
+
 ## License
 
 Copyright 2022-2023 The MITRE Corporation

diff --git a/service/scripts/dbSetup.ts b/service/scripts/dbSetup.ts
@@ -217,10 +217,10 @@ function modifyEntriesForUpload(entries: fhir4.BundleEntry<fhir4.FhirResource>[]
       if (!updatedEntry.resource.id) {
         updatedEntry.resource.id = uuidv4();
       }
-      if (updatedEntry.resource.status != 'active') {
+      if (updatedEntry.resource.status != 'active' && process.env.AUTHORING === 'false') {
         updatedEntry.resource.status = 'active';
         console.warn(
-          `Resource ${updatedEntry.resource.resourceType}/${updatedEntry.resource.id} status has been coerced to 'active'.`
+          `Resource ${updatedEntry.resource.resourceType}/${updatedEntry.resource.id} status has been coerced to 'active' for Publishable environment.`
         );
       }
     }

diff --git a/service/src/config/capabilityStatementResources.json b/service/src/config/capabilityStatementResources.json
@@ -202,6 +202,16 @@
           ],
           "name": "review",
           "definition": "http://hl7.org/fhir/uv/crmi/OperationDefinition/crmi-review"
+        },
+        {
+          "extension": [
+            {
+              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
+              "valueCode": "SHALL"
+            }
+          ],
+          "name": "release",
+          "definition": "http://hl7.org/fhir/uv/crmi/OperationDefinition/crmi-release"
         }
       ]
     },
@@ -400,6 +410,16 @@
           ],
           "name": "review",
           "definition": "http://hl7.org/fhir/uv/crmi/OperationDefinition/crmi-review"
+        },
+        {
+          "extension": [
+            {
+              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
+              "valueCode": "SHALL"
+            }
+          ],
+          "name": "release",
+          "definition": "http://hl7.org/fhir/uv/crmi/OperationDefinition/crmi-release"
         }
       ]
     }

diff --git a/service/src/config/serverConfig.ts b/service/src/config/serverConfig.ts
@@ -181,6 +181,30 @@ export const serverConfig: ServerConfig = {
           route: '/:id/$review',
           method: 'POST',
           reference: 'https://hl7.org/fhir/uv/crmi/STU1/OperationDefinition-crmi-review.html'
+        },
+        {
+          name: 'release',
+          route: '/$release',
+          method: 'GET',
+          reference: 'https://hl7.org/fhir/uv/crmi/STU1/OperationDefinition-crmi-release.html'
+        },
+        {
+          name: 'release',
+          route: '/$release',
+          method: 'POST',
+          reference: 'https://hl7.org/fhir/uv/crmi/STU1/OperationDefinition-crmi-release.html'
+        },
+        {
+          name: 'release',
+          route: '/:id/$release',
+          method: 'GET',
+          reference: 'https://hl7.org/fhir/uv/crmi/STU1/OperationDefinition-crmi-release.html'
+        },
+        {
+          name: 'release',
+          route: '/:id/$release',
+          method: 'POST',
+          reference: 'https://hl7.org/fhir/uv/crmi/STU1/OperationDefinition-crmi-release.html'
         }
       ]
     },
@@ -331,6 +355,30 @@ export const serverConfig: ServerConfig = {
           route: '/:id/$review',
           method: 'POST',
           reference: 'https://hl7.org/fhir/uv/crmi/STU1/OperationDefinition-crmi-review.html'
+        },
+        {
+          name: 'release',
+          route: '/$release',
+          method: 'GET',
+          reference: 'https://hl7.org/fhir/uv/crmi/STU1/OperationDefinition-crmi-release.html'
+        },
+        {
+          name: 'release',
+          route: '/$release',
+          method: 'POST',
+          reference: 'https://hl7.org/fhir/uv/crmi/STU1/OperationDefinition-crmi-release.html'
+        },
+        {
+          name: 'release',
+          route: '/:id/$release',
+          method: 'GET',
+          reference: 'https://hl7.org/fhir/uv/crmi/STU1/OperationDefinition-crmi-release.html'
+        },
+        {
+          name: 'release',
+          route: '/:id/$release',
+          method: 'POST',
+          reference: 'https://hl7.org/fhir/uv/crmi/STU1/OperationDefinition-crmi-release.html'
         }
       ]
     }

diff --git a/service/src/requestSchemas.ts b/service/src/requestSchemas.ts
@@ -225,6 +225,14 @@ export const ReviewArgs = z
   .strict()
   .superRefine(catchInvalidParams([catchMissingId, catchMissingTypeAndSummary]));
 
+export const ReleaseArgs = z
+  .object({
+    id: z.string(),
+    releaseVersion: z.string(),
+    versionBehavior: z.union([z.literal('default'), z.literal('check'), z.literal('force')])
+  })
+  .strict();
+
 export const IdentifyingParameters = z
   .object({
     id: z.string(),

diff --git a/service/src/services/LibraryService.ts b/service/src/services/LibraryService.ts
@@ -19,7 +19,8 @@ import {
   DraftArgs,
   CloneArgs,
   ApproveArgs,
-  ReviewArgs
+  ReviewArgs,
+  ReleaseArgs
 } from '../requestSchemas';
 import { Service } from '../types/service';
 import {
@@ -413,6 +414,86 @@ export class LibraryService implements Service<CRMIShareableLibrary> {
     return createBatchResponseBundle(reviewedArtifacts);
   }
 
+  /**
+   * result of sending a POST or GET request to:
+   * {BASE_URL}/4_0_1/Library/$release or {BASE_URL}/4_0_1/Library/[id]/$release
+   * releases an artifact, updating the status of an existing draft artifact to active and
+   * setting the date element of the resource. Also sets the version and recursively releases
+   * child artifacts according to the versionBehavior parameter.
+   */
+  async release(args: RequestArgs, { req }: RequestCtx) {
+    logger.info(`${req.method} ${req.path}`);
+
+    // checks that the authoring environment variable is true
+    checkAuthoring();
+
+    if (req.method === 'POST') {
+      const contentType: string | undefined = req.headers['content-type'];
+      checkContentTypeHeader(contentType);
+    }
+
+    const params = gatherParams(req.query, args.resource);
+    validateParamIdSource(req.params.id, params.id);
+    const query = extractIdentificationForQuery(args, params);
+    const parsedParams = parseRequestSchema({ ...params, ...query }, ReleaseArgs);
+
+    const library = await findResourceById<CRMIShareableLibrary>(parsedParams.id, 'Library');
+    if (!library) {
+      throw new ResourceNotFoundError(`No resource found in collection: Library, with id: ${parsedParams.id}`);
+    }
+    if (library.status !== 'draft') {
+      throw new BadRequestError(
+        `Library with id: ${library.id} has status ${library.status}. $release may only be used on draft artifacts.`
+      );
+    }
+    checkIsOwned(library, 'Child artifacts cannot be directly released.');
+
+    library.status = 'active';
+    library.date = new Date().toISOString();
+
+    // Version behavior source: https://hl7.org/fhir/uv/crmi/1.0.0-snapshot/CodeSystem-crmi-release-version-behavior-codes.html
+    if (parsedParams.versionBehavior === 'check') {
+      logger.info('Applying check version behavior');
+      // check: if the root artifact has a specified version different from the version passed in, an error will be returned
+      // Developer note: this is assumed to be the behavior for child artifacts as well
+      if (parsedParams.releaseVersion !== library.version) {
+        throw new BadRequestError(
+          `Library with id: ${library.id} has version ${library.version}, which does not match the passed release version ${parsedParams.releaseVersion}`
+        );
+      }
+    } else if (parsedParams.versionBehavior === 'force') {
+      logger.info('Applying force version behavior');
+      // force: version provided will be applied to the root and all children, regardless of whether a version was already specified
+      library.version = parsedParams.releaseVersion;
+    } else {
+      logger.info('Applying default version behavior');
+      // default: version provided will be applied to the root artifact and all children if a version is not specified.
+      // Developer note: this is currently a null operation because version is a required field
+    }
+
+    // recursively get any child artifacts from the artifact if they exist
+    const children = library.relatedArtifact ? await getChildren(library.relatedArtifact) : [];
+    children.forEach(child => {
+      child.status = 'active';
+      child.date = new Date().toISOString();
+      if (parsedParams.versionBehavior === 'check') {
+        if (parsedParams.releaseVersion !== child.version) {
+          throw new BadRequestError(
+            `Child artifact with id: ${child.id} has version ${child.version}, which does not match the passed release version ${parsedParams.releaseVersion}`
+          );
+        }
+      } else if (parsedParams.versionBehavior === 'force') {
+        child.version = parsedParams.releaseVersion;
+      }
+    });
+
+    // batch update the released parent Library and any of its children
+    const releasedArtifacts = await batchUpdate([library, ...(await Promise.all(children))], 'release');
+
+    // return a Bundle containing the updated artifacts
+    return createBatchResponseBundle(releasedArtifacts);
+  }
+
   /**
    * result of sending a POST or GET request to:
    * {BASE_URL}/4_0_1/Library/$cqfm.package or {BASE_URL}/4_0_1/Library/:id/$cqfm.package

diff --git a/service/src/services/MeasureService.ts b/service/src/services/MeasureService.ts
@@ -41,7 +41,8 @@ import {
   DraftArgs,
   CloneArgs,
   ApproveArgs,
-  ReviewArgs
+  ReviewArgs,
+  ReleaseArgs
 } from '../requestSchemas';
 import { v4 as uuidv4 } from 'uuid';
 import { Filter } from 'mongodb';
@@ -415,6 +416,86 @@ export class MeasureService implements Service<CRMIShareableMeasure> {
     return createBatchResponseBundle(reviewedArtifacts);
   }
 
+  /**
+   * result of sending a POST or GET request to:
+   * {BASE_URL}/4_0_1/Measure/$release or {BASE_URL}/4_0_1/Measure/[id]/$release
+   * releases an artifact, updating the status of an existing draft artifact to active and
+   * setting the date element of the resource. Also sets the version and recursively releases
+   * child artifacts according to the versionBehavior parameter.
+   */
+  async release(args: RequestArgs, { req }: RequestCtx) {
+    logger.info(`${req.method} ${req.path}`);
+
+    // checks that the authoring environment variable is true
+    checkAuthoring();
+
+    if (req.method === 'POST') {
+      const contentType: string | undefined = req.headers['content-type'];
+      checkContentTypeHeader(contentType);
+    }
+
+    const params = gatherParams(req.query, args.resource);
+    validateParamIdSource(req.params.id, params.id);
+    const query = extractIdentificationForQuery(args, params);
+    const parsedParams = parseRequestSchema({ ...params, ...query }, ReleaseArgs);
+
+    const measure = await findResourceById<CRMIShareableMeasure>(parsedParams.id, 'Measure');
+    if (!measure) {
+      throw new ResourceNotFoundError(`No resource found in collection: Measure, with id: ${parsedParams.id}`);
+    }
+    if (measure.status !== 'draft') {
+      throw new BadRequestError(
+        `Measure with id: ${measure.id} has status ${measure.status}. $release may only be used on draft artifacts.`
+      );
+    }
+    checkIsOwned(measure, 'Child artifacts cannot be directly released.');
+
+    measure.status = 'active';
+    measure.date = new Date().toISOString();
+
+    // Version behavior source: https://hl7.org/fhir/uv/crmi/1.0.0-snapshot/CodeSystem-crmi-release-version-behavior-codes.html
+    if (parsedParams.versionBehavior === 'check') {
+      logger.info('Applying check version behavior');
+      // check: if the root artifact has a specified version different from the version passed in, an error will be returned
+      // Developer note: this is assumed to be the behavior for child artifacts as well
+      if (parsedParams.releaseVersion !== measure.version) {
+        throw new BadRequestError(
+          `Measure with id: ${measure.id} has version ${measure.version}, which does not match the passed release version ${parsedParams.releaseVersion}`
+        );
+      }
+    } else if (parsedParams.versionBehavior === 'force') {
+      logger.info('Applying force version behavior');
+      // force: version provided will be applied to the root and all children, regardless of whether a version was already specified
+      measure.version = parsedParams.releaseVersion;
+    } else {
+      logger.info('Applying default version behavior');
+      // default: version provided will be applied to the root artifact and all children if a version is not specified.
+      // Developer note: this is currently a null operation because version is a required field
+    }
+
+    // recursively get any child artifacts from the artifact if they exist
+    const children = measure.relatedArtifact ? await getChildren(measure.relatedArtifact) : [];
+    children.forEach(child => {
+      child.status = 'active';
+      child.date = new Date().toISOString();
+      if (parsedParams.versionBehavior === 'check') {
+        if (parsedParams.releaseVersion !== child.version) {
+          throw new BadRequestError(
+            `Child artifact with id: ${child.id} has version ${child.version}, which does not match the passed release version ${parsedParams.releaseVersion}`
+          );
+        }
+      } else if (parsedParams.versionBehavior === 'force') {
+        child.version = parsedParams.releaseVersion;
+      }
+    });
+
+    // batch update the released parent Measure and any of its children
+    const releasedArtifacts = await batchUpdate([measure, ...(await Promise.all(children))], 'release');
+
+    // return a Bundle containing the updated artifacts
+    return createBatchResponseBundle(releasedArtifacts);
+  }
+
   /**
    * result of sending a POST or GET request to:
    * {BASE_URL}/4_0_1/Measure/$cqfm.package or {BASE_URL}/4_0_1/Measure/:id/$cqfm.package