Refreshes do not trigger sync notifications
- Linguagem predominante
- Python
- Estrelas
- 22.1k
- Forks
- 5.4k
- Merge médio
- 5h
- PRs com merge (30d)
- 671
Descrição
### Topic
Refresh syncs do not trigger the execution of sync notifications, such as Successful Sync, Failed Sync
### Relevant information
## Platform Version
* Edition: community
* Version: Observed on 1.0.0, reproduced through 2.2
* Deployment: GKE, local abctl
## Description
Triggering a [Refresh Sync](https://docs.airbyte.com/platform/operator-guides/refreshes) does not appear to execute any of the [webhook notifications associated with sync events](https://docs.airbyte.com/platform/cloud/managing-airbyte-cloud/manage-airbyte-cloud-notifications#events-airbyte-can-notify-you-about).
This is surprising because my impression from the documentation is that refresh syncs are considered to be syncs, and I'd expect to be able to notify on their success/failure (since they have similar effects - changes in the synced data).
The code in `JobCreationAndStatusUpdateHelper.kt` defines [`val SYNC_CONFIG_SET: Set = setOf(ConfigType.SYNC, ConfigType.REFRESH)`](https://github.com/airbytehq/airbyte-platform/blob/dcaef5c05a1dfd5e90d3ebbce9a397c29290cd25/airbyte-commons-server/src/main/kotlin/io/airbyte/commons/server/handlers/helpers/JobCreationAndStatusUpdateHelper.kt#L590), which seems in line with the documentation. The `JobsHandler` class though [conditions sync notification execution on `ConfigType.SYNC` rather than `SYNC_CONFIG_SET`](https://github.com/airbytehq/airbyte-platform/blob/dcaef5c05a1dfd5e90d3ebbce9a397c29290cd25/airbyte-commons-server/src/main/kotlin/io/airbyte/commons/server/handlers/JobsHandler.kt#L201-L203), meaning `ConfigType.REFRESH` do not emit notifications.
## Steps to reproduce
1. Have a connection that supports [Refresh Syncs](https://docs.airbyte.com/platform/operator-guides/refreshes)
2. Configure and enable webhooks for Successful sync, Failed sync per https://docs.airbyte.com/platform/cloud/managing-airbyte-cloud/manage-airbyte-cloud-notifications#set-up-webhook-notifications
3. Sync the connection - observe notifications trigger.
4. Refresh the connections - no notifications trigger.
---
**Internal Tracking:** https://github.com/airbytehq/oncall/issues/13311
Guia de contribuição
Direção de pesquisa
Start with JobsHandler.kt around the notification condition cited in the issue, then compare it with SYNC_CONFIG_SET in JobCreationAndStatusUpdateHelper.kt. Reproduce the successful and failed refresh-sync flows with webhooks enabled, and verify that refreshes trigger the same sync notifications while regular sync notifications remain unchanged.
Escrita pelo modelo de indexação a partir do texto da issue.
Avaliação
- Stack de tecnologia
- kotlin
- Domínio
- backend
- Tipo de issue
- Bug
- Dificuldade
- 3/5
- Tempo estimado
- 1-2 dias
- Status de atividade
- Pouca atividade
- Clareza
- Claramente especificada
- Facilidade para iniciantes
- 76/100