fix: Passthrough original error details from nitric plugin errors. (#207)

Author: tjholm

package.json

@@ -32,6 +32,7 @@
   ],
   "dependencies": {
     "@grpc/grpc-js": "1.8.1",
+    "@nitric/grpc-error-status": "^0.0.2",
     "@opentelemetry/api": "^1.4.1",
     "@opentelemetry/exporter-trace-otlp-http": "^0.36.1",
     "@opentelemetry/instrumentation": "^0.36.1",

src/api/documents/v0/collection-group-ref.ts

@@ -50,7 +50,7 @@ export class CollectionGroupRef<T extends DocumentStructure> {
     name: string
   ): CollectionGroupRef<T> {
     if (this.depth() >= MAX_COLLECTION_DEPTH) {
-      throw new InvalidArgumentError(
+      throw new Error(
         `Maximum collection depth ${MAX_COLLECTION_DEPTH} exceeded`
       );
     }

src/api/documents/v0/document-ref.test.ts

@@ -176,7 +176,7 @@ describe('Document Ref Tests', () => {
       const testNestedAgain = () => nestedCollection.collection('nested-again');
 
       expect(testNestedAgain).toThrow(
-        new InvalidArgumentError('Maximum collection depth 1 exceeded')
+        new Error('Maximum collection depth 1 exceeded')
       );
     });
   });

src/api/documents/v0/document-ref.ts

@@ -143,7 +143,7 @@ export class DocumentRef<T extends DocumentStructure> {
     name: string
   ): CollectionRef<T> {
     if (this.depth() >= MAX_COLLECTION_DEPTH) {
-      throw new InvalidArgumentError(
+      throw new Error(
         `Maximum collection depth ${MAX_COLLECTION_DEPTH} exceeded`
       );
     }

src/api/documents/v0/query.test.ts

@@ -200,8 +200,8 @@ describe('Query Tests', () => {
 
       q.pagingFrom('test' as any);
 
-      await expect(q.fetch()).rejects.toStrictEqual(
-        new InvalidArgumentError('Invalid paging token provided!')
+      await expect(q.fetch()).rejects.toEqual(
+        new Error('Invalid paging token provided!')
       );
     });
   });

src/api/documents/v0/query.ts

@@ -139,9 +139,7 @@ export class Query<T extends DocumentStructure> {
    */
   public limit(limit: number): Query<T> {
     if (typeof limit !== 'number' || limit < 0) {
-      throw new InvalidArgumentError(
-        'limit must be a positive integer or 0 for unlimited.'
-      );
+      throw new Error('limit must be a positive integer or 0 for unlimited.');
     }
 
     this.fetchLimit = limit;
@@ -160,7 +158,7 @@ export class Query<T extends DocumentStructure> {
 
     if (this.pagingToken != null) {
       if (!(this.pagingToken instanceof Map)) {
-        throw new InvalidArgumentError('Invalid paging token provided!');
+        throw new Error('Invalid paging token provided!');
       }
 
       const map = request.getPagingTokenMap();

src/api/errors/aborted.ts

@@ -11,15 +11,16 @@
 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 // See the License for the specific language governing permissions and
 // limitations under the License.
-
+import { ErrorDetails } from '@nitric/sdk/gen/proto/error/v1/error_pb';
+import { NitricPluginError } from './plugin-error';
 /**
  * AbortedError
  *
  * The operation was aborted
  */
-export class AbortedError extends Error {
-  constructor(message: string) {
-    super(message);
+export class AbortedError extends NitricPluginError {
+  constructor(message: string, details: ErrorDetails) {
+    super(message, details);
     Object.setPrototypeOf(this, AbortedError.prototype);
   }
 }

src/api/errors/already-exists.ts

@@ -12,14 +12,17 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
+import { ErrorDetails } from '@nitric/sdk/gen/proto/error/v1/error_pb';
+import { NitricPluginError } from './plugin-error';
+
 /**
  * AlreadyExistsError
  *
  * Client attempted to illegally create an entity that already exists
  */
-export class AlreadyExistsError extends Error {
-  constructor(message: string) {
-    super(message);
+export class AlreadyExistsError extends NitricPluginError {
+  constructor(message: string, details: ErrorDetails) {
+    super(message, details);
     Object.setPrototypeOf(this, AlreadyExistsError.prototype);
   }
 }

src/api/errors/cancelled.ts

@@ -12,14 +12,20 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
+import {
+  ErrorDetails,
+  ErrorScope,
+} from '@nitric/sdk/gen/proto/error/v1/error_pb';
+import { NitricPluginError } from './plugin-error';
+
 /**
  * CancelledError
  *
  * Operation was cancelled (typically occurs client side)
  */
-export class CancelledError extends Error {
-  constructor(message: string) {
-    super(message);
+export class CancelledError extends NitricPluginError {
+  constructor(message: string, details: ErrorDetails) {
+    super(message, details);
     Object.setPrototypeOf(this, CancelledError.prototype);
   }
 }

src/api/errors/data-loss.ts

@@ -12,14 +12,17 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
+import { ErrorDetails } from '@nitric/sdk/gen/proto/error/v1/error_pb';
+import { NitricPluginError } from './plugin-error';
+
 /**
  * DataLossError
  *
  * Unrecoverable data loss or corruption
  */
-export class DataLossError extends Error {
-  constructor(message: string) {
-    super(message);
+export class DataLossError extends NitricPluginError {
+  constructor(message: string, details: ErrorDetails) {
+    super(message, details);
     Object.setPrototypeOf(this, DataLossError.prototype);
   }
 }