From 44c00c026fecb06f79b050aac73cfb8b36895533 Mon Sep 17 00:00:00 2001
From: Hilary Oliver <hilary.j.oliver@gmail.com>
Date: Wed, 4 Sep 2024 16:11:39 +1200
Subject: [PATCH 1/2] Avoid duplicate job submissions before reload.

---
 changes.d/6345.fix.md     |  1 +
 cylc/flow/task_job_mgr.py | 11 ++++++++++-
 2 files changed, 11 insertions(+), 1 deletion(-)
 create mode 100644 changes.d/6345.fix.md

diff --git a/changes.d/6345.fix.md b/changes.d/6345.fix.md
new file mode 100644
index 0000000000..a629eb6c8e
--- /dev/null
+++ b/changes.d/6345.fix.md
@@ -0,0 +1 @@
+Fix duplicate job submissions of tasks in the preparing state before reload.
diff --git a/cylc/flow/task_job_mgr.py b/cylc/flow/task_job_mgr.py
index 185966ff12..d5c9828829 100644
--- a/cylc/flow/task_job_mgr.py
+++ b/cylc/flow/task_job_mgr.py
@@ -536,6 +536,12 @@ def submit_task_jobs(self, workflow, itasks, curve_auth,
                 stdin_files = []
                 job_log_dirs = []
                 for itask in itasks_batch:
+                    if not itask.waiting_on_job_prep:
+                        # Avoid duplicate job submissions when flushing
+                        # preparing tasks before a reload. See
+                        # https://github.com/cylc/cylc-flow/pull/6345
+                        continue
+
                     if remote_mode:
                         stdin_files.append(
                             os.path.expandvars(
@@ -554,8 +560,11 @@ def submit_task_jobs(self, workflow, itasks, curve_auth,
                     # write flag so that subsequent manual retrigger will
                     # generate a new job file.
                     itask.local_job_file_path = None
-
                     itask.waiting_on_job_prep = False
+
+                if not job_log_dirs:
+                    continue
+
                 self.proc_pool.put_command(
                     SubProcContext(
                         self.JOBS_SUBMIT,

From dcedd2bbe8e16725798c9c829c462e5a50598b5e Mon Sep 17 00:00:00 2001
From: Hilary Oliver <hilary.j.oliver@gmail.com>
Date: Wed, 4 Sep 2024 17:19:37 +1200
Subject: [PATCH 2/2] Added a functional test.

---
 tests/functional/reload/28-preparing.t        | 43 +++++++++++++++++++
 .../functional/reload/28-preparing/flow.cylc  |  8 ++++
 2 files changed, 51 insertions(+)
 create mode 100644 tests/functional/reload/28-preparing.t
 create mode 100644 tests/functional/reload/28-preparing/flow.cylc

diff --git a/tests/functional/reload/28-preparing.t b/tests/functional/reload/28-preparing.t
new file mode 100644
index 0000000000..08f4ba911a
--- /dev/null
+++ b/tests/functional/reload/28-preparing.t
@@ -0,0 +1,43 @@
+#!/usr/bin/env bash
+# THIS FILE IS PART OF THE CYLC WORKFLOW ENGINE.
+# Copyright (C) NIWA & British Crown (Met Office) & Contributors.
+# 
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#-------------------------------------------------------------------------------
+
+# Test for duplicate job submissions when preparing tasks get flushed
+# prior to reload - see https://github.com/cylc/cylc-flow/pull/6345
+
+. "$(dirname "$0")/test_header"
+set_test_number 4
+
+# Strap the process pool size down to 1, so that the first task is stuck
+# in the preparing state until the startup event handler finishes.
+
+create_test_global_config "" "
+[scheduler]
+    process pool size = 1
+"
+
+# install and play the workflow, then reload it and wait for it to finish.
+install_workflow "${TEST_NAME_BASE}" "${TEST_NAME_BASE}"
+run_ok "${TEST_NAME_BASE}-vip" cylc validate "${WORKFLOW_NAME}"
+run_ok "${TEST_NAME_BASE}-reload" cylc play "${WORKFLOW_NAME}"
+run_ok "${TEST_NAME_BASE}-reload" cylc reload "${WORKFLOW_NAME}"
+poll_grep_workflow_log -F 'INFO - DONE'
+
+# check that task `foo` was only submitted once.
+count_ok "1/foo.*submitted to" "${WORKFLOW_RUN_DIR}/log/scheduler/log" 1
+
+purge
diff --git a/tests/functional/reload/28-preparing/flow.cylc b/tests/functional/reload/28-preparing/flow.cylc
new file mode 100644
index 0000000000..27a9f1013e
--- /dev/null
+++ b/tests/functional/reload/28-preparing/flow.cylc
@@ -0,0 +1,8 @@
+[scheduler]
+   [[events]]
+       startup handlers = "sleep 10; echo"
+[scheduling]
+    [[graph]]
+        R1 = "foo => bar"
+[runtime]
+    [[foo, bar]]