@dcl/protocol 1.0.0-3524279049.commit-02b9080 → 1.0.0-3576463488.commit-bbfbde4

package/README.md

@@ -23,4 +23,35 @@ protoc \
 1. All .proto files are snake_case.proto.
 2. For pascal or camel case usage, please make a deterministic one from the snake case. Example: nft_shape will transform to NftShape.
 3. See https://docs.buf.build/best-practices/style-guide. The most of other styles are taken from there, the Buf configuration is in proto/buf.yml.
-4. Use public/ folder only for .proto with protocol exposing, that is only for files with `import public`. This folder is not processed by the linter.
+4. Use public/ folder only for .proto with protocol exposing, that is only for files with `import public`. This folder is not processed by the linter.
+
+# Dev with Decentraland Repositories
+Many repositories depend on this protocol definition and that sometimes implies some merge order. We don't have to worry much about compatibility because the checks are running with each PR, if you break something, the CI will warn you. But, in some cases, it's desirable to merge the implementation in a specific order to avoid unexpected behavior in the corner cases (multiple repositories are waiting for the build at the same time).
+
+Some dev-cases are described here:
+## SDK: New component or component modification 
+Repositories: [unity-renderer](https://github.com/decentraland/unity-renderer/) and [js-sdk-toolchain](https://github.com/decentraland/js-sdk-toolchain/)
+
+At the protocol level both operations shouldn't be a problem, but `js-sdk-toolchain` CI will fail if the component is not tested. This can happen if the PR **`A`** from the protocol is merged, and you update your PR **`B`** from `js-sdk-toolchain` with the changes before the PR **`A`** from `js-sdk-toolchain` is merged.
+
+Some guidelines and testing before merge:
+- The protocol package is uploaded to S3 while developing in a PR. This can be used in the target repositories
+- Testing in the playground: Playground allows us to test by adding query parameters: `https://playground.decentraland.org/?&renderer-branch=**feat/my-new-component**&sdk-branch=**feat/new-component-approach**`
+- Testing locally: you can write an example scene and install the package `@dcl/sdk` uploaded to S3 commented in the PR comments.
+- Testing in the Unity Editor: if you need to test with the editor opened, write the `ws` query parameter in your local or playground test.
+- Start merging when the three PRs are already to merge: first merge the Protocol one, then update the other two with the version @next and merge them at the same time.
+
+## SDK: New APIs or APIs modifications
+Repositories: [kernel](https://github.com/decentraland/kernel/), [js-sdk-toolchain](https://github.com/decentraland/js-sdk-toolchain/) and [scene-runtime](https://github.com/decentraland/scene-runtime/) 
+In this case, there is no problem with when each PR is merged. It's recommendable to merge first the rpc server-side (in this case, Kernel), second the `scene-runtime` (and this would require a second update from `kernel`) and last the `js-sdk-toolchain`.
+
+## Renderer protocol (RPC)
+Repositories: [kernel](https://github.com/decentraland/kernel/) and [unity-renderer](https://github.com/decentraland/unity-renderer/)
+
+TODO
+
+## BFF
+TODO
+
+## Comms 
+TODO

package/out-ts/decentraland/kernel/comms/rfc5/ws_comms.gen.ts

@@ -60,9 +60,11 @@ export interface WsIdentification {
 /**
  * This message is received by the peers when the same address logs in in a
  * different session. It should signal that the client should be shut down and not
- * retry any new comms connection.
+ * retry any new comms connection. It can also be used to reject new users joining when
+ * the room capacity has been reached.
  */
 export interface WsKicked {
+  reason: string;
 }
 
 export interface WsPacket {
@@ -539,11 +541,14 @@ export const WsIdentification = {
 };
 
 function createBaseWsKicked(): WsKicked {
-  return {};
+  return { reason: "" };
 }
 
 export const WsKicked = {
-  encode(_: WsKicked, writer: _m0.Writer = _m0.Writer.create()): _m0.Writer {
+  encode(message: WsKicked, writer: _m0.Writer = _m0.Writer.create()): _m0.Writer {
+    if (message.reason !== "") {
+      writer.uint32(10).string(message.reason);
+    }
     return writer;
   },
 
@@ -554,6 +559,9 @@ export const WsKicked = {
     while (reader.pos < end) {
       const tag = reader.uint32();
       switch (tag >>> 3) {
+        case 1:
+          message.reason = reader.string();
+          break;
         default:
           reader.skipType(tag & 7);
           break;
@@ -562,17 +570,19 @@ export const WsKicked = {
     return message;
   },
 
-  fromJSON(_: any): WsKicked {
-    return {};
+  fromJSON(object: any): WsKicked {
+    return { reason: isSet(object.reason) ? String(object.reason) : "" };
   },
 
-  toJSON(_: WsKicked): unknown {
+  toJSON(message: WsKicked): unknown {
     const obj: any = {};
+    message.reason !== undefined && (obj.reason = message.reason);
     return obj;
   },
 
-  fromPartial<I extends Exact<DeepPartial<WsKicked>, I>>(_: I): WsKicked {
+  fromPartial<I extends Exact<DeepPartial<WsKicked>, I>>(object: I): WsKicked {
     const message = createBaseWsKicked();
+    message.reason = object.reason ?? "";
     return message;
   },
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dcl/protocol",
-  "version": "1.0.0-3524279049.commit-02b9080",
+  "version": "1.0.0-3576463488.commit-bbfbde4",
   "description": "",
   "main": "index.js",
   "scripts": {
@@ -25,5 +25,5 @@
     "out-ts",
     "public"
   ],
-  "commit": "02b9080d9eed011f499dd8d150fcf3431dfc7c97"
+  "commit": "bbfbde471eb830d5adab4ec50670e73e0a94951d"
 }

package/proto/decentraland/kernel/comms/rfc5/ws_comms.proto

@@ -68,9 +68,12 @@ message WsIdentification {
 /**
  * This message is received by the peers when the same address logs in in a
  * different session. It should signal that the client should be shut down and not
- * retry any new comms connection.
+ * retry any new comms connection. It can also be used to reject new users joining when
+ * the room capacity has been reached.
  */
-message WsKicked {}
+message WsKicked {
+  string reason = 1;
+}
 
 message WsPacket {
   oneof message {
@@ -98,4 +101,4 @@ message WsPacket {
     // direction: server->client
     WsKicked peer_kicked = 8;
   }
-}
+}