Move feature privilege iterator into the features plugin

elastic · May 17, 2021 · 542fad2 · 542fad2
1 parent 2129732
commit 542fad2
Show file tree

Hide file tree

Showing 12 changed files with 89 additions and 86 deletions.
diff --git a/x-pack/plugins/features/server/feature_privilege_iterator.js b/x-pack/plugins/features/server/feature_privilege_iterator.js
diff --git a/...erator/feature_privilege_iterator.test.ts → ...erator/feature_privilege_iterator.test.ts b/...erator/feature_privilege_iterator.test.ts → ...erator/feature_privilege_iterator.test.ts
@@ -5,7 +5,7 @@
  * 2.0.
  */
 
-import { KibanaFeature } from '../../../../../features/server';
+import { KibanaFeature } from '../';
 import { featurePrivilegeIterator } from './feature_privilege_iterator';
 
 describe('featurePrivilegeIterator', () => {

diff --git a/...ge_iterator/feature_privilege_iterator.ts → ...ge_iterator/feature_privilege_iterator.ts b/...ge_iterator/feature_privilege_iterator.ts → ...ge_iterator/feature_privilege_iterator.ts
@@ -7,20 +7,25 @@
 
 import _ from 'lodash';
 
-import type { FeatureKibanaPrivileges, KibanaFeature } from '../../../../../features/server';
-import type { LicenseType } from '../../../../../licensing/server';
+import type { FeatureKibanaPrivileges, KibanaFeature } from '../';
+import type { LicenseType } from '../../../licensing/server';
 import { subFeaturePrivilegeIterator } from './sub_feature_privilege_iterator';
 
-interface IteratorOptions {
+export interface IteratorOptions {
   augmentWithSubFeaturePrivileges: boolean;
   licenseType: LicenseType;
   predicate?: (privilegeId: string, privilege: FeatureKibanaPrivileges) => boolean;
 }
 
-export function* featurePrivilegeIterator(
+export type FeaturePrivilegeIterator = (
   feature: KibanaFeature,
   options: IteratorOptions
-): IterableIterator<{ privilegeId: string; privilege: FeatureKibanaPrivileges }> {
+) => IterableIterator<{ privilegeId: string; privilege: FeatureKibanaPrivileges }>;
+
+const featurePrivilegeIterator: FeaturePrivilegeIterator = function* featurePrivilegeIterator(
+  feature: KibanaFeature,
+  options: IteratorOptions
+) {
   for (const entry of Object.entries(feature.privileges ?? {})) {
     const [privilegeId, privilege] = entry;
 
@@ -37,7 +42,7 @@ export function* featurePrivilegeIterator(
       yield { privilegeId, privilege };
     }
   }
-}
+};
 
 function mergeWithSubFeatures(
   privilegeId: string,
@@ -97,3 +102,5 @@ function mergeArrays(input1: readonly string[] | undefined, input2: readonly str
   const second = input2 ?? [];
   return Array.from(new Set([...first, ...second]));
 }
+
+export { featurePrivilegeIterator };
diff --git a/...leges/feature_privilege_iterator/index.ts → ...erver/feature_privilege_iterator/index.ts b/...leges/feature_privilege_iterator/index.ts → ...erver/feature_privilege_iterator/index.ts
@@ -5,5 +5,7 @@
  * 2.0.
  */
 
+export type { FeaturePrivilegeIterator, IteratorOptions } from './feature_privilege_iterator';
+export type { SubFeaturePrivilegeIterator } from './sub_feature_privilege_iterator';
 export { featurePrivilegeIterator } from './feature_privilege_iterator';
 export { subFeaturePrivilegeIterator } from './sub_feature_privilege_iterator';
diff --git a/...terator/sub_feature_privilege_iterator.ts → ...terator/sub_feature_privilege_iterator.ts b/...terator/sub_feature_privilege_iterator.ts → ...terator/sub_feature_privilege_iterator.ts
@@ -5,10 +5,15 @@
  * 2.0.
  */
 
-import type { KibanaFeature, SubFeaturePrivilegeConfig } from '../../../../../features/common';
-import type { LicenseType } from '../../../../../licensing/server';
+import type { KibanaFeature, SubFeaturePrivilegeConfig } from '../../common';
+import type { LicenseType } from '../../../licensing/server';
 
-export function* subFeaturePrivilegeIterator(
+export type SubFeaturePrivilegeIterator = (
+  feature: KibanaFeature,
+  licenseType: LicenseType
+) => IterableIterator<SubFeaturePrivilegeConfig>;
+
+const subFeaturePrivilegeIterator: SubFeaturePrivilegeIterator = function* subFeaturePrivilegeIterator(
   feature: KibanaFeature,
   licenseType: LicenseType
 ): IterableIterator<SubFeaturePrivilegeConfig> {
@@ -19,4 +24,6 @@ export function* subFeaturePrivilegeIterator(
       );
     }
   }
-}
+};
+
+export { subFeaturePrivilegeIterator };
diff --git a/x-pack/plugins/features/server/mocks.ts b/x-pack/plugins/features/server/mocks.ts
@@ -6,6 +6,10 @@
  */
 
 import { PluginSetupContract, PluginStartContract } from './plugin';
+import {
+  featurePrivilegeIterator,
+  subFeaturePrivilegeIterator,
+} from './feature_privilege_iterator';
 
 const createSetup = (): jest.Mocked<PluginSetupContract> => {
   return {
@@ -15,6 +19,8 @@ const createSetup = (): jest.Mocked<PluginSetupContract> => {
     registerKibanaFeature: jest.fn(),
     registerElasticsearchFeature: jest.fn(),
     enableReportingUiCapabilities: jest.fn(),
+    featurePrivilegeIterator: jest.fn().mockImplementation(featurePrivilegeIterator),
+    subFeaturePrivilegeIterator: jest.fn().mockImplementation(subFeaturePrivilegeIterator),
   };
 };
 

diff --git a/x-pack/plugins/features/server/oss_features.test.ts b/x-pack/plugins/features/server/oss_features.test.ts
@@ -6,7 +6,6 @@
  */
 
 import { buildOSSFeatures } from './oss_features';
-// @ts-expect-error
 import { featurePrivilegeIterator } from './feature_privilege_iterator';
 import { KibanaFeature } from '.';
 import { LicenseType } from '../../licensing/server';

diff --git a/x-pack/plugins/features/server/plugin.ts b/x-pack/plugins/features/server/plugin.ts
@@ -26,6 +26,14 @@ import {
   KibanaFeature,
   KibanaFeatureConfig,
 } from '../common';
+import type {
+  FeaturePrivilegeIterator,
+  SubFeaturePrivilegeIterator,
+} from './feature_privilege_iterator';
+import {
+  featurePrivilegeIterator,
+  subFeaturePrivilegeIterator,
+} from './feature_privilege_iterator';
 
 /**
  * Describes public Features plugin contract returned at the `setup` stage.
@@ -54,6 +62,9 @@ export interface PluginSetupContract {
    * `features` to include Reporting when registering OSS features.
    */
   enableReportingUiCapabilities(): void;
+
+  featurePrivilegeIterator: FeaturePrivilegeIterator;
+  subFeaturePrivilegeIterator: SubFeaturePrivilegeIterator;
 }
 
 export interface PluginStartContract {
@@ -110,6 +121,8 @@ export class FeaturesPlugin
       ),
       getFeaturesUICapabilities,
       enableReportingUiCapabilities: this.enableReportingUiCapabilities.bind(this),
+      featurePrivilegeIterator,
+      subFeaturePrivilegeIterator,
     });
   }
 

