Move validateObject to kbn-std package and add a description

elastic · Dec 18, 2020 · 0555f02 · 0555f02
1 parent 82cff88
commit 0555f02
Show file tree

Hide file tree

Showing 10 changed files with 4 additions and 25 deletions.
diff --git a/docs/development/core/server/kibana-plugin-core-server.validateobject.md b/docs/development/core/server/kibana-plugin-core-server.validateobject.md
@@ -14,7 +14,7 @@ export declare function validateObject(obj: any): void;
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  obj | <code>any</code> |  |
+|  obj | <code>any</code> | Is used to validate object properties for containing constructor and prototype with detecting circular references
 
 <b>Returns:</b>
 

diff --git a/..._snapshots__/validate_object.test.ts.snap → ..._snapshots__/validate_object.test.ts.snap b/..._snapshots__/validate_object.test.ts.snap → ..._snapshots__/validate_object.test.ts.snap
diff --git a/packages/kbn-std/src/index.ts b/packages/kbn-std/src/index.ts
@@ -27,4 +27,5 @@ export { withTimeout } from './promise';
 export { isRelativeUrl, modifyUrl, getUrlOrigin, URLMeaningfulParts } from './url';
 export { unset } from './unset';
 export { getFlattenedObject } from './get_flattened_object';
+export { validateObject } from './validate_object';
 export * from './rxjs_7';
diff --git a/...ototype_pollution/validate_object.test.ts → packages/kbn-std/src/validate_object.test.ts b/...ototype_pollution/validate_object.test.ts → packages/kbn-std/src/validate_object.test.ts
diff --git a/...tp/prototype_pollution/validate_object.ts → packages/kbn-std/src/validate_object.ts b/...tp/prototype_pollution/validate_object.ts → packages/kbn-std/src/validate_object.ts
diff --git a/src/core/server/http/http_tools.ts b/src/core/server/http/http_tools.ts
@@ -29,8 +29,8 @@ import Hoek from '@hapi/hoek';
 import type { ServerOptions as TLSOptions } from 'https';
 import type { ValidationError } from 'joi';
 import uuid from 'uuid';
+import { validateObject } from '@kbn/std';
 import { HttpConfig } from './http_config';
-import { validateObject } from './prototype_pollution';
 
 const corsAllowedHeaders = ['Accept', 'Authorization', 'Content-Type', 'If-None-Match', 'kbn-xsrf'];
 /**

diff --git a/src/core/server/http/index.ts b/src/core/server/http/index.ts
@@ -94,4 +94,3 @@ export {
 } from './cookie_session_storage';
 export * from './types';
 export { BasePath, IBasePath } from './base_path_service';
-export { validateObject } from './prototype_pollution';
diff --git a/src/core/server/http/prototype_pollution/index.ts b/src/core/server/http/prototype_pollution/index.ts
diff --git a/src/core/server/index.ts b/src/core/server/index.ts
@@ -201,7 +201,6 @@ export {
   RouteConfigOptionsBody,
   RouteContentType,
   validBodyOutput,
-  validateObject,
   RouteValidatorConfig,
   RouteValidationSpec,
   RouteValidationFunction,

diff --git a/src/plugins/vis_type_timeseries/server/routes/vis.ts b/src/plugins/vis_type_timeseries/server/routes/vis.ts
@@ -19,12 +19,12 @@
 
 import { IRouter, KibanaRequest } from 'kibana/server';
 import { schema } from '@kbn/config-schema';
+import { validateObject } from '@kbn/std';
 import { getVisData, GetVisDataOptions } from '../lib/get_vis_data';
 import { visPayloadSchema } from '../../common/vis_schema';
 import { ROUTES } from '../../common/constants';
 import { ValidationTelemetryServiceSetup } from '../index';
 import { Framework } from '../plugin';
-import { validateObject } from '../../../../core/server';
 
 const escapeHatch = schema.object({}, { unknowns: 'allow' });