How to resolve internal service error with cosmosDb Azure Function bindings when item is not found

Question

How to resolve internal service error with cosmosDb Azure Function bindings when item is not found

Brandon Wozniewicz 5

Following this tutorial, I receive an internal service error when the item is not found. My app's runtime is 4.x, and I've made sure to update the configuration as appropriate.
{
"name": "bookmark",
"databaseName": "func-io-learn-db",
"containerName": "Bookmarks",
"connection": "-------",
"id":"{id}",
"partitionKey": "{id}",
"direction": "in",
"type": "cosmosDB"
}

It works fine if the item exists, but if the item does not, an internal service error is thrown, not even allowing my custom function to return a more graceful error. I've seen a number of issues on Github related to ensuring the partitionId and id values are {id}, which I have done. This issue can be found here: https://github.com/Azure/Azure-Functions/issues/1670.

Is the only solution to roll back to v2? I have a hard time believing 2 years later, this is still the solution.

Thanks for any help.

MuthuKumaranMurugaachari-MSFT 22,441 Reputation points Moderator

2023-08-17T13:04:12.7033333+00:00

Wozniewicz, Brandon R (FAA) Just a follow up to see if you still face any issues. If so, share the details requested below and would be happy to assist you in resolving it.
Daniel Gelencser 25 Reputation points

2024-01-15T10:58:43.7566667+00:00

I am experiencing the same issue. If Cosmos DB responds with a not found (404) error to the input binding of the function (Node.js), the whole function crashes and when using an HTTP trigger the HTTP response is internal severer error (500).

It seems like this has been a long running bug, is there any fix in sight for this?

Request: Screenshot 2024-01-15 at 12-05-05 Microsoft Azure.png Response & Logs: Screenshot 2024-01-15 at 12-01-33 Microsoft Azure.png Cosmos DB: Screenshot 2024-01-15 at 12-06-59 Microsoft Azure.png

4 answers

Your answer

MuthuKumaranMurugaachari-MSFT 22,441 Reputation points Moderator

2023-08-17T13:04:12.7033333+00:00

Wozniewicz, Brandon R (FAA) Just a follow up to see if you still face any issues. If so, share the details requested below and would be happy to assist you in resolving it.
Daniel Gelencser 25 Reputation points

2024-01-15T10:58:43.7566667+00:00

I am experiencing the same issue. If Cosmos DB responds with a not found (404) error to the input binding of the function (Node.js), the whole function crashes and when using an HTTP trigger the HTTP response is internal severer error (500).

It seems like this has been a long running bug, is there any fix in sight for this?

Request: Screenshot 2024-01-15 at 12-05-05 Microsoft Azure.png Response & Logs: Screenshot 2024-01-15 at 12-01-33 Microsoft Azure.png Cosmos DB: Screenshot 2024-01-15 at 12-06-59 Microsoft Azure.png

Answer 1

