Leveraging Firestore Errors within Cloud Functions

Is it possible to utilize the FirestoreError class within Firebase cloud functions?

The goal is to raise errors with a FirestoreError type when a document or field is not found in Firestore:

throw new FirestoreError();

Upon importing FirestoreError using 

import { FirestoreError } from "firebase/firestore";
and attempting to throw a FirestoreError, an error stating that the constructor is private is encountered. Can a FirestoreError be thrown from a Firebase function, or is it necessary to use HttpsError instead?

Appreciate any insights.

typescriptfirebasegoogle-cloud-firestoregoogle-cloud-functionstype-safety

Answer №1

FirestoreError is described as an internal, technical issue.

If you wish to handle a more application-specific error, consider throwing an AppError instead of dealing with Firestore-related problems.

An appropriate way to do this is by using an HttpsError. This can be caught on the client side and checked for the specific your-app-error-id.

throw functions.https.HttpsError(
  'your-app-error-id',
  'Your custom message.'
);

Documentation

For effective error handling on the client side, make sure to throw errors from a callable function by utilizing functions.https.HttpsError.

If any other type of error is thrown from your functions, the client will receive an error labeled INTERNAL with the code internal.

https://firebase.google.com/docs/functions/callable#handle_errors

Example

if (!(typeof text === 'string') || text.length === 0) {
  // Throw an HttpsError to provide detailed error information to the client.
  throw new functions.https.HttpsError('invalid-argument', 'The function requires ' +
      'one argument "text" that contains the message text to add.');
}

Similar questions

If you have not found the answer to your question or you are interested in this topic, then look at other similar questions below or use the search

The process of saving array information in Firebase and the method for generating unique IDs

Within my firebase data, I have a group of objects each containing an array. When I initially create the object, I include the first element in the array using this code snippet: ref.child('items').set([{firstobject: id123}]) Initially, the ...

angularjsfirebase

Enhancing the loading speed of hefty Angular components

The issue I encountered involved a large component that loads over 1000 data elements, populated by a service called only once. Initially, the service was being called each time the component initialized, which seemed to be causing performance problems. To ...

angulartypescriptcomponents

Utilizing the axios create method: troubleshooting and best practices

I am attempting to use the axios library in my Next.js app (written in TypeScript) to access a public API for retrieving IP addresses from . In my index.ts file, I have the following code: import axios from "axios"; export const ipApi = axios.cr ...

typescriptnext.jsaxiosip

I love the idea of the music playing on as I navigate between pages or tabs. Such a cool feature with Next

I'm looking to implement a music player within my next.js application. How can I ensure that the currently playing track doesn't stop when switching between pages? Essentially, I want the music playback to continue seamlessly as users navigate th ...

javascriptreactjstypescriptnext.jsfrontend

HTML template failing to retrieve data from Angular dataSource

My goal is to import data from an Excel file into my angular application. I have successfully retrieved the data from the Excel file, parsed it to extract the necessary columns, and stored it in an array within my service.ts file. I call the service from ...

angulartypescript

Accepting undefined in rest parameter of typescript

I'm struggling with an exercise involving Function parameters: The maximum function below has the wrong type. To allow undefined in the rest arguments, you need to update the type of the rest parameter. Fortunately, you don't have to change the ...

typescript

The Angular checked functionality is not working as expected due to the presence of ngModel

Just getting started with Angular here. I’m working on a checkbox table that compares to another table and automatically checks if it exists. The functionality is all good, but as soon as I add ngModel to save the changes, the initial check seems to be ...

htmlcsstypescriptwebangularjs-digest

Tips for extracting key values from an array of objects in Typescript

I am working with an array called studyTypes: const studyTypes = [ { value: "ENG", label: "ENG-RU", }, { value: "RU", label: "RU-ENG", }, ]; Additionally, I have a state variable set ...

javascriptreactjstypescript

In a Next.js project, Typescript seems to be overlooking errors related to proptype definitions and function types

Greetings everyone! I am currently working on a project using TypeScript and have implemented various rules and elements. However, I am facing issues with type errors for functions and props. Essentially, when using any function, it is necessary to specify ...

javascriptreactjstypescriptnext.js

Assign an appropriate label to this sonarqube input field

Sonarqube flagged an issue with the following line of code: <div class="dropdown-language"> <label>{{'GENERALE.LINGUA' | translate }}</label> <select #langSelect (change)="translate.use(langSe ...

angulartypescriptsonarqube

Unable to store object data within an Angular component

This is a sample component class: export class AppComponent { categories = { country: [], author: [] } constructor(){} getOptions(options) { options.forEach(option => { const key = option.name; this.categories[k ...

javascriptangulartypescript

Step-by-step guide on inserting a variable into .doc() to create a new table

Recently, I created a SignIn page that uses variables to store data fetched with document.getElementByClassName. Now, I am facing an issue while trying to create a new document on Firebase using the person's name stored in a variable. Struggling with ...

javascriptnode.jsfirebasegoogle-cloud-firestore

include the ReactToastify.css file in your project using the import statement

Error in file path C:\Users\User\Documents\GitHub\zampliasurveys_frontend\node_modules\react-toastify\dist\ReactToastify.css:1 ({"Object.":function(module,exports,require,__dirname,__filename,jest){:ro ...

javascriptreactjstypescriptunit-testingjestjs

What is the best way to declare only a portion of a JavaScript module?

I'm having trouble understanding declarations. If I only need to declare a portion of a module, is this the correct way to do it (disregarding the use of 'any')? import { Method as JaysonMethod } from 'jayson/promise'; declare cla ...

typescript

The promise is unexpectedly fulfilled ahead of schedule without returning the expected value from an AXIOS call

My current challenge involves making a request to a service that rapidly generates multiple strings. The problem lies in returning a promise from this service, as I lack control over the string-generation process. It is crucial for me to return a promise ...

javascriptnode.jstypescriptpromiseaxios

Angular 6: The importance of access modifiers when injecting services

As I make my way through the tutorial, an interesting scenario has arisen. I've noticed that when injecting a service into my component without specifying an access modifier, it results in an error as shown below. However, adding either "private" or ...

angulartypescriptangular6

When attempting to utilize yarn link, I receive an error message indicating that the other folder is not recognized as a module

After successfully running "yarn link," I encountered an issue when attempting to use it in a different project. The error message displayed was ../../.tsx is not a module. What could be causing this problem? const App: React.FC = () => { const [op ...

javascriptreactjstypescriptyarnpkg

Extending an interface in TypeScript to include an Array

Can I implement a parent interface in Angular 4? export interface Devices extends Array<Device> { } The error 'Class 'DevicesModel' incorrectly implements interface 'Devices'. Property 'includes' is missing in typ ...

angulartypescriptswagger

What is the correct way to trigger an event specified as a string parameter in the emit() function?

My current goal is to pass the emit name as a string (for example, 'showComponent') from child to parent. I then want to trigger another emit in the emitAction(callbackName: string) function, and finally execute the showComponent() function. I&a ...

typescriptvue.jsvue-composition-apiemit

When there are multiple tabs open in the browser, I notice a difference in the time displayed. This occurs in an Angular 2 environment

https://i.sstatic.net/l4YQ1.pngAfter a successful login, I am fetching server time from the back-end (in Java) and adding 1 second at intervals. Observable.interval(1000).map(() => { return this.time.add(1, 'seconds'); }). ...

angulartypescriptangular2-routing