Skip to content

Update design for PR #3047: feat(checkout): EU refund window (30 min) #13

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

Open
gauravagerwala wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update design for PR #3047: feat(checkout): EU refund window (30 min) #13

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 30 additions & 0 deletions pr-analysis-3047.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# PR #3047: Workflow Design Impact Analysis

## Affected Workflows
None of the workflows defined in `.exp/workflows.json` are impacted by the changes in this PR.

Justification:
- The PR introduces a new feature in the checkoutservice for handling EU refund windows (30 minutes), including a policy configuration file (`src/checkoutservice/policy/capsule.yaml`), a new contract document (`docs/contracts/checkout/refund.yaml`), a requirement document (`docs/requirements/req-eu-refund-30m.md`), and updates to GitHub Actions CI (` .github/workflows/ci.yml`) to include minimal tests for checkoutservice.
- While these changes affect the internal logic and testing of the checkoutservice, they do not modify the build processes (e.g., Docker image construction includes the new policy file automatically), deployment manifests, or steps in the defined workflows such as local development, GKE deployment, Helm, Kustomize, Terraform, Cloud Build, release, or adding new microservices.
- The new GitHub CI workflow is outside the scope of the defined workflows, which focus on Skaffold, Helm, Kustomize, etc., and Cloud Build for CI/CD.
- Design documents in `.exp/` do not reference checkoutservice-specific logic, policies, or GitHub CI, confirming no impact on workflow designs or Mermaid diagrams.

## Summary of PR Changes
This PR adds support for an EU-specific refund policy with a 30-minute window in the checkout process, fulfilling requirement `req://checkout/refund-window/v1`.

### Key Changes:
- **Code and Configuration**: Added `policy/capsule.yaml` in checkoutservice source, likely defining rules for refund eligibility based on time windows. This file is included in the Docker image build via existing `COPY . .` in Dockerfile, so no manifest changes needed.
- **Documentation**:
- `docs/contracts/checkout/refund.yaml`: Defines the API or data contract for refund operations.
- `docs/requirements/req-eu-refund-30m.md`: Details the functional requirement for the 30-minute refund window.
- **CI/CD**: Updated `.github/workflows/ci.yml` to include basic tests for checkoutservice, enabling automated testing on PRs via GitHub Actions.
- **Commits**:
- `1c62b375`: Adds minimal tests to CI for checkoutservice.
- `4db895e2`: Seeds intent and policy configurations for the EU refund feature.

### Implications:
- **Benefits**: Improves compliance with EU regulations by enforcing refund windows, adds test coverage for checkoutservice (previously possibly untested in CI), and documents the feature for maintainability.
- **No Design Changes**: No alterations to workflow sequences, components, or interactions in the documented designs. Deployment workflows remain unchanged; the feature is transparent to them.
- **Potential Future Impacts**: If the policy requires runtime configuration (e.g., ConfigMap mount) or affects other services, future PRs might need manifest updates, potentially impacting deployment workflows.

No Mermaid diagrams require updates, and no changes to `.exp/` documents are necessary.
Loading