Azure / Azure/data-api-builder
[Bug]: `StoredProcedureBuilderTests` assume locale of en-US, and may cause problems with how we handle `DateTime` in stored procedure parameters
- Lingua principale
- C#
- Stelle
- 1.5k
- Fork
- 370
- Merge medio
- 3g 22h
- PR unite (30g)
- 9
Descrizione
### What happened?
I was running the test suite of `StoredProcedure_ParameterValueTypeResolution` and had the three `DateTime`/`DateTimeOffset` tests:
https://github.com/Azure/data-api-builder/blob/main/src/Service.Tests/GraphQLBuilder/Sql/StoredProcedureBuilderTests.cs#L53-L55
The error is that it failed to parse the default value:
```
Assert.IsTrue failed. Failure: Did not expect error during stored procedure field creation: The parameter value 11/19/2012 10:57:11 AM -08:00 provided in configuration cannot be converted to the type DateTime
```
The reason this fails is that my machine locale is `en-AU`, whereas the date format in the test is `en-US` (denoted by `MM/dd`). As a result, these tests will _never_ pass on my machine because of the locale set, unless I change my machine locale.
While failing unit tests is an annoyance, it's survivable as they pass on the build server, it highlights a potentially larger problem in a production environment - **`DateTime` stored procedure params may fail due to locale assumptions.**
We should probably clearly document that the default value should be in the same format as the locale of the DAB host (which is more difficult to know in the SWA hosted version) or state that we only support a known format, such as ISO 8601, and update the parser to have that explicitly set.
### Version
N/A
### What database are you using?
Azure SQL
### What hosting model are you using?
Local (including CLI)
### Which API approach are you accessing DAB through?
GraphQL
### Relevant log output
_No response_
### Code of Conduct
- [X] I agree to follow this project's Code of Conduct
Guida per i contributori
Apri la guida per i contributori
Direzione di ricerca
Inizia da src/Service.Tests/GraphQLBuilder/Sql/StoredProcedureBuilderTests.cs, in particolare dalle righe 53-55 e dai test StoredProcedure_ParameterValueTypeResolution; riproduci il fallimento con una locale diversa da en-US. Traccia quindi il parser dei valori predefiniti dei parametri delle stored procedure, stabilisci il formato di data supportato, documentalo e assicurati che i test abbiano esito positivo indipendentemente dalla locale dell'host.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- azure, csharp, graphql, sql
- Ambito
- api, databases, testing
- Tipo di issue
- Bug
- Difficoltà
- 4/5
- Tempo stimato
- 3-5 giorni
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 35/100