feat: pass logger to integrations
This commit is contained in:
parent
25e04a2ecb
commit
9658f6cd17
3 changed files with 172 additions and 81 deletions
|
@ -22,6 +22,7 @@ import type { AstroCookies } from '../core/cookies';
|
||||||
import type { LogOptions } from '../core/logger/core';
|
import type { LogOptions } from '../core/logger/core';
|
||||||
import type { AstroComponentFactory, AstroComponentInstance } from '../runtime/server';
|
import type { AstroComponentFactory, AstroComponentInstance } from '../runtime/server';
|
||||||
import type { SUPPORTED_MARKDOWN_FILE_EXTENSIONS } from './../core/constants.js';
|
import type { SUPPORTED_MARKDOWN_FILE_EXTENSIONS } from './../core/constants.js';
|
||||||
|
import { Logger } from '../core/logger/core';
|
||||||
export type {
|
export type {
|
||||||
MarkdownHeading,
|
MarkdownHeading,
|
||||||
MarkdownMetadata,
|
MarkdownMetadata,
|
||||||
|
@ -1856,7 +1857,8 @@ export interface AstroIntegration {
|
||||||
name: string;
|
name: string;
|
||||||
/** The different hooks available to extend. */
|
/** The different hooks available to extend. */
|
||||||
hooks: {
|
hooks: {
|
||||||
'astro:config:setup'?: (options: {
|
'astro:config:setup'?: (
|
||||||
|
options: {
|
||||||
config: AstroConfig;
|
config: AstroConfig;
|
||||||
command: 'dev' | 'build' | 'preview';
|
command: 'dev' | 'build' | 'preview';
|
||||||
isRestart: boolean;
|
isRestart: boolean;
|
||||||
|
@ -1870,15 +1872,27 @@ export interface AstroIntegration {
|
||||||
// This may require some refactoring of `scripts`, `styles`, and `links` into something
|
// This may require some refactoring of `scripts`, `styles`, and `links` into something
|
||||||
// more generalized. Consider the SSR use-case as well.
|
// more generalized. Consider the SSR use-case as well.
|
||||||
// injectElement: (stage: vite.HtmlTagDescriptor, element: string) => void;
|
// injectElement: (stage: vite.HtmlTagDescriptor, element: string) => void;
|
||||||
}) => void | Promise<void>;
|
},
|
||||||
'astro:config:done'?: (options: {
|
bag: AstroIntegrationBag
|
||||||
|
) => void | Promise<void>;
|
||||||
|
'astro:config:done'?: (
|
||||||
|
options: {
|
||||||
config: AstroConfig;
|
config: AstroConfig;
|
||||||
setAdapter: (adapter: AstroAdapter) => void;
|
setAdapter: (adapter: AstroAdapter) => void;
|
||||||
}) => void | Promise<void>;
|
},
|
||||||
'astro:server:setup'?: (options: { server: vite.ViteDevServer }) => void | Promise<void>;
|
bag: AstroIntegrationBag
|
||||||
'astro:server:start'?: (options: { address: AddressInfo }) => void | Promise<void>;
|
) => void | Promise<void>;
|
||||||
'astro:server:done'?: () => void | Promise<void>;
|
'astro:server:setup'?: (
|
||||||
'astro:build:ssr'?: (options: {
|
options: { server: vite.ViteDevServer },
|
||||||
|
bag: AstroIntegrationBag
|
||||||
|
) => void | Promise<void>;
|
||||||
|
'astro:server:start'?: (
|
||||||
|
options: { address: AddressInfo },
|
||||||
|
bag: AstroIntegrationBag
|
||||||
|
) => void | Promise<void>;
|
||||||
|
'astro:server:done'?: (bag: AstroIntegrationBag) => void | Promise<void>;
|
||||||
|
'astro:build:ssr'?: (
|
||||||
|
options: {
|
||||||
manifest: SerializedSSRManifest;
|
manifest: SerializedSSRManifest;
|
||||||
/**
|
/**
|
||||||
* This maps a {@link RouteData} to an {@link URL}, this URL represents
|
* This maps a {@link RouteData} to an {@link URL}, this URL represents
|
||||||
|
@ -1889,23 +1903,41 @@ export interface AstroIntegration {
|
||||||
* File path of the emitted middleware
|
* File path of the emitted middleware
|
||||||
*/
|
*/
|
||||||
middlewareEntryPoint: URL | undefined;
|
middlewareEntryPoint: URL | undefined;
|
||||||
}) => void | Promise<void>;
|
},
|
||||||
'astro:build:start'?: () => void | Promise<void>;
|
bag: AstroIntegrationBag
|
||||||
'astro:build:setup'?: (options: {
|
) => void | Promise<void>;
|
||||||
|
'astro:build:start'?: (bag: AstroIntegrationBag) => void | Promise<void>;
|
||||||
|
'astro:build:setup'?: (
|
||||||
|
options: {
|
||||||
vite: vite.InlineConfig;
|
vite: vite.InlineConfig;
|
||||||
pages: Map<string, PageBuildData>;
|
pages: Map<string, PageBuildData>;
|
||||||
target: 'client' | 'server';
|
target: 'client' | 'server';
|
||||||
updateConfig: (newConfig: vite.InlineConfig) => void;
|
updateConfig: (newConfig: vite.InlineConfig) => void;
|
||||||
}) => void | Promise<void>;
|
},
|
||||||
'astro:build:generated'?: (options: { dir: URL }) => void | Promise<void>;
|
bag: AstroIntegrationBag
|
||||||
'astro:build:done'?: (options: {
|
) => void | Promise<void>;
|
||||||
|
'astro:build:generated'?: (
|
||||||
|
options: { dir: URL },
|
||||||
|
bag: AstroIntegrationBag
|
||||||
|
) => void | Promise<void>;
|
||||||
|
'astro:build:done'?: (
|
||||||
|
options: {
|
||||||
pages: { pathname: string }[];
|
pages: { pathname: string }[];
|
||||||
dir: URL;
|
dir: URL;
|
||||||
routes: RouteData[];
|
routes: RouteData[];
|
||||||
}) => void | Promise<void>;
|
},
|
||||||
|
bag: AstroIntegrationBag
|
||||||
|
) => void | Promise<void>;
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* A set of utilities that are passed at each hook
|
||||||
|
*/
|
||||||
|
export type AstroIntegrationBag = {
|
||||||
|
logger: Logger;
|
||||||
|
};
|
||||||
|
|
||||||
export type MiddlewareNext<R> = () => Promise<R>;
|
export type MiddlewareNext<R> = () => Promise<R>;
|
||||||
export type MiddlewareHandler<R> = (
|
export type MiddlewareHandler<R> = (
|
||||||
context: APIContext,
|
context: APIContext,
|
||||||
|
|
|
@ -127,3 +127,32 @@ export function timerMessage(message: string, startTime: number = Date.now()) {
|
||||||
timeDiff < 750 ? `${Math.round(timeDiff)}ms` : `${(timeDiff / 1000).toFixed(1)}s`;
|
timeDiff < 750 ? `${Math.round(timeDiff)}ms` : `${(timeDiff / 1000).toFixed(1)}s`;
|
||||||
return `${message} ${dim(timeDisplay)}`;
|
return `${message} ${dim(timeDisplay)}`;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
export class Logger {
|
||||||
|
type: string;
|
||||||
|
options: LogOptions;
|
||||||
|
constructor(type: string, options: LogOptions) {
|
||||||
|
this.type = type;
|
||||||
|
this.options = options;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Creates a new Logger instance using the same log options
|
||||||
|
*/
|
||||||
|
fork(type: string): Logger {
|
||||||
|
return new Logger(type, this.options);
|
||||||
|
}
|
||||||
|
|
||||||
|
info(message: string) {
|
||||||
|
info(this.options, this.type, message);
|
||||||
|
}
|
||||||
|
warn(message: string) {
|
||||||
|
warn(this.options, this.type, message);
|
||||||
|
}
|
||||||
|
error(message: string) {
|
||||||
|
error(this.options, this.type, message);
|
||||||
|
}
|
||||||
|
debug(message: string) {
|
||||||
|
debug(this.options, this.type, message);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
|
@ -16,7 +16,7 @@ import type { SerializedSSRManifest } from '../core/app/types';
|
||||||
import type { PageBuildData } from '../core/build/types';
|
import type { PageBuildData } from '../core/build/types';
|
||||||
import { buildClientDirectiveEntrypoint } from '../core/client-directive/index.js';
|
import { buildClientDirectiveEntrypoint } from '../core/client-directive/index.js';
|
||||||
import { mergeConfig } from '../core/config/index.js';
|
import { mergeConfig } from '../core/config/index.js';
|
||||||
import { info, type LogOptions } from '../core/logger/core.js';
|
import { info, type LogOptions, Logger } from '../core/logger/core.js';
|
||||||
import { isServerLikeOutput } from '../prerender/utils.js';
|
import { isServerLikeOutput } from '../prerender/utils.js';
|
||||||
|
|
||||||
async function withTakingALongTimeMsg<T>({
|
async function withTakingALongTimeMsg<T>({
|
||||||
|
@ -72,6 +72,8 @@ export async function runHookConfigSetup({
|
||||||
* ```
|
* ```
|
||||||
*/
|
*/
|
||||||
if (integration.hooks?.['astro:config:setup']) {
|
if (integration.hooks?.['astro:config:setup']) {
|
||||||
|
const logger = new Logger(`${integration.name}`, logging);
|
||||||
|
|
||||||
const hooks: HookParameters<'astro:config:setup'> = {
|
const hooks: HookParameters<'astro:config:setup'> = {
|
||||||
config: updatedConfig,
|
config: updatedConfig,
|
||||||
command,
|
command,
|
||||||
|
@ -144,7 +146,7 @@ export async function runHookConfigSetup({
|
||||||
|
|
||||||
await withTakingALongTimeMsg({
|
await withTakingALongTimeMsg({
|
||||||
name: integration.name,
|
name: integration.name,
|
||||||
hookResult: integration.hooks['astro:config:setup'](hooks),
|
hookResult: integration.hooks['astro:config:setup'](hooks, { logger }),
|
||||||
logging,
|
logging,
|
||||||
});
|
});
|
||||||
|
|
||||||
|
@ -167,10 +169,12 @@ export async function runHookConfigDone({
|
||||||
logging: LogOptions;
|
logging: LogOptions;
|
||||||
}) {
|
}) {
|
||||||
for (const integration of settings.config.integrations) {
|
for (const integration of settings.config.integrations) {
|
||||||
|
const logger = new Logger(`${integration.name}`, logging);
|
||||||
if (integration?.hooks?.['astro:config:done']) {
|
if (integration?.hooks?.['astro:config:done']) {
|
||||||
await withTakingALongTimeMsg({
|
await withTakingALongTimeMsg({
|
||||||
name: integration.name,
|
name: integration.name,
|
||||||
hookResult: integration.hooks['astro:config:done']({
|
hookResult: integration.hooks['astro:config:done'](
|
||||||
|
{
|
||||||
config: settings.config,
|
config: settings.config,
|
||||||
setAdapter(adapter) {
|
setAdapter(adapter) {
|
||||||
if (settings.adapter && settings.adapter.name !== adapter.name) {
|
if (settings.adapter && settings.adapter.name !== adapter.name) {
|
||||||
|
@ -180,7 +184,9 @@ export async function runHookConfigDone({
|
||||||
}
|
}
|
||||||
settings.adapter = adapter;
|
settings.adapter = adapter;
|
||||||
},
|
},
|
||||||
}),
|
},
|
||||||
|
{ logger }
|
||||||
|
),
|
||||||
logging,
|
logging,
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
@ -198,9 +204,10 @@ export async function runHookServerSetup({
|
||||||
}) {
|
}) {
|
||||||
for (const integration of config.integrations) {
|
for (const integration of config.integrations) {
|
||||||
if (integration?.hooks?.['astro:server:setup']) {
|
if (integration?.hooks?.['astro:server:setup']) {
|
||||||
|
const logger = new Logger(`${integration.name}`, logging);
|
||||||
await withTakingALongTimeMsg({
|
await withTakingALongTimeMsg({
|
||||||
name: integration.name,
|
name: integration.name,
|
||||||
hookResult: integration.hooks['astro:server:setup']({ server }),
|
hookResult: integration.hooks['astro:server:setup']({ server }, { logger }),
|
||||||
logging,
|
logging,
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
@ -217,10 +224,12 @@ export async function runHookServerStart({
|
||||||
logging: LogOptions;
|
logging: LogOptions;
|
||||||
}) {
|
}) {
|
||||||
for (const integration of config.integrations) {
|
for (const integration of config.integrations) {
|
||||||
|
const logger = new Logger(`${integration.name}`, logging);
|
||||||
|
|
||||||
if (integration?.hooks?.['astro:server:start']) {
|
if (integration?.hooks?.['astro:server:start']) {
|
||||||
await withTakingALongTimeMsg({
|
await withTakingALongTimeMsg({
|
||||||
name: integration.name,
|
name: integration.name,
|
||||||
hookResult: integration.hooks['astro:server:start']({ address }),
|
hookResult: integration.hooks['astro:server:start']({ address }, { logger }),
|
||||||
logging,
|
logging,
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
@ -235,10 +244,12 @@ export async function runHookServerDone({
|
||||||
logging: LogOptions;
|
logging: LogOptions;
|
||||||
}) {
|
}) {
|
||||||
for (const integration of config.integrations) {
|
for (const integration of config.integrations) {
|
||||||
|
const logger = new Logger(`${integration.name}`, logging);
|
||||||
|
|
||||||
if (integration?.hooks?.['astro:server:done']) {
|
if (integration?.hooks?.['astro:server:done']) {
|
||||||
await withTakingALongTimeMsg({
|
await withTakingALongTimeMsg({
|
||||||
name: integration.name,
|
name: integration.name,
|
||||||
hookResult: integration.hooks['astro:server:done'](),
|
hookResult: integration.hooks['astro:server:done']({ logger }),
|
||||||
logging,
|
logging,
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
@ -254,9 +265,11 @@ export async function runHookBuildStart({
|
||||||
}) {
|
}) {
|
||||||
for (const integration of config.integrations) {
|
for (const integration of config.integrations) {
|
||||||
if (integration?.hooks?.['astro:build:start']) {
|
if (integration?.hooks?.['astro:build:start']) {
|
||||||
|
const logger = new Logger(`${integration.name}`, logging);
|
||||||
|
|
||||||
await withTakingALongTimeMsg({
|
await withTakingALongTimeMsg({
|
||||||
name: integration.name,
|
name: integration.name,
|
||||||
hookResult: integration.hooks['astro:build:start'](),
|
hookResult: integration.hooks['astro:build:start']({ logger }),
|
||||||
logging,
|
logging,
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
@ -280,16 +293,21 @@ export async function runHookBuildSetup({
|
||||||
|
|
||||||
for (const integration of config.integrations) {
|
for (const integration of config.integrations) {
|
||||||
if (integration?.hooks?.['astro:build:setup']) {
|
if (integration?.hooks?.['astro:build:setup']) {
|
||||||
|
const logger = new Logger(`${integration.name}`, logging);
|
||||||
|
|
||||||
await withTakingALongTimeMsg({
|
await withTakingALongTimeMsg({
|
||||||
name: integration.name,
|
name: integration.name,
|
||||||
hookResult: integration.hooks['astro:build:setup']({
|
hookResult: integration.hooks['astro:build:setup'](
|
||||||
|
{
|
||||||
vite,
|
vite,
|
||||||
pages,
|
pages,
|
||||||
target,
|
target,
|
||||||
updateConfig: (newConfig) => {
|
updateConfig: (newConfig) => {
|
||||||
updatedConfig = mergeConfig(updatedConfig, newConfig);
|
updatedConfig = mergeConfig(updatedConfig, newConfig);
|
||||||
},
|
},
|
||||||
}),
|
},
|
||||||
|
{ logger }
|
||||||
|
),
|
||||||
logging,
|
logging,
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
@ -315,13 +333,18 @@ export async function runHookBuildSsr({
|
||||||
}: RunHookBuildSsr) {
|
}: RunHookBuildSsr) {
|
||||||
for (const integration of config.integrations) {
|
for (const integration of config.integrations) {
|
||||||
if (integration?.hooks?.['astro:build:ssr']) {
|
if (integration?.hooks?.['astro:build:ssr']) {
|
||||||
|
const logger = new Logger(`${integration.name}`, logging);
|
||||||
|
|
||||||
await withTakingALongTimeMsg({
|
await withTakingALongTimeMsg({
|
||||||
name: integration.name,
|
name: integration.name,
|
||||||
hookResult: integration.hooks['astro:build:ssr']({
|
hookResult: integration.hooks['astro:build:ssr'](
|
||||||
|
{
|
||||||
manifest,
|
manifest,
|
||||||
entryPoints,
|
entryPoints,
|
||||||
middlewareEntryPoint,
|
middlewareEntryPoint,
|
||||||
}),
|
},
|
||||||
|
{ logger }
|
||||||
|
),
|
||||||
logging,
|
logging,
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
@ -338,10 +361,12 @@ export async function runHookBuildGenerated({
|
||||||
const dir = isServerLikeOutput(config) ? config.build.client : config.outDir;
|
const dir = isServerLikeOutput(config) ? config.build.client : config.outDir;
|
||||||
|
|
||||||
for (const integration of config.integrations) {
|
for (const integration of config.integrations) {
|
||||||
|
const logger = new Logger(`${integration.name}`, logging);
|
||||||
|
|
||||||
if (integration?.hooks?.['astro:build:generated']) {
|
if (integration?.hooks?.['astro:build:generated']) {
|
||||||
await withTakingALongTimeMsg({
|
await withTakingALongTimeMsg({
|
||||||
name: integration.name,
|
name: integration.name,
|
||||||
hookResult: integration.hooks['astro:build:generated']({ dir }),
|
hookResult: integration.hooks['astro:build:generated']({ dir }, { logger }),
|
||||||
logging,
|
logging,
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
@ -361,13 +386,18 @@ export async function runHookBuildDone({ config, pages, routes, logging }: RunHo
|
||||||
|
|
||||||
for (const integration of config.integrations) {
|
for (const integration of config.integrations) {
|
||||||
if (integration?.hooks?.['astro:build:done']) {
|
if (integration?.hooks?.['astro:build:done']) {
|
||||||
|
const logger = new Logger(`${integration.name}`, logging);
|
||||||
|
|
||||||
await withTakingALongTimeMsg({
|
await withTakingALongTimeMsg({
|
||||||
name: integration.name,
|
name: integration.name,
|
||||||
hookResult: integration.hooks['astro:build:done']({
|
hookResult: integration.hooks['astro:build:done'](
|
||||||
|
{
|
||||||
pages: pages.map((p) => ({ pathname: p })),
|
pages: pages.map((p) => ({ pathname: p })),
|
||||||
dir,
|
dir,
|
||||||
routes,
|
routes,
|
||||||
}),
|
},
|
||||||
|
{ logger }
|
||||||
|
),
|
||||||
logging,
|
logging,
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
Loading…
Reference in a new issue