Skip to content
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.

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

docs: add guidance on connecting to a remote API host #579

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

Conversation

danwatford
Copy link
Contributor

Depends on #578

@@ -108,7 +118,7 @@ Here are the options you can use with `swa start`:
- `-i, --api-location <path>`: the folder containing the source code of the API application
- `-O, --output-location <path>`: the folder containing the built source of the front-end application. The path is relative to `--app-location` (default: ".")
- `-D, --app-devserver-url <url>`: connect to the app dev server at this URL instead of using output location
- `-is, --api-devserver-url <url>`: connect to the api server at this URL instead of using output location
- `-is, --api-devserver-url <url>`: connect to the api server at this URL instead of using output location. Set `--api-location` to `remote` if using this option.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can't we set this automatically by the cli, or ignore it if the user is connecting to a remote address?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can do. At the time I wanted to keep changes to a minimum in case their was some cases I hadn't realised.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually after testing some other swa-cli bits I realised that specifying an api-devserver-url option is not necessary. I think the bit that confused me was following in cli/commands/start.ts which suggested api-location would be ignored if it didn't resolve to file location, but it was still necessary to specify api-location in order to get apiDevServerUrl checked.

if (apiLocation) {
// resolves to the absolute path of the apiLocation
let resolvedApiLocation = path.resolve(apiLocation);
if (apiDevserverUrl) {
// TODO: properly refactor this after GA to send apiDevserverUrl to the server
useApiDevServer = apiDevserverUrl;
apiLocation = apiDevserverUrl;
}
// make sure api folder exists
else if (fs.existsSync(resolvedApiLocation)) {
apiLocation = resolvedApiLocation;
} else {
logger.info(`Skipping API because folder "${resolvedApiLocation}" is missing`, "swa");
}
}

I now realise that even though a line about the api-location being missing was logged, the api-location was still passed to msha/server so was still accepted.

I'll clean up the example and api-devserver-url option documentation.

What usecases is the api-devserver-url option needed for?

