Skip to content

Commit e8fc072

Browse files
authored
fix(env): AS-796 fix QP env var locations (#409)
1 parent 2976c79 commit e8fc072

8 files changed

Lines changed: 90 additions & 106 deletions

File tree

docker/common-services.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ services:
44
image: voxel51/fiftyone-app:v2.10.1
55
environment:
66
API_URL: ${API_URL}
7+
FIFTYONE_APP_DEFAULT_QUERY_PERFORMANCE: ${FIFTYONE_APP_DEFAULT_QUERY_PERFORMANCE}
8+
FIFTYONE_APP_ENABLE_QUERY_PERFORMANCE: ${FIFTYONE_APP_ENABLE_QUERY_PERFORMANCE}
79
FIFTYONE_AUTH_SECRET: ${FIFTYONE_AUTH_SECRET}
810
FIFTYONE_DATABASE_ADMIN: false
911
FIFTYONE_DATABASE_NAME: ${FIFTYONE_DATABASE_NAME}
@@ -72,8 +74,6 @@ services:
7274
NODE_ENV: production
7375
RECOIL_DUPLICATE_ATOM_KEY_CHECKING_ENABLED: false
7476
FIFTYONE_APP_ANONYMOUS_ANALYTICS_ENABLED: ${FIFTYONE_APP_ANONYMOUS_ANALYTICS_ENABLED:-true}
75-
FIFTYONE_APP_DEFAULT_QUERY_PERFORMANCE: ${FIFTYONE_APP_DEFAULT_QUERY_PERFORMANCE}
76-
FIFTYONE_APP_ENABLE_QUERY_PERFORMANCE: ${FIFTYONE_APP_ENABLE_QUERY_PERFORMANCE}
7777
# If you are routing through a proxy server you will want to set
7878
# HTTP_PROXY_URL, HTTPS_PROXY_URL, and NO_PROXY_LIST in your .env
7979
# then add the following environment variables to your

helm/fiftyone-teams-app/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -526,6 +526,8 @@ follow
526526
| appSettings.autoscaling.targetCPUUtilizationPercentage | int | `80` | Percent CPU utilization for autoscaling for `fiftyone-app`. |
527527
| appSettings.autoscaling.targetMemoryUtilizationPercentage | int | `80` | Percent memory utilization for autoscaling for `fiftyone-app`. |
528528
| appSettings.deploymentAnnotations | object | `{}` | Annotations for the `fiftyone-app` deployment. [Reference][annotations]. |
529+
| appSettings.env.FIFTYONE_APP_DEFAULT_QUERY_PERFORMANCE | bool | `true` | Controls whether Query Performance mode is enabled by default for every dataset for the teams application. Set to false to set default mode to off. |
530+
| appSettings.env.FIFTYONE_APP_ENABLE_QUERY_PERFORMANCE | bool | `true` | Controls whether Query Performance mode is enabled for the application. Set to false to disable Query Performance mode for entire application. |
529531
| appSettings.env.FIFTYONE_DATABASE_ADMIN | bool | `false` | Controls whether the client is allowed to trigger database migrations. [Reference][fiftyone-config]. |
530532
| appSettings.env.FIFTYONE_INTERNAL_SERVICE | bool | `true` | Whether the SDK is running in an internal service context. When running in FiftyOne Enterprise, set to `true`. |
531533
| appSettings.env.FIFTYONE_MEDIA_CACHE_APP_IMAGES | bool | `false` | Controls whether cloud media images will be downloaded and added to the local cache upon viewing media in the app. |
@@ -748,8 +750,6 @@ follow
748750
| teamsAppSettings.env.APP_USE_HTTPS | bool | `true` | Controls the protocol of the `teams-app`. Configure your ingress to match. When `true`, uses the https protocol. When `false`, uses the http protocol. |
749751
| teamsAppSettings.env.FIFTYONE_APP_ALLOW_MEDIA_EXPORT | bool | `true` | When `false`, disables media export options |
750752
| teamsAppSettings.env.FIFTYONE_APP_ANONYMOUS_ANALYTICS_ENABLED | bool | `true` | Controls whether anonymous analytics are captured for the application. Set to false to opt-out of anonymous analytics. |
751-
| teamsAppSettings.env.FIFTYONE_APP_DEFAULT_QUERY_PERFORMANCE | bool | `true` | Controls whether Query Performance mode is enabled by default for every dataset for the teams application. Set to false to set default mode to off. |
752-
| teamsAppSettings.env.FIFTYONE_APP_ENABLE_QUERY_PERFORMANCE | bool | `true` | Controls whether Query Performance mode is enabled for the application. Set to false to disable Query Performance mode for entire application. |
753753
| teamsAppSettings.env.FIFTYONE_APP_TEAMS_SDK_RECOMMENDED_VERSION | string | `"2.10.1"` | The recommended fiftyone SDK version that will be displayed in the install modal (i.e. `pip install ... fiftyone==0.11.0`). |
754754
| teamsAppSettings.env.FIFTYONE_APP_THEME | string | `"dark"` | The default theme configuration. `dark`: Theme will be dark when user visits for the first time. `light`: Theme will be light theme when user visits for the first time. `always-dark`: Sets dark theme on each refresh (overrides user theme changes in the app). `always-light`: Sets light theme on each refresh (overrides user theme changes in the app). |
755755
| teamsAppSettings.env.RECOIL_DUPLICATE_ATOM_KEY_CHECKING_ENABLED | bool | `false` | Disable duplicate atom/selector key checking that generated false-positive errors. [Reference][recoil-env]. |

helm/fiftyone-teams-app/values.schema.json

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -616,6 +616,26 @@
616616
"env": {
617617
"description": "Environment Variables are passed to the `fiftyone-app` containers",
618618
"properties": {
619+
"FIFTYONE_APP_DEFAULT_QUERY_PERFORMANCE": {
620+
"default": true,
621+
"description": "Controls whether Query Performance mode is enabled by default for\nevery dataset for the teams application. Set to false to set default mode to off.",
622+
"required": [],
623+
"title": "FIFTYONE_APP_DEFAULT_QUERY_PERFORMANCE",
624+
"type": [
625+
"string",
626+
"boolean"
627+
]
628+
},
629+
"FIFTYONE_APP_ENABLE_QUERY_PERFORMANCE": {
630+
"default": true,
631+
"description": "Controls whether Query Performance mode is enabled for the\napplication. Set to false to disable Query Performance mode for entire application.",
632+
"required": [],
633+
"title": "FIFTYONE_APP_ENABLE_QUERY_PERFORMANCE",
634+
"type": [
635+
"string",
636+
"boolean"
637+
]
638+
},
619639
"FIFTYONE_DATABASE_ADMIN": {
620640
"default": false,
621641
"description": "Controls whether the client is allowed to trigger database migrations.\n[Reference][fiftyone-config].",
@@ -3034,26 +3054,6 @@
30343054
"boolean"
30353055
]
30363056
},
3037-
"FIFTYONE_APP_DEFAULT_QUERY_PERFORMANCE": {
3038-
"default": true,
3039-
"description": "Controls whether Query Performance mode is enabled by default for\nevery dataset for the teams application. Set to false to set default mode to off.",
3040-
"required": [],
3041-
"title": "FIFTYONE_APP_DEFAULT_QUERY_PERFORMANCE",
3042-
"type": [
3043-
"string",
3044-
"boolean"
3045-
]
3046-
},
3047-
"FIFTYONE_APP_ENABLE_QUERY_PERFORMANCE": {
3048-
"default": true,
3049-
"description": "Controls whether Query Performance mode is enabled for the\napplication. Set to false to disable Query Performance mode for entire application.",
3050-
"required": [],
3051-
"title": "FIFTYONE_APP_ENABLE_QUERY_PERFORMANCE",
3052-
"type": [
3053-
"string",
3054-
"boolean"
3055-
]
3056-
},
30573057
"FIFTYONE_APP_TEAMS_SDK_RECOMMENDED_VERSION": {
30583058
"default": "2.10.1",
30593059
"description": "The recommended fiftyone SDK version that will be displayed in the\ninstall modal (i.e. `pip install ... fiftyone==0.11.0`).",

helm/fiftyone-teams-app/values.yaml

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -219,6 +219,18 @@ appSettings:
219219
deploymentAnnotations: {}
220220
# Environment Variables are passed to the `fiftyone-app` containers
221221
env:
222+
# @schema
223+
# type: ["string", "boolean"]
224+
# @schema
225+
# -- Controls whether Query Performance mode is enabled by default for
226+
# every dataset for the teams application. Set to false to set default mode to off.
227+
FIFTYONE_APP_DEFAULT_QUERY_PERFORMANCE: true
228+
# @schema
229+
# type: ["string", "boolean"]
230+
# @schema
231+
# -- Controls whether Query Performance mode is enabled for the
232+
# application. Set to false to disable Query Performance mode for entire application.
233+
FIFTYONE_APP_ENABLE_QUERY_PERFORMANCE: true
222234
# @schema
223235
# type: ["string", "boolean"]
224236
# @schema
@@ -1130,18 +1142,6 @@ teamsAppSettings:
11301142
# -- Controls whether anonymous analytics are captured for the
11311143
# application. Set to false to opt-out of anonymous analytics.
11321144
FIFTYONE_APP_ANONYMOUS_ANALYTICS_ENABLED: true
1133-
# @schema
1134-
# type: ["string", "boolean"]
1135-
# @schema
1136-
# -- Controls whether Query Performance mode is enabled by default for
1137-
# every dataset for the teams application. Set to false to set default mode to off.
1138-
FIFTYONE_APP_DEFAULT_QUERY_PERFORMANCE: true
1139-
# @schema
1140-
# type: ["string", "boolean"]
1141-
# @schema
1142-
# -- Controls whether Query Performance mode is enabled for the
1143-
# application. Set to false to disable Query Performance mode for entire application.
1144-
FIFTYONE_APP_ENABLE_QUERY_PERFORMANCE: true
11451145

11461146
# -- Secret variables to be passed to the `teams-app` containers.
11471147
secretEnv: {}

tests/unit/compose/docker-compose-internal-auth_test.go

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -237,6 +237,8 @@ func (s *commonServicesInternalAuthDockerComposeTest) TestServiceEnvironment() {
237237
s.dotEnvFiles,
238238
[]string{
239239
"API_URL=http://teams-api:8000",
240+
"FIFTYONE_APP_DEFAULT_QUERY_PERFORMANCE=true",
241+
"FIFTYONE_APP_ENABLE_QUERY_PERFORMANCE=true",
240242
"FIFTYONE_AUTH_SECRET=test-fiftyone-auth-secret",
241243
"FIFTYONE_DATABASE_ADMIN=false",
242244
"FIFTYONE_DATABASE_NAME=fiftyone",
@@ -286,8 +288,6 @@ func (s *commonServicesInternalAuthDockerComposeTest) TestServiceEnvironment() {
286288
"NODE_ENV=production",
287289
"RECOIL_DUPLICATE_ATOM_KEY_CHECKING_ENABLED=false",
288290
"FIFTYONE_APP_ANONYMOUS_ANALYTICS_ENABLED=true",
289-
"FIFTYONE_APP_DEFAULT_QUERY_PERFORMANCE=true",
290-
"FIFTYONE_APP_ENABLE_QUERY_PERFORMANCE=true",
291291
},
292292
},
293293
{
@@ -317,6 +317,8 @@ func (s *commonServicesInternalAuthDockerComposeTest) TestServiceEnvironment() {
317317
s.dotEnvFiles,
318318
[]string{
319319
"API_URL=http://teams-api:8000",
320+
"FIFTYONE_APP_DEFAULT_QUERY_PERFORMANCE=true",
321+
"FIFTYONE_APP_ENABLE_QUERY_PERFORMANCE=true",
320322
"FIFTYONE_AUTH_SECRET=test-fiftyone-auth-secret",
321323
"FIFTYONE_DATABASE_ADMIN=false",
322324
"FIFTYONE_DATABASE_NAME=fiftyone",
@@ -368,8 +370,6 @@ func (s *commonServicesInternalAuthDockerComposeTest) TestServiceEnvironment() {
368370
"NODE_ENV=production",
369371
"RECOIL_DUPLICATE_ATOM_KEY_CHECKING_ENABLED=false",
370372
"FIFTYONE_APP_ANONYMOUS_ANALYTICS_ENABLED=true",
371-
"FIFTYONE_APP_DEFAULT_QUERY_PERFORMANCE=true",
372-
"FIFTYONE_APP_ENABLE_QUERY_PERFORMANCE=true",
373373
},
374374
},
375375
{
@@ -399,6 +399,8 @@ func (s *commonServicesInternalAuthDockerComposeTest) TestServiceEnvironment() {
399399
s.dotEnvFiles,
400400
[]string{
401401
"API_URL=http://teams-api:8000",
402+
"FIFTYONE_APP_DEFAULT_QUERY_PERFORMANCE=true",
403+
"FIFTYONE_APP_ENABLE_QUERY_PERFORMANCE=true",
402404
"FIFTYONE_AUTH_SECRET=test-fiftyone-auth-secret",
403405
"FIFTYONE_DATABASE_ADMIN=false",
404406
"FIFTYONE_DATABASE_NAME=fiftyone",
@@ -450,8 +452,6 @@ func (s *commonServicesInternalAuthDockerComposeTest) TestServiceEnvironment() {
450452
"RECOIL_DUPLICATE_ATOM_KEY_CHECKING_ENABLED=false",
451453
"FIFTYONE_TEAMS_PLUGIN_URL=http://teams-plugins:5151",
452454
"FIFTYONE_APP_ANONYMOUS_ANALYTICS_ENABLED=true",
453-
"FIFTYONE_APP_DEFAULT_QUERY_PERFORMANCE=true",
454-
"FIFTYONE_APP_ENABLE_QUERY_PERFORMANCE=true",
455455
},
456456
},
457457
{

tests/unit/compose/docker-compose-legacy-auth_test.go

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -237,6 +237,8 @@ func (s *commonServicesLegacyAuthDockerComposeTest) TestServiceEnvironment() {
237237
s.dotEnvFiles,
238238
[]string{
239239
"API_URL=http://teams-api:8000",
240+
"FIFTYONE_APP_DEFAULT_QUERY_PERFORMANCE=true",
241+
"FIFTYONE_APP_ENABLE_QUERY_PERFORMANCE=true",
240242
"FIFTYONE_AUTH_SECRET=test-fiftyone-auth-secret",
241243
"FIFTYONE_DATABASE_ADMIN=false",
242244
"FIFTYONE_DATABASE_NAME=fiftyone",
@@ -286,8 +288,6 @@ func (s *commonServicesLegacyAuthDockerComposeTest) TestServiceEnvironment() {
286288
"NODE_ENV=production",
287289
"RECOIL_DUPLICATE_ATOM_KEY_CHECKING_ENABLED=false",
288290
"FIFTYONE_APP_ANONYMOUS_ANALYTICS_ENABLED=true",
289-
"FIFTYONE_APP_DEFAULT_QUERY_PERFORMANCE=true",
290-
"FIFTYONE_APP_ENABLE_QUERY_PERFORMANCE=true",
291291
},
292292
},
293293
{
@@ -316,6 +316,8 @@ func (s *commonServicesLegacyAuthDockerComposeTest) TestServiceEnvironment() {
316316
s.dotEnvFiles,
317317
[]string{
318318
"API_URL=http://teams-api:8000",
319+
"FIFTYONE_APP_DEFAULT_QUERY_PERFORMANCE=true",
320+
"FIFTYONE_APP_ENABLE_QUERY_PERFORMANCE=true",
319321
"FIFTYONE_AUTH_SECRET=test-fiftyone-auth-secret",
320322
"FIFTYONE_DATABASE_ADMIN=false",
321323
"FIFTYONE_DATABASE_NAME=fiftyone",
@@ -365,8 +367,6 @@ func (s *commonServicesLegacyAuthDockerComposeTest) TestServiceEnvironment() {
365367
"NODE_ENV=production",
366368
"RECOIL_DUPLICATE_ATOM_KEY_CHECKING_ENABLED=false",
367369
"FIFTYONE_APP_ANONYMOUS_ANALYTICS_ENABLED=true",
368-
"FIFTYONE_APP_DEFAULT_QUERY_PERFORMANCE=true",
369-
"FIFTYONE_APP_ENABLE_QUERY_PERFORMANCE=true",
370370
},
371371
},
372372
{
@@ -395,6 +395,8 @@ func (s *commonServicesLegacyAuthDockerComposeTest) TestServiceEnvironment() {
395395
s.dotEnvFiles,
396396
[]string{
397397
"API_URL=http://teams-api:8000",
398+
"FIFTYONE_APP_DEFAULT_QUERY_PERFORMANCE=true",
399+
"FIFTYONE_APP_ENABLE_QUERY_PERFORMANCE=true",
398400
"FIFTYONE_AUTH_SECRET=test-fiftyone-auth-secret",
399401
"FIFTYONE_DATABASE_ADMIN=false",
400402
"FIFTYONE_DATABASE_NAME=fiftyone",
@@ -446,8 +448,6 @@ func (s *commonServicesLegacyAuthDockerComposeTest) TestServiceEnvironment() {
446448
"NODE_ENV=production",
447449
"RECOIL_DUPLICATE_ATOM_KEY_CHECKING_ENABLED=false",
448450
"FIFTYONE_APP_ANONYMOUS_ANALYTICS_ENABLED=true",
449-
"FIFTYONE_APP_DEFAULT_QUERY_PERFORMANCE=true",
450-
"FIFTYONE_APP_ENABLE_QUERY_PERFORMANCE=true",
451451
},
452452
},
453453
{
@@ -476,6 +476,8 @@ func (s *commonServicesLegacyAuthDockerComposeTest) TestServiceEnvironment() {
476476
s.dotEnvFiles,
477477
[]string{
478478
"API_URL=http://teams-api:8000",
479+
"FIFTYONE_APP_DEFAULT_QUERY_PERFORMANCE=true",
480+
"FIFTYONE_APP_ENABLE_QUERY_PERFORMANCE=true",
479481
"FIFTYONE_AUTH_SECRET=test-fiftyone-auth-secret",
480482
"FIFTYONE_DATABASE_ADMIN=false",
481483
"FIFTYONE_DATABASE_NAME=fiftyone",
@@ -527,8 +529,6 @@ func (s *commonServicesLegacyAuthDockerComposeTest) TestServiceEnvironment() {
527529
"RECOIL_DUPLICATE_ATOM_KEY_CHECKING_ENABLED=false",
528530
"FIFTYONE_TEAMS_PLUGIN_URL=http://teams-plugins:5151",
529531
"FIFTYONE_APP_ANONYMOUS_ANALYTICS_ENABLED=true",
530-
"FIFTYONE_APP_DEFAULT_QUERY_PERFORMANCE=true",
531-
"FIFTYONE_APP_ENABLE_QUERY_PERFORMANCE=true",
532532
},
533533
},
534534
{

tests/unit/helm/app-deployment_test.go

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -463,6 +463,14 @@ func (s *deploymentAppTemplateTest) TestContainerEnv() {
463463
}
464464
}
465465
},
466+
{
467+
"name": "FIFTYONE_APP_DEFAULT_QUERY_PERFORMANCE",
468+
"value": "true"
469+
},
470+
{
471+
"name": "FIFTYONE_APP_ENABLE_QUERY_PERFORMANCE",
472+
"value": "true"
473+
},
466474
{
467475
"name": "FIFTYONE_DATABASE_ADMIN",
468476
"value": "false"
@@ -539,6 +547,14 @@ func (s *deploymentAppTemplateTest) TestContainerEnv() {
539547
}
540548
}
541549
},
550+
{
551+
"name": "FIFTYONE_APP_DEFAULT_QUERY_PERFORMANCE",
552+
"value": "true"
553+
},
554+
{
555+
"name": "FIFTYONE_APP_ENABLE_QUERY_PERFORMANCE",
556+
"value": "true"
557+
},
542558
{
543559
"name": "FIFTYONE_DATABASE_ADMIN",
544560
"value": "false"
@@ -629,6 +645,14 @@ func (s *deploymentAppTemplateTest) TestContainerEnv() {
629645
}
630646
}
631647
},
648+
{
649+
"name": "FIFTYONE_APP_DEFAULT_QUERY_PERFORMANCE",
650+
"value": "true"
651+
},
652+
{
653+
"name": "FIFTYONE_APP_ENABLE_QUERY_PERFORMANCE",
654+
"value": "true"
655+
},
632656
{
633657
"name": "FIFTYONE_DATABASE_ADMIN",
634658
"value": "false"
@@ -716,6 +740,14 @@ func (s *deploymentAppTemplateTest) TestContainerEnv() {
716740
}
717741
}
718742
},
743+
{
744+
"name": "FIFTYONE_APP_DEFAULT_QUERY_PERFORMANCE",
745+
"value": "true"
746+
},
747+
{
748+
"name": "FIFTYONE_APP_ENABLE_QUERY_PERFORMANCE",
749+
"value": "true"
750+
},
719751
{
720752
"name": "FIFTYONE_DATABASE_ADMIN",
721753
"value": "false"
@@ -791,6 +823,14 @@ func (s *deploymentAppTemplateTest) TestContainerEnv() {
791823
}
792824
}
793825
},
826+
{
827+
"name": "FIFTYONE_APP_DEFAULT_QUERY_PERFORMANCE",
828+
"value": "true"
829+
},
830+
{
831+
"name": "FIFTYONE_APP_ENABLE_QUERY_PERFORMANCE",
832+
"value": "true"
833+
},
794834
{
795835
"name": "FIFTYONE_DATABASE_ADMIN",
796836
"value": "false"

0 commit comments

Comments
 (0)