From 73ad8c7363179f8f9062e8e65578169d07f58687 Mon Sep 17 00:00:00 2001
From: Jason Thomas <jason@openc3.com>
Date: Wed, 8 Jan 2025 13:14:08 -0700
Subject: [PATCH] Make news feed a setting

---
 .../src/services/openc3Api.js                 |   4 +
 .../src/tools/admin/tabs/SettingsTab.vue      |   4 +
 .../admin/tabs/settings/NewsFeedSettings.vue  |  80 +++++++++++++
 .../tabs/settings/SuppressedSettings.vue      |   2 +-
 .../src/tools/admin/tabs/settings/settings.js |   2 +-
 .../src/tools/base/UserMenu.vue               | 108 +++++++++---------
 openc3/lib/openc3/api/settings_api.rb         |  30 ++++-
 .../microservices/periodic_microservice.rb    |  38 +++---
 .../migrations/20250108060000_news_feed.rb    |  18 +++
 openc3/lib/openc3/models/news_model.rb        |   4 +-
 openc3/lib/openc3/models/scope_model.rb       |   2 +
 11 files changed, 217 insertions(+), 75 deletions(-)
 create mode 100644 openc3-cosmos-init/plugins/packages/openc3-vue-common/src/tools/admin/tabs/settings/NewsFeedSettings.vue
 create mode 100644 openc3/lib/openc3/migrations/20250108060000_news_feed.rb

diff --git a/openc3-cosmos-init/plugins/packages/openc3-js-common/src/services/openc3Api.js b/openc3-cosmos-init/plugins/packages/openc3-js-common/src/services/openc3Api.js
index f2512a95d2..ad53d7c2a5 100644
--- a/openc3-cosmos-init/plugins/packages/openc3-js-common/src/services/openc3Api.js
+++ b/openc3-cosmos-init/plugins/packages/openc3-js-common/src/services/openc3Api.js
@@ -683,6 +683,10 @@ export default class OpenC3Api {
     return this.exec('set_setting', [name, data])
   }
 
