Added Key support for Authorization header.

Author: sonnykt

codecov.yml

@@ -0,0 +1,15 @@
+codecov:
+  require_ci_to_pass: yes
+
+coverage:
+  status:
+    project:
+      default:
+        target: auto
+        threshold: 0
+        if_ci_failed: error
+    patch:
+      default:
+        target: auto
+        threshold: 0
+        if_ci_failed: error

modules/webform_openfisca_key_auth/webform_openfisca_key_auth.info.yml

@@ -0,0 +1,8 @@
+name: Webform OpenFisca - Key Authentication
+type: module
+description: Add authentication with Key module to Webform OpenFisca.
+package: Webform
+core_version_requirement: ^10 || ^11
+dependencies:
+  - webform_openfisca:webform_openfisca
+  - key:key

modules/webform_openfisca_key_auth/webform_openfisca_key_auth.module

@@ -0,0 +1,84 @@
+<?php
+
+/**
+ * @file
+ * Webform OpenFisca Key Authentication.
+ */
+
+declare(strict_types=1);
+
+use Drupal\Core\Entity\EntityFormInterface;
+use Drupal\Core\Form\FormStateInterface;
+use Drupal\key\KeyInterface;
+use Drupal\webform\Entity\Webform;
+use Drupal\webform\WebformInterface;
+use Drupal\webform_openfisca\WebformOpenFiscaSettings;
+
+/**
+ * Implements hook_config_schema_info_alter().
+ */
+function webform_openfisca_key_auth_config_schema_info_alter(array &$definitions) : void {
+  $definitions['webform.settings.third_party.webform_openfisca']['mapping']['fisca_api_authorization_header_token_key'] = [
+    'type' => 'string',
+    'label' => 'Fisca API Authorization Header - Token Key',
+  ];
+}
+
+/**
+ * Implements hook_webform_third_party_settings_form_alter().
+ */
+function webform_openfisca_key_auth_webform_third_party_settings_form_alter(array &$form, FormStateInterface $form_state) : void {
+  $form_object = $form_state->getFormObject();
+  if (!$form_object instanceof EntityFormInterface) {
+    return;
+  }
+  $webform = $form_object->getEntity();
+  if (!$webform instanceof WebformInterface) {
+    return;
+  }
+
+  $token_key = (string) $webform->getThirdPartySetting('webform_openfisca', 'fisca_api_authorization_header_token_key', '');
+  $form['third_party_settings']['webform_openfisca']['fisca_api_authorization_header_token_key'] = [
+    '#type' => 'key_select',
+    '#key_filters' => ['type' => 'authentication'],
+    '#title' => t('Authorization token key'),
+    '#description' => t('Specify the key storing the token for the Authorization header above. The token will be appended to the Authorization header when making API calls to OpenFisca.'),
+    '#default_value' => $token_key,
+    '#weight' => -59,
+  ];
+}
+
+/**
+ * Implements hook_webform_openfisca_client_options_alter().
+ */
+function webform_openfisca_key_auth_webform_openfisca_client_options_alter(array &$options, array &$context, array &$webform_openfisca_context) : void {
+  /** @var \Drupal\webform_openfisca\WebformOpenFiscaSettings $webform_openfisca_settings */
+  $webform_openfisca_settings = $webform_openfisca_context['webform_openfisca_settings'] ?? NULL;
+  if (!$webform_openfisca_settings instanceof WebformOpenFiscaSettings) {
+    return;
+  }
+
+  $webform = Webform::load($webform_openfisca_settings->getWebformId());
+  if (!$webform instanceof WebformInterface) {
+    return;
+  }
+
+  $token_key = (string) $webform->getThirdPartySetting('webform_openfisca', 'fisca_api_authorization_header_token_key', '');
+  if (!$token_key) {
+    return;
+  }
+
+  /** @var \Drupal\key\KeyRepositoryInterface $key_repository */
+  $key_repository = \Drupal::service('key.repository');
+  $key = $key_repository->getKey($token_key);
+  if (!$key instanceof KeyInterface) {
+    return;
+  }
+
+  $token = $key->getKeyValue();
+  if (!empty($token)) {
+    $auth_header = $options['headers']['Authorization'] ?? '';
+    $auth_header = trim($auth_header) . ' ' . $token;
+    $options['headers']['Authorization'] = $auth_header;
+  }
+}

src/WebformThirdPartySettingsFormAlter.php

