Update SDKs to ignore retry if set to default (#573)

* Update SDKs to ignore `retry` if set to default * Remove from test output * Build
starfederation · Feb 2, 2025 · ed980b3 · ed980b3
1 parent 854ce6e
commit ed980b3
Show file tree

Hide file tree

Showing 24 changed files with 82 additions and 60 deletions.
diff --git a/bundles/datastar-aliased.js b/bundles/datastar-aliased.js
diff --git a/bundles/datastar-aliased.js.map b/bundles/datastar-aliased.js.map
diff --git a/bundles/datastar.js b/bundles/datastar.js
diff --git a/bundles/datastar.js.map b/bundles/datastar.js.map
diff --git a/library/src/plugins/official/backend/actions/sse.ts b/library/src/plugins/official/backend/actions/sse.ts
@@ -2,7 +2,7 @@
 // Slug: Use a GET request to fetch data from a server using Server-Sent Events matching the Datastar SDK interface
 // Description: Remember, SSE is just a regular SSE request but with the ability to send 0-inf messages to the client.
 
-import { DATASTAR, DATASTAR_REQUEST } from '../../../../engine/consts'
+import { DATASTAR, DATASTAR_REQUEST, DefaultSseRetryDurationMs } from '../../../../engine/consts'
 import { runtimeErr } from '../../../../engine/errors'
 import type { RuntimeContext } from '../../../../engine/types'
 import {
@@ -75,7 +75,7 @@ export const sse = async (
       includeLocal: false,
       selector: null,
       openWhenHidden: false, // will keep the request open even if the document is hidden.
-      retryInterval: 1_000, // the retry interval in milliseconds
+      retryInterval: DefaultSseRetryDurationMs, // the retry interval in milliseconds
       retryScaler: 2, // the amount to multiply the retry interval by each time
       retryMaxWaitMs: 30_000, // the maximum retry interval in milliseconds
       retryMaxCount: 10, // the maximum number of retries before giving up

diff --git a/sdk/README.md b/sdk/README.md
@@ -11,18 +11,6 @@ Provide an SDK in a language agnostic way, to that end
 1. Keep SDK as minimal as possible
 2. Allow per language/framework extended features to live in an SDK ***sugar*** version
 
-### Status
-
-- [x] Create a document (this) to allow any one to make a spec compliant SDK for any language or framework
-- [x] Provide a [reference implementation](../sdk/go) in Go
-- [ ] Provide SDKs for
-  - [ ] JS/TS
-  - [x] PHP
-  - [x] .NET
-  - [x] Python
-  - [x] Java
-  - [ ] Haskell?
-
 ## Details
 
 ### Assumptions
@@ -84,12 +72,12 @@ Currently valid values are
 
 #### Logic
 When called the function ***must*** write to the response buffer the following in specified order.  If any part of this process fails you ***must*** return/throw an error depending on language norms.
-1. ***Must*** write `event: EVENT_TYPE\n` where `EVENT_TYPE` is [EventType](#EventType)
+1. ***Must*** write `event: EVENT_TYPE\n` where `EVENT_TYPE` is [EventType](#EventType).
 2. If a user defined event ID is provided, the function ***must*** write `id: EVENT_ID\n` where `EVENT_ID` is the event ID.
 3. ***Must*** write `retry: RETRY_DURATION\n` where `RETRY_DURATION` is the provided retry duration, ***unless*** the value is the default of `1000` milliseconds.
 4. For each string in the provided `dataLines`, you ***must*** write `data: DATA\n` where `DATA` is the provided string.
 5. ***Must*** write a `\n\n` to complete the event per the SSE spec.
-6. Afterward the writer ***should*** immediately flush.  This can be confounded by other middlewares such as compression layers
+6. Afterward the writer ***should*** immediately flush.  This can be confounded by other middlewares such as compression layers.
 
 ### `ServerSentEventGenerator.MergeFragments`
 
@@ -109,6 +97,16 @@ ServerSentEventGenerator.MergeFragments(
 
 #### Example Output
 
+Minimal:
+
+```
+event: datastar-merge-fragments
+data: fragments <div id="feed">
+data: fragments     <span>1</span>
+data: fragments </div>
+
+Maximal:
+
 ```
 event: datastar-merge-fragments
 id: 123
@@ -171,6 +169,15 @@ ServerSentEventGenerator.RemoveFragments(
 
 #### Example Output
 
+Minimal:
+
+```
+event: datastar-remove-fragments
+data: selector #target
+```
+
+Maximal:
+
 ```
 event: datastar-remove-fragments
 id: 123
@@ -213,6 +220,15 @@ ServerSentEventGenerator.MergeSignals(
 
 #### Example Output
 
+Minimal:
+
+```
+event: datastar-merge-signals
+data: signals {"output":"Patched Output Test","show":true,"input":"Test","user":{"name":"","email":""}}
+```
+
+Maximal:
+
 ```
 event: datastar-merge-signals
 id: 123
@@ -251,6 +267,16 @@ ServerSentEventGenerator.RemoveSignals(
 
 #### Example Output
 
+Minimal:
+
+```
+event: datastar-remove-signals
+data: paths user.name
+data: paths user.email
+```
+
+Maximal:
+
 ```
 event: datastar-remove-signals
 id: 123
@@ -286,6 +312,15 @@ ServerSentEventGenerator.ExecuteScript(
 
 #### Example Output
 
+Minimal:
+
+```
+event: datastar-execute-script
+data: script window.location = "https://data-star.dev"
+```
+
+Maximal:
+
 ```
 event: datastar-execute-script
 id: 123

diff --git a/sdk/go/consts.go b/sdk/go/consts.go
diff --git a/sdk/go/sse.go b/sdk/go/sse.go
@@ -126,7 +126,7 @@ func (sse *ServerSentEventGenerator) Send(eventType EventType, dataLines []strin
 	}
 
 	// write retry if needed
-	if evt.RetryDuration.Milliseconds() > 0 {
+	if evt.RetryDuration.Milliseconds() > 0 && evt.RetryDuration.Milliseconds() != DefaultSseRetryDuration.Milliseconds() {
 		retry := int(evt.RetryDuration.Milliseconds())
 		retryStr := strconv.Itoa(retry)
 		if err := errors.Join(

diff --git a/sdk/php/src/ServerSentEventGenerator.php b/sdk/php/src/ServerSentEventGenerator.php
@@ -170,7 +170,9 @@ protected function send(EventType $eventType, array $dataLines, array $options =
             $output[] = 'id: ' . $eventData->eventId;
         }
 
-        $output[] = 'retry: ' . $eventData->retryDuration;
+        if ($eventData->retryDuration !== Consts::DEFAULT_SSE_RETRY_DURATION) {
+            $output[] = 'retry: ' . $eventData->retryDuration;
+        }
 
         foreach ($eventData->data as $line) {
             $output[] = $line;

diff --git a/sdk/test/get-cases/executeScriptWithDefaults/output.txt b/sdk/test/get-cases/executeScriptWithDefaults/output.txt
@@ -1,5 +1,4 @@
 event: datastar-execute-script
-retry: 1000
 data: script console.log('hello');
 
 
diff --git a/sdk/test/get-cases/executeScriptWithMultilineScript/output.txt b/sdk/test/get-cases/executeScriptWithMultilineScript/output.txt
@@ -1,5 +1,4 @@
 event: datastar-execute-script
-retry: 1000
 data: script if (true) {
 data: script   console.log('hello');
 data: script }

diff --git a/sdk/test/get-cases/executeScriptWithoutDefaults/output.txt b/sdk/test/get-cases/executeScriptWithoutDefaults/output.txt
@@ -1,5 +1,4 @@
 event: datastar-execute-script
-retry: 1000
 data: script console.log('hello');
 
 
diff --git a/sdk/test/get-cases/mergeFragmentsWithDefaults/output.txt b/sdk/test/get-cases/mergeFragmentsWithDefaults/output.txt
@@ -1,5 +1,4 @@
 event: datastar-merge-fragments
-retry: 1000
 data: fragments <div>Merge</div>
 
 
diff --git a/sdk/test/get-cases/mergeFragmentsWithMultilineFragments/output.txt b/sdk/test/get-cases/mergeFragmentsWithMultilineFragments/output.txt
@@ -1,5 +1,4 @@
 event: datastar-merge-fragments
-retry: 1000
 data: fragments <div>
 data: fragments   <span>Merge</span>
 data: fragments </div>

diff --git a/sdk/test/get-cases/mergeFragmentsWithoutDefaults/output.txt b/sdk/test/get-cases/mergeFragmentsWithoutDefaults/output.txt
@@ -1,5 +1,4 @@
 event: datastar-merge-fragments
-retry: 1000
 data: fragments <div>Merge</div>
 
 
diff --git a/sdk/test/get-cases/mergeSignalsWithDefaults/output.txt b/sdk/test/get-cases/mergeSignalsWithDefaults/output.txt
@@ -1,5 +1,4 @@
 event: datastar-merge-signals
-retry: 1000
 data: signals {"one":1,"two":2}
 
 
diff --git a/sdk/test/get-cases/mergeSignalsWithMultilineSignals/output.txt b/sdk/test/get-cases/mergeSignalsWithMultilineSignals/output.txt
@@ -1,5 +1,4 @@
 event: datastar-merge-signals
-retry: 1000
 data: signals {"one":"first\\n signal","two":"second signal"}
 
 
diff --git a/sdk/test/get-cases/mergeSignalsWithoutDefaults/output.txt b/sdk/test/get-cases/mergeSignalsWithoutDefaults/output.txt
@@ -1,5 +1,4 @@
 event: datastar-merge-signals
-retry: 1000
 data: signals {"one":1,"two":2}
 
 
diff --git a/sdk/test/get-cases/removeFragmentsWithDefaults/output.txt b/sdk/test/get-cases/removeFragmentsWithDefaults/output.txt
@@ -1,5 +1,4 @@
 event: datastar-remove-fragments
-retry: 1000
 data: selector #target
 
 
diff --git a/sdk/test/get-cases/removeFragmentsWithoutDefaults/output.txt b/sdk/test/get-cases/removeFragmentsWithoutDefaults/output.txt
@@ -1,5 +1,4 @@
 event: datastar-remove-fragments
-retry: 1000
 data: selector #target
 
 
diff --git a/sdk/test/get-cases/removeSignalsWithDefaults/output.txt b/sdk/test/get-cases/removeSignalsWithDefaults/output.txt
@@ -1,5 +1,4 @@
 event: datastar-remove-signals
-retry: 1000
 data: paths one
 
 
diff --git a/sdk/test/get-cases/sendTwoEvents/output.txt b/sdk/test/get-cases/sendTwoEvents/output.txt
@@ -1,10 +1,8 @@
 event: datastar-merge-fragments
-retry: 1000
 data: fragments <div>Merge</div>
 
 
 event: datastar-merge-fragments
-retry: 1000
 data: fragments <div>Merge 2</div>
 
 
diff --git a/sdk/test/post-cases/readSignalsFromBody/output.txt b/sdk/test/post-cases/readSignalsFromBody/output.txt
@@ -1,5 +1,4 @@
 event: datastar-merge-fragments
-retry: 1000
 data: fragments <div>Merge</div>
 
 
diff --git a/site/static/md/reference/sdks.md b/site/static/md/reference/sdks.md
@@ -1,6 +1,6 @@
 # SDKs
 
-Datastar provides backend SDKs that simplify the process of generating [SSE events](/reference/sse_events) specific to Datastar.
+Datastar provides backend SDKs that simplify the process of generating [SSE events](/reference/sse_events) specific to Datastar. Every SDK must follow the [Architecture Decision Record](https://github.com/starfederation/datastar/blob/develop/sdk/README.md) document.
 
 ## Clojure