aleios-cloud / aleios-cloud/sls-test-tools

getEvents method name unclear

Abierto
#15 0 comentarios 1 reacción 0 asignados Ver en GitHub
Lenguaje dominante
TypeScript
Estrellas
195
Forks
20
Métricas de merge de PR
Sin PR fusionados en 30 d

Descripción

Hi :)

I have used the lib in a use case when several events are sent to EventBridge, I thought that the getEvents method would fetch them all (until the queue was empty). But instead, it only fetched the messages one by one. This was quite confusing since the plural in the name of the method lead me to think it would fetch all the events fired so far. This confusion caused many failure in my test suite, which were difficult to debug.

So, in the end, I implemented a method like so to fetch all events in one function call:

```typescript
static async getAllEventBridgeMessages(): Promise {
if (EventBridgeTestUtil.eventBridge === null) {
throw new Error("EventBridgeTestUtil has not been setup");
}

let result: EventBridgeMessage[] = [];
let lastResults: EventBridgeMessage[] = [];

do {
try {
const events = await EventBridgeTestUtil.eventBridge.getEvents();
lastResults = events.Messages;
result = [...result, ...lastResults];
} catch (e) {
lastResults = [];
}
} while (lastResults.length !== 0);

return result;
}
```

It would be great if `getEvents` could be renamed to be clearer, such as `getEvent` and if a method `getAllEvents` could be implemented :)

Thanks ;)

Guía de contribución

No hay ninguna guía de contribución indexada para este repositorio

Evaluación

Este issue todavía no se ha evaluado.

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.