fix(orchestrator): skip empty headers (#1229)

Author: mareklibra

workspaces/orchestrator/.changeset/hip-parrots-drive.md

@@ -0,0 +1,5 @@
+---
+'@red-hat-developer-hub/backstage-plugin-orchestrator-form-widgets': patch
+---
+
+If a fetch/validate body/headers field resolves to empty or undefined value, it is skipped from the HTTP request.

workspaces/orchestrator/docs/orchestratorFormWidgets.md

@@ -446,6 +446,10 @@ Various selectors (like `fetch:response:*`) are processed by the [jsonata](https
 |         ui:variant          |                                                                                                                                                                                   So far specific for StaticText widget only. See [ActiveText props](#activetext-widget-uiprops)                                                                                                                                                                                   |                                                                                                 |
 |           ui:text           |                                                                                                                                                                    So far specific for StaticText widget only. Check the description there. See [ActiveText props](#activetext-widget-uiprops)                                                                                                                                                                     |                                                                                                 |
 
+#### Specifics for templates in fetch:body, validate:body, fetch:headers or validate:headers
+
+If a template for a field of one of those properties evaluates to just an empty or undefined value, the **field is skipped** from the HTTP request (body, headers).
+
 ### Authentication
 
 To make the `identityApi` working, the [Backstage authentication](https://backstage.io/docs/auth/#sign-in-configuration) needs to be configured.

workspaces/orchestrator/plugins/orchestrator-form-widgets/src/utils/constants.ts

@@ -0,0 +1,15 @@
+/*
+ * Copyright Red Hat, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the for the specific language governing permissions and
+ */
+export const UNDEFINED_VALUE = '___undefined___';

workspaces/orchestrator/plugins/orchestrator-form-widgets/src/utils/evaluateTemplate.test.ts

@@ -77,6 +77,7 @@ describe('evaluate template', () => {
 
   it('can parse template template to units', async () => {
     const cases = [
+      { template: '', expected: '' },
       { template: 'zz', expected: 'zz' },
       { template: '}}', expected: '}}' },
       { template: '${{foo}}', expected: '${{foo}}' },

workspaces/orchestrator/plugins/orchestrator-form-widgets/src/utils/evaluateTemplate.ts

@@ -19,6 +19,7 @@ import { JsonObject, JsonPrimitive, JsonValue } from '@backstage/types';
 import { useTemplateUnitEvaluator } from './useTemplateUnitEvaluator';
 import { UiProps } from '../uiPropTypes';
 import { isJsonObject } from './applySelector';
+import { UNDEFINED_VALUE } from './constants';
 
 export type evaluateTemplateProps = {
   template?: JsonValue;
@@ -82,7 +83,7 @@ export const evaluateTemplateString = async (
       uiProps,
     );
     if (evaluatedUnit === undefined) {
-      evaluatedUnit = '___undefined___';
+      evaluatedUnit = UNDEFINED_VALUE;
     }
 
     if (

workspaces/orchestrator/plugins/orchestrator-form-widgets/src/utils/useRequestInit.ts

@@ -22,6 +22,7 @@ import {
   evaluateTemplateString,
 } from './evaluateTemplate';
 import { useTemplateUnitEvaluator } from './useTemplateUnitEvaluator';
+import { UNDEFINED_VALUE } from './constants';
 
 const ALLOWED_METHODS = ['GET', 'POST'];
 
@@ -62,7 +63,10 @@ export const getRequestInit = async (
           ),
         );
         keys.forEach((key, idx) => {
-          evaluated[key] = values[idx];
+          if (values[idx] && values[idx] !== UNDEFINED_VALUE) {
+            // skip empty or undefined values
+            evaluated[key] = values[idx];
+          }
         });
 
         const bodyInit: BodyInit = JSON.stringify(evaluated);
@@ -105,8 +109,11 @@ export const getRequestInit = async (
       keys.forEach((key, idx) => {
         // Header must be a string
         const value = values[idx];
-        headersInit[key] =
-          typeof value === 'string' ? value : JSON.stringify(value);
+        if (value && value !== UNDEFINED_VALUE) {
+          // skip empty or undefined values
+          headersInit[key] =
+            typeof value === 'string' ? value : JSON.stringify(value);
+        }
       });
     } else {
       throw new Error('fetch:body must be object for POST requests');