diff --git a/x-pack/plugins/security/server/authorization/authorization_service.tsx b/x-pack/plugins/security/server/authorization/authorization_service.tsx
@@ -51,7 +51,6 @@ import { validateReservedPrivileges } from './validate_reserved_privileges';
 
 export { Actions } from './actions';
 export { CheckSavedObjectsPrivileges } from './check_saved_objects_privileges';
-export { featurePrivilegeIterator } from './privileges';
 
 interface AuthorizationServiceSetupParams {
   packageVersion: string;

diff --git a/x-pack/plugins/security/server/authorization/privileges/index.ts b/x-pack/plugins/security/server/authorization/privileges/index.ts
@@ -6,4 +6,3 @@
  */
 
 export { privilegesFactory, PrivilegesService } from './privileges';
-export { featurePrivilegeIterator } from './feature_privilege_iterator';
diff --git a/x-pack/plugins/security/server/authorization/privileges/privileges.test.ts b/x-pack/plugins/security/server/authorization/privileges/privileges.test.ts
@@ -85,9 +85,8 @@ describe('features', () => {
       }),
     ];
 
-    const mockFeaturesPlugin = {
-      getKibanaFeatures: jest.fn().mockReturnValue(features),
-    };
+    const mockFeaturesPlugin = featuresPluginMock.createSetup();
+    mockFeaturesPlugin.getKibanaFeatures.mockReturnValue(features);
     const mockLicenseService = {
       getFeatures: jest.fn().mockReturnValue({ allowSubFeaturePrivileges: true }),
       getType: jest.fn().mockReturnValue('basic'),
@@ -190,9 +189,8 @@ describe('features', () => {
       }),
     ];
 
-    const mockFeaturesPlugin = {
-      getKibanaFeatures: jest.fn().mockReturnValue(features),
-    };
+    const mockFeaturesPlugin = featuresPluginMock.createSetup();
+    mockFeaturesPlugin.getKibanaFeatures.mockReturnValue(features);
     const mockLicenseService = {
       getFeatures: jest.fn().mockReturnValue({ allowSubFeaturePrivileges: true }),
       getType: jest.fn().mockReturnValue('basic'),
@@ -268,9 +266,8 @@ describe('features', () => {
           }),
         ];
 
