Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Make timeout optional in LDIdentifyOptions. #552

Merged
merged 1 commit into from
Aug 28, 2024

Conversation

kinyoklion
Copy link
Member

In the strictest sense this would be a breaking change, but in the practical I think it is not likely to be.

The way this would be breaking is if someone was using this for something other than just passing to the identify function. This would be somewhat unusual.

Example:

interface MyOptions: {
  timeout: number;
}

let myOptions: MyOptions = someLdIdentifyOptions;

For standard usage this will not be breaking.

I am tagging this as a feat instead of a fix to prevent any breakage for someone floating patches and also doing unusual things with the type.

@kinyoklion kinyoklion requested a review from a team as a code owner August 27, 2024 20:42
@kinyoklion
Copy link
Member Author

kinyoklion commented Aug 27, 2024

@Bardiamist requested this in another PR.

@kinyoklion
Copy link
Member Author

There is another issue, which is:

if (identifyOptions?.timeout) {

The timeout is being truthy checked, which means a timeout of 0 is not accepted. Changing this would be a more severe breaking change, so that will have to be reserved for a breaking SDK release.

@kinyoklion kinyoklion merged commit fa247b2 into main Aug 28, 2024
20 checks passed
@kinyoklion kinyoklion deleted the rlamb/sc-254550/optional-timeout branch August 28, 2024 16:12
@github-actions github-actions bot mentioned this pull request Aug 28, 2024
kinyoklion pushed a commit that referenced this pull request Aug 28, 2024
🤖 I have created a release *beep* *boop*
---


<details><summary>akamai-edgeworker-sdk-common: 1.1.13</summary>

##
[1.1.13](akamai-edgeworker-sdk-common-v1.1.12...akamai-edgeworker-sdk-common-v1.1.13)
(2024-08-28)


### Dependencies

* The following workspace dependencies were updated
  * dependencies
    * @launchdarkly/js-server-sdk-common bumped from ^2.4.5 to ^2.5.0
</details>

<details><summary>akamai-server-base-sdk: 2.1.13</summary>

##
[2.1.13](akamai-server-base-sdk-v2.1.12...akamai-server-base-sdk-v2.1.13)
(2024-08-28)


### Dependencies

* The following workspace dependencies were updated
  * dependencies
* @launchdarkly/akamai-edgeworker-sdk-common bumped from ^1.1.12 to
^1.1.13
    * @launchdarkly/js-server-sdk-common bumped from ^2.4.5 to ^2.5.0
</details>

<details><summary>akamai-server-edgekv-sdk: 1.1.13</summary>

##
[1.1.13](akamai-server-edgekv-sdk-v1.1.12...akamai-server-edgekv-sdk-v1.1.13)
(2024-08-28)


### Dependencies

* The following workspace dependencies were updated
  * dependencies
* @launchdarkly/akamai-edgeworker-sdk-common bumped from ^1.1.12 to
^1.1.13
    * @launchdarkly/js-server-sdk-common bumped from ^2.4.5 to ^2.5.0
</details>

<details><summary>cloudflare-server-sdk: 2.5.11</summary>

##
[2.5.11](cloudflare-server-sdk-v2.5.10...cloudflare-server-sdk-v2.5.11)
(2024-08-28)


### Dependencies

* The following workspace dependencies were updated
  * devDependencies
    * @launchdarkly/js-server-sdk-common-edge bumped from 2.3.6 to 2.3.7
</details>

<details><summary>js-client-sdk-common: 1.6.0</summary>

##
[1.6.0](js-client-sdk-common-v1.5.0...js-client-sdk-common-v1.6.0)
(2024-08-28)


### Features

* Correct client evaluation typings.
([#554](#554))
([64ab88d](64ab88d))
* Make timeout optional in LDIdentifyOptions.
([#552](#552))
([fa247b2](fa247b2))


### Dependencies

* The following workspace dependencies were updated
  * dependencies
    * @launchdarkly/js-sdk-common bumped from 2.6.0 to 2.7.0
</details>

<details><summary>js-sdk-common: 2.7.0</summary>

##
[2.7.0](js-sdk-common-v2.6.0...js-sdk-common-v2.7.0)
(2024-08-28)


### Features

* Correct client evaluation typings.
([#554](#554))
([64ab88d](64ab88d))
</details>

<details><summary>js-server-sdk-common: 2.5.0</summary>

##
[2.5.0](js-server-sdk-common-v2.4.5...js-server-sdk-common-v2.5.0)
(2024-08-28)


### Features

* Correct client evaluation typings.
([#554](#554))
([64ab88d](64ab88d))


### Dependencies

* The following workspace dependencies were updated
  * dependencies
    * @launchdarkly/js-sdk-common bumped from 2.6.0 to 2.7.0
</details>

<details><summary>js-server-sdk-common-edge: 2.3.7</summary>

##
[2.3.7](js-server-sdk-common-edge-v2.3.6...js-server-sdk-common-edge-v2.3.7)
(2024-08-28)


### Dependencies

* The following workspace dependencies were updated
  * dependencies
    * @launchdarkly/js-server-sdk-common bumped from 2.4.5 to 2.5.0
</details>

<details><summary>node-server-sdk: 9.5.2</summary>

##
[9.5.2](node-server-sdk-v9.5.1...node-server-sdk-v9.5.2)
(2024-08-28)


### Dependencies

* The following workspace dependencies were updated
  * dependencies
    * @launchdarkly/js-server-sdk-common bumped from 2.4.5 to 2.5.0
</details>

<details><summary>node-server-sdk-dynamodb: 6.1.19</summary>

##
[6.1.19](node-server-sdk-dynamodb-v6.1.18...node-server-sdk-dynamodb-v6.1.19)
(2024-08-28)


### Dependencies

* The following workspace dependencies were updated
  * devDependencies
    * @launchdarkly/node-server-sdk bumped from 9.5.1 to 9.5.2
  * peerDependencies
    * @launchdarkly/node-server-sdk bumped from >=9.4.3 to >=9.5.2
</details>

<details><summary>node-server-sdk-otel: 1.0.11</summary>

##
[1.0.11](node-server-sdk-otel-v1.0.10...node-server-sdk-otel-v1.0.11)
(2024-08-28)


### Dependencies

* The following workspace dependencies were updated
  * devDependencies
    * @launchdarkly/node-server-sdk bumped from 9.5.1 to 9.5.2
  * peerDependencies
    * @launchdarkly/node-server-sdk bumped from >=9.4.3 to >=9.5.2
</details>

<details><summary>node-server-sdk-redis: 4.1.19</summary>

##
[4.1.19](node-server-sdk-redis-v4.1.18...node-server-sdk-redis-v4.1.19)
(2024-08-28)


### Dependencies

* The following workspace dependencies were updated
  * devDependencies
    * @launchdarkly/node-server-sdk bumped from 9.5.1 to 9.5.2
  * peerDependencies
    * @launchdarkly/node-server-sdk bumped from >=9.4.3 to >=9.5.2
</details>

<details><summary>react-native-client-sdk: 10.6.0</summary>

##
[10.6.0](react-native-client-sdk-v10.5.1...react-native-client-sdk-v10.6.0)
(2024-08-28)


### Features

* custom storage option for React Native SDK
([#539](#539))
([115bd82](115bd82))


### Dependencies

* The following workspace dependencies were updated
  * dependencies
    * @launchdarkly/js-client-sdk-common bumped from 1.5.0 to 1.6.0
</details>

<details><summary>vercel-server-sdk: 1.3.14</summary>

##
[1.3.14](vercel-server-sdk-v1.3.13...vercel-server-sdk-v1.3.14)
(2024-08-28)


### Dependencies

* The following workspace dependencies were updated
  * dependencies
    * @launchdarkly/js-server-sdk-common-edge bumped from 2.3.6 to 2.3.7
</details>

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants