foreman_remote_execution 18.0.1 → 18.1.0

data/locale/zh_CN/foreman_remote_execution.po

@@ -135,7 +135,7 @@ msgid "Alphabetical"
 msgstr "按字母"
 
 msgid "Already on the review step"
-msgstr ""
+msgstr "已在审阅步骤中"
 
 msgid "An error occurred while fetching the template invocation details."
 msgstr "在获取模板调用详情时出错。"
@@ -267,28 +267,28 @@ msgid "Copy to clipboard"
 msgstr "复制到剪贴板"
 
 msgid "Could not abort the job %s: %s"
-msgstr ""
+msgstr "无法中止作业 %s: %s"
 
 msgid "Could not abort the task"
 msgstr "无法中止作业"
 
 msgid "Could not cancel recurring logic %s: %s"
-msgstr ""
+msgstr "无法取消循环逻辑 %s：%s"
 
 msgid "Could not cancel the job %s: %s"
-msgstr ""
+msgstr "无法取消作业 %s: %s"
 
 msgid "Could not cancel the task"
 msgstr "无法取消作业"
 
 msgid "Could not disable recurring logic %s: %s"
-msgstr ""
+msgstr "无法禁用重复逻辑 %s：%s"
 
 msgid "Could not display data for job invocation."
 msgstr "无法显示用于作业调用的数据。"
 
 msgid "Could not enable recurring logic %s: %s"
-msgstr ""
+msgstr "无法启用重复逻辑 %s：%s"
 
 msgid "Could not find any suitable interface for execution"
 msgstr "无法找到适合执行的接口"
@@ -321,7 +321,7 @@ msgid "Create a job template"
 msgstr "创建作业模板"
 
 msgid "Create a new job invocation"
-msgstr ""
+msgstr "创建新作业调用"
 
 msgid "Create a recurring job"
 msgstr "创建一个重复运行的作业"
@@ -414,7 +414,7 @@ msgid "Designation of a special purpose"
 msgstr "设计特殊目的"
 
 msgid "Directory on the host where remote execution jobs in push mode place and run their scripts. You can override this setting per host with the `remote_execution_remote_working_dir` host parameter."
-msgstr ""
+msgstr "主机上以推送模式运行的远程执行作业存放并运行其脚本的目录。。您可以使用 'remote_execution_remote_working_dir' 主机参数覆盖每个主机的设置。"
 
 msgid "Disable recurring"
 msgstr "禁用重复"
@@ -552,7 +552,7 @@ msgid "Failed rendering template: %s"
 msgstr "呈现模板失败：%s"
 
 msgid "Failed to load host invocation data"
-msgstr ""
+msgstr "加载主机调用数据失败"
 
 msgid "Failed:"
 msgstr "失败："
@@ -609,7 +609,7 @@ msgid "Get raw output for a host"
 msgstr "获取主机的原始输出"
 
 msgid "Go to job invocations"
-msgstr ""
+msgstr "返回到作业调用"
 
 msgid "Has to be a positive number"
 msgstr "必须为一个正数"
@@ -678,10 +678,10 @@ msgid "Include all inputs from the foreign template"
 msgstr "在外部模板中包含所有输入格式"
 
 msgid "Include hosts and template invocations in the response. Defaults to true for backwards compatibility. Pass false to skip serializing all hosts."
-msgstr ""
+msgstr "在响应中包含主机和模板调用。为了向后兼容，默认为 true。设置为 false 来跳过所有主机的序列化。"
 
 msgid "Include per-host task and permission data in the response"
-msgstr ""
+msgstr "在响应中包含每个主机的任务和权限数据"
 
 msgid "Indicates that the action should be cancelled if it cannot be started before this time."
 msgstr "这代表，如果操作无法在这个时间前开始则操作应该被取消。"
@@ -852,7 +852,7 @@ msgid "Minute can only be a number between 0-59"
 msgstr "分钟只能是一个 0-59 之间的数字"
 
 msgid "Missing permissions to generate report templates"
-msgstr ""
+msgstr "缺少生成报告模板的权限"
 
 msgid "Missing the required permissions: ${missingPermissions.join( ', ' )}"
 msgstr "缺少所需的权限：${missingPermissions.join( ', ' )}"