-        const mockFeaturesPlugin = {
-          getKibanaFeatures: jest.fn().mockReturnValue(features),
-        };
+        const mockFeaturesPlugin = featuresPluginMock.createSetup();
+        mockFeaturesPlugin.getKibanaFeatures.mockReturnValue(features);
         const mockLicenseService = {
           getFeatures: jest.fn().mockReturnValue({ allowSubFeaturePrivileges: true }),
           getType: jest.fn().mockReturnValue('basic'),
@@ -413,9 +410,8 @@ describe('features', () => {
           }),
         ];
 
-        const mockFeaturesPlugin = {
-          getKibanaFeatures: jest.fn().mockReturnValue(features),
-        };
+        const mockFeaturesPlugin = featuresPluginMock.createSetup();
+        mockFeaturesPlugin.getKibanaFeatures.mockReturnValue(features);
         const mockLicenseService = {
           getFeatures: jest.fn().mockReturnValue({ allowSubFeaturePrivileges: true }),
           getType: jest.fn().mockReturnValue('basic'),
@@ -502,9 +498,8 @@ describe('features', () => {
           }),
         ];
 
-        const mockFeaturesPlugin = {
-          getKibanaFeatures: jest.fn().mockReturnValue(features),
-        };
+        const mockFeaturesPlugin = featuresPluginMock.createSetup();
+        mockFeaturesPlugin.getKibanaFeatures.mockReturnValue(features);
         const mockLicenseService = {
           getFeatures: jest.fn().mockReturnValue({ allowSubFeaturePrivileges: true }),
           getType: jest.fn().mockReturnValue('basic'),
@@ -577,9 +572,8 @@ describe('features', () => {
           }),
         ];
 
-        const mockFeaturesPlugin = {
-          getKibanaFeatures: jest.fn().mockReturnValue(features),
-        };
+        const mockFeaturesPlugin = featuresPluginMock.createSetup();
+        mockFeaturesPlugin.getKibanaFeatures.mockReturnValue(features);
         const mockLicenseService = {
           getFeatures: jest.fn().mockReturnValue({ allowSubFeaturePrivileges: true }),
           getType: jest.fn().mockReturnValue('basic'),
@@ -653,9 +647,8 @@ describe('features', () => {
           }),
         ];
 
-        const mockFeaturesPlugin = {
-          getKibanaFeatures: jest.fn().mockReturnValue(features),
-        };
+        const mockFeaturesPlugin = featuresPluginMock.createSetup();
+        mockFeaturesPlugin.getKibanaFeatures.mockReturnValue(features);
         const mockLicenseService = {
           getFeatures: jest.fn().mockReturnValue({ allowSubFeaturePrivileges: true }),
           getType: jest.fn().mockReturnValue('basic'),
@@ -723,9 +716,8 @@ describe('reserved', () => {
       }),
     ];
 
-    const mockFeaturesPlugin = {
-      getKibanaFeatures: jest.fn().mockReturnValue(features),
-    };
+    const mockFeaturesPlugin = featuresPluginMock.createSetup();
+    mockFeaturesPlugin.getKibanaFeatures.mockReturnValue(features);
     const mockLicenseService = {
       getFeatures: jest.fn().mockReturnValue({ allowSubFeaturePrivileges: true }),
       getType: jest.fn().mockReturnValue('basic'),
@@ -762,9 +754,8 @@ describe('reserved', () => {
       }),
     ];
 
-    const mockFeaturesPlugin = {
-      getKibanaFeatures: jest.fn().mockReturnValue(features),
-    };
+    const mockFeaturesPlugin = featuresPluginMock.createSetup();
+    mockFeaturesPlugin.getKibanaFeatures.mockReturnValue(features);
     const mockLicenseService = {
       getFeatures: jest.fn().mockReturnValue({ allowSubFeaturePrivileges: true }),
       getType: jest.fn().mockReturnValue('basic'),
@@ -837,9 +828,8 @@ describe('reserved', () => {
       }),
     ];
 
-    const mockFeaturesPlugin = {
-      getKibanaFeatures: jest.fn().mockReturnValue(features),
-    };
+    const mockFeaturesPlugin = featuresPluginMock.createSetup();
+    mockFeaturesPlugin.getKibanaFeatures.mockReturnValue(features);
     const mockLicenseService = {
       getFeatures: jest.fn().mockReturnValue({ allowSubFeaturePrivileges: true }),
       getType: jest.fn().mockReturnValue('basic'),
@@ -901,9 +891,8 @@ describe('subFeatures', () => {
         }),
       ];
 
