add diddoc class transformer (openwallet-foundation#108)

* expose default values in class-transformer
* update diddoc classes to class-transformer
* add class-transformer to docker build
* update class-transformer to newest version

Signed-off-by: Timo Glastra <[email protected]>

Author: TimoGlastra

.gitignore

@@ -6,3 +6,4 @@ yarn-error.log
 aries-framework-javascript-*.tgz
 src/lib/__tests__/genesis-von.txn
 coverage
+.DS_Store

jest.config.js

@@ -13,5 +13,5 @@ module.exports = {
   },
   collectCoverageFrom: ['src/lib/**/*.{js,jsx,tsx,ts}'],
   coveragePathIgnorePatterns: ['/node_modules/', '/__tests__/'],
-  testTimeout: 30000,
+  testTimeout: 45000,
 };

package.json

@@ -25,7 +25,7 @@
     "await-poll": "^1.0.2",
     "bn.js": "^5.1.3",
     "buffer": "^6.0.2",
-    "class-transformer": "^0.3.1",
+    "class-transformer": "0.3.2",
     "class-validator": "^0.12.2",
     "debug": "^4.1.1",
     "events": "^3.2.0",

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

@@ -1,5 +1,6 @@
 import { getMockConnection } from '../../protocols/connections/ConnectionService.test';
