Merge pull request #2548 from markjmiller/markmiller/2516

Better error messages on plugin gem file upload #2516

Author: jmthomas

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

@@ -101,6 +101,9 @@ def create(update = false)
           result = OpenC3::PluginModel.install_phase1(gem_file_path, store_id: params[:store_id], scope: scope)
         end
         render json: result
+      rescue OpenC3::EmptyGemFileError => error
+        render json: { status: 'error', message: error.message }, status: 400
+        logger.error(error.formatted)
       rescue Exception => error
         render json: { status: 'error', message: error.message }, status: 500
         logger.error(error.formatted)

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

@@ -165,6 +165,24 @@
       expect(json["message"]).to eq("Installation failed")
     end
 
+    it "returns bad request when gem file is empty" do
+      allow(OpenC3::PluginModel).to receive(:install_phase1).and_raise(OpenC3::EmptyGemFileError.new("Gem file is empty: test-plugin.gem"))
+
+      post :create, params: { plugin: @upload_file, scope: "DEFAULT" }
+      expect(response).to have_http_status(:bad_request)
+      json = JSON.parse(response.body)
+      expect(json["status"]).to eq("error")
+      expect(json["message"]).to eq("Gem file is empty: test-plugin.gem")
+    end
+
+    it "raises EmptyGemFileError when gem file is empty" do
+      Tempfile.create(["empty-plugin", ".gem"]) do |tf|
+        expect {
+          OpenC3::PluginModel.install_phase1(tf.path, scope: "DEFAULT")
+        }.to raise_error(OpenC3::EmptyGemFileError, /Gem file is empty/)
+      end
+    end
+
     it "cleans up temporary directory on success" do
       allow(OpenC3::PluginModel).to receive(:install_phase1).and_return({})
       expect(FileUtils).to receive(:remove_entry_secure).with("/tmp/test", true)

openc3/lib/openc3/models/plugin_model.rb

@@ -41,6 +41,8 @@
 require 'fileutils'
 
 module OpenC3
+  class EmptyGemFileError < StandardError; end
+
   # Represents a OpenC3 plugin that can consist of targets, interfaces, routers
   # microservices and tools. The PluginModel installs all these pieces as well
   # as destroys them all when the plugin is removed.
@@ -87,6 +89,10 @@ def self.install_phase1(gem_file_path, existing_variables: nil, existing_plugin_
       tf = nil
       begin
         if File.exist?(gem_file_path)
+          if File.zero?(gem_file_path)
+            raise EmptyGemFileError, "Gem file is empty: #{gem_file_path}"
+          end
+
           # Load gem to internal gem server
           OpenC3::GemModel.put(gem_file_path, gem_install: false, scope: scope) unless validate_only
         else
@@ -209,7 +215,7 @@ def self.install_phase2(plugin_hash, scope:, gem_file_path: nil, validate_only:
         # Handle python dependencies (pyproject.toml or requirements.txt)
         pyproject_path = File.join(gem_path, 'pyproject.toml')
         requirements_path = File.join(gem_path, 'requirements.txt')
-        
+
         if File.exist?(pyproject_path) || File.exist?(requirements_path)
           begin
             pypi_url = get_setting('pypi_url', scope: scope)