Skip to content

Commit

Permalink
feat: Default port to 8015 if in-process resolver is used. #936 (#937)
Browse files Browse the repository at this point in the history 
Signed-off-by: Simon Schrottner <simon.schrottner@dynatrace.com>
  • Loading branch information
@aepfli
aepfli committed Jun 14, 2024
1 parent c789878 commit 53c4077
Show file tree
Hide file tree
Showing 3 changed files with 68 additions and 18 deletions.
30 changes: 18 additions & 12 deletions libs/providers/flagd/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -27,17 +27,23 @@ Options can be defined in the constructor or as environment variables. Construct

### Available Configuration Options

| Option name | Environment variable name | Type | Default | Supported values |
| -------------------------------------- | ------------------------------ | ------- | --------- | ---------------- |
| host | FLAGD_HOST | string | localhost | |
| port | FLAGD_PORT | number | 8013 | |
| tls | FLAGD_TLS | boolean | false | |
| socketPath | FLAGD_SOCKET_PATH | string | - | |
| resolverType | FLAGD_RESOLVER | string | rpc | rpc, in-process |
| offlineFlagSourcePath | FLAGD_OFFLINE_FLAG_SOURCE_PATH | string | - | |
| selector | FLAGD_SOURCE_SELECTOR | string | - | |
| cache | FLAGD_CACHE | string | lru | lru, disabled |
| maxCacheSize | FLAGD_MAX_CACHE_SIZE | int | 1000 | |
| Option name | Environment variable name | Type | Default | Supported values |
| -------------------------------------- | ------------------------------ | ------- |----------------------------------------------------------------| ---------------- |
| host | FLAGD_HOST | string | localhost | |
| port | FLAGD_PORT | number | [resolver specific defaults](#resolver-type-specific-defaults) | |
| tls | FLAGD_TLS | boolean | false | |
| socketPath | FLAGD_SOCKET_PATH | string | - | |
| resolverType | FLAGD_RESOLVER | string | rpc | rpc, in-process |
| offlineFlagSourcePath | FLAGD_OFFLINE_FLAG_SOURCE_PATH | string | - | |
| selector | FLAGD_SOURCE_SELECTOR | string | - | |
| cache | FLAGD_CACHE | string | lru | lru, disabled |
| maxCacheSize | FLAGD_MAX_CACHE_SIZE | int | 1000 | |

#### Resolver type-specific Defaults

| Option name | Environment variable name | in-process | rpc | default |
| -------------------------------------- | ------------------------------ |-------------|------|---------|
| port | FLAGD_PORT | 8015 | 8013 | 8013 |

Below are examples of usage patterns.

Expand Down Expand Up @@ -72,7 +78,7 @@ Flag configurations for evaluation are obtained via gRPC protocol using [sync pr
}))
```

In the above example, the provider expects a flag sync service implementation to be available at `localhost:8013` (default host and port).
In the above example, the provider expects a flag sync service implementation to be available at `localhost:8015` (default host and port).

In-process resolver can also work in an offline mode.
To enable this mode, you should provide a valid flag configuration file with the option `offlineFlagSourcePath`.
Expand Down
39 changes: 38 additions & 1 deletion libs/providers/flagd/src/lib/configuration.spec.ts
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { FlagdProviderOptions, getConfig } from './configuration';
import { Config, FlagdProviderOptions, getConfig } from './configuration';
import { DEFAULT_MAX_CACHE_SIZE } from './constants';

describe('Configuration', () => {
Expand Down Expand Up @@ -77,4 +77,41 @@ describe('Configuration', () => {
process.env['FLAGD_PORT'] = 'invalid number';
expect(getConfig()).toStrictEqual(expect.objectContaining({ port: 8013 }));
});

describe('port handling', () => {
describe('for "in-process" evaluation', () => {
const resolverType = 'in-process';
const port = 8015;
it('should use default in-process port if resolver type is set per envVar and no port is provided', () => {
process.env['FLAGD_RESOLVER'] = resolverType;
expect(getConfig()).toStrictEqual(expect.objectContaining({ port, resolverType }));
});
it('should use default in-process port if resolver type is set per options and no port is provided', () => {
const options: Partial<Config> = { resolverType };
expect(getConfig(options)).toStrictEqual(expect.objectContaining({ port, resolverType }));
});
it('should use provided port if resolver type is set per options and port', () => {
const port = 1111;
const options: Partial<Config> = { resolverType, port };
expect(getConfig(options)).toStrictEqual(expect.objectContaining({ port, resolverType }));
});
});
describe('for "rpc" evaluation', () => {
const resolverType = 'rpc';
const port = 8013;
it('should use default in-process port if resolver type is set per envVar and no port is provided', () => {
process.env['FLAGD_RESOLVER'] = resolverType;
expect(getConfig()).toStrictEqual(expect.objectContaining({ port, resolverType }));
});
it('should use default in-process port if resolver type is set per options and no port is provided', () => {
const options: Partial<Config> = { resolverType };
expect(getConfig(options)).toStrictEqual(expect.objectContaining({ port, resolverType }));
});
it('should use provided port if resolver type is set per options and port', () => {
const port = 1111;
const options: Partial<Config> = { resolverType, port };
expect(getConfig(options)).toStrictEqual(expect.objectContaining({ port, resolverType }));
});
});
});
});
17 changes: 12 additions & 5 deletions libs/providers/flagd/src/lib/configuration.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -72,16 +72,18 @@ export interface Config {

export type FlagdProviderOptions = Partial<Config>;

const DEFAULT_CONFIG: Config = {
const DEFAULT_CONFIG: Omit<Config, 'port' | 'resolverType'> = {
host: 'localhost',
port: 8013,
tls: false,
resolverType: 'rpc',
selector: '',
cache: 'lru',
maxCacheSize: DEFAULT_MAX_CACHE_SIZE,
};

const DEFAULT_RPC_CONFIG: Config = { ...DEFAULT_CONFIG, resolverType: 'rpc', port: 8013 };

const DEFAULT_IN_PROCESS_CONFIG: Config = { ...DEFAULT_CONFIG, resolverType: 'in-process', port: 8015 };

enum ENV_VAR {
FLAGD_HOST = 'FLAGD_HOST',
FLAGD_PORT = 'FLAGD_PORT',
Expand Down Expand Up @@ -125,9 +127,14 @@ const getEnvVarConfig = (): Partial<Config> => ({
});

export function getConfig(options: FlagdProviderOptions = {}) {
const envVarConfig = getEnvVarConfig();
const defaultConfig =
options.resolverType == 'in-process' || envVarConfig.resolverType == 'in-process'
? DEFAULT_IN_PROCESS_CONFIG
: DEFAULT_RPC_CONFIG;
return {
...DEFAULT_CONFIG,
...getEnvVarConfig(),
...defaultConfig,
...envVarConfig,
...options,
};
}

0 comments on commit 53c4077

Please sign in to comment.