GCP VPC doc improvements by eschultink · Pull Request #1042 · Worklytics/psoxy

eschultink · 2025-11-04T17:35:06Z

Features

improve GCP VPC docs
elevate VPC feature to beta
improve error feedback when networking issues

Change implications

dependencies added/changed? No
something important to note in future release notes? no

…oogle sources

Copilot

Pull Request Overview

This PR improves GCP VPC documentation and error handling for network connectivity issues, elevating the VPC feature from alpha to beta status.

Key Changes:

Enhanced error feedback for network timeout scenarios with detailed troubleshooting guidance
Updated VPC feature maturity level from "alpha" to "beta" across documentation and variable descriptions
Improved VPC configuration documentation with clearer examples and setup instructions

Reviewed Changes

Copilot reviewed 7 out of 8 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
tools/psoxy-test/psoxy-test-call.js	Added network timeout error handling with detailed diagnostic message; reorganized imports alphabetically
java/core/src/main/java/co/worklytics/psoxy/gateway/impl/ApiDataRequestHandler.java	Added SocketTimeoutException detection and specialized error response with troubleshooting guidance
java/core/src/main/java/co/worklytics/psoxy/ErrorCauses.java	Added NETWORK_EGRESS_BLOCKED error cause; removed unused imports
infra/modules/gcp/variables.tf	Updated VPC config description from "alpha" to "beta"
infra/modules/gcp-host/variables.tf	Updated VPC config description from "alpha" to "beta"; removed validation blocks
infra/examples-dev/gcp/variables.tf	Removed extraneous blank line
docs/gcp/vpc.md	Comprehensive rewrite of VPC documentation with clearer configuration examples, corrected network setup instructions, and additional troubleshooting notes

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

docs/gcp/vpc.md

java/core/src/main/java/co/worklytics/psoxy/gateway/impl/ApiDataRequestHandler.java

aperez-worklytics

Just the command in CI seems to be wrong to me.

aperez-worklytics · 2025-11-04T18:49:26Z

.github/workflows/ci-terraform-modules.yaml

        working-directory: infra/modules/${{ matrix.module.name }}
        run: |
-          terraform test
+          terraform test --var="deployment_bundle=gs://psoxy-public-artifacts/psoxy-0.4.28.zip"


wrong paramters ? should this be just terraform test as before ?

it's just running terraform unit tests; those were failing bc it was trying to compile the JAR, due to dep of the module or something. So I passed a value for deployment_bundle to avoid that in this case.

ok, but just for 0.4.28, right ?

aperez-worklytics · 2025-11-04T18:55:08Z

java/core/src/main/java/co/worklytics/psoxy/gateway/impl/ApiDataRequestHandler.java

