Skip to content

chore: add readme for OAuth module #6335

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
Sep 15, 2025
Merged

chore: add readme for OAuth module #6335

merged 1 commit into from
Sep 15, 2025

Conversation

ItsSudip
Copy link
Member

Description

This PR adds comprehensive documentation for the OAuth module located at services/oauth/ in the form of a README.md file. The documentation covers:

  • Module overview and purpose
  • Architecture and component breakdown
  • Request lifecycle for both OAuth and non-OAuth destinations
  • Control Plane contracts and API endpoints
  • Configuration options and environment variables
  • Public APIs and extension points
  • Usage examples and code snippets
  • Observability and metrics information
  • Troubleshooting guidelines
  • Maintenance notes

Linear Ticket

https://linear.app/rudderstack/issue/INT-4124/create-readme-for-oauth-module-in-rudder-server

Security

  • The code changed/added as part of this pull request won't create any security issues with how the software is being used.

@codecov Codecov
Copy link

codecov bot commented Sep 11, 2025 •
edited
Loading

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 77.52%. Comparing base (077b0fb) to head (4b0518e).
⚠️ Report is 3 commits behind head on master.

Additional details and impacted files 
@@            Coverage Diff             @@
##           master    #6335      +/-   ##
==========================================
- Coverage   77.60%   77.52%   -0.08%     
==========================================
  Files         523      523              
  Lines       70252    70252              