-import { DidDoc, Service } from '../../protocols/connections/domain/DidDoc';
+import { DidDoc } from '../../protocols/connections/domain/did/DidDoc';
+import { IndyAgentService } from '../../protocols/connections/domain/did/service';
 import { AgentConfig } from '../AgentConfig';
 
 describe('AgentConfig', () => {
@@ -15,7 +16,12 @@ describe('AgentConfig', () => {
       agentConfig.establishInbound({
         verkey: 'test',
         connection: getMockConnection({
-          theirDidDoc: new DidDoc('test', [], [], [new Service('test', endpoint, [], [], 1, 'type')]),
+          theirDidDoc: new DidDoc({
+            id: 'test',
+            publicKey: [],
+            authentication: [],
+            service: [new IndyAgentService({ id: `test;indy`, serviceEndpoint: endpoint, recipientKeys: [] })],
+          }),
         }),
       });
 

src/lib/helpers.ts

@@ -1,4 +1,3 @@
-import { Transform } from 'class-transformer';
 import { validateOrReject } from 'class-validator';
 
 import { ConnectionInvitationMessage } from './protocols/connections/messages/ConnectionInvitationMessage';
@@ -41,36 +40,3 @@ export function encodeInvitationToUrl(
 
   return invitationUrl;
 }
-
-/**
- * Provide a default value for a parameter when using class-transformer
- *
- * Class transfomer doesn't use the default value of a property when transforming an
- * object using `plainToClass`. This decorator allows to set a default value when no value is
- * present during transformation.
- *
- * @param defaultValue the default value to use when there is no value present during transformation
- * @see https://github.com/typestack/class-transformer/issues/129#issuecomment-425843700
- *
- * @example
- * import { plainToClass } from 'class-transformer'
- *
- * class Test {
- *  // doesn't work
- *  myProp = true;
- *
- *  // does work
- *  ＠Default(true)
- *  myDefaultProp: boolean;
- * }
- *
- * plainToClass(Test, {})
- * // results in
- * {
- *   "myProp": undefined,
- *   "myDefaultProp": true
- * }
- */
-export function Default<T>(defaultValue: T) {
-  return Transform((value: T | null | undefined) => (value !== null && value !== undefined ? value : defaultValue));
-}

src/lib/protocols/connections/ConnectionService.test.ts

@@ -9,9 +9,7 @@ import { ConnectionState } from './domain/ConnectionState';
 import { InitConfig } from '../../types';
 import { ConnectionRole } from './domain/ConnectionRole';
 import { ConnectionInvitationMessage } from './messages/ConnectionInvitationMessage';
-
 import { Repository } from '../../storage/Repository';
-import { DidDoc, Service } from './domain/DidDoc';
 import { Connection } from './domain/Connection';
 import { signData, unpackAndVerifySignatureDecorator } from '../../decorators/signature/SignatureDecoratorUtils';
 import { InboundMessageContext } from '../../agent/models/InboundMessageContext';
@@ -21,6 +19,9 @@ import { ConnectionRequestMessage } from './messages/ConnectionRequestMessage';
 import { TrustPingMessage } from '../trustping/TrustPingMessage';
 import { AckMessage, AckStatus } from './messages/AckMessage';
 import { JsonTransformer } from '../../utils/JsonTransformer';
+import { DidDoc } from './domain/did/DidDoc';
+import { IndyAgentService } from './domain/did/service';
+
 jest.mock('./../../storage/Repository');
 const ConnectionRepository = <jest.Mock<Repository<ConnectionRecord>>>(<unknown>Repository);
 
@@ -30,20 +31,29 @@ export function getMockConnection({
   id = 'test',
   did = 'test-did',
   verkey = 'key-1',
-  didDoc = new DidDoc(did, [], [], [new Service(`${did};indy`, 'https://endpoint.com', [verkey], [], 0, 'IndyAgent')]),
+  didDoc = new DidDoc({
+    id: did,
+    publicKey: [],
+    authentication: [],
+    service: [
+      new IndyAgentService({ id: `${did};indy`, serviceEndpoint: 'https://endpoint.com', recipientKeys: [verkey] }),
+    ],
+  }),
   tags = {},
   invitation = new ConnectionInvitationMessage({
     label: 'test',
     recipientKeys: [verkey],
     serviceEndpoint: 'https:endpoint.com/msg',
   }),
   theirDid = 'their-did',
-  theirDidDoc = new DidDoc(
-    theirDid,
-    [],
-    [],
-    [new Service(`${did};indy`, 'https://endpoint.com', [verkey], [], 0, 'IndyAgent')]
-  ),
+  theirDidDoc = new DidDoc({
+    id: theirDid,
+    publicKey: [],
+    authentication: [],
+    service: [
+      new IndyAgentService({ id: `${did};indy`, serviceEndpoint: 'https://endpoint.com', recipientKeys: [verkey] }),
+    ],
+  }),
 }: Partial<ConnectionStorageProps> = {}) {
   return new ConnectionRecord({
     did,
@@ -290,12 +300,18 @@ describe('ConnectionService', () => {
 
       const theirDid = 'their-did';
       const theirVerkey = 'their-verkey';
-      const theirDidDoc = new DidDoc(
-        theirDid,
-        [],
-        [],
-        [new Service(`${theirDid};indy`, 'https://endpoint.com', [theirVerkey], [], 0, 'IndyAgent')]
-      );
+      const theirDidDoc = new DidDoc({
+        id: theirDid,
+        publicKey: [],
+        authentication: [],
+        service: [
+          new IndyAgentService({
+            id: `${theirDid};indy`,
+            serviceEndpoint: 'https://endpoint.com',
+            recipientKeys: [theirVerkey],
+          }),
+        ],
+      });
 
       const connectionRequest = new ConnectionRequestMessage({
         did: theirDid,
@@ -477,12 +493,18 @@ describe('ConnectionService', () => {
 
       const otherPartyConnection = new Connection({
         did: theirDid,
-        didDoc: new DidDoc(
-          theirDid,
-          [],
-          [],
-          [new Service(`${did};indy`, 'https://endpoint.com', [theirVerkey], [], 0, 'IndyAgent')]
-        ),
+        didDoc: new DidDoc({
+          id: theirDid,
+          publicKey: [],
+          authentication: [],
+          service: [
+            new IndyAgentService({
+              id: `${did};indy`,
+              serviceEndpoint: 'https://endpoint.com',
+              recipientKeys: [theirVerkey],
+            }),
+          ],
+        }),
       });
 
       const plainConnection = JsonTransformer.toJSON(otherPartyConnection);
@@ -537,12 +559,18 @@ describe('ConnectionService', () => {
 
       const otherPartyConnection = new Connection({
         did: theirDid,
-        didDoc: new DidDoc(
-          theirDid,
-          [],
-          [],
-          [new Service(`${did};indy`, 'https://endpoint.com', [theirVerkey], [], 0, 'IndyAgent')]
-        ),
+        didDoc: new DidDoc({
+          id: theirDid,
+          publicKey: [],
+          authentication: [],
+          service: [
+            new IndyAgentService({
+              id: `${did};indy`,
+              serviceEndpoint: 'https://endpoint.com',
+              recipientKeys: [theirVerkey],
+            }),
+          ],
+        }),
       });
       const plainConnection = JsonTransformer.toJSON(otherPartyConnection);
       const connectionSig = await signData(plainConnection, wallet, theirVerkey);

src/lib/protocols/connections/ConnectionService.ts

@@ -3,7 +3,6 @@ import { validateOrReject } from 'class-validator';
 
 import { AgentConfig } from '../../agent/AgentConfig';
 import { ConnectionState } from './domain/ConnectionState';
-import { DidDoc, Service, PublicKey, PublicKeyType, Authentication } from './domain/DidDoc';
 import { ConnectionRecord, ConnectionTags } from '../../storage/ConnectionRecord';
 import { Repository } from '../../storage/Repository';
 import { Wallet } from '../../wallet/Wallet';
@@ -18,6 +17,10 @@ import { ConnectionRole } from './domain/ConnectionRole';
 import { TrustPingMessage } from '../trustping/TrustPingMessage';
 import { JsonTransformer } from '../../utils/JsonTransformer';
 import { AgentMessage } from '../../agent/AgentMessage';
+import { Ed25119Sig2018 } from './domain/did/publicKey';
+import { IndyAgentService } from './domain/did/service';
+import { DidDoc } from './domain/did/DidDoc';
+import { authenticationTypes, ReferencedAuthentication } from './domain/did/authentication';
 
 export enum ConnectionEventType {
   StateChanged = 'stateChanged',
@@ -64,11 +67,12 @@ export class ConnectionService extends EventEmitter {
     });
 
     const { didDoc } = connectionRecord;
+    const [service] = didDoc.getServicesByClassType(IndyAgentService);
     const invitation = new ConnectionInvitationMessage({
       label: this.config.label,
-      recipientKeys: didDoc.service[0].recipientKeys,
-      serviceEndpoint: didDoc.service[0].serviceEndpoint,
-      routingKeys: didDoc.service[0].routingKeys,
+      recipientKeys: service.recipientKeys,
+      serviceEndpoint: service.serviceEndpoint,
+      routingKeys: service.routingKeys,
     });
 
     connectionRecord.invitation = invitation;
@@ -249,6 +253,7 @@ export class ConnectionService extends EventEmitter {
     const connectionJson = await unpackAndVerifySignatureDecorator(message.connectionSig, this.wallet);
 
     const connection = JsonTransformer.fromJSON(connectionJson, Connection);
+    // TODO: throw framework error stating the connection object is invalid
     await validateOrReject(connection);
 
     // Per the Connection RFC we must check if the key used to sign the connection~sig is the same key
@@ -345,18 +350,31 @@ export class ConnectionService extends EventEmitter {
     autoAcceptConnection?: boolean;
     tags?: ConnectionTags;
   }): Promise<ConnectionRecord> {
-    const [did, verkey] = await this.wallet.createDid();
-    const publicKey = new PublicKey(`${did}#1`, PublicKeyType.ED25519_SIG_2018, did, verkey);
-    const service = new Service(
-      `${did};indy`,
-      this.config.getEndpoint(),
-      [verkey],
-      this.config.getRoutingKeys(),
-      0,
-      'IndyAgent'
-    );
-    const auth = new Authentication(publicKey);
-    const didDoc = new DidDoc(did, [auth], [publicKey], [service]);
+    const [did, verkey] = await this.wallet.createDid({ method_name: 'sov' });
+
+    const publicKey = new Ed25119Sig2018({
+      id: `${did}#1`,
+      controller: did,
+      publicKeyBase58: verkey,
+    });
+
+    const service = new IndyAgentService({
+      id: `${did};indy`,
+      serviceEndpoint: this.config.getEndpoint(),
+      recipientKeys: [verkey],
+      routingKeys: this.config.getRoutingKeys(),
+    });
+
+    // TODO: abstract the second paramater for ReferencedAuthentication away. This can be
+    // inferred from the publicKey class instance
+    const auth = new ReferencedAuthentication(publicKey, authenticationTypes[publicKey.type]);
+
+    const didDoc = new DidDoc({
+      id: did,
+      authentication: [auth],
+      service: [service],
+      publicKey: [publicKey],
+    });
 
     const connectionRecord = new ConnectionRecord({
       did,
@@ -377,7 +395,7 @@ export class ConnectionService extends EventEmitter {
     return connectionRecord;
   }
 
-  public async getConnections() {
+  public getConnections() {
     return this.connectionRepository.findAll();
   }
 

src/lib/protocols/connections/domain/Connection.ts

@@ -1,7 +1,7 @@
-import { IsString } from 'class-validator';
-import { Expose, Transform } from 'class-transformer';
+import { IsString, ValidateNested } from 'class-validator';
+import { Expose, Type } from 'class-transformer';
 
-import { DidDoc } from './DidDoc';
+import { DidDoc } from './did/DidDoc';
 
 export interface ConnectionOptions {
   did: string;
@@ -21,13 +21,7 @@ export class Connection {
   public did!: string;
 
   @Expose({ name: 'DIDDoc' })
-  // TODO: add type for DidDoc
-  // When we add the @Type json object DidDoc parameter will be cast to DidDoc class instance
-  // However the DidDoc class is not yet decorated using class-transformer
-  // meaning it will give errors because the class will be invalid.
-  // for now the DidDoc class is however correctly cast from class instance to json
-  // @Type(() => DidDoc)
-  // This way we also don't need the custom transformer
-  @Transform((value: DidDoc | undefined) => (value?.toJSON ? value.toJSON() : value), { toPlainOnly: true })
+  @Type(() => DidDoc)
+  @ValidateNested()
   public didDoc?: DidDoc;
 }