@azure/app-configuration-importer 1.0.0-preview → 1.1.0-preview
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +21 -0
- package/README.md +67 -0
- package/dist/index.js +7110 -217
- package/dist/index.js.map +1 -1
- package/dist-esm/src/MsFeatureFlagSchema.js +122 -0
- package/dist-esm/src/MsFeatureFlagSchema.js.map +1 -0
- package/dist-esm/src/appConfigurationImporter.js +157 -0
- package/dist-esm/src/appConfigurationImporter.js.map +1 -0
- package/dist-esm/src/enums.js +28 -0
- package/dist-esm/src/enums.js.map +1 -0
- package/dist-esm/src/errors.js +53 -0
- package/dist-esm/src/errors.js.map +1 -0
- package/dist-esm/src/featureFlag.js +12 -0
- package/dist-esm/src/featureFlag.js.map +1 -0
- package/dist-esm/src/importOptions.js +4 -0
- package/dist-esm/src/importOptions.js.map +1 -0
- package/dist-esm/src/index.js +9 -0
- package/dist-esm/src/index.js.map +1 -0
- package/dist-esm/src/internal/adaptiveTaskManager.js +69 -0
- package/dist-esm/src/internal/adaptiveTaskManager.js.map +1 -0
- package/dist-esm/src/internal/constants.js +36 -0
- package/dist-esm/src/internal/constants.js.map +1 -0
- package/dist-esm/src/internal/parsers/configurationSettingsConverter.js +4 -0
- package/dist-esm/src/internal/parsers/configurationSettingsConverter.js.map +1 -0
- package/dist-esm/src/internal/parsers/defaultConfigurationSettingsConverter.js +328 -0
- package/dist-esm/src/internal/parsers/defaultConfigurationSettingsConverter.js.map +1 -0
- package/dist-esm/src/internal/parsers/kvSetConfigurationSettingsConverter.js +66 -0
- package/dist-esm/src/internal/parsers/kvSetConfigurationSettingsConverter.js.map +1 -0
- package/dist-esm/src/internal/stream.browser.js +16 -0
- package/dist-esm/src/internal/stream.browser.js.map +1 -0
- package/dist-esm/src/internal/stream.js +15 -0
- package/dist-esm/src/internal/stream.js.map +1 -0
- package/dist-esm/src/internal/utils.js +129 -0
- package/dist-esm/src/internal/utils.js.map +1 -0
- package/dist-esm/src/models.js +4 -0
- package/dist-esm/src/models.js.map +1 -0
- package/dist-esm/src/settingsImport/configurationSettingsSource.js +4 -0
- package/dist-esm/src/settingsImport/configurationSettingsSource.js.map +1 -0
- package/dist-esm/src/settingsImport/iterableConfigurationSettingsSource.js +83 -0
- package/dist-esm/src/settingsImport/iterableConfigurationSettingsSource.js.map +1 -0
- package/dist-esm/src/settingsImport/readableStreamConfigurationSettingsSource.js +49 -0
- package/dist-esm/src/settingsImport/readableStreamConfigurationSettingsSource.js.map +1 -0
- package/dist-esm/src/settingsImport/stringConfigurationSettingsSource.js +92 -0
- package/dist-esm/src/settingsImport/stringConfigurationSettingsSource.js.map +1 -0
- package/package.json +20 -5
- package/types/azure-app-configuration-importer.d.ts +13 -0
- package/types/src/MsFeatureFlagSchema.d.ts +164 -0
- package/types/src/MsFeatureFlagSchema.d.ts.map +1 -0
- package/types/src/appConfigurationImporter.d.ts +37 -0
- package/types/src/appConfigurationImporter.d.ts.map +1 -0
- package/types/src/enums.d.ts +23 -0
- package/types/src/enums.d.ts.map +1 -0
- package/types/src/errors.d.ts +36 -0
- package/types/src/errors.d.ts.map +1 -0
- package/types/src/featureFlag.d.ts +50 -0
- package/types/src/featureFlag.d.ts.map +1 -0
- package/types/src/importOptions.d.ts +39 -0
- package/types/src/importOptions.d.ts.map +1 -0
- package/types/src/index.d.ts +10 -0
- package/types/src/index.d.ts.map +1 -0
- package/types/src/internal/adaptiveTaskManager.d.ts +20 -0
- package/types/src/internal/adaptiveTaskManager.d.ts.map +1 -0
- package/types/src/internal/constants.d.ts +10 -0
- package/types/src/internal/constants.d.ts.map +1 -0
- package/types/src/internal/parsers/configurationSettingsConverter.d.ts +11 -0
- package/types/src/internal/parsers/configurationSettingsConverter.d.ts.map +1 -0
- package/types/src/internal/parsers/defaultConfigurationSettingsConverter.d.ts +21 -0
- package/types/src/internal/parsers/defaultConfigurationSettingsConverter.d.ts.map +1 -0
- package/types/src/internal/parsers/kvSetConfigurationSettingsConverter.d.ts +15 -0
- package/types/src/internal/parsers/kvSetConfigurationSettingsConverter.d.ts.map +1 -0
- package/types/src/internal/stream.browser.d.ts +4 -0
- package/types/src/internal/stream.browser.d.ts.map +1 -0
- package/types/src/internal/stream.d.ts +4 -0
- package/types/src/internal/stream.d.ts.map +1 -0
- package/types/src/internal/utils.d.ts +17 -0
- package/types/src/internal/utils.d.ts.map +1 -0
- package/types/src/models.d.ts +42 -0
- package/types/src/models.d.ts.map +1 -0
- package/types/src/settingsImport/configurationSettingsSource.d.ts +19 -0
- package/types/src/settingsImport/configurationSettingsSource.d.ts.map +1 -0
- package/types/src/settingsImport/iterableConfigurationSettingsSource.d.ts +14 -0
- package/types/src/settingsImport/iterableConfigurationSettingsSource.d.ts.map +1 -0
- package/types/src/settingsImport/readableStreamConfigurationSettingsSource.d.ts +11 -0
- package/types/src/settingsImport/readableStreamConfigurationSettingsSource.d.ts.map +1 -0
- package/types/src/settingsImport/stringConfigurationSettingsSource.d.ts +24 -0
- package/types/src/settingsImport/stringConfigurationSettingsSource.d.ts.map +1 -0
- package/NOTICE.txt +0 -370
- package/app-configuration-importer.test.log +0 -164
- package/dist/app-configuration-importer.api.md +0 -136
- package/examples/README.md +0 -59
- package/examples/package.json +0 -32
- package/examples/sample.env +0 -6
- package/examples/testFiles/default.json +0 -24
- package/examples/testFiles/kvset.json +0 -35
- package/types/tsdoc-metadata.json +0 -11
|
@@ -0,0 +1,328 @@
|
|
|
1
|
+
// Copyright (c) Microsoft Corporation.
|
|
2
|
+
// Licensed under the MIT license.
|
|
3
|
+
var __rest = (this && this.__rest) || function (s, e) {
|
|
4
|
+
var t = {};
|
|
5
|
+
for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
|
|
6
|
+
t[p] = s[p];
|
|
7
|
+
if (s != null && typeof Object.getOwnPropertySymbols === "function")
|
|
8
|
+
for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
|
|
9
|
+
if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
|
|
10
|
+
t[p[i]] = s[p[i]];
|
|
11
|
+
}
|
|
12
|
+
return t;
|
|
13
|
+
};
|
|
14
|
+
import { featureFlagPrefix, featureFlagContentType } from "@azure/app-configuration";
|
|
15
|
+
import { AjvValidationError, ArgumentError } from "../../errors";
|
|
16
|
+
import * as flat from "flat";
|
|
17
|
+
import { ConfigurationFormat } from "../../enums";
|
|
18
|
+
import { isJsonContentType } from "../utils";
|
|
19
|
+
import { RequirementType } from "../../featureFlag";
|
|
20
|
+
import { Constants } from "../constants";
|
|
21
|
+
import { MsFeatureFlagValueSchema } from "../../MsFeatureFlagSchema";
|
|
22
|
+
import Ajv from "ajv";
|
|
23
|
+
/**
|
|
24
|
+
* Format Parser for common key-value configuration.
|
|
25
|
+
*
|
|
26
|
+
* @internal
|
|
27
|
+
* */
|
|
28
|
+
export class DefaultConfigurationSettingsConverter {
|
|
29
|
+
/**
|
|
30
|
+
* Parse the raw configuration object to collection of ConfigurationSettings
|
|
31
|
+
*
|
|
32
|
+
* @param config Raw configuration object
|
|
33
|
+
* @param options Configuration options to dictate how the configuration be parsed.
|
|
34
|
+
* */
|
|
35
|
+
Convert(config, options) {
|
|
36
|
+
let configurationSettings = new Array();
|
|
37
|
+
let featureFlagsConfigSettings = new Array();
|
|
38
|
+
let foundMsFmSchema = false;
|
|
39
|
+
let foundDotnetFmSchema = false;
|
|
40
|
+
let dotnetFmSchemaKeyWord = "";
|
|
41
|
+
const featureFlagsDict = {};
|
|
42
|
+
if (options.format == ConfigurationFormat.Properties && !options.skipFeatureFlags) {
|
|
43
|
+
this.checkFeatureManagementExist(config);
|
|
44
|
+
}
|
|
45
|
+
for (let i = 0; i < Constants.FeatureManagementKeyWords.length - 1; i++) {
|
|
46
|
+
if (Constants.FeatureManagementKeyWords[i] in config) {
|
|
47
|
+
if (foundDotnetFmSchema) {
|
|
48
|
+
throw new ArgumentError(`Unable to proceed because data contains multiple sections corresponding to Feature Management. with the key, ${Constants.FeatureManagementKeyWords[i]}`);
|
|
49
|
+
}
|
|
50
|
+
foundDotnetFmSchema = true;
|
|
51
|
+
dotnetFmSchemaKeyWord = Constants.FeatureManagementKeyWords[i];
|
|
52
|
+
const dotnetFmSchemaKey = dotnetFmSchemaKeyWord;
|
|
53
|
+
featureFlagsDict[dotnetFmSchemaKey] = config[dotnetFmSchemaKey];
|
|
54
|
+
delete config[dotnetFmSchemaKey];
|
|
55
|
+
}
|
|
56
|
+
}
|
|
57
|
+
const msFeatureManagementKeyWord = Constants.FeatureManagementKeyWords[3];
|
|
58
|
+
if (msFeatureManagementKeyWord in config) {
|
|
59
|
+
if (foundDotnetFmSchema &&
|
|
60
|
+
Object.keys(config[msFeatureManagementKeyWord]).some(key => key !== Constants.FeatureFlagsKeyWord)) {
|
|
61
|
+
throw new ArgumentError(`Unable to proceed because data contains an already defined dotnet schema section with the key, ${dotnetFmSchemaKeyWord}.`);
|
|
62
|
+
}
|
|
63
|
+
if (Object.keys(config[msFeatureManagementKeyWord]).includes(Constants.FeatureFlagsKeyWord)) {
|
|
64
|
+
foundMsFmSchema = true;
|
|
65
|
+
}
|
|
66
|
+
if (Object.keys(config[msFeatureManagementKeyWord]).some(key => key !== Constants.FeatureFlagsKeyWord)) {
|
|
67
|
+
foundDotnetFmSchema = true;
|
|
68
|
+
dotnetFmSchemaKeyWord = msFeatureManagementKeyWord;
|
|
69
|
+
}
|
|
70
|
+
const featureManagementKey = msFeatureManagementKeyWord;
|
|
71
|
+
featureFlagsDict[featureManagementKey] = config[featureManagementKey];
|
|
72
|
+
delete config[featureManagementKey];
|
|
73
|
+
}
|
|
74
|
+
if ((foundDotnetFmSchema || foundMsFmSchema) && !options.skipFeatureFlags) {
|
|
75
|
+
const featureFlagConverter = new FeatureFlagConfigurationSettingsConverter(dotnetFmSchemaKeyWord, foundMsFmSchema);
|
|
76
|
+
featureFlagsConfigSettings = featureFlagConverter.Convert(featureFlagsDict, options);
|
|
77
|
+
}
|
|
78
|
+
const flattenedConfigurationSettings = flat.flatten(config, {
|
|
79
|
+
delimiter: options.separator,
|
|
80
|
+
maxDepth: options.depth,
|
|
81
|
+
safe: isJsonContentType(options.contentType) // preserve array for json content type
|
|
82
|
+
});
|
|
83
|
+
configurationSettings = this.toConfigurationSettings(flattenedConfigurationSettings, options);
|
|
84
|
+
configurationSettings = configurationSettings.concat(featureFlagsConfigSettings);
|
|
85
|
+
return configurationSettings;
|
|
86
|
+
}
|
|
87
|
+
checkFeatureManagementExist(configurations) {
|
|
88
|
+
const keys = Object.keys(configurations);
|
|
89
|
+
for (const featureFlagKeyWord of Constants.FeatureManagementKeyWords) {
|
|
90
|
+
if (keys.find(key => key.startsWith(featureFlagKeyWord))) {
|
|
91
|
+
throw new ArgumentError("Importing feature flag in Properties format is not supported. Anything in the Properties format being imported will be treated as key value.");
|
|
92
|
+
}
|
|
93
|
+
}
|
|
94
|
+
}
|
|
95
|
+
toConfigurationSettings(flatted, options) {
|
|
96
|
+
const result = new Array();
|
|
97
|
+
const isJsonType = isJsonContentType(options.contentType);
|
|
98
|
+
for (const element in flatted) {
|
|
99
|
+
let generateKey = element;
|
|
100
|
+
if (options.prefix) {
|
|
101
|
+
generateKey = options.prefix + element;
|
|
102
|
+
}
|
|
103
|
+
if (generateKey === "." || generateKey === ".." || generateKey.indexOf("%") > -1) {
|
|
104
|
+
throw new ArgumentError("Key cannot be a '.' or '..', or contain the '%' character.");
|
|
105
|
+
}
|
|
106
|
+
if (generateKey.startsWith(featureFlagPrefix)) {
|
|
107
|
+
throw new ArgumentError("Key cannot start with the reserved prefix for feature flags.");
|
|
108
|
+
}
|
|
109
|
+
// Ignore key-value with empty array/object value when content-type is not json, instead of pushing a kv with an empty array/obj
|
|
110
|
+
// For null value it will be treated as "null" string.
|
|
111
|
+
if (!isJsonType && flatted[element] && typeof flatted[element] === "object" && Object.keys(flatted[element]).length == 0) {
|
|
112
|
+
continue;
|
|
113
|
+
}
|
|
114
|
+
const setting = {
|
|
115
|
+
label: options.label,
|
|
116
|
+
tags: options.tags,
|
|
117
|
+
key: generateKey,
|
|
118
|
+
contentType: options.contentType,
|
|
119
|
+
value: typeof flatted[element] === "object" || isJsonType
|
|
120
|
+
? JSON.stringify(flatted[element])
|
|
121
|
+
: flatted[element].toString()
|
|
122
|
+
};
|
|
123
|
+
result.push(setting);
|
|
124
|
+
}
|
|
125
|
+
return result;
|
|
126
|
+
}
|
|
127
|
+
}
|
|
128
|
+
/**
|
|
129
|
+
* ConfigurationSettings converter for feature flag.
|
|
130
|
+
*
|
|
131
|
+
* @internal
|
|
132
|
+
* */
|
|
133
|
+
class FeatureFlagConfigurationSettingsConverter {
|
|
134
|
+
constructor(dotnetFmSchemaKeyWord, foundMsFeatureManagement) {
|
|
135
|
+
this.dotnetFmSchemaKeyWord = dotnetFmSchemaKeyWord;
|
|
136
|
+
this.foundMsFeatureManagement = foundMsFeatureManagement;
|
|
137
|
+
this.ajv = new Ajv();
|
|
138
|
+
if (!this.dotnetFmSchemaKeyWord && !this.foundMsFeatureManagement) {
|
|
139
|
+
throw new ArgumentError("No feature management was found");
|
|
140
|
+
}
|
|
141
|
+
}
|
|
142
|
+
/**
|
|
143
|
+
* @inheritdoc
|
|
144
|
+
* */
|
|
145
|
+
Convert(config, options) {
|
|
146
|
+
var _a;
|
|
147
|
+
const settings = new Array();
|
|
148
|
+
const featureFlags = new Array();
|
|
149
|
+
if (this.dotnetFmSchemaKeyWord) {
|
|
150
|
+
const dotnetSchemaFeatureFlags = this.getDotnetFmSchemaFeatureFlags(config);
|
|
151
|
+
const featureManagementIndex = Constants.FeatureManagementKeyWords.indexOf(this.dotnetFmSchemaKeyWord);
|
|
152
|
+
for (const featureFlag in dotnetSchemaFeatureFlags) {
|
|
153
|
+
if (!this.validateFeatureName(featureFlag)) {
|
|
154
|
+
throw new ArgumentError(`Feature flag ${featureFlag} contains invalid character,'%' and ':' are not allowed in feature name. Please provide valid feature name.`);
|
|
155
|
+
}
|
|
156
|
+
const featureFlagValue = this.getFeatureFlagValueFromDotnetSchema(featureFlag, dotnetSchemaFeatureFlags[featureFlag], Constants.EnabledForKeyWords[featureManagementIndex], Constants.RequirementTypeKeyWords[featureManagementIndex]);
|
|
157
|
+
featureFlags.push(featureFlagValue);
|
|
158
|
+
}
|
|
159
|
+
}
|
|
160
|
+
if (this.foundMsFeatureManagement) {
|
|
161
|
+
const msFmSectionFeatureFlags = this.getMsFmSchemaFeatureFlags(config);
|
|
162
|
+
for (const featureFlag of msFmSectionFeatureFlags) {
|
|
163
|
+
if (!featureFlag.id) {
|
|
164
|
+
throw new ArgumentError("Feature flag without id is found, id is a required property.");
|
|
165
|
+
}
|
|
166
|
+
if (!this.validateFeatureName(featureFlag.id)) {
|
|
167
|
+
throw new ArgumentError(`Feature flag id ${featureFlag.id} contains invalid character,'%' and ':' are not allowed.`);
|
|
168
|
+
}
|
|
169
|
+
const featureFlagValue = this.getFeatureFlagValueFromMsFmSchema(featureFlag);
|
|
170
|
+
// Check if the featureFlag with the same id already exists
|
|
171
|
+
// Replace the existing flag with the later one, the later one always wins
|
|
172
|
+
const indexOfExistingFlag = featureFlags.findIndex(existingFeatureFlag => existingFeatureFlag.id === featureFlag.id);
|
|
173
|
+
if (indexOfExistingFlag !== -1) {
|
|
174
|
+
featureFlags[indexOfExistingFlag] = featureFlagValue;
|
|
175
|
+
}
|
|
176
|
+
else {
|
|
177
|
+
featureFlags.push(featureFlagValue);
|
|
178
|
+
}
|
|
179
|
+
}
|
|
180
|
+
}
|
|
181
|
+
const prefix = (_a = options.prefix) !== null && _a !== void 0 ? _a : "";
|
|
182
|
+
for (const featureFlag of featureFlags) {
|
|
183
|
+
const setting = {
|
|
184
|
+
key: featureFlagPrefix + prefix + featureFlag.id,
|
|
185
|
+
label: options.label,
|
|
186
|
+
value: featureFlag,
|
|
187
|
+
contentType: featureFlagContentType,
|
|
188
|
+
tags: options.tags
|
|
189
|
+
};
|
|
190
|
+
settings.push(setting);
|
|
191
|
+
}
|
|
192
|
+
return settings;
|
|
193
|
+
}
|
|
194
|
+
validateFeatureName(featureName) {
|
|
195
|
+
if (featureName) {
|
|
196
|
+
const valid = /^[^:%]*$/;
|
|
197
|
+
return valid.test(featureName);
|
|
198
|
+
}
|
|
199
|
+
else {
|
|
200
|
+
return false;
|
|
201
|
+
}
|
|
202
|
+
}
|
|
203
|
+
getFeatureFlagValueFromDotnetSchema(featureFlagName, featureData, enabledForKeyWord, requirementTypeKeyWord) {
|
|
204
|
+
const defaultFeatureConditions = { clientFilters: [] };
|
|
205
|
+
const featureFlagValue = {
|
|
206
|
+
id: featureFlagName,
|
|
207
|
+
description: "",
|
|
208
|
+
enabled: false,
|
|
209
|
+
conditions: {
|
|
210
|
+
clientFilters: []
|
|
211
|
+
}
|
|
212
|
+
};
|
|
213
|
+
if (typeof featureData == "object") {
|
|
214
|
+
const filters = featureData[enabledForKeyWord];
|
|
215
|
+
if (!filters) {
|
|
216
|
+
throw new ArgumentError(`Data contains feature flags in invalid format. Feature flag '${featureFlagName}' must contain '${enabledForKeyWord}' definition or have a true/false value.`);
|
|
217
|
+
}
|
|
218
|
+
if (filters.length != 0) {
|
|
219
|
+
featureFlagValue.enabled = true;
|
|
220
|
+
featureFlagValue.conditions.clientFilters = filters;
|
|
221
|
+
if (featureFlagValue.conditions && featureFlagValue.conditions.clientFilters) {
|
|
222
|
+
for (let i = 0; i < featureFlagValue.conditions.clientFilters.length; i++) {
|
|
223
|
+
const parameters = {};
|
|
224
|
+
//
|
|
225
|
+
// Converting client_filter keys to lower case
|
|
226
|
+
const lowerCaseFilters = this.getLowerCaseFilters(featureFlagValue.conditions.clientFilters[i]);
|
|
227
|
+
const filtersName = lowerCaseFilters["name"];
|
|
228
|
+
const filtersParameters = lowerCaseFilters["parameters"];
|
|
229
|
+
if (filtersName) {
|
|
230
|
+
if (filtersName.toLowerCase() == "alwayson") {
|
|
231
|
+
featureFlagValue.conditions = defaultFeatureConditions;
|
|
232
|
+
break;
|
|
233
|
+
}
|
|
234
|
+
parameters.name = filtersName;
|
|
235
|
+
if (filtersParameters) {
|
|
236
|
+
parameters.parameters = filtersParameters;
|
|
237
|
+
}
|
|
238
|
+
featureFlagValue.conditions.clientFilters[i] = parameters;
|
|
239
|
+
}
|
|
240
|
+
else {
|
|
241
|
+
throw new ArgumentError(`This feature flag '${featureFlagName}' has a filter without the required 'name' property.`);
|
|
242
|
+
}
|
|
243
|
+
}
|
|
244
|
+
}
|
|
245
|
+
}
|
|
246
|
+
const requirementType = featureData[requirementTypeKeyWord];
|
|
247
|
+
if (requirementType) {
|
|
248
|
+
if (this.validateRequirementType(featureFlagName, requirementType)) {
|
|
249
|
+
featureFlagValue.conditions.requirementType = requirementType;
|
|
250
|
+
}
|
|
251
|
+
}
|
|
252
|
+
}
|
|
253
|
+
else if (typeof featureData == "boolean") {
|
|
254
|
+
featureFlagValue.enabled = featureData;
|
|
255
|
+
}
|
|
256
|
+
else {
|
|
257
|
+
throw new ArgumentError(`Data contains feature flags in invalid format. The type of ${featureFlagName} should be either boolean or dictionary.`);
|
|
258
|
+
}
|
|
259
|
+
return featureFlagValue;
|
|
260
|
+
}
|
|
261
|
+
getFeatureFlagValueFromMsFmSchema(featureFlag) {
|
|
262
|
+
var _a, _b, _c;
|
|
263
|
+
const validate = this.ajv.compile(MsFeatureFlagValueSchema);
|
|
264
|
+
const featureFlagCopy = JSON.parse(JSON.stringify(featureFlag)); //deep copy
|
|
265
|
+
// normalize client filters
|
|
266
|
+
if (featureFlagCopy.conditions && featureFlagCopy.conditions.client_filters) {
|
|
267
|
+
for (let i = 0; i < featureFlagCopy.conditions.client_filters.length; i++) {
|
|
268
|
+
featureFlagCopy.conditions.client_filters[i] = this.getLowerCaseFilters(featureFlagCopy.conditions.client_filters[i]);
|
|
269
|
+
}
|
|
270
|
+
}
|
|
271
|
+
const valid = validate(featureFlagCopy);
|
|
272
|
+
if (!valid) {
|
|
273
|
+
const validationError = new AjvValidationError(validate.errors);
|
|
274
|
+
throw new ArgumentError(`Feature flag '${featureFlag.id}' is not in the correct format. ${validationError.getFriendlyMessage()}`);
|
|
275
|
+
}
|
|
276
|
+
const parsedFeatureFlag = Object.assign(Object.assign({}, featureFlag), { conditions: {
|
|
277
|
+
clientFilters: (_b = (_a = featureFlag.conditions) === null || _a === void 0 ? void 0 : _a.client_filters) !== null && _b !== void 0 ? _b : []
|
|
278
|
+
} });
|
|
279
|
+
if (featureFlag.display_name) {
|
|
280
|
+
parsedFeatureFlag.displayName = featureFlag.display_name;
|
|
281
|
+
}
|
|
282
|
+
if ((_c = featureFlag.conditions) === null || _c === void 0 ? void 0 : _c.requirement_type) {
|
|
283
|
+
parsedFeatureFlag.conditions.requirementType = featureFlag.conditions.requirement_type;
|
|
284
|
+
}
|
|
285
|
+
return parsedFeatureFlag;
|
|
286
|
+
}
|
|
287
|
+
getLowerCaseFilters(clientFilter) {
|
|
288
|
+
const keys = Object.keys(clientFilter);
|
|
289
|
+
const lowerCaseFilters = {};
|
|
290
|
+
for (let i = 0; i < keys.length; i++) {
|
|
291
|
+
lowerCaseFilters[keys[i].toLowerCase()] = clientFilter[keys[i]];
|
|
292
|
+
}
|
|
293
|
+
return lowerCaseFilters;
|
|
294
|
+
}
|
|
295
|
+
validateRequirementType(requirement_type, featureFlagName) {
|
|
296
|
+
if (!Object.values(RequirementType).includes(requirement_type)) {
|
|
297
|
+
throw new ArgumentError(`This feature flag '${featureFlagName}' must have any/all requirement type.`);
|
|
298
|
+
}
|
|
299
|
+
return true;
|
|
300
|
+
}
|
|
301
|
+
getMsFmSchemaFeatureFlags(config) {
|
|
302
|
+
const msFeatureManagementKeyWord = Constants.FeatureManagementKeyWords[3];
|
|
303
|
+
const featureManagementKey = msFeatureManagementKeyWord;
|
|
304
|
+
const featureManagementSection = config[featureManagementKey];
|
|
305
|
+
if (typeof featureManagementSection !== "object") {
|
|
306
|
+
throw new ArgumentError(`The ${msFeatureManagementKeyWord} section must be an object.`);
|
|
307
|
+
}
|
|
308
|
+
if (!Array.isArray(featureManagementSection[Constants.FeatureFlagsKeyWord])) {
|
|
309
|
+
throw new ArgumentError(`The ${Constants.FeatureFlagsKeyWord} key within ${msFeatureManagementKeyWord} must be an array.`);
|
|
310
|
+
}
|
|
311
|
+
return featureManagementSection[Constants.FeatureFlagsKeyWord];
|
|
312
|
+
}
|
|
313
|
+
getDotnetFmSchemaFeatureFlags(config) {
|
|
314
|
+
const msFeatureManagementKeyWord = Constants.FeatureManagementKeyWords[3];
|
|
315
|
+
const featureManagementSection = config[this.dotnetFmSchemaKeyWord];
|
|
316
|
+
if (typeof featureManagementSection !== "object") {
|
|
317
|
+
throw new ArgumentError(`The ${this.dotnetFmSchemaKeyWord} section must be an object.`);
|
|
318
|
+
}
|
|
319
|
+
if (this.dotnetFmSchemaKeyWord === msFeatureManagementKeyWord) { //dotnet schema might be nested within msFmSchema
|
|
320
|
+
const _a = featureManagementSection, { feature_flags } = _a, dotnetSchemaFeatureFlags = __rest(_a, ["feature_flags"]);
|
|
321
|
+
return dotnetSchemaFeatureFlags;
|
|
322
|
+
}
|
|
323
|
+
else {
|
|
324
|
+
return featureManagementSection;
|
|
325
|
+
}
|
|
326
|
+
}
|
|
327
|
+
}
|
|
328
|
+
//# sourceMappingURL=defaultConfigurationSettingsConverter.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"defaultConfigurationSettingsConverter.js","sourceRoot":"","sources":["../../../../src/internal/parsers/defaultConfigurationSettingsConverter.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;;;;;;;;;;;;AAElC,OAAO,EAGL,iBAAiB,EACjB,sBAAsB,EACvB,MAAM,0BAA0B,CAAC;AAGlC,OAAO,EAAE,kBAAkB,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAEjE,OAAO,KAAK,IAAI,MAAM,MAAM,CAAC;AAC7B,OAAO,EAAE,mBAAmB,EAAE,MAAM,aAAa,CAAC;AAClD,OAAO,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAC;AAC7C,OAAO,EAAsB,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACxE,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AACzC,OAAO,EAAE,wBAAwB,EAAE,MAAM,2BAA2B,CAAC;AACrE,OAAO,GAAoB,MAAM,KAAK,CAAC;AAEvC;;;;KAIK;AACL,MAAM,OAAO,qCAAqC;IAChD;;;;;SAKK;IACE,OAAO,CACZ,MAAc,EACd,OAAsB;QAEtB,IAAI,qBAAqB,GAAG,IAAI,KAAK,EAElC,CAAC;QAEJ,IAAI,0BAA0B,GAAG,IAAI,KAAK,EAAoD,CAAC;QAC/F,IAAI,eAAe,GAAG,KAAK,CAAC;QAC5B,IAAI,mBAAmB,GAAG,KAAK,CAAC;QAChC,IAAI,qBAAqB,GAAG,EAAE,CAAC;QAE/B,MAAM,gBAAgB,GAAQ,EAAE,CAAC;QAEjC,IAAI,OAAO,CAAC,MAAM,IAAI,mBAAmB,CAAC,UAAU,IAAI,CAAC,OAAO,CAAC,gBAAgB,EAAE;YACjF,IAAI,CAAC,2BAA2B,CAAC,MAAM,CAAC,CAAC;SAC1C;QAED,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,SAAS,CAAC,yBAAyB,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC,EAAE,EAAE;YACvE,IAAI,SAAS,CAAC,yBAAyB,CAAC,CAAC,CAAC,IAAI,MAAM,EAAE;gBACpD,IAAI,mBAAmB,EAAE;oBACvB,MAAM,IAAI,aAAa,CACrB,gHAAgH,SAAS,CAAC,yBAAyB,CAAC,CAAC,CAAC,EAAE,CACzJ,CAAC;iBACH;gBAED,mBAAmB,GAAG,IAAI,CAAC;gBAC3B,qBAAqB,GAAG,SAAS,CAAC,yBAAyB,CAAC,CAAC,CAAC,CAAC;gBAE/D,MAAM,iBAAiB,GAAG,qBAAqC,CAAC;gBAChE,gBAAgB,CAAC,iBAAiB,CAAC,GAAG,MAAM,CAAC,iBAAiB,CAAC,CAAC;gBAChE,OAAO,MAAM,CAAC,iBAAiB,CAAC,CAAC;aAClC;SACF;QAED,MAAM,0BAA0B,GAAG,SAAS,CAAC,yBAAyB,CAAC,CAAC,CAAC,CAAC;QAC1E,IAAI,0BAA0B,IAAI,MAAM,EAAE;YACxC,IAAI,mBAAmB;gBACrB,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,0BAA0C,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,SAAS,CAAC,mBAAmB,CAAC,EAAE;gBACpH,MAAM,IAAI,aAAa,CACrB,kGAAkG,qBAAqB,GAAG,CAC3H,CAAC;aACH;YAED,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,0BAA0C,CAAC,CAAC,CAAC,QAAQ,CAAC,SAAS,CAAC,mBAAmB,CAAC,EAAE;gBAC3G,eAAe,GAAG,IAAI,CAAC;aACxB;YAED,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,0BAA0C,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,SAAS,CAAC,mBAAmB,CAAC,EAAC;gBACrH,mBAAmB,GAAG,IAAI,CAAC;gBAC3B,qBAAqB,GAAG,0BAA0B,CAAC;aACpD;YAED,MAAM,oBAAoB,GAAG,0BAA0C,CAAC;YACxE,gBAAgB,CAAC,oBAAoB,CAAC,GAAG,MAAM,CAAC,oBAAoB,CAAC,CAAC;YACtE,OAAO,MAAM,CAAC,oBAAoB,CAAC,CAAC;SACrC;QAED,IAAI,CAAC,mBAAmB,IAAI,eAAe,CAAC,IAAI,CAAC,OAAO,CAAC,gBAAgB,EAAE;YACzE,MAAM,oBAAoB,GAAG,IAAI,yCAAyC,CACxE,qBAAqB,EACrB,eAAe,CAChB,CAAC;YACF,0BAA0B,GAAG,oBAAoB,CAAC,OAAO,CAAC,gBAAgB,EAAE,OAAO,CAAC,CAAC;SACtF;QAED,MAAM,8BAA8B,GAAW,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE;YAClE,SAAS,EAAE,OAAO,CAAC,SAAS;YAC5B,QAAQ,EAAE,OAAO,CAAC,KAAK;YACvB,IAAI,EAAE,iBAAiB,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,uCAAuC;SACrF,CAAC,CAAC;QACH,qBAAqB,GAAG,IAAI,CAAC,uBAAuB,CAAC,8BAA8B,EAAE,OAAO,CAAC,CAAC;QAC9F,qBAAqB,GAAG,qBAAqB,CAAC,MAAM,CAAC,0BAA0B,CAAC,CAAC;QAEjF,OAAO,qBAAqB,CAAC;IAC/B,CAAC;IAEO,2BAA2B,CAAC,cAAsB;QACxD,MAAM,IAAI,GAAa,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QACnD,KAAK,MAAM,kBAAkB,IAAI,SAAS,CAAC,yBAAyB,EAAE;YACpE,IAAI,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,UAAU,CAAC,kBAAkB,CAAC,CAAC,EAAE;gBACxD,MAAM,IAAI,aAAa,CAAC,8IAA8I,CAAC,CAAC;aACzK;SACF;IACH,CAAC;IAEO,uBAAuB,CAC7B,OAAY,EACZ,OAAsB;QAEtB,MAAM,MAAM,GAAG,IAAI,KAAK,EAAgC,CAAC;QACzD,MAAM,UAAU,GAAG,iBAAiB,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;QAC1D,KAAK,MAAM,OAAO,IAAI,OAAO,EAAE;YAC7B,IAAI,WAAW,GAAW,OAAO,CAAC;YAClC,IAAI,OAAO,CAAC,MAAM,EAAE;gBAClB,WAAW,GAAG,OAAO,CAAC,MAAM,GAAG,OAAO,CAAC;aACxC;YAED,IAAI,WAAW,KAAK,GAAG,IAAI,WAAW,KAAK,IAAI,IAAI,WAAW,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,EAAE;gBAChF,MAAM,IAAI,aAAa,CAAC,4DAA4D,CAAC,CAAC;aACvF;YACD,IAAI,WAAW,CAAC,UAAU,CAAC,iBAAiB,CAAC,EAAE;gBAC7C,MAAM,IAAI,aAAa,CAAC,8DAA8D,CAAC,CAAC;aACzF;YAED,gIAAgI;YAChI,sDAAsD;YACtD,IAAI,CAAC,UAAU,IAAI,OAAO,CAAC,OAAO,CAAC,IAAI,OAAO,OAAO,CAAC,OAAO,CAAC,KAAK,QAAQ,IAAI,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,IAAI,CAAC,EAAG;gBACzH,SAAS;aACV;YAED,MAAM,OAAO,GAAyC;gBACpD,KAAK,EAAE,OAAO,CAAC,KAAK;gBACpB,IAAI,EAAE,OAAO,CAAC,IAAI;gBAClB,GAAG,EAAE,WAAW;gBAChB,WAAW,EAAE,OAAO,CAAC,WAAW;gBAChC,KAAK,EACH,OAAO,OAAO,CAAC,OAAO,CAAC,KAAK,QAAQ,IAAI,UAAU;oBAChD,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;oBAClC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE;aAClC,CAAC;YAEF,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;SACtB;QAED,OAAO,MAAM,CAAC;IAChB,CAAC;CACF;AAED;;;;KAIK;AACL,MAAM,yCAAyC;IAK7C,YAAY,qBAA6B,EAAE,wBAAiC;QAC1E,IAAI,CAAC,qBAAqB,GAAG,qBAAqB,CAAC;QACnD,IAAI,CAAC,wBAAwB,GAAG,wBAAwB,CAAC;QACzD,IAAI,CAAC,GAAG,GAAG,IAAI,GAAG,EAAE,CAAC;QAErB,IAAI,CAAC,IAAI,CAAC,qBAAqB,IAAI,CAAC,IAAI,CAAC,wBAAwB,EAAE;YACjE,MAAM,IAAI,aAAa,CAAC,iCAAiC,CAAC,CAAC;SAC5D;IACH,CAAC;IAED;;SAEK;IACL,OAAO,CACL,MAAc,EACd,OAAsB;;QAEtB,MAAM,QAAQ,GAAG,IAAI,KAAK,EAAoD,CAAC;QAC/E,MAAM,YAAY,GAAG,IAAI,KAAK,EAAsB,CAAC;QAErD,IAAI,IAAI,CAAC,qBAAqB,EAAE;YAC9B,MAAM,wBAAwB,GAAG,IAAI,CAAC,6BAA6B,CAAC,MAAM,CAAC,CAAC;YAE5E,MAAM,sBAAsB,GAAW,SAAS,CAAC,yBAAyB,CAAC,OAAO,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC;YAE/G,KAAK,MAAM,WAAW,IAAI,wBAAwB,EAAE;gBAClD,IAAI,CAAC,IAAI,CAAC,mBAAmB,CAAC,WAAW,CAAC,EAAE;oBAC1C,MAAM,IAAI,aAAa,CACrB,gBAAgB,WAAW,6GAA6G,CACzI,CAAC;iBACH;gBAED,MAAM,gBAAgB,GAAG,IAAI,CAAC,mCAAmC,CAC/D,WAAW,EACX,wBAAwB,CAAC,WAAW,CAAC,EACrC,SAAS,CAAC,kBAAkB,CAAC,sBAAsB,CAAC,EACpD,SAAS,CAAC,uBAAuB,CAAC,sBAAsB,CAAC,CAC1D,CAAC;gBAEF,YAAY,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;aACrC;SACF;QAED,IAAI,IAAI,CAAC,wBAAwB,EAAE;YACjC,MAAM,uBAAuB,GAAG,IAAI,CAAC,yBAAyB,CAAC,MAAM,CAAC,CAAC;YAEvE,KAAK,MAAM,WAAW,IAAI,uBAAuB,EAAE;gBACjD,IAAI,CAAC,WAAW,CAAC,EAAE,EAAE;oBACnB,MAAM,IAAI,aAAa,CACrB,8DAA8D,CAC/D,CAAC;iBACH;gBAED,IAAI,CAAC,IAAI,CAAC,mBAAmB,CAAC,WAAW,CAAC,EAAE,CAAC,EAAE;oBAC7C,MAAM,IAAI,aAAa,CACrB,mBAAmB,WAAW,CAAC,EAAE,0DAA0D,CAC5F,CAAC;iBACH;gBAED,MAAM,gBAAgB,GAAG,IAAI,CAAC,iCAAiC,CAAC,WAAW,CAAC,CAAC;gBAE7E,2DAA2D;gBAC3D,0EAA0E;gBAC1E,MAAM,mBAAmB,GAAG,YAAY,CAAC,SAAS,CAAC,mBAAmB,CAAC,EAAE,CAAC,mBAAmB,CAAC,EAAE,KAAK,WAAW,CAAC,EAAE,CAAC,CAAC;gBAErH,IAAI,mBAAmB,KAAK,CAAC,CAAC,EAAE;oBAC9B,YAAY,CAAC,mBAAmB,CAAC,GAAG,gBAAgB,CAAC;iBACtD;qBACI;oBACH,YAAY,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;iBACrC;aACF;SACF;QAED,MAAM,MAAM,GAAW,MAAA,OAAO,CAAC,MAAM,mCAAI,EAAE,CAAC;QAC5C,KAAK,MAAM,WAAW,IAAI,YAAY,EAAE;YACtC,MAAM,OAAO,GAAqD;gBAChE,GAAG,EAAE,iBAAiB,GAAG,MAAM,GAAG,WAAW,CAAC,EAAE;gBAChD,KAAK,EAAE,OAAO,CAAC,KAAK;gBACpB,KAAK,EAAE,WAAW;gBAClB,WAAW,EAAE,sBAAsB;gBACnC,IAAI,EAAE,OAAO,CAAC,IAAI;aACnB,CAAC;YAEF,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;SACxB;QAED,OAAO,QAAQ,CAAC;IAClB,CAAC;IAEO,mBAAmB,CAAC,WAAmB;QAC7C,IAAI,WAAW,EAAE;YACf,MAAM,KAAK,GAAG,UAAU,CAAC;YACzB,OAAO,KAAK,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;SAChC;aACI;YACH,OAAO,KAAK,CAAC;SACd;IACH,CAAC;IAEO,mCAAmC,CACzC,eAAuB,EACvB,WAAgB,EAChB,iBAAyB,EACzB,sBAA8B;QAE9B,MAAM,wBAAwB,GAAG,EAAE,aAAa,EAAE,EAAE,EAAE,CAAC;QAEvD,MAAM,gBAAgB,GAAuB;YAC3C,EAAE,EAAE,eAAe;YACnB,WAAW,EAAE,EAAE;YACf,OAAO,EAAE,KAAK;YACd,UAAU,EAAE;gBACV,aAAa,EAAE,EAAE;aAClB;SACF,CAAC;QAEF,IAAI,OAAO,WAAW,IAAI,QAAQ,EAAE;YAClC,MAAM,OAAO,GAAG,WAAW,CAAC,iBAAiB,CAAC,CAAC;YAE/C,IAAI,CAAC,OAAO,EAAE;gBACZ,MAAM,IAAI,aAAa,CACrB,gEAAgE,eAAe,mBAAmB,iBAAiB,0CAA0C,CAC9J,CAAC;aACH;YAED,IAAI,OAAO,CAAC,MAAM,IAAI,CAAC,EAAE;gBACvB,gBAAgB,CAAC,OAAO,GAAG,IAAI,CAAC;gBAChC,gBAAgB,CAAC,UAAU,CAAC,aAAa,GAAG,OAAO,CAAC;gBAEpD,IAAI,gBAAgB,CAAC,UAAU,IAAI,gBAAgB,CAAC,UAAU,CAAC,aAAa,EAAE;oBAC5E,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,gBAAgB,CAAC,UAAU,CAAC,aAAa,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;wBACzE,MAAM,UAAU,GAA0B,EAAE,CAAC;wBAC7C,EAAE;wBACF,8CAA8C;wBAC9C,MAAM,gBAAgB,GAAG,IAAI,CAAC,mBAAmB,CAC/C,gBAAgB,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC,CAAC,CAC7C,CAAC;wBAEF,MAAM,WAAW,GAAG,gBAAgB,CAAC,MAAM,CAAC,CAAC;wBAC7C,MAAM,iBAAiB,GAAG,gBAAgB,CAAC,YAAY,CAAC,CAAC;wBAEzD,IAAI,WAAW,EAAE;4BACf,IAAI,WAAW,CAAC,WAAW,EAAE,IAAI,UAAU,EAAE;gCAC3C,gBAAgB,CAAC,UAAU,GAAG,wBAAwB,CAAC;gCACvD,MAAM;6BACP;4BACD,UAAU,CAAC,IAAI,GAAG,WAAW,CAAC;4BAC9B,IAAI,iBAAiB,EAAE;gCACrB,UAAU,CAAC,UAAU,GAAG,iBAAiB,CAAC;6BAC3C;4BAED,gBAAgB,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC,CAAC,GAAG,UAA0B,CAAC;yBAC3E;6BACI;4BACH,MAAM,IAAI,aAAa,CACrB,sBAAsB,eAAe,sDAAsD,CAC5F,CAAC;yBACH;qBACF;iBACF;aACF;YAED,MAAM,eAAe,GAAG,WAAW,CAAC,sBAAsB,CAAC,CAAC;YAE5D,IAAI,eAAe,EAAE;gBACnB,IAAI,IAAI,CAAC,uBAAuB,CAAC,eAAe,EAAE,eAAe,CAAC,EAAE;oBAClE,gBAAgB,CAAC,UAAU,CAAC,eAAe,GAAG,eAAe,CAAC;iBAC/D;aACF;SACF;aACI,IAAI,OAAO,WAAW,IAAI,SAAS,EAAE;YACxC,gBAAgB,CAAC,OAAO,GAAG,WAAW,CAAC;SACxC;aACI;YACH,MAAM,IAAI,aAAa,CACrB,8DAA8D,eAAe,0CAA0C,CACxH,CAAC;SACH;QAED,OAAO,gBAAgB,CAAC;IAC1B,CAAC;IAEO,iCAAiC,CAAC,WAAgB;;QACxD,MAAM,QAAQ,GAAG,IAAI,CAAC,GAAG,CAAC,OAAO,CAAqB,wBAAwB,CAAC,CAAC;QAChF,MAAM,eAAe,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,WAAW;QAE5E,2BAA2B;QAC3B,IAAI,eAAe,CAAC,UAAU,IAAI,eAAe,CAAC,UAAU,CAAC,cAAc,EAAE;YAC3E,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,eAAe,CAAC,UAAU,CAAC,cAAc,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;gBACzE,eAAe,CAAC,UAAU,CAAC,cAAc,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,mBAAmB,CAAC,eAAe,CAAC,UAAU,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,CAAC;aACvH;SACF;QAED,MAAM,KAAK,GAAG,QAAQ,CAAC,eAAe,CAAC,CAAC;QACxC,IAAI,CAAC,KAAK,EAAE;YACV,MAAM,eAAe,GAAG,IAAI,kBAAkB,CAAC,QAAQ,CAAC,MAAuB,CAAC,CAAC;YACjF,MAAM,IAAI,aAAa,CAAC,iBAAiB,WAAW,CAAC,EAAE,mCAAmC,eAAe,CAAC,kBAAkB,EAAE,EAAE,CAAC,CAAC;SACnI;QAED,MAAM,iBAAiB,mCAClB,WAAW,KACd,UAAU,EAAE;gBACV,aAAa,EAAE,MAAA,MAAA,WAAW,CAAC,UAAU,0CAAE,cAAc,mCAAI,EAAE;aAC5D,GACF,CAAC;QAEF,IAAI,WAAW,CAAC,YAAY,EAAE;YAC5B,iBAAiB,CAAC,WAAW,GAAG,WAAW,CAAC,YAAY,CAAC;SAC1D;QAED,IAAI,MAAA,WAAW,CAAC,UAAU,0CAAE,gBAAgB,EAAE;YAC5C,iBAAiB,CAAC,UAAU,CAAC,eAAe,GAAG,WAAW,CAAC,UAAU,CAAC,gBAAgB,CAAC;SACxF;QAED,OAAO,iBAAiB,CAAC;IAC3B,CAAC;IAEO,mBAAmB,CAAC,YAA0B;QACpD,MAAM,IAAI,GAAkB,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QACtD,MAAM,gBAAgB,GAA2B,EAAE,CAAC;QAEpD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;YACpC,gBAAgB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,GAAG,YAAY,CAAC,IAAI,CAAC,CAAC,CAAiB,CAAC,CAAC;SACjF;QAED,OAAO,gBAAgB,CAAC;IAC1B,CAAC;IAEO,uBAAuB,CAAC,gBAAqB,EAAE,eAAuB;QAC5E,IAAG,CAAC,MAAM,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC,QAAQ,CAAC,gBAAgB,CAAC,EAAC;YAC5D,MAAM,IAAI,aAAa,CACrB,sBAAsB,eAAe,uCAAuC,CAC7E,CAAC;SACH;QAED,OAAO,IAAI,CAAC;IACd,CAAC;IAEO,yBAAyB,CAAC,MAAc;QAC9C,MAAM,0BAA0B,GAAG,SAAS,CAAC,yBAAyB,CAAC,CAAC,CAAC,CAAC;QAC1E,MAAM,oBAAoB,GAAI,0BAA0C,CAAC;QACzE,MAAM,wBAAwB,GAAG,MAAM,CAAC,oBAAoB,CAAC,CAAC;QAE9D,IAAI,OAAO,wBAAwB,KAAK,QAAQ,EAAE;YAChD,MAAM,IAAI,aAAa,CAAC,OAAO,0BAA0B,6BAA6B,CAAC,CAAC;SACzF;QAED,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,wBAAwB,CAAC,SAAS,CAAC,mBAAmB,CAAC,CAAC,EAAE;YAC3E,MAAM,IAAI,aAAa,CAAC,OAAO,SAAS,CAAC,mBAAmB,eAAe,0BAA0B,oBAAoB,CAAC,CAAC;SAC5H;QAED,OAAO,wBAAwB,CAAC,SAAS,CAAC,mBAAmB,CAAC,CAAC;IACjE,CAAC;IAEO,6BAA6B,CAAC,MAAc;QAClD,MAAM,0BAA0B,GAAG,SAAS,CAAC,yBAAyB,CAAC,CAAC,CAAC,CAAC;QAC1E,MAAM,wBAAwB,GAAW,MAAM,CAAC,IAAI,CAAC,qBAAqC,CAAC,CAAC;QAE5F,IAAI,OAAO,wBAAwB,KAAK,QAAQ,EAAE;YAChD,MAAM,IAAI,aAAa,CAAC,OAAO,IAAI,CAAC,qBAAqB,6BAA6B,CAAC,CAAC;SACzF;QAED,IAAI,IAAI,CAAC,qBAAqB,KAAK,0BAA0B,EAAE,EAAE,iDAAiD;YAChH,MAAM,KAAiD,wBAAkD,EAAnG,EAAE,aAAa,OAAoF,EAA/E,wBAAwB,cAA5C,iBAA8C,CAAqD,CAAC;YAC1G,OAAO,wBAAwB,CAAC;SACjC;aACI;YACH,OAAO,wBAAwB,CAAC;SACjC;IACH,CAAC;CACF","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\nimport {\n SetConfigurationSettingParam,\n SecretReferenceValue,\n featureFlagPrefix,\n featureFlagContentType\n} from \"@azure/app-configuration\";\nimport { SourceOptions } from \"../../importOptions\";\nimport { ConfigurationSettingsConverter } from \"./configurationSettingsConverter\";\nimport { AjvValidationError, ArgumentError } from \"../../errors\";\nimport { ClientFilter } from \"../../models\";\nimport * as flat from \"flat\";\nimport { ConfigurationFormat } from \"../../enums\";\nimport { isJsonContentType } from \"../utils\";\nimport { MsFeatureFlagValue, RequirementType } from \"../../featureFlag\";\nimport { Constants } from \"../constants\";\nimport { MsFeatureFlagValueSchema } from \"../../MsFeatureFlagSchema\";\nimport Ajv, { ErrorObject } from \"ajv\";\n\n/**\n * Format Parser for common key-value configuration.\n *\n * @internal\n * */\nexport class DefaultConfigurationSettingsConverter implements ConfigurationSettingsConverter {\n /**\n * Parse the raw configuration object to collection of ConfigurationSettings\n *\n * @param config Raw configuration object\n * @param options Configuration options to dictate how the configuration be parsed.\n * */\n public Convert(\n config: object,\n options: SourceOptions\n ): SetConfigurationSettingParam<string | MsFeatureFlagValue | SecretReferenceValue>[] {\n let configurationSettings = new Array<\n SetConfigurationSettingParam<string | MsFeatureFlagValue>\n >();\n\n let featureFlagsConfigSettings = new Array<SetConfigurationSettingParam<MsFeatureFlagValue>>();\n let foundMsFmSchema = false;\n let foundDotnetFmSchema = false;\n let dotnetFmSchemaKeyWord = \"\";\n\n const featureFlagsDict: any = {};\n\n if (options.format == ConfigurationFormat.Properties && !options.skipFeatureFlags) {\n this.checkFeatureManagementExist(config);\n }\n\n for (let i = 0; i < Constants.FeatureManagementKeyWords.length - 1; i++) {\n if (Constants.FeatureManagementKeyWords[i] in config) {\n if (foundDotnetFmSchema) {\n throw new ArgumentError(\n `Unable to proceed because data contains multiple sections corresponding to Feature Management. with the key, ${Constants.FeatureManagementKeyWords[i]}`\n );\n }\n \n foundDotnetFmSchema = true;\n dotnetFmSchemaKeyWord = Constants.FeatureManagementKeyWords[i];\n\n const dotnetFmSchemaKey = dotnetFmSchemaKeyWord as keyof object;\n featureFlagsDict[dotnetFmSchemaKey] = config[dotnetFmSchemaKey];\n delete config[dotnetFmSchemaKey];\n }\n }\n\n const msFeatureManagementKeyWord = Constants.FeatureManagementKeyWords[3];\n if (msFeatureManagementKeyWord in config) {\n if (foundDotnetFmSchema &&\n Object.keys(config[msFeatureManagementKeyWord as keyof object]).some(key => key !== Constants.FeatureFlagsKeyWord)) {\n throw new ArgumentError(\n `Unable to proceed because data contains an already defined dotnet schema section with the key, ${dotnetFmSchemaKeyWord}.`\n );\n }\n\n if (Object.keys(config[msFeatureManagementKeyWord as keyof object]).includes(Constants.FeatureFlagsKeyWord)) {\n foundMsFmSchema = true;\n }\n\n if (Object.keys(config[msFeatureManagementKeyWord as keyof object]).some(key => key !== Constants.FeatureFlagsKeyWord)){\n foundDotnetFmSchema = true;\n dotnetFmSchemaKeyWord = msFeatureManagementKeyWord;\n }\n\n const featureManagementKey = msFeatureManagementKeyWord as keyof object;\n featureFlagsDict[featureManagementKey] = config[featureManagementKey];\n delete config[featureManagementKey];\n }\n\n if ((foundDotnetFmSchema || foundMsFmSchema) && !options.skipFeatureFlags) {\n const featureFlagConverter = new FeatureFlagConfigurationSettingsConverter(\n dotnetFmSchemaKeyWord,\n foundMsFmSchema\n );\n featureFlagsConfigSettings = featureFlagConverter.Convert(featureFlagsDict, options);\n }\n\n const flattenedConfigurationSettings: object = flat.flatten(config, {\n delimiter: options.separator,\n maxDepth: options.depth,\n safe: isJsonContentType(options.contentType) // preserve array for json content type\n });\n configurationSettings = this.toConfigurationSettings(flattenedConfigurationSettings, options);\n configurationSettings = configurationSettings.concat(featureFlagsConfigSettings);\n\n return configurationSettings;\n }\n\n private checkFeatureManagementExist(configurations: object): void {\n const keys: string[] = Object.keys(configurations);\n for (const featureFlagKeyWord of Constants.FeatureManagementKeyWords) {\n if (keys.find(key => key.startsWith(featureFlagKeyWord))) {\n throw new ArgumentError(\"Importing feature flag in Properties format is not supported. Anything in the Properties format being imported will be treated as key value.\");\n }\n }\n }\n\n private toConfigurationSettings(\n flatted: any,\n options: SourceOptions\n ): Array<SetConfigurationSettingParam<string>> {\n const result = new Array<SetConfigurationSettingParam>();\n const isJsonType = isJsonContentType(options.contentType);\n for (const element in flatted) {\n let generateKey: string = element;\n if (options.prefix) {\n generateKey = options.prefix + element;\n }\n\n if (generateKey === \".\" || generateKey === \"..\" || generateKey.indexOf(\"%\") > -1) {\n throw new ArgumentError(\"Key cannot be a '.' or '..', or contain the '%' character.\");\n }\n if (generateKey.startsWith(featureFlagPrefix)) {\n throw new ArgumentError(\"Key cannot start with the reserved prefix for feature flags.\");\n }\n\n // Ignore key-value with empty array/object value when content-type is not json, instead of pushing a kv with an empty array/obj\n // For null value it will be treated as \"null\" string.\n if (!isJsonType && flatted[element] && typeof flatted[element] === \"object\" && Object.keys(flatted[element]).length == 0 ) {\n continue;\n }\n\n const setting: SetConfigurationSettingParam<string> = {\n label: options.label,\n tags: options.tags,\n key: generateKey,\n contentType: options.contentType,\n value:\n typeof flatted[element] === \"object\" || isJsonType\n ? JSON.stringify(flatted[element])\n : flatted[element].toString()\n };\n\n result.push(setting);\n }\n\n return result;\n }\n}\n\n/**\n * ConfigurationSettings converter for feature flag.\n *\n * @internal\n * */\nclass FeatureFlagConfigurationSettingsConverter implements ConfigurationSettingsConverter {\n dotnetFmSchemaKeyWord: string;\n foundMsFeatureManagement: boolean;\n ajv: Ajv;\n\n constructor(dotnetFmSchemaKeyWord: string, foundMsFeatureManagement: boolean) {\n this.dotnetFmSchemaKeyWord = dotnetFmSchemaKeyWord;\n this.foundMsFeatureManagement = foundMsFeatureManagement;\n this.ajv = new Ajv();\n\n if (!this.dotnetFmSchemaKeyWord && !this.foundMsFeatureManagement) {\n throw new ArgumentError(\"No feature management was found\");\n }\n }\n\n /**\n * @inheritdoc\n * */\n Convert(\n config: object,\n options: SourceOptions\n ): SetConfigurationSettingParam<MsFeatureFlagValue>[] {\n const settings = new Array<SetConfigurationSettingParam<MsFeatureFlagValue>>();\n const featureFlags = new Array<MsFeatureFlagValue>();\n\n if (this.dotnetFmSchemaKeyWord) {\n const dotnetSchemaFeatureFlags = this.getDotnetFmSchemaFeatureFlags(config);\n\n const featureManagementIndex: number = Constants.FeatureManagementKeyWords.indexOf(this.dotnetFmSchemaKeyWord);\n\n for (const featureFlag in dotnetSchemaFeatureFlags) {\n if (!this.validateFeatureName(featureFlag)) {\n throw new ArgumentError(\n `Feature flag ${featureFlag} contains invalid character,'%' and ':' are not allowed in feature name. Please provide valid feature name.`\n );\n }\n\n const featureFlagValue = this.getFeatureFlagValueFromDotnetSchema(\n featureFlag,\n dotnetSchemaFeatureFlags[featureFlag],\n Constants.EnabledForKeyWords[featureManagementIndex],\n Constants.RequirementTypeKeyWords[featureManagementIndex]\n );\n\n featureFlags.push(featureFlagValue);\n }\n }\n\n if (this.foundMsFeatureManagement) {\n const msFmSectionFeatureFlags = this.getMsFmSchemaFeatureFlags(config);\n\n for (const featureFlag of msFmSectionFeatureFlags) {\n if (!featureFlag.id) {\n throw new ArgumentError(\n \"Feature flag without id is found, id is a required property.\"\n );\n }\n\n if (!this.validateFeatureName(featureFlag.id)) {\n throw new ArgumentError(\n `Feature flag id ${featureFlag.id} contains invalid character,'%' and ':' are not allowed.`\n );\n }\n\n const featureFlagValue = this.getFeatureFlagValueFromMsFmSchema(featureFlag);\n\n // Check if the featureFlag with the same id already exists\n // Replace the existing flag with the later one, the later one always wins\n const indexOfExistingFlag = featureFlags.findIndex(existingFeatureFlag => existingFeatureFlag.id === featureFlag.id);\n\n if (indexOfExistingFlag !== -1) {\n featureFlags[indexOfExistingFlag] = featureFlagValue;\n }\n else {\n featureFlags.push(featureFlagValue);\n }\n }\n }\n\n const prefix: string = options.prefix ?? \"\";\n for (const featureFlag of featureFlags) {\n const setting: SetConfigurationSettingParam<MsFeatureFlagValue> = {\n key: featureFlagPrefix + prefix + featureFlag.id,\n label: options.label,\n value: featureFlag,\n contentType: featureFlagContentType,\n tags: options.tags\n };\n\n settings.push(setting);\n }\n\n return settings;\n }\n\n private validateFeatureName(featureName: string): boolean {\n if (featureName) {\n const valid = /^[^:%]*$/;\n return valid.test(featureName);\n }\n else {\n return false;\n }\n }\n\n private getFeatureFlagValueFromDotnetSchema(\n featureFlagName: string,\n featureData: any,\n enabledForKeyWord: string,\n requirementTypeKeyWord: string\n ): MsFeatureFlagValue {\n const defaultFeatureConditions = { clientFilters: [] };\n\n const featureFlagValue: MsFeatureFlagValue = {\n id: featureFlagName,\n description: \"\",\n enabled: false,\n conditions: {\n clientFilters: []\n }\n };\n\n if (typeof featureData == \"object\") {\n const filters = featureData[enabledForKeyWord];\n\n if (!filters) {\n throw new ArgumentError(\n `Data contains feature flags in invalid format. Feature flag '${featureFlagName}' must contain '${enabledForKeyWord}' definition or have a true/false value.`\n );\n }\n\n if (filters.length != 0) {\n featureFlagValue.enabled = true;\n featureFlagValue.conditions.clientFilters = filters;\n\n if (featureFlagValue.conditions && featureFlagValue.conditions.clientFilters) {\n for (let i = 0; i < featureFlagValue.conditions.clientFilters.length; i++) {\n const parameters: Partial<ClientFilter> = {};\n //\n // Converting client_filter keys to lower case\n const lowerCaseFilters = this.getLowerCaseFilters(\n featureFlagValue.conditions.clientFilters[i]\n );\n\n const filtersName = lowerCaseFilters[\"name\"];\n const filtersParameters = lowerCaseFilters[\"parameters\"];\n\n if (filtersName) {\n if (filtersName.toLowerCase() == \"alwayson\") {\n featureFlagValue.conditions = defaultFeatureConditions;\n break;\n }\n parameters.name = filtersName;\n if (filtersParameters) {\n parameters.parameters = filtersParameters;\n }\n\n featureFlagValue.conditions.clientFilters[i] = parameters as ClientFilter;\n }\n else {\n throw new ArgumentError(\n `This feature flag '${featureFlagName}' has a filter without the required 'name' property.`\n );\n }\n }\n }\n }\n\n const requirementType = featureData[requirementTypeKeyWord];\n\n if (requirementType) {\n if (this.validateRequirementType(featureFlagName, requirementType)) {\n featureFlagValue.conditions.requirementType = requirementType;\n }\n }\n }\n else if (typeof featureData == \"boolean\") {\n featureFlagValue.enabled = featureData;\n }\n else {\n throw new ArgumentError(\n `Data contains feature flags in invalid format. The type of ${featureFlagName} should be either boolean or dictionary.`\n );\n }\n\n return featureFlagValue;\n }\n\n private getFeatureFlagValueFromMsFmSchema(featureFlag: any): MsFeatureFlagValue {\n const validate = this.ajv.compile<MsFeatureFlagValue>(MsFeatureFlagValueSchema);\n const featureFlagCopy = JSON.parse(JSON.stringify(featureFlag)); //deep copy\n\n // normalize client filters\n if (featureFlagCopy.conditions && featureFlagCopy.conditions.client_filters) {\n for (let i = 0; i < featureFlagCopy.conditions.client_filters.length; i++) {\n featureFlagCopy.conditions.client_filters[i] = this.getLowerCaseFilters(featureFlagCopy.conditions.client_filters[i]);\n }\n }\n\n const valid = validate(featureFlagCopy);\n if (!valid) {\n const validationError = new AjvValidationError(validate.errors as ErrorObject[]);\n throw new ArgumentError(`Feature flag '${featureFlag.id}' is not in the correct format. ${validationError.getFriendlyMessage()}`);\n }\n\n const parsedFeatureFlag: MsFeatureFlagValue = {\n ...featureFlag,\n conditions: {\n clientFilters: featureFlag.conditions?.client_filters ?? []\n }\n };\n\n if (featureFlag.display_name) {\n parsedFeatureFlag.displayName = featureFlag.display_name;\n }\n\n if (featureFlag.conditions?.requirement_type) {\n parsedFeatureFlag.conditions.requirementType = featureFlag.conditions.requirement_type;\n }\n\n return parsedFeatureFlag;\n }\n\n private getLowerCaseFilters(clientFilter: ClientFilter): { [key: string]: any } {\n const keys: Array<string> = Object.keys(clientFilter);\n const lowerCaseFilters: { [key: string]: any } = {};\n\n for (let i = 0; i < keys.length; i++) {\n lowerCaseFilters[keys[i].toLowerCase()] = clientFilter[keys[i] as keyof object];\n }\n\n return lowerCaseFilters;\n }\n\n private validateRequirementType(requirement_type: any, featureFlagName: string) {\n if(!Object.values(RequirementType).includes(requirement_type)){\n throw new ArgumentError(\n `This feature flag '${featureFlagName}' must have any/all requirement type.`\n );\n }\n\n return true;\n }\n\n private getMsFmSchemaFeatureFlags(config: object): Array<{ [key: string]: any }>{\n const msFeatureManagementKeyWord = Constants.FeatureManagementKeyWords[3];\n const featureManagementKey = msFeatureManagementKeyWord as keyof object;\n const featureManagementSection = config[featureManagementKey];\n\n if (typeof featureManagementSection !== \"object\") {\n throw new ArgumentError(`The ${msFeatureManagementKeyWord} section must be an object.`);\n }\n\n if (!Array.isArray(featureManagementSection[Constants.FeatureFlagsKeyWord])) {\n throw new ArgumentError(`The ${Constants.FeatureFlagsKeyWord} key within ${msFeatureManagementKeyWord} must be an array.`);\n }\n\n return featureManagementSection[Constants.FeatureFlagsKeyWord];\n }\n\n private getDotnetFmSchemaFeatureFlags(config: object): { [key: string]: any } {\n const msFeatureManagementKeyWord = Constants.FeatureManagementKeyWords[3];\n const featureManagementSection: object = config[this.dotnetFmSchemaKeyWord as keyof object];\n\n if (typeof featureManagementSection !== \"object\") {\n throw new ArgumentError(`The ${this.dotnetFmSchemaKeyWord} section must be an object.`);\n }\n\n if (this.dotnetFmSchemaKeyWord === msFeatureManagementKeyWord) { //dotnet schema might be nested within msFmSchema\n const { feature_flags, ...dotnetSchemaFeatureFlags } = featureManagementSection as { [key: string]: any };\n return dotnetSchemaFeatureFlags;\n }\n else {\n return featureManagementSection;\n }\n }\n}\n"]}
|
|
@@ -0,0 +1,66 @@
|
|
|
1
|
+
// Copyright (c) Microsoft Corporation.
|
|
2
|
+
// Licensed under the MIT license.
|
|
3
|
+
import { featureFlagPrefix, featureFlagContentType } from "@azure/app-configuration";
|
|
4
|
+
import { ArgumentError } from "../../errors";
|
|
5
|
+
/**
|
|
6
|
+
* Format Parser for kvset profile.
|
|
7
|
+
*
|
|
8
|
+
* @internal
|
|
9
|
+
* */
|
|
10
|
+
export class KvSetConfigurationSettingsConverter {
|
|
11
|
+
/**
|
|
12
|
+
* @inheritdoc
|
|
13
|
+
* */
|
|
14
|
+
Convert(config) {
|
|
15
|
+
const configurationSettings = new Array();
|
|
16
|
+
const itemsKeyword = "items";
|
|
17
|
+
if (!(itemsKeyword in config) || !Array.isArray(config[itemsKeyword])) {
|
|
18
|
+
throw new ArgumentError("The input data doesn't follow the KVSet file schema. See https://github.com/Azure/AppConfiguration/blob/main/docs/KVSet/KVSet.v1.0.0.schema.json");
|
|
19
|
+
}
|
|
20
|
+
const items = config[itemsKeyword];
|
|
21
|
+
for (let index = 0; index < items.length; index++) {
|
|
22
|
+
const element = items[index];
|
|
23
|
+
this.validateKvSetElement(element);
|
|
24
|
+
configurationSettings.push({
|
|
25
|
+
key: element.key,
|
|
26
|
+
value: element.value,
|
|
27
|
+
label: element.label,
|
|
28
|
+
contentType: element.content_type,
|
|
29
|
+
tags: element.tags
|
|
30
|
+
});
|
|
31
|
+
}
|
|
32
|
+
return configurationSettings;
|
|
33
|
+
}
|
|
34
|
+
validateKvSetElement(element) {
|
|
35
|
+
if (!element.key) {
|
|
36
|
+
throw new ArgumentError("Configuration key is required, cannot be an empty string");
|
|
37
|
+
}
|
|
38
|
+
if (typeof element.key !== "string") {
|
|
39
|
+
throw new ArgumentError(`Invalid key '${element.key}', key must be a string`);
|
|
40
|
+
}
|
|
41
|
+
if (element.key === "." || element.key === ".." || element.key.indexOf("%") > -1) {
|
|
42
|
+
throw new ArgumentError("Key cannot be a '.' or '..', or contain the '%' character.");
|
|
43
|
+
}
|
|
44
|
+
if (element.key.startsWith(featureFlagPrefix) && element.content_type !== featureFlagContentType) {
|
|
45
|
+
throw new ArgumentError(`Invalid key '${element.key}'. Key cannot start with the reserved prefix for feature flags.`);
|
|
46
|
+
}
|
|
47
|
+
if (element.value && typeof element.value !== "string") {
|
|
48
|
+
throw new ArgumentError(`The 'value' for the key '${element.key}' is not a string.`);
|
|
49
|
+
}
|
|
50
|
+
if (element.content_type && typeof element.content_type !== "string") {
|
|
51
|
+
throw new ArgumentError(`The 'content_type' for the key '${element.key}' is not a string.`);
|
|
52
|
+
}
|
|
53
|
+
if (element.label && typeof element.label !== "string") {
|
|
54
|
+
throw new ArgumentError(`The 'label' for the key '${element.key}' is not a string.`);
|
|
55
|
+
}
|
|
56
|
+
if (typeof element.tags !== "object") {
|
|
57
|
+
throw new ArgumentError(`The value for the tag '${element.tags}' for key '${element.key}' is not in a valid format.`);
|
|
58
|
+
}
|
|
59
|
+
for (const item in element.tags) {
|
|
60
|
+
if (typeof element.tags[item] !== "string") {
|
|
61
|
+
throw new ArgumentError(`The value for the tag '${element.tags}' for key '${element.key}' is not in a valid format.`);
|
|
62
|
+
}
|
|
63
|
+
}
|
|
64
|
+
}
|
|
65
|
+
}
|
|
66
|
+
//# sourceMappingURL=kvSetConfigurationSettingsConverter.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"kvSetConfigurationSettingsConverter.js","sourceRoot":"","sources":["../../../../src/internal/parsers/kvSetConfigurationSettingsConverter.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAElC,OAAO,EAIL,iBAAiB,EACjB,sBAAsB,EACvB,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAI7C;;;;KAIK;AACL,MAAM,OAAO,mCAAmC;IAC9C;;SAEK;IACE,OAAO,CAAC,MAAc;QAC3B,MAAM,qBAAqB,GAAG,IAAI,KAAK,EAAkF,CAAC;QAC1H,MAAM,YAAY,GAAG,OAAO,CAAC;QAE7B,IAAI,CAAC,CAAC,YAAY,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,YAA4B,CAAC,CAAC,EAAE;YACrF,MAAM,IAAI,aAAa,CAAC,kJAAkJ,CAAC,CAAC;SAC7K;QACD,MAAM,KAAK,GAAkC,MAAM,CAAC,YAA4B,CAAC,CAAC;QAClF,KAAK,IAAI,KAAK,GAAG,CAAC,EAAE,KAAK,GAAG,KAAK,CAAC,MAAM,EAAE,KAAK,EAAE,EAAE;YACjD,MAAM,OAAO,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC;YAC7B,IAAI,CAAC,oBAAoB,CAAC,OAAO,CAAC,CAAC;YACnC,qBAAqB,CAAC,IAAI,CAAC;gBACzB,GAAG,EAAE,OAAO,CAAC,GAAG;gBAChB,KAAK,EAAE,OAAO,CAAC,KAAK;gBACpB,KAAK,EAAE,OAAO,CAAC,KAAK;gBACpB,WAAW,EAAE,OAAO,CAAC,YAAY;gBACjC,IAAI,EAAE,OAAO,CAAC,IAAI;aACnB,CAAC,CAAC;SACJ;QAED,OAAO,qBAAqB,CAAC;IAC/B,CAAC;IAEO,oBAAoB,CAAC,OAA+B;QAC1D,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE;YAChB,MAAM,IAAI,aAAa,CAAC,0DAA0D,CAAC,CAAC;SACrF;QACD,IAAI,OAAO,OAAO,CAAC,GAAG,KAAK,QAAQ,EAAE;YACnC,MAAM,IAAI,aAAa,CAAC,gBAAgB,OAAO,CAAC,GAAG,yBAAyB,CAAC,CAAC;SAC/E;QACD,IAAI,OAAO,CAAC,GAAG,KAAK,GAAG,IAAI,OAAO,CAAC,GAAG,KAAK,IAAI,IAAI,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,EAAE;YAChF,MAAM,IAAI,aAAa,CAAC,4DAA4D,CAAC,CAAC;SACvF;QACD,IAAI,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,iBAAiB,CAAC,IAAI,OAAO,CAAC,YAAY,KAAK,sBAAsB,EAAE;YAChG,MAAM,IAAI,aAAa,CAAC,gBAAgB,OAAO,CAAC,GAAG,iEAAiE,CAAC,CAAC;SACvH;QACD,IAAI,OAAO,CAAC,KAAK,IAAI,OAAO,OAAO,CAAC,KAAK,KAAK,QAAQ,EAAE;YACtD,MAAM,IAAI,aAAa,CAAC,4BAA4B,OAAO,CAAC,GAAG,oBAAoB,CAAC,CAAC;SACtF;QACD,IAAI,OAAO,CAAC,YAAY,IAAI,OAAO,OAAO,CAAC,YAAY,KAAK,QAAQ,EAAE;YACpE,MAAM,IAAI,aAAa,CAAC,mCAAmC,OAAO,CAAC,GAAG,oBAAoB,CAAC,CAAC;SAC7F;QACD,IAAI,OAAO,CAAC,KAAK,IAAI,OAAO,OAAO,CAAC,KAAK,KAAK,QAAQ,EAAE;YACtD,MAAM,IAAI,aAAa,CAAC,4BAA4B,OAAO,CAAC,GAAG,oBAAoB,CAAC,CAAC;SACtF;QACD,IAAI,OAAO,OAAO,CAAC,IAAI,KAAK,QAAQ,EAAE;YACpC,MAAM,IAAI,aAAa,CAAC,0BAA0B,OAAO,CAAC,IAAI,cAAc,OAAO,CAAC,GAAG,6BAA6B,CAAC,CAAC;SACvH;QACD,KAAK,MAAM,IAAI,IAAI,OAAO,CAAC,IAAI,EAAE;YAC/B,IAAI,OAAO,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,QAAQ,EAAE;gBAC1C,MAAM,IAAI,aAAa,CAAC,0BAA0B,OAAO,CAAC,IAAI,cAAc,OAAO,CAAC,GAAG,6BAA6B,CAAC,CAAC;aACvH;SACF;IACH,CAAC;CACF","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\nimport {\n SetConfigurationSettingParam,\n FeatureFlagValue,\n SecretReferenceValue,\n featureFlagPrefix,\n featureFlagContentType\n} from \"@azure/app-configuration\";\nimport { ArgumentError } from \"../../errors\";\nimport { KvSetConfigurationItem } from \"../../models\";\nimport { ConfigurationSettingsConverter } from \"./configurationSettingsConverter\";\n\n/**\n * Format Parser for kvset profile.\n *\n * @internal\n * */\nexport class KvSetConfigurationSettingsConverter implements ConfigurationSettingsConverter {\n /**\n * @inheritdoc\n * */\n public Convert(config: object): SetConfigurationSettingParam<string | FeatureFlagValue | SecretReferenceValue>[] {\n const configurationSettings = new Array<SetConfigurationSettingParam<string | FeatureFlagValue | SecretReferenceValue>>();\n const itemsKeyword = \"items\";\n\n if (!(itemsKeyword in config) || !Array.isArray(config[itemsKeyword as keyof object])) {\n throw new ArgumentError(\"The input data doesn't follow the KVSet file schema. See https://github.com/Azure/AppConfiguration/blob/main/docs/KVSet/KVSet.v1.0.0.schema.json\");\n }\n const items: Array<KvSetConfigurationItem> = config[itemsKeyword as keyof object];\n for (let index = 0; index < items.length; index++) {\n const element = items[index];\n this.validateKvSetElement(element);\n configurationSettings.push({\n key: element.key,\n value: element.value,\n label: element.label,\n contentType: element.content_type,\n tags: element.tags\n });\n }\n\n return configurationSettings;\n }\n\n private validateKvSetElement(element: KvSetConfigurationItem) {\n if (!element.key) {\n throw new ArgumentError(\"Configuration key is required, cannot be an empty string\");\n }\n if (typeof element.key !== \"string\") {\n throw new ArgumentError(`Invalid key '${element.key}', key must be a string`);\n }\n if (element.key === \".\" || element.key === \"..\" || element.key.indexOf(\"%\") > -1) {\n throw new ArgumentError(\"Key cannot be a '.' or '..', or contain the '%' character.\");\n }\n if (element.key.startsWith(featureFlagPrefix) && element.content_type !== featureFlagContentType) {\n throw new ArgumentError(`Invalid key '${element.key}'. Key cannot start with the reserved prefix for feature flags.`);\n }\n if (element.value && typeof element.value !== \"string\") {\n throw new ArgumentError(`The 'value' for the key '${element.key}' is not a string.`);\n }\n if (element.content_type && typeof element.content_type !== \"string\") {\n throw new ArgumentError(`The 'content_type' for the key '${element.key}' is not a string.`);\n }\n if (element.label && typeof element.label !== \"string\") {\n throw new ArgumentError(`The 'label' for the key '${element.key}' is not a string.`);\n }\n if (typeof element.tags !== \"object\") {\n throw new ArgumentError(`The value for the tag '${element.tags}' for key '${element.key}' is not in a valid format.`);\n }\n for (const item in element.tags) {\n if (typeof element.tags[item] !== \"string\") {\n throw new ArgumentError(`The value for the tag '${element.tags}' for key '${element.key}' is not in a valid format.`);\n }\n }\n }\n}\n"]}
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
// Copyright (c) Microsoft Corporation.
|
|
2
|
+
// Licensed under the MIT License.
|
|
3
|
+
/** @internal */
|
|
4
|
+
export function toWebStream(source) {
|
|
5
|
+
if (isWebReadableStream(source)) {
|
|
6
|
+
return source;
|
|
7
|
+
}
|
|
8
|
+
throw new Error("Unexpected Node stream in browser environment");
|
|
9
|
+
}
|
|
10
|
+
function isWebReadableStream(stream) {
|
|
11
|
+
return Boolean(stream &&
|
|
12
|
+
typeof stream === "object" &&
|
|
13
|
+
typeof stream.getReader === "function" &&
|
|
14
|
+
typeof stream.tee === "function");
|
|
15
|
+
}
|
|
16
|
+
//# sourceMappingURL=stream.browser.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"stream.browser.js","sourceRoot":"","sources":["../../../src/internal/stream.browser.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAElC,gBAAgB;AAChB,MAAM,UAAU,WAAW,CAAC,MAA2D;IACrF,IAAI,mBAAmB,CAAC,MAAM,CAAC,EAAE;QAC/B,OAAQ,MAAoC,CAAC;KAC9C;IAED,MAAM,IAAI,KAAK,CAAE,+CAA+C,CAAC,CAAC;AACpE,CAAC;AAED,SAAS,mBAAmB,CAAC,MAAe;IAC1C,OAAO,OAAO,CAAC,MAAM;QACnB,OAAO,MAAM,KAAK,QAAQ;QAC1B,OAAQ,MAAyB,CAAC,SAAS,KAAK,UAAU;QAC1D,OAAQ,MAAyB,CAAC,GAAG,KAAK,UAAU,CAAC,CAAC;AAC1D,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\n/** @internal */\nexport function toWebStream(source: NodeJS.ReadableStream | ReadableStream<Uint8Array>): ReadableStream<Uint8Array> { \n if (isWebReadableStream(source)) {\n return source as ReadableStream<Uint8Array>;\n }\n\n throw new Error (\"Unexpected Node stream in browser environment\");\n}\n\nfunction isWebReadableStream(stream: unknown): boolean {\n return Boolean(stream && \n typeof stream === \"object\" && \n typeof (stream as ReadableStream).getReader === \"function\" &&\n typeof (stream as ReadableStream).tee === \"function\");\n}\n"]}
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
// Copyright (c) Microsoft Corporation.
|
|
2
|
+
// Licensed under the MIT License.
|
|
3
|
+
import { Readable } from "stream";
|
|
4
|
+
/** @internal */
|
|
5
|
+
export function toWebStream(source) {
|
|
6
|
+
if (isNodeReadableStream(source)) {
|
|
7
|
+
const stream = source;
|
|
8
|
+
return Readable.toWeb(Readable.from(stream));
|
|
9
|
+
}
|
|
10
|
+
return source;
|
|
11
|
+
}
|
|
12
|
+
function isNodeReadableStream(stream) {
|
|
13
|
+
return Boolean(stream && typeof stream === "object" && typeof stream.pipe === "function");
|
|
14
|
+
}
|
|
15
|
+
//# sourceMappingURL=stream.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"stream.js","sourceRoot":"","sources":["../../../src/internal/stream.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAElC,OAAO,EAAE,QAAQ,EAAE,MAAM,QAAQ,CAAC;AAElC,gBAAgB;AAChB,MAAM,UAAU,WAAW,CAAC,MAA2D;IACrF,IAAI,oBAAoB,CAAC,MAAM,CAAC,EAAE;QAChC,MAAM,MAAM,GAAI,MAA+B,CAAC;QAChD,OAAO,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,CAA+B,CAAC;KAC5E;IAED,OAAO,MAAoC,CAAC;AAC9C,CAAC;AAED,SAAS,oBAAoB,CAAC,MAAe;IAC3C,OAAO,OAAO,CAAC,MAAM,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,OAAQ,MAAgC,CAAC,IAAI,KAAK,UAAU,CAAC,CAAC;AACvH,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport { Readable } from \"stream\";\n\n/** @internal */\nexport function toWebStream(source: NodeJS.ReadableStream | ReadableStream<Uint8Array>): ReadableStream<Uint8Array> { \n if (isNodeReadableStream(source)) {\n const stream = source as NodeJS.ReadableStream;\n return Readable.toWeb(Readable.from(stream)) as ReadableStream<Uint8Array>;\n }\n\n return source as ReadableStream<Uint8Array>;\n}\n\nfunction isNodeReadableStream(stream: unknown): boolean {\n return Boolean(stream && typeof stream === \"object\" && typeof (stream as NodeJS.ReadableStream).pipe === \"function\");\n}\n"]}
|
|
@@ -0,0 +1,129 @@
|
|
|
1
|
+
// Copyright (c) Microsoft Corporation.
|
|
2
|
+
// Licensed under the MIT license.
|
|
3
|
+
import { featureFlagContentType } from "@azure/app-configuration";
|
|
4
|
+
import { isEmpty, isEqual } from "lodash";
|
|
5
|
+
import { ConfigurationFormat, ConfigurationProfile } from "../enums";
|
|
6
|
+
import { ArgumentError, ArgumentNullError } from "../errors";
|
|
7
|
+
import { Constants } from "../internal/constants";
|
|
8
|
+
/** @internal*/
|
|
9
|
+
export function isJsonContentType(contentType) {
|
|
10
|
+
if (!contentType) {
|
|
11
|
+
return false;
|
|
12
|
+
}
|
|
13
|
+
contentType = contentType.trim().toLowerCase();
|
|
14
|
+
const mineType = contentType.split(";")[0].trim();
|
|
15
|
+
const typeParts = mineType.split("/");
|
|
16
|
+
if (typeParts.length != 2) {
|
|
17
|
+
return false;
|
|
18
|
+
}
|
|
19
|
+
if (typeParts[0] != "application") {
|
|
20
|
+
return false;
|
|
21
|
+
}
|
|
22
|
+
const subTypes = typeParts[1].split("+");
|
|
23
|
+
if (subTypes[subTypes.length - 1] == "json") {
|
|
24
|
+
return true;
|
|
25
|
+
}
|
|
26
|
+
return false;
|
|
27
|
+
}
|
|
28
|
+
/** @internal*/
|
|
29
|
+
export function isConfigSettingEqual(settingA, settingB) {
|
|
30
|
+
let valueIsEqual = settingA.value == settingB.value;
|
|
31
|
+
if (settingA.contentType == featureFlagContentType &&
|
|
32
|
+
settingB.contentType == featureFlagContentType &&
|
|
33
|
+
settingA.value !== undefined &&
|
|
34
|
+
settingB.value !== undefined) {
|
|
35
|
+
valueIsEqual = isFeatureFlagValueEqual(settingA.value, settingB.value);
|
|
36
|
+
}
|
|
37
|
+
return valueIsEqual &&
|
|
38
|
+
settingA.contentType == settingB.contentType &&
|
|
39
|
+
areTagsEqual(settingA.tags, settingB.tags);
|
|
40
|
+
}
|
|
41
|
+
/** @internal*/
|
|
42
|
+
export function areTagsEqual(tagA, tagB) {
|
|
43
|
+
if (isEmpty(tagA) || isEmpty(tagB)) {
|
|
44
|
+
return isEmpty(tagA) && isEmpty(tagB);
|
|
45
|
+
}
|
|
46
|
+
if (Object.keys(tagA).length !== Object.keys(tagB).length) {
|
|
47
|
+
return false;
|
|
48
|
+
}
|
|
49
|
+
for (const key in tagA) {
|
|
50
|
+
if (tagA[key] !== tagB[key]) {
|
|
51
|
+
return false;
|
|
52
|
+
}
|
|
53
|
+
}
|
|
54
|
+
return true;
|
|
55
|
+
}
|
|
56
|
+
/** @internal*/
|
|
57
|
+
/**
|
|
58
|
+
* Validate the ConfigurationSyncOptions argument, throw fatal error if options are not valid.
|
|
59
|
+
*
|
|
60
|
+
* @param options - ConfigurationSyncOptions to be validated.
|
|
61
|
+
*/
|
|
62
|
+
export function validateOptions(options) {
|
|
63
|
+
if (!options) {
|
|
64
|
+
throw new ArgumentNullError();
|
|
65
|
+
}
|
|
66
|
+
if (options.profile == ConfigurationProfile.KvSet) {
|
|
67
|
+
if (options.prefix ||
|
|
68
|
+
options.separator ||
|
|
69
|
+
options.label ||
|
|
70
|
+
options.depth ||
|
|
71
|
+
options.tags ||
|
|
72
|
+
options.contentType) {
|
|
73
|
+
throw new ArgumentError("The option label, prefix, depth, contentType, tags and separator are not supported when importing using 'appconfig/kvset' profile");
|
|
74
|
+
}
|
|
75
|
+
if (options.format !== ConfigurationFormat.Json) {
|
|
76
|
+
throw new ArgumentError("Yaml and Properties formats are not supported for appconfig/kvset profile. Supported value is: Json");
|
|
77
|
+
}
|
|
78
|
+
}
|
|
79
|
+
if (options.depth && options.depth > 1 && !options.separator) {
|
|
80
|
+
throw new ArgumentError("Separator must be specified if Depth is default value or set a value lager than 1");
|
|
81
|
+
}
|
|
82
|
+
if (options.separator && !Constants.Separators.includes(options.separator)) {
|
|
83
|
+
throw new ArgumentError(`${options.separator} is not a supported separator.`);
|
|
84
|
+
}
|
|
85
|
+
if (!options.separator && !options.depth) {
|
|
86
|
+
options.depth = 1;
|
|
87
|
+
}
|
|
88
|
+
if (options.format !== ConfigurationFormat.Json && isJsonContentType(options.contentType)) {
|
|
89
|
+
throw new ArgumentError(`Failed to import '${ConfigurationFormat[options.format]}' data format with '${options.contentType}' content type. Please provide data in JSON format to match your content type.`);
|
|
90
|
+
}
|
|
91
|
+
}
|
|
92
|
+
function isFeatureFlagValueEqual(valueA, valueB) {
|
|
93
|
+
let featureFlagAValue;
|
|
94
|
+
if (typeof valueA == "string") {
|
|
95
|
+
featureFlagAValue = toFeatureFlagValue(valueA);
|
|
96
|
+
}
|
|
97
|
+
else {
|
|
98
|
+
featureFlagAValue = valueA;
|
|
99
|
+
}
|
|
100
|
+
const featureFlagBValue = toFeatureFlagValue(valueB);
|
|
101
|
+
if (Object.keys(featureFlagAValue).length !== Object.keys(featureFlagBValue).length) {
|
|
102
|
+
return false;
|
|
103
|
+
}
|
|
104
|
+
return featureFlagAValue.id == featureFlagBValue.id &&
|
|
105
|
+
featureFlagAValue.enabled == featureFlagBValue.enabled &&
|
|
106
|
+
featureFlagAValue.description == featureFlagBValue.description &&
|
|
107
|
+
areFeatureFlagFiltersEqual(featureFlagAValue.conditions.clientFilters, featureFlagBValue.conditions.clientFilters);
|
|
108
|
+
}
|
|
109
|
+
function areFeatureFlagFiltersEqual(filterA, filterB) {
|
|
110
|
+
if (filterA.length !== filterB.length) {
|
|
111
|
+
return false;
|
|
112
|
+
}
|
|
113
|
+
for (let i = 0; i < filterA.length; i++) {
|
|
114
|
+
if (!isEqual(filterA[i], filterB[i])) {
|
|
115
|
+
return false;
|
|
116
|
+
}
|
|
117
|
+
}
|
|
118
|
+
return true;
|
|
119
|
+
}
|
|
120
|
+
function toFeatureFlagValue(value) {
|
|
121
|
+
const parsedJson = JSON.parse(value);
|
|
122
|
+
return {
|
|
123
|
+
id: parsedJson.id,
|
|
124
|
+
enabled: parsedJson.enabled,
|
|
125
|
+
description: parsedJson.description,
|
|
126
|
+
conditions: isEmpty(parsedJson.conditions) ? { clientFilters: [] } : { clientFilters: parsedJson.conditions.client_filters }
|
|
127
|
+
};
|
|
128
|
+
}
|
|
129
|
+
//# sourceMappingURL=utils.js.map
|