Infrastructure/astro
0
Fork 0
mirror of https://github.com/withastro/astro.git synced 2024-12-16 21:46:22 -05:00
Code Issues Activity

[ci] format

Browse source
This commit is contained in:
Emanuele Stoppa 2024-05-22 11:12:30 +00:00 committed by astrobot-houston
parent 12a1bccc81
commit b15949f8fa
8 changed files with 85 additions and 79 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
examples/container-with-vitest/src/components/Card.astro
View file

@ -1,6 +1,7 @@
---
---
<div>
This is a card
<slot />

28
examples/container-with-vitest/src/pages/[locale].astro
View file

@ -1,22 +1,20 @@
---
export function getStaticPaths() {
return [
{params: {locale: 'en'}},
];
return [{ params: { locale: 'en' } }];
}
const { locale } = Astro.params
const { locale } = Astro.params;
---
<html lang="en">
<head>
<meta charset="utf-8" />
<link rel="icon" type="image/svg+xml" href="/favicon.svg" />
<meta name="viewport" content="width=device-width" />
<meta name="generator" content={Astro.generator} />
<title>Astro</title>
</head>
<body>
<h1>Astro</h1>
<p>Locale: {locale}</p>
</body>
<head>
<meta charset="utf-8" />
<link rel="icon" type="image/svg+xml" href="/favicon.svg" />
<meta name="viewport" content="width=device-width" />
<meta name="generator" content={Astro.generator} />
<title>Astro</title>
</head>
<body>
<h1>Astro</h1>
<p>Locale: {locale}</p>
</body>
</html>

8
examples/container-with-vitest/test/ReactWrapper.test.ts
View file

@ -7,10 +7,10 @@ test('ReactWrapper with react renderer', async () => {
renderers: [
{
name: '@astrojs/react',
clientEntrypoint: "@astrojs/react/client.js",
serverEntrypoint: "@astrojs/react/server.js",
}
]
clientEntrypoint: '@astrojs/react/client.js',
serverEntrypoint: '@astrojs/react/server.js',
},
],
});
const result = await container.renderToString(ReactWrapper);

2
examples/container-with-vitest/test/[locale].test.ts
View file

