WIP - service versioning.

Author: tegefaulkes

src/PolykeyAgent.ts

@@ -22,7 +22,7 @@ import { SessionManager } from './sessions';
 import { certNodeId } from './network/utils';
 import { IdentitiesManager } from './identities';
 import { ForwardProxy, ReverseProxy } from './network';
-import { IAgentServer } from './proto/js/Agent_grpc_pb';
+import { IAgentServer } from './proto/js/Agent.v2_grpc_pb';
 import { IClientServer } from './proto/js/Client_grpc_pb';
 import { createAgentService, AgentService } from './agent';
 import { createClientService, ClientService } from './client';

src/agent/agentService.ts

@@ -14,7 +14,7 @@ import { Sigchain } from '../sigchain';
 import { KeyManager } from '../keys';
 import { NotificationsManager } from '../notifications';
 import { ErrorGRPC } from '../grpc/errors';
-import { AgentService, IAgentServer } from '../proto/js/Agent_grpc_pb';
+import { AgentService, IAgentServer } from '../proto/js/Agent.v2_grpc_pb';
 
 import { messages } from '.';
 import * as grpcUtils from '../grpc/utils';
@@ -47,7 +47,7 @@ function createAgentService({
   notificationsManager: NotificationsManager;
 }): IAgentServer {
   const agentService: IAgentServer = {
-    echo: async (
+    echoNew: async (
       call: grpc.ServerUnaryCall<
         messages.common.EchoMessage,
         messages.common.EchoMessage

src/grpc/GRPCServer.ts

@@ -194,7 +194,6 @@ class GRPCServer {
     return;
   }
 
-  @ready(new grpcErrors.ErrorGRPCServerNotStarted())
   public closeServerForce(): void {
     this.server.forceShutdown();
   }

src/proto/schemas/Agent.v2.proto

@@ -0,0 +1,30 @@
+syntax = "proto3";
+
+import "Common.proto";
+import "Nodes.proto";
+import "Vaults.proto";
+import "Notifications.proto";
+
+package agentInterface.v2;
+
+service Agent {
+
+  // Echo
+  rpc EchoNew(common.EchoMessage) returns (common.EchoMessage);
+
+  // Vaults
+  rpc VaultsGitInfoGet (vault.Vault) returns (stream vault.PackChunk);
+  rpc VaultsGitPackGet(stream vault.PackChunk) returns (stream vault.PackChunk);
+  rpc VaultsScan (node.Node) returns (stream vault.Vault);
+  rpc VaultsPermisssionsCheck (vault.NodePermission) returns (vault.NodePermissionAllowed);
+
+  // Nodes
+  rpc NodesClosestLocalNodesGet (node.Node) returns (node.NodeTable);
+  rpc NodesClaimsGet (node.ClaimType) returns (node.Claims);
+  rpc NodesChainDataGet (common.EmptyMessage) returns (node.ChainData);
+  rpc NodesHolePunchMessageSend (node.Relay) returns (common.EmptyMessage);
+  rpc NodesCrossSignClaim (stream node.CrossSign) returns (stream node.CrossSign);
+
+  // Notifications
+  rpc NotificationsSend (notification.AgentNotification) returns (common.EmptyMessage);
+}

src/vaults/VaultManager.ts

@@ -216,6 +216,12 @@ class VaultManager {
     this.logger.info('Destroyed Vault Manager');
   }
 
+  /**
+   * Gets the name of the vault with vaultId
+   * @param vaultId - Id of the vault.
+   * @returns {VaultName} - Name of the vault.
+   * @throws ErrorVaultUndefined if no vault matches the provided VaultId
+   */
   @ready(new vaultsErrors.ErrorVaultManagerDestroyed())
   public async getVaultName(vaultId: VaultId): Promise<VaultName | undefined> {
     const vaultMeta = await this.db.get<POJO>(
@@ -226,6 +232,11 @@ class VaultManager {
     return vaultMeta.name;
   }
 
+  /**
+   * Creates a vault with the vaultName.
+   * @param vaultName
+   * @returns {*}
+   */
   @ready(new vaultsErrors.ErrorVaultManagerDestroyed())
   public async createVault(vaultName: VaultName): Promise<Vault> {
     const vaultId = await this.generateVaultId();

tests/agent/GRPCClientAgent.test.ts

@@ -407,4 +407,11 @@ describe('GRPC agent', () => {
       expect(sigchain.locked).toBe(false);
     });
   });
+  test('trying to call a service that is not supported.', async () => {
+    const echoMessage = new messages.common.EchoMessage();
+    echoMessage.setChallenge('yes');
+    await client.echo(echoMessage);
+    const response = await client.echo(echoMessage);
+    expect(response.getChallenge()).toBe('yes');
+  })
 });