feat: getActionPath() by florian-lefebvre · Pull Request #10353 · withastro/docs

florian-lefebvre · 2024-12-12T17:34:35Z

Description (required)

Documents a new getActionPath() helper

Related issues & labels (optional)

Closes #
Suggested label:

netlify · 2024-12-12T17:34:53Z

✅ Deploy Preview for astro-docs-2 ready!

Name	Link
🔨 Latest commit	`077d84f`
🔍 Latest deploy log	https://app.netlify.com/sites/astro-docs-2/deploys/6762d9063725fc0008561b3e
😎 Deploy Preview	https://deploy-preview-10353--astro-docs-2.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

astrobot-houston · 2024-12-12T17:35:00Z

Lunaria Status Overview

🌕 This pull request will trigger status changes.

Learn more

By default, every PR changing files present in the Lunaria configuration's files property will be considered and trigger status changes accordingly.

You can change this by adding one of the keywords present in the ignoreKeywords property in your Lunaria configuration file in the PR's title (ignoring all files) or by including a tracker directive in the merged commit's description.

Tracked Files

File	Note
en/reference/modules/astro-actions.mdx	Source changed, localizations will be marked as outdated.

Warnings reference

Icon	Description
🔄️	The source for this localization has been updated since the creation of this pull request, make sure all changes in the source have been applied.

sarah11918

Thanks @florian-lefebvre ! I left some questions below to help tease out exactly what's happening.

sarah11918 · 2024-12-12T22:37:10Z

+
+The `getActionPath()` utility is used to get the path to an action, taking base and trailing slash settings into account. This is useful when you want to call an action for more advanced usages, such as providing custom headers or not using the fetch API (eg. `navigator.sendBeacon`):
+
+```ts


Can we have a "this example shows..." and then describe what is happening here?

Is it worth showing 2 examples? Eg. one using the fetch API and one using the navigator.sendBeacon API

sarah11918 · 2024-12-12T22:46:29Z

+```ts
+import { actions, getActionPath } from 'astro:actions'
+
+const path = getActionPath(actions.like) // '/_actions/like'


I'm not sure what the commented part is representing. Is that what is returned by getActionPath(actions.like)?

How is the example different using getActionPath(actions.like) vs just actions.like. You mention that often you can just use the action. What is happening here that we're benefiting from using getActionPath() or that wouldn't otherwise be possible?

I'm not sure what the commented part is representing. Is that what is returned by getActionPath(actions.like)?

Yes!

How is the example different using getActionPath(actions.like) vs just actions.like. You mention that often you can just use the action. What is happening here that we're benefiting from using getActionPath() or that wouldn't otherwise be possible?

See the keepalive option. I guess it's not clear enough tho, so i'll probably use an example with sendBeacon instead

See the keepalive option. I guess it's not clear enough tho, so i'll probably use an example with sendBeacon instead

Never answer a question with an example! 😄 I need to know, in your words, what is happening so that I can help make them into docs words! You can never assume that someone will get which part of an example is important, or what exactly you're trying to show. Your example might be fine as an illustration! But it's not docs and not an answer to my specific question "How is this example different using getActionPath than not using it?"

Ha I see (I think)!

How is this example different using getActionPath than not using it?

Calling an action directly does the following under the hood:

await fetch(someInternalPathLogic, { method: 'POST', headers: { 'Content-Type': 'application/json', }, })

This is internal, which means you can't pass custom headers (eg. you want to protect your actions with a auth header) nor custom options (eg. keepalive which prevents the request from being killed).

Does that help?

That is very helpful, thank you!

sarah11918

ugh, so sorry I didn't realize these comments were pending!

sarah11918 · 2024-12-13T12:49:55Z

+```ts
+import { actions, getActionPath } from 'astro:actions'
+
+const path = getActionPath(actions.like) // '/_actions/like'


See the keepalive option. I guess it's not clear enough tho, so i'll probably use an example with sendBeacon instead

Never answer a question with an example! 😄 I need to know, in your words, what is happening so that I can help make them into docs words! You can never assume that someone will get which part of an example is important, or what exactly you're trying to show. Your example might be fine as an illustration! But it's not docs and not an answer to my specific question "How is this example different using getActionPath than not using it?"

florian-lefebvre

Gotta say I'm struggling to answer correctly your reviews 😄

florian-lefebvre · 2024-12-16T15:48:38Z

+```ts
+import { actions, getActionPath } from 'astro:actions'
+
+const path = getActionPath(actions.like) // '/_actions/like'


