@gasket/plugin-fastify 7.5.2 → 8.0.0-next.1

package/lib/create-servers.js

@@ -5,32 +5,23 @@ import { getAppInstance } from './utils.js';
 
 /**
  * Create the Fastify instance and setup the lifecycle hooks.
- * Fastify is compatible with express middleware when @fastify/express is installed.
+ * Fastify is compatible with express middleware out of the box, so we can
+ * use the same middleware lifecycles.
  * @type {import('@gasket/core').HookHandler<'createServers'>}
  */
 export default async function createServers(gasket, serverOpts) {
-  const app = getAppInstance(gasket);
+  /** Cast to Fastify + Express hybrid because Gasket adds `.use()` via @fastify/express plugin */
+  const app = /** @type {import('fastify').FastifyInstance & { use: Function }} */ (getAppInstance(gasket));
 
   // allow consuming apps to directly append options to their server
   await gasket.exec('fastify', app);
 
   const postRenderingStacks = (await gasket.exec('errorMiddleware')).filter(Boolean);
-  if (postRenderingStacks.length > 0) {
-    // app.use() is added by @fastify/express when registered via @gasket/plugin-middleware
-    // @ts-expect-error
-    if (typeof app.use !== 'function') {
-      throw new Error(
-        'errorMiddleware requires @fastify/express to be installed and registered. ' +
-        'Install @fastify/express and ensure @gasket/plugin-middleware is configured.'
-      );
-    }
-    postRenderingStacks.forEach((stack) => {
-      /** @type {import('connect').NextHandleFunction} */
-      const middleware = stack;
-      // @ts-expect-error
-      app.use(middleware);
-    });
-  }
+  postRenderingStacks.forEach((stack) => {
+    /** @type {import('connect').NextHandleFunction} */
+    const middleware = stack;
+    app.use(middleware);
+  });
 
   return {
     ...serverOpts,

package/lib/index.js

@@ -1,7 +1,6 @@
 /// <reference types="@gasket/core" />
 /// <reference types="@gasket/plugin-metadata" />
 
-import create from './create.js';
 import createServers from './create-servers.js';
 import actions from './actions.js';
 import packageJson from '../package.json' with { type: 'json' };
@@ -14,7 +13,6 @@ const plugin = {
   description,
   actions,
   hooks: {
-    create,
     createServers,
     metadata(gasket, meta) {
       return {

package/package.json

@@ -1,12 +1,10 @@
 {
   "name": "@gasket/plugin-fastify",
-  "version": "7.5.2",
+  "version": "8.0.0-next.1",
   "description": "Adds fastify support to your application",
   "type": "module",
-  "main": "./lib/index.js",
   "types": "./lib/index.d.ts",
   "files": [
-    "cjs",
     "generator",
     "lib",
     "EXAMPLES.md"
@@ -14,8 +12,7 @@
   "exports": {
     ".": {
       "types": "./lib/index.d.ts",
-      "import": "./lib/index.js",
-      "require": "./cjs/index.cjs"
+      "import": "./lib/index.js"
     },
     "./package.json": "./package.json"
   },
@@ -33,24 +30,23 @@
   "bugs": "https://github.com/godaddy/gasket/issues",
   "homepage": "https://github.com/godaddy/gasket/tree/main/packages/gasket-plugin-fastify",
   "dependencies": {
+    "@fastify/express": "^3.0.0",
     "fastify": "^4.29.1"
   },
   "devDependencies": {
     "@types/connect": "^3.4.38",
     "fastify": "^4.29.1",
     "vitest": "^3.2.0",
-    "@gasket/core": "^7.7.2",
-    "@gasket/plugin-https": "^7.4.0",
-    "@gasket/plugin-logger": "^7.4.0",
-    "@gasket/plugin-metadata": "^7.5.8",
-    "create-gasket-app": "^7.4.18",
-    "@gasket/cjs": "^7.1.1"
+    "@gasket/core": "^8.0.0-next.1",
+    "@gasket/plugin-https": "^8.0.0-next.1",
+    "@gasket/plugin-logger": "^8.0.0-next.1",
+    "@gasket/plugin-metadata": "^8.0.0-next.1",
+    "create-gasket-app": "^8.0.0-next.1"
   },
   "peerDependencies": {
     "fastify": "^4.29.1"
   },
   "scripts": {
-    "build": "gasket-cjs ./lib",
     "lint": "eslint .",
     "lint:fix": "pnpm run lint --fix",
     "posttest": "pnpm run lint && pnpm run typecheck",

package/cjs/actions.cjs

@@ -1,21 +0,0 @@
-Object.defineProperty(exports, "__esModule", {
-    value: true
-});
-Object.defineProperty(exports, "default", {
-    enumerable: true,
-    get: function() {
-        return _default;
-    }
-});
-const _utils = require("./utils.cjs");
-const actions = {
-    /**
-   * @deprecated
-   * @param {import('@gasket/core').Gasket} gasket - Gasket instance
-   * @returns {import('fastify').FastifyInstance} - Fastify instance
-   */ getFastifyApp (gasket) {
-        gasket.logger.warn(`DEPRECATED \`getFastifyApp\` action will not be support in future major release.`);
-        return (0, _utils.getAppInstance)(gasket);
-    }
-};
-const _default = actions;

package/cjs/create-servers.cjs

@@ -1,41 +0,0 @@
-/// <reference types="@gasket/plugin-https" />
-/// <reference types="@gasket/plugin-logger" />
-Object.defineProperty(exports, "__esModule", {
-    value: true
-});
-Object.defineProperty(exports, /**
- * Create the Fastify instance and setup the lifecycle hooks.
- * Fastify is compatible with express middleware when @fastify/express is installed.
- * @type {import('@gasket/core').HookHandler<'createServers'>}
- */ "default", {
-    enumerable: true,
-    get: function() {
-        return createServers;
-    }
-});
-const _utils = require("./utils.cjs");
-async function createServers(gasket, serverOpts) {
-    const app = (0, _utils.getAppInstance)(gasket);
-    // allow consuming apps to directly append options to their server
-    await gasket.exec('fastify', app);
-    const postRenderingStacks = (await gasket.exec('errorMiddleware')).filter(Boolean);
-    if (postRenderingStacks.length > 0) {
-        // app.use() is added by @fastify/express when registered via @gasket/plugin-middleware
-        // @ts-expect-error
-        if (typeof app.use !== 'function') {
-            throw new Error('errorMiddleware requires @fastify/express to be installed and registered. ' + 'Install @fastify/express and ensure @gasket/plugin-middleware is configured.');
-        }
-        postRenderingStacks.forEach((stack)=>{
-            /** @type {import('connect').NextHandleFunction} */ const middleware = stack;
-            // @ts-expect-error
-            app.use(middleware);
-        });
-    }
-    return {
-        ...serverOpts,
-        handler: async function handler(...args) {
-            await app.ready();
-            app.server.emit('request', ...args);
-        }
-    };
-}

package/cjs/create.cjs

@@ -1,72 +0,0 @@
-/// <reference types="@gasket/core" />
-/// <reference types="create-gasket-app" />
-Object.defineProperty(exports, "__esModule", {
-    value: true
-});
-Object.defineProperty(exports, /**
- * Add files & extend package.json for new apps.
- * @type {import('@gasket/core').HookHandler<'create'>}
- */ "default", {
-    enumerable: true,
-    get: function() {
-        return create;
-    }
-});
-const _url = require("url");
-const _path = require("path");
-const _packagejson = /*#__PURE__*/ _interop_require_default(require("../package.json"));
-function _interop_require_default(obj) {
-    return obj && obj.__esModule ? obj : {
-        default: obj
-    };
-}
-const __filename1 = (0, _url.fileURLToPath)(require("url").pathToFileURL(__filename).toString());
-const __dirname = (0, _path.dirname)(__filename1);
-const { name, version, devDependencies } = _packagejson.default;
-const createTestFiles = ({ files, generatorDir, testPlugins, globIgnore })=>{
-    if (!testPlugins || testPlugins.length === 0) return;
-    const unit = [
-        'jest',
-        'mocha',
-        'vitest'
-    ];
-    const integration = [
-        'cypress'
-    ];
-    const frameworks = [
-        ...unit,
-        ...integration
-    ];
-    const frameworksRegex = new RegExp(frameworks.join('|'));
-    testPlugins.forEach((testPlugin)=>{
-        const match = frameworksRegex.exec(testPlugin);
-        if (match) {
-            const matchedFramework = match[0];
-            if (unit.includes(matchedFramework)) {
-                files.add(`${generatorDir}/${matchedFramework}/*`, `${generatorDir}/${matchedFramework}/**/${globIgnore}`);
-            } else {
-                files.add(`${generatorDir}/${matchedFramework}/*`, `${generatorDir}/${matchedFramework}/**/*`);
-            }
-        }
-    });
-};
-async function create(gasket, context) {
-    const { files, typescript, apiApp, addApiRoutes = true, testPlugins, pkg, gasketConfig } = context;
-    const generatorDir = `${__dirname}/../generator`;
-    gasketConfig.addPlugin('pluginFastify', name);
-    pkg.add('dependencies', {
-        [name]: `^${version}`,
-        fastify: devDependencies.fastify
-    });
-    if (apiApp && addApiRoutes) {
-        const globIgnore = typescript ? '!(*.js)' : '!(*.ts)';
-        files.add(`${generatorDir}/app/**/${globIgnore}`);
-        gasketConfig.addPlugin('pluginRoutes', './plugins/routes-plugin.js');
-        createTestFiles({
-            files,
-            generatorDir,
-            testPlugins,
-            globIgnore
-        });
-    }
-}

package/cjs/index.cjs

@@ -1,84 +0,0 @@
-/// <reference types="@gasket/core" />
-/// <reference types="@gasket/plugin-metadata" />
-Object.defineProperty(exports, "__esModule", {
-    value: true
-});
-Object.defineProperty(exports, "default", {
-    enumerable: true,
-    get: function() {
-        return _default;
-    }
-});
-const _create = /*#__PURE__*/ _interop_require_default(require("./create.cjs"));
-const _createservers = /*#__PURE__*/ _interop_require_default(require("./create-servers.cjs"));
-const _actions = /*#__PURE__*/ _interop_require_default(require("./actions.cjs"));
-const _packagejson = /*#__PURE__*/ _interop_require_default(require("../package.json"));
-function _interop_require_default(obj) {
-    return obj && obj.__esModule ? obj : {
-        default: obj
-    };
-}
-const { name, version, description } = _packagejson.default;
-/** @type {import('@gasket/core').Plugin} */ const plugin = {
-    name,
-    version,
-    description,
-    actions: _actions.default,
-    hooks: {
-        create: _create.default,
-        createServers: _createservers.default,
-        metadata (gasket, meta) {
-            return {
-                ...meta,
-                actions: [
-                    {
-                        name: 'getFastifyApp',
-                        description: 'Get the Fastify app instance',
-                        link: 'README.md#getFastifyApp',
-                        deprecated: true
-                    }
-                ],
-                lifecycles: [
-                    {
-                        name: 'fastify',
-                        method: 'exec',
-                        description: 'Modify the Fastify instance to for adding endpoints',
-                        link: 'README.md#express',
-                        parent: 'createServers',
-                        after: 'middleware'
-                    },
-                    {
-                        name: 'errorMiddleware',
-                        method: 'exec',
-                        description: 'Add Express style middleware for handling errors with Fastify',
-                        link: 'README.md#errorMiddleware',
-                        parent: 'createServers',
-                        after: 'express'
-                    }
-                ],
-                configurations: [
-                    {
-                        name: 'fastify',
-                        link: 'README.md#configuration',
-                        description: 'Fastify configuration object',
-                        type: 'object'
-                    },
-                    {
-                        name: 'fastify.compression',
-                        link: 'README.md#configuration',
-                        description: 'Automatic compression',
-                        type: 'boolean',
-                        default: true
-                    },
-                    {
-                        name: 'fastify.excludedRoutesRegex',
-                        link: 'README.md#configuration',
-                        description: 'Routes to be excluded based on a regex',
-                        type: 'RegExp'
-                    }
-                ]
-            };
-        }
-    }
-};
-const _default = plugin;

package/cjs/package.json

@@ -1 +0,0 @@
-{}

package/cjs/utils.cjs

@@ -1,66 +0,0 @@
-// @ts-nocheck
-Object.defineProperty(exports, "__esModule", {
-    value: true
-});
-function _export(target, all) {
-    for(var name in all)Object.defineProperty(target, name, {
-        enumerable: true,
-        get: all[name]
-    });
-}
-_export(exports, {
-    alignLogger: function() {
-        return alignLogger;
-    },
-    getAppInstance: function() {
-        return getAppInstance;
-    },
-    testClearAppInstance: function() {
-        return testClearAppInstance;
-    }
-});
-const _fastify = /*#__PURE__*/ _interop_require_default(require("fastify"));
-function _interop_require_default(obj) {
-    return obj && obj.__esModule ? obj : {
-        default: obj
-    };
-}
-const fallbackMap = {
-    fatal: 'error',
-    trace: 'debug'
-};
-/**
- * A helper function to ensure that all the required log levels
- * for a Fastify server are present.
- * @type {import('@gasket/plugin-fastify').alignLogger}
- */ function alignLogger(logger) {
-    const fastifyLogger = logger;
-    [
-        'fatal',
-        'trace'
-    ].map((level)=>{
-        if (!logger[level]) {
-            fastifyLogger[level] = logger[fallbackMap[level]];
-        }
-    });
-    return fastifyLogger;
-}
-let instance = null;
-function getAppInstance(gasket) {
-    if (!instance) {
-        const { fastify: fastifyConfig = {}, http2, https } = gasket.config;
-        const { trustProxy = false, disableRequestLogging = true } = fastifyConfig;
-        const fastifyLogger = alignLogger(gasket.logger);
-        instance = (0, _fastify.default)({
-            logger: fastifyLogger,
-            trustProxy,
-            https,
-            http2,
-            disableRequestLogging
-        });
-    }
-    return instance;
-}
-function testClearAppInstance() {
-    instance = null;
-}

package/generator/app/plugins/README.md

@@ -1,11 +0,0 @@
-# Local Plugins
-
-### Routes plugin
-
-A local plugin is used to define Fastify routes. The plugin hooks the `fastify` lifecycle and mutates the Fastify app.
-
-The following routes are available:
-
-```javascript
-GET /default
-```

package/generator/app/plugins/routes-plugin.js

@@ -1,30 +0,0 @@
-export const defaultHandler = async (req, res) => {
-  if (res.statusCode === 200) {
-    res.send({ message: 'Welcome to your default route...' });
-  }
-};
-
-export default {
-  name: 'routes-plugin',
-  hooks: {
-    fastify(gasket, app) {
-      {{#if useSwagger }}
-      /**
-      * @swagger
-      *
-      * /default:
-      *   get:
-      *     summary: "Get default route"
-      *     produces:
-      *       - "application/json"
-      *     responses:
-      *       "200":
-      *         description: "Returns welcome message."
-      *         content:
-      *           application/json
-      */
-      {{/if }}
-      app.get('/default', defaultHandler);
-    }
-  }
-}

package/generator/app/plugins/routes-plugin.ts

@@ -1,29 +0,0 @@
-export const defaultHandler = async (req, res) => {
-  if (res.statusCode === 200) {
-    res.send({ message: 'Welcome to your default route...' });
-  }
-};
-export default {
-  name: 'routes-plugin',
-  hooks: {
-    fastify(gasket, app) {
-      {{#if useSwagger }}
-      /**
-      * @swagger
-      *
-      * /default:
-      *   get:
-      *     summary: "Get default route"
-      *     produces:
-      *       - "application/json"
-      *     responses:
-      *       "200":
-      *         description: "Returns welcome message."
-      *         content:
-      *           application/json
-      */
-      {{/if }}
-      app.get('/default', defaultHandler);
-    }
-  }
-}

package/generator/jest/jest.config.js

@@ -1,21 +0,0 @@
-{{#if typescript}}
-const config = {
-  preset: 'ts-jest/presets/default-esm',
-  testEnvironment: 'node',
-  injectGlobals: true,
-  moduleDirectories: ['node_modules', '<rootDir>'],
-  moduleNameMapper: {
-    '^(\\.{1,2}/.*)\\.js$': '$1'
-  },
-  transform: {
-    '^.+.ts$': ['ts-jest', { useESM: true }]
-  }
-};
-
-export default config;
-{{else}}
-export default {
-  testEnvironment: 'node',
-  injectGlobals: true
-};
-{{/if}}

package/generator/jest/test/index.test.js

@@ -1,20 +0,0 @@
-import { jest } from '@jest/globals';
-import { defaultHandler } from '../plugins/routes-plugin.js';
-
-describe('Routes', () => {
-  let mockRequest, mockResponse;
-  beforeEach(() => {
-    mockRequest = {};
-    mockResponse = {
-      statusCode: 200,
-      send: jest.fn()
-    };
-  });
-
-  it('defaultHandler should use expeced message', async () => {
-    await defaultHandler(mockRequest, mockResponse);
-    expect(mockResponse.send).toHaveBeenCalledWith({
-      message: 'Welcome to your default route...'
-    });
-  });
-});

package/generator/jest/test/index.test.ts

@@ -1,26 +0,0 @@
-import {
-  jest,
-  describe,
-  beforeEach,
-  it,
-  expect
-} from '@jest/globals';
-import { defaultHandler } from '../plugins/routes-plugin.js';
-
-describe('Routes', () => {
-  let mockRequest, mockResponse;
-  beforeEach(() => {
-    mockRequest = {};
-    mockResponse = {
-      statusCode: 200,
-      send: jest.fn()
-    };
-  });
-
-  it('defaultHandler should use expeced message', async () => {
-    await defaultHandler(mockRequest, mockResponse);
-    expect(mockResponse.send).toHaveBeenCalledWith({
-      message: 'Welcome to your default route...'
-    });
-  });
-});

package/generator/mocha/test/index.test.js

@@ -1,23 +0,0 @@
-import { expect } from 'chai';
-import sinon from 'sinon';
-import { defaultHandler } from '../plugins/routes-plugin.js';
-
-describe('Routes', () => {
-  let mockRequest, mockResponse, sendSpy;
-
-  beforeEach(() => {
-    mockRequest = {};
-    sendSpy = sinon.spy();
-    mockResponse = {
-      statusCode: 200,
-      send: sendSpy
-    };
-  });
-
-  it('defaultHandler should use expected message', async () => {
-    await defaultHandler(mockRequest, mockResponse);
-    expect(sendSpy.calledWith({
-      message: 'Welcome to your default route...'
-    })).to.be.true;
-  });
-});

package/generator/mocha/test/index.test.ts

@@ -1,23 +0,0 @@
-import { expect } from 'chai';
-import sinon from 'sinon';
-import { defaultHandler } from '../plugins/routes-plugin.js';
-
-describe('Routes', () => {
-  let mockRequest, mockResponse, sendSpy;
-
-  beforeEach(() => {
-    mockRequest = {};
-    sendSpy = sinon.spy();
-    mockResponse = {
-      statusCode: 200,
-      send: sendSpy
-    };
-  });
-
-  it('defaultHandler should use expected message', async () => {
-    await defaultHandler(mockRequest, mockResponse);
-    expect(sendSpy.calledWith({
-      message: 'Welcome to your default route...'
-    })).to.be.true;
-  });
-});

package/generator/vitest/test/index.test.js

@@ -1,21 +0,0 @@
-import { vi, expect } from 'vitest';
-import { defaultHandler } from '../plugins/routes-plugin.js';
-
-describe('Routes', () => {
-  let mockRequest, mockResponse;
-
-  beforeEach(() => {
-    mockRequest = {};
-    mockResponse = {
-      statusCode: 200,
-      send: vi.fn()
-    };
-  });
-
-  it('defaultHeader should use expected message', async () => {
-    await defaultHandler(mockRequest, mockResponse);
-    expect(mockResponse.send).toHaveBeenCalledWith({
-      message: 'Welcome to your default route...'
-    });
-  });
-});

package/generator/vitest/test/index.test.ts

@@ -1,21 +0,0 @@
-import { describe, it, expect, beforeEach, vi } from 'vitest';
-import { defaultHandler } from '../plugins/routes-plugin.js';
-
-describe('Routes', () => {
-  let mockRequest, mockResponse;
-
-  beforeEach(() => {
-    mockRequest = {};
-    mockResponse = {
-      statusCode: 200,
-      send: vi.fn()
-    };
-  });
-
-  it('defaultHeader should use expected message', async () => {
-    await defaultHandler(mockRequest, mockResponse);
-    expect(mockResponse.send).toHaveBeenCalledWith({
-      message: 'Welcome to your default route...'
-    });
-  });
-});

package/lib/create.js

@@ -1,61 +0,0 @@
-/// <reference types="@gasket/core" />
-/// <reference types="create-gasket-app" />
-
-import { fileURLToPath } from 'url';
-import { dirname } from 'path';
-import packageJson from '../package.json' with { type: 'json' };
-const __filename = fileURLToPath(import.meta.url);
-const __dirname = dirname(__filename);
-const { name, version, devDependencies } = packageJson;
-
-const createTestFiles = ({ files, generatorDir, testPlugins, globIgnore }) => {
-  if (!testPlugins || testPlugins.length === 0) return;
-  const unit = ['jest', 'mocha', 'vitest'];
-  const integration = ['cypress'];
-  const frameworks = [...unit, ...integration];
-  const frameworksRegex = new RegExp(frameworks.join('|'));
-
-  testPlugins.forEach((testPlugin) => {
-    const match = frameworksRegex.exec(testPlugin);
-    if (match) {
-      const matchedFramework = match[0];
-      if (unit.includes(matchedFramework)) {
-        files.add(`${generatorDir}/${matchedFramework}/*`, `${generatorDir}/${matchedFramework}/**/${globIgnore}`);
-      } else {
-        files.add(`${generatorDir}/${matchedFramework}/*`, `${generatorDir}/${matchedFramework}/**/*`);
-      }
-    }
-  });
-};
-
-/**
- * Add files & extend package.json for new apps.
- * @type {import('@gasket/core').HookHandler<'create'>}
- */
-export default async function create(gasket, context) {
-  const {
-    files,
-    typescript,
-    apiApp,
-    addApiRoutes = true,
-    testPlugins,
-    pkg,
-    gasketConfig
-  } = context;
-  const generatorDir = `${__dirname}/../generator`;
-
-  gasketConfig.addPlugin('pluginFastify', name);
-
-  pkg.add('dependencies', {
-    [name]: `^${version}`,
-    fastify: devDependencies.fastify
-  });
-
-  if (apiApp && addApiRoutes) {
-    const globIgnore = typescript ? '!(*.js)' : '!(*.ts)';
-    files.add(`${generatorDir}/app/**/${globIgnore}`);
-    gasketConfig.addPlugin('pluginRoutes', './plugins/routes-plugin.js');
-
-    createTestFiles({ files, generatorDir, testPlugins, globIgnore });
-  }
-}