-      const mockFeaturesPlugin = {
-        getKibanaFeatures: jest.fn().mockReturnValue(features),
-      };
+      const mockFeaturesPlugin = featuresPluginMock.createSetup();
+      mockFeaturesPlugin.getKibanaFeatures.mockReturnValue(features);
       const mockLicenseService = {
         getFeatures: jest.fn().mockReturnValue({ allowSubFeaturePrivileges: true }),
         getType: jest.fn().mockReturnValue('basic'),
@@ -1036,9 +1025,8 @@ describe('subFeatures', () => {
         }),
       ];
 
-      const mockFeaturesPlugin = {
-        getKibanaFeatures: jest.fn().mockReturnValue(features),
-      };
+      const mockFeaturesPlugin = featuresPluginMock.createSetup();
+      mockFeaturesPlugin.getKibanaFeatures.mockReturnValue(features);
       const mockLicenseService = {
         getFeatures: jest.fn().mockReturnValue({ allowSubFeaturePrivileges: true }),
         getType: jest.fn().mockReturnValue('basic'),
@@ -1274,9 +1262,8 @@ describe('subFeatures', () => {
         }),
       ];
 
-      const mockFeaturesPlugin = {
-        getKibanaFeatures: jest.fn().mockReturnValue(features),
-      };
+      const mockFeaturesPlugin = featuresPluginMock.createSetup();
+      mockFeaturesPlugin.getKibanaFeatures.mockReturnValue(features);
       const mockLicenseService = {
         getFeatures: jest.fn().mockReturnValue({ allowSubFeaturePrivileges: true }),
         getType: jest.fn().mockReturnValue('basic'),
@@ -1435,9 +1422,8 @@ describe('subFeatures', () => {
         }),
       ];
 
-      const mockFeaturesPlugin = {
-        getKibanaFeatures: jest.fn().mockReturnValue(features),
-      };
+      const mockFeaturesPlugin = featuresPluginMock.createSetup();
+      mockFeaturesPlugin.getKibanaFeatures.mockReturnValue(features);
       const mockLicenseService = {
         getFeatures: jest.fn().mockReturnValue({ allowSubFeaturePrivileges: true }),
         getType: jest.fn().mockReturnValue('basic'),
@@ -1622,9 +1608,8 @@ describe('subFeatures', () => {
         }),
       ];
 
-      const mockFeaturesPlugin = {
-        getKibanaFeatures: jest.fn().mockReturnValue(features),
-      };
+      const mockFeaturesPlugin = featuresPluginMock.createSetup();
+      mockFeaturesPlugin.getKibanaFeatures.mockReturnValue(features);
       const mockLicenseService = {
         getFeatures: jest.fn().mockReturnValue({ allowSubFeaturePrivileges: true }),
         getType: jest.fn().mockReturnValue('basic'),
@@ -1766,9 +1751,8 @@ describe('subFeatures', () => {
         }),
       ];
 
-      const mockFeaturesPlugin = {
-        getKibanaFeatures: jest.fn().mockReturnValue(features),
-      };
+      const mockFeaturesPlugin = featuresPluginMock.createSetup();
+      mockFeaturesPlugin.getKibanaFeatures.mockReturnValue(features);
       const mockLicenseService = {
         getFeatures: jest.fn().mockReturnValue({ allowSubFeaturePrivileges: false }),
         getType: jest.fn().mockReturnValue('basic'),
@@ -1993,9 +1977,8 @@ describe('subFeatures', () => {
         }),
       ];
 
-      const mockFeaturesPlugin = {
-        getKibanaFeatures: jest.fn().mockReturnValue(features),
-      };
+      const mockFeaturesPlugin = featuresPluginMock.createSetup();
+      mockFeaturesPlugin.getKibanaFeatures.mockReturnValue(features);
       const mockLicenseService = {
         getFeatures: jest.fn().mockReturnValue({ allowSubFeaturePrivileges: true }),
         getType: jest.fn().mockReturnValue('gold'),
@@ -2229,9 +2212,8 @@ describe('subFeatures', () => {
         }),
       ];
 
-      const mockFeaturesPlugin = {
-        getKibanaFeatures: jest.fn().mockReturnValue(features),
-      };
+      const mockFeaturesPlugin = featuresPluginMock.createSetup();
+      mockFeaturesPlugin.getKibanaFeatures.mockReturnValue(features);
       const mockLicenseService = {
         getFeatures: jest.fn().mockReturnValue({ allowSubFeaturePrivileges: true }),
         getType: jest.fn().mockReturnValue('platinum'),
Original file line number	Diff line number	Diff line change
Expand Up		@@ -6,4 +6,3 @@
		*/

		export { privilegesFactory, PrivilegesService } from './privileges';
		export { featurePrivilegeIterator } from './feature_privilege_iterator';