@ -7,7 +7,7 @@ test('Dynamic route', async () => {
// @ts-ignore
const result = await container.renderToString(Locale, {
params: {
"locale": 'en'
locale: 'en',
},
request: new Request('http://example.com/en'),
});

4
packages/astro/src/@types/astro.ts
View file

@ -819,7 +819,7 @@ export interface AstroUserConfig {
checkOrigin?: boolean;
};
/**
* @docs
* @name vite
@ -1996,7 +1996,7 @@ export interface AstroUserConfig {
* In the event of route collisions, where two routes of equal route priority attempt to build the same URL, Astro will log a warning identifying the conflicting routes.
*/
globalRoutePriority?: boolean;
/**
* @docs
* @name experimental.rewriting

104
packages/astro/src/container/index.ts
View file

@ -1,4 +1,7 @@
import { posix } from 'node:path';
import type {
AstroRenderer,
AstroUserConfig,
ComponentInstance,
MiddlewareHandler,
RouteData,
@ -6,19 +9,16 @@ import type {
SSRLoadedRenderer,
SSRManifest,
SSRResult,
AstroUserConfig,
AstroRenderer,
} from '../@types/astro.js';
import { ContainerPipeline } from './pipeline.js';
import { Logger } from '../core/logger/core.js';
import { nodeLogDestination } from '../core/logger/node.js';
import { validateConfig } from '../core/config/config.js';
import { ASTRO_CONFIG_DEFAULTS } from '../core/config/schema.js';
import { RenderContext } from '../core/render-context.js';
import { posix } from 'node:path';
import { getParts, getPattern, validateSegment } from '../core/routing/manifest/create.js';
import { Logger } from '../core/logger/core.js';
import { nodeLogDestination } from '../core/logger/node.js';
import { removeLeadingForwardSlash } from '../core/path.js';
import type {AstroComponentFactory} from "../runtime/server/index.js";
import { RenderContext } from '../core/render-context.js';
import { getParts, getPattern, validateSegment } from '../core/routing/manifest/create.js';
import type { AstroComponentFactory } from '../runtime/server/index.js';
import { ContainerPipeline } from './pipeline.js';
/**
* Options to be passed when rendering a route
@ -27,15 +27,15 @@ export type ContainerRenderOptions = {
/**
* If your component renders slots, that's where you want to fill the slots.
* A single slot should have the `default` field:
*
*
* ## Examples
*
*
* **Default slot**
*
*
* ```js
* container.renderToString(Component, { slots: { default: "Some value"}});
* ```
*
*
* **Named slots**
*
* ```js
@ -83,7 +83,7 @@ function createManifest(
return {
rewritingEnabled: false,
trailingSlash: manifest?.trailingSlash ?? ASTRO_CONFIG_DEFAULTS.trailingSlash ,
trailingSlash: manifest?.trailingSlash ?? ASTRO_CONFIG_DEFAULTS.trailingSlash,
buildFormat: manifest?.buildFormat ?? ASTRO_CONFIG_DEFAULTS.build.format,
compressHTML: manifest?.compressHTML ?? ASTRO_CONFIG_DEFAULTS.compressHTML,
assets: manifest?.assets ?? new Set(),
@ -93,7 +93,7 @@ function createManifest(
adapterName: '',
clientDirectives: manifest?.clientDirectives ?? new Map(),
renderers: manifest?.renderers ?? renderers,
base: manifest?.base ?? ASTRO_CONFIG_DEFAULTS.base,
base: manifest?.base ?? ASTRO_CONFIG_DEFAULTS.base,
componentMetadata: manifest?.componentMetadata ?? new Map(),
inlinedScripts: manifest?.inlinedScripts ?? new Map(),
i18n: manifest?.i18n,
@ -102,7 +102,7 @@ function createManifest(
};
}
export type AstroContainerUserConfig = Omit<AstroUserConfig, 'integrations' | 'adapter' >
export type AstroContainerUserConfig = Omit<AstroUserConfig, 'integrations' | 'adapter'>;
/**
* Options that are used for the entire lifecycle of the current instance of the container.
@ -110,13 +110,13 @@ export type AstroContainerUserConfig = Omit<AstroUserConfig, 'integrations' | 'a
export type AstroContainerOptions = {
/**
* @default false
*
*
* @description
*
*
* Enables streaming during rendering
*
*
* ## Example
*
*
* ```js
* const container = await AstroContainer.create({
* streaming: true
@ -127,11 +127,11 @@ export type AstroContainerOptions = {
/**
* @default []
* @description
*
*
* List or renderers to use when rendering components. Usually they are entry points
*
*
* ## Example
*
*
* ```js
* const container = await AstroContainer.create({
* renderers: [{
@ -232,17 +232,14 @@ export class experimental_AstroContainer {
/**
* Creates a new instance of a container.
*
*
* @param {AstroContainerOptions=} containerOptions
*/
public static async create(
containerOptions: AstroContainerOptions = {}
): Promise<experimental_AstroContainer> {
const {
streaming = false,
renderers = [],
} = containerOptions;
const loadedRenderers = await Promise.all(
const { streaming = false, renderers = [] } = containerOptions;
const loadedRenderers = await Promise.all(
renderers.map(async (renderer) => {
const mod = await import(renderer.serverEntrypoint);
if (typeof mod.default !== 'undefined') {
@ -255,13 +252,15 @@ export class experimental_AstroContainer {
})
);
const finalRenderers = loadedRenderers.filter((r): r is SSRLoadedRenderer => Boolean(r));
return new experimental_AstroContainer({ streaming, renderers: finalRenderers });
}
// NOTE: we keep this private via TS instead via `#` so it's still available on the surface, so we can play with it.
// @ematipico: I plan to use it for a possible integration that could help people
private static async createFromManifest(manifest: SSRManifest): Promise<experimental_AstroContainer> {
// @ematipico: I plan to use it for a possible integration that could help people
private static async createFromManifest(
manifest: SSRManifest
): Promise<experimental_AstroContainer> {
const config = await validateConfig(ASTRO_CONFIG_DEFAULTS, process.cwd(), 'container');
const container = new experimental_AstroContainer({
manifest,
@ -269,7 +268,7 @@ export class experimental_AstroContainer {
container.#withManifest = true;
return container;
}
#insertRoute({
path,
componentInstance,
@ -278,13 +277,12 @@ export class experimental_AstroContainer {
}: {
path: string;
componentInstance: ComponentInstance;
route?: string,
route?: string;
params?: Record<string, string | undefined>;
type?: RouteType;
}): RouteData {
const pathUrl = new URL(path, 'https://example.com');
const routeData: RouteData = this.#createRoute(pathUrl,
params, type);
const routeData: RouteData = this.#createRoute(pathUrl, params, type);
this.#pipeline.manifest.routes.push({
routeData,
file: '',
@ -299,19 +297,19 @@ export class experimental_AstroContainer {
/**
* @description
* It renders a component and returns the result as a string.
*
*
* ## Example
*
*
* ```js
* import Card from "../src/components/Card.astro";
*
*
* const container = await AstroContainer.create();
* const result = await container.renderToString(Card);
*
*
* console.log(result); // it's a string
* ```
*
*
*
*
* @param {AstroComponentFactory} component The instance of the component.
* @param {ContainerRenderOptions=} options Possible options to pass when rendering the component.
*/
@ -349,7 +347,10 @@ export class experimental_AstroContainer {
const { routeType = 'page', slots } = options;
const request = options?.request ?? new Request('https://example.com/');
const url = new URL(request.url);
const componentInstance = routeType === "endpoint" ? component as unknown as ComponentInstance : this.#wrapComponent(component, options.params);
const componentInstance =
routeType === 'endpoint'
? (component as unknown as ComponentInstance)
: this.#wrapComponent(component, options.params);
const routeData = this.#insertRoute({
path: request.url,
componentInstance,
@ -387,7 +388,11 @@ export class experimental_AstroContainer {
return '';
},
params: Object.keys(params),
pattern: getPattern(segments, ASTRO_CONFIG_DEFAULTS.base, ASTRO_CONFIG_DEFAULTS.trailingSlash),
pattern: getPattern(
segments,
ASTRO_CONFIG_DEFAULTS.base,
ASTRO_CONFIG_DEFAULTS.trailingSlash
),
prerender: false,
segments,
type,
@ -402,15 +407,18 @@ export class experimental_AstroContainer {
* @param params
* @private
*/
#wrapComponent(componentFactory: AstroComponentFactory, params?: Record<string, string | undefined>): ComponentInstance {
#wrapComponent(
componentFactory: AstroComponentFactory,
params?: Record<string, string | undefined>
): ComponentInstance {
if (params) {
return {
default: componentFactory,
getStaticPaths() {
return [{ params }];
}
}
},
};
}
return ({ default: componentFactory })
return { default: componentFactory };
}
}

11
packages/astro/src/container/pipeline.ts
View file

@ -1,4 +1,3 @@
import { type HeadElements, Pipeline } from '../core/base-pipeline.js';
import type {
ComponentInstance,
RewritePayload,
@ -6,13 +5,14 @@ import type {
SSRElement,
SSRResult,
} from '../@types/astro.js';
import { type HeadElements, Pipeline } from '../core/base-pipeline.js';
import type { SinglePageBuiltModule } from '../core/build/types.js';
import { RouteNotFound } from '../core/errors/errors-data.js';
import { AstroError } from '../core/errors/index.js';
import {
createModuleScriptElement,
createStylesheetElementSet,
} from '../core/render/ssr-element.js';
import { AstroError } from '../core/errors/index.js';
import { RouteNotFound } from '../core/errors/errors-data.js';
import type { SinglePageBuiltModule } from '../core/build/types.js';
export class ContainerPipeline extends Pipeline {
/**
@ -110,6 +110,5 @@ export class ContainerPipeline extends Pipeline {
// At the moment it's not used by the container via any public API
// @ts-expect-error It needs to be implemented.
async getComponentByRoute(_routeData: RouteData): Promise<ComponentInstance> {
}
async getComponentByRoute(_routeData: RouteData): Promise<ComponentInstance> {}
}

6
packages/astro/test/container.test.js
View file

@ -1,4 +1,6 @@
import assert from 'node:assert/strict';
import { describe, it } from 'node:test';
import { experimental_AstroContainer } from '../dist/container/index.js';
import {
Fragment,
createComponent,
@ -8,8 +10,6 @@ import {
renderHead,
renderSlot,
} from '../dist/runtime/server/index.js';
import { experimental_AstroContainer } from '../dist/container/index.js';
import assert from 'node:assert/strict';
const BaseLayout = createComponent((result, _props, slots) => {
return render`<html>
@ -54,7 +54,7 @@ describe('Container', () => {
assert.match(response, /hello world/);
});
it('Renders a slot', async () => {
const Page = createComponent(
(result, _props, slots) => {