Ha I see (I think)!

How is this example different using getActionPath than not using it?

Calling an action directly does the following under the hood:

await fetch(someInternalPathLogic, { method: 'POST', headers: { 'Content-Type': 'application/json', }, })

This is internal, which means you can't pass custom headers (eg. you want to protect your actions with a auth header) nor custom options (eg. keepalive which prevents the request from being killed).

Does that help?

sarah11918 · 2024-12-16T16:00:25Z

Gotta say I'm struggling to answer correctly your reviews 😄

Then they must be the right reviews! 😅

sarah11918 · 2024-12-16T16:29:59Z

So last thing worth mentioning is we no longer mention taking base and trailing slash into account, but I'm wondering whether we have to? That could be "true but not particularly helpful to know" in this context? I mean, you get "the URL path you need for your project" and maybe that's enough? Thoughts?

Co-authored-by: Sarah Rainsberger <5098874+sarah11918@users.noreply.github.com>

florian-lefebvre · 2024-12-16T20:47:34Z

last thing worth mentioning is we no longer mention taking base and trailing slash into account, but I'm wondering whether we have to? That could be "true but not particularly helpful to know" in this context? I mean, you get "the URL path you need for your project" and maybe that's enough? Thoughts?

"The URL path you need for your project" sounds more useful to me, people usually expect trailing slash and base to be taken into account

Co-authored-by: Sarah Rainsberger <5098874+sarah11918@users.noreply.github.com>

sarah11918

I am really hating GitHub's interface. Here is my stupid review for my stupid pending comment lol. Otherwise, this PR is good to go! 😅

Co-authored-by: Sarah Rainsberger <5098874+sarah11918@users.noreply.github.com>

sarah11918

Amazing, good to go @florian-lefebvre ! 🥳

feat: getActionPath()

507d2ff

florian-lefebvre mentioned this pull request Dec 12, 2024

feat(actions): getActionPath() withastro/astro#12721

Merged

sarah11918 reviewed Dec 12, 2024

View reviewed changes

sarah11918 added this to the 5.1.0 milestone Dec 16, 2024

sarah11918 reviewed Dec 16, 2024

View reviewed changes

florian-lefebvre commented Dec 16, 2024

View reviewed changes

florian-lefebvre added 3 commits December 16, 2024 17:22

Update astro-actions.mdx

7cebba3

Update astro-actions.mdx

1d70f6e

Update astro-actions.mdx

ec03f85

florian-lefebvre requested a review from sarah11918 December 16, 2024 16:23

sarah11918 reviewed Dec 16, 2024

View reviewed changes

Comment thread src/content/docs/en/reference/modules/astro-actions.mdx Outdated

sarah11918 reviewed Dec 16, 2024

View reviewed changes

Comment thread src/content/docs/en/reference/modules/astro-actions.mdx Outdated

sarah11918 reviewed Dec 16, 2024

View reviewed changes

Comment thread src/content/docs/en/reference/modules/astro-actions.mdx Outdated

florian-lefebvre and others added 3 commits December 16, 2024 17:57

Update src/content/docs/en/reference/modules/astro-actions.mdx

638f48c

Co-authored-by: Sarah Rainsberger <5098874+sarah11918@users.noreply.github.com>

Update src/content/docs/en/reference/modules/astro-actions.mdx

d62131f

Co-authored-by: Sarah Rainsberger <5098874+sarah11918@users.noreply.github.com>

Update astro-actions.mdx

03af0ed

florian-lefebvre commented Dec 17, 2024

View reviewed changes

Comment thread src/content/docs/en/reference/modules/astro-actions.mdx Outdated

Update src/content/docs/en/reference/modules/astro-actions.mdx

44057ff

florian-lefebvre requested a review from sarah11918 December 17, 2024 11:19

sarah11918 reviewed Dec 17, 2024

View reviewed changes

