-
Notifications
You must be signed in to change notification settings - Fork 477
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add a config value for the DAG cutoff #143
Merged
Merged
Changes from 2 commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
aa96e7d
Config DAG max svcs, handle deprecated config keys
tiffon 5a5b5fe
Unit tests for utils/config
tiffon d5e3507
Merge branch 'master' into issue-130-config-for-dag-max
tiffon 6d838cf
Merge branch 'master' into issue-130-config-for-dag-max
tiffon 749296d
Consolidate single-value constants
tiffon File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
// Copyright (c) 2017 Uber Technologies, Inc. | ||
// | ||
// Licensed under the Apache License, Version 2.0 (the "License"); | ||
// you may not use this file except in compliance with the License. | ||
// You may obtain a copy of the License at | ||
// | ||
// http://www.apache.org/licenses/LICENSE-2.0 | ||
// | ||
// Unless required by applicable law or agreed to in writing, software | ||
// distributed under the License is distributed on an "AS IS" BASIS, | ||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
// See the License for the specific language governing permissions and | ||
// limitations under the License. | ||
|
||
export default 100; | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,87 @@ | ||
// Copyright (c) 2017 Uber Technologies, Inc. | ||
// | ||
// Licensed under the Apache License, Version 2.0 (the "License"); | ||
// you may not use this file except in compliance with the License. | ||
// You may obtain a copy of the License at | ||
// | ||
// http://www.apache.org/licenses/LICENSE-2.0 | ||
// | ||
// Unless required by applicable law or agreed to in writing, software | ||
// distributed under the License is distributed on an "AS IS" BASIS, | ||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
// See the License for the specific language governing permissions and | ||
// limitations under the License. | ||
|
||
/* eslint-disable no-console, import/first */ | ||
|
||
jest.mock('./process-deprecation'); | ||
jest.mock('../../constants/default-config', () => { | ||
const actual = require.requireActual('../../constants/default-config'); | ||
// make sure there are deprecations | ||
const deprecations = [{ currentKey: 'current.key', formerKey: 'former.key' }]; | ||
return { default: actual.default, deprecations }; | ||
}); | ||
|
||
import getConfig from './get-config'; | ||
import processDeprecation from './process-deprecation'; | ||
import defaultConfig from '../../constants/default-config'; | ||
|
||
describe('getConfig()', () => { | ||
let oldWarn; | ||
let warnFn; | ||
|
||
beforeEach(() => { | ||
oldWarn = console.warn; | ||
warnFn = jest.fn(); | ||
console.warn = warnFn; | ||
}); | ||
|
||
afterEach(() => { | ||
console.warn = oldWarn; | ||
}); | ||
|
||
describe('`window.getJaegerUiConfig` is not a function', () => { | ||
it('warns once', () => { | ||
getConfig(); | ||
expect(warnFn.mock.calls.length).toBe(1); | ||
getConfig(); | ||
expect(warnFn.mock.calls.length).toBe(1); | ||
}); | ||
|
||
it('returns the default config', () => { | ||
expect(getConfig()).toEqual(defaultConfig); | ||
}); | ||
}); | ||
|
||
describe('`window.getJaegerUiConfig` is a function', () => { | ||
let embedded; | ||
let getJaegerUiConfig; | ||
|
||
beforeEach(() => { | ||
embedded = {}; | ||
getJaegerUiConfig = jest.fn(() => embedded); | ||
window.getJaegerUiConfig = getJaegerUiConfig; | ||
}); | ||
|
||
it('merges the defaultConfig with the embedded config ', () => { | ||
embedded = { novel: 'prop' }; | ||
expect(getConfig()).toEqual({ ...defaultConfig, ...embedded }); | ||
}); | ||
|
||
it('gives precedence to the embedded config', () => { | ||
embedded = {}; | ||
Object.keys(defaultConfig).forEach(key => { | ||
embedded[key] = key; | ||
}); | ||
expect(getConfig()).toEqual(embedded); | ||
}); | ||
|
||
it('processes deprecations every time `getConfig` is invoked', () => { | ||
processDeprecation.mockClear(); | ||
getConfig(); | ||
expect(processDeprecation.mock.calls.length).toBe(1); | ||
getConfig(); | ||
expect(processDeprecation.mock.calls.length).toBe(2); | ||
}); | ||
}); | ||
}); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,68 @@ | ||
// @flow | ||
|
||
// Copyright (c) 2017 Uber Technologies, Inc. | ||
// | ||
// Licensed under the Apache License, Version 2.0 (the "License"); | ||
// you may not use this file except in compliance with the License. | ||
// You may obtain a copy of the License at | ||
// | ||
// http://www.apache.org/licenses/LICENSE-2.0 | ||
// | ||
// Unless required by applicable law or agreed to in writing, software | ||
// distributed under the License is distributed on an "AS IS" BASIS, | ||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
// See the License for the specific language governing permissions and | ||
// limitations under the License. | ||
|
||
import _get from 'lodash/get'; | ||
import _has from 'lodash/has'; | ||
import _set from 'lodash/set'; | ||
import _unset from 'lodash/unset'; | ||
|
||
type Deprecation = { | ||
formerKey: string, | ||
currentKey: string, | ||
}; | ||
|
||
/** | ||
* Processes a deprecated config property with respect to a configuration. | ||
* NOTE: This mutates `config`. | ||
* | ||
* If the deprecated config property is found to be set on `config`, it is | ||
* moved to the new config property unless a conflicting setting exists. If | ||
* `issueWarning` is `true`, warnings are issues when: | ||
* | ||
* - The deprecated config property is found to be set on `config` | ||
* - The value at the deprecated config property is moved to the new property | ||
* - The value at the deprecated config property is ignored in favor of the value at the new property | ||
*/ | ||
export default function processDeprecation(config: {}, deprecation: Deprecation, issueWarning: boolean) { | ||
const { formerKey, currentKey } = deprecation; | ||
if (_has(config, formerKey)) { | ||
let isTransfered = false; | ||
let isIgnored = false; | ||
if (!_has(config, currentKey)) { | ||
// the new key is not set so transfer the value at the old key | ||
const value = _get(config, formerKey); | ||
_set(config, currentKey, value); | ||
isTransfered = true; | ||
} else { | ||
isIgnored = true; | ||
} | ||
_unset(config, formerKey); | ||
|
||
if (issueWarning) { | ||
const warnings = [`"${formerKey}" is deprecated, instead use "${currentKey}"`]; | ||
if (isTransfered) { | ||
warnings.push(`The value at "${formerKey}" has been moved to "${currentKey}"`); | ||
} | ||
if (isIgnored) { | ||
warnings.push( | ||
`The value at "${formerKey}" is being ignored in favor of the value at "${currentKey}"` | ||
); | ||
} | ||
// eslint-disable-next-line no-console | ||
console.warn(warnings.join('\n')); | ||
} | ||
} | ||
} |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
why is it better to have one constant per file rather than list them all in one file?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That's a valid point. I'll make the change.