feat: add two example apps that use nginx php8.2 and the sdk proxy #62

dakotawashok · 2023-12-27T00:57:39Z

Enhancement: New PHP 8.2 Hello World Examples with Nginx, Docker-Compose, and DevCycle Proxy

This Pull Request introduces two new Hello World applications for our PHP SDK, setup with PHP 8.2 and integrated with nginx, docker-compose, and the DevCycle Local Bucketing Proxy.

Key Changes:

New Hello World Applications: Two examples added to demonstrate the PHP SDK's functionality with the DevCycle Local Bucketing Proxy in a PHP 8.2 environment.
PHP 8.2 Compatibility: These containers assume PHP 8.2 is being used
Nginx Integration: Nginx is used as the web server
Docker-Compose Setup: The environment setup is streamlined with docker-compose for ease of use and consistency.
DevCycle Local Bucketing Proxy Integration:

Looking forward to your feedback on these enhancements.

Dakota Washok
Senior Software Engineer/DevOps Engineer

dakotawashok · 2023-12-27T01:02:43Z

Looks like there are some failing tests reported by the Harness Tests suite? I'm not sure if those are okay or not, but let me know if you want me to update anything!

jonathannorris · 2023-12-29T01:32:00Z

Hey @dakotawashok thanks so much for submitting this PR! Our "virtual office" is closed this week, we will be sure to dig into it next week when everyone is back.

JamieSinn · 2024-01-02T20:35:16Z

Further investigation shows this is due to a file permissions issue for the raw socket file:
DevCycleHQ/sdk-proxy#12 (comment)

This is an awesome contribution for the repo!

dakotawashok · 2024-01-29T21:59:22Z

Hello @JamieSinn / @jonathannorris !
I'm not sure who to ask this, so I figured I'd ping both, sorry about that.
We decided to use the HTTP SDK proxy instead of the UDP proxy for the time being, until we can further investigate our setup and how to integrate the proper file/group permissions across our services.
The HTTP SDK Proxy seems to be working like a charm, though! Thanks for that :)

As for this PR, though, I still think it'd be good to have a variety of example setups in this project for others to use and build off of. If yall agree, I'd love to get this in here still. Is there anything you need me to update on my end?

JamieSinn · 2024-01-30T02:02:27Z

Absolutely, I'd love to get it in here.

I think for tweaks, making the socket available under 777 would be a quick fix, somehow part of the docker compose setup or a docker file edit.

With that, it works and we can merge the rest as is!

fix: alter devcycle udp socket file permissions in example app

dakotawashok · 2024-02-01T19:19:37Z

Hey @JamieSinn I've altered the Supervisord configuration in the UDP example app to alter the socket file permissions after startup. Please take a look and let me know if you want anything else updated!

examples/hello-world-udp-proxy/Dockerfile

examples/hello-world-udp-proxy/supervisord.conf

JamieSinn · 2024-02-06T20:35:42Z

Hey @dakotawashok - are you able to update the example apps to use the new init flow?
Check the readme if you need help

dakotawashok · 2024-02-06T20:55:36Z

@JamieSinn I'll take a look and integrate it with these example apps once I'm able to hop back onto this, sorry for the wait!

JamieSinn · 2024-02-06T20:55:58Z

No rush! Thank you!

fix: alter devcycle udp socket file permissions in example app

…ocumentation in readme

…e docker compose configuration file

…ation

dakotawashok · 2024-02-13T05:04:50Z

I've got the issues you've pointed out resolved, could you take another look at this @JamieSinn ? I'll test again in the morning, but I think these changes are good to go! Let me know if you'd like me to resolve the unit tests that are failing, as I can't remember if they were a part of the Checks in this repo when I originally opened this haha

JamieSinn · 2024-02-13T10:52:59Z

Looks great, I'll take a shot at testing it when I'm in the office

JamieSinn · 2024-02-13T15:28:55Z

Seems like supervisord is crashing still

Did it work when you tried it locally? I'm using a test token so it may be a weird environment setup

examples/hello-world-udp-proxy/app.php

examples/hello-world-http-proxy/app.php

…p proxy to use only one slash

…r compose configuration

dakotawashok · 2024-02-13T19:33:32Z

Looks good now! Here's the result from variable.php for a variable set to true in the http proxy example:

Here's the result from variable.php for a variable set to true in the udp proxy example:

