8000 Refactor API inliner by KevinTCoughlin · Pull Request #74 · cascadiacollections/podr · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Refactor API inliner #74

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.

Sign up for GitHub

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

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

Refactor API inliner #74

8000 Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
117 changes: 56 additions & 61 deletions webpack-plugins/api-inliner-plugin/heft-plugin.ts
View file
Open in desktop
< F6C3 td class="blob-num blob-num-addition empty-cell">
Original file line number Diff line number Diff line change
@@ -1,15 +1,16 @@
/**
* Heft Plugin Integration for API Inliner
*
*
* This file demonstrates how to integrate ApiInlinerPlugin with Heft's plugin system.
*/

import * as path from 'path';
import type { IHeftTaskSession } from '@rushstack/heft';
import { HeftConfiguration } from '@rushstack/heft';
import type { IScopedLogger } from '@rushstack/heft/lib/pluginFramework/logging/ScopedLogger';
import * as Ajv from 'ajv';
import * as fs from 'fs';
import { HeftConfiguration, HeftSession, ScopedLogger } from '@rushstack/heft';
import { IWebpackConfigurationUpdaterHookOptions } from '@rushstack/heft-webpack5-plugin';
import * as path from 'path';
import type { Configuration as WebpackConfiguration } from 'webpack';
import * as Ajv from 'ajv';

import { ApiInlinerPlugin, IApiInlinerConfiguration } from './index';

Expand All @@ -23,72 +24,66 @@ export class ApiInlinerHeftPlugin {
* Applies this plugin to the Heft session
*/
public static apply(
heftSession: HeftSession,
heftSession: IHeftTaskSession,
heftConfiguration: HeftConfiguration
): void {
// Get a logger for this plugin
const logger: ScopedLogger = heftSession.requestScopedLogger(PLUGIN_NAME);
const logger: IScopedLogger = heftSession.logger;

// Register a hook to modify the webpack configuration
heftSession.hooks.webpackConfiguration.tap(PLUGIN_NAME, (options: IWebpackConfigurationUpdaterHookOptions) => {
// Find the configuration file
const configPath: string = path.resolve(heftConfiguration.buildFolder, 'api-inliner.json');

// Skip if no configuration file exists
if (!fs.existsSync(configPath)) {
logger.terminal.writeLine(`No api-inliner.json configuration found at ${configPath}, skipping plugin activation`);
return;
}

try {
// Load and validate the configuration
const configJson: string = fs.readFileSync(configPath, 'utf8');
const config: IApiInlinerConfiguration = JSON.parse(configJson);

// Validate the configuration against the schema
const schemaPath: string = path.resolve(__dirname, 'schema.json');
if (fs.existsSync(schemaPath)) {
const schemaJson: string = fs.readFileSync(schemaPath, 'utf8');
const schema: object = JSON.parse(schemaJson);

const ajv: Ajv.default = new Ajv.default({ allErrors: true });
const validate = ajv.compile(schema);

if (!validate(config)) {
logger.terminal.writeErrorLine(`Invalid API Inliner configuration:`);

if (validate.errors) {
for (const error of validate.errors) {
logger.terminal.writeErrorLine(` - ${error.instancePath}: ${error.message}`);
// Heft's bundle task exposes hooks for webpackConfiguration
const bundleHooks = (heftSession as any).hooks?.bundle?.hooks;
if (bundleHooks && bundleHooks.webpackConfiguration) {
bundleHooks.webpackConfiguration.tap(PLUGIN_NAME, (options: any) => {
// Find the configuration file
const configPath: string = path.resolve(heftConfiguration.buildFolderPath, 'api-inliner.json');
// Skip if no configuration file exists
if (!fs.existsSync(configPath)) {
logger.terminal.writeLine(`No api-inliner.json configuration found at ${configPath}, skipping plugin activation`);
return;
}
try {
// Load and validate the configuration
const configJson: string = fs.readFileSync(configPath, 'utf8');
const config: IApiInlinerConfiguration = JSON.parse(configJson);
// Validate the configuration against the schema
const schemaPath: string = path.resolve(__dirname, 'schema.json');
if (fs.existsSync(schemaPath)) {
const schemaJson: string = fs.readFileSync(schemaPath, 'utf8');
const schema: object = JSON.parse(schemaJson);
const ajv: Ajv.default = new Ajv.default({ allErrors: true });
const validate = ajv.compile(schema);
if (!validate(config)) {
logger.terminal.writeErrorLine(`Invalid API Inliner configuration:`);
if (validate.errors) {
for (const error of validate.errors) {
logger.terminal.writeErrorLine(` - ${error.instancePath}: ${error.message}`);
}
}
return;
}

return;
}
// Add production flag from Heft
config.production = options.webpack.mode === 'production';
logger.terminal.writeLine(`API Inliner Plugin activated with ${config.endpoints.length} endpoints`);
// Add the ApiInlinerPlugin to webpack config
const webpackConfig: WebpackConfiguration = options.webpackConfig;
if (!webpackConfig.plugins) {
webpackConfig.plugins = [];
}
webpackConfig.plugins.push(new ApiInlinerPlugin(config));
} catch (error) {
logger.terminal.writeErrorLine(`Error loading API Inliner configuration: ${(error as Error).message}`);
}

// Add production flag from Heft
config.production = options.webpack.mode === 'production';

logger.terminal.writeLine(`API Inliner Plugin activated with ${config.endpoints.length} endpoints`);

// Add the ApiInlinerPlugin to webpack config
const webpackConfig: WebpackConfiguration = options.webpackConfig;

if (!webpackConfig.plugins) {
webpackConfig.plugins = [];
}

webpackConfig.plugins.push(new ApiInlinerPlugin(config));

} catch (error) {
logger.terminal.writeErrorLine(`Error loading API Inliner configuration: ${(error as Error).message}`);
}
});
});
} else {
// Fallback: log warning if hooks are not available
logger.terminal.writeWarningLine('Heft bundle hooks for webpackConfiguration not found. API Inliner plugin not activated.');
}
};
}
}

// Export a function to setup the Heft plugin
export function setupApiInlinerPlugin(heftSession: HeftSession, heftConfiguration: HeftConfiguration): void {
export function setupApiInlinerPlugin(heftSession: IHeftTaskSession, heftConfiguration: HeftConfiguration): void {
ApiInlinerHeftPlugin.apply(heftSession, heftConfiguration);
}
}
Loading
0