feat: container APIs #11051
Merged
feat: container APIs #11051
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
🦋 Changeset detectedLatest commit: 239a41c The changes in this PR will be included in the next version bump. Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
github-actions
bot
added
pkg: example
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
|
!preview container |
|
Snapshots have been released for the following packages:
Publish LogBuild Log |
Princesseuh
reviewed
May 15, 2024
Princesseuh
reviewed
May 15, 2024
| * | ||
| * | ||
| * @param {AstroComponentFactory} component The instance of the component. | ||
| * @param {ContainerRenderOptions=} options Possible options to pass when rendering the component. |
There was a problem hiding this comment.
What's this = at the end of the type? Saw it in a few places
There was a problem hiding this comment.
With TSDoc, we should also be able to remove the type altogether so we don't have to declare it in two places.
There was a problem hiding this comment.
@Princesseuh It's a JSDoc thing to mark a @param as optional
matthewp
reviewed
May 15, 2024
matthewp
reviewed
May 15, 2024
matthewp
reviewed
May 15, 2024
matthewp
reviewed
May 15, 2024
matthewp
reviewed
May 15, 2024
ematipico
force-pushed
the
feat/container-api
branch
from
48e2cfd
to
ed9a2be
Compare
sarah11918
reviewed
May 17, 2024
| "test": "vitest run" | ||
| }, | ||
| "dependencies": { | ||
| "astro": "experimental--container", |
There was a problem hiding this comment.
Just want to check on this. Will this be the "version" of Astro to use for this starter when 4.9 is out? But, it's not an experimental flag people have to enable in config?
There was a problem hiding this comment.
This is required for the time being, otherwise astro check will fail, which is run in our CI. We will change this straight after we will release v4.9
| */ | ||
| params?: Record<string, string | undefined>; | ||
| /** | ||
| * Useful if your component needs to access some locals without the use a middleware. |
There was a problem hiding this comment.
Just a quick note here that I did some editing of descriptions for these in the Container API page PR for docs. These could always be revisited after that is finalized, and/or these could have links to docs (not sure what the proper/usual M.O. is here with these code comments as I don't usually edit them).
But, I have made some suggestions in the docs PR itself for these!
Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca>
sarah11918
approved these changes
May 18, 2024
matthewp
reviewed
May 20, 2024
|
|
||
| componentMetadata(_routeData: RouteData): Promise<SSRResult['componentMetadata']> | void {} | ||
|
|
||
| headElements(routeData: RouteData): Promise<HeadElements> | HeadElements { |
There was a problem hiding this comment.
What is this function used for?
There was a problem hiding this comment.
Ok, I see now that this is called when the render context is created.
There was a problem hiding this comment.
I used some code we already use in dev/build/ssr. We will probably need to review it in case it causes bugs.
matthewp
approved these changes
May 20, 2024
Princesseuh
approved these changes
May 21, 2024
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Changes
Relative RFC: withastro/roadmap#916 (this RFC will be soon updated based on the APIs and options crafted in this PR)
As for now, we publicly expose the following methods:
create: creates a new instance of the containerrenderToString: renders a component to stringrenderToResponse: returns the response emitted by the rendering phaseThe methods
insertRouteandcreateFromManifestwere left private using TS on purpose because I still want them available so I can still play with them without breaking the compatibility with end users.The goal is to provide, for now, the ability to test components with
vitest. This would allow us to quickly release the APIs and receive feedback.Testing
Added unit tests and example tests
Docs
withastro/docs#8281
/cc @withastro/maintainers-docs for feedback!