@danwatford danwatford force-pushed the document-remote-api-connection branch from b509d96 to 008b484 Compare October 5, 2022 13:56
sgollapudi77 pushed a commit that referenced this pull request Dec 16, 2022
…579) (#620)

* fix: --api-devserver-url not working if --api-location not set (#523, #579)

* docs: fix documentation regarding --api-devserver-url usage (#579)
sgollapudi77 added a commit that referenced this pull request Dec 19, 2022
commit 02fdb90
Author: Yohan Lasorsa <[email protected]>
Date:   Fri Dec 16 10:09:48 2022 +0100

    fix: --api-devserver-url not working if --api-location not set (#523, #579) (#620)

    * fix: --api-devserver-url not working if --api-location not set (#523, #579)

    * docs: fix documentation regarding --api-devserver-url usage (#579)

commit 7ecbae2
Author: Reshmi Sriram <[email protected]>
Date:   Thu Dec 15 13:10:12 2022 +0530

    docs: Add firewall section to troubleshoot (#618)

    * Added firewall section

    * updated the message

commit eee1263
Author: BeardinaSuit <[email protected]>
Date:   Sun Dec 11 23:54:32 2022 -0500

    fix: handle new provider name when deploying (#617)

commit 27ec687
Author: Stuart Leeks <[email protected]>
Date:   Tue Dec 6 09:40:07 2022 +0000

    Fix typo (#605)

    fix: typo in CONTRIBUTING.md

commit 9c43aa8
Author: Stuart Leeks <[email protected]>
Date:   Tue Dec 6 09:38:51 2022 +0000

    Update title (#606)

    docs: In the doc content this is referred to as the "configuration file" and this feels like a more natural title

commit 97e9461
Merge: 08ac26c ac6909a
Author: Rupa Reddy <[email protected]>
Date:   Tue Dec 6 13:06:18 2022 +0530

    Merge pull request #614 from Azure/origin/rupareddy/LoginCC

    fix(login): fixed short-form of --clear-credentials flag

commit 08ac26c
Merge: 2cd0e98 6d1ad19
Author: Rupa Reddy <[email protected]>
Date:   Tue Dec 6 12:59:29 2022 +0530

    Merge pull request #613 from Azure/origin/rupareddy/FixRGName

    fix(deploy): create SWA in user-provided Resource Group

commit 6d1ad19
Author: rupareddy5 <[email protected]>
Date:   Mon Dec 5 14:57:37 2022 +0530

    fix: to fix the inability to create a SWA in user-mentioned resource group, changed all the resourceGroupName references to resourceGroup in the code to match with --resource-group flag.

commit ac6909a
Author: rupareddy5 <[email protected]>
Date:   Mon Dec 5 13:34:00 2022 +0530

    fixed short-form of --clear-credentials flag

commit ca856be
Author: rupareddy5 <[email protected]>
Date:   Fri Dec 2 16:17:38 2022 +0530

    create SWA in user-provided Resource Group

commit 2cd0e98
Author: sgollapudi77 <[email protected]>
Date:   Wed Nov 9 11:32:46 2022 +0530

    chore: upgrade dependency version to fix security vulnerability (#597)

    * chore: upgrade dependency version to fix security vulnerability

    * chore: upgrade integrity of package

commit 3bdc5f1
Author: sgollapudi77 <[email protected]>
Date:   Sun Oct 9 16:34:22 2022 +0530

    chore: bump into 1.0.4-alpha after release (#586)

commit 5ab32a7
Merge: b4fbf3a a6f08e3
Author: Sulabh Upadhyay <[email protected]>
Date:   Fri Oct 7 14:15:35 2022 +0530

    Merge pull request #585 from Azure/all-contributors/add-rupareddy5-21

    docs: add rupareddy5-21 as a contributor for code

commit a6f08e3
Author: allcontributors[bot] <46447321+allcontributors[bot]@users.noreply.github.com>
Date:   Fri Oct 7 08:20:26 2022 +0000

    docs: update .all-contributorsrc

commit b461129
Author: allcontributors[bot] <46447321+allcontributors[bot]@users.noreply.github.com>
Date:   Fri Oct 7 08:20:25 2022 +0000

    docs: update docs/www/docs/contribute/3-contributors.md

commit b4fbf3a
Author: sgollapudi77 <[email protected]>
Date:   Fri Oct 7 12:51:28 2022 +0530

    ci: Remove Node 12 from the testing matrix (#584)

commit 4b0114b
Author: sgollapudi77 <[email protected]>
Date:   Fri Oct 7 12:01:04 2022 +0530

    chore: prep-release 1.0.3 (#583)

commit 4af9624
Author: Wassim Chegham <[email protected]>
Date:   Fri Oct 7 07:30:23 2022 +0200

    docs: update troubleshooting with explainer #576 (#581)

commit 70c126e
Author: Wassim Chegham <[email protected]>
Date:   Fri Oct 7 07:30:03 2022 +0200

    docs: add valid azure regions for SWA (#582)

    * docs: add valid azure regions for SWA

    * docs: update azure regions

commit 6004141
Author: Wassim Chegham <[email protected]>
Date:   Thu Oct 6 08:52:36 2022 +0200

    fix(core): match * glob in routes (#574)

    Fixes #569

commit d24df7a
Author: Aaron Powell <[email protected]>
Date:   Thu Oct 6 17:51:46 2022 +1100

    fix(api): bumping the node support to 18 for v4 functions (#564)

commit 1fec77e
Merge: 19c619b 2771906
Author: Rupa Reddy <[email protected]>
Date:   Thu Oct 6 11:38:36 2022 +0530

    Merge pull request #577 from rupareddy5-21/main

    Updating deployment provider

commit 2771906
Author: Rupa Reddy <[email protected]>
Date:   Thu Sep 29 16:34:22 2022 +0530

    Updating Deployment provider

commit 1b7fabd
Author: Rupa Reddy <[email protected]>
Date:   Thu Sep 29 16:33:02 2022 +0530

    updating Deployment provider

commit 19c619b
Author: Natalia Venditto <[email protected]>
Date:   Mon Sep 26 15:13:12 2022 +0200

    docs: add default port for vite-based frameworks (#571)

commit 47823b0
Merge: 06356c1 7e021c7
Author: Sulabh Upadhyay <[email protected]>
Date:   Fri Sep 16 15:05:06 2022 +0530

    Merge pull request #560 from Azure/swa-start-perf-boost

    fix(start): keep connection open with http-proxy

commit 06356c1
Author: allcontributors[bot] <46447321+allcontributors[bot]@users.noreply.github.com>
Date:   Wed Sep 14 23:10:22 2022 +0530

    docs: add thsackos as a contributor (#561)

    * docs: update docs/www/docs/contribute/3-contributors.md

    * docs: update .all-contributorsrc

    Co-authored-by: allcontributors[bot] <46447321+allcontributors[bot]@users.noreply.github.com>

commit 8b7d725
Author: thsackos <[email protected]>
Date:   Wed Sep 14 06:13:25 2022 -0700

    fix(cli): implement missing response override referrer behavior (#543)

    The documentation calls out user-defined redirect behavior using the
    .referrer parameter in the response override configuration. This PR
    enables the SWA CLI emulator to support that functionality.

    Fixes #542

commit 7e021c7
Author: Wassim Chegham <[email protected]>
Date:   Wed Sep 14 12:19:03 2022 +0200

    fix(start): keep connection open with http-proxy
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants