Colocate handlers and protocol implementations into modules (openwallet-foundation#191)

Signed-off-by: Jakub Koci <[email protected]>

Author: jakubkoci

src/lib/__tests__/credentials.test.ts

@@ -14,7 +14,7 @@ import {
   waitForCredentialRecord,
 } from './helpers';
 import { CredentialRecord } from '../storage/CredentialRecord';
-import { CredentialPreview, CredentialPreviewAttribute, CredentialState } from '../protocols/issue-credential';
+import { CredentialPreview, CredentialPreviewAttribute, CredentialState } from '../modules/credentials';
 import { InitConfig } from '../types';
 import logger from '../logger';
 

src/lib/__tests__/helpers.ts

@@ -4,19 +4,19 @@ import logger from '../logger';
 import path from 'path';
 import { Subject } from 'rxjs';
 import { ConnectionRecord } from '../storage/ConnectionRecord';
-import { Agent, InboundTransporter, OutboundTransporter, ProofEventType, ProofState, ProofStateChangedEvent } from '..';
+import { Agent, InboundTransporter, OutboundTransporter } from '..';
+import { ProofEventType, ProofState, ProofStateChangedEvent } from '../modules/proofs';
 import { OutboundPackage, WireMessage } from '../types';
-import { SchemaTemplate, CredDefTemplate } from '../agent/LedgerService';
+import { SchemaTemplate, CredDefTemplate } from '../modules/ledger/LedgerService';
 import {
   CredentialState,
   CredentialOfferTemplate,
   CredentialEventType,
   CredentialStateChangedEvent,
-} from '../protocols/issue-credential';
+} from '../modules/credentials';
 import { CredentialRecord } from '../storage/CredentialRecord';
 import { ProofRecord } from '../storage/ProofRecord';
-import { BasicMessage } from '../protocols/basicmessage/BasicMessage';
-import { BasicMessageEventType, BasicMessageReceivedEvent } from '../protocols/basicmessage/BasicMessageService';
+import { BasicMessage, BasicMessageEventType, BasicMessageReceivedEvent } from '../modules/basic-messages';
 
 export const genesisPath = process.env.GENESIS_TXN_PATH
   ? path.resolve(process.env.GENESIS_TXN_PATH)

src/lib/__tests__/proofs.test.ts

@@ -14,7 +14,7 @@ import {
   issueCredential,
   waitForProofRecord,
 } from './helpers';
-import { CredentialPreview, CredentialPreviewAttribute } from '../protocols/issue-credential';
+import { CredentialPreview, CredentialPreviewAttribute } from '../modules/credentials';
 import { InitConfig } from '../types';
 import {
   PredicateType,
@@ -25,7 +25,7 @@ import {
   ProofAttributeInfo,
   AttributeFilter,
   ProofPredicateInfo,
-} from '../protocols/present-proof';
+} from '../modules/proofs';
 import { ConnectionRecord } from '../storage/ConnectionRecord';
 import logger from '../logger';
 

src/lib/agent/Agent.ts

@@ -2,29 +2,29 @@ import type Indy from 'indy-sdk';
 import logger from '../logger';
 import { InitConfig } from '../types';
 import { IndyWallet } from '../wallet/IndyWallet';
-import { ConnectionService } from '../protocols/connections/ConnectionService';
-import { ProofService } from '../protocols/present-proof/ProofService';
-import { ProviderRoutingService } from '../protocols/routing/ProviderRoutingService';
-import { ConsumerRoutingService } from '../protocols/routing/ConsumerRoutingService';
-import { BasicMessageService } from '../protocols/basicmessage/BasicMessageService';
-import { TrustPingService } from '../protocols/trustping/TrustPingService';
-import { MessagePickupService } from '../protocols/messagepickup/MessagePickupService';
+import { ConnectionService } from '../modules/connections/ConnectionService';
+import { ProofService } from '../modules/proofs/ProofService';
+import { ProviderRoutingService } from '../modules/routing/ProviderRoutingService';
+import { ConsumerRoutingService } from '../modules/routing/ConsumerRoutingService';
+import { BasicMessageService } from '../modules/basic-messages/BasicMessageService';
+import { TrustPingService } from '../modules/connections/TrustPingService';
+import { MessagePickupService } from '../modules/routing/MessagePickupService';
 import { MessageReceiver } from './MessageReceiver';
 import { EnvelopeService } from './EnvelopeService';