@@ -36,31 +36,36 @@ public function alterForm(array &$form, FormStateInterface $form_state): void {
       '#title' => $this->t('Enable OpenFisca RaC integration'),
       '#description' => '',
       '#default_value' => $openfisca_settings->isEnabled(),
+      '#weight' => -100,
     ];
     $form['third_party_settings']['webform_openfisca']['fisca_debug_mode'] = [
       '#type' => 'checkbox',
       '#title' => $this->t('Enable debug mode'),
       '#description' => '',
       '#default_value' => $openfisca_settings->isDebugEnabled(),
+      '#weight' => -90,
     ];
     $form['third_party_settings']['webform_openfisca']['fisca_logging_mode'] = [
       '#type' => 'checkbox',
       '#title' => $this->t('Log OpenFisca calculation'),
       '#description' => '',
       '#default_value' => $openfisca_settings->isLoggingEnabled(),
+      '#weight' => -80,
     ];
     $form['third_party_settings']['webform_openfisca']['fisca_api_endpoint'] = [
       '#type' => 'textfield',
       '#title' => $this->t('OpenFisca API endpoint'),
       '#description' => $this->t('Specify the API endpoint to the Fisca Rule'),
       '#default_value' => $openfisca_settings->getApiEndpoint(),
+      '#weight' => -70,
     ];
     $form['third_party_settings']['webform_openfisca']['fisca_api_authorization_header'] = [
       '#type' => 'textfield',
       '#title' => $this->t('Authorization header to connect to OpenFisca API'),
       '#description' => $this->t('Specify the Authorization header to connect to a private OpenFisca API, e.g. a Basic auth or a Bearer token.'),
       '#default_value' => $openfisca_settings->getApiAuthorizationHeader(),
       '#field_prefix' => $this->t('Authorization:'),
+      '#weight' => -60,
     ];
     $form['third_party_settings']['webform_openfisca']['fisca_return_key'] = [
       '#type' => 'webform_codemirror',
@@ -69,6 +74,7 @@ public function alterForm(array &$form, FormStateInterface $form_state): void {
       '#title' => $this->t('The keys for the return value'),
       '#description' => $this->t('Specify the keys for the return value that needs to be checked. Comma separated.'),
       '#default_value' => $openfisca_settings->getPlainReturnKeys(),
+      '#weight' => -50,
     ];
     $form['third_party_settings']['webform_openfisca']['fisca_field_mappings'] = [
       '#type' => 'webform_codemirror',
@@ -81,6 +87,7 @@ public function alterForm(array &$form, FormStateInterface $form_state): void {
       '#title' => $this->t('OpenFisca Field mappings'),
       '#description' => $this->t('Specify the field mappings'),
       '#default_value' => $openfisca_settings->getJsonFieldMappings(),
+      '#weight' => -40,
     ];
     $form['third_party_settings']['webform_openfisca']['fisca_variables'] = [
       '#type' => 'webform_codemirror',
@@ -93,6 +100,7 @@ public function alterForm(array &$form, FormStateInterface $form_state): void {
       '#title' => $this->t('OpenFisca Variables'),
       '#description' => $this->t('Specify the variables from OpenFisca API'),
       '#default_value' => $openfisca_settings->getJsonVariables(),
+      '#weight' => -30,
     ];
     $form['third_party_settings']['webform_openfisca']['fisca_parameter_tokens'] = [
       '#type' => 'webform_codemirror',
@@ -101,6 +109,7 @@ public function alterForm(array &$form, FormStateInterface $form_state): void {
       '#title' => $this->t('OpenFisca parameter tokens'),
       '#description' => $this->t('Specify the OpenFisca parameters used as tokens. Comma separated.'),
       '#default_value' => $openfisca_settings->getPlainParameterTokens(),
+      '#weight' => -20,
     ];
     $form['third_party_settings']['webform_openfisca']['fisca_entity_roles'] = [
       '#type' => 'webform_codemirror',
@@ -113,6 +122,7 @@ public function alterForm(array &$form, FormStateInterface $form_state): void {
       '#title' => $this->t('OpenFisca Field Entity Roles'),
       '#description' => $this->t('Specify the field entity roles for OpenFisca API'),
       '#default_value' => $openfisca_settings->getJsonEntityRoles(),
+      '#weight' => -10,
     ];
     $form['third_party_settings']['webform_openfisca']['fisca_immediate_response_mapping'] = [
       '#type' => 'webform_codemirror',
@@ -125,6 +135,7 @@ public function alterForm(array &$form, FormStateInterface $form_state): void {
       '#title' => $this->t('OpenFisca immediate response mapping'),
       '#description' => $this->t('Specify the field immediate response mapping'),
       '#default_value' => $openfisca_settings->getJsonImmediateResponseMapping(),
+      '#weight' => 0,
     ];
     $form['third_party_settings']['webform_openfisca']['fisca_immediate_exit_mapping'] = [
       '#type' => 'webform_codemirror',
@@ -133,12 +144,14 @@ public function alterForm(array &$form, FormStateInterface $form_state): void {
       '#title' => $this->t('OpenFisca immediate exit mapping'),
       '#description' => $this->t('Specify the return keys of OpenFisca response to map to immediate exit. Comma separated.'),
       '#default_value' => $openfisca_settings->getPlainImmediateExitKeys(),
+      '#weight' => 10,
     ];
     $form['third_party_settings']['webform_openfisca']['fisca_immediate_response_ajax_indicator'] = [
       '#type' => 'checkbox',
       '#title' => $this->t('Display Ajax indicator'),
       '#description' => $this->t('Whether to display an Ajax indicator when an immediate response is required.'),
       '#default_value' => $openfisca_settings->hasImmediateResponseAjaxIndicator(),
+      '#weight' => 20,
     ];
     $form['#validate'][] = [$this, 'validateForm'];
   }

webform_openfisca.info.yml

@@ -1,11 +1,11 @@
-name: 'Webform OpenFisca'
+name: Webform OpenFisca
 type: module
-description: 'Adds OpenFisca support for RaC enabled webforms.'
+description: Adds OpenFisca support for RaC enabled webforms.
 package: Webform
 core_version_requirement: ^10 || ^11
 configure: webform_openfisca.settings
 dependencies:
-  - 'webform:webform'
-  - 'webform_ui:webform_ui'
-  - 'paragraphs:paragraphs'
-  - 'token:token'
+  - webform:webform
+  - webform_ui:webform_ui
+  - paragraphs:paragraphs
+  - token:token