Conversation
…c values Co-authored-by: intel352 <77607+intel352@users.noreply.github.com>
…h generic alternatives Replace chimera_app → myapp_user, chimera_backend → myappdb, real-looking RDS cluster hostname with generic alternatives, and MySecretPassword123 with MySecretP@ssword. Update 'Your Specific Use Case' section to generic 'Example Use Case'. Co-authored-by: intel352 <77607+intel352@users.noreply.github.com>
…laceholders Co-authored-by: intel352 <77607+intel352@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
This PR removes realistic-looking database usernames, passwords, and RDS hostnames from the database module documentation/examples by replacing them with generic placeholders, and updates related examples/tests to match the new placeholder values.
Changes:
- Replaced app/environment-specific DB usernames, DB names, and RDS hostnames in database module docs and example YAML.
- Updated database module tests and inline comments to use the new placeholder DSNs/usernames.
- Updated multiple example
go.modfiles to requiregithub.com/GoCodeAlone/modular v1.12.0(plus relatedgo.sumchanges in eventbus examples).
Reviewed changes
Copilot reviewed 17 out of 19 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| modules/database/examples/aws-iam-auth-config.yaml | Replaces realistic-looking IAM auth DSN/user values with generic placeholders. |
| modules/database/credential_refresh_test.go | Updates test DSN fixtures to new placeholder values. |
| modules/database/credential_refresh_store.go | Updates inline comment examples to new placeholder values. |
| modules/database/config.go | Updates IAM DSN comment example to new placeholder username. |
| modules/database/DIAGNOSTICS.md | Replaces realistic-looking DSN/username examples with placeholders in troubleshooting docs. |
| modules/database/AWS_IAM_AUTH.md | Replaces realistic-looking DSN/username/password examples with placeholders and reframes an “Example Use Case” section. |
| examples/testing-scenarios/go.mod | Bumps modular dependency to v1.12.0. |
| examples/reverse-proxy/go.mod | Bumps modular dependency to v1.12.0. |
| examples/observer-pattern/go.mod | Bumps modular dependency to v1.12.0. |
| examples/observer-demo/go.mod | Bumps modular dependency to v1.12.0. |
| examples/http-client/go.mod | Bumps modular dependency to v1.12.0. |
| examples/health-aware-reverse-proxy/go.mod | Bumps modular dependency to v1.12.0. |
| examples/feature-flag-proxy/go.mod | Bumps modular dependency to v1.12.0. |
| examples/advanced-logging/go.mod | Bumps modular dependency to v1.12.0. |
| examples/logmasker-example/go.mod | Bumps modular dependency to v1.12.0. |
| examples/nats-eventbus/go.mod | Bumps modular dependency to v1.12.0; adds indirect modules/eventbus/v2. |
| examples/nats-eventbus/go.sum | Adds sums for indirect modules/eventbus/v2. |
| examples/multi-engine-eventbus/go.mod | Bumps modular dependency to v1.12.0; adds indirect modules/eventbus/v2. |
| examples/multi-engine-eventbus/go.sum | Adds sums for indirect modules/eventbus/v2. |
| require ( | ||
| github.com/BurntSushi/toml v1.6.0 // indirect | ||
| github.com/DataDog/datadog-go/v5 v5.4.0 // indirect | ||
| github.com/GoCodeAlone/modular/modules/eventbus/v2 v2.5.1 // indirect |
There was a problem hiding this comment.
This adds an indirect dependency on github.com/GoCodeAlone/modular/modules/eventbus/v2 alongside the direct requirement on modules/eventbus v1.7.0. If this wasn’t intentional, run go mod tidy to drop the extra major-version module; if it is intentional, please document why v2 is needed in this example.
| github.com/GoCodeAlone/modular/modules/eventbus/v2 v2.5.1 // indirect |
| writer: | ||
| driver: postgres | ||
| dsn: "postgresql://myuser:MySecretPassword123@host.rds.amazonaws.com:5432/mydb" | ||
| dsn: "postgresql://myuser:MySecretP@ssword@host.rds.amazonaws.com:5432/mydb" |
There was a problem hiding this comment.
The example DSN password MySecretP@ssword contains @, which breaks URL-style DSN parsing (the @ is the userinfo/host separator). Use a password without reserved URI characters here, or show it URL-encoded (e.g., %40) so the example DSN is syntactically valid.
| dsn: "postgresql://myuser:MySecretP@ssword@host.rds.amazonaws.com:5432/mydb" | |
| dsn: "postgresql://myuser:MySecretPassword@host.rds.amazonaws.com:5432/mydb" |
| require ( | ||
| github.com/GoCodeAlone/modular v1.11.11 | ||
| github.com/GoCodeAlone/modular v1.12.0 | ||
| github.com/GoCodeAlone/modular/modules/chimux v1.1.0 | ||
| github.com/GoCodeAlone/modular/modules/httpserver v0.1.1 | ||
| github.com/GoCodeAlone/modular/modules/reverseproxy v1.1.0 |
There was a problem hiding this comment.
These example go.mod bumps (v1.11.11 → v1.12.0) are unrelated to the PR’s stated goal (scrubbing realistic-looking DB credentials) and aren’t mentioned in the PR description. Please either remove these dependency/version changes from this PR, or update the PR description and ensure the version updates are intentional and consistent across all examples.
| require ( | ||
| github.com/BurntSushi/toml v1.6.0 // indirect | ||
| github.com/DataDog/datadog-go/v5 v5.4.0 // indirect | ||
| github.com/GoCodeAlone/modular/modules/eventbus/v2 v2.5.1 // indirect |
There was a problem hiding this comment.
This adds an indirect dependency on github.com/GoCodeAlone/modular/modules/eventbus/v2 alongside the direct requirement on modules/eventbus v1.7.0. If this wasn’t intentional, run go mod tidy to drop the extra major-version module; if it is intentional, please add a short note in the PR description explaining why v2 is needed here to avoid confusion about mixed major versions.
| github.com/GoCodeAlone/modular/modules/eventbus/v2 v2.5.1 // indirect |
Documentation and example configs in the database module contained app-specific values (
chimera_app,chimera_backend, a real-looking RDS cluster IDcluster-cbysgk6e0u2x) that appeared to originate from a real environment.Replacements
chimera_appmyapp_userchimera_backendmyappdbshared-chimera-dev-backend.cluster-cbysgk6e0u2x.us-east-1.rds.amazonaws.commydb-instance.cluster-abc123def456.us-east-1.rds.amazonaws.comshared-chimera-dev-backend.cluster-xyz.us-east-1.rds.amazonaws.commydb-instance.cluster-xyz.us-east-1.rds.amazonaws.comMySecretPassword123MySecretP@sswordAlso renamed the "Your Specific Use Case" section to "Example Use Case" and removed the user-directed framing ("You mentioned passing the DSN as:").
Files changed
modules/database/AWS_IAM_AUTH.mdmodules/database/DIAGNOSTICS.mdmodules/database/examples/aws-iam-auth-config.yamlmodules/database/credential_refresh_test.gomodules/database/credential_refresh_store.go(comments)modules/database/config.go(comments)💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.