-import { LedgerService } from './LedgerService';
+import { LedgerService } from '../modules/ledger/LedgerService';
 import { Dispatcher } from './Dispatcher';
 import { MessageSender } from './MessageSender';
 import { InboundTransporter } from '../transport/InboundTransporter';
 import { OutboundTransporter } from '../transport/OutboundTransporter';
-import { ConnectionRequestHandler } from '../handlers/connections/ConnectionRequestHandler';
-import { ConnectionResponseHandler } from '../handlers/connections/ConnectionResponseHandler';
-import { AckMessageHandler } from '../handlers/acks/AckMessageHandler';
-import { BasicMessageHandler } from '../handlers/basicmessage/BasicMessageHandler';
-import { ForwardHandler } from '../handlers/routing/ForwardHandler';
-import { TrustPingMessageHandler } from '../handlers/trustping/TrustPingMessageHandler';
-import { TrustPingResponseMessageHandler } from '../handlers/trustping/TrustPingResponseMessageHandler';
-import { MessagePickupHandler } from '../handlers/messagepickup/MessagePickupHandler';
-import { KeylistUpdateHandler } from '../handlers/coordinatemediation/KeylistUpdateHandler';
+import { ConnectionRequestHandler } from '../modules/connections/handlers/ConnectionRequestHandler';
+import { ConnectionResponseHandler } from '../modules/connections/handlers/ConnectionResponseHandler';
+import { AckMessageHandler } from '../modules/connections/handlers/AckMessageHandler';
+import { BasicMessageHandler } from '../modules/basic-messages/handlers/BasicMessageHandler';
+import { ForwardHandler } from '../modules/routing/handlers/ForwardHandler';
+import { TrustPingMessageHandler } from '../modules/connections/handlers/TrustPingMessageHandler';
+import { TrustPingResponseMessageHandler } from '../modules/connections/handlers/TrustPingResponseMessageHandler';
+import { MessagePickupHandler } from '../modules/routing/handlers/MessagePickupHandler';
+import { KeylistUpdateHandler } from '../modules/routing/handlers/KeylistUpdateHandler';
 import { MessageRepository } from '../storage/MessageRepository';
 import { BasicMessageRecord } from '../storage/BasicMessageRecord';
 import { Repository } from '../storage/Repository';
@@ -34,24 +34,24 @@ import { AgentConfig } from './AgentConfig';
 import { Wallet } from '../wallet/Wallet';
 import { ProvisioningRecord } from '../storage/ProvisioningRecord';
 import { ProvisioningService } from './ProvisioningService';
-import { ConnectionsModule } from '../modules/ConnectionsModule';
-import { RoutingModule } from '../modules/RoutingModule';
-import { BasicMessagesModule } from '../modules/BasicMessagesModule';
-import { LedgerModule } from '../modules/LedgerModule';
-import { CredentialsModule } from '../modules/CredentialsModule';
-import { ProofsModule } from '../modules/ProofsModule';
-import { CredentialService } from '../protocols/issue-credential/CredentialService';
+import { ConnectionsModule } from '../modules/connections/ConnectionsModule';
+import { RoutingModule } from '../modules/routing/RoutingModule';
+import { BasicMessagesModule } from '../modules/basic-messages/BasicMessagesModule';
+import { LedgerModule } from '../modules/ledger/LedgerModule';
+import { CredentialsModule } from '../modules/credentials/CredentialsModule';
+import { ProofsModule } from '../modules/proofs/ProofsModule';
+import { CredentialService } from '../modules/credentials/CredentialService';
 import { CredentialRecord } from '../storage/CredentialRecord';
-import { OfferCredentialHandler } from '../handlers/issue-credential/OfferCredentialHandler';
-import { RequestCredentialHandler } from '../handlers/issue-credential/RequestCredentialHandler';
-import { IssueCredentialHandler } from '../handlers/issue-credential/IssueCredentialHandler';
-import { CredentialAckHandler } from '../handlers/issue-credential/CredentialAckHandler';
-import { RequestPresentationHandler } from '../handlers/present-proof/RequestPresentationHandler';
+import { OfferCredentialHandler } from '../modules/credentials/handlers/OfferCredentialHandler';
+import { RequestCredentialHandler } from '../modules/credentials/handlers/RequestCredentialHandler';
+import { IssueCredentialHandler } from '../modules/credentials/handlers/IssueCredentialHandler';
+import { CredentialAckHandler } from '../modules/credentials/handlers/CredentialAckHandler';
+import { RequestPresentationHandler } from '../modules/proofs/handlers/RequestPresentationHandler';
 import { ProofRecord } from '../storage/ProofRecord';
