Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -12,5 +12,6 @@ __debug*
!deploy/charts/firefly
containerlogs
.vscode/*.log
.idea
doc-site/site
.idea/
doc-site/site
*.iml
1 change: 1 addition & 0 deletions .golangci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ linters-settings:
values:
regexp:
COMPANY: .*
YEAR: '\d\d\d\d(-\d\d\d\d)?'
template: |-
Copyright © {{ YEAR }} {{ COMPANY }}

Expand Down
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ GOGC=30

all: build test go-mod-tidy
test: deps lint
$(VGO) test ./internal/... ./pkg/... ./cmd/... ./doc-site ./ffconfig/... -cover -coverprofile=coverage.txt -covermode=atomic -timeout=30s ${TEST_ARGS}
$(VGO) test ./internal/... ./pkg/... ./cmd/... ./doc-site ./ffconfig/... -cover -coverprofile=coverage.txt -covermode=atomic -timeout=45s ${TEST_ARGS}
coverage.html:
$(VGO) tool cover -html=coverage.txt
coverage: test coverage.html
Expand Down
2 changes: 1 addition & 1 deletion doc-site/docs/reference/types/subscription.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ title: Subscription
| Field Name | Description | Type |
|------------|-------------|------|
| `firstEvent` | Whether your application would like to receive events from the 'oldest' event emitted by your FireFly node (from the beginning of time), or the 'newest' event (from now), or a specific event sequence. Default is 'newest' | `SubOptsFirstEvent` |
| `readAhead` | The number of events to stream ahead to your application, while waiting for confirmation of consumption of those events. At least once delivery semantics are used in FireFly, so if your application crashes/reconnects this is the maximum number of events you would expect to be redelivered after it restarts | `uint16` |
| `readAhead` | The number of events to stream ahead to your application, while waiting for confirmation of consumption of those events. At least once delivery semantics are used in FireFly, so if your application crashes/reconnects this is the maximum number of events you would expect to be redelivered after it restarts | `uint` |
| `withData` | Whether message events delivered over the subscription, should be packaged with the full data of those messages in-line as part of the event JSON payload. Or if the application should make separate REST calls to download that data. May not be supported on some transports. | `bool` |
| `batch` | Events are delivered in batches in an ordered array. The batch size is capped to the readAhead limit. The event payload is always an array even if there is a single event in the batch, allowing client-side optimizations when processing the events in a group. Available for both Webhooks and WebSockets. | `bool` |
| `batchTimeout` | When batching is enabled, the optional timeout to send events even when the batch hasn't filled. | `string` |
Expand Down
2 changes: 1 addition & 1 deletion doc-site/docs/reference/types/wsstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ title: WSStart
| Field Name | Description | Type |
|------------|-------------|------|
| `firstEvent` | Whether your application would like to receive events from the 'oldest' event emitted by your FireFly node (from the beginning of time), or the 'newest' event (from now), or a specific event sequence. Default is 'newest' | `SubOptsFirstEvent` |
| `readAhead` | The number of events to stream ahead to your application, while waiting for confirmation of consumption of those events. At least once delivery semantics are used in FireFly, so if your application crashes/reconnects this is the maximum number of events you would expect to be redelivered after it restarts | `uint16` |
| `readAhead` | The number of events to stream ahead to your application, while waiting for confirmation of consumption of those events. At least once delivery semantics are used in FireFly, so if your application crashes/reconnects this is the maximum number of events you would expect to be redelivered after it restarts | `uint` |
| `withData` | Whether message events delivered over the subscription, should be packaged with the full data of those messages in-line as part of the event JSON payload. Or if the application should make separate REST calls to download that data. May not be supported on some transports. | `bool` |
| `batch` | Events are delivered in batches in an ordered array. The batch size is capped to the readAhead limit. The event payload is always an array even if there is a single event in the batch, allowing client-side optimizations when processing the events in a group. Available for both Webhooks and WebSockets. | `bool` |
| `batchTimeout` | When batching is enabled, the optional timeout to send events even when the batch hasn't filled. | `string` |
Expand Down
12 changes: 0 additions & 12 deletions doc-site/docs/swagger/swagger.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -29287,7 +29287,6 @@ paths:
used in FireFly, so if your application crashes/reconnects
this is the maximum number of events you would expect
to be redelivered after it restarts
maximum: 65535
minimum: 0
type: integer
reply:
Expand Down Expand Up @@ -29572,7 +29571,6 @@ paths:
At least once delivery semantics are used in FireFly, so if
your application crashes/reconnects this is the maximum number
of events you would expect to be redelivered after it restarts
maximum: 65535
minimum: 0
type: integer
reply:
Expand Down Expand Up @@ -29846,7 +29844,6 @@ paths:
in FireFly, so if your application crashes/reconnects this
is the maximum number of events you would expect to be redelivered
after it restarts
maximum: 65535
minimum: 0
type: integer
reply:
Expand Down Expand Up @@ -30128,7 +30125,6 @@ paths:
At least once delivery semantics are used in FireFly, so if
your application crashes/reconnects this is the maximum number
of events you would expect to be redelivered after it restarts
maximum: 65535
minimum: 0
type: integer
reply:
Expand Down Expand Up @@ -30402,7 +30398,6 @@ paths:
in FireFly, so if your application crashes/reconnects this
is the maximum number of events you would expect to be redelivered
after it restarts
maximum: 65535
minimum: 0
type: integer
reply:
Expand Down Expand Up @@ -30750,7 +30745,6 @@ paths:
in FireFly, so if your application crashes/reconnects this
is the maximum number of events you would expect to be redelivered
after it restarts
maximum: 65535
minimum: 0
type: integer
reply:
Expand Down Expand Up @@ -38574,7 +38568,6 @@ paths:
used in FireFly, so if your application crashes/reconnects
this is the maximum number of events you would expect
to be redelivered after it restarts
maximum: 65535
minimum: 0
type: integer
reply:
Expand Down Expand Up @@ -38852,7 +38845,6 @@ paths:
At least once delivery semantics are used in FireFly, so if
your application crashes/reconnects this is the maximum number
of events you would expect to be redelivered after it restarts
maximum: 65535
minimum: 0
type: integer
reply:
Expand Down Expand Up @@ -39126,7 +39118,6 @@ paths:
in FireFly, so if your application crashes/reconnects this
is the maximum number of events you would expect to be redelivered
after it restarts
maximum: 65535
minimum: 0
type: integer
reply:
Expand Down Expand Up @@ -39401,7 +39392,6 @@ paths:
At least once delivery semantics are used in FireFly, so if
your application crashes/reconnects this is the maximum number
of events you would expect to be redelivered after it restarts
maximum: 65535
minimum: 0
type: integer
reply:
Expand Down Expand Up @@ -39675,7 +39665,6 @@ paths:
in FireFly, so if your application crashes/reconnects this
is the maximum number of events you would expect to be redelivered
after it restarts
maximum: 65535
minimum: 0
type: integer
reply:
Expand Down Expand Up @@ -40009,7 +39998,6 @@ paths:
in FireFly, so if your application crashes/reconnects this
is the maximum number of events you would expect to be redelivered
after it restarts
maximum: 65535
minimum: 0
type: integer
reply:
Expand Down
Loading