[RND-651] Ability to loosely allow overposted material for parity (#314)

Ed-Fi-Exchange-OSS · Nov 13, 2023 · 9920048 · 9920048
1 parent be106a6
commit 9920048
Show file tree

Hide file tree

Showing 8 changed files with 1,393 additions and 24 deletions.
diff --git a/Meadowlark-js/packages/meadowlark-core/src/validation/QueryStringValidator.ts b/Meadowlark-js/packages/meadowlark-core/src/validation/QueryStringValidator.ts
@@ -19,7 +19,7 @@ export type QueryStringValidationResult = {
  * Validates that those queryParameters which are present are actually fields on the API resource
  */
 export function validateQueryParameters(resourceSchema: ResourceSchema, queryParameters: FrontendQueryParameters): string[] {
-  const { queryValidator } = getSchemaValidatorsFor(resourceSchema);
+  const { queryValidator } = getSchemaValidatorsFor(resourceSchema, true);
 
   let errors: string[] = [];
 

diff --git a/Meadowlark-js/packages/meadowlark-core/src/validation/ResourceSchemaValidation.ts b/Meadowlark-js/packages/meadowlark-core/src/validation/ResourceSchemaValidation.ts
@@ -18,8 +18,9 @@ export type ResourceSchemaValidators = {
   updateValidator: ValidateFunction;
 };
 
-function initializeAjv(): Ajv {
-  const removeAdditional = false; // TODO: replace on merge with RND-651
+function initializeAjv(isQueryParameterValidator: boolean): Ajv {
+  // A query parameter validator cannot have additional properties
+  const removeAdditional = isQueryParameterValidator ? false : getBooleanFromEnvironment('ALLOW_OVERPOSTING', false);
   const coerceTypes = getBooleanFromEnvironment('ALLOW_TYPE_COERCION', false);
 
   const ajv = new Ajv({ allErrors: true, coerceTypes, removeAdditional });
@@ -34,16 +35,19 @@ let ajv: Ajv | null = null;
 // simple cache implementation, see: https://rewind.io/blog/simple-caching-in-aws-lambda-functions/
 /** This is a cache mapping ResourceSchema objects to compiled ajv JSON Schema validators for the API resource */
 const validatorCache: Map<ResourceSchema, ResourceSchemaValidators> = new Map();
+const queryValidatorCache: Map<ResourceSchema, ResourceSchemaValidators> = new Map();
 
 /**
  * Returns the API resource JSON Schema validator functions for the given ResourceSchema. Caches results.
  */
-export function getSchemaValidatorsFor(resourceSchema: ResourceSchema): ResourceSchemaValidators {
-  if (ajv == null) ajv = initializeAjv();
-
-  const cachedValidators: ResourceSchemaValidators | undefined = validatorCache.get(resourceSchema);
+export function getSchemaValidatorsFor(
+  resourceSchema: ResourceSchema,
+  isQueryParameterValidator: boolean = false,
+): ResourceSchemaValidators {
+  const validatorCacheObject = isQueryParameterValidator ? queryValidatorCache : validatorCache;
+  const cachedValidators: ResourceSchemaValidators | undefined = validatorCacheObject.get(resourceSchema);
   if (cachedValidators != null) return cachedValidators;
-
+  ajv = initializeAjv(isQueryParameterValidator);
   const resourceValidators: ResourceSchemaValidators = {
     insertValidator: ajv.compile(resourceSchema.jsonSchemaForInsert),
     queryValidator: ajv.compile(resourceSchema.jsonSchemaForQuery),
@@ -58,4 +62,5 @@ export function getSchemaValidatorsFor(resourceSchema: ResourceSchema): Resource
  */
 export function clearAllValidatorCache(): void {
   validatorCache.clear();
+  queryValidatorCache.clear();
 }
diff --git a/Meadowlark-js/packages/meadowlark-core/test/TestHelper.ts b/Meadowlark-js/packages/meadowlark-core/test/TestHelper.ts
@@ -21,3 +21,7 @@ export function apiSchemaFrom(metaEd: MetaEdEnvironment): ApiSchema {
   const pluginEnvironment = metaEd.plugin.get('edfiApiSchema') as PluginEnvironment;
   return (pluginEnvironment.data as PluginEnvironmentEdfiApiSchema).apiSchema;
 }
+
+export function restoreSpies(spies: jest.SpyInstance[]) {
+  spies.forEach((spy) => spy.mockRestore());
+}