Skip to content

Commit b9a6f4c

Browse files
tanderson-ldtanderson-ld
authored
chore: migrating redis store package to java-core (#45)
Migrates redis-store package to java-core package.
1 parent 1dbf1ec commit b9a6f4c

30 files changed

+1624
-4
lines changed

‎.github/ISSUE_TEMPLATE/package-redis-store--bug_report.md

+36
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
---
2+
name: 'Bug report for the java-server-sdk-redis-store package'
3+
about: Create a report to help us improve
4+
title: ''
5+
labels: 'package: java-server-sdk-redis-store, bug'
6+
assignees: ''
7+
---
8+
9+
**Is this a support request?**
10+
This issue tracker is maintained by LaunchDarkly SDK developers and is intended for feedback on the code in this library. If you're not sure whether the problem you are having is specifically related to this library, or to the LaunchDarkly service overall, it may be more appropriate to contact the LaunchDarkly support team; they can help to investigate the problem and will consult the SDK team if necessary. You can submit a support request by going [here](https://support.launchdarkly.com/) and clicking "submit a request", or by emailing [email protected].
11+
12+
Note that issues filed on this issue tracker are publicly accessible. Do not provide any private account information on your issues. If your problem is specific to your account, you should submit a support request as described above.
13+
14+
**Describe the bug**
15+
A clear and concise description of what the bug is.
16+
17+
**To reproduce**
18+
Steps to reproduce the behavior.
19+
20+
**Expected behavior**
21+
A clear and concise description of what you expected to happen.
22+
23+
**Logs**
24+
If applicable, add any log output related to your problem.
25+
26+
**SDK version**
27+
The version of this SDK that you are using.
28+
29+
**Language version, developer tools**
30+
For instance, Go 1.11 or Ruby 2.5.3. If you are using a language that requires a separate compiler, such as C, please include the name and version of the compiler too.
31+
32+
**OS/platform**
33+
For instance, Ubuntu 16.04, Windows 10, or Android 4.0.3. If your code is running in a browser, please also include the browser type and version.
34+
35+
**Additional context**
36+
Add any other context about the problem here.

‎.github/ISSUE_TEMPLATE/package-redis-store--feature_request.md

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: Feature request for the java-server-sdk-redis-store package
3+
about: Suggest an idea for this project
4+
title: ''
5+
labels: 'package: java-server-sdk-redis-store, enhancement'
6+
assignees: ''
7+
8+
---
9+
10+
**Is your feature request related to a problem? Please describe.**
11+
A clear and concise description of what the problem is. Ex. I would love to see the SDK [...does something new...]
12+
13+
**Describe the solution you'd like**
14+
A clear and concise description of what you want to happen.
15+
16+
**Describe alternatives you've considered**
17+
A clear and concise description of any alternative solutions or features you've considered.
18+
19+
**Additional context**
20+
Add any other context about the feature request here.

‎.github/actions/ci/action.yml

+8
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,14 @@ runs:
2727
distribution: ${{ inputs.java_distribution }}
2828
java-version: ${{ inputs.java_version }}
2929

30+
- name: Setup Redis Service
31+
shell: bash
32+
if: ${{ inputs.workspace_path == 'lib/java-server-sdk-redis-store' }}
33+
run: |
34+
sudo apt-get update -y
35+
sudo apt-get install redis-server -y
36+
sudo service redis-server start
37+
3038
- name: Restore dependencies
3139
shell: bash
3240
id: restore

‎.github/workflows/java-server-sdk-redis-store.yml

+87
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,87 @@
1+
name: java-server-sdk-redis-store
2+
3+
on:
4+
push:
5+
branches: [main, 'feat/**']
6+
paths-ignore:
7+
- '**.md' #Do not need to run CI for markdown changes.
8+
pull_request:
9+
branches: [main, 'feat/**']
10+
paths-ignore:
11+
- '**.md'
12+
13+
jobs:
14+
build-test-java-server-sdk-redis-store:
15+
strategy:
16+
matrix:
17+
jedis-version: [2.9.0, 3.0.0]
18+
runs-on: ubuntu-latest
19+
steps:
20+
- uses: actions/checkout@v3
21+
22+
- name: Edit build.gradle to change Jedis version
23+
shell: bash
24+
run: |
25+
cd lib/java-server-sdk-redis-store
26+
sed -i.bak 's#"jedis":.*"[0-9.]*"#"jedis":"${{ matrix.jedis-version }}"#' build.gradle
27+
28+
- name: Shared CI Steps
29+
uses: ./.github/actions/ci
30+
with:
31+
workspace_path: 'lib/java-server-sdk-redis-store'
32+
java_version: 8
33+
34+
build-test-java-server-sdk-windows:
35+
strategy:
36+
matrix:
37+
jedis-version: [2.9.0, 3.0.0]
38+
runs-on: windows-latest
39+
steps:
40+
- uses: actions/checkout@v3
41+
42+
- run: |
43+
$ProgressPreference = "SilentlyContinue"
44+
iwr -outf redis.zip https://github.com/MicrosoftArchive/redis/releases/download/win-3.0.504/Redis-x64-3.0.504.zip
45+
mkdir redis
46+
Expand-Archive -Path redis.zip -DestinationPath redis
47+
cd redis
48+
.\redis-server --service-install
49+
.\redis-server --service-start
50+
Start-Sleep -s 5
51+
.\redis-cli ping
52+
53+
- name: Edit build.gradle to change Jedis version
54+
shell: bash
55+
run: |
56+
cd lib/java-server-sdk-redis-store
57+
sed -i.bak 's#"jedis":.*"[0-9.]*"#"jedis":"${{ matrix.jedis-version }}"#' build.gradle
58+
59+
- name: Setup Java
60+
uses: actions/setup-java@v4
61+
with:
62+
distribution: 'temurin'
63+
java-version: 8
64+
65+
- name: Restore dependencies
66+
shell: bash
67+
id: restore
68+
run: lib/java-server-sdk-redis-store/gradlew dependencies -p lib/java-server-sdk-redis-store
69+
70+
- name: Build
71+
shell: bash
72+
id: build
73+
run: lib/java-server-sdk-redis-store/gradlew build -p lib/java-server-sdk-redis-store
74+
75+
- name: Build Jar
76+
shell: bash
77+
id: buildjar
78+
run: lib/java-server-sdk-redis-store/gradlew jar -p lib/java-server-sdk-redis-store
79+
80+
- name: Run Tests
81+
if: steps.build.outcome == 'success' && inputs.run_tests == 'true'
82+
shell: bash
83+
run: lib/java-server-sdk-redis-store/gradlew test -p lib/java-server-sdk-redis-store
84+
85+
- name: Build Documentation
86+
shell: bash
87+
run: lib/java-server-sdk-redis-store/gradlew javadoc -p lib/java-server-sdk-redis-store

‎.github/workflows/manual-publish-docs.yml

+2-1
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,11 @@ on:
66
required: true
77
type: choice
88
options:
9-
- lib/java-server-sdk-otel
109
- lib/shared/common
1110
- lib/shared/internal
1211
- lib/sdk/server
12+
- lib/java-server-sdk-otel
13+
- lib/java-server-sdk-redis-store
1314
dry_run:
1415
description: 'Is this a dry run. If so no docs will be published.'
1516
type: boolean

‎.github/workflows/manual-publish.yml

+2-1
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,11 @@ on:
77
required: true
88
type: choice
99
options:
10-
- lib/java-server-sdk-otel
1110
- lib/shared/common
1211
- lib/shared/internal
1312
- lib/sdk/server
13+
- lib/java-server-sdk-otel
14+
- lib/java-server-sdk-redis-store
1415
prerelease:
1516
description: 'Is this a prerelease.'
1617
type: boolean

‎.github/workflows/release-please.yml

+34-1
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,11 @@ jobs:
1010
runs-on: ubuntu-latest
1111

1212
outputs:
13-
package-server-sdk-otel-released: ${{ steps.release.outputs['lib/java-server-sdk-otel--release_created'] }}
1413
package-sdk-common-released: ${{ steps.release.outputs['lib/java-sdk-common--release_created'] }}
1514
package-sdk-internal-released: ${{ steps.release.outputs['lib/java-sdk-internal--release_created'] }}
1615
package-server-sdk-released: ${{ steps.release.outputs['lib/java-server-sdk--release_created'] }}
16+
package-server-sdk-otel-released: ${{ steps.release.outputs['lib/java-server-sdk-otel--release_created'] }}
17+
package-server-sdk-redis-store-released: ${{ steps.release.outputs['lib/java-server-sdk-redis-store--release_created'] }}
1718

1819
steps:
1920
- uses: google-github-actions/release-please-action@v4
@@ -86,6 +87,38 @@ jobs:
8687
aws_role: ${{ vars.AWS_ROLE_ARN }}
8788
token: ${{ secrets.GITHUB_TOKEN }}
8889

90+
release-server-sdk-redis-store:
91+
runs-on: ubuntu-latest
92+
needs: release-please
93+
permissions:
94+
id-token: write
95+
contents: write
96+
pull-requests: write
97+
if: ${{ needs.release-please.outputs.package-server-sdk-redis-store-released == 'true'}}
98+
steps:
99+
- uses: actions/checkout@v4
100+
101+
- uses: launchdarkly/gh-actions/actions/[email protected]
102+
name: Get secrets
103+
with:
104+
aws_assume_role: ${{ vars.AWS_ROLE_ARN }}
105+
ssm_parameter_pairs: '/production/common/releasing/sonatype/username = SONATYPE_USER_NAME,
106+
/production/common/releasing/sonatype/password = SONATYPE_PASSWORD'
107+
s3_path_pairs: 'launchdarkly-releaser/java/code-signing-keyring.gpg = code-signing-keyring.gpg'
108+
109+
- uses: ./.github/actions/full-release
110+
with:
111+
workspace_path: lib/java-server-sdk-redis-store
112+
dry_run: false
113+
prerelease: false
114+
code_signing_keyring: 'code-signing-keyring.gpg'
115+
signing_key_id: ${{ env.SIGNING_KEY_ID }}
116+
signing_key_passphrase: ${{ env.SIGNING_KEY_PASSPHRASE }}
117+
sonatype_username: ${{ env.SONATYPE_USER_NAME }}
118+
sonatype_password: ${{ env.SONATYPE_PASSWORD }}
119+
aws_role: ${{ vars.AWS_ROLE_ARN }}
120+
token: ${{ secrets.GITHUB_TOKEN }}
121+
89122
release-sdk-internal:
90123
runs-on: ubuntu-latest
91124
needs: release-please

‎.release-please-manifest.json

+1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
{
22
"lib/java-server-sdk-otel": "0.1.0",
3+
"lib/java-server-sdk-redis-store": "3.0.0",
34
"lib/shared/common": "2.1.1",
45
"lib/shared/internal": "1.3.0",
56
"lib/sdk/server": "7.7.0"

‎README.md

+11-1
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,10 @@ This includes shared libraries, used by SDKs and other tools, as well as SDKs.
1414
| [@launchdarkly/java-sdk-internal](lib/shared/internal/README.md) | [![Documentation][sdk-internal-docs-badge]][sdk-internal-docs-link] | [![maven][sdk-internal-maven-badge]][sdk-internal-maven-link] | [Issues][sdk-internal-issues] | [![Actions Status][sdk-internal-ci-badge]][sdk-internal-ci-link] |
1515
| [@launchdarkly/java-sdk-common](lib/shared/common/README.md) | [![Documentation][sdk-common-docs-badge]][sdk-common-docs-link] | [![maven][sdk-common-maven-badge]][sdk-common-maven-link] | [Issues][sdk-common-issues] | [![Actions Status][sdk-common-ci-badge]][sdk-common-ci-link] |
1616

17-
| Telemetry Packages | API Docs | maven | issues | tests |
17+
| Other Packages | API Docs | maven | issues | tests |
1818
| ---------------------------------------------------------------------------- |--------------------------------------------------------------| ---------------------------------------------------------- | ------------------------------------- | ------------------------------------------------------------- |
1919
| [@launchdarkly/java-server-sdk-otel](lib/java-server-sdk-otel/README.md) | [![Documentation][server-otel-docs-badge]][server-otel-docs-link] | [![maven][server-otel-maven-badge]][server-otel-maven-link] | [Issues][server-otel-issues] | [![Actions Status][server-otel-ci-badge]][server-otel-ci-link] |
20+
| [@launchdarkly/java-server-sdk-redis-store](lib/java-server-sdk-redis-store/README.md) | [![Documentation][server-redis-docs-badge]][server-redis-docs-link] | [![maven][server-redis-maven-badge]][server-redis-maven-link] | [Issues][server-redis-issues] | [![Actions Status][server-redis-ci-badge]][server-redis-ci-link] |
2021

2122
## Organization
2223

@@ -71,6 +72,15 @@ We encourage pull requests and other contributions from the community. Check out
7172
[server-otel-docs-badge]: https://img.shields.io/static/v1?label=GitHub+Pages&message=API+reference&color=00add8
7273
[server-otel-docs-link]: https://launchdarkly.github.io/java-core/lib/java-server-sdk-otel/
7374

75+
[//]: # 'java-server-sdk-redis-store'
76+
[server-redis-issues]: https://github.com/launchdarkly/java-core/issues?q=is%3Aissue+is%3Aopen+label%3A%22package%3A+java-server-sdk-redis-store%22+
77+
[server-redis-maven-badge]: https://img.shields.io/maven-central/v/com.launchdarkly/launchdarkly-java-server-sdk-redis-store
78+
[server-redis-maven-link]: https://central.sonatype.com/artifact/com.launchdarkly/launchdarkly-java-server-sdk-redis-store
79+
[server-redis-ci-badge]: https://github.com/launchdarkly/java-core/actions/workflows/java-server-sdk-redis-store.yml/badge.svg
80+
[server-redis-ci-link]: https://github.com/launchdarkly/java-core/actions/workflows/java-server-sdk-redis-store.yml
81+
[server-redis-docs-badge]: https://img.shields.io/static/v1?label=GitHub+Pages&message=API+reference&color=00add8
82+
[server-redis-docs-link]: https://launchdarkly.github.io/java-core/lib/java-server-sdk-redis-store/
83+
7484
[//]: # 'java-sdk-internal'
7585
[sdk-internal-issues]: https://github.com/launchdarkly/java-core/issues?q=is%3Aissue+is%3Aopen+label%3A%22package%3A+java-sdk-internal%22+
7686
[sdk-internal-maven-badge]: https://img.shields.io/maven-central/v/com.launchdarkly/launchdarkly-java-sdk-internal

‎lib/java-server-sdk-redis-store/CHANGELOG.md

+33
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# Change log
2+
3+
All notable changes to the LaunchDarkly Java SDK Redis integration will be documented in this file. This project adheres to [Semantic Versioning](http://semver.org).
4+
5+
## [3.0.0] - 2022-12-07
6+
This release corresponds to the 6.0.0 release of the LaunchDarkly Java SDK. Any application code that is being updated to use the 6.0.0 SDK, and was using a 2.x version of `launchdarkly-java-server-sdk-redis-store`, should now use a 3.x version instead.
7+
8+
There are no functional differences in the behavior of the Redis integration; the differences are only related to changes in the usage of interface types for configuration in the SDK.
9+
10+
### Added:
11+
- `Redis.bigSegmentStore()`, which creates a configuration builder for use with Big Segments. Previously, the `Redis.dataStore()` builder was used for both regular data stores and Big Segment stores.
12+
13+
### Changed:
14+
- The type `RedisDataStoreBuilder` has been removed, replaced by a generic type `RedisStoreBuilder`. Application code would not normally need to reference these types by name, but if necessary, use either `RedisStoreBuilder<PersistentDataStore>` or `RedisStoreBuilder<BigSegmentStore>` depending on whether you are configuring a regular data store or a Big Segment store.
15+
16+
## [2.0.0] - 2022-07-29
17+
This release updates the package to use the new logging mechanism that was introduced in version 5.10.0 of the LaunchDarkly Java SDK, so that log output from the Redis integration is handled in whatever way was specified by the SDK's logging configuration.
18+
19+
This version of the package will not work with SDK versions earlier than 5.10.0; that is the only reason for the 2.0.0 major version increment. The functionality of the package is otherwise unchanged, and there are no API changes.
20+
21+
## [1.1.0] - 2022-01-28
22+
### Added:
23+
- Added support for Big Segments. An Early Access Program for creating and syncing Big Segments from customer data platforms is available to enterprise customers.
24+
25+
## [1.0.1] - 2021-08-06
26+
### Fixed:
27+
- This integration now works with Jedis 3.x as well as Jedis 2.9.x. The default dependency is still 2.9.x, but an application can override this with a dependency on a 3.x version. (Thanks, [robotmlg](https://github.com/launchdarkly/java-server-sdk-redis/pull/3)!)
28+
29+
## [1.0.0] - 2020-06-02
30+
Initial release, corresponding to the 5.0.0 release of [`launchdarkly-java-server-sdk`](https://github.com/launchdarkly/java-server-sdk).
31+
32+
Prior to that release, the Redis integration was built into the main SDK library. For more information about changes in the SDK database integrations, see the [4.x to 5.0 migration guide](https://docs-stg.launchdarkly.com/252/sdk/server-side/java/migration-4-to-5/).
33+

0 commit comments

Comments
 (0)