@@ -1098,7 +1098,7 @@ msgid "Recurring logic"
 msgstr "重复逻辑"
 
 msgid "Recurring logic %s cancelled successfully."
-msgstr "成功取消重复逻辑 %s。"
+msgstr "成功取消循环逻辑 %s。"
 
 msgid "Recurring logic %s disabled successfully."
 msgstr "成功禁用重复逻辑 %s。"
@@ -1134,10 +1134,10 @@ msgid "Remote execution job"
 msgstr "远程执行作业"
 
 msgid "Remote working directory"
-msgstr ""
+msgstr "远程工作目录"
 
 msgid "Remote working directory \"%{current_value}\" is not an absolute path"
-msgstr ""
+msgstr "远程工作目录 \"%{current_value}\" 不是绝对路径"
 
 msgid "Repeat a maximum of N times"
 msgstr "最多重复 N 次"
@@ -1152,7 +1152,7 @@ msgid "Repeats"
 msgstr "重复"
 
 msgid "Report template not found or not configured properly"
-msgstr ""
+msgstr "报告模板未找到或未正确配置"
 
 msgid "Rerun"
 msgstr "重新运行"
@@ -1359,7 +1359,7 @@ msgid "Show job invocation"
 msgstr "显示作业调用"
 
 msgid "Show job status for each host, only applicable when include_hosts is true"
-msgstr ""
+msgstr "显示每个主机的作业状态，仅在 include_hosts 为 true 时才适用"
 
 msgid "Show job template details"
 msgstr "显示作业模板详情"
@@ -1675,7 +1675,7 @@ msgid "Unknown"
 msgstr "未知"
 
 msgid "Unknown error."
-msgstr ""
+msgstr "未知错误"
 
 msgid "Unknown execution status"
 msgstr "未知的执行状态"
@@ -1825,7 +1825,7 @@ msgid "host already has an execution interface"
 msgstr "主机已有一个执行接口"
 
 msgid "host method"
-msgstr ""
+msgstr "主机方法"
 
 msgid "hosts"
 msgstr "主机"
@@ -1855,10 +1855,10 @@ msgid "is month (range: 1-12)"
 msgstr "月份（范围：1-12）"
 
 msgid "job invocation"
-msgstr ""
+msgstr "工作调用"
 
 msgid "must be an absolute path"
-msgstr ""
+msgstr "必须是绝对路径"
 
 msgid "no"
 msgstr "否"

data/package.json

@@ -3,12 +3,7 @@
   "version": "1.0.0",
   "license": "GPL-3.0",
   "scripts": {
-    "lint": "tfm-lint --plugin -d /webpack",
-    "lint:custom": "eslint ./webpack",
-    "test": "tfm-test --plugin --config jest.config.js",
-    "test:watch": "tfm-test --plugin --config jest.config.js --watchAll",
-    "test:current": "tfm-test --plugin --config jest.config.js --watch",
-    "publish-coverage": "tfm-publish-coverage"
+    "lint:custom": "eslint ./webpack"
   },
   "repository": {
     "type": "git",
@@ -19,11 +14,6 @@
   },
   "devDependencies": {
     "@babel/core": "^7.7.0",
-    "@theforeman/builder": ">= 15.0.1",
-    "@theforeman/eslint-plugin-foreman": ">= 15.0.1",
-    "@theforeman/eslint-plugin-rules": ">= 15.0.1",
-    "@theforeman/test": ">= 15.0.1",
-    "@theforeman/vendor-dev": ">= 15.0.1",
     "babel-eslint": "^10.0.0",
     "eslint": "^6.8.0",
     "prettier": "^1.19.1",
@@ -32,8 +22,5 @@
     "graphql": "^15.5.0",
     "victory-core": "~36.8.6",
     "victory-pie": "~36.8.6"
-  },
-  "peerDependencies": {
-    "@theforeman/vendor": ">= 15.0.1"
   }
 }

data/test/functional/job_invocations_controller_test.rb

@@ -1,65 +1,8 @@
 # frozen_string_literal: true
 
 require 'test_plugin_helper'
-require_relative '../support/remote_execution_helper'
 
 class JobInvocationsControllerTest < ActionController::TestCase
