Azure / Azure/static-web-apps-cli

Route rewrite removes Query Parameters

Open
#930 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
TypeScript
Stars
668
Forks
156
PR merge metrics
No merged PRs in 30d

Description

Before filing this issue, please ensure you're using the latest CLI by running `swa --version` and comparing to the latest version on [npm](https://www.npmjs.com/package/@azure/static-web-apps-cli).

**Are you accessing the CLI from the default port `:4280` ?**

- [ ] No, I am using a different port number (`--port`) and accessing the CLI from that port
- [x] Yes, I am accessing the CLI from port `:4280`

> Make sure you are accessing the URL printed in the console when running `swa start`!

**ℹ️ NOTE: Make sure to enable debug logs when running any `swa` commands using `--verbose=silly`**

**Describe the bug**
When defining a route rewrite in the `staticwebapp.config.json` like this:
```
{
"routes": [
{
"route": "/something",
"rewrite": "/api/something"
}
}
```
The query parameters are not passed to the rewritten route.

**To Reproduce**
Steps to reproduce the behavior:
1. Create a route as described above
2. In the API endpoint `something` log the query parameters from the request
3. Run `npx swa start public --api-location http://localhost:7071`
4. Request `http://localhost:4280/something?key=value`
5. Notice in API logs that no query parameters arrive

**Expected behavior**
The query parameters from the initial request are available in the API.

**Desktop (please complete the following information):**

- OS: Windows
- Version 11

Contributor guide

Open the contributing guide

Research direction

Reproduce the issue using staticwebapp.config.json, `npx swa start public --api-location http://localhost:7071`, and the request to `/something?key=value`; enable `--verbose=silly` logs. Start at the CLI's route rewrite and API forwarding entry points, then verify that the API receives the original query parameter and add coverage for this behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
azure, typescript
Domain
api, cli
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.