Skip to content

Commit

Permalink
Merge pull request #1362 from akhilmhdh/fix/tsup-cp-template
Browse files Browse the repository at this point in the history
feat: enabled tsup code splitting and esm directory import, removed manual copy of files
  • Loading branch information
maidul98 authored Feb 6, 2024
2 parents 0529b50 + 8de2302 commit 2d1b60a
Show file tree
Hide file tree
Showing 8 changed files with 438 additions and 273 deletions.
1 change: 0 additions & 1 deletion Dockerfile.standalone-infisical
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,6 @@ ENV NEXT_PUBLIC_INTERCOM_ID=$INTERCOM_ID \
WORKDIR /

COPY --from=backend-runner /app /backend
COPY --from=backend-runner /app/dist/services/smtp/templates /backend/dist/templates

COPY --from=frontend-runner /app ./backend/frontend-build

Expand Down
612 changes: 358 additions & 254 deletions backend/package-lock.json

Large diffs are not rendered by default.

17 changes: 9 additions & 8 deletions backend/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@
"name": "backend",
"version": "1.0.0",
"description": "",
"main": "index.js",
"main": "./dist/main.mjs",
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1",
"dev": "tsx watch --clear-screen=false ./src/main.ts | pino-pretty --colorize --colorizeObjects --singleLine",
"dev:docker": "nodemon",
"build": "rimraf dist && tsup && cp -R ./src/lib/validator/disposable_emails.txt ./dist && cp -R ./src/services/smtp/templates ./dist",
"build": "tsup",
"start": "node dist/main.mjs",
"type:check": "tsc --noEmit",
"lint:fix": "eslint --fix --ext js,ts ./src",
Expand Down Expand Up @@ -44,7 +44,13 @@
"@types/pg": "^8.10.9",
"@types/picomatch": "^2.3.3",
"@types/prompt-sync": "^4.2.3",
"@types/resolve": "^1.20.6",
"@types/uuid": "^9.0.7",
"@typescript-eslint/eslint-plugin": "^6.20.0",
"@typescript-eslint/parser": "^6.20.0",
"eslint": "^8.56.0",
"eslint-config-airbnb-base": "^15.0.0",
"eslint-config-airbnb-typescript": "^17.1.0",
"eslint-config-prettier": "^9.1.0",
"eslint-import-resolver-typescript": "^3.6.1",
"eslint-plugin-import": "^2.29.1",
Expand All @@ -55,6 +61,7 @@
"prompt-sync": "^4.2.0",
"rimraf": "^5.0.5",
"ts-node": "^10.9.1",
"tsc-alias": "^1.8.8",
"tsconfig-paths": "^4.2.0",
"tsup": "^8.0.1",
"tsx": "^4.4.0",
Expand All @@ -80,8 +87,6 @@
"@octokit/webhooks-types": "^7.3.1",
"@serdnam/pino-cloudwatch-transport": "^1.0.4",
"@sindresorhus/slugify": "^2.2.1",
"@typescript-eslint/eslint-plugin": "^6.20.0",
"@typescript-eslint/parser": "^6.20.0",
"@ucast/mongo2js": "^1.3.4",
"ajv": "^8.12.0",
"argon2": "^0.31.2",
Expand All @@ -91,9 +96,6 @@
"bcrypt": "^5.1.1",
"bullmq": "^5.1.1",
"dotenv": "^16.3.1",
"eslint": "^8.56.0",
"eslint-config-airbnb-base": "^15.0.0",
"eslint-config-airbnb-typescript": "^17.1.0",
"fastify": "^4.24.3",
"fastify-plugin": "^4.5.1",
"handlebars": "^4.7.8",
Expand All @@ -108,7 +110,6 @@
"nanoid": "^5.0.4",
"node-cache": "^5.1.2",
"nodemailer": "^6.9.7",
"ora": "^7.0.1",
"passport-github": "^1.1.0",
"passport-gitlab2": "^5.0.0",
"passport-google-oauth20": "^2.0.0",
Expand Down
6 changes: 3 additions & 3 deletions backend/src/server/app.ts
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,10 @@ import fasitfy from "fastify";
import { Knex } from "knex";
import { Logger } from "pino";

import { getConfig } from "@app/lib/config/env";
import { TQueueServiceFactory } from "@app/queue";
import { TSmtpService } from "@app/services/smtp/smtp-service";

import { getConfig } from "@lib/config/env";