-  test 'should parse inputs coming from the URL params' do
-    template = FactoryBot.create(:job_template, :with_input)
-    feature = FactoryBot.create(:remote_execution_feature,
-      :job_template => template)
-    params = {
-      feature: feature.label,
-      inputs: { template.template_inputs.first.name => 'foobar' },
-    }
-
-    get :new, params: params, session: set_session_user
-    template_invocation_params = [
-      {
-        'input_values' =>
-        [
-          {
-            'value' => 'foobar',
-            'template_input_id' => template.template_inputs.first.id,
-          },
-        ],
-        'template_id' => template.id,
-      },
-    ]
-    assert_equal(template_invocation_params,
-      assigns(:composer).params['template_invocations'])
-  end
-
-  test 'should allow no inputs' do
-    template = FactoryBot.create(:job_template)
-    feature = FactoryBot.create(:remote_execution_feature,
-      :job_template => template)
-    params = {
-      feature: feature.label,
-    }
-    get :new, params: params, session: set_session_user
-    template_invocation_params = [
-      {
-        'template_id' => template.id,
-        'input_values' => {},
-      },
-    ]
-    assert_equal(template_invocation_params,
-      assigns(:composer).params['template_invocations'])
-  end
-
-  test 'new via GET and POST' do
-    template = FactoryBot.create(:job_template, :with_input)
-    feature = FactoryBot.create(:remote_execution_feature, job_template: template)
-    params = { feature: feature.label, inputs: { template.template_inputs.first.name => 'foobar' } }
-
-    get :new, params: params, session: set_session_user
-    assert_response :success
-
-    post :new, params: params, session: set_session_user
-    assert_response :success
-  end
-
   context '#report' do
     setup do
       @invocation = FactoryBot.create(:job_invocation, :with_template, :with_task)
@@ -167,16 +110,6 @@ class JobInvocationsControllerTest < ActionController::TestCase
         assert 2, assigns(:job_invocations).size
       end
 
-      test '#show' do
-        get :show, params: { id: @invocation2.id }, session: prepare_user(@admin)
-        assert_response :success
-      end
-
-      test '#rerun' do
-        get :rerun, params: { id: @invocation2.id }, session: prepare_user(@admin)
-        assert_response :success
-      end
-
       test '#cancel' do
         ForemanTasks::Task.any_instance.expects(:cancel).returns(true)
         post :cancel, params: { id: @invocation2.id }, session: prepare_user(@admin)
@@ -192,16 +125,6 @@ class JobInvocationsControllerTest < ActionController::TestCase
         assert_equal @invocation2, assigns(:job_invocations)[0]
       end
 
-      test '#show' do
-        get :show, params: { id: @invocation.id }, session: prepare_user(@user)
-        assert_response :not_found
-      end
-
-      test '#rerun' do
-        get :rerun, params: { id: @invocation.id }, session: prepare_user(@user)
-        assert_response :not_found
-      end
-
       test 'cancel' do
         post :cancel, params: { id: @invocation.id }, session: prepare_user(@user)
         assert_response :not_found

data/webpack/JobInvocationDetail/JobInvocationConstants.js

@@ -16,6 +16,8 @@ export const DIRECT_OPEN_HOST_LIMIT = 3;
 export const AWAITING_STATUS_FILTER = '(job_invocation.result = N/A)';
 
 export const AUTO_REFRESH_INTERVAL_MS = 5000;
+export const OUTPUT_REFRESH_INTERVAL_MS = 1000;
+export const OUTPUT_MAX_REFRESH_INTERVAL_MS = 3000;
 export const DEFAULT_CHART_LEGEND_WIDTH = 270;
 export const CLIPBOARD_COPIED_EXIT_DELAY_MS = 1500;
 export const CLIPBOARD_DEFAULT_EXIT_DELAY_MS = 600;
@@ -23,6 +25,9 @@ export const CLIPBOARD_DEFAULT_EXIT_DELAY_MS = 600;
 export const showTemplateInvocationUrl = (hostID, jobID) =>
   `/show_template_invocation_by_host/${hostID}/job_invocation/${jobID}`;
 
+export const templateInvocationOutputUrl = (hostID, jobID) =>
+  `/api/job_invocations/${jobID}/hosts/${hostID}`;
+
 export const templateInvocationPageUrl = (hostID, jobID) =>
   `/job_invocations_detail/${jobID}/host_invocation/${hostID}`;
 

