@dxos/protocols 0.1.58-main.f69fa2f → 0.1.58-main.f860ba2

package/dist/esm/src/proto/gen/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../src/proto/gen/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AAuDhE,OAAO,aAAa,MAAM,kBAAkB,CAAC;AAgf7C,MAAM,CAAC,MAAM,UAAU,GAAG,gBAAgB,CAAC,IAAI,CAAC,KAAK,CAAC,6s2FAA6s2F,CAAC,CAAC,CAAC;AACtw2F,MAAM,CAAC,MAAM,MAAM,GAAG,MAAM,CAAC,QAAQ,CAAkB,UAAU,EAAE,aAAa,CAAC,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../src/proto/gen/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AAuDhE,OAAO,aAAa,MAAM,kBAAkB,CAAC;AAgf7C,MAAM,CAAC,MAAM,UAAU,GAAG,gBAAgB,CAAC,IAAI,CAAC,KAAK,CAAC,uy2FAAuy2F,CAAC,CAAC,CAAC;AACh22F,MAAM,CAAC,MAAM,MAAM,GAAG,MAAM,CAAC,QAAQ,CAAkB,UAAU,EAAE,aAAa,CAAC,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dxos/protocols",
-  "version": "0.1.58-main.f69fa2f",
+  "version": "0.1.58-main.f860ba2",
   "description": "Protobuf definitions for DXOS protocols.",
   "homepage": "https://dxos.org",
   "bugs": "https://github.com/dxos/dxos/issues",
@@ -33,10 +33,10 @@
     "src"
   ],
   "dependencies": {
-    "@dxos/codec-protobuf": "0.1.58-main.f69fa2f",
-    "@dxos/invariant": "0.1.58-main.f69fa2f",
-    "@dxos/keys": "0.1.58-main.f69fa2f",
-    "@dxos/timeframe": "0.1.58-main.f69fa2f"
+    "@dxos/codec-protobuf": "0.1.58-main.f860ba2",
+    "@dxos/invariant": "0.1.58-main.f860ba2",
+    "@dxos/keys": "0.1.58-main.f860ba2",
+    "@dxos/timeframe": "0.1.58-main.f860ba2"
   },
   "devDependencies": {
     "glob": "~7.1.6"

package/src/errors/base-errors.ts

@@ -0,0 +1,34 @@
+//
+// Copyright 2021 DXOS.org
+//
+
+/**
+ * NOTE: Messages should be sentences (Start with a capital letter and end with a period).
+ * Errors can optionally include a JSON context object.
+ */
+export class BaseError extends Error {
+  constructor(readonly code: string, message?: string, readonly context?: Record<string, any>) {
+    super(message ?? code);
+    this.name = code;
+    // NOTE: Restores prototype chain (https://stackoverflow.com/a/48342359).
+    Object.setPrototypeOf(this, new.target.prototype);
+  }
+}
+
+/**
+ * User facing API Errors.
+ * E.g., something was misconfigured.
+ */
+export class ApiError extends BaseError {}
+
+/**
+ * Internal system errors.
+ * E.g., unexpected/unrecoverable runtime error.
+ */
+export class SystemError extends BaseError {}
+
+/**
+ * Database errors.
+ */
+// TODO(wittjosiah): Same as ApiError?
+export class DatabaseError extends BaseError {}

package/src/errors/errors.test.ts

@@ -7,7 +7,7 @@ import chaiAsPromised from 'chai-as-promised';
 
 import { describe, test } from '@dxos/test';
 
-import { ApiError } from './errors';
+import { ApiError } from './base-errors';
 
 chai.use(chaiAsPromised);
 

package/src/errors/errors.ts

@@ -2,41 +2,12 @@
 // Copyright 2021 DXOS.org
 //
 
-import type { PublicKey } from '@dxos/keys';
+import { PublicKey } from '@dxos/keys';
 
+import { ApiError, DatabaseError, SystemError, BaseError } from './base-errors';
+import { registerError, registerErrorMessageContext, registerErrorNoArgs } from './helpers';
 import type { ItemID } from '../types';
 
-/**
- * NOTE: Messages should be sentences (Start with a capital letter and end with a period).
- * Errors can optionally include a JSON context object.
- */
-class BaseError extends Error {
-  constructor(readonly code: string, message?: string, readonly context?: Record<string, any>) {
-    super(message ?? code);
-    this.name = code;
-    // NOTE: Restores prototype chain (https://stackoverflow.com/a/48342359).
-    Object.setPrototypeOf(this, new.target.prototype);
-  }
-}
-
-/**
- * User facing API Errors.
- * E.g., something was misconfigured.
- */
-export class ApiError extends BaseError {}
-
-/**
- * Internal system errors.
- * E.g., unexpected/unrecoverable runtime error.
- */
-export class SystemError extends BaseError {}
-
-/**
- * Database errors.
- */
-// TODO(wittjosiah): Same as ApiError?
-export class DatabaseError extends BaseError {}
-
 /**
  * Thrown when request was terminated because the RPC endpoint has been closed.
  */
@@ -46,6 +17,8 @@ export class RpcClosedError extends SystemError {
   }
 }
 