-import { ProposePresentationHandler } from '../handlers/present-proof/ProposePresentationHandler';
-import { PresentationAckHandler } from '../handlers/present-proof/PresentationAckHandler';
-import { PresentationHandler } from '../handlers/present-proof/PresentationHandler';
-import { ProposeCredentialHandler } from '../handlers/issue-credential/ProposeCredentialHandler';
+import { ProposePresentationHandler } from '../modules/proofs/handlers/ProposePresentationHandler';
+import { PresentationAckHandler } from '../modules/proofs/handlers/PresentationAckHandler';
+import { PresentationHandler } from '../modules/proofs/handlers/PresentationHandler';
+import { ProposeCredentialHandler } from '../modules/credentials/handlers/ProposeCredentialHandler';
 
 export class Agent {
   protected wallet: Wallet;

src/lib/agent/EnvelopeService.ts

@@ -1,7 +1,7 @@
 import logger from '../logger';
 import { OutboundMessage, OutboundPackage, UnpackedMessageContext } from '../types';
 import { Wallet } from '../wallet/Wallet';
-import { ForwardMessage } from '../protocols/routing/ForwardMessage';
+import { ForwardMessage } from '../modules/routing/ForwardMessage';
 
 class EnvelopeService {
   private wallet: Wallet;

src/lib/agent/MessageReceiver.ts

@@ -3,9 +3,9 @@ import { AgentConfig } from './AgentConfig';
 import { Dispatcher } from './Dispatcher';
 import { EnvelopeService } from './EnvelopeService';
 import { UnpackedMessageContext, UnpackedMessage } from '../types';
-import { MessageType } from '../protocols/routing/messages';
+import { MessageType } from '../modules/routing/messages';
 import { InboundMessageContext } from './models/InboundMessageContext';
-import { ConnectionService } from '../protocols/connections/ConnectionService';
+import { ConnectionService } from '../modules/connections/ConnectionService';
 import { AgentMessage } from './AgentMessage';
 import { JsonTransformer } from '../utils/JsonTransformer';
 
@@ -44,8 +44,6 @@ class MessageReceiver {
 
     logger.logJson('inboundMessage', unpackedMessage);
 
-    // TODO move `message` declaration down right above `messageContext` creation
-    const message = await this.transformMessage(unpackedMessage);
     const senderKey = unpackedMessage.sender_verkey;
     let connection = undefined;
     if (senderKey && unpackedMessage.recipient_verkey) {
@@ -63,6 +61,7 @@ class MessageReceiver {
       }
     }
 
+    const message = await this.transformMessage(unpackedMessage);
     const messageContext = new InboundMessageContext(message, {
       connection,
       senderVerkey: senderKey,

src/lib/agent/__tests__/AgentConfig.test.ts

@@ -1,6 +1,5 @@
-import { getMockConnection } from '../../protocols/connections/__tests__/ConnectionService.test';
-import { DidDoc } from '../../protocols/connections/domain/did/DidDoc';
-import { IndyAgentService } from '../../protocols/connections/domain/did/service';
+import { getMockConnection } from '../../modules/connections/__tests__/ConnectionService.test';
+import { DidDoc, IndyAgentService } from '../../modules/connections';
 import { AgentConfig } from '../AgentConfig';
 
 describe('AgentConfig', () => {

src/lib/protocols/helpers.ts renamed to src/lib/agent/helpers.ts

@@ -1,8 +1,8 @@
 import { ConnectionRecord } from '../storage/ConnectionRecord';
-import { AgentMessage } from '../agent/AgentMessage';
+import { AgentMessage } from './AgentMessage';
 import { OutboundMessage } from '../types';
-import { ConnectionInvitationMessage } from './connections/messages/ConnectionInvitationMessage';
-import { IndyAgentService } from './connections/domain/did/service';
+import { ConnectionInvitationMessage } from '../modules/connections';
+import { IndyAgentService } from '../modules/connections';
 
 export function createOutboundMessage<T extends AgentMessage = AgentMessage>(
   connection: ConnectionRecord,

src/lib/helpers.ts

@@ -1,6 +1,6 @@
 import { validateOrReject } from 'class-validator';
 
-import { ConnectionInvitationMessage } from './protocols/connections/messages/ConnectionInvitationMessage';
+import { ConnectionInvitationMessage } from './modules/connections';
 import { JsonEncoder } from './utils/JsonEncoder';
 import { JsonTransformer } from './utils/JsonTransformer';
 

src/lib/index.ts

@@ -10,9 +10,9 @@ export { InitConfig, OutboundPackage } from './types';
 export { ConnectionRecord } from './storage/ConnectionRecord';
 export { BasicMessageRecord } from './storage/BasicMessageRecord';
 export { CredentialRecord } from './storage/CredentialRecord';
-export { ConnectionEventType } from './protocols/connections/ConnectionService';
-export { BasicMessageEventType } from './protocols/basicmessage/BasicMessageService';
-export * from './protocols/issue-credential';
-export * from './protocols/present-proof';
-export * from './protocols/connections';
+export { ConnectionEventType } from './modules/connections/ConnectionService';
+export { BasicMessageEventType } from './modules/basic-messages/BasicMessageService';
+export * from './modules/credentials';
+export * from './modules/proofs';
+export * from './modules/connections';
 export * from './utils/JsonTransformer';

src/lib/protocols/basicmessage/BasicMessage.ts renamed to src/lib/modules/basic-messages/BasicMessage.ts

@@ -1,7 +1,7 @@
 import type { Verkey, WalletQuery } from 'indy-sdk';
 import { EventEmitter } from 'events';
 import { OutboundMessage } from '../../types';
-import { createOutboundMessage } from '../helpers';
+import { createOutboundMessage } from '../../agent/helpers';
 import { Repository } from '../../storage/Repository';
 import { BasicMessageRecord } from '../../storage/BasicMessageRecord';
 import { ConnectionRecord } from '../../storage/ConnectionRecord';

src/lib/protocols/basicmessage/BasicMessageService.test.ts renamed to src/lib/modules/basic-messages/BasicMessageService.test.ts

@@ -1,8 +1,8 @@
 import type { WalletQuery } from 'indy-sdk';
 import { EventEmitter } from 'events';
-import { BasicMessageService } from '../protocols/basicmessage/BasicMessageService';
-import { MessageSender } from '../agent/MessageSender';
-import { ConnectionRecord } from '../storage/ConnectionRecord';
+import { BasicMessageService } from './BasicMessageService';
+import { MessageSender } from '../../agent/MessageSender';
+import { ConnectionRecord } from '../../storage/ConnectionRecord';
 
 export class BasicMessagesModule {
   private basicMessageService: BasicMessageService;

src/lib/protocols/basicmessage/BasicMessageService.ts renamed to src/lib/modules/basic-messages/BasicMessageService.ts

@@ -1,6 +1,6 @@
-import { Handler, HandlerInboundMessage } from '../Handler';
-import { BasicMessageService } from '../../protocols/basicmessage/BasicMessageService';
-import { BasicMessage } from '../../protocols/basicmessage/BasicMessage';
+import { Handler, HandlerInboundMessage } from '../../../handlers/Handler';
+import { BasicMessageService } from '../BasicMessageService';
+import { BasicMessage } from '../BasicMessage';
 
 export class BasicMessageHandler implements Handler {
   private basicMessageService: BasicMessageService;

src/lib/modules/BasicMessagesModule.ts renamed to src/lib/modules/basic-messages/BasicMessagesModule.ts

@@ -0,0 +1,2 @@
+export { BasicMessage } from './BasicMessage';
+export { BasicMessageService, BasicMessageEventType, BasicMessageReceivedEvent } from './BasicMessageService';

src/lib/handlers/basicmessage/BasicMessageHandler.ts renamed to src/lib/modules/basic-messages/handlers/BasicMessageHandler.ts

@@ -15,7 +15,7 @@ import { Connection } from './domain/Connection';
 import { AckMessage } from './messages/AckMessage';
 import { InboundMessageContext } from '../../agent/models/InboundMessageContext';
 import { ConnectionRole } from './domain/ConnectionRole';
-import { TrustPingMessage } from '../trustping/TrustPingMessage';
+import { TrustPingMessage } from './messages/TrustPingMessage';
 import { JsonTransformer } from '../../utils/JsonTransformer';
 import { AgentMessage } from '../../agent/AgentMessage';
 import { Ed25119Sig2018 } from './domain/did/publicKey';

src/lib/modules/basic-messages/index.ts

@@ -1,15 +1,15 @@
 import type { Verkey } from 'indy-sdk';
 import { EventEmitter } from 'events';
 
-import { AgentConfig } from '../agent/AgentConfig';
-import { ConnectionService, ConnectionStateChangedEvent } from '../protocols/connections/ConnectionService';
-import { ConsumerRoutingService } from '../protocols/routing/ConsumerRoutingService';
-import { ConnectionRecord } from '../storage/ConnectionRecord';
-import { ConnectionState } from '../protocols/connections/domain/ConnectionState';
-import { ConnectionInvitationMessage } from '../protocols/connections/messages/ConnectionInvitationMessage';
-import { MessageSender } from '../agent/MessageSender';
-import { ConnectionEventType } from '..';
-import { createOutboundMessage } from '../protocols/helpers';
+import { AgentConfig } from '../../agent/AgentConfig';
+import { ConnectionService, ConnectionStateChangedEvent } from './ConnectionService';
+import { ConsumerRoutingService } from '../routing/ConsumerRoutingService';
+import { ConnectionRecord } from '../../storage/ConnectionRecord';
+import { ConnectionState } from './domain/ConnectionState';
+import { MessageSender } from '../../agent/MessageSender';
+import { ConnectionEventType } from './ConnectionService';
+import { createOutboundMessage } from '../../agent/helpers';
+import { ConnectionInvitationMessage } from './messages';
 
 export class ConnectionsModule {
   private agentConfig: AgentConfig;

src/lib/protocols/basicmessage/messages.ts renamed to src/lib/modules/basic-messages/messages.ts

@@ -1,7 +1,7 @@
-import { createOutboundMessage } from '../helpers';
+import { createOutboundMessage } from '../../agent/helpers';
 import { ConnectionRecord } from '../../storage/ConnectionRecord';
-import { TrustPingMessage } from './TrustPingMessage';
-import { TrustPingResponseMessage } from './TrustPingResponseMessage';
+import { TrustPingMessage } from './messages/TrustPingMessage';
+import { TrustPingResponseMessage } from './messages/TrustPingResponseMessage';
 import { InboundMessageContext } from '../../agent/models/InboundMessageContext';
 
 /**

src/lib/protocols/connections/ConnectionService.ts renamed to src/lib/modules/connections/ConnectionService.ts

@@ -16,7 +16,7 @@ import { InboundMessageContext } from '../../../agent/models/InboundMessageConte
 import { ConnectionResponseMessage } from '../messages/ConnectionResponseMessage';
 import { SignatureDecorator } from '../../../decorators/signature/SignatureDecorator';
 import { ConnectionRequestMessage } from '../messages/ConnectionRequestMessage';
-import { TrustPingMessage } from '../../trustping/TrustPingMessage';
+import { TrustPingMessage } from '../messages/TrustPingMessage';
 import { AckMessage, AckStatus } from '../messages/AckMessage';
 import { JsonTransformer } from '../../../utils/JsonTransformer';
 import { DidDoc } from '../domain/did/DidDoc';

src/lib/modules/ConnectionsModule.ts renamed to src/lib/modules/connections/ConnectionsModule.ts

@@ -1,6 +1,6 @@
-import { Handler, HandlerInboundMessage } from '../Handler';
-import { ConnectionService } from '../../protocols/connections/ConnectionService';
-import { AckMessage } from '../../protocols/connections/messages/AckMessage';
+import { Handler, HandlerInboundMessage } from '../../../handlers/Handler';
+import { ConnectionService } from '../ConnectionService';
+import { AckMessage } from '../messages/AckMessage';
 
 export class AckMessageHandler implements Handler {
   private connectionService: ConnectionService;

src/lib/protocols/trustping/TrustPingService.ts renamed to src/lib/modules/connections/TrustPingService.ts

@@ -1,8 +1,8 @@
-import { Handler, HandlerInboundMessage } from '../Handler';
-import { ConnectionService } from '../../protocols/connections/ConnectionService';
-import { ConnectionRequestMessage } from '../../protocols/connections/messages/ConnectionRequestMessage';
-import { AgentConfig } from '../../agent/AgentConfig';
-import { createOutboundMessage } from '../../protocols/helpers';
+import { Handler, HandlerInboundMessage } from '../../../handlers/Handler';
+import { ConnectionService } from '../ConnectionService';
+import { ConnectionRequestMessage } from '../messages/ConnectionRequestMessage';
+import { AgentConfig } from '../../../agent/AgentConfig';
+import { createOutboundMessage } from '../../../agent/helpers';
 
 export class ConnectionRequestHandler implements Handler {
   private connectionService: ConnectionService;