@gasket/plugin-fastify 7.0.0-next.63 → 7.0.0-next.65

package/lib/create-servers.js

@@ -1,8 +1,6 @@
 /// <reference types="@gasket/plugin-https" />
 /// <reference types="@gasket/plugin-logger" />
 
-const { alignLogger } = require('./utils');
-
 /**
  * Create the Fastify instance and setup the lifecycle hooks.
  * Fastify is compatible with express middleware out of the box, so we can
@@ -11,34 +9,10 @@ const { alignLogger } = require('./utils');
  */
 // eslint-disable-next-line max-statements
 module.exports = async function createServers(gasket, serverOpts) {
-  const fastify = require('fastify');
-
-  const { config } = gasket;
-  const {
-    fastify: {
-      routes,
-      trustProxy = false
-    } = {},
-    http2
-  } = config;
-
-  const fastifyLogger = alignLogger(gasket.logger);
-
-  // @ts-ignore
-  const app = fastify({ logger: fastifyLogger, trustProxy, http2 });
-
+  const app = gasket.actions.getFastifyApp();
   // allow consuming apps to directly append options to their server
   await gasket.exec('fastify', app);
 
-  if (routes) {
-    for (const route of routes) {
-      if (typeof route !== 'function') {
-        throw new Error('Route must be a function');
-      }
-      await route(app);
-    }
-  }
-
   const postRenderingStacks = (await gasket.exec('errorMiddleware')).filter(Boolean);
   // @ts-ignore
   postRenderingStacks.forEach((stack) => app.use(stack));

package/lib/create.js

@@ -2,22 +2,58 @@
 
 const { name, version, devDependencies } = require('../package.json');
 
+/**
+ * createTestFiles
+ * @property {Files} files - The Gasket Files API.
+ * @property {generatorDir} - The directory of the generator.
+ * @property {testPlugins} - Array of selected test plugins
+ * @property {globIgnore} - Extension pattern to ignore
+ */
+function createTestFiles({ files, generatorDir, testPlugins, globIgnore }) {
+  if (!testPlugins || testPlugins.length === 0) return;
+  const unit = ['jest', 'mocha'];
+  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}/*/${globIgnore}`, `${generatorDir}/${matchedFramework}/**/${globIgnore}`);
+      } else {
+        files.add(`${generatorDir}/${matchedFramework}/*`, `${generatorDir}/${matchedFramework}/**/*`);
+      }
+    }
+  });
+}
+
 /**
  * Add files & extend package.json for new apps.
  * @type {import('@gasket/core').HookHandler<'create'>}
  */
 module.exports = async function create(gasket, context) {
+  const {
+    files,
+    typescript,
+    testPlugins,
+    pkg,
+    gasketConfig
+  } = context;
   const generatorDir = `${__dirname}/../generator`;
 
-  context.gasketConfig.addPlugin('pluginFastify', name);
+  gasketConfig.addPlugin('pluginFastify', name);
 
-  context.pkg.add('dependencies', {
+  pkg.add('dependencies', {
     [name]: `^${version}`,
     fastify: devDependencies.fastify
   });
 
   if ('apiApp' in context && context.apiApp) {
-    const glob = context.typescript ? '**/*.ts' : '**/*.js';
-    context.files.add(`${generatorDir}/${glob}`);
+    const globIgnore = typescript ? '!(*.js)' : '!(*.ts)';
+    files.add(`${generatorDir}/app/**/${globIgnore}`);
+
+    createTestFiles({ files, generatorDir, testPlugins, globIgnore });
   }
 };

package/lib/index.d.ts

@@ -4,13 +4,21 @@ import type {
   FastifyInstance,
   FastifyRequest,
   FastifyReply,
-  FastifyServerOptions
+  FastifyServerOptions,
+  FastifyBaseLogger,
+  FastifyTypeProviderDefault,
+  RawServerDefault
 } from 'fastify';
-import { Http2SecureServer, Http2ServerRequest, Http2ServerResponse } from 'http2'
+import { Http2SecureServer, Http2ServerRequest, Http2ServerResponse } from 'http2';
+import { IncomingMessage, ServerResponse } from 'http';
 
 export type AppRoutes = Array<MaybeAsync<(app: FastifyInstance) => void>>;
 
 declare module '@gasket/core' {
+  export interface GasketActions {
+    getFastifyApp(): FastifyInstance<RawServerDefault, IncomingMessage, ServerResponse<IncomingMessage>, FastifyBaseLogger, FastifyTypeProviderDefault>;
+  }
+
   export interface GasketConfig {
     fastify?: {
       /** Enable compression */
@@ -21,8 +29,6 @@ declare module '@gasket/core' {
       excludedRoutesRegex?: RegExp;
       /** Trust proxy configuration */
       trustProxy?: FastifyServerOptions['trustProxy'];
-      /** Glob pattern for source files setting up fastify routes */
-      routes?: Array<MaybeAsync<(app: FastifyInstance<Http2SecureServer, Http2ServerRequest, Http2ServerResponse>) => void>>;
     };
     /** Middleware configuration */
     middleware?: {
@@ -49,21 +55,16 @@ declare module '@gasket/core' {
 
   export interface HookExecTypes {
     middleware(
-      app: FastifyInstance<Http2SecureServer, Http2ServerRequest, Http2ServerResponse>
+      app: FastifyInstance<RawServerDefault, IncomingMessage, ServerResponse<IncomingMessage>, FastifyBaseLogger, FastifyTypeProviderDefault>
     ): MaybeAsync<MaybeMultiple<Handler> & { paths?: (string | RegExp)[] }>;
-    fastify(app: FastifyInstance<Http2SecureServer, Http2ServerRequest, Http2ServerResponse>): MaybeAsync<void>;
+    fastify(app: FastifyInstance<RawServerDefault, IncomingMessage, ServerResponse<IncomingMessage>, FastifyBaseLogger, FastifyTypeProviderDefault>): MaybeAsync<void>;
     errorMiddleware(): MaybeAsync<MaybeMultiple<ErrorHandler>>;
   }
 }
 
-type FastifyLogger = Logger & {
-  trace?: () => MaybeAsync<any>,
-  fatal?: () => MaybeAsync<any>
-}
-
 export function alignLogger(
   logger: Logger
-): FastifyLogger
+): FastifyBaseLogger
 
 declare module 'create-gasket-app' {
   export interface CreateContext {

package/lib/index.js

@@ -8,12 +8,28 @@ const {
 } = require('../package.json');
 const create = require('./create');
 const createServers = require('./create-servers');
+const fastify = require('fastify');
+const { alignLogger } = require('./utils');
+
+let app;
 
 /** @type {import('@gasket/core').Plugin} */
 const plugin = {
   name,
   version,
   description,
+  actions: {
+    getFastifyApp(gasket) {
+      const { fastify: fastifyConfig = {}, http2, https } = gasket.config;
+      const { trustProxy = false } = fastifyConfig;
+      const fastifyLogger = alignLogger(gasket.logger);
+
+      // @ts-ignore
+      app ??= fastify({ logger: fastifyLogger, trustProxy, https, http2 });
+
+      return app;
+    }
+  },
   hooks: {
     create,
     createServers,

package/lib/utils.js

@@ -1,3 +1,4 @@
+// @ts-nocheck
 /* eslint-disable no-console */
 const fallbackMap = {
   fatal: 'error',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gasket/plugin-fastify",
-  "version": "7.0.0-next.63",
+  "version": "7.0.0-next.65",
   "description": "Adds fastify support to your application",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
@@ -39,7 +39,7 @@
   },
   "homepage": "https://github.com/godaddy/gasket/tree/main/packages/gasket-plugin-fastify",
   "devDependencies": {
-    "@gasket/core": "7.0.0-next.63",
+    "@gasket/core": "7.0.0-next.65",
     "cross-env": "^7.0.3",
     "eslint": "^8.56.0",
     "eslint-config-godaddy": "^7.1.1",
@@ -71,5 +71,8 @@
   "eslintIgnore": [
     "generator"
   ],
-  "gitHead": "53d9d2f59b438d94d171eeac528c6aa2346c142e"
+  "jest": {
+    "rootDir": "test"
+  },
+  "gitHead": "93fb05fe933682704607eed6a2dfc870cf35c2d1"
 }