+registerErrorNoArgs('RPC_CLOSED', RpcClosedError);
+
 /**
  * Thrown when `request` is called when RPC has not been opened.
  */
@@ -55,18 +28,24 @@ export class RpcNotOpenError extends SystemError {
   }
 }
 
+registerErrorNoArgs('RPC_NOT_OPEN', RpcNotOpenError);
+
 export class CancelledError extends SystemError {
   constructor(message?: string, context?: Record<string, any>) {
     super('CANCELLED', message, context);
   }
 }
 
+registerErrorMessageContext('CANCELLED', CancelledError);
+
 export class InvalidConfigError extends ApiError {
   constructor(message?: string, context?: Record<string, any>) {
     super('INVALID_CONFIG', message, context);
   }
 }
 
+registerErrorMessageContext('INVALID_CONFIG', InvalidConfigError);
+
 /**
  * Explicit failure to connect with remote client services.
  */
@@ -76,6 +55,8 @@ export class RemoteServiceConnectionError extends ApiError {
   }
 }
 
+registerErrorMessageContext('REMOTE_SERVICE_CONNECTION_ERROR', RemoteServiceConnectionError);
+
 /**
  * Failed to open a connection to remote client services.
  */
@@ -85,42 +66,56 @@ export class RemoteServiceConnectionTimeout extends ApiError {
   }
 }
 
+registerErrorMessageContext('REMOTE_SERVICE_CONNECTION_TIMEOUT', RemoteServiceConnectionTimeout);
+
 export class DataCorruptionError extends SystemError {
   constructor(message?: string, context?: Record<string, any>) {
     super('DATA_CORRUPTION', message, context);
   }
 }
 
+registerErrorMessageContext('DATA_CORRUPTION', DataCorruptionError);
+
 export class InvalidInvitationExtensionRoleError extends SystemError {
   constructor(message?: string, context?: Record<string, any>) {
     super('INVALID_INVITATION_EXTENSION_ROLE', message, context);
   }
 }
 
+registerErrorMessageContext('INVALID_INVITATION_EXTENSION_ROLE', InvalidInvitationExtensionRoleError);
+
 export class IdentityNotInitializedError extends DatabaseError {
   constructor(message?: string, context?: Record<string, any>) {
     super('IDENTITY_NOT_INITIALIZED', message, context);
   }
 }
 
+registerErrorMessageContext('IDENTITY_NOT_INITIALIZED', IdentityNotInitializedError);
+
 export class InvalidInvitationError extends DatabaseError {
   constructor(message?: string, context?: Record<string, any>) {
     super('INVALID_INVITATION', message, context);
   }
 }
 
+registerErrorMessageContext('INVALID_INVITATION', InvalidInvitationError);
+
 export class ConnectionResetError extends BaseError {
   constructor(message?: string, context?: any) {
     super('CONNECTION_RESET', message, context);
   }
 }
 
