hasura / hasura/graphql-engine

Cron triggers include the comment when calling the endpoint everytime in the body

Open
#9,851 0 comments 2 reactions 0 assignees View on GitHub
k/enhancement t/gql-services
Dominant language
TypeScript
Stars
32.1k
Forks
3k
PR merge metrics
PR metrics pending

Description

### Is your proposal related to a problem?

When using the cron trigger, the comment for the cron trigger is sent along with every call to the spcified endpoint.

```json
{
"comment":"This endpoint executes bulk update operation which sets all locations to latitude=null, longitude=null for all person_locations with old phonestatuses",
"id":"7b37cc64-4b61-1bca-ba09-1f4864bd2ce3",
"name":"ResetOutdatedLocations",
"payload":{},
"scheduled_time":"2023-08-24T15:39:00Z"
}
```

This causes unnecessary datatransfers going out from hasura nad coming into the service handling the requests

### Describe the solution you'd like

Optionally opt in or allow skipping sending the comment with the call

### Describe alternatives you've considered

No alternatives, as otherwise we have to stop documenting the cron triggers

Contributor guide

Open the contributing guide

Research direction

Start by tracing the cron trigger path that constructs the request sent to the specified endpoint and compare the documented trigger comment with the emitted JSON. Define the opt-in or skip behavior for the comment, then verify that the endpoint body omits it when skipping is selected while the other trigger fields remain available.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
api, backend
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.