data/webpack/JobInvocationDetail/JobInvocationToolbarButtons.js

@@ -2,7 +2,6 @@ import PropTypes from 'prop-types';
 import React, { useCallback, useMemo, useState } from 'react';
 import { useDispatch, useSelector } from 'react-redux';
 import { Button, Split, SplitItem } from '@patternfly/react-core';
-import { UndoIcon } from '@patternfly/react-icons';
 import {
   Dropdown,
   DropdownItem,
@@ -153,15 +152,6 @@ const JobInvocationToolbarButtons = ({ jobId, data }) => {
         {__('Abort')}
       </DropdownItem>,
       ...recurrenceDropdownItems,
-      <DropdownSeparator ouiaId="dropdown-separator-2" key="separator-2" />,
-      <DropdownItem
-        ouiaId="legacy-ui-dropdown-item"
-        icon={<UndoIcon />}
-        href={`/legacy/job_invocations/${jobId}`}
-        key="legacy-ui"
-      >
-        {__('Legacy UI')}
-      </DropdownItem>,
     ],
     [
       canCancelJobInvocations,

data/webpack/JobInvocationDetail/TemplateInvocation.js

@@ -1,17 +1,13 @@
-import React, { useEffect, useRef } from 'react';
+import React from 'react';
 import { isEmpty } from 'lodash';
 import PropTypes from 'prop-types';
 import { ClipboardCopyButton, Alert, Skeleton } from '@patternfly/react-core';
-import { useDispatch, useSelector } from 'react-redux';
-import { APIActions } from 'foremanReact/redux/API';
+import { useSelector } from 'react-redux';
 import { translate as __ } from 'foremanReact/common/I18n';
 import { useForemanHostDetailsPageUrl } from 'foremanReact/Root/Context/ForemanContext';
 import { STATUS } from 'foremanReact/constants';
 import {
-  showTemplateInvocationUrl,
   templateInvocationPageUrl,
-  GET_TEMPLATE_INVOCATION,
-  AUTO_REFRESH_INTERVAL_MS,
   CLIPBOARD_COPIED_EXIT_DELAY_MS,
   CLIPBOARD_DEFAULT_EXIT_DELAY_MS,
 } from './JobInvocationConstants';
@@ -19,6 +15,7 @@ import {
   selectTemplateInvocationStatus,
   selectTemplateInvocation,
 } from './JobInvocationSelectors';
+import { useTemplateInvocationOutputPolling } from './useTemplateInvocationOutputPolling';
 import { OutputToggleGroup } from './TemplateInvocationComponents/OutputToggleGroup';
 import { PreviewTemplate } from './TemplateInvocationComponents/PreviewTemplate';
 import { OutputCodeBlock } from './TemplateInvocationComponents/OutputCodeBlock';
@@ -74,64 +71,16 @@ export const TemplateInvocation = ({
   showCommand,
   setShowCommand,
 }) => {
-  const timeoutRef = useRef(null);
-  const templateURL = showTemplateInvocationUrl(hostID, jobID);
   const hostDetailsPageUrl = useForemanHostDetailsPageUrl();
 
   const status = useSelector(selectTemplateInvocationStatus(hostID));
   const response = useSelector(selectTemplateInvocation(hostID));
-  const dispatch = useDispatch();
-
-  const responseRef = useRef(response);
-  useEffect(() => {
-    responseRef.current = response;
-  }, [response]);
-
-  useEffect(() => {
-    let cancelled = false;
-
-    const schedulePoll = () => {
-      if (cancelled) return;
-      dispatch(
-        APIActions.get({
-          url: templateURL,
-          key: `${GET_TEMPLATE_INVOCATION}_${hostID}`,
-          handleSuccess: ({ data }) => {
-            if (cancelled) return;
-            const isFinished = data?.finished ?? true;
-            // eslint-disable-next-line camelcase
-            const autoRefresh = data?.auto_refresh || false;
-            if (!isFinished && autoRefresh) {
-              timeoutRef.current = setTimeout(
-                schedulePoll,
-                AUTO_REFRESH_INTERVAL_MS
-              );
-            } else {
-              timeoutRef.current = null;
-            }
-          },
-          handleError: () => {
-            if (cancelled) return;
-            timeoutRef.current = null;
-          },
-        })
-      );
-    };
-
-    clearTimeout(timeoutRef.current);
-    timeoutRef.current = null;
-
-    if (isExpanded) {
-      if (responseRef.current?.finished) return undefined;
-      schedulePoll();
-    }
-
-    return () => {
-      cancelled = true;
-      clearTimeout(timeoutRef.current);
-      timeoutRef.current = null;
-    };
-  }, [isExpanded, dispatch, templateURL, hostID]);
+  const liveOutput = useTemplateInvocationOutputPolling({
+    hostID,
+    jobID,
+    isExpanded,
+    response,
+  });
 
   if (!response || (status === STATUS.PENDING && isEmpty(response))) {
     return <Skeleton data-testid="template-invocation-skeleton" />;
@@ -156,13 +105,7 @@ export const TemplateInvocation = ({
     );
   }
 
-  const {
-    preview,
-    output,
-    input_values: inputValues,
-    task,
-    permissions,
-  } = response;
+  const { preview, input_values: inputValues, task, permissions } = response;
   const { id: taskID, cancellable: taskCancellable } = task || {};
 
   return (
@@ -183,7 +126,7 @@ export const TemplateInvocation = ({
         isInTableView={isInTableView}
         copyToClipboard={
           <CopyToClipboard
-            fullOutput={output
+            fullOutput={liveOutput
               ?.filter(
                 ({ output_type: outputType }) => showOutputType[outputType]
               )
@@ -226,7 +169,7 @@ export const TemplateInvocation = ({
         </>
       )}
       <OutputCodeBlock
-        code={output || []}
+        code={liveOutput}
         showOutputType={showOutputType}
         scrollElement={
           isInTableView

data/webpack/JobInvocationDetail/TemplateInvocationComponents/OutputCodeBlock.js

@@ -9,58 +9,87 @@ import { Button } from '@patternfly/react-core';
 import { translate as __ } from 'foremanReact/common/I18n';
 import { MS_PER_SECOND } from 'foremanReact/constants';
 
+// eslint-disable-next-line no-control-regex
+const COLOR_PATTERN = /\x1b\[[\d;]*m/g;
+const CONSOLE_COLOR = {
+  '31': 'red',
+  '32': 'lightgreen',
+  '33': 'orange',
+  '34': 'deepskyblue',
+  '35': 'mediumpurple',
+  '36': 'cyan',
+  '37': 'grey',
+  '91': 'red',
+  '92': 'lightgreen',
+  '93': 'yellow',
+  '94': 'lightblue',
+  '95': 'violet',
+  '96': 'turquoise',
+  '0': 'default',
+  '39': 'default',
+};
+const parsedOutput = new WeakMap();
+
+const colorizeLine = line => {
+  line = line.replace(COLOR_PATTERN, seq => {
+    const codes = seq.match(/(\d+)/g) || [];
+    const lastColorCode =
+      [...codes].reverse().find(code_ => code_ in CONSOLE_COLOR) || '0';
+    return `{{{format color:${lastColorCode}}}}`;
+  });
+
+  let currentColor = 'default';
+  const parts = line.split(/({{{format.*?}}})/).filter(Boolean);
+  if (parts.length === 0) return <span>{'\n'}</span>;
+
+  // eslint-disable-next-line array-callback-return, consistent-return
+  return parts.map((consoleLine, index) => {
+    if (consoleLine.includes('{{{format')) {
+      const colorMatch = consoleLine.match(/color:(\d+)/);
+      if (colorMatch) {
+        const colorIndex = colorMatch[1];
+        currentColor = CONSOLE_COLOR[colorIndex] || 'default';
+      }
+    } else {
+      return (
+        <span key={index} style={{ color: currentColor }}>
+          {consoleLine.length ? consoleLine : '\n'}
+        </span>
+      );
+    }
+  });
+};
+
+const getLineOutputs = lineSet => {
+  if (parsedOutput.has(lineSet)) return parsedOutput.get(lineSet);
+
+  const lineOutputs =
+    lineSet.output === '\n'
+      ? []
+      : lineSet.output
+          .replace(/\r\n/g, '\n')
+          .replace(/\n$/, '')
+          .split('\n');
+  parsedOutput.set(lineSet, lineOutputs);
+  return lineOutputs;
+};
+
+const OutputLineSet = React.memo(({ lineSet, startLine }) =>
+  getLineOutputs(lineSet).map((lineOutput, index) => (
+    <div key={index} className={`line ${lineSet.output_type}`}>
+      <span
+        className="counter"
+        title={new Date(lineSet.timestamp * MS_PER_SECOND).toISOString()}
+      >
+        {(startLine + index).toString().padStart(4, '\u00A0')}:{' '}
+      </span>
+      <div className="content">{colorizeLine(lineOutput)}</div>
+    </div>
+  ))
+);
+
 export const OutputCodeBlock = ({ code, showOutputType, scrollElement }) => {
   let lineCounter = 0;
-  // eslint-disable-next-line no-control-regex
-  const COLOR_PATTERN = /\x1b\[[\d;]*m/g;
-  const CONSOLE_COLOR = {
-    '31': 'red',
-    '32': 'lightgreen',
-    '33': 'orange',
-    '34': 'deepskyblue',
-    '35': 'mediumpurple',
-    '36': 'cyan',
-    '37': 'grey',
-    '91': 'red',
-    '92': 'lightgreen',
-    '93': 'yellow',
-    '94': 'lightblue',
-    '95': 'violet',
-    '96': 'turquoise',
-    '0': 'default',
-    '39': 'default',
-  };
-
-  const colorizeLine = line => {
-    line = line.replace(COLOR_PATTERN, seq => {
-      const codes = seq.match(/(\d+)/g) || [];
-      const lastColorCode =
-        [...codes].reverse().find(code_ => code_ in CONSOLE_COLOR) || '0';
-      return `{{{format color:${lastColorCode}}}}`;
-    });
-
-    let currentColor = 'default';
-    const parts = line.split(/({{{format.*?}}})/).filter(Boolean);
-    if (parts.length === 0) {
-      return <span>{'\n'}</span>;
-    }
-    // eslint-disable-next-line array-callback-return, consistent-return
-    return parts.map((consoleLine, index) => {
-      if (consoleLine.includes('{{{format')) {
-        const colorMatch = consoleLine.match(/color:(\d+)/);
-        if (colorMatch) {
-          const colorIndex = colorMatch[1];
-          currentColor = CONSOLE_COLOR[colorIndex] || 'default';
-        }
-      } else {
-        return (
-          <span key={index} style={{ color: currentColor }}>
-            {consoleLine.length ? consoleLine : '\n'}
-          </span>
-        );
-      }
-    });
-  };
   const filteredCode = code.filter(
     ({ output_type: outputType }) => showOutputType[outputType]
   );
@@ -109,28 +138,16 @@ export const OutputCodeBlock = ({ code, showOutputType, scrollElement }) => {
   if (!filteredCode.length) {
     return <div>{__('No output for the selected filters')}</div>;
   }
-  const codeParse = filteredCode.map(line => {
-    if (line.output === '\n') {
-      return null;
-    }
-    const lineOutputs = line.output
-      .replace(/\r\n/g, '\n')
-      .replace(/\n$/, '')
-      .split('\n');
-    return lineOutputs.map((lineOutput, index) => {
-      lineCounter += 1;
-      return (
-        <div key={index} className={`line ${line.output_type}`}>
-          <span
-            className="counter"
-            title={new Date(line.timestamp * MS_PER_SECOND).toISOString()}
-          >
-            {lineCounter.toString().padStart(4, '\u00A0')}:{' '}
-          </span>
-          <div className="content">{colorizeLine(lineOutput)}</div>
-        </div>
-      );
-    });
+  const codeParse = filteredCode.map((lineSet, index) => {
+    const startLine = lineCounter + 1;
+    lineCounter += getLineOutputs(lineSet).length;
+    return (
+      <OutputLineSet
+        key={`${lineSet.timestamp}-${index}`}
+        lineSet={lineSet}
+        startLine={startLine}
+      />
+    );
   });
 
   return (
@@ -167,3 +184,8 @@ OutputCodeBlock.propTypes = {
   showOutputType: PropTypes.object.isRequired,
   scrollElement: PropTypes.string.isRequired,
 };
+
+OutputLineSet.propTypes = {
+  lineSet: PropTypes.object.isRequired,
+  startLine: PropTypes.number.isRequired,
+};