==========================================
- Hits        54522    54466      -56     
- Misses      12910    12946      +36     
- Partials     2820     2840      +20

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@ItsSudip ItsSudip force-pushed the chore/addOAuthReadME branch from ad5144f to 4b0518e Compare September 12, 2025 09:15
@ItsSudip ItsSudip enabled auto-merge (squash) September 12, 2025 09:58
@ItsSudip ItsSudip merged commit 3c9f251 into master Sep 15, 2025
61 checks passed
@ItsSudip ItsSudip deleted the chore/addOAuthReadME branch September 15, 2025 10:50
This was referenced Sep 15, 2025
Merged
Merged
satishrudderstack pushed a commit that referenced this pull request Sep 15, 2025
@devops-github-rudderstack
chore: prerelease 1.59.0-rc.1 (#6348)
b431bf4 
🤖 I have created a release *beep* *boop*
---


##
[1.59.0-rc.1](v1.58.0...v1.59.0-rc.1)
(2025-09-15)


### Features

* **router:** add request latency and count metrics for router
deliveries
([#6288](#6288))
([c8dd8ef](c8dd8ef))


### Bug Fixes

* avoid running migrations for notifier from slaves
([#6303](#6303))
([761eb46](761eb46))
* **batchrouter:** support configurable column ordering in CSVs in sftp
([#6342](#6342))
([652215b](652215b))
* populate table level schemas createdAt updatedAt
([#6344](#6344))
([a76a509](a76a509))
* remove unwanted table level schemas
([#6296](#6296))
([761eb46](761eb46))
* **router:** kinesis rate exceeded errors are being aborted with http
400 ([#6329](#6329))
([f739d7f](f739d7f))
* update ID regex to include underscores in error cleanup
([#6315](#6315))
([bc1a751](bc1a751))


### Miscellaneous

* add logs for events coming with an incorrect source and sourceRunId
([#6309](#6309))
([17afa60](17afa60))
* add readme for OAuth module
([#6335](#6335))
([3c9f251](3c9f251))
* bump go-kit
([#6321](#6321))
([87499e0](87499e0))
* bump mvdan.cc/gofumpt to v0.9.1
([#6328](#6328))
([cf9f653](cf9f653))
* capture stats for failed transformer client requests
([#6300](#6300))
([e10d5c1](e10d5c1))
* clean up legacy MTU logic
([#6314](#6314))
([a2e753d](a2e753d))
* clean up logs to trace double-encoded HLL value issue
([#6310](#6310))
([c707aea](c707aea))
* drop unused services/oauth v1 and minor v2 tidy-ups
([#6275](#6275))
([c1b84c1](c1b84c1))
* improve googlesheets oauth flow and error handling
([#6340](#6340))
([738d420](738d420))
* optimize dtransform payloads and have compaction always enabled
([#6331](#6331))
([63af856](63af856))
* remove proc_error jobsdb
([#6287](#6287))
([5b92665](5b92665))
* renaming mirroring modes
([#6325](#6325))
([84687fb](84687fb))
* **router:** ignore throttling costs in pickup throttler
([#6316](#6316))
([af85b92](af85b92))
* sync release v1.58.0 to main branch
([#6294](#6294))
([565630e](565630e))
* unify adaptive and static throttling configuration
([#6327](#6327))
([077b0fb](077b0fb))
* update rudderlabs/build-scan-push-action to 1.7.0
([#6320](#6320))
([edb02d3](edb02d3))
* updating keydb client
([#6301](#6301))
([0f9e3ec](0f9e3ec))

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).
satishrudderstack pushed a commit that referenced this pull request Sep 16, 2025
@devops-github-rudderstack
chore: release 1.59.0 (#6347)
ffba3b8 
🤖 I have created a release *beep* *boop*
---


##
[1.59.0](v1.58.0...v1.59.0)
(2025-09-15)


### Features

* **router:** add request latency and count metrics for router
deliveries
([#6288](#6288))
([c8dd8ef](c8dd8ef))


### Bug Fixes

* avoid running migrations for notifier from slaves
([#6303](#6303))
([761eb46](761eb46))
* **batchrouter:** support configurable column ordering in CSVs in sftp
([#6342](#6342))
([652215b](652215b))
* populate table level schemas createdAt updatedAt
([#6344](#6344))
([a76a509](a76a509))
* remove unwanted table level schemas
([#6296](#6296))
([761eb46](761eb46))
* **router:** kinesis rate exceeded errors are being aborted with http
400 ([#6329](#6329))
([f739d7f](f739d7f))
* update ID regex to include underscores in error cleanup
([#6315](#6315))
([bc1a751](bc1a751))


### Miscellaneous

* add logs for events coming with an incorrect source and sourceRunId
([#6309](#6309))
([17afa60](17afa60))
* add readme for OAuth module
([#6335](#6335))
([3c9f251](3c9f251))
* bump go-kit
([#6321](#6321))
([87499e0](87499e0))
* bump mvdan.cc/gofumpt to v0.9.1
([#6328](#6328))
([cf9f653](cf9f653))
* capture stats for failed transformer client requests
([#6300](#6300))
([e10d5c1](e10d5c1))
* clean up legacy MTU logic
([#6314](#6314))
([a2e753d](a2e753d))
* clean up logs to trace double-encoded HLL value issue
([#6310](#6310))
([c707aea](c707aea))
* drop unused services/oauth v1 and minor v2 tidy-ups
([#6275](#6275))
([c1b84c1](c1b84c1))
* improve googlesheets oauth flow and error handling
([#6340](#6340))
([738d420](738d420))
* optimize dtransform payloads and have compaction always enabled
([#6331](#6331))
([63af856](63af856))
* remove proc_error jobsdb
([#6287](#6287))
([5b92665](5b92665))
* renaming mirroring modes
([#6325](#6325))
([84687fb](84687fb))
* **router:** ignore throttling costs in pickup throttler
([#6316](#6316))
([af85b92](af85b92))
* sync release v1.58.0 to main branch
([#6294](#6294))
([565630e](565630e))
* unify adaptive and static throttling configuration
([#6327](#6327))
([077b0fb](077b0fb))
* update rudderlabs/build-scan-push-action to 1.7.0
([#6320](#6320))
([edb02d3](edb02d3))
* updating keydb client
([#6301](#6301))
([0f9e3ec](0f9e3ec))

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@utsabc utsabc utsabc approved these changes

@koladilip koladilip koladilip approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@ItsSudip @utsabc @koladilip