github/directus
1
0
Fork 0
mirror of https://github.com/directus/directus.git synced 2026-01-22 19:08:01 -05:00
Code Issues Packages Projects Releases Wiki Activity

Allow environment syntax prefix per item within an array (#8257)

Browse Source 
* Updating environment syntax prefix to identify prefix per item

* Updating environment syntax prefix documentation to show how to add prefix to array value

* Add additional example

Co-authored-by: Juan Carlos Blanco Delgado <juancarlosjr97@gmail.com>
Co-authored-by: rijkvanzanten <rijkvanzanten@me.com>
This commit is contained in:
Azri Kahar
2021-09-24 04:15:18 +08:00
committed by GitHub
parent 8af51d852c
commit 83d2b661c8
2 changed files with 21 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
api/src/env.ts
View File

@@ -163,6 +163,15 @@ function getEnvVariableValue(variableValue: string, variableType: string) {
return variableValue.split(`${variableType}:`)[1];
}
function getEnvironmentValueWithPrefix(envArray: Array<string>): Array<string | number | RegExp> {
return envArray.map((item: string) => {
if (isEnvSyntaxPrefixPresent(item)) {
return getEnvironmentValueByType(item);
}
return item;
});
}
function getEnvironmentValueByType(envVariableString: string) {
const variableType = getVariableType(envVariableString);
const envVariableValue = getEnvVariableValue(envVariableString, variableType);
@@ -171,7 +180,7 @@ function getEnvironmentValueByType(envVariableString: string) {
case 'number':
return toNumber(envVariableValue);
case 'array':
return toArray(envVariableValue);
return getEnvironmentValueWithPrefix(toArray(envVariableValue));
case 'regex':
return new RegExp(envVariableValue);
case 'string':
@@ -181,6 +190,10 @@ function getEnvironmentValueByType(envVariableString: string) {
}
}
function isEnvSyntaxPrefixPresent(value: string): boolean {
return acceptedEnvTypes.some((envType) => value.includes(`${envType}:`));
}
function processValues(env: Record<string, any>) {
env = clone(env);
@@ -205,7 +218,7 @@ function processValues(env: Record<string, any>) {
// Convert values with a type prefix
// (see https://docs.directus.io/reference/environment-variables/#environment-syntax-prefix)
if (typeof value === 'string' && acceptedEnvTypes.some((envType) => value.includes(`${envType}:`))) {
if (typeof value === 'string' && isEnvSyntaxPrefixPresent(value)) {
env[key] = getEnvironmentValueByType(value);
continue;
}

12
docs/reference/environment-variables.md
View File

@@ -429,12 +429,12 @@ Directus will attempt to automatically type cast environment variables based on
([see above](#type-casting-and-nesting)). If you have a specific need for a given type, you can tell Directus what type
to use for the given value by prefixing the value with `{type}:`. The following types are available:
| Syntax Prefix | Example | Output |
| ------------- | ------------------------------------------------ | ------------------------------------------------ |
| `string` | `string:value` | `"value"` |
| `number` | `number:3306` | `3306` |
| `regex` | `regex:/\.example\.com$/` | `/\.example\.com$/` |
| `array` | `array:https://example.com,https://example2.com` | `["https://example.com","https://example2.com"]` |
| Syntax Prefix | Example | Output |
| ------------- | ----------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- |
| `string` | `string:value` | `"value"` |
| `number` | `number:3306` | `3306` |
| `regex` | `regex:/\.example\.com$/` | `/\.example\.com$/` |
| `array` | `array:https://example.com,https://example2.com` <br> `array:string:https://example.com,regex:/\.example3\.com$/` | `["https://example.com", "https://example2.com"]` <br> `["https://example.com", "https://example2.com", /\.example3\.com$/]` |
## File Based Environment Variables (Docker Secrets)