fix(satp-hermes): resolve proto files import cycles closes #3773 (#3834)

Signed-off-by: Jorge Santos <[email protected]>

Author: JJSantos22

packages/cactus-plugin-satp-hermes/src/main/proto/cacti/satp/v02/common/session.proto packages/cactus-plugin-satp-hermes/src/main/proto/cacti/satp/v02/session/session.proto

@@ -1,12 +1,11 @@
 syntax = "proto3";
-package cacti.satp.v02.common;
+package cacti.satp.v02.session;
 
 import "cacti/satp/v02/common/message.proto";
 import "cacti/satp/v02/service/stage_0.proto";
 import "cacti/satp/v02/service/stage_1.proto";
 import "cacti/satp/v02/service/stage_2.proto";
 import "cacti/satp/v02/service/stage_3.proto";
-
 import "google/protobuf/empty.proto";
 
 message SessionData {
@@ -245,6 +244,14 @@ message Stage3Timestamps {
     string transfer_complete_response_message_timestamp = 6;
 }
 
+enum SATPStage {
+    SATP_STAGE_UNSPECIFIED = 0;
+    SATP_STAGE_0 = 1;
+    SATP_STAGE_1 = 2;
+    SATP_STAGE_2 = 3;
+    SATP_STAGE_3 = 4;
+}
+
 message SendStatusRequest {
     string status = 1;
     bool has_backup = 2;
@@ -255,14 +262,6 @@ message GetStatusResponse {
     bool has_backup = 2;
 }
 
-enum SATPStage {
-    SATP_STAGE_UNSPECIFIED = 0;
-    SATP_STAGE_0 = 1;
-    SATP_STAGE_1 = 2;
-    SATP_STAGE_2 = 3;
-    SATP_STAGE_3 = 4;
-}
-
 message PingResponse {
     string message = 1;
 }
@@ -285,4 +284,4 @@ service CommonService {
     rpc Ping(google.protobuf.Empty) returns (PingResponse) {}
     rpc Rollback(google.protobuf.Empty) returns (RollbackResponse) {}
     rpc GetStageVersion(google.protobuf.Empty) returns (GetStageVersionResponse) {};
-}
+}

packages/cactus-plugin-satp-hermes/src/main/typescript/api1/admin/get-status-handler-service.ts

@@ -14,7 +14,7 @@ import {
   getStageName,
   getStateName,
 } from "../../core/session-utils";
-import { State } from "../../generated/proto/cacti/satp/v02/common/session_pb";
+import { State } from "../../generated/proto/cacti/satp/v02/session/session_pb";
 import { LedgerType } from "@hyperledger/cactus-core-api";
 
 export async function executeGetStatus(

packages/cactus-plugin-satp-hermes/src/main/typescript/core/crash-management/client-service.ts

@@ -11,7 +11,7 @@ import { JsObjectSigner, Logger } from "@hyperledger/cactus-common";
 import { create } from "@bufbuild/protobuf";
 import { stringify as safeStableStringify } from "safe-stable-stringify";
 import { bufArray2HexStr, sign } from "../../gateway-utils";
-import type { SessionData } from "../../generated/proto/cacti/satp/v02/common/session_pb";
+import type { SessionData } from "../../generated/proto/cacti/satp/v02/session/session_pb";
 import { getCrashedStage } from "../session-utils";
 
 export class CrashRecoveryClientService {

packages/cactus-plugin-satp-hermes/src/main/typescript/core/crash-management/crash-handler.ts

@@ -15,7 +15,7 @@ import type {
   RollbackState,
 } from "../../generated/proto/cacti/satp/v02/service/crash_recovery_pb";
 import { type SATPHandler, SATPHandlerType } from "../../types/satp-protocol";
-import type { SessionData } from "../../generated/proto/cacti/satp/v02/common/session_pb";
+import type { SessionData } from "../../generated/proto/cacti/satp/v02/session/session_pb";
 
 export class CrashRecoveryHandler implements SATPHandler {
   private readonly log: Logger;

packages/cactus-plugin-satp-hermes/src/main/typescript/core/crash-management/rollback/rollback-strategy-factory.ts

@@ -10,7 +10,7 @@ import {
   type Type,
   SATPStage,
   type SessionData,
-} from "../../../generated/proto/cacti/satp/v02/common/session_pb";
+} from "../../../generated/proto/cacti/satp/v02/session/session_pb";
 import { getCrashedStage } from "../../session-utils";
 
 // TODO: fix for single-gateway setups to handle both client and server data together

packages/cactus-plugin-satp-hermes/src/main/typescript/core/crash-management/rollback/stage0-rollback-strategy.ts

@@ -12,7 +12,7 @@ import {
   Type,
   SATPStage,
   type SessionData,
-} from "../../../generated/proto/cacti/satp/v02/common/session_pb";
+} from "../../../generated/proto/cacti/satp/v02/session/session_pb";
 
 export class Stage0RollbackStrategy implements RollbackStrategy {
   private log: Logger;

packages/cactus-plugin-satp-hermes/src/main/typescript/core/crash-management/rollback/stage1-rollback-strategy.ts

@@ -11,7 +11,7 @@ import {
   Type,
   SATPStage,
   type SessionData,
-} from "../../../generated/proto/cacti/satp/v02/common/session_pb";
+} from "../../../generated/proto/cacti/satp/v02/session/session_pb";
 
 export class Stage1RollbackStrategy implements RollbackStrategy {
   private log: Logger;

packages/cactus-plugin-satp-hermes/src/main/typescript/core/crash-management/rollback/stage2-rollback-strategy.ts

@@ -12,7 +12,7 @@ import {
   Type,
   SATPStage,
   type SessionData,
-} from "../../../generated/proto/cacti/satp/v02/common/session_pb";
+} from "../../../generated/proto/cacti/satp/v02/session/session_pb";
 
 export class Stage2RollbackStrategy implements RollbackStrategy {
   private log: Logger;

packages/cactus-plugin-satp-hermes/src/main/typescript/core/crash-management/rollback/stage3-rollback-strategy.ts

@@ -12,7 +12,7 @@ import {
   Type,
   SATPStage,
   type SessionData,
-} from "../../../generated/proto/cacti/satp/v02/common/session_pb";
+} from "../../../generated/proto/cacti/satp/v02/session/session_pb";
 
 export class Stage3RollbackStrategy implements RollbackStrategy {
   private log: Logger;

packages/cactus-plugin-satp-hermes/src/main/typescript/core/crash-management/server-service.ts

@@ -18,7 +18,7 @@ import { create } from "@bufbuild/protobuf";
 import { stringify as safeStableStringify } from "safe-stable-stringify";
 import { bufArray2HexStr, sign, verifySignature } from "../../gateway-utils";
 import { SignatureVerificationError } from "../errors/satp-service-errors";
-import { Type } from "../../generated/proto/cacti/satp/v02/common/session_pb";
+import { Type } from "../../generated/proto/cacti/satp/v02/session/session_pb";
 
 export class CrashRecoveryServerService {
   constructor(

packages/cactus-plugin-satp-hermes/src/main/typescript/core/satp-session.ts

@@ -34,7 +34,7 @@ import {
   Stage3SignaturesSchema,
   Stage3TimestampsSchema,
   State,
-} from "../generated/proto/cacti/satp/v02/common/session_pb";
+} from "../generated/proto/cacti/satp/v02/session/session_pb";
 import {
   AccessControlProfileError,
   ClientGatewayPubkeyError,

packages/cactus-plugin-satp-hermes/src/main/typescript/core/session-utils.ts

@@ -12,7 +12,7 @@ import {
   SATPStage,
   SessionData,
   State,
-} from "../generated/proto/cacti/satp/v02/common/session_pb";
+} from "../generated/proto/cacti/satp/v02/session/session_pb";
 import {
   NewSessionRequest,
   NewSessionRequestSchema,

packages/cactus-plugin-satp-hermes/src/main/typescript/core/stage-services/client/stage1-client-service.ts

@@ -29,7 +29,7 @@ import {
   ISATPServiceOptions,
 } from "../satp-service";
 import { commonBodyVerifier, signatureVerifier } from "../data-verifier";
-import { State } from "../../../generated/proto/cacti/satp/v02/common/session_pb";
+import { State } from "../../../generated/proto/cacti/satp/v02/session/session_pb";
 import {
   HashError,
   MessageTypeError,

packages/cactus-plugin-satp-hermes/src/main/typescript/core/stage-services/client/stage3-client-service.ts

@@ -44,7 +44,7 @@ import {
   TokenIdMissingError,
 } from "../../errors/satp-service-errors";
 import { FailedToProcessError } from "../../errors/satp-handler-errors";
-import { State } from "../../../generated/proto/cacti/satp/v02/common/session_pb";
+import { State } from "../../../generated/proto/cacti/satp/v02/session/session_pb";
 import { create } from "@bufbuild/protobuf";
 
 export class Stage3ClientService extends SATPService {

packages/cactus-plugin-satp-hermes/src/main/typescript/core/stage-services/data-verifier.ts

@@ -6,7 +6,7 @@ import {
 } from "../../generated/proto/cacti/satp/v02/common/message_pb";
 import { stringify as safeStableStringify } from "safe-stable-stringify";
 
-import { SessionData } from "../../generated/proto/cacti/satp/v02/common/session_pb";
+import { SessionData } from "../../generated/proto/cacti/satp/v02/session/session_pb";
 import { SATP_VERSION } from "../constants";
 import {
   ClientGatewayPubkeyError,

packages/cactus-plugin-satp-hermes/src/main/typescript/core/stage-services/server/stage1-server-service.ts

@@ -43,7 +43,7 @@ import {
 } from "../../errors/satp-service-errors";
 import { SATPInternalError } from "../../errors/satp-errors";
 import { SessionNotFoundError } from "../../errors/satp-handler-errors";
-import { State } from "../../../generated/proto/cacti/satp/v02/common/session_pb";
+import { State } from "../../../generated/proto/cacti/satp/v02/session/session_pb";
 import { create } from "@bufbuild/protobuf";
 import { NetworkId } from "../../../services/network-identification/chainid-list";
 export class Stage1ServerService extends SATPService {

packages/cactus-plugin-satp-hermes/src/main/typescript/core/stage-services/server/stage3-server-service.ts

@@ -49,7 +49,7 @@ import {
   SessionNotFoundError,
 } from "../../errors/satp-handler-errors";
 import { SATPInternalError } from "../../errors/satp-errors";
-import { State } from "../../../generated/proto/cacti/satp/v02/common/session_pb";
+import { State } from "../../../generated/proto/cacti/satp/v02/session/session_pb";
 import { create } from "@bufbuild/protobuf";
 
 export class Stage3ServerService extends SATPService {

packages/cactus-plugin-satp-hermes/src/main/typescript/generated/proto/cacti/satp/v02/common/session_connect.ts packages/cactus-plugin-satp-hermes/src/main/typescript/generated/proto/cacti/satp/v02/session/session_connect.ts

@@ -1,19 +1,19 @@
 // @generated by protoc-gen-connect-es v1.6.1 with parameter "target=ts,js_import_style=module"
-// @generated from file cacti/satp/v02/common/session.proto (package cacti.satp.v02.common, syntax proto3)
+// @generated from file cacti/satp/v02/session/session.proto (package cacti.satp.v02.session, syntax proto3)
 /* eslint-disable */
 // @ts-nocheck
 
 import { Empty, MethodKind } from "@bufbuild/protobuf";
 import { GetStageVersionResponse, GetStatusResponse, PingResponse, RollbackResponse, SendStatusRequest } from "./session_pb.js";
 
 /**
- * @generated from service cacti.satp.v02.common.SessionStatusService
+ * @generated from service cacti.satp.v02.session.SessionStatusService
  */
 export const SessionStatusService = {
-  typeName: "cacti.satp.v02.common.SessionStatusService",
+  typeName: "cacti.satp.v02.session.SessionStatusService",
   methods: {
     /**
-     * @generated from rpc cacti.satp.v02.common.SessionStatusService.GetStatus
+     * @generated from rpc cacti.satp.v02.session.SessionStatusService.GetStatus
      */
     getStatus: {
       name: "GetStatus",
@@ -22,7 +22,7 @@ export const SessionStatusService = {
       kind: MethodKind.Unary,
     },
     /**
-     * @generated from rpc cacti.satp.v02.common.SessionStatusService.SendStatus
+     * @generated from rpc cacti.satp.v02.session.SessionStatusService.SendStatus
      */
     sendStatus: {
       name: "SendStatus",
@@ -36,13 +36,13 @@ export const SessionStatusService = {
 /**
  * TODO: define common RPC methods for each step. This is a draft
  *
- * @generated from service cacti.satp.v02.common.CommonService
+ * @generated from service cacti.satp.v02.session.CommonService
  */
 export const CommonService = {
-  typeName: "cacti.satp.v02.common.CommonService",
+  typeName: "cacti.satp.v02.session.CommonService",
   methods: {
     /**
-     * @generated from rpc cacti.satp.v02.common.CommonService.Ping
+     * @generated from rpc cacti.satp.v02.session.CommonService.Ping
      */
     ping: {
       name: "Ping",
@@ -51,7 +51,7 @@ export const CommonService = {
       kind: MethodKind.Unary,
     },
     /**
-     * @generated from rpc cacti.satp.v02.common.CommonService.Rollback
+     * @generated from rpc cacti.satp.v02.session.CommonService.Rollback
      */
     rollback: {
       name: "Rollback",
@@ -60,7 +60,7 @@ export const CommonService = {
       kind: MethodKind.Unary,
     },
     /**
-     * @generated from rpc cacti.satp.v02.common.CommonService.GetStageVersion
+     * @generated from rpc cacti.satp.v02.session.CommonService.GetStageVersion
      */
     getStageVersion: {
       name: "GetStageVersion",