+     * 1) Network egress blocked from proxy (VPC/serverless connector misconfiguration)
+     * 2) Target API being unreachable/slow (their infrastructure issue)
+     */
+    private HttpEventResponse buildNetworkTimeoutErrorResponse(


Just for personal preference; as this method is without a state and just a builder, I'd put it static ###

Suggested change

private HttpEventResponse buildNetworkTimeoutErrorResponse(

private static HttpEventResponse buildNetworkTimeoutErrorResponse(

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

aperez-worklytics · 2025-11-05T16:46:52Z

.github/workflows/ci-terraform-modules.yaml

        working-directory: infra/modules/${{ matrix.module.name }}
        run: |
-          terraform test
+          terraform test --var="deployment_bundle=gs://psoxy-public-artifacts/psoxy-0.4.28.zip"


ok, but just for 0.4.28, right ?

* Bump org.apache.httpcomponents.client5:httpclient5 in /java/gateway-core Bumps [org.apache.httpcomponents.client5:httpclient5](https://github.com/apache/httpcomponents-client) from 5.4.1 to 5.4.3. - [Changelog](https://github.com/apache/httpcomponents-client/blob/rel/v5.4.3/RELEASE_NOTES.txt) - [Commits](apache/httpcomponents-client@rel/v5.4.1...rel/v5.4.3) --- updated-dependencies: - dependency-name: org.apache.httpcomponents.client5:httpclient5 dependency-version: 5.4.3 dependency-type: direct:production ... Signed-off-by: dependabot[bot] <support@github.com> * prep v0.5.12 * Salesforce rules refresh (#1039) * Update rules * Support example with POST * bump many dependencies (#1038) * apache commons codec to 1.19.0 * more dep updates * webhook collector auth perf (#1036) * add logic to keep lambdas warm * fix style * init public keys in mem for webhook collectors on start-up * aws replay tool (#1034) * aws replace tool * add documentation * webhook collector output prefix support (#1035) * improve webhook collector mode configuration * support webhook output prefix * fix style * fix path stuff * fix missed rename * fix various test issues * gmail empty header fix (#1040) * deal with empty header case more correctly; that's quite clearly a bug * add test of empty CC case * GCP VPC doc improvements (#1042) * improve GCP vpc docs + conditions * fix style, unrelated * improve error feedback on network connectivity issues * doc that GCP VPC needs external connectivity via router/nat for non-google sources * move validation up to dop * try to skip compile in tests * Apply suggestion from @Copilot Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Apply suggestion from @Copilot Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --------- Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * fix some references to role constants (#1043) * config to deploy packages as mvn libs via GitHub Packages (#1041) * improve OAuth token refresh (#1037) * interface to secret store to get multiple versions of things * refactor how token refreshin works, so potentially more proactive / better re-use * pick most recent token based on expirationDate * cr feedback * fix refactor * remove stray bracket * Update java/core/src/main/java/co/worklytics/psoxy/gateway/impl/oauth/OAuthRefreshTokenSourceAuthStrategy.java Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update java/core/src/main/java/co/worklytics/psoxy/gateway/impl/CompositeConfigService.java Co-authored-by: aperez-worklytics <75276364+aperez-worklytics@users.noreply.github.com> * drop sort on lastAccessDate; only date-level granularity, so why bother --------- Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Co-authored-by: aperez-worklytics <75276364+aperez-worklytics@users.noreply.github.com> * more psoxy constants (#1044) * expose more outputs relevant to gcp-hosted deployments * gcp min perms to host * expose gcp network roles, for completenes * doc gcp vpc roles * doc that Project IAM Admin is required * fix docs * Update infra/modules/psoxy-constants/main.tf Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update infra/modules/psoxy-constants/outputs.tf Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update docs/gcp/vpc.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --------- Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * prep v0.5.12 (#1046) * fix bad comment * try to make sbom stuff more robust * drop mvn plugins that are problematic, see to cause build errors * use reactor build * sboms * fix sbom generation * update package-lock in psoxy-test * fix gcp release artifact script * prompt user if gcp artifact has already been published * prompt user if aws artifact has already been published * warn if we're NOT running in the expected place --------- Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: aperez-worklytics <75276364+aperez-worklytics@users.noreply.github.com> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

eschultink added 5 commits November 3, 2025 12:18

improve GCP vpc docs + conditions

4ac260b

fix style, unrelated

8e5c1e9

improve error feedback on network connectivity issues

af99a90

doc that GCP VPC needs external connectivity via router/nat for non-g…

043cf60

…oogle sources

move validation up to dop

561383b

eschultink requested review from aperez-worklytics, Copilot and jlorper November 4, 2025 17:35

eschultink self-assigned this Nov 4, 2025

Copilot AI reviewed Nov 4, 2025

View reviewed changes

docs/gcp/vpc.md Outdated Show resolved Hide resolved

java/core/src/main/java/co/worklytics/psoxy/gateway/impl/ApiDataRequestHandler.java Outdated Show resolved Hide resolved

try to skip compile in tests

293530a

aperez-worklytics requested changes Nov 4, 2025

View reviewed changes

eschultink and others added 2 commits November 5, 2025 07:38

Apply suggestion from @Copilot

d0ec975

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Apply suggestion from @Copilot

018a21f

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

eschultink requested a review from aperez-worklytics November 5, 2025 15:39

aperez-worklytics approved these changes Nov 5, 2025

View reviewed changes

eschultink merged commit 6e75623 into rc-v0.5.12 Nov 5, 2025
48 checks passed

eschultink deleted the s211-gpc-vpc-docs branch November 5, 2025 18:37

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

GCP VPC doc improvements#1042

GCP VPC doc improvements#1042
eschultink merged 8 commits intorc-v0.5.12from
s211-gpc-vpc-docs

eschultink commented Nov 4, 2025

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

aperez-worklytics left a comment

Uh oh!

aperez-worklytics Nov 4, 2025

Uh oh!

eschultink Nov 5, 2025

Uh oh!

aperez-worklytics Nov 5, 2025

Uh oh!

aperez-worklytics Nov 4, 2025

Uh oh!

aperez-worklytics Nov 5, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

	private HttpEventResponse buildNetworkTimeoutErrorResponse(
	private static HttpEventResponse buildNetworkTimeoutErrorResponse(

Conversation

eschultink commented Nov 4, 2025

Features

Change implications

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

aperez-worklytics left a comment

Choose a reason for hiding this comment

Uh oh!

aperez-worklytics Nov 4, 2025

Choose a reason for hiding this comment

Uh oh!

eschultink Nov 5, 2025

Choose a reason for hiding this comment

Uh oh!

aperez-worklytics Nov 5, 2025

Choose a reason for hiding this comment

Uh oh!

aperez-worklytics Nov 4, 2025

Choose a reason for hiding this comment

Uh oh!

aperez-worklytics Nov 5, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants