foreman_webhooks 5.0.1 → 5.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 27a02852b9247c1b74c362b9e84f72b7585e45976b9c58bc3d50bd81278467c3
-  data.tar.gz: 99fbe30a245a5594b955c25ab64818ee81f23248d1de2a17aadf61041becf974
+  metadata.gz: b0e6639b74aa9598f8a7961d48dd5c2bf81714bb6f6111e9f9bbb65a2393a4d2
+  data.tar.gz: fbe6d793527bf76fd9c3d73e357c7a4da87e3a77b1a8636652569e47955ef928
 SHA512:
-  metadata.gz: ad3089c50b01e80b35a9e35f63c8fee7752f06a4ca1be6528eff178a9e679da6412b2ed7f518745a265ecb651d5f2e6feff27686aa63a145a8ea512fe21f4846
-  data.tar.gz: 2834fe2d67940bcecab03cf62df919b77682cbe1df7bc05411c92e19158f4a39e33ccafae16baa9f5736424b1aa433cb9ea7f4063d424ef898222a2835ca4ea1
+  metadata.gz: 7de4a54540a300b0d0f5de39b79275074c403f4d74ccf1a5d53fa22f77ae6bfba2788f26824b8642608da39ef09e4bd99be88fdf7a615e527cb1070066730631
+  data.tar.gz: 752cb5d63594e68e313b9a91a4fce2955a0fce47ad51a25351c0f9c43df4104ad2a456dd1e9651b2d7b51a65daef196c1f39ddf726e7b701ad146455238b00d0

data/lib/foreman_webhooks/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ForemanWebhooks
-  VERSION = "5.0.1"
+  VERSION = "5.0.2"
 end

data/test/integration/webhooks_test.rb

@@ -118,6 +118,101 @@ class WebhooksIntegrationTest < IntegrationTestWithJavascript
     assert webhook.password.present?, 'Password was cleared after update'
   end
 