dakotawashok · 2024-02-13T19:36:00Z

@JamieSinn can you please try this again, replacing the sdk in the docker-compose files with a proper key? This should be ready for review.

JamieSinn · 2024-02-13T19:36:38Z

examples/hello-world-udp-proxy/dvc-proxy-config.json

+    {
+      "sdkKey": "${DEVCYCLE_SDK_KEY}",
+      "unixSocketPath": "/tmp/dvc_lb_proxy.sock",
+      "unixSocketEnabled": true,


Suggested change

"unixSocketEnabled": true,

"unixSocketEnabled": true,

"unixSocketPermissions": 777,

You'll need to set the file perms here too.

I've removed the extra commands from the supervisord configuration and I'm testing this functionality now

@JamieSinn Is this configuration option supposed to negate the need to alter the socket file permissions after the proxy command is run?

I'm not able to get the actual variable value when using this configuration option and removing the extra commands for altering the socket file permissions, which is why I ask.

Hmm - that's odd - let me do a quick test.

I'll push up the changes I used to test that, I think that'd help, and I can resolve any issues afterward.

sounds good. I have a feeling this might be on my implementation.

Yep - looks like that was on me. I fixed it to now support octal perms. 1.1.1 will fix it

…tp example

dakotawashok · 2024-02-13T21:10:45Z

@JamieSinn I'm still getting an issue, even with updating the proxy package to 1.1.1. Here's the error I get when running the command now, a new error:

2024/02/13 21:08:17 Loading configuration from file: /etc/devcycle-sdk-proxy/dvc-proxy-config.json
2024/02/13 21:08:17 Failed to parse config: failed to parse config from JSON: json: cannot unmarshal number into Go struct field ProxyInstance.instances.unixSocketPermissions of type string
2024/02/13 21:08:17 Please either set the config path or set the environment variables

I tried "unixSocketPermissions": "777", and "unixSocketPermissions": 777, in my dvc-proxy-config.json.

Here's the results of the udp variable test. Interestingly, the webpage still is loading without a devcycle error being reported, even though the proxy isn't apparently running:

JamieSinn · 2024-02-13T21:11:28Z

@JamieSinn I'm still getting an issue, even with updating the proxy package to 1.1.1. Here's the error I get when running the command now, a new error:
2024/02/13 21:08:17 Loading configuration from file: /etc/devcycle-sdk-proxy/dvc-proxy-config.json
2024/02/13 21:08:17 Failed to parse config: failed to parse config from JSON: json: cannot unmarshal number into Go struct field ProxyInstance.instances.unixSocketPermissions of type string
2024/02/13 21:08:17 Please either set the config path or set the environment variables
I tried "unixSocketPermissions": "777", and "unixSocketPermissions": 777, in my dvc-proxy-config.json.

Here's the results of the udp variable test. Interestingly, the webpage still is loading without a devcycle error being reported, even though the proxy isn't apparently running:

ah my bad - I forgot to say you'll need to change that param to be a string, "0777" specifically.
The loading without an error is the expected behaviour - devcycle should default and not bubble the error to the user layer.

examples/hello-world-udp-proxy/dvc-proxy-config.json

…sions set

dakotawashok · 2024-02-13T21:15:51Z

Woohoo! That worked! I'm able to get our variable successfully now on both proxy hello world examples. If this is good to go for yall, please feel free to merge in.

feat: add two example apps that use nginx php8.2 and the sdk proxy

83c606a

dakotawashok mentioned this pull request Dec 27, 2023

SDK Proxy Requires non-default file permissions DevCycleHQ/sdk-proxy#12

Closed

fix: remove supervisord.pid

fecaefe

fix: alter devcycle udp socket file permissions in example app

JamieSinn reviewed Feb 1, 2024

View reviewed changes

examples/hello-world-udp-proxy/Dockerfile Outdated Show resolved Hide resolved

examples/hello-world-udp-proxy/supervisord.conf Outdated Show resolved Hide resolved

JamieSinn self-assigned this Feb 6, 2024

dakotawashok added 8 commits February 7, 2024 13:21

feat: add two example apps that use nginx php8.2 and the sdk proxy

3b29127

fix: remove supervisord.pid

fd63eba

fix: alter devcycle udp socket file permissions in example app

Merge remote-tracking branch 'origin/main' into main

356f4d9

refactor: update instantiation of DevCycleClient to use new options d…

1de5e5f

…ocumentation in readme

refactor: pass dockerfile the devcycle sdk key as an argument from th…

7f8539f

…e docker compose configuration file

refactor: revert testing change

ece611a

refactor: update variable php scripts to be more default oriented

d8eeeea

fix: add a longer sleep time between commands in supervisord configur…

bd22280

…ation

JamieSinn reviewed Feb 13, 2024

View reviewed changes

examples/hello-world-udp-proxy/app.php Outdated Show resolved Hide resolved

JamieSinn reviewed Feb 13, 2024

View reviewed changes

examples/hello-world-udp-proxy/app.php Outdated Show resolved Hide resolved

JamieSinn reviewed Feb 13, 2024

View reviewed changes

examples/hello-world-http-proxy/app.php Outdated Show resolved Hide resolved

dakotawashok added 2 commits February 13, 2024 11:54

refactor: remove unnecessary import and fix bucketing hostname for ud…

3b3bfd2

…p proxy to use only one slash

refactor: update emails to be default oriented

892c1cf

dakotawashok added 4 commits February 13, 2024 11:57

refactor: update devcycle proxy version to install

98cb0be

refactor: move devcycle sdk key to the appropriate field in the docke…

52dd75f

…r compose configuration

refactor: fix issues with devcycle keys not being set to env var

30f585e

refactor: remove key

1cebfc3

dakotawashok requested a review from JamieSinn February 13, 2024 19:34

JamieSinn reviewed Feb 13, 2024

View reviewed changes

dakotawashok added 3 commits February 13, 2024 13:39

refactor: remove unnecessary container around sdk proxy command in ht…

23a71b2

…tp example

refactor: use new configuration option for devcycle proxy

cb757e6

refactor: update devcycle proxy version to download and install

94d12ae

JamieSinn reviewed Feb 13, 2024

View reviewed changes

examples/hello-world-udp-proxy/dvc-proxy-config.json Outdated Show resolved Hide resolved

JamieSinn and others added 3 commits February 13, 2024 16:12

Update examples/hello-world-udp-proxy/dvc-proxy-config.json

6e7912b

refactor: update permissions string value to be a proper octal permis…

2165f6a

…sions set

Merge remote-tracking branch 'origin/main' into main

123e5a8

dakotawashok requested a review from JamieSinn February 13, 2024 21:16

JamieSinn approved these changes Feb 13, 2024

View reviewed changes

JamieSinn merged commit 8a40424 into DevCycleHQ:main Feb 13, 2024

	"unixSocketEnabled": true,
	"unixSocketEnabled": true,
	"unixSocketPermissions": 777,

feat: add two example apps that use nginx php8.2 and the sdk proxy #62

feat: add two example apps that use nginx php8.2 and the sdk proxy #62

Uh oh!

Conversation

dakotawashok commented Dec 27, 2023

Enhancement: New PHP 8.2 Hello World Examples with Nginx, Docker-Compose, and DevCycle Proxy

Key Changes:

Uh oh!

dakotawashok commented Dec 27, 2023

Uh oh!

jonathannorris commented Dec 29, 2023

Uh oh!

JamieSinn commented Jan 2, 2024

Uh oh!

dakotawashok commented Jan 29, 2024

Uh oh!

JamieSinn commented Jan 30, 2024

Uh oh!

dakotawashok commented Feb 1, 2024

Uh oh!

Uh oh!

Uh oh!

JamieSinn commented Feb 6, 2024

Uh oh!

dakotawashok commented Feb 6, 2024

Uh oh!

JamieSinn commented Feb 6, 2024

Uh oh!

dakotawashok commented Feb 13, 2024

Uh oh!

JamieSinn commented Feb 13, 2024

Uh oh!

JamieSinn commented Feb 13, 2024

Uh oh!

Uh oh!

Uh oh!

Uh oh!

dakotawashok commented Feb 13, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

dakotawashok commented Feb 13, 2024

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dakotawashok commented Feb 13, 2024

Uh oh!

JamieSinn commented Feb 13, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

dakotawashok commented Feb 13, 2024

Uh oh!

Reviewers

Assignees

Labels

Milestone

Development

Uh oh!

3 participants

dakotawashok commented Feb 13, 2024 •

edited

Loading

JamieSinn commented Feb 13, 2024 •

edited

Loading