[RND-84] validate equality constraints (#279)

* [RND-84] validate equality constraints

* [RND-84] e2e tests

* [RND-86] all tests in

* [RND-84] PR suggestions

---------

Co-authored-by: Stephen Fuqua <[email protected]>

Author: bradbanister

Meadowlark-js/backends/meadowlark-elasticsearch-backend/package.json

@@ -21,7 +21,6 @@
   "dependencies": {
     "@edfi/meadowlark-core": "^v0.3.6-pre-36",
     "@edfi/meadowlark-utilities": "^v0.3.6-pre-36",
-    "@edfi/metaed-core": "^4.1.2-dev.20",
     "@elastic/elasticsearch": "^8.8.1",
     "@elastic/transport": "^8.3.2"
   },

Meadowlark-js/backends/meadowlark-elasticsearch-backend/src/repository/QueryElasticsearch.ts

@@ -6,7 +6,6 @@
 import { Client } from '@elastic/elasticsearch';
 import { QueryRequest, QueryResult, ResourceInfo } from '@edfi/meadowlark-core';
 import { isDebugEnabled, Logger } from '@edfi/meadowlark-utilities';
-import { normalizeDescriptorSuffix } from '@edfi/metaed-core';
 import { handleElasticSearchError } from './ElasticSearchException';
 
 const moduleName = 'elasticsearch.repository.QueryElasticsearch';
@@ -15,11 +14,7 @@ const moduleName = 'elasticsearch.repository.QueryElasticsearch';
  * Returns ElasticSearch index name from the given ResourceInfo.
  */
 export function indexFromResourceInfo(resourceInfo: ResourceInfo): string {
-  const adjustedResourceName = resourceInfo.isDescriptor
-    ? normalizeDescriptorSuffix(resourceInfo.resourceName)
-    : resourceInfo.resourceName;
-
-  return `${resourceInfo.projectName}$${resourceInfo.resourceVersion}$${adjustedResourceName}`
+  return `${resourceInfo.projectName}$${resourceInfo.resourceVersion}$${resourceInfo.resourceName}`
     .toLowerCase()
     .replace(/\./g, '-');
 }

Meadowlark-js/backends/meadowlark-opensearch-backend/package.json

@@ -21,7 +21,6 @@
   "dependencies": {
     "@edfi/meadowlark-core": "^v0.3.6-pre-36",
     "@edfi/meadowlark-utilities": "^v0.3.6-pre-36",
-    "@edfi/metaed-core": "^4.1.2-dev.20",
     "@opensearch-project/opensearch": "^2.2.1"
   },
   "devDependencies": {

Meadowlark-js/backends/meadowlark-opensearch-backend/src/repository/QueryOpensearch.ts

@@ -6,7 +6,6 @@
 import { Client } from '@opensearch-project/opensearch';
 import { QueryRequest, QueryResult, ResourceInfo } from '@edfi/meadowlark-core';
 import { isDebugEnabled, Logger } from '@edfi/meadowlark-utilities';
-import { normalizeDescriptorSuffix } from '@edfi/metaed-core';
 import { handleOpenSearchError } from './OpenSearchException';
 
 const moduleName = 'opensearch.repository.QueryOpensearch';
@@ -17,11 +16,7 @@ const moduleName = 'opensearch.repository.QueryOpensearch';
  * OpenSearch indexes are required to be lowercase only, with no pound signs or periods.
  */
 export function indexFromResourceInfo(resourceInfo: ResourceInfo): string {
-  const adjustedResourceName = resourceInfo.isDescriptor
-    ? normalizeDescriptorSuffix(resourceInfo.resourceName)
-    : resourceInfo.resourceName;
-
-  return `${resourceInfo.projectName}$${resourceInfo.resourceVersion}$${adjustedResourceName}`
+  return `${resourceInfo.projectName}$${resourceInfo.resourceVersion}$${resourceInfo.resourceName}`
     .toLowerCase()
     .replace(/\./g, '-');
 }

Meadowlark-js/package-lock.json

@@ -43,7 +43,7 @@
   "scripts": {
     "build": "lerna run build --stream",
     "build:clean": "lerna run build:clean --stream",
-    "test": "npm run test:lint && npm run test:unit && npm run test:integration && npm run test:e2e",
+    "test": "npm run test:lint && npm run test:unit && npm run test:integration",
     "test:lint": "npm run test:lint:ts && npm run test:lint:eslint",
     "test:lint:eslint": "eslint --max-warnings 0 --ext .js,.ts .",
     "test:lint:ts": "tsc -p . --noEmit",

Meadowlark-js/package.json

@@ -17,9 +17,9 @@
     "@edfi/ed-fi-model-3.1": "3.0.1",
     "@edfi/ed-fi-model-3.3b": "3.0.1",
     "@edfi/meadowlark-utilities": "^v0.3.6-pre-36",
-    "@edfi/metaed-core": "^4.1.2-dev.20",
-    "@edfi/metaed-plugin-edfi-api-schema": "^4.1.2-dev.20",
-    "@edfi/metaed-plugin-edfi-unified": "^4.1.2-dev.20",
+    "@edfi/metaed-core": "^4.2.2-dev.2",
+    "@edfi/metaed-plugin-edfi-api-schema": "^4.2.2-dev.2",
+    "@edfi/metaed-plugin-edfi-unified": "^4.2.2-dev.2",
     "@isaacs/ttlcache": "^1.4.1",
     "ajv": "^8.12.0",
     "ajv-formats": "^2.1.1",
@@ -31,6 +31,7 @@
     "fast-memoize": "^2.5.2",
     "fs-extra": "^10.1.0",
     "inquirer": "^9.1.5",
+    "jsonpath-plus": "^7.2.0",
     "njwt": "^1.2.0",
     "ramda": "0.27.2",
     "secure-random": "^1.1.2",

Meadowlark-js/packages/meadowlark-core/package.json

@@ -14,7 +14,7 @@ import {
 import { DocumentReference } from '../model/DocumentReference';
 
 // TODO: The behavior of calculating the body names of descriptors for an entity can be pushed into a
-// new MetaEd enhancer, and entity.data.edfiApiSchema.apiMapping.descriptorCollectedProperties
+// new MetaEd enhancer, and entity.data.edfiApiSchema.apiMapping.descriptorCollectedApiProperties
 // can be replaced with an array structure with the resolved name, isCollection flag, metaEdType and metaEdName,
 // named something like entity.data.edfiApiSchema.apiMapping.descriptorPropertyBodyNames
 
@@ -83,9 +83,9 @@ function extractDescriptorValuesFromBody(
  */
 export function extractDescriptorValues(entity: TopLevelEntity, body: object): DocumentReference[] {
   const result: DocumentReference[] = [];
-  const { descriptorCollectedProperties } = (entity.data.edfiApiSchema as EntityApiSchemaData).apiMapping;
+  const { descriptorCollectedApiProperties } = (entity.data.edfiApiSchema as EntityApiSchemaData).apiMapping;
 
-  descriptorCollectedProperties.forEach((collectedProperty: CollectedProperty) => {
+  descriptorCollectedApiProperties.forEach((collectedProperty: CollectedProperty) => {
     const topLevelName = topLevelApiNameOnEntity(entity, collectedProperty.property);
     result.push(...extractDescriptorValuesFromBody(collectedProperty, body, topLevelName));
   });

Meadowlark-js/packages/meadowlark-core/src/extraction/DescriptorValueExtractor.ts

@@ -24,6 +24,7 @@ import { documentInfoExtraction } from '../middleware/ExtractDocumentInfoMiddlew
 import { metaEdModelFinding } from '../middleware/FindMetaEdModelMiddleware';
 import { logRequestBody } from '../middleware/RequestLoggingMiddleware';
 import { logTheResponse } from '../middleware/ResponseLoggingMiddleware';
+import { equalityConstraintValidation } from '../middleware/ValidateEqualityConstraintMiddleware';
 
 type MiddlewareStack = (model: MiddlewareModel) => Promise<MiddlewareModel>;
 
@@ -48,6 +49,7 @@ function postStack(): MiddlewareStack {
       R.andThen(resourceValidation),
       R.andThen(metaEdModelFinding),
       R.andThen(documentValidation),
+      R.andThen(equalityConstraintValidation),
       R.andThen(documentInfoExtraction),
       R.andThen(getDocumentStore().securityMiddleware),
       R.andThen(logTheResponse),
@@ -66,6 +68,7 @@ function putStack(): MiddlewareStack {
       R.andThen(resourceValidation),
       R.andThen(metaEdModelFinding),
       R.andThen(documentUpdateValidation),
+      R.andThen(equalityConstraintValidation),
       R.andThen(documentInfoExtraction),
       R.andThen(getDocumentStore().securityMiddleware),
       R.andThen(logTheResponse),

Meadowlark-js/packages/meadowlark-core/src/handler/FrontendFacade.ts

@@ -11,9 +11,9 @@ import didYouMean from 'didyoumean2';
 import memoize from 'fast-memoize';
 import { MetaEdEnvironment, TopLevelEntity, NoTopLevelEntity } from '@edfi/metaed-core';
 import { getBooleanFromEnvironment } from '@edfi/meadowlark-utilities';
-import { ResourceMatchResult } from '../model/ResourceMatchResult';
+import type { ResourceMatchResult } from '../model/ResourceMatchResult';
 import { getMetaEdModelForResourceName, getResourceNamesForProject } from './ResourceNameMapping';
-import { FrontendQueryParameters } from '../handler/FrontendRequest';
+import type { FrontendQueryParameters } from '../handler/FrontendRequest';
 
 function getAjv(): Ajv {
   const coerceTypes = getBooleanFromEnvironment('ALLOW_TYPE_COERCION', false);