Skip to content

Commit

Permalink
feat: support prefix in VariableScope
Browse files Browse the repository at this point in the history
This change allows us to use the current VariableScope
with VaultVariables which have a fixed 'vault' prefix
  • Loading branch information
Pranav Joglekar committed Jul 10, 2024
1 parent e1dfe7a commit b6d68e3
Show file tree
Hide file tree
Showing 3 changed files with 1,561 additions and 7 deletions.
37 changes: 30 additions & 7 deletions lib/collection/variable-scope.js
Original file line number Diff line number Diff line change
Expand Up @@ -111,6 +111,10 @@ _.inherit((
if (mutations) {
this.mutations = new MutationTracker(mutations);
}

if (definition && definition.prefix) {
this._postman_scopePrefix = definition.prefix;
}
}), Property);

/**
Expand Down Expand Up @@ -176,7 +180,9 @@ _.assign(VariableScope.prototype, /** @lends VariableScope.prototype */ {
* false otherwise
*/
has: function (key) {
var variable = this.values.oneNormalizedVariable(key),
const keyWithPrefix = this._postman_scopePrefix ? this._postman_scopePrefix + key : key;

var variable = this.values.oneNormalizedVariable(keyWithPrefix),
i,
ii;

Expand All @@ -199,7 +205,9 @@ _.assign(VariableScope.prototype, /** @lends VariableScope.prototype */ {
* @returns {*} The value of the specified variable across scopes.
*/
get: function (key) {
var variable = this.values.oneNormalizedVariable(key),
const keyWithPrefix = this._postman_scopePrefix ? this._postman_scopePrefix + key : key;

var variable = this.values.oneNormalizedVariable(keyWithPrefix),
i,
ii;

Expand All @@ -222,10 +230,12 @@ _.assign(VariableScope.prototype, /** @lends VariableScope.prototype */ {
* @param {Variable.types} [type] - Optionally, the value of the variable can be set to a type
*/
set: function (key, value, type) {
var variable = this.values.oneNormalizedVariable(key),
const keyWithPrefix = this._postman_scopePrefix ? this._postman_scopePrefix + key : key;

var variable = this.values.oneNormalizedVariable(keyWithPrefix),

// create an object that will be used as setter
update = { key, value };
update = { key: keyWithPrefix, value: value };

_.isString(type) && (update.type = type);

Expand All @@ -248,11 +258,13 @@ _.assign(VariableScope.prototype, /** @lends VariableScope.prototype */ {
* @param {String} key -
*/
unset: function (key) {
const keyWithPrefix = this._postman_scopePrefix ? this._postman_scopePrefix + key : key;

var lastDisabledVariable;

this.values.remove(function (variable) {
// bail out if variable name didn't match
if (variable.key !== key) {
if (variable.key !== keyWithPrefix) {
return false;
}

Expand All @@ -269,7 +281,7 @@ _.assign(VariableScope.prototype, /** @lends VariableScope.prototype */ {

// restore the reference with the last disabled variable
if (lastDisabledVariable) {
this.values.reference[key] = lastDisabledVariable;
this.values.reference[keyWithPrefix] = lastDisabledVariable;
}

// track the change if mutation tracking is enabled
Expand Down Expand Up @@ -300,9 +312,20 @@ _.assign(VariableScope.prototype, /** @lends VariableScope.prototype */ {
* @returns {String|Object} The string or object with variables (if any) substituted with their values
*/
replaceIn: function (template) {
let values = this.values;

if (this._postman_scopePrefix) {
values = new VariableList(this, this.values.toJSON().map((v) => {
return {
...v,
key: v.key.replace(this._postman_scopePrefix, '')
};
}));
}

if (_.isString(template) || _.isArray(template)) {
// convert template to object because replaceSubstitutionsIn only accepts objects
var result = Property.replaceSubstitutionsIn({ template }, _.concat(this.values, this._layers));
var result = Property.replaceSubstitutionsIn({ template }, _.concat(values, this._layers));

return result.template;
}
Expand Down
Loading

0 comments on commit b6d68e3

Please sign in to comment.