Basically the exercise assume that you are using a 3.x version of the extension bundle, however the default is 4.x. I am not sure why it is not yet working with the new version (4.x) yet as previous version (3.x) will be retired on August 31 2024 (https://learn.microsoft.com/en-us/azure/azure-functions/migrate-cosmos-db-version-3-version-4?tabs=isolated-process&pivots=programming-language-javascript).

Found the fix on 3rd party a forum post, with the following steps

After the HttpTrigger2 function is created open the function app.
Click on App Service Editor (and Open Editor)
Select host.json and change it to this:

{
  "version": "2.0",
  "extensionBundle": {
    "id": "Microsoft.Azure.Functions.ExtensionBundle",
    "version": "[3.*, 4.0.0)"
  }
}

Go back to the function app overview and restart the app.

After these steps you should be able to continue with the exercise (as of 16 January 2023).

humaira siddiqui 0 Reputation points

2024-02-03T19:37:32.7366667+00:00

Please guide where to find App service editor on Azure portal and host.josn, I am struggling with this problem.

Answer 2

related your trainings the azure functions don't behave as expected : https://learn.microsoft.com/en-us/training/modules/chain-azure-functions-data-using-bindings/5-read-data-with-input-bindings-portal-lab?pivots=javascript

I have Runtime Version ~4 and can not select another value. There are two issues here:
1. When using an inputBinding with AzureCosmosDB NOSQL and the value is not present into the database the function will give an abort and put in the log and error 404 not found but for the HTTP response will raise a 500 Internal Server Error
2. connecting to AzureCosmos using input/output Binding is not correct using the portal way of configuring the bindings (connection and containerName should be present)

For the point 1:
"2023-10-03T08:14:18.646 [Error] Executed 'Functions.myHttpTrigger2' (Failed, Id=75ef38cf-d474-41fa-bfab-24f407afbb08, Duration=105ms)Response status code does not indicate success: NotFound (404); Substatus: 0; ActivityId: 0d09d743-fd0d-40a0-bebf-dcfbbae0402e; Reason: (code : NotFoundmessage : Entity with the specified id does not exist in the system. More info: https://aka.ms/cosmosdb-tsg-not-found,RequestStartTime: 2023-10-03T08:14:18.5698536Z,.........."
This is the message error when using in the input Json an "in" value that is not present into the AzureCosmosDB

For the point 2:
Instead of

{
      "name": "inputDocument",
      "direction": "in",
      "type": "cosmosDB",
      "connectionStringSetting": "myfirstazurecosmos_DOCUMENTDB",
      "databaseName": "inDatabase",
      "collectionName": "MyCollection",
      "partitionKey": "{id}"
    }

You need to have

{
      "name": "inputDocument",
      "direction": "in",
      "type": "cosmosDB",
      "connection": "myfirstazurecosmos_DOCUMENTDB",
      "databaseName": "inDatabase",
      "containerName": "MyCollection",
      "partitionKey": "{id}"
    }

Otherwise you get errors in the log and can not reach the cosmos DB

MuthuKumaranMurugaachari-MSFT 22,441 Reputation points Moderator

2023-10-03T13:23:51.94+00:00

Guta Daniel Thanks for sharing the feedback. Will pass the feedback to our doc team to update the tutorial.
José Luiz Marques Maciel 5 Reputation points

2023-12-16T09:03:34.75+00:00

very relevant, i`m facing the same issue right now.

is there any bypass?

Answer 3

MuthuKumaranMurugaachari-MSFT 22,441 Moderator

Wozniewicz, Brandon R (FAA) Thanks for posting your question in Microsoft Q&A. I followed the tutorial and got 404 NotFound error when item doesn't exist (unable to reproduce the error).

Output:
2023-08-15T15:26:38.034 [Information] Executing 'Functions.HttpTrigger1' (Reason='This function was programmatically called via the host APIs.', Id=66e1b5f5-3e19-400d-9de7-e059be8b84ac)

2023-08-15T15:26:38.116 [Error] Executed 'Functions.HttpTrigger1' (Failed, Id=66e1b5f5-3e19-400d-9de7-e059be8b84ac, Duration=55ms)Response status code does not indicate success: NotFound (404); Substatus: 0; ActivityId: 7226f6b7-7883-45c1-b6c2-e9e673eab163; Reason: (code : NotFoundmessage : Entity with the specified id does not exist in the system. More info: https://aka.ms/cosmosdb-tsg-not-found,RequestStartTime: 2023-08-15T15:26:38.0563586Z, RequestEndTime: 2023-08-15T15:26:38.0807738Z, Number of regions attempted:1{"systemHistory":[{"dateUtc":"2023-08-15T15:25:39.3398045Z","cpu":0.670,"memory":472870132.000,"threadInfo":

function.json

{
      "name": "bookmark",
      "direction": "in",
      "type": "cosmosDB",
      "connection": "<db name>",
      "databaseName": "func-io-learn-db",
      "containerName": "Bookmarks",
      "id": "{id}",
      "partitionKey": "{id}"
    }

If you still face internal server error, please share the code snippet, function.json, request url/activity id and the output of the error message. That would help in investigating the backend logs and find the cause.

If you found the answer to your question helpful, please take a moment to mark it as "Yes" for others to benefit from your experience. Or simply add a comment tagging me and would be happy to answer your questions.

Patrick Espinosa 5

Hi MuthuKumaranMurugaachari-MSFT, that's precisely the problem with the exercise, that the error thrown by Cosmos DB is causing the Function to return a 500 Internal Server error instead of letting the Function process the error and return a 404 http response with the following code:

module.exports = function (context, req) {

    var bookmark = context.bindings.bookmark

    if(bookmark){
        context.res = {
        body: { "url": bookmark.url },
        headers: {
            'Content-Type': 'application/json'
        }
        };
    }
    else {
        context.res = {
            status: 404,
            body : "No bookmarks found",
            headers: {
            'Content-Type': 'application/json'
            }
        };
    }

    context.done();
};

MuthuKumaranMurugaachari-MSFT 22,441 Reputation points Moderator

2023-09-11T13:17:46.27+00:00

Wozniewicz, Brandon R (FAA) In my case, the function successfully returned 404 NotFound as expected when I used the same code snippet with the latest function runtime. Sorry I couldn't understand which error was thrown by Cosmos DB in your scenario causing InternalServer error.

We may have to review your function app, cosmos DB logs to find the cause and suggest you open a support ticket to our azure support team. If you don't have a support plan and need assistance, let me know.

datagobes 5

I am running into the exact same problem. I had just updated the extension bundle to 4.x to allow for managed identity connection with cosmos and I also have graceful handling of documents not found in my function code (Python) but my code never runs because it already returns internal server error when the document does not exist.

Host.json:

{
  "version": "2.0",
  "logging": {
    "applicationInsights": {
      "samplingSettings": {
        "isEnabled": true,
        "excludedTypes": "Request"
      }
    }
  },
  "extensionBundle": {
    "id": "Microsoft.Azure.Functions.ExtensionBundle",
    "version": "[4.*, 5.0.0)"
  }
}

function code:

import logging
import azure.functions as func
import json

def main(req: func.HttpRequest, retrievedocument: func.DocumentList) -> str:
    """
    Azure Function entry point.

    Parameters:
        req (func.HttpRequest): The HTTP request object.
        retrievedocument (func.DocumentList): A list of documents retrieved from Cosmos DB.

    Returns:
        str: JSON representation of the retrieved document if it exists, otherwise an error message.
    """

    # Log that the function is processing a request
    logging.info('Python HTTP trigger function processed a request.')

    if not retrievedocument:
        # Log a warning if the document list is empty
        logging.warning("Entry does not exist in Cosmos DB.")
        return func.HttpResponse(json.dumps({"ERROR": "Entry does not exist"}),status_code=404,mimetype="application/json") 
    
    else:
        # Log that the function successfully retrieved a document from Cosmos DB
        logging.info('Python HTTP trigger function retrieved document from Cosmos DB.')
        return func.HttpResponse(retrievedocument[0].to_json())

function.json:

{
  "bindings": [
    {
      "authLevel": "admin",
      "name": "req",
      "type": "httpTrigger",
      "direction": "in",
      "methods": [
        "get",
        "post"
      ]
    },
    {
      "name": "$return",
      "type": "http",
      "direction": "out"
    },
    {
      "type": "cosmosDB",
      "name": "retrievedocument",
      "databaseName": "SST",
      "containerName": "Items",
      "connection": "CosmosDbConnectionString",
      "direction": "in",
      "Id": "{Query.id}",
      "PartitionKey": "{Query.id}"
    }
  ],
  "scriptFile": "__init__.py"
}

MuthuKumaranMurugaachari-MSFT 22,441 Reputation points Moderator

2023-09-19T14:33:22.51+00:00

datagobes Has the same issue occurred in your local environment or after deploying to Azure? Also, can you share info such as sample request URL path (removing host name), request body/query parameters? That would help in reproducing the issue.
datagobes 5 Reputation points

2023-10-09T14:08:23.55+00:00

The issue occurs in Azure, honestly I did not test it running locally.

So sample request path would be like

/retrieve_document?id=12345

If a document with the passed id does not exist function will not run and return 500, and error will be logged from the cosmos binding NotFound (404). But in previous extension version my function would in fact run but with an empty document object passed to the python code in which case we could write code handling the case of the passed id not being in the cosmos collection.
MuthuKumaranMurugaachari-MSFT 22,441 Reputation points Moderator

2023-10-09T15:39:59.3833333+00:00

datagobes Thanks for getting back to me. Will review and update accordingly.
Dan Mo 0 Reputation points

2024-02-02T14:32:12.61+00:00

still having the same issue to date

Answer 4

humaira siddiqui 0

I am also facing the same issue.. I have added logs to trace the cause - the function is not going in else statement, it seems the exception is raised from cosmos db. Not able to figure out a solution. Any help is appreciated User's image

Share via

How to resolve internal service error with cosmosDb Azure Function bindings when item is not found

4 answers

Your answer