Comment thread src/content/docs/en/reference/modules/astro-actions.mdx Outdated

sarah11918 reviewed Dec 17, 2024

View reviewed changes

Comment thread src/content/docs/en/reference/modules/astro-actions.mdx

Update src/content/docs/en/reference/modules/astro-actions.mdx

70b57c1

Co-authored-by: Sarah Rainsberger <5098874+sarah11918@users.noreply.github.com>

florian-lefebvre requested a review from sarah11918 December 17, 2024 15:42

sarah11918 approved these changes Dec 17, 2024

View reviewed changes

Comment thread src/content/docs/en/reference/modules/astro-actions.mdx Outdated

Update src/content/docs/en/reference/modules/astro-actions.mdx

aadd2db

Co-authored-by: Sarah Rainsberger <5098874+sarah11918@users.noreply.github.com>

florian-lefebvre commented Dec 18, 2024

View reviewed changes

Comment thread src/content/docs/en/reference/modules/astro-actions.mdx

sarah11918 reviewed Dec 18, 2024

View reviewed changes

Comment thread src/content/docs/en/reference/modules/astro-actions.mdx Outdated

florian-lefebvre and others added 2 commits December 18, 2024 15:14

Update src/content/docs/en/reference/modules/astro-actions.mdx

83dba95

Co-authored-by: Sarah Rainsberger <5098874+sarah11918@users.noreply.github.com>

Merge branch 'main' into feat/get-action-path

077d84f

sarah11918 changed the base branch from main to 5.1.0 December 18, 2024 14:22

sarah11918 approved these changes Dec 18, 2024

View reviewed changes

sarah11918 added the Merge Queue Approved and ready to be merged (wait for feature release if also labelled M-O-R)! label Dec 18, 2024

sarah11918 reviewed Dec 18, 2024

View reviewed changes

Comment thread src/content/docs/en/reference/modules/astro-actions.mdx Outdated

fix link format

2ef5f09

sarah11918 merged commit 29fbeb6 into 5.1.0 Dec 18, 2024

sarah11918 deleted the feat/get-action-path branch December 18, 2024 15:09

sarah11918 mentioned this pull request Dec 18, 2024

5.1.0 Minor Docs #10447

Merged


		The `getActionPath()` utility is used to get the path to an action, taking base and trailing slash settings into account. This is useful when you want to call an action for more advanced usages, such as providing custom headers or not using the fetch API (eg. `navigator.sendBeacon`):

		```ts

Uh oh!

Conversation

florian-lefebvre commented Dec 12, 2024

Description (required)

Related issues & labels (optional)

Uh oh!

netlify Bot commented Dec 12, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for astro-docs-2 ready!

Uh oh!

astrobot-houston commented Dec 12, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Lunaria Status Overview

Tracked Files

Uh oh!

sarah11918 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

sarah11918 Dec 12, 2024

Choose a reason for hiding this comment

Uh oh!

florian-lefebvre Dec 16, 2024

Choose a reason for hiding this comment

Uh oh!

sarah11918 Dec 12, 2024

Choose a reason for hiding this comment

Uh oh!

florian-lefebvre Dec 13, 2024

Choose a reason for hiding this comment

Uh oh!

sarah11918 Dec 13, 2024

Choose a reason for hiding this comment

Uh oh!

florian-lefebvre Dec 16, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sarah11918 Dec 16, 2024

Choose a reason for hiding this comment

Uh oh!

sarah11918 left a comment

Choose a reason for hiding this comment

Uh oh!

sarah11918 Dec 13, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

florian-lefebvre left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

florian-lefebvre Dec 16, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sarah11918 commented Dec 16, 2024

Uh oh!

Uh oh!

Uh oh!

Uh oh!

sarah11918 commented Dec 16, 2024

Uh oh!

florian-lefebvre commented Dec 16, 2024

Uh oh!

Uh oh!

Uh oh!

Uh oh!

sarah11918 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

sarah11918 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

netlify Bot commented Dec 12, 2024 •

edited

Loading

astrobot-houston commented Dec 12, 2024 •

edited

Loading

florian-lefebvre Dec 16, 2024 •

edited

Loading

florian-lefebvre Dec 16, 2024 •

edited

Loading