Merge pull request #1171 from OpenC3/recurring

Recurring Calendar activities

Author: jmthomas

openc3-cosmos-cmd-tlm-api/app/controllers/activity_controller.rb

@@ -14,7 +14,7 @@
 # GNU Affero General Public License for more details.
 
 # Modified by OpenC3, Inc.
-# All changes Copyright 2023, OpenC3, Inc.
+# All changes Copyright 2024, OpenC3, Inc.
 # All Rights Reserved
 #
 # This file may also be used under the terms of a commercial license
@@ -25,6 +25,7 @@
 
 class ActivityController < ApplicationController
   def initialize
+    super()
     @model_class = OpenC3::ActivityModel
   end
 
@@ -84,15 +85,17 @@ def index
   def create
     return unless authorization('script_run')
     begin
-      hash = params.to_unsafe_h.slice(:start, :stop, :kind, :data).to_h
+      hash = params.to_unsafe_h.slice(:start, :stop, :kind, :data, :recurring).to_h
       hash['data'] ||= {}
       hash['data']['username'] = username()
       if hash['start'].nil? || hash['stop'].nil?
         raise ArgumentError.new 'post body must contain start and stop'
       end
-
       hash['start'] = DateTime.parse(hash['start']).strftime('%s').to_i
       hash['stop'] = DateTime.parse(hash['stop']).strftime('%s').to_i