import { globalRateLimiterCfg } from "./config/rateLimiter";
import { fastifyErrHandler } from "./plugins/error-handler";
import { registerExternalNextjs } from "./plugins/external-nextjs";
Expand All @@ -40,6 +39,7 @@ export const main = async ({ db, smtp, logger, queue }: TMain) => {
const server = fasitfy({
logger,
trustProxy: true,
connectionTimeout: 30 * 1000,
ignoreTrailingSlash: true
}).withTypeProvider<ZodTypeProvider>();

Expand Down Expand Up @@ -75,7 +75,7 @@ export const main = async ({ db, smtp, logger, queue }: TMain) => {
if (appCfg.isProductionMode) {
await server.register(registerExternalNextjs, {
standaloneMode: appCfg.STANDALONE_MODE,
dir: path.join(__dirname, "../"),
dir: path.join(__dirname, "../../"),
port: appCfg.PORT
});
}
Expand Down
3 changes: 3 additions & 0 deletions backend/src/server/plugins/external-nextjs.ts
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,9 @@ export const registerExternalNextjs = async (
server.route({
method: ["GET", "PUT", "PATCH", "POST", "DELETE"],
url: "/*",
schema: {
hide: true
},
handler: (req, res) =>
nextApp
.getRequestHandler()(req.raw, res.raw)
Expand Down
3 changes: 2 additions & 1 deletion backend/src/server/plugins/swagger.ts
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@ export const fastifySwagger = fp(async (fastify) => {
});

await fastify.register(swaggerUI, {
routePrefix: "/docs"
routePrefix: "/api/docs",
prefix: "/api/docs"
});
});
6 changes: 2 additions & 4 deletions backend/tsconfig.json
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,9 @@
"skipLibCheck": true,
"baseUrl": ".",
"paths": {
"@app/*": ["./src/*"],
"@lib/*": ["./src/lib/*"],
"@server/*": ["./src/server/*"]
"@app/*": ["./src/*"]
}
},
"include": ["src/**/*", "scripts/**/*", "e2e-test/**/*","./.eslintrc.js"],
"include": ["src/**/*", "scripts/**/*", "e2e-test/**/*", "./.eslintrc.js", "./tsup.config.js"],
"exclude": ["node_modules"]
}
63 changes: 61 additions & 2 deletions backend/tsup.config.js
Original file line number Diff line number Diff line change
@@ -1,14 +1,73 @@
/* eslint-disable */
import path from "node:path";

import fs from "fs/promises";
import { replaceTscAliasPaths } from "tsc-alias";
import { defineConfig } from "tsup";

// Instead of using tsx or tsc for building, consider using tsup.
// TSX serves as an alternative to Node.js, allowing you to build directly on the Node.js runtime.
// Its functionality mirrors Node.js, with the only difference being the absence of a final build step. Production should ideally be launched with TSX.
// TSC is effective for creating a final build, but it requires manual copying of all static files such as handlebars, emails, etc.
// A significant challenge is the shift towards ESM, as more packages are adopting ESM. If the output is in CommonJS, it may lead to errors.
// The suggested configuration offers a balance, accommodating both ESM and CommonJS requirements.

export default defineConfig({
shims: true,
clean: true,
minify: false,
keepNames: true,
splitting: false,
format: "esm",
// copy the files to output
loader: {
".handlebars": "copy",
".md": "copy"
".md": "copy",
".txt": "copy"
},
external: ["../../../frontend/node_modules/next/dist/server/next-server.js"],
outDir: "dist",
tsconfig: "./tsconfig.json",
entry: ["./src"],
sourceMap: "inline"
sourceMap: true,
skipNodeModulesBundle: true,
esbuildPlugins: [
{
// esm directory import are not allowed
// /folder1 should be explicitly imported as /folder1/index.ts
// this plugin will append it automatically on build time to all imports
name: "commonjs-esm-directory-import",
setup(build) {
build.onResolve({ filter: /.*/ }, async (args) => {
if (args.importer) {
if (args.kind === "import-statement") {
const isRelativePath = args.path.startsWith(".");
const absPath = isRelativePath
? path.join(args.resolveDir, args.path)
: path.join(args.path.replace("@app", "./src"));

const isFile = await fs
.stat(`${absPath}.ts`)
.then((el) => el.isFile)
.catch((err) => err.code === "ENOTDIR");

return {
path: isFile ? `${args.path}.mjs` : `${args.path}/index.mjs`,
external: true
};
}
}
return undefined;
});
}
}
],
async onSuccess() {
// this will replace all tsconfig paths
await replaceTscAliasPaths({
configFile: "tsconfig.json",
watch: false,
outDir: "dist"
});
}
});

0 comments on commit 2d1b60a

Please sign in to comment.