+  test 'edit webhook modal shows selected webhook instead of previous one' do
+    first_webhook = FactoryBot.create(:webhook,
+      name: 'FirstWebhook',
+      target_url: 'http://example.com/webhook1',
+      http_method: 'POST',
+      webhook_template: webhook_template)
+    second_webhook = FactoryBot.create(:webhook,
+      name: 'SecondWebhook',
+      target_url: 'http://example.com/webhook2',
+      http_method: 'POST',
+      webhook_template: webhook_template)
+
+    visit '/webhooks'
+    wait_for_ajax
+    click_webhook_name(first_webhook.name)
+    assert_selector '.pf-v5-c-modal-box'
+    click_cancel_button
+    wait_for_ajax
+    click_webhook_name(second_webhook.name)
+    assert_selector '.pf-v5-c-modal-box'
+    assert_field_value('id-name', second_webhook.name)
+    click_cancel_button
+    assert_no_selector '.pf-v5-c-modal-box'
+  end
+
+  test 'should update password' do
+    webhook = FactoryBot.create(:webhook,
+      name: 'PasswordUpdateWebhook',
+      target_url: 'http://example.com/webhook',
+      http_method: 'POST',
+      webhook_template: webhook_template,
+      password: 'oldpassword123')
+    new_password = 'newpassword456'
+    visit '/webhooks'
+    wait_for_ajax
+    click_webhook_name(webhook.name)
+    assert_selector '.pf-v5-c-modal-box'
+    click_tab('Credentials')
+    click_change_password_button
+    fill_in 'id-password', with: new_password
+    click_submit_button
+    wait_for_success_toast
+    webhook.reload
+    assert_equal new_password, webhook.password, 'Password was not updated in database'
+  end
+
+  test 'edit submission triggers PUT /api/webhooks/id and GET /api/webhooks only' do
+    first_webhook = FactoryBot.create(:webhook,
+      name: 'FirstWebhook',
+      target_url: 'http://example.com/webhook1',
+      http_method: 'POST',
+      webhook_template: webhook_template)
+    second_webhook = FactoryBot.create(:webhook,
+      name: 'SecondWebhook',
+      target_url: 'http://example.com/webhook2',
+      http_method: 'POST',
+      webhook_template: webhook_template)
+
+    visit '/webhooks'
+    wait_for_ajax
+    click_webhook_name(first_webhook.name)
+    assert_selector '.pf-v5-c-modal-box'
+
+    click_cancel_button
+    wait_for_ajax
+    click_webhook_name(second_webhook.name)
+    assert_selector '.pf-v5-c-modal-box'
+
+    fill_in 'id-name', with: '', fill_options: { clear: :backspace }
+    fill_in 'id-name', with: 'UpdatedAPITestWebhook'
+
+    api_requests = []
+    callback = lambda { |_name, _started, _finished, _unique_id, payload|
+      api_requests << { method: payload[:method], controller: payload[:controller], action: payload[:action], path: payload[:path] } if payload[:controller]&.start_with?('Api::')
+    }
+
+    ActiveSupport::Notifications.subscribed(callback, 'process_action.action_controller') do
+      click_submit_button
+      wait_for_success_toast
+      wait_for_ajax
+    end
+
+    assert api_requests.any? { |r| r[:method] == 'PUT' && r[:controller] == 'Api::V2::WebhooksController' && r[:action] == 'update' },
+      "Expected PUT webhooks#update, got: #{api_requests.inspect}"
+    assert api_requests.any? { |r| r[:method] == 'GET' && r[:controller] == 'Api::V2::WebhooksController' && r[:action] == 'index' },
+      "Expected GET webhooks#index, got: #{api_requests.inspect}"
+
+    assert api_requests.none? { |r| r[:controller] == 'Api::V2::WebhooksController' && r[:action] == 'events' },
+      "Unexpected call to webhooks#events: #{api_requests.inspect}"
+    assert api_requests.none? { |r| r[:controller] == 'Api::V2::WebhookTemplatesController' },
+      "Unexpected call to webhook_templates: #{api_requests.inspect}"
+    assert api_requests.none? { |r| r[:controller] == 'Api::V2::WebhooksController' && r[:action] == 'show' },
+      "Unexpected call to webhooks#show: #{api_requests.inspect}"
+  end
+
   test 'delete webhook via UI' do
     webhook = FactoryBot.create(:webhook,
       name: 'WebhookToDelete',
@@ -190,6 +285,13 @@ class WebhooksIntegrationTest < IntegrationTestWithJavascript
     page.execute_script('arguments[0].click()', button.native)
   end
 
+  def click_change_password_button
+    modal = find('.pf-v5-c-modal-box', wait: 10)
+    button = modal.find(:ouia_component_id, 'reset-password', wait: 10, visible: :all)
+    page.execute_script('arguments[0].scrollIntoView({block: "center"})', button.native)
+    page.execute_script('arguments[0].click()', button.native)
+  end
+
   def click_webhook_name(name)
     row = find(:xpath, "//tbody//tr[contains(., '#{name}')]", wait: 15, match: :first)
     within(row) do

data/webpack/ForemanWebhooks/Routes/Webhooks/Components/WebhookForm/Components/FieldConstructor.js

@@ -28,7 +28,6 @@ const FormField = ({
   type,
   required,
   options,
-  isLoading,
   validated,
   value,
   disabled,
@@ -36,11 +35,11 @@ const FormField = ({
   placeholder,
   errMsg,
   fieldId,
+  setIsPasswordDisabled,
   ...props
 }) => {
   const [fieldValidated, setFieldValidated] = useState('default');
   const [firstLoad, setFirstLoad] = useState(true);
-  const [isDisabled, setIsDisabled] = useState(disabled);
 
   const requiredValidate = () => {
     if (firstLoad || !required) return;
@@ -57,10 +56,6 @@ const FormField = ({
     setFirstLoad(false);
   }, []);
 
-  useEffect(() => {
-    setIsDisabled(disabled);
-  }, [disabled]);
-
   useEffect(() => {
     requiredValidate();
     // eslint-disable-next-line react-hooks/exhaustive-deps
@@ -76,7 +71,7 @@ const FormField = ({
           onChange={(_, newValue) => {
             setValue(name, newValue);
           }}
-          isDisabled={isLoading || isDisabled}
+          isDisabled={disabled}
           isRequired={required}
           type={type}
           validated={fieldValidated}
@@ -94,7 +89,7 @@ const FormField = ({
           value={value ?? ''}
           onChange={(_, newValue) => setValue(name, newValue)}
           isRequired={required}
-          isDisabled={isLoading || isDisabled}
+          isDisabled={disabled}
           type={type}
           validated={fieldValidated}
           placeholder={placeholder}
@@ -121,7 +116,7 @@ const FormField = ({
   }
   return (
     <>
-      {name === 'password' && (isDisabled || disabled) ? (
+      {name === 'password' && disabled && setIsPasswordDisabled ? (
         <Grid hasGutter={false}>
           <GridItem span={11}>
             <TextInput
@@ -129,7 +124,7 @@ const FormField = ({
               value={value ?? ''}
               id={fieldId ?? `id-${name}`}
               onChange={localHandler}
-              isDisabled={isLoading || isDisabled}
+              isDisabled={disabled}
               isRequired={required}
               type={type}
               validated={fieldValidated}
@@ -141,7 +136,7 @@ const FormField = ({
           <GridItem span={1}>
             <Button
               ouiaId={`reset-${name}`}
-              onClick={() => setIsDisabled(false)}
+              onClick={() => setIsPasswordDisabled(!disabled)}
               variant="control"
               icon={<PencilAltIcon />}
             />
@@ -153,11 +148,9 @@ const FormField = ({
           value={value ?? ''}
           id={fieldId ?? `id-${name}`}
           onChange={localHandler}
-          isDisabled={isLoading || isDisabled}
           isRequired={required}
           type={type}
           validated={fieldValidated}
-          placeholder={placeholder}
           onBlur={requiredValidate}
           autoComplete={type === 'password' ? 'new-password' : null}
         />
@@ -283,7 +276,6 @@ FormField.propTypes = {
       label: PropTypes.string.isRequired,
     })
   ),
-  isLoading: PropTypes.bool,
   validated: PropTypes.string,
   placeholder: PropTypes.string,
   errMsg: PropTypes.string,
@@ -303,7 +295,6 @@ FormField.defaultProps = {
   required: false,
   allowClear: false,
   options: [],
-  isLoading: false,
   disabled: false,
   value: '',
   fieldId: undefined,

data/webpack/ForemanWebhooks/Routes/Webhooks/Components/WebhookForm/Components/WebhookFormTabs.js

@@ -18,6 +18,7 @@ const WebhookFormTabs = ({
   isTemplatesLoading,
   isEventsLoading,
   isPasswordDisabled,
+  setIsPasswordDisabled,
   urlValidated,
 }) => {
   const updateFieldValue = (key, value) => {
@@ -141,6 +142,8 @@ const WebhookFormTabs = ({
             labelHelp={__('Authentication credentials')}
             disabled={isPasswordDisabled}
             setValue={updateFieldValue}
+            setIsPasswordDisabled={setIsPasswordDisabled}
+            placeholder="********"
           />
           <FieldConstructor
             name="verify_ssl"
@@ -218,11 +221,13 @@ WebhookFormTabs.propTypes = {
   isTemplatesLoading: PropTypes.bool.isRequired,
   isEventsLoading: PropTypes.bool.isRequired,
   isPasswordDisabled: PropTypes.bool,
+  setIsPasswordDisabled: PropTypes.func,
   urlValidated: PropTypes.func.isRequired,
 };
 
 WebhookFormTabs.defaultProps = {
   isPasswordDisabled: false,
+  setIsPasswordDisabled: null,
 };
 
 export default WebhookFormTabs;

data/webpack/ForemanWebhooks/Routes/Webhooks/Components/WebhookForm/Components/__tests__/FieldConstructor.test.js

@@ -60,10 +60,10 @@ describe('FieldConstructor RTL Tests', () => {
       );
     });
 
-    test('renders as disabled when loading', () => {
+    test('renders as enabled when loading', () => {
       render(<FieldConstructor {...defaultProps} type="text" isLoading />);
 
-      expect(document.getElementById('id-test-field')).toBeDisabled();
+      expect(document.getElementById('id-test-field')).toBeEnabled();
     });
   });
 

data/webpack/ForemanWebhooks/Routes/Webhooks/Components/WebhookForm/WebhookForm.js

@@ -8,7 +8,6 @@ import { HTTP_METHODS } from './constants';
 
 const WebhookForm = ({
   onCancel,
-  isLoading,
   handleSubmit,
   initialValues,
   templates,
@@ -16,6 +15,8 @@ const WebhookForm = ({
   isTemplatesLoading,
   isEventsLoading,
   isPasswordDisabled,
+  setIsPasswordDisabled,
+  isSubmitting,
 }) => {
   const webhookTemplates = templates.map(t => ({ value: t.id, label: t.name }));
 
@@ -71,18 +72,24 @@ const WebhookForm = ({
         isEventsLoading={isEventsLoading}
         isTemplatesLoading={isTemplatesLoading}
         isPasswordDisabled={isPasswordDisabled}
+        setIsPasswordDisabled={setIsPasswordDisabled}
         urlValidated={urlValidated}
       />
       <ActionGroup>
         <Button
           ouiaId="submit-webhook-form"
-          isDisabled={verifyFields() || isLoading}
+          isDisabled={verifyFields() || isSubmitting}
           variant="primary"
           onClick={() => handleSubmit(inputValues)}
         >
           {__('Submit')}
         </Button>
-        <Button ouiaId="cancel-webhook-form" variant="link" onClick={onCancel}>
+        <Button
+          ouiaId="cancel-webhook-form"
+          variant="link"
+          onClick={onCancel}
+          isDisabled={isSubmitting}
+        >
           {__('Cancel')}
         </Button>
       </ActionGroup>
@@ -91,7 +98,6 @@ const WebhookForm = ({
 };
 
 WebhookForm.propTypes = {
-  isLoading: PropTypes.bool.isRequired,
   onCancel: PropTypes.func.isRequired,
   handleSubmit: PropTypes.func.isRequired,
   initialValues: PropTypes.object.isRequired,
@@ -100,10 +106,14 @@ WebhookForm.propTypes = {
   isEventsLoading: PropTypes.bool.isRequired,
   isTemplatesLoading: PropTypes.bool.isRequired,
   isPasswordDisabled: PropTypes.bool,
+  setIsPasswordDisabled: PropTypes.func,
+  isSubmitting: PropTypes.bool,
 };
 
 WebhookForm.defaultProps = {
   isPasswordDisabled: false,
+  setIsPasswordDisabled: null,
+  isSubmitting: false,
 };
 
 export default WebhookForm;

data/webpack/ForemanWebhooks/Routes/Webhooks/Components/WebhookForm/index.js

@@ -25,11 +25,12 @@ import {
 const params = { page: 1, search: 'snippet = false', per_page: 'all' };
 
 const ConnectedWebhookForm = ({
-  isLoading,
   onCancel,
   handleSubmit,
   initialValues,
   isPasswordDisabled,
+  setIsPasswordDisabled,
+  isSubmitting,
 }) => {
   const dispatch = useDispatch();
 
@@ -59,7 +60,6 @@ const ConnectedWebhookForm = ({
 
   return (
     <WebhookForm
-      isLoading={isLoading}
       templates={templates}
       availableEvents={availableEvents}
       onCancel={onCancel}
@@ -68,20 +68,25 @@ const ConnectedWebhookForm = ({
       isTemplatesLoading={isTemplatesLoading}
       isEventsLoading={isEventsLoading}
       isPasswordDisabled={isPasswordDisabled}
+      setIsPasswordDisabled={setIsPasswordDisabled}
+      isSubmitting={isSubmitting}
     />
   );
 };
 
 ConnectedWebhookForm.propTypes = {
-  isLoading: PropTypes.bool.isRequired,
   onCancel: PropTypes.func.isRequired,
   handleSubmit: PropTypes.func.isRequired,
   initialValues: PropTypes.object.isRequired,
   isPasswordDisabled: PropTypes.bool,
+  setIsPasswordDisabled: PropTypes.func,
+  isSubmitting: PropTypes.bool,
 };
 
 ConnectedWebhookForm.defaultProps = {
   isPasswordDisabled: false,
+  setIsPasswordDisabled: null,
+  isSubmitting: false,
 };
 
 export default ConnectedWebhookForm;

data/webpack/ForemanWebhooks/Routes/Webhooks/WebhooksIndexPage/Components/WebhookCreateModal.js

@@ -15,8 +15,8 @@ import './WebhookModal.scss';
 
 const WebhookCreateModal = ({ onSuccess, onCancel, isOpen }) => {
   const dispatch = useDispatch();
+  const [isSubmitting, setIsSubmitting] = useState(false);
 
-  const [isLoading, setIsLoading] = useState(false);
   const initialWebhookValues = {
     name: '',
     target_url: '',
@@ -34,7 +34,7 @@ const WebhookCreateModal = ({ onSuccess, onCancel, isOpen }) => {
   };
 
   const handleSubmit = values => {
-    setIsLoading(true);
+    setIsSubmitting(true);
     dispatch(
       APIActions.post({
         url: foremanUrl(`/api${WEBHOOKS_PATH}`),
@@ -43,9 +43,8 @@ const WebhookCreateModal = ({ onSuccess, onCancel, isOpen }) => {
         successToast: () => __('Webhook was successfully created.'),
         handleSuccess: () => {
           onSuccess();
-          setIsLoading(false);
         },
-        handleError: () => setIsLoading(false),
+        handleError: () => setIsSubmitting(false),
         errorToast: ({ response }) =>
           // eslint-disable-next-line camelcase
           response?.data?.error?.full_messages?.[0] || response,
@@ -64,10 +63,10 @@ const WebhookCreateModal = ({ onSuccess, onCancel, isOpen }) => {
       title={__('Create Webhook')}
     >
       <ConnectedWebhookForm
-        isLoading={isLoading}
         handleSubmit={handleSubmit}
         initialValues={initialWebhookValues}
         onCancel={onCancel}
+        isSubmitting={isSubmitting}
       />
     </Modal>
   );

data/webpack/ForemanWebhooks/Routes/Webhooks/WebhooksIndexPage/Components/WebhookDeleteModal.js

@@ -1,4 +1,4 @@
-import React from 'react';
+import React, { useState } from 'react';
 import PropTypes from 'prop-types';
 
 import { APIActions } from 'foremanReact/redux/API';
@@ -12,8 +12,10 @@ import { WEBHOOK_DELETE_MODAL_ID } from '../../constants';
 const WebhookDeleteModal = ({ toDelete, onSuccess, modalState }) => {
   const { id, name } = toDelete;
 
+  const [isSubmitting, setIsSubmitting] = useState(false);
   const dispatch = useDispatch();
-  const handleSubmit = () =>
+  const handleSubmit = () => {
+    setIsSubmitting(true);
     dispatch(
       APIActions.delete({
         url: foremanUrl(`/api/v2/webhooks/${id}`),
@@ -24,8 +26,10 @@ const WebhookDeleteModal = ({ toDelete, onSuccess, modalState }) => {
           // eslint-disable-next-line camelcase
           response?.response?.data?.error?.full_messages?.[0] || response,
         handleSuccess: onSuccess,
+        handleError: () => setIsSubmitting(false),
       })
     );
+  };
 
   return (
     <Modal
@@ -45,6 +49,7 @@ const WebhookDeleteModal = ({ toDelete, onSuccess, modalState }) => {
           ouiaId="submitBtn"
           key="confirm"
           variant="danger"
+          isDisabled={isSubmitting}
           onClick={handleSubmit}
         >
           {__('Delete')}
@@ -53,6 +58,7 @@ const WebhookDeleteModal = ({ toDelete, onSuccess, modalState }) => {
           ouiaId="cancelBtn"
           key="cancel"
           variant="link"
+          isDisabled={isSubmitting}
           onClick={modalState.closeModal}
         >
           {__('Cancel')}

data/webpack/ForemanWebhooks/Routes/Webhooks/WebhooksIndexPage/Components/WebhookEditModal.js

@@ -15,9 +15,11 @@ import {
   WEBHOOK_API_REQUEST_KEY,
   WEBHOOK_EDIT_MODAL_ID,
   WEBHOOKS_API_PLAIN_PATH,
+  WEBHOOK_API_UPDATE_KEY,
 } from '../../constants';
 
 import {
+  selectIsLoading,
   selectWebhookValues,
   selectWebhookTemplateId,
 } from './WebhookEditModalSelectors';
@@ -27,8 +29,10 @@ import './WebhookModal.scss';
 const WebhookEditModal = ({ toEdit, onSuccess, modalState }) => {
   const dispatch = useDispatch();
 
+  const isLoading = useSelector(selectIsLoading);
+
+  const [isSubmitting, setIsSubmitting] = useState(false);
   const [isPasswordDisabled, setIsPasswordDisabled] = useState(false);
-  const [isLoading, setIsLoading] = useState(true);
   const id = toEdit;
 
   const isPasswordSet = useSelector(selectWebhookValues).passwordSet;
@@ -54,20 +58,20 @@ const WebhookEditModal = ({ toEdit, onSuccess, modalState }) => {
   }, [isPasswordSet]);
 
   const handleSubmit = values => {
-    setIsLoading(true);
+    setIsSubmitting(true);
     if (isPasswordDisabled) {
       delete values.password;
     }
     dispatch(
       put({
         url: foremanUrl(`/api${WEBHOOKS_PATH}/${id}`),
-        key: WEBHOOK_API_REQUEST_KEY,
+        key: WEBHOOK_API_UPDATE_KEY,
         params: { ...values, controller: 'webhooks' },
         successToast: () => __('Webhook was successfully updated.'),
         handleSuccess: () => {
           onSuccess();
-          setIsLoading(false);
         },
+        handleError: () => setIsSubmitting(false),
         errorToast: ({ response }) =>
           // eslint-disable-next-line camelcase
           response?.data?.error?.full_messages?.[0] || response,
@@ -75,10 +79,6 @@ const WebhookEditModal = ({ toEdit, onSuccess, modalState }) => {
     );
   };
 
-  useEffect(() => {
-    if (initialWebhookValues.id) setIsLoading(false);
-  }, [initialWebhookValues.id]);
-
   useEffect(() => {
     if (id) {
       dispatch(
@@ -111,12 +111,12 @@ const WebhookEditModal = ({ toEdit, onSuccess, modalState }) => {
         <Loading />
       ) : (
         <ConnectedWebhookForm
-          isLoading={isLoading}
           handleSubmit={handleSubmit}
           initialValues={initialWebhookValues}
           onCancel={onEditCancel}
           isPasswordDisabled={isPasswordDisabled}
           setIsPasswordDisabled={setIsPasswordDisabled}
+          isSubmitting={isSubmitting}
         />
       )}
     </Modal>

data/webpack/ForemanWebhooks/Routes/Webhooks/WebhooksIndexPage/Components/WebhooksTable/index.js

@@ -41,15 +41,24 @@ const WrappedWebhooksTable = props => {
       modalsStates={{
         testModal: {
           isOpen: isTestModalOpen,
-          closeModal: () => setIsTestModalOpen(false),
+          closeModal: () => {
+            setToTest({});
+            setIsTestModalOpen(false);
+          },
         },
         deleteModal: {
           isOpen: isDeleteModalOpen,
-          closeModal: () => setIsDeleteModalOpen(false),
+          closeModal: () => {
+            setToDelete({});
+            setIsDeleteModalOpen(false);
+          },
         },
         editModal: {
           isOpen: isEditModalOpen,
-          closeModal: () => setIsEditModalOpen(false),
+          closeModal: () => {
+            setToEdit(0);
+            setIsEditModalOpen(false);
+          },
         },
       }}
       webhookActions={webhookActions}

data/webpack/ForemanWebhooks/Routes/Webhooks/constants.js

@@ -13,6 +13,7 @@ export const WEBHOOK_TEMPLATES_API_PATH =
 export const WEBHOOKS_API_PLAIN_PATH = '/api/v2/webhooks';
 export const WEBHOOK_TEMPLATES_API_REQUEST_KEY = 'WEBHOOK_TEMPLATES';
 export const WEBHOOK_API_REQUEST_KEY = 'WEBHOOK';
+export const WEBHOOK_API_UPDATE_KEY = 'WEBHOOK_UPDATE';
 export const WEBHOOK_EVENTS_API_REQUEST_KEY = 'WEBHOOK_EVENTS';
 
 export const WEBHOOK_CREATE_MODAL_ID = 'webhookCreateModal';

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: foreman_webhooks
 version: !ruby/object:Gem::Version
-  version: 5.0.1
+  version: 5.0.2
 platform: ruby
 authors:
 - Timo Goebel