+registerErrorMessageContext('CONNECTION_RESET', ConnectionResetError);
+
 export class TimeoutError extends BaseError {
   constructor(message?: string, context?: any) {
     super('TIMEOUT', message, context);
   }
 }
 
+registerErrorMessageContext('TIMEOUT', TimeoutError);
+
 // General protocol error.
 export class ProtocolError extends BaseError {
   constructor(message?: string, context?: any) {
@@ -128,6 +123,8 @@ export class ProtocolError extends BaseError {
   }
 }
 
+registerErrorMessageContext('PROTOCOL_ERROR', ProtocolError);
+
 // General connectivity errors.
 export class ConnectivityError extends BaseError {
   constructor(message?: string, context?: any) {
@@ -135,32 +132,53 @@ export class ConnectivityError extends BaseError {
   }
 }
 
+registerErrorMessageContext('CONNECTIVITY_ERROR', ConnectivityError);
+
 // TODO(nf): Rename? the protocol isn't what's unknown...
 export class UnknownProtocolError extends BaseError {
   constructor(message?: string, innerError?: Error) {
     super('UNKNOWN_PROTOCOL_ERROR', message, innerError);
   }
 }
+
+registerErrorMessageContext('UNKNOWN_PROTOCOL_ERROR', UnknownProtocolError);
+
 export class InvalidStorageVersionError extends DatabaseError {
   constructor(expected: number, actual: number) {
     super('INVALID_STORAGE_VERSION', 'Invalid storage version.', { expected, actual });
   }
 }
 
+registerError('INVALID_STORAGE_VERSION', (_, context) => {
+  return new InvalidStorageVersionError(context.expected ?? NaN, context.actual ?? NaN);
+});
+
 export class SpaceNotFoundError extends DatabaseError {
   constructor(spaceKey: PublicKey) {
     super('SPACE_NOT_FOUND', 'Space not found.', { spaceKey });
   }
 }
 
+registerError('SPACE_NOT_FOUND', (_, context) => {
+  return new SpaceNotFoundError(PublicKey.safeFrom(context.spaceKey) ?? PublicKey.from('00'));
+});
+
 export class EntityNotFoundError extends DatabaseError {
   constructor(entityId: ItemID) {
     super('ITEM_NOT_FOUND', 'Item not found.', { entityId });
   }
 }
 
+registerError('ITEM_NOT_FOUND', (_, context) => {
+  return new EntityNotFoundError(context.entityId);
+});
+
 export class UnknownModelError extends DatabaseError {
   constructor(model: string) {
     super('UNKNOWN_MODEL', 'Unknown model.', { model });
   }
 }
+
+registerError('UNKNOWN_MODEL', (_, context) => {
+  return new UnknownModelError(context.model);
+});

package/src/errors/helpers.ts

@@ -3,30 +3,8 @@
 //
 
 import { invariant } from '@dxos/invariant';
-import { PublicKey } from '@dxos/keys';
 
-import {
-  CancelledError,
-  ConnectionResetError,
-  ConnectivityError,
-  DataCorruptionError,
-  EntityNotFoundError,
-  IdentityNotInitializedError,
-  InvalidConfigError,
-  InvalidInvitationError,
-  InvalidInvitationExtensionRoleError,
-  InvalidStorageVersionError,
-  ProtocolError,
-  RemoteServiceConnectionError,
-  RemoteServiceConnectionTimeout,
-  RpcClosedError,
-  RpcNotOpenError,
-  SpaceNotFoundError,
-  SystemError,
-  TimeoutError,
-  UnknownModelError,
-  UnknownProtocolError,
-} from './errors';
+import { SystemError } from './base-errors';
 import { Error as SerializedErrorProto } from '../proto/gen/dxos/error';
 
 export const reconstructError = (error: SerializedErrorProto) => {
@@ -34,80 +12,28 @@ export const reconstructError = (error: SerializedErrorProto) => {
   return errorFromCode(name, message, context);
 };
 
-export const errorFromCode = (code?: string, message?: string, context?: any) => {
-  switch (code) {
-    case 'RPC_CLOSED':
-      return new RpcClosedError();
-
-    case 'RPC_NOT_OPEN':
-      return new RpcNotOpenError();
-
-    case 'CANCELLED':
-      return new CancelledError(message, context);
-
-    case 'INVALID_CONFIG':
-      return new InvalidConfigError(message, context);
-
-    case 'REMOTE_SERVICE_CONNECTION_ERROR':
-      return new RemoteServiceConnectionError(message, context);
-
-    case 'REMOTE_SERVICE_CONNECTION_TIMEOUT':
-      return new RemoteServiceConnectionTimeout(message, context);
-
-    case 'DATA_CORRUPTION':
-      return new DataCorruptionError(message, context);
-
-    case 'INVALID_INVITATION_EXTENSION_ROLE':
-      return new InvalidInvitationExtensionRoleError(message, context);
-
-    case 'CONNECTION_RESET':
-      return new ConnectionResetError(message, context);
-
-    case 'TIMEOUT':
-      return new TimeoutError(message, context);
+const errorRegistry = new Map<string, (message?: string, context?: any) => Error>();
 
-    case 'PROTOCOL_ERROR':
-      return new ProtocolError(message, context);
-
-    case 'CONNECTIVITY_ERROR':
-      return new ConnectivityError(message, context);
-
-    case 'UNKNOWN_PROTOCOL_ERROR':
-      return new UnknownProtocolError(message, context);
-
-    case 'IDENTITY_NOT_INITIALIZED':
-      return new IdentityNotInitializedError(message, context);
-
-    case 'INVALID_INVITATION':
-      return new InvalidInvitationError(message, context);
-
-    case 'INVALID_STORAGE_VERSION': {
-      const { expected, actual } = context;
-      invariant(expected);
-      invariant(actual);
-      return new InvalidStorageVersionError(expected, actual);
-    }
-
-    case 'SPACE_NOT_FOUND': {
-      const { spaceKey: key } = context;
-      const spaceKey = PublicKey.safeFrom(key);
-      invariant(spaceKey);
-      return new SpaceNotFoundError(spaceKey);
-    }
+export const registerError = (code: string, make: (message?: string, context?: any) => Error) => {
+  invariant(!errorRegistry.has(code), `Error code already registered: ${code}`);
+  errorRegistry.set(code, make);
+};
 
-    case 'ITEM_NOT_FOUND': {
-      const { entityId } = context;
-      invariant(typeof entityId === 'string');
-      return new EntityNotFoundError(entityId);
-    }
+export const registerErrorNoArgs = (code: string, Constructor: { new (): Error }) => {
+  registerError(code, () => new Constructor());
+};
 
-    case 'UNKNOWN_MODEL': {
-      const { model } = context;
-      invariant(typeof model === 'string');
-      return new UnknownModelError(model);
-    }
+export const registerErrorMessageContext = (
+  code: string,
+  Constructor: { new (message?: string, context?: any): Error },
+) => {
+  registerError(code, (message?: string, context?: string) => new Constructor(message, context));
+};
 
-    default:
-      return new SystemError(code ?? 'Error', message, context);
+export const errorFromCode = (code?: string, message?: string, context?: any) => {
+  if (code && errorRegistry.has(code)) {
+    return errorRegistry.get(code)!(message, context);
+  } else {
+    return new SystemError(code ?? 'Error', message, context);
   }
 };

package/src/errors/index.ts

@@ -5,3 +5,4 @@
 export * from './encoding';
 export * from './errors';
 export * from './helpers';
+export * from './base-errors';

package/src/proto/dxos/error.proto

@@ -10,6 +10,7 @@ option go_package = "github.com/dxos/kube/proto/def/dxos/error";
 
 /// Serialized error.
 message Error {
+  /// Also error code. Will be used to reconstruct a known error type.
   optional string name = 1;
   optional string message = 2;
   optional google.protobuf.Struct context = 4;

package/src/proto/gen/dxos/error.ts

@@ -61,6 +61,8 @@ import * as google_protobuf from "../google/protobuf";
  */
 export interface Error {
     /**
+     * Also error code. Will be used to reconstruct a known error type.
+     *
      * Options:
      *   - proto3_optional = true
      */