Ensure template can be completed with an open occurrence

Adds some safeguards to ensure a series occurrence is not instantiated while template is in draft:

- InitOccurrenceService refuses to instantiate an occurrence if the  template is still in draft
- InitNextOccurrenceJob adds a condition to check draft templates, preventing jobs from opening occurrences
- template_completed can always recover the broken state: if the first occurrence already exists but the template is still draft, it opens the template instead of redirecting into the loop.

https://community.openproject.org/projects/MEET/work_packages/MEET-557/activity

Author: oliverguenther

modules/meeting/app/controllers/recurring_meetings_controller.rb

@@ -423,7 +423,7 @@ def check_template_completable
       .not_cancelled
       .exists?(recurrence_start_time: @first_occurrence)
 
-    if is_scheduled
+    if is_scheduled && !@recurring_meeting.template.draft?
       flash[:info] = I18n.t("recurring_meeting.occurrence.first_already_exists")
       redirect_to action: :show, status: :see_other
     end

modules/meeting/app/services/recurring_meetings/init_occurrence_service.rb

@@ -44,6 +44,8 @@ def initialize(user:, recurring_meeting:)
 
     def perform
       start_time = params.fetch(:start_time)
+      return draft_template_failure if recurring_meeting.template.draft?
+
       in_context(recurring_meeting, send_notifications: false) do
         call = instantiate(start_time)
         if call.success?
@@ -54,6 +56,10 @@ def perform
       end
     end
 
+    def draft_template_failure
+      ServiceResult.failure(message: I18n.t("recurring_meeting.occurrence.error_template_draft"))
+    end
+
     def instantiate(start_time)
       existing = recurring_meeting.meetings.not_templated.find_by(recurrence_start_time: start_time)
 

modules/meeting/app/workers/recurring_meetings/init_next_occurrence_job.rb

@@ -57,6 +57,8 @@ def self.unique_key(recurring_meeting)
 
     def perform(recurring_meeting, scheduled_time)
       self.recurring_meeting = recurring_meeting
+      return if recurring_meeting.template.draft?
+
       self.scheduled_time = scheduled_time.in_time_zone(recurring_meeting.time_zone)
 
       # Schedule the next job

modules/meeting/app/workers/recurring_meetings/init_next_occurrence_watchdog_job.rb

@@ -35,9 +35,12 @@ def perform
     key = RecurringMeetings::InitNextOccurrenceJob::CONCURRENCY_KEY_BASE
 
     RecurringMeeting
+      .includes(:template)
       .joins("LEFT JOIN good_jobs ON good_jobs.concurrency_key = CONCAT('#{key}', recurring_meetings.id)")
       .where(good_jobs: { id: nil })
       .find_each do |series|
+      next if series.template.draft?
+
       next_occurrence = series.next_occurrence
 
       if next_occurrence

modules/meeting/config/locales/en.yml

@@ -452,12 +452,13 @@ en:
       message: "This meeting series has come to an end. There are no upcoming meetings. "
       action: "You can still view past occurrences or edit the meeting series to extend it."
     occurrence:
-      infoline: "This meeting is part of a recurring meeting series."
       error_no_next: "There is no next occurrence for this meeting."
+      error_template_draft: "The meeting series template is still in draft mode."
       first_already_exists: "The first occurrence of this meeting series is already instantiated."
       first_created: >
         The first meeting has been successfuly created from template.
         All future meetings will be created automatically at the time of the previous occurrence.
+      infoline: "This meeting is part of a recurring meeting series."
     template:
       button_finalize: "Open first meeting"
       blank_title: "Your meeting series template is empty"

modules/meeting/spec/requests/recurring_meetings/recurring_meetings_template_completed_spec.rb

@@ -102,6 +102,33 @@
     end
   end
 