+  update_news() {
+    return this.exec('update_news', [])
+  }
+
   // DEPRECATED for set_setting
   save_setting(name, data) {
     return this.exec('set_setting', [name, data])
diff --git a/openc3-cosmos-init/plugins/packages/openc3-vue-common/src/tools/admin/tabs/SettingsTab.vue b/openc3-cosmos-init/plugins/packages/openc3-vue-common/src/tools/admin/tabs/SettingsTab.vue
index af93340257..95dc6eb0e0 100644
--- a/openc3-cosmos-init/plugins/packages/openc3-vue-common/src/tools/admin/tabs/SettingsTab.vue
+++ b/openc3-cosmos-init/plugins/packages/openc3-vue-common/src/tools/admin/tabs/SettingsTab.vue
@@ -26,6 +26,8 @@
     <v-divider />
     <time-zone-settings />
     <v-divider />
+    <news-feed-settings />
+    <v-divider />
     <classification-banner-settings />
     <v-divider />
     <subtitle-settings />
@@ -44,6 +46,7 @@ import DefaultConfigSettings from './settings/DefaultConfigSettings.vue'
 import AstroSettings from './settings/AstroSettings.vue'
 import ClassificationBannerSettings from './settings/ClassificationBannerSettings.vue'
 import TimeZoneSettings from './settings/TimeZoneSettings.vue'
+import NewsFeedSettings from './settings/NewsFeedSettings.vue'
 import SubtitleSettings from './settings/SubtitleSettings.vue'
 import SourceCodeSettings from './settings/SourceCodeSettings.vue'
 import RubyGemsSettings from './settings/RubyGemsSettings.vue'
@@ -56,6 +59,7 @@ export default {
     AstroSettings,
     ClassificationBannerSettings,
     TimeZoneSettings,
+    NewsFeedSettings,
     SubtitleSettings,
     SourceCodeSettings,
     RubyGemsSettings,
diff --git a/openc3-cosmos-init/plugins/packages/openc3-vue-common/src/tools/admin/tabs/settings/NewsFeedSettings.vue b/openc3-cosmos-init/plugins/packages/openc3-vue-common/src/tools/admin/tabs/settings/NewsFeedSettings.vue
new file mode 100644
index 0000000000..b10df89698
--- /dev/null
+++ b/openc3-cosmos-init/plugins/packages/openc3-vue-common/src/tools/admin/tabs/settings/NewsFeedSettings.vue
@@ -0,0 +1,80 @@
+<!--
+# Copyright 2025 OpenC3, Inc.
+# All Rights Reserved.
+#
+# This program is free software; you can modify and/or redistribute it
+# under the terms of the GNU Affero General Public License
+# as published by the Free Software Foundation; version 3 with
+# attribution addendums as found in the LICENSE.txt
+#
+# 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 Affero General Public License for more details.
+
+# This file may also be used under the terms of a commercial license
+# if purchased from OpenC3, Inc.
+-->
+
+<template>
+  <v-card>
+    <v-card-title>News Feed Settings</v-card-title>
+    <v-alert v-model="errorLoading" type="error" closable density="compact">
+      Error loading previous configuration due to {{ errorText }}
+    </v-alert>
+    <v-alert v-model="errorSaving" type="error" closable density="compact">
+      Error saving due to {{ errorText }}
+    </v-alert>
+    <v-alert v-model="successSaving" type="success" closable density="compact">
+      Saved! (Refresh the page to see changes)
+    </v-alert>
+    <v-card-text class="pb-0">
+      <v-switch
+        label="Allow COSMOS backend to pull the news feed from the COSMOS external news site.
+        This is a low bandwidth poll which only happens every 12 hrs. To immediately update the news feed, click the 'Refresh' in the User Menu."
+        v-model="newsFeed"
+        color="primary"
+      />
+    </v-card-text>
+    <v-card-actions>
+      <v-btn
+        @click="save"
+        color="success"
+        variant="text"
+        data-test="save-news-feed"
+      >
+        Save
+      </v-btn>
+    </v-card-actions>
+  </v-card>
+</template>
+
+<script>
+import Settings from './settings.js'
+
+const settingName = 'news_feed'
+export default {
+  mixins: [Settings],
+  data() {
+    return {
+      newsFeed: true,
+    }
+  },
+  created() {
+    this.loadSetting(settingName)
+  },
+  methods: {
+    save() {
+      console.log('save news feed', this.newsFeed)
+      this.saveSetting(settingName, this.newsFeed)
+      if (this.newsFeed) {
+        this.api.update_news()
+      }
+    },
+    parseSetting: function (response) {
+      console.log('parseSetting response', response)
+      this.newsFeed = response
+    },
+  },
+}
+</script>
diff --git a/openc3-cosmos-init/plugins/packages/openc3-vue-common/src/tools/admin/tabs/settings/SuppressedSettings.vue b/openc3-cosmos-init/plugins/packages/openc3-vue-common/src/tools/admin/tabs/settings/SuppressedSettings.vue
index 3ce45a704a..6074477eb1 100644
--- a/openc3-cosmos-init/plugins/packages/openc3-vue-common/src/tools/admin/tabs/settings/SuppressedSettings.vue
+++ b/openc3-cosmos-init/plugins/packages/openc3-vue-common/src/tools/admin/tabs/settings/SuppressedSettings.vue
@@ -27,7 +27,7 @@
         <v-checkbox
           v-model="selectAllSuppressedWarnings"
           label="Select All Warnings"
-          desity="compact"
+          density="compact"
         />
         <v-checkbox
           v-for="warning in suppressedWarnings"
diff --git a/openc3-cosmos-init/plugins/packages/openc3-vue-common/src/tools/admin/tabs/settings/settings.js b/openc3-cosmos-init/plugins/packages/openc3-vue-common/src/tools/admin/tabs/settings/settings.js
index a8c229a21f..e1a105ffbd 100644
--- a/openc3-cosmos-init/plugins/packages/openc3-vue-common/src/tools/admin/tabs/settings/settings.js
+++ b/openc3-cosmos-init/plugins/packages/openc3-vue-common/src/tools/admin/tabs/settings/settings.js
@@ -29,7 +29,7 @@ export default {
     }
   },
   methods: {
-    loadSetting: function (setting, variable, defaultValue) {
+    loadSetting: function (setting) {
       this.api
         .get_setting(setting)
         .then((response) => {
diff --git a/openc3-cosmos-init/plugins/packages/openc3-vue-common/src/tools/base/UserMenu.vue b/openc3-cosmos-init/plugins/packages/openc3-vue-common/src/tools/base/UserMenu.vue
index 82ba9ac416..501cf618b8 100644
--- a/openc3-cosmos-init/plugins/packages/openc3-vue-common/src/tools/base/UserMenu.vue
+++ b/openc3-cosmos-init/plugins/packages/openc3-vue-common/src/tools/base/UserMenu.vue
@@ -75,35 +75,39 @@
             COSMOS Enterprise Edition
           </div>
         </v-card-text>
-        <div class="news-header">
-          COSMOS News
-          <v-switch
-            v-model="displayNews"
-            color="primary"
-            data-test="display-news"
-            class="news-switch"
-            hide-details
-          />
+        <div v-if="newsFeed">
+          <v-row no-gutters class="news-header">
+            <v-col cols="auto" class="me-auto">COSMOS News</v-col>
+            <v-col cols="auto">
+              <v-btn
+                @click="refreshNews"
+                color="primary"
+                density="compact"
+                block
+              >
+                Refresh
+              </v-btn>
+            </v-col>
+          </v-row>
+          <v-list
+            lines="two"
+            width="420"
+            max-height="75vh"
+            class="overflow-y-auto"
+            data-test="news-list"
+          >
+            <template v-for="(news, index) in news" :key="`news-${index}`">
+              <hr />
+              <v-list-item class="pl-2">
+                <v-list-item-title>
+                  <span class="news-title">{{ news.title }}</span
+                  ><span class="news-date">{{ formatDate(news.date) }}</span>
+                </v-list-item-title>
+                <div v-html="news.body"></div>
+              </v-list-item>
+            </template>
+          </v-list>
         </div>
-        <v-list
-          v-if="displayNews"
-          lines="two"
-          width="420"
-          max-height="80vh"
-          class="overflow-y-auto"
-          data-test="news-list"
-        >
-          <template v-for="(news, index) in news" :key="`news-${index}`">
-            <hr />
-            <v-list-item class="pl-2">
-              <v-list-item-title>
-                <span class="news-title">{{ news.title }}</span
-                ><span class="news-date">{{ formatDate(news.date) }}</span>
-              </v-list-item-title>
-              <div v-html="news.body"></div>
-            </v-list-item>
-          </template>
-        </v-list>
       </v-card>
     </v-menu>
     <upgrade-to-enterprise-dialog
@@ -115,6 +119,7 @@
 
 <script>
 import { Api } from '@openc3/js-common/services'
+import { OpenC3Api } from '@openc3/js-common/services'
 import { UpgradeToEnterpriseDialog } from '@/components'
 
 export default {
@@ -130,6 +135,7 @@ export default {
   data: function () {
     let user = OpenC3Auth.user()
     return {
+      api: new OpenC3Api(),
       showUserMenu: false,
       authenticated: !!localStorage.openc3Token,
       name: user['name'],
@@ -137,7 +143,7 @@ export default {
       username: user['preferred_username'],
       showUpgradeToEnterpriseDialog: false,
       activeUsers: ['None'],
-      displayNews: true,
+      newsFeed: false,
       news: [],
     }
   },
@@ -147,9 +153,6 @@ export default {
     },
   },
   watch: {
-    displayNews: function (newValue, oldValue) {
-      localStorage.displayNews = newValue
-    },
     // Whenever we show the user menu, read the news and refresh the list of active users
     showUserMenu: function (newValue, oldValue) {
       if (newValue === true) {
@@ -172,15 +175,30 @@ export default {
     },
   },
   created: function () {
-    if (localStorage.displayNews) {
-      this.displayNews = localStorage.displayNews === 'true'
-    }
-    this.fetchNews()
-    // Every hour fetch news from the backend
-    // Note: the backend updates from news.openc3.org every 12 hours
-    setInterval(this.fetchNews, 60 * 60 * 1000)
+    this.api
+      .get_setting('news_feed')
+      .then((response) => {
+        if (response) {
+          this.newsFeed = response
+          if (this.newsFeed) {
+            this.fetchNews()
+            // Every hour fetch news from the backend
+            // Note: the backend updates from news.openc3.org every 12 hours
+            setInterval(this.fetchNews, 60 * 60 * 1000)
+          }
+        }
+      })
+      .catch((error) => {
+        // Do nothing
+      })
   },
   methods: {
+    refreshNews() {
+      // Force the backend to update the news feed
+      this.api.update_news().then(() => {
+        this.fetchNews()
+      })
+    },
     formatDate(date) {
       // Just show the YYYY-MM-DD part of the date
       return date.split('T')[0]
@@ -227,14 +245,6 @@ export default {
 }
 </script>
 
-<style>
-.v-switch .v-selection-control {
-  min-height: 20px;
-}
-.v-switch .v-selection-control--density-default {
-  --v-selection-control-size: 20px;
-}
-</style>
 <style scoped>
 .news-header {
   padding: 10px;
@@ -249,10 +259,6 @@ export default {
   color: grey;
   float: right;
 }
-.news-switch {
-  float: right;
-  padding-right: 10px;
-}
 .link {
   cursor: pointer;
 }
diff --git a/openc3/lib/openc3/api/settings_api.rb b/openc3/lib/openc3/api/settings_api.rb
index 98a950ead7..5c73372023 100644
--- a/openc3/lib/openc3/api/settings_api.rb
+++ b/openc3/lib/openc3/api/settings_api.rb
@@ -14,13 +14,23 @@
 # GNU Affero General Public License for more details.
 
 # Modified by OpenC3, Inc.
-# All changes Copyright 2022, OpenC3, Inc.
+# All changes Copyright 2025, OpenC3, Inc.
 # All Rights Reserved
 #
 # This file may also be used under the terms of a commercial license
 # if purchased from OpenC3, Inc.
 
+begin
+  require 'openc3-enterprise/version'
+  VERSION = OPENC3_ENTERPRISE_VERSION
+  ENTERPRISE = true
+rescue LoadError
+  require 'openc3/version'
+  VERSION = OPENC3_VERSION
+  ENTERPRISE = false
+end
 require 'openc3/models/setting_model'
+require 'openc3/models/news_model'
 
 module OpenC3
   module Api
@@ -31,7 +41,8 @@ module Api
                        'get_setting',
                        'get_settings',
                        'set_setting',
-                       'save_setting' # DEPRECATED
+                       'save_setting', # DEPRECATED
+                       'update_news',
                      ])
 
     def list_settings(manual: false, scope: $openc3_scope, token: $openc3_token)
@@ -68,5 +79,20 @@ def set_setting(name, data, manual: false, scope: $openc3_scope, token: $openc3_
     end
     # save_setting is DEPRECATED
     alias save_setting set_setting
+
+    # Update the news feed on demand to respond to frontend setting changes
+    def update_news(manual: false, scope: $openc3_scope, token: $openc3_token)
+      authorize(permission: 'admin', manual: manual, scope: scope, token: token)
+      conn = Faraday.new(
+        url: 'https://news.openc3.com',
+        params: {version: VERSION, enterprise: ENTERPRISE},
+      )
+      response = conn.get('/news')
+      if response.success?
+        NewsModel.set(response.body)
+      else
+        NewsModel.news_error(response)
+      end
+    end
   end
 end
diff --git a/openc3/lib/openc3/microservices/periodic_microservice.rb b/openc3/lib/openc3/microservices/periodic_microservice.rb
index e934dbe2b6..c01249bfd8 100644
--- a/openc3/lib/openc3/microservices/periodic_microservice.rb
+++ b/openc3/lib/openc3/microservices/periodic_microservice.rb
@@ -19,17 +19,14 @@
 require 'openc3/microservices/microservice'
 require 'openc3/models/offline_access_model'
 require 'openc3/models/news_model'
-begin
-  require 'openc3-enterprise/version'
-  VERSION = OPENC3_ENTERPRISE_VERSION
-  ENTERPRISE = true
-rescue LoadError
-  require 'openc3/version'
-  VERSION = OPENC3_VERSION
-  ENTERPRISE = false
-end
+# The VERSION and ENTERPRISE constants are set by settings_api.rb
+require 'openc3/api/settings_api'
 
 module OpenC3
+  class LocalApi
+    include Api
+  end
+
   class PeriodicMicroservice < Microservice
     STARTUP_DELAY_SECONDS = 2 * 60 # Two Minutes
     SLEEP_PERIOD_SECONDS = 24 * 60 * 60 # Run once per day
@@ -37,19 +34,24 @@ class PeriodicMicroservice < Microservice
     def initialize(*args)
       super(*args)
       @metric.set(name: 'periodic_total', value: @count, type: 'counter')
-      @conn = Faraday.new(
-        url: 'https://news.openc3.com',
-        params: {version: VERSION, enterprise: ENTERPRISE},
-      )
+      @conn = nil # Faraday connection set by get_news
       get_news()
     end
 
     def get_news
-      response = @conn.get('/news')
-      if response.success?
-        NewsModel.set(response.body)
-      else
-        NewsModel.no_news()
+      if LocalApi.new().get_setting('news_feed', scope: @scope)
+        unless @conn
+          @conn = Faraday.new(
+            url: 'https://news.openc3.com',
+            params: {version: VERSION, enterprise: ENTERPRISE},
+          )
+        end
+        response = @conn.get('/news')
+        if response.success?
+          NewsModel.set(response.body)
+        else
+          NewsModel.news_error(response)
+        end
       end
     end
 
diff --git a/openc3/lib/openc3/migrations/20250108060000_news_feed.rb b/openc3/lib/openc3/migrations/20250108060000_news_feed.rb
new file mode 100644
index 0000000000..e9124c2006
--- /dev/null
+++ b/openc3/lib/openc3/migrations/20250108060000_news_feed.rb
@@ -0,0 +1,18 @@
+require 'openc3/utilities/migration'
+require 'openc3/models/scope_model'
+require 'openc3/models/setting_model'
+
+module OpenC3
+  class NewsFeed < Migration
+    def self.run
+      ScopeModel.names.each do |scope|
+        setting = SettingModel.get(name: 'news_feed')
+        SettingModel.set({ name: 'news_feed', data: true }, scope: scope) unless setting
+      end
+    end
+  end
+end
+
+unless ENV['OPENC3_NO_MIGRATE']
+  OpenC3::NewsFeed.run
+end
diff --git a/openc3/lib/openc3/models/news_model.rb b/openc3/lib/openc3/models/news_model.rb
index 5893a2f40f..5384442f5f 100644
--- a/openc3/lib/openc3/models/news_model.rb
+++ b/openc3/lib/openc3/models/news_model.rb
@@ -31,8 +31,8 @@ def self.all()
       Store.get(PRIMARY_KEY)
     end
 
-    def self.no_news()
-      Store.set(PRIMARY_KEY, [{title: 'News Disabled', body: 'Unable to contact the OpenC3 news feed.'}].to_json)
+    def self.news_error(response)
+      Store.set(PRIMARY_KEY, [{ date: Time.now.utc.iso8601, title: 'News Error', body: "Error contacting OpenC3 news feed (status: #{response.status})" }].to_json)
     end
   end
 end
diff --git a/openc3/lib/openc3/models/scope_model.rb b/openc3/lib/openc3/models/scope_model.rb
index 2d21629a31..dcb529a47c 100644
--- a/openc3/lib/openc3/models/scope_model.rb
+++ b/openc3/lib/openc3/models/scope_model.rb
@@ -400,6 +400,8 @@ def seed_database
       SettingModel.set({ name: 'rubygems_url', data: ENV['RUBYGEMS_URL'] || 'https://rubygems.org' }, scope: @scope) unless setting
       setting = SettingModel.get(name: 'pypi_url')
       SettingModel.set({ name: 'pypi_url', data: ENV['PYPI_URL'] || 'https://pypi.org' }, scope: @scope) unless setting
+      setting = SettingModel.get(name: 'news_feed')
+      SettingModel.set({ name: 'news_feed', data: true }, scope: @scope) unless setting
     end
   end
 end