+      if hash['recurring'] and hash['recurring']['end']
+        hash['recurring']['end'] = DateTime.parse(hash['recurring']['end']).strftime('%s').to_i
+      end
       model = @model_class.from_json(hash.symbolize_keys, name: params[:name], scope: params[:scope])
       model.create()
       OpenC3::Logger.info(
@@ -288,9 +291,9 @@ def destroy
         render :json => { :status => 'error', :message => 'not found' }, :status => 404
         return
       end
-      ret = model.destroy()
+      ret = model.destroy(recurring: params[:recurring])
       OpenC3::Logger.info(
-        "Activity destroyed: #{params[:name]}",
+        "Activity destroyed name: #{params[:name]} id:#{params[:id]} recurring:#{params[:recurring]}",
         scope: params[:scope],
         user: username()
       )

openc3-cosmos-cmd-tlm-api/app/controllers/timeline_controller.rb

@@ -141,7 +141,7 @@ def color
     end
   end
 
-  # Returns hash/object of timeline name in json with a 204 no-content status code.
+  # Delete timeline
   #
   # name [String] the timeline name, `system42`
   # scope [String] the scope of the timeline, `TEST`

openc3-cosmos-cmd-tlm-api/spec/controllers/activity_controller_spec.rb

@@ -80,7 +80,6 @@ def generate_activity_hash(start)
       post :create, params: hash.merge({ 'scope'=>'DEFAULT', 'name'=>'test' })
       ret = JSON.parse(response.body, :allow_nan => true, :create_additions => true)
       expect(ret['updated_at']).not_to be_nil
-      expect(ret['duration']).to eql(3600)
       expect(ret['start']).not_to be_nil
       expect(ret['stop']).not_to be_nil
       expect(response).to have_http_status(:created)
@@ -160,7 +159,6 @@ def generate_activity_hash(start)
       expect(ret['start']).to eql(created['start'])
       expect(ret['stop']).to eql(created['stop'])
       expect(ret['updated_at']).not_to be_nil
-      expect(ret['duration']).to eql(3600)
       expect(response).to have_http_status(:ok)
     end
 

openc3-cosmos-init/plugins/packages/openc3-tool-common/src/tools/calendar/Dialogs/ActivityUpdateDialog.vue

@@ -13,7 +13,7 @@
 # GNU Affero General Public License for more details.
 
 # Modified by OpenC3, Inc.
-# All changes Copyright 2022, OpenC3, Inc.
+# All changes Copyright 2024, OpenC3, Inc.
 # All Rights Reserved
 #
 # This file may also be used under the terms of a commercial license
@@ -23,7 +23,7 @@
 <template>
   <v-dialog v-model="show" width="600">
     <v-card>
-      <form v-on:submit.prevent="updateActivity">
+      <form @submit.prevent="updateActivity">
         <v-system-bar>
           <v-spacer />
           <span>
@@ -86,16 +86,77 @@
                     data-test="activity-stop-time"
                   />
                 </v-row>
-                <v-row class="mx-2 mb-2">
-                  <v-radio-group
-                    v-model="utcOrLocal"
-                    row
-                    hide-details
-                    class="mt-0"
-                  >
-                    <v-radio label="LST" value="loc" data-test="lst-radio" />
-                    <v-radio label="UTC" value="utc" data-test="utc-radio" />
-                  </v-radio-group>
+                <v-row style="margin-top: 0px">
+                  <v-col>
+                    <v-radio-group
+                      v-model="utcOrLocal"
+                      row
+                      hide-details
+                      class="mt-0"
+                    >
+                      <v-radio label="LST" value="loc" data-test="lst-radio" />
+                      <v-radio label="UTC" value="utc" data-test="utc-radio" />
+                    </v-radio-group>
+                  </v-col>
+                  <v-col>
+                    <v-checkbox
+                      style="padding-top: 0px; margin-top: 0px"
+                      v-model="recurring"
+                      label="Recurring"
+                      hide-details
+                      data-test="recurring"
+                      disabled
+                    >
+                    </v-checkbox>
+                  </v-col>
+                </v-row>
+                <v-row v-if="recurring">
+                  <v-col><div class="repeat">Repeat every</div></v-col>
+                  <v-col>
+                    <v-text-field
+                      v-model="frequency"
+                      dense
+                      outlined
+                      single-line
+                      hide-details
+                      disabled
+                  /></v-col>
+                  <v-col>
+                    <v-select
+                      :items="timeSpans"
+                      v-model="timeSpan"
+                      style="primary"
+                      hide-details
+                      dense
+                      outlined
+                      disabled
+                      data-test="cmd-param-select"
+                    />
+                  </v-col>
+                </v-row>
+                <v-row v-if="recurring" style="padding-bottom: 10px">
+                  <v-col><div class="repeat">Ending</div></v-col>
+                  <v-col>
+                    <v-text-field
+                      v-model="recurringEndDate"
+                      type="date"
+                      label="End Date"
+                      class="mx-1"
+                      disabled
+                      :rules="[rules.required]"
+                      data-test="recurring-end-date"
+                  /></v-col>
+                  <v-col>
+                    <v-text-field
+                      v-model="recurringEndTime"
+                      type="time"
+                      step="1"
+                      label="End Time"
+                      class="mx-1"
+                      disabled
+                      :rules="[rules.required]"
+                      data-test="recurrning-end-time"
+                  /></v-col>
                 </v-row>
                 <v-row>
                   <span
@@ -104,7 +165,7 @@
                     v-text="timeError"
                   />
                 </v-row>
-                <v-row>
+                <v-row class="mt-2">
                   <v-spacer />
                   <v-btn
                     @click="dialogStep = 2"
@@ -118,7 +179,6 @@
               </div>
             </v-card-text>
           </v-stepper-content>
-
           <v-stepper-step editable step="2">
             Activity type Input
           </v-stepper-step>
@@ -134,7 +194,7 @@
                     placeholder="INST COLLECT with TYPE 0, DURATION 1, OPCODE 171, TEMP 0"
                     prefix="cmd('"
                     suffix="')"
-                    hint="Timeline run commands with cmd_no_hazardous_check"
+                    hint="Timeline runs commands with cmd_no_hazardous_check"
                     data-test="activity-cmd"
                   />
                 </div>
@@ -145,10 +205,10 @@
                 <div v-else>
                   <span class="ma-2"> No required input </span>
                 </div>
-                <v-row v-show="typeError">
+                <v-row v-show="typeError" class="mt-2">
                   <span class="ma-2 red--text" v-text="typeError" />
                 </v-row>
-                <v-row>
+                <v-row class="mt-2">
                   <v-spacer />
                   <v-btn
                     @click="cancelActivity"
@@ -214,6 +274,12 @@ export default {
       rules: {
         required: (value) => !!value || 'Required',
       },
+      recurring: false,
+      recurringEndDate: null,
+      recurringEndTime: null,
+      frequency: 90,
+      timeSpan: 'minutes',
+      timeSpans: ['minutes', 'hours', 'days'],
     }
   },
   watch: {
@@ -260,6 +326,9 @@ export default {
       this.kind = inputKind
       this.activityData = ''
     },
+    fileHandler: function (event) {
+      this.activityData = event ? event : null
+    },
     updateValues: function () {
       const sDate = new Date(this.activity.start * 1000)
       const eDate = new Date(this.activity.stop * 1000)
@@ -270,45 +339,68 @@ export default {
       this.kind = this.activity.kind.toUpperCase()
       this.activityData = this.activity.data[this.activity.kind]
       this.activityEnvironment = this.activity.data.environment
-    },
-    fileHandler: function (event) {
-      this.activityData = event ? event : null
+      if (this.activity.recurring?.uuid) {
+        this.recurring = true
+        const rDate = new Date(this.activity.recurring.end * 1000)
+        this.recurringEndDate = format(rDate, 'yyyy-MM-dd')
+        this.recurringEndTime = format(rDate, 'HH:mm:ss')
+        this.frequency = this.activity.recurring.frequency
+        this.timeSpan = this.activity.recurring.span
+      }
     },
     cancelActivity: function () {
       this.show = !this.show
     },
     updateActivity: function () {
       // Call the api to update the activity
       const start = this.toIsoString(
-        Date.parse(`${this.startDate}T${this.startTime}`),
+        Date.parse(`${this.startDate}T${this.startTime}`)
       )
       const stop = this.toIsoString(
-        Date.parse(`${this.stopDate}T${this.stopTime}`),
+        Date.parse(`${this.stopDate}T${this.stopTime}`)
       )
       const kind = this.kind.toLowerCase()
       let data = { environment: this.activityEnvironment }
       data[kind] = this.activityData
       const tName = this.activity.name
       const aStart = this.activity.start
+      var recurring = {}
+      if (this.recurring) {
+        recurring = {
+          frequency: this.frequency,
+          span: this.timeSpan,
+          end: this.toIsoString(
+            Date.parse(`${this.recurringEndDate}T${this.recurringEndTime}`)
+          ),
+        }
+      }
       Api.put(`/openc3-api/timeline/${tName}/activity/${aStart}`, {
-        data: { start, stop, kind, data },
-      }).then((response) => {
-        const activityTime = this.generateDateTime(
-          new Date(response.data.start * 1000),
-        )
-        this.$notify.normal({
-          title: 'Updated Activity',
-          body: `${activityTime} (${response.data.start}) on timeline: ${response.data.name}`,
-        })
+        data: { start, stop, kind, data, recurring },
       })
-      this.$emit('close')
-      this.show = !this.show
+        .then((response) => {
+          const activityTime = this.generateDateTime(
+            new Date(response.data.start * 1000)
+          )
+          this.$notify.normal({
+            title: 'Updated Activity',
+            body: `${activityTime} (${response.data.start}) on timeline: ${response.data.name}`,
+          })
+          this.$emit('update')
+          this.show = !this.show
+        })
+        .catch((error) => {
+          this.show = !this.show
+        })
     },
   },
 }
 </script>
 
 <style scoped>
+.repeat {
+  padding-top: 10px;
+  text-align: right;
+}
 .v-stepper--vertical .v-stepper__content {
   width: auto;
   margin: 0px 0px 0px 36px;