+  context "when first occurrence is already created while the template is still a draft" do
+    let!(:meeting) do
+      create(:meeting,
+             recurring_meeting:,
+             start_time: recurring_meeting.start_time,
+             recurrence_start_time: recurring_meeting.start_time)
+    end
+
+    before do
+      recurring_meeting.template.update!(state: :draft)
+    end
+
+    it "opens the template without creating a duplicate occurrence" do
+      expect { subject }.not_to change(recurring_meeting.meetings.not_templated, :count)
+      expect(response).to have_http_status(:ok)
+      expect(response.media_type).to eq("text/vnd.turbo-stream.html")
+      expect(response.body).to include('action="redirect_to"')
+      expect(response.body).to include(project_recurring_meeting_path(project, recurring_meeting))
+
+      expect(recurring_meeting.template.reload).to be_open
+      expect(recurring_meeting.meetings.not_templated.first).to eq(meeting)
+      expect(RecurringMeetings::InitNextOccurrenceJob)
+        .to have_been_enqueued.with(recurring_meeting, DateTime.parse("2024-12-06T10:00:00Z"))
+                              .at(DateTime.parse("2024-12-05T10:00:00Z"))
+    end
+  end
+
   context "when first occurrence is cancelled" do
     let!(:cancelled_occurrence) do
       create(:meeting,

modules/meeting/spec/services/recurring_meetings/init_occurrence_service_spec.rb

@@ -56,6 +56,23 @@
   describe "instantiating an occurrence for a slot" do
     let(:start_time) { series.start_time + 3.days }
 
+    context "when the template is still in draft mode" do
+      before do
+        series.template.update!(state: :draft)
+      end
+
+      it "does not create an occurrence" do
+        expect(service_result).not_to be_success
+        expect(service_result.message).to eq(I18n.t("recurring_meeting.occurrence.error_template_draft"))
+        expect(created_meeting).to be_nil
+      end
+
+      it "does not add an occurrence" do
+        expect { instance.call(**params) }
+          .not_to change { series.meetings.not_templated.count }
+      end
+    end
+
     context "when no occurrence exists yet for the slot" do
       it "creates a new occurrence for the series" do
         expect(service_result).to be_success

modules/meeting/spec/workers/recurring_meetings/init_next_occurrence_job_spec.rb

@@ -46,6 +46,21 @@
 
   subject { described_class.perform_now(series, scheduled_time) }
 
+  context "when the template is still in draft mode" do
+    before do
+      series.template.update!(state: :draft)
+    end
+
+    it "does not schedule or instantiate occurrences" do
+      result = nil
+
+      expect { result = subject }
+        .not_to change { series.meetings.not_templated.count }
+      expect(result).to be_nil
+      expect(described_class).not_to have_been_enqueued
+    end
+  end
+
   it "schedules the first occurrence" do
     expect { subject }.to change(Meeting, :count).by(1)
     expect(subject).to be_success

modules/meeting/spec/workers/recurring_meetings/init_next_occurrence_watchdog_job_spec.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+#-- copyright
+# OpenProject is an open source project management software.
+# Copyright (C) the OpenProject GmbH
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License version 3.
+#
+# OpenProject is a fork of ChiliProject, which is a fork of Redmine. The copyright follows:
+# Copyright (C) 2006-2013 Jean-Philippe Lang
+# Copyright (C) 2010-2013 the ChiliProject Team
+#
+# 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 2
+# 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, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+#
+# See COPYRIGHT and LICENSE files for more details.
+#++
+
+require "spec_helper"
+require_module_spec_helper
+
+RSpec.describe RecurringMeetings::InitNextOccurrenceWatchdogJob, type: :model do
+  shared_let(:project) { create(:project, enabled_module_names: %i[meetings]) }
+  shared_let(:user) { create(:user) }
+
+  let(:series) do
+    create(:recurring_meeting,
+           project:,
+           author: user,
+           start_time: Time.zone.tomorrow + 10.hours,
+           frequency: "daily",
+           interval: 1,
+           end_after: "specific_date",
+           end_date: 1.month.from_now)
+  end
+
+  subject(:perform) { described_class.perform_now }
+
+  it "re-schedules missing init jobs for open series" do
+    expect { perform }
+      .to have_enqueued_job(RecurringMeetings::InitNextOccurrenceJob)
+      .with(series, series.next_occurrence)
+  end
+
+  context "when the template is still in draft mode" do
+    before do
+      series.template.update!(state: :draft)
+    end
+
+    it "does not schedule an init job" do
+      expect { perform }
+        .not_to have_enqueued_job(RecurringMeetings::InitNextOccurrenceJob)
+    end
+  end
+end