Rename traits to include Rpc in their names

ghostbuster91 · ghostbuster91 · commit e168783d984c · 2025-05-29T22:13:07.000+02:00
diff --git a/modules/examples/smithyShared/src/main/smithy/spec.smithy b/modules/examples/smithyShared/src/main/smithy/spec.smithy
@@ -2,21 +2,21 @@ $version: "2.0"
 
 namespace test
 
-use jsonrpclib#jsonRequest
-use jsonrpclib#jsonRPC
-use jsonrpclib#jsonNotification
+use jsonrpclib#jsonRpcRequest
+use jsonrpclib#jsonRpc
+use jsonrpclib#jsonRpcNotification
 
-@jsonRPC
+@jsonRpc
 service TestServer {
   operations: [Greet, Ping]
 }
 
-@jsonRPC
+@jsonRpc
 service TestClient {
   operations: [Pong]
 }
 
-@jsonRequest("greet")
+@jsonRpcRequest("greet")
 operation Greet {
   input := {
     @required
@@ -28,15 +28,15 @@ operation Greet {
   }
 }
 
-@jsonNotification("ping")
+@jsonRpcNotification("ping")
 operation Ping {
   input := {
     @required
     ping: String
   }
 }
 
-@jsonNotification("pong")
+@jsonRpcNotification("pong")
 operation Pong {
   input := {
     @required
diff --git a/modules/smithy/src/main/java/jsonrpclib/validation/JsonNotificationOutputValidator.java b/modules/smithy/src/main/java/jsonrpclib/validation/JsonNotificationOutputValidator.java
@@ -1,6 +1,6 @@
 package jsonrpclib.validation;
 
-import jsonrpclib.JsonNotificationTrait;
+import jsonrpclib.JsonRpcNotificationTrait;
 import software.amazon.smithy.model.Model;
 import software.amazon.smithy.model.shapes.ShapeId;
 import software.amazon.smithy.model.validation.AbstractValidator;
@@ -18,7 +18,7 @@ public class JsonNotificationOutputValidator extends AbstractValidator {
 
     @Override
     public List<ValidationEvent> validate(Model model) {
-        return model.getShapesWithTrait(JsonNotificationTrait.ID).stream().flatMap(op -> {
+        return model.getShapesWithTrait(JsonRpcNotificationTrait.ID).stream().flatMap(op -> {
             ShapeId outputShapeId = op.asOperationShape().orElseThrow().getOutputShape();
             var outputShape = model.expectShape(outputShapeId);
             if (outputShape.asStructureShape().map(s -> !s.members().isEmpty()).orElse(true)) {
diff --git a/modules/smithy/src/main/java/jsonrpclib/validation/JsonRpcOperationValidator.java b/modules/smithy/src/main/java/jsonrpclib/validation/JsonRpcOperationValidator.java
@@ -1,8 +1,8 @@
 package jsonrpclib.validation;
 
-import jsonrpclib.JsonNotificationTrait;
-import jsonrpclib.JsonRPCTrait;
-import jsonrpclib.JsonRequestTrait;
+import jsonrpclib.JsonRpcNotificationTrait;
+import jsonrpclib.JsonRpcTrait;
+import jsonrpclib.JsonRpcRequestTrait;
 import software.amazon.smithy.model.Model;
 import software.amazon.smithy.model.shapes.ServiceShape;
 import software.amazon.smithy.model.shapes.Shape;
@@ -18,7 +18,7 @@ public class JsonRpcOperationValidator extends AbstractValidator {
     @Override
     public List<ValidationEvent> validate(Model model) {
         return model.getServiceShapes().stream()
-            .filter(service -> service.hasTrait(JsonRPCTrait.class))
+            .filter(service -> service.hasTrait(JsonRpcTrait.class))
             .flatMap(service -> validateService(model, service))
             .collect(Collectors.toList());
     }
@@ -32,7 +32,7 @@ private Stream<ValidationEvent> validateService(Model model, ServiceShape servic
     }
 
     private boolean hasJsonRpcMethod(Shape op) {
-        return op.hasTrait(JsonRequestTrait.ID) || op.hasTrait(JsonNotificationTrait.ID);
+        return op.hasTrait(JsonRpcRequestTrait.ID) || op.hasTrait(JsonRpcNotificationTrait.ID);
     }
 }
 
diff --git a/modules/smithy/src/main/java/jsonrpclib/validation/UniqueJsonRpcMethodNamesValidator.java b/modules/smithy/src/main/java/jsonrpclib/validation/UniqueJsonRpcMethodNamesValidator.java
@@ -1,8 +1,8 @@
 package jsonrpclib.validation;
 
-import jsonrpclib.JsonNotificationTrait;
-import jsonrpclib.JsonRPCTrait;
-import jsonrpclib.JsonRequestTrait;
+import jsonrpclib.JsonRpcNotificationTrait;
+import jsonrpclib.JsonRpcTrait;
+import jsonrpclib.JsonRpcRequestTrait;
 import software.amazon.smithy.model.Model;
 import software.amazon.smithy.model.shapes.OperationShape;
 import software.amazon.smithy.model.shapes.ServiceShape;
@@ -20,7 +20,7 @@ public class UniqueJsonRpcMethodNamesValidator extends AbstractValidator {
 
     @Override
     public List<ValidationEvent> validate(Model model) {
-        return model.getShapesWithTrait(JsonRPCTrait.class).stream()
+        return model.getShapesWithTrait(JsonRpcTrait.class).stream()
             .flatMap(service -> validateService(service.asServiceShape().orElseThrow(), model))
             .collect(Collectors.toList());
     }
@@ -53,9 +53,9 @@ private Stream<ValidationEvent> validateService(ServiceShape service, Model mode
     }
 
     private Optional<String> getJsonRpcMethodName(OperationShape operation) {
-        return operation.getTrait(JsonRequestTrait.class)
+        return operation.getTrait(JsonRpcRequestTrait.class)
             .map(StringTrait::getValue)
-            .or(() -> operation.getTrait(JsonNotificationTrait.class).map(StringTrait::getValue));
+            .or(() -> operation.getTrait(JsonRpcNotificationTrait.class).map(StringTrait::getValue));
     }
 }
 
diff --git a/modules/smithy/src/main/resources/META-INF/smithy/jsonrpclib.smithy b/modules/smithy/src/main/resources/META-INF/smithy/jsonrpclib.smithy
@@ -5,9 +5,9 @@ namespace jsonrpclib
 /// the JSON-RPC protocol,
 /// see https://www.jsonrpc.org/specification
 @protocolDefinition(traits: [
-    jsonRequest
-    jsonNotification
-    jsonPayload
+    jsonRpcRequest
+    jsonRpcNotification
+    jsonRpcPayload
     smithy.api#jsonName
     smithy.api#length
     smithy.api#pattern
@@ -20,28 +20,28 @@ namespace jsonrpclib
     alloy#untagged
 ])
 @trait(selector: "service")
-structure jsonRPC {
+structure jsonRpc {
 }
 
 /// Identifies an operation that abides by request/response semantics
 /// https://www.jsonrpc.org/specification#request_object
-@trait(selector: "operation", conflicts: [jsonNotification])
-string jsonRequest
+@trait(selector: "operation", conflicts: [jsonRpcNotification])
+string jsonRpcRequest
 
 /// Identifies an operation that abides by fire-and-forget semantics
 /// see https://www.jsonrpc.org/specification#notification
-@trait(selector: "operation", conflicts: [jsonRequest])
-string jsonNotification
+@trait(selector: "operation", conflicts: [jsonRpcRequest])
+string jsonRpcNotification
 
 
 /// Binds a single structure member to the payload of a jsonrpc message.
-/// Just like @httpPayload, but for jsonRPC.
+/// Just like @httpPayload, but for jsonRpc.
 @trait(selector: "structure > member", structurallyExclusive: "member")
 @traitValidators({
-    "jsonPayload.OnlyTopLevel": { 
-        message: "jsonPayload can only be used on the top level of an operation input/output/error.", 
+    "jsonRpcPayload.OnlyTopLevel": { 
+        message: "jsonRpcPayload can only be used on the top level of an operation input/output/error.", 
         severity: "ERROR", 
         selector: "$allowedShapes(:root(operation -[input, output, error]-> structure > member)) :not(:in(${allowedShapes}))"
     }
 })
-structure jsonPayload {}
+structure jsonRpcPayload {}
diff --git a/modules/smithy4s-tests/src/main/smithy/spec.smithy b/modules/smithy4s-tests/src/main/smithy/spec.smithy
@@ -2,22 +2,22 @@ $version: "2.0"
 
 namespace test
 
-use jsonrpclib#jsonNotification
-use jsonrpclib#jsonRPC
-use jsonrpclib#jsonRequest
-use jsonrpclib#jsonPayload
+use jsonrpclib#jsonRpcNotification
+use jsonrpclib#jsonRpc
+use jsonrpclib#jsonRpcRequest
+use jsonrpclib#jsonRpcPayload
 
-@jsonRPC
+@jsonRpc
 service TestServer {
     operations: [Greet, Ping]
 }
 
-@jsonRPC
+@jsonRpc
 service TestClient {
     operations: [Pong]
 }
 
-@jsonRequest("greet")
+@jsonRpcRequest("greet")
 operation Greet {
     input := {
         @required
@@ -31,21 +31,21 @@ operation Greet {
 }
 
 
-@jsonRPC
+@jsonRpc
 service TestServerWithPayload {
     operations: [GreetWithPayload]
 }
 
-@jsonRequest("greetWithPayload")
+@jsonRpcRequest("greetWithPayload")
 operation GreetWithPayload {
     input := {
         @required
-        @jsonPayload
+        @jsonRpcPayload
         payload: GreetInputPayload
     }
     output := {
         @required
-        @jsonPayload
+        @jsonRpcPayload
         payload: GreetOutputPayload
     }
 }
@@ -66,28 +66,28 @@ structure NotWelcomeError {
     msg: String
 }
 
-@jsonNotification("ping")
+@jsonRpcNotification("ping")
 operation Ping {
     input := {
         @required
         ping: String
     }
 }
 
-@jsonNotification("pong")
+@jsonRpcNotification("pong")
 operation Pong {
     input := {
         @required
         pong: String
     }
 }
 
-@jsonRPC
+@jsonRpc
 service WeatherService {
     operations: [GetWeather]
 }
 
-@jsonRequest("getWeather")
+@jsonRpcRequest("getWeather")
 operation GetWeather {
     input := {
         @required
diff --git a/modules/smithy4s/src/main/scala/jsonrpclib/smithy4sinterop/EndpointSpec.scala b/modules/smithy4s/src/main/scala/jsonrpclib/smithy4sinterop/EndpointSpec.scala
@@ -8,8 +8,8 @@ private[smithy4sinterop] object EndpointSpec {
   case class Request(methodName: String) extends EndpointSpec
 
   def fromHints(hints: Hints): Option[EndpointSpec] = hints match {
-    case jsonrpclib.JsonRequest.hint(r)      => Some(Request(r.value))
-    case jsonrpclib.JsonNotification.hint(r) => Some(Notification(r.value))
-    case _                                   => None
+    case jsonrpclib.JsonRpcRequest.hint(r)      => Some(Request(r.value))
+    case jsonrpclib.JsonRpcNotification.hint(r) => Some(Notification(r.value))
+    case _                                      => None
   }
 }
diff --git a/modules/smithy4s/src/main/scala/jsonrpclib/smithy4sinterop/JsonPayloadTransformation.scala b/modules/smithy4s/src/main/scala/jsonrpclib/smithy4sinterop/JsonPayloadTransformation.scala
@@ -1,6 +1,6 @@
 package jsonrpclib.smithy4sinterop
 
-import jsonrpclib.JsonPayload
+import jsonrpclib.JsonRpcPayload
 import smithy4s.~>
 import smithy4s.Schema
 import smithy4s.Schema.StructSchema
@@ -12,7 +12,7 @@ private[jsonrpclib] object JsonPayloadTransformation extends (Schema ~> Schema)
       case struct: StructSchema[b] =>
         struct.fields
           .collectFirst {
-            case field if field.hints.has[JsonPayload] =>
+            case field if field.hints.has[JsonRpcPayload] =>
               field.schema.biject[b]((f: Any) => struct.make(Vector(f)))(field.get)
           }
           .getOrElse(fa)

Original file line number	Diff line number	Diff line change
`@@ -8,8 +8,8 @@ private[smithy4sinterop] object EndpointSpec {`
`8`	`8`	`case class Request(methodName: String) extends EndpointSpec`
`9`	`9`
`10`	`10`	`def fromHints(hints: Hints): Option[EndpointSpec] = hints match {`
`11`		`- case jsonrpclib.JsonRequest.hint(r) => Some(Request(r.value))`
`12`		`- case jsonrpclib.JsonNotification.hint(r) => Some(Notification(r.value))`
`13`		`- case _ => None`
	`11`	`+ case jsonrpclib.JsonRpcRequest.hint(r) => Some(Request(r.value))`
	`12`	`+ case jsonrpclib.JsonRpcNotification.hint(r) => Some(Notification(r.value))`
	`13`	`+ case _ => None`
`14`	`14`	`}`
`15`	`15`	`}`