From 20d10b57d6373b09510fbe964427849c613a1890 Mon Sep 17 00:00:00 2001 From: MT Lewis Date: Tue, 21 Dec 2021 09:46:22 +0000 Subject: [PATCH] permission-node: rename static create method to fromConfig Signed-off-by: MT Lewis --- packages/backend/src/index.ts | 3 +-- plugins/permission-node/api-report.md | 12 +++++++----- .../src/ServerPermissionClient.test.ts | 12 ++++-------- .../permission-node/src/ServerPermissionClient.ts | 14 ++++++++------ 4 files changed, 20 insertions(+), 21 deletions(-) diff --git a/packages/backend/src/index.ts b/packages/backend/src/index.ts index c398650588..a83abc218c 100644 --- a/packages/backend/src/index.ts +++ b/packages/backend/src/index.ts @@ -64,9 +64,8 @@ function makeCreateEnv(config: Config) { const reader = UrlReaders.default({ logger: root, config }); const discovery = SingleHostDiscovery.fromConfig(config); const tokenManager = ServerTokenManager.fromConfig(config, { logger: root }); - const permissions = ServerPermissionClient.create({ + const permissions = ServerPermissionClient.fromConfig(config, { discovery, - config, tokenManager, }); diff --git a/plugins/permission-node/api-report.md b/plugins/permission-node/api-report.md index f41350231f..25a8be06c8 100644 --- a/plugins/permission-node/api-report.md +++ b/plugins/permission-node/api-report.md @@ -134,10 +134,12 @@ export class ServerPermissionClient implements PermissionAuthorizer { options?: AuthorizeRequestOptions, ): Promise; // (undocumented) - static create(options: { - discovery: PluginEndpointDiscovery; - config: Config; - tokenManager: TokenManager; - }): ServerPermissionClient; + static fromConfig( + config: Config, + options: { + discovery: PluginEndpointDiscovery; + tokenManager: TokenManager; + }, + ): ServerPermissionClient; } ``` diff --git a/plugins/permission-node/src/ServerPermissionClient.test.ts b/plugins/permission-node/src/ServerPermissionClient.test.ts index cd15ba7439..2c29ef8939 100644 --- a/plugins/permission-node/src/ServerPermissionClient.test.ts +++ b/plugins/permission-node/src/ServerPermissionClient.test.ts @@ -68,9 +68,8 @@ describe('ServerPermissionClient', () => { afterEach(() => server.resetHandlers()); it('should bypass authorization if permissions are disabled', async () => { - const client = ServerPermissionClient.create({ + const client = ServerPermissionClient.fromConfig(new ConfigReader({}), { discovery, - config: new ConfigReader({}), tokenManager: ServerTokenManager.noop(), }); @@ -81,9 +80,8 @@ describe('ServerPermissionClient', () => { it('should bypass authorization if permissions are enabled and request has valid server token', async () => { const tokenManager = ServerTokenManager.fromConfig(config, { logger }); - const client = ServerPermissionClient.create({ + const client = ServerPermissionClient.fromConfig(config, { discovery, - config, tokenManager, }); @@ -96,9 +94,8 @@ describe('ServerPermissionClient', () => { it('should authorize normally if permissions are enabled and request does not have valid server token', async () => { const tokenManager = ServerTokenManager.fromConfig(config, { logger }); - const client = ServerPermissionClient.create({ + const client = ServerPermissionClient.fromConfig(config, { discovery, - config, tokenManager, }); @@ -111,9 +108,8 @@ describe('ServerPermissionClient', () => { it('should error if permissions are enabled but a no-op token manager is configured', async () => { expect(() => - ServerPermissionClient.create({ + ServerPermissionClient.fromConfig(config, { discovery, - config, tokenManager: ServerTokenManager.noop(), }), ).toThrowError( diff --git a/plugins/permission-node/src/ServerPermissionClient.ts b/plugins/permission-node/src/ServerPermissionClient.ts index e9438a9162..a6f3488851 100644 --- a/plugins/permission-node/src/ServerPermissionClient.ts +++ b/plugins/permission-node/src/ServerPermissionClient.ts @@ -39,12 +39,14 @@ export class ServerPermissionClient implements PermissionAuthorizer { private readonly tokenManager: TokenManager; private readonly permissionEnabled: boolean; - static create(options: { - discovery: PluginEndpointDiscovery; - config: Config; - tokenManager: TokenManager; - }) { - const { discovery, config, tokenManager } = options; + static fromConfig( + config: Config, + options: { + discovery: PluginEndpointDiscovery; + tokenManager: TokenManager; + }, + ) { + const { discovery, tokenManager } = options; const permissionClient = new PermissionClient({ discovery, config }); const permissionEnabled = config.getOptionalBoolean('permission.enabled') ?? false;