RSDK-3008 - add misc-unused-params (#216)

.clang-tidy

@@ -6,7 +6,6 @@
 # readability-named-parameter: Useful to fix lints about unused parameters
 # readability-implicit-bool-conversion: We have decided that !ptr-type is cleaner than ptr-type==nullptr
 # readability-magic-numbers: This encourages useless variables and extra lint lines
-# misc-unused-parameters: TODO(RSDK-3008) remove this and fix all lints.
 # misc-include-cleaner: TODO(RSDK-5479) this is overly finnicky, add IWYU support and fix.
 # readability-function-cognitive-complexity: No, complexity is subjective and sometimes necessary.
 # readability-else-after-return: No, this causes code complexification
@@ -26,7 +25,6 @@ Checks: >
   -readability-named-parameter,
   -readability-implicit-bool-conversion,
   -readability-magic-numbers,
-  -misc-unused-parameters,
   -misc-include-cleaner,
   -readability-function-cognitive-complexity,
   -readability-else-after-return,

src/viam/examples/modules/simple/main.cpp

@@ -43,7 +43,7 @@ class Printer : public GenericService {
         std::cout << "Printer " << Resource::name() << " will print " << to_print_ << std::endl;
     }
 
-    AttributeMap do_command(AttributeMap command) {
+    AttributeMap do_command(const AttributeMap& command) {
         std::cout << "Received DoCommand request for Printer " << Resource::name() << std::endl;
         std::cout << "Printer " << Resource::name() << " has printed " << to_print_ << std::endl;
         return command;

src/viam/sdk/components/base/server.cpp

@@ -16,28 +16,27 @@ BaseServer::BaseServer(std::shared_ptr<ResourceManager> manager)
     : ResourceServer(std::move(manager)){};
 
 ::grpc::Status BaseServer::MoveStraight(
-    ::grpc::ServerContext* context,
+    ::grpc::ServerContext*,
     const ::viam::component::base::v1::MoveStraightRequest* request,
-    ::viam::component::base::v1::MoveStraightResponse* response) noexcept {
+    ::viam::component::base::v1::MoveStraightResponse*) noexcept {
     return make_service_helper<Base>(
         "BaseServer::MoveStraight", this, request)([&](auto& helper, auto& base) {
         base->move_straight(request->distance_mm(), request->mm_per_sec(), helper.getExtra());
     });
 }
 
-::grpc::Status BaseServer::Spin(::grpc::ServerContext* context,
+::grpc::Status BaseServer::Spin(::grpc::ServerContext*,
                                 const ::viam::component::base::v1::SpinRequest* request,
-                                ::viam::component::base::v1::SpinResponse* response) noexcept {
+                                ::viam::component::base::v1::SpinResponse*) noexcept {
     return make_service_helper<Base>(
         "BaseServer::Spin", this, request)([&](auto& helper, auto& base) {
         base->spin(request->angle_deg(), request->degs_per_sec(), helper.getExtra());
     });
 }
 
-::grpc::Status BaseServer::SetPower(
-    ::grpc::ServerContext* context,
-    const ::viam::component::base::v1::SetPowerRequest* request,
-    ::viam::component::base::v1::SetPowerResponse* response) noexcept {
+::grpc::Status BaseServer::SetPower(::grpc::ServerContext*,
+                                    const ::viam::component::base::v1::SetPowerRequest* request,
+                                    ::viam::component::base::v1::SetPowerResponse*) noexcept {
     return make_service_helper<Base>(
         "BaseServer::SetPower", this, request)([&](auto& helper, auto& base) {
         auto linear = Vector3::from_proto(request->linear());
@@ -47,9 +46,9 @@ ::grpc::Status BaseServer::SetPower(
 }
 
 ::grpc::Status BaseServer::SetVelocity(
-    ::grpc::ServerContext* context,
+    ::grpc::ServerContext*,
     const ::viam::component::base::v1::SetVelocityRequest* request,
-    ::viam::component::base::v1::SetVelocityResponse* response) noexcept {
+    ::viam::component::base::v1::SetVelocityResponse*) noexcept {
     return make_service_helper<Base>(
         "BaseServer::SetVelocity", this, request)([&](auto& helper, auto& base) {
         auto linear = Vector3::from_proto(request->linear());
@@ -58,26 +57,25 @@ ::grpc::Status BaseServer::SetVelocity(
     });
 }
 
-::grpc::Status BaseServer::Stop(::grpc::ServerContext* context,
+::grpc::Status BaseServer::Stop(::grpc::ServerContext*,
                                 const ::viam::component::base::v1::StopRequest* request,
-                                ::viam::component::base::v1::StopResponse* response) noexcept {
+                                ::viam::component::base::v1::StopResponse*) noexcept {
     return make_service_helper<Base>("BaseServer::Stop", this, request)(
         [&](auto& helper, auto& base) { base->stop(helper.getExtra()); });
 }
 
 ::grpc::Status BaseServer::IsMoving(
-    ::grpc::ServerContext* context,
+    ::grpc::ServerContext*,
     const ::viam::component::base::v1::IsMovingRequest* request,
     ::viam::component::base::v1::IsMovingResponse* response) noexcept {
-    return make_service_helper<Base>(
-        "BaseServer::IsMoving", this, request)([&](auto& helper, auto& base) {
+    return make_service_helper<Base>("BaseServer::IsMoving", this, request)([&](auto&, auto& base) {
         const bool result = base->is_moving();
         response->set_is_moving(result);
     });
 }
 
 ::grpc::Status BaseServer::GetGeometries(
-    ::grpc::ServerContext* context,
+    ::grpc::ServerContext*,
     const ::viam::common::v1::GetGeometriesRequest* request,
     ::viam::common::v1::GetGeometriesResponse* response) noexcept {
     return make_service_helper<Base>(
@@ -90,7 +88,7 @@ ::grpc::Status BaseServer::GetGeometries(
 }
 
 ::grpc::Status BaseServer::GetProperties(
-    grpc::ServerContext* context,
+    grpc::ServerContext*,
     const viam::component::base::v1::GetPropertiesRequest* request,
     viam::component::base::v1::GetPropertiesResponse* response) noexcept {
     return make_service_helper<Base>(
@@ -102,11 +100,11 @@ ::grpc::Status BaseServer::GetProperties(
     });
 }
 
-::grpc::Status BaseServer::DoCommand(grpc::ServerContext* context,
+::grpc::Status BaseServer::DoCommand(grpc::ServerContext*,
                                      const viam::common::v1::DoCommandRequest* request,
                                      viam::common::v1::DoCommandResponse* response) noexcept {
     return make_service_helper<Base>(
-        "BaseServer::DoCommand", this, request)([&](auto& helper, auto& base) {
+        "BaseServer::DoCommand", this, request)([&](auto&, auto& base) {
         const AttributeMap result = base->do_command(struct_to_map(request->command()));
         *response->mutable_result() = map_to_struct(result);
     });

src/viam/sdk/components/board/server.cpp

@@ -14,7 +14,7 @@ BoardServer::BoardServer(std::shared_ptr<ResourceManager> manager)
     : ResourceServer(std::move(manager)){};
 
 ::grpc::Status BoardServer::Status(
-    ::grpc::ServerContext* context,
+    ::grpc::ServerContext*,
     const ::viam::component::board::v1::StatusRequest* request,
     ::viam::component::board::v1::StatusResponse* response) noexcept {
     return make_service_helper<Board>(
@@ -25,18 +25,17 @@ ::grpc::Status BoardServer::Status(
     });
 }
 
-::grpc::Status BoardServer::SetGPIO(
-    ::grpc::ServerContext* context,
-    const ::viam::component::board::v1::SetGPIORequest* request,
-    ::viam::component::board::v1::SetGPIOResponse* response) noexcept {
+::grpc::Status BoardServer::SetGPIO(::grpc::ServerContext*,
+                                    const ::viam::component::board::v1::SetGPIORequest* request,
+                                    ::viam::component::board::v1::SetGPIOResponse*) noexcept {
     return make_service_helper<Board>(
         "BoardServer::SetGPIO", this, request)([&](auto& helper, auto& board) {
         board->set_gpio(request->pin(), request->high(), helper.getExtra());
     });
 }
 
 ::grpc::Status BoardServer::GetGPIO(
-    ::grpc::ServerContext* context,
+    ::grpc::ServerContext*,
     const ::viam::component::board::v1::GetGPIORequest* request,
     ::viam::component::board::v1::GetGPIOResponse* response) noexcept {
     return make_service_helper<Board>(
@@ -45,7 +44,7 @@ ::grpc::Status BoardServer::GetGPIO(
     });
 }
 
-::grpc::Status BoardServer::PWM(::grpc::ServerContext* context,
+::grpc::Status BoardServer::PWM(::grpc::ServerContext*,
                                 const ::viam::component::board::v1::PWMRequest* request,
                                 ::viam::component::board::v1::PWMResponse* response) noexcept {
     return make_service_helper<Board>(
@@ -54,18 +53,17 @@ ::grpc::Status BoardServer::PWM(::grpc::ServerContext* context,
     });
 }
 
-::grpc::Status BoardServer::SetPWM(
-    ::grpc::ServerContext* context,
-    const ::viam::component::board::v1::SetPWMRequest* request,
-    ::viam::component::board::v1::SetPWMResponse* response) noexcept {
+::grpc::Status BoardServer::SetPWM(::grpc::ServerContext*,
+                                   const ::viam::component::board::v1::SetPWMRequest* request,
+                                   ::viam::component::board::v1::SetPWMResponse*) noexcept {
     return make_service_helper<Board>(
         "BoardServer::SetPWM", this, request)([&](auto& helper, auto& board) {
         board->set_pwm_duty_cycle(request->pin(), request->duty_cycle_pct(), helper.getExtra());
     });
 }
 
 ::grpc::Status BoardServer::PWMFrequency(
-    ::grpc::ServerContext* context,
+    ::grpc::ServerContext*,
     const ::viam::component::board::v1::PWMFrequencyRequest* request,
     ::viam::component::board::v1::PWMFrequencyResponse* response) noexcept {
     return make_service_helper<Board>(
@@ -76,27 +74,27 @@ ::grpc::Status BoardServer::PWMFrequency(
 }
 
 ::grpc::Status BoardServer::SetPWMFrequency(
-    ::grpc::ServerContext* context,
+    ::grpc::ServerContext*,
     const ::viam::component::board::v1::SetPWMFrequencyRequest* request,
-    ::viam::component::board::v1::SetPWMFrequencyResponse* response) noexcept {
+    ::viam::component::board::v1::SetPWMFrequencyResponse*) noexcept {
     return make_service_helper<Board>(
         "BoardServer::SetPWMFrequency", this, request)([&](auto& helper, auto& board) {
         board->set_pwm_frequency(request->pin(), request->frequency_hz(), helper.getExtra());
     });
 }
 
-::grpc::Status BoardServer::DoCommand(grpc::ServerContext* context,
+::grpc::Status BoardServer::DoCommand(grpc::ServerContext*,
                                       const viam::common::v1::DoCommandRequest* request,
                                       viam::common::v1::DoCommandResponse* response) noexcept {
     return make_service_helper<Board>(
-        "BoardServer::DoCommand", this, request)([&](auto& helper, auto& board) {
+        "BoardServer::DoCommand", this, request)([&](auto&, auto& board) {
         const AttributeMap result = board->do_command(struct_to_map(request->command()));
         *response->mutable_result() = map_to_struct(result);
     });
 }
 
 ::grpc::Status BoardServer::ReadAnalogReader(
-    ::grpc::ServerContext* context,
+    ::grpc::ServerContext*,
     const ::viam::component::board::v1::ReadAnalogReaderRequest* request,
     ::viam::component::board::v1::ReadAnalogReaderResponse* response) {
     if (!request) {
@@ -123,9 +121,9 @@ ::grpc::Status BoardServer::ReadAnalogReader(
 }
 
 ::grpc::Status BoardServer::WriteAnalog(
-    ::grpc::ServerContext* context,
+    ::grpc::ServerContext*,
     const ::viam::component::board::v1::WriteAnalogRequest* request,
-    ::viam::component::board::v1::WriteAnalogResponse* response) {
+    ::viam::component::board::v1::WriteAnalogResponse*) {
     if (!request) {
         return ::grpc::Status(::grpc::StatusCode::INVALID_ARGUMENT,
                               "Called [Board::WriteAnalog] without a request");
@@ -148,7 +146,7 @@ ::grpc::Status BoardServer::WriteAnalog(
 }
 
 ::grpc::Status BoardServer::GetDigitalInterruptValue(
-    ::grpc::ServerContext* context,
+    ::grpc::ServerContext*,
     const ::viam::component::board::v1::GetDigitalInterruptValueRequest* request,
     ::viam::component::board::v1::GetDigitalInterruptValueResponse* response) {
     if (!request) {
@@ -176,9 +174,9 @@ ::grpc::Status BoardServer::GetDigitalInterruptValue(
 }
 
 ::grpc::Status BoardServer::SetPowerMode(
-    ::grpc::ServerContext* context,
+    ::grpc::ServerContext*,
     const ::viam::component::board::v1::SetPowerModeRequest* request,
-    ::viam::component::board::v1::SetPowerModeResponse* response) noexcept {
+    ::viam::component::board::v1::SetPowerModeResponse*) noexcept {
     return make_service_helper<Board>(
         "BoardServer::SetPowerMode", this, request)([&](auto& helper, auto& board) {
         if (request->has_duration()) {
@@ -192,7 +190,7 @@ ::grpc::Status BoardServer::SetPowerMode(
 }
 
 ::grpc::Status BoardServer::GetGeometries(
-    ::grpc::ServerContext* context,
+    ::grpc::ServerContext*,
     const ::viam::common::v1::GetGeometriesRequest* request,
     ::viam::common::v1::GetGeometriesResponse* response) noexcept {
     return make_service_helper<Board>(

src/viam/sdk/components/camera/camera.hpp

@@ -122,7 +122,7 @@ class Camera : public Component {
     /// @brief Send/receive arbitrary commands to the resource.
     /// @param Command the command to execute.
     /// @return The result of the executed command.
-    virtual AttributeMap do_command(AttributeMap command) = 0;
+    virtual AttributeMap do_command(const AttributeMap& command) = 0;
 
     /// @brief Get the next image from the camera as a raw image.
     /// @param mime_type the desired mime_type of the image (does not guarantee output type).

src/viam/sdk/components/camera/client.cpp

@@ -22,7 +22,7 @@ CameraClient::CameraClient(std::string name, std::shared_ptr<grpc::Channel> chan
       stub_(viam::component::camera::v1::CameraService::NewStub(channel)),
       channel_(std::move(channel)){};
 
-AttributeMap CameraClient::do_command(AttributeMap command) {
+AttributeMap CameraClient::do_command(const AttributeMap& command) {
     return make_client_helper(this, *stub_, &StubType::DoCommand)
         .with([&](auto& request) { *request.mutable_command() = map_to_struct(command); })
         .invoke([](auto& response) { return struct_to_map(response.result()); });

src/viam/sdk/components/camera/client.hpp

@@ -23,7 +23,7 @@ class CameraClient : public Camera {
    public:
     using interface_type = Camera;
     CameraClient(std::string name, std::shared_ptr<grpc::Channel> channel);
-    AttributeMap do_command(AttributeMap command) override;
+    AttributeMap do_command(const AttributeMap& command) override;
     raw_image get_image(std::string mime_type, const AttributeMap& extra) override;
     image_collection get_images() override;
     point_cloud get_point_cloud(std::string mime_type, const AttributeMap& extra) override;

src/viam/sdk/components/camera/server.cpp

@@ -16,18 +16,18 @@ namespace sdk {
 CameraServer::CameraServer(std::shared_ptr<ResourceManager> manager)
     : ResourceServer(std::move(manager)){};
 
-::grpc::Status CameraServer::DoCommand(::grpc::ServerContext* context,
+::grpc::Status CameraServer::DoCommand(::grpc::ServerContext*,
                                        const ::viam::common::v1::DoCommandRequest* request,
                                        ::viam::common::v1::DoCommandResponse* response) noexcept {
     return make_service_helper<Camera>(
-        "CameraServer::DoCommand", this, request)([&](auto& helper, auto& camera) {
+        "CameraServer::DoCommand", this, request)([&](auto&, auto& camera) {
         const AttributeMap result = camera->do_command(struct_to_map(request->command()));
         *response->mutable_result() = map_to_struct(result);
     });
 }
 
 ::grpc::Status CameraServer::GetImage(
-    ::grpc::ServerContext* context,
+    ::grpc::ServerContext*,
     const ::viam::component::camera::v1::GetImageRequest* request,
     ::viam::component::camera::v1::GetImageResponse* response) noexcept {
     return make_service_helper<Camera>(
@@ -42,11 +42,11 @@ ::grpc::Status CameraServer::GetImage(
 }
 
 ::grpc::Status CameraServer::GetImages(
-    ::grpc::ServerContext* context,
+    ::grpc::ServerContext*,
     const ::viam::component::camera::v1::GetImagesRequest* request,
     ::viam::component::camera::v1::GetImagesResponse* response) noexcept {
     return make_service_helper<Camera>(
-        "CameraServer::GetImages", this, request)([&](auto& helper, auto& camera) {
+        "CameraServer::GetImages", this, request)([&](auto&, auto& camera) {
         const Camera::image_collection image_coll = camera->get_images();
         for (const auto& img : image_coll.images) {
             ::viam::component::camera::v1::Image proto_image;
@@ -62,7 +62,7 @@ ::grpc::Status CameraServer::GetImages(
 }
 
 ::grpc::Status CameraServer::RenderFrame(
-    ::grpc::ServerContext* context,
+    ::grpc::ServerContext*,
     const ::viam::component::camera::v1::RenderFrameRequest* request,
     ::google::api::HttpBody* response) noexcept {
     return make_service_helper<Camera>(
@@ -75,7 +75,7 @@ ::grpc::Status CameraServer::RenderFrame(
 }
 
 ::grpc::Status CameraServer::GetPointCloud(
-    ::grpc::ServerContext* context,
+    ::grpc::ServerContext*,
     const ::viam::component::camera::v1::GetPointCloudRequest* request,
     ::viam::component::camera::v1::GetPointCloudResponse* response) noexcept {
     return make_service_helper<Camera>(
@@ -88,7 +88,7 @@ ::grpc::Status CameraServer::GetPointCloud(
 }
 
 ::grpc::Status CameraServer::GetGeometries(
-    ::grpc::ServerContext* context,
+    ::grpc::ServerContext*,
     const ::viam::common::v1::GetGeometriesRequest* request,
     ::viam::common::v1::GetGeometriesResponse* response) noexcept {
     return make_service_helper<Camera>(
@@ -101,11 +101,11 @@ ::grpc::Status CameraServer::GetGeometries(
 }
 
 ::grpc::Status CameraServer::GetProperties(
-    ::grpc::ServerContext* context,
+    ::grpc::ServerContext*,
     const ::viam::component::camera::v1::GetPropertiesRequest* request,
     ::viam::component::camera::v1::GetPropertiesResponse* response) noexcept {
     return make_service_helper<Camera>(
-        "CameraServer::GetProperties", this, request)([&](auto& helper, auto& camera) {
+        "CameraServer::GetProperties", this, request)([&](auto&, auto& camera) {
         const Camera::properties properties = camera->get_properties();
 
         *response->mutable_distortion_parameters() =

src/viam/sdk/components/encoder/client.cpp

@@ -46,7 +46,7 @@ std::vector<GeometryConfig> EncoderClient::get_geometries(const AttributeMap& ex
         .invoke([](auto& response) { return GeometryConfig::from_proto(response); });
 };
 
-AttributeMap EncoderClient::do_command(AttributeMap command) {
+AttributeMap EncoderClient::do_command(const AttributeMap& command) {
     return make_client_helper(this, *stub_, &StubType::DoCommand)
         .with([&](auto& request) { *request.mutable_command() = map_to_struct(command); })
         .invoke([](auto& response) { return struct_to_map(response.result()); });

src/viam/sdk/components/encoder/client.hpp

@@ -26,7 +26,7 @@ class EncoderClient : public Encoder {
     void reset_position(const AttributeMap& extra) override;
     properties get_properties(const AttributeMap& extra) override;
     std::vector<GeometryConfig> get_geometries(const AttributeMap& extra) override;
-    AttributeMap do_command(AttributeMap command) override;
+    AttributeMap do_command(const AttributeMap& command) override;
 
     // the `extra` param is frequently unnecessary but needs to be supported. Ideally, we'd
     // like to live in a world where implementers of derived classes don't need to go out of

src/viam/sdk/components/encoder/encoder.hpp

@@ -104,7 +104,7 @@ class Encoder : public Component {
     /// @brief Send/receive arbitrary commands to the resource.
     /// @param Command the command to execute.
     /// @return The result of the executed command.
-    virtual AttributeMap do_command(AttributeMap command) = 0;
+    virtual AttributeMap do_command(const AttributeMap& command) = 0;
 
     /// @brief Returns `GeometryConfig`s associated with the calling encoder.
     /// @return The requested `GeometryConfig`s associated with the component.