Migrate server code to server/index.ts and simplify processes (#1066)

* Migrate server-side code to `server/index.ts`, remove `server-build` structure, and streamline build and dev processes

* Update Node.js engine requirement to `^22.18.0` in package configuration and documentation

* Fix types in test

* Fix types in test

Author: kasperpeulen

.gitignore

@@ -2,7 +2,6 @@ node_modules
 .DS_store
 
 /build
-/server-build
 .env
 .cache
 

.prettierignore

@@ -2,7 +2,6 @@ node_modules
 
 /build
 /public/build
-/server-build
 .env
 
 /test-results/

app/routes/_auth/auth.$provider/callback.test.ts

@@ -2,6 +2,7 @@ import { invariant } from '@epic-web/invariant'
 import { faker } from '@faker-js/faker'
 import { SetCookie } from '@mjackson/headers'
 import { http } from 'msw'
+import { type AppLoadContext } from 'react-router'
 import { afterEach, expect, test } from 'vitest'
 import { twoFAVerificationType } from '#app/routes/settings/profile/two-factor/_layout.tsx'
 import { getSessionExpirationDate, sessionKey } from '#app/utils/auth.server.ts'
@@ -25,9 +26,11 @@ afterEach(async () => {
 
 test('a new user goes to onboarding', async () => {
 	const request = await setupRequest()
-	const response = await loader({ request, params: PARAMS, context: {} }).catch(
-		(e) => e,
-	)
+	const response = await loader({
+		request,
+		params: PARAMS,
+		context: {} as AppLoadContext,
+	}).catch((e) => e)
 	expect(response).toHaveRedirect('/onboarding/github')
 })
 
@@ -39,9 +42,11 @@ test('when auth fails, send the user to login with a toast', async () => {
 		}),
 	)
 	const request = await setupRequest()
-	const response = await loader({ request, params: PARAMS, context: {} }).catch(
-		(e) => e,
-	)
+	const response = await loader({
+		request,
+		params: PARAMS,
+		context: {} as AppLoadContext,
+	}).catch((e) => e)
 	invariant(response instanceof Response, 'response should be a Response')
 	expect(response).toHaveRedirect('/login')
 	await expect(response).toSendToast(
@@ -60,7 +65,11 @@ test('when a user is logged in, it creates the connection', async () => {
 		sessionId: session.id,
 		code: githubUser.code,
 	})
-	const response = await loader({ request, params: PARAMS, context: {} })
+	const response = await loader({
+		request,
+		params: PARAMS,
+		context: {} as AppLoadContext,
+	})
 	expect(response).toHaveRedirect('/settings/profile/connections')
 	await expect(response).toSendToast(
 		expect.objectContaining({
@@ -96,7 +105,11 @@ test(`when a user is logged in and has already connected, it doesn't do anything
 		sessionId: session.id,
 		code: githubUser.code,
 	})
-	const response = await loader({ request, params: PARAMS, context: {} })
+	const response = await loader({
+		request,
+		params: PARAMS,
+		context: {} as AppLoadContext,
+	})
 	expect(response).toHaveRedirect('/settings/profile/connections')
 	await expect(response).toSendToast(
 		expect.objectContaining({
@@ -111,7 +124,11 @@ test('when a user exists with the same email, create connection and make session
 	const email = githubUser.primaryEmail.toLowerCase()
 	const { userId } = await setupUser({ ...createUser(), email })
 	const request = await setupRequest({ code: githubUser.code })
-	const response = await loader({ request, params: PARAMS, context: {} })
+	const response = await loader({
+		request,
+		params: PARAMS,
+		context: {} as AppLoadContext,
+	})
 
 	expect(response).toHaveRedirect('/')
 
@@ -155,7 +172,11 @@ test('gives an error if the account is already connected to another user', async
 		sessionId: session.id,
 		code: githubUser.code,
 	})
-	const response = await loader({ request, params: PARAMS, context: {} })
+	const response = await loader({
+		request,
+		params: PARAMS,
+		context: {} as AppLoadContext,
+	})
 	expect(response).toHaveRedirect('/settings/profile/connections')
 	await expect(response).toSendToast(
 		expect.objectContaining({
@@ -178,7 +199,11 @@ test('if a user is not logged in, but the connection exists, make a session', as
 		},
 	})
 	const request = await setupRequest({ code: githubUser.code })
-	const response = await loader({ request, params: PARAMS, context: {} })
+	const response = await loader({
+		request,
+		params: PARAMS,
+		context: {} as AppLoadContext,
+	})
 	expect(response).toHaveRedirect('/')
 	await expect(response).toHaveSessionForUser(userId)
 })
@@ -202,7 +227,11 @@ test('if a user is not logged in, but the connection exists and they have enable
 		},
 	})
 	const request = await setupRequest({ code: githubUser.code })
-	const response = await loader({ request, params: PARAMS, context: {} })
+	const response = await loader({
+		request,
+		params: PARAMS,
+		context: {} as AppLoadContext,
+	})
 	const searchParams = new URLSearchParams({
 		type: twoFAVerificationType,
 		target: userId,

app/routes/_seo/sitemap[.]xml.ts

@@ -1,14 +1,11 @@
 import { generateSitemap } from '@nasa-gcn/remix-seo'
-import { type ServerBuild } from 'react-router'
 import { getDomainUrl } from '#app/utils/misc.tsx'
 import { type Route } from './+types/sitemap[.]xml.ts'
 
 export async function loader({ request, context }: Route.LoaderArgs) {
-	const serverBuild = (await context.serverBuild) as { build: ServerBuild }
-
 	// TODO: This is typeerror is coming up since of the remix-run/server-runtime package. We might need to remove/update that one.
 	// @ts-expect-error
-	return generateSitemap(request, serverBuild.build.routes, {
+	return generateSitemap(request, context.serverBuild.routes, {
 		siteUrl: getDomainUrl(request),
 		headers: {
 			'Cache-Control': `public, max-age=${60 * 5}`,

docs/authentication.md

@@ -44,8 +44,8 @@ is a precondition for a "Mock GitHub server" to be installed (with the help of
 calls to `https://github.com/login/oauth/access_token` are being intercepted.
 But once deployed to an environment where `process.env.MOCKS` is not set to
 `'true'` (see how this is done when launching the
-[dev server](../server/dev-server.js) and checked in the
-[entrypoint](../index.js)), or even when developing _locally_ but not setting
+[server](../server/index.ts) and checked in the
+[entrypoint](../index.ts)), or even when developing _locally_ but not setting
 `GITHUB_CLIENT_ID` to `MOCK_...`, the requests will actually reach the GitHub
 auth server. This is where you will want to have a GitHub OAuth application
 properly set up, otherwise the logging in with GitHub will fail and a

docs/managing-updates.md

@@ -12,14 +12,11 @@ If you wish to change the Node.js version, you can do so by updating the
 ```json
 {
 	"engines": {
-		"node": "20.3.1"
+		"node": "^22.18.0"
 	}
 }
 ```
 
-Make certain you do not use a version range here because this is used in the
-`./other/build-server.ts` to compile the express server code.
-
 You will also want to update the `Dockerfile` to use the same version of Node.js
 as the `package.json` file.
 

index.js index.tsindex.js renamed to index.ts

@@ -20,8 +20,4 @@ if (process.env.MOCKS === 'true') {
 	await import('./tests/mocks/index.ts')
 }
 
-if (process.env.NODE_ENV === 'production') {
-	await import('./server-build/index.js')
-} else {
-	await import('./server/index.ts')
-}
+await import('./server/index.ts')

other/Dockerfile

@@ -81,7 +81,6 @@ RUN INTERNAL_COMMAND_TOKEN=$(openssl rand -hex 32) && \
 COPY --from=production-deps /myapp/node_modules /myapp/node_modules
 COPY --from=build /myapp/node_modules/.prisma /myapp/node_modules/.prisma
 
-COPY --from=build /myapp/server-build /myapp/server-build
 COPY --from=build /myapp/build /myapp/build
 COPY --from=build /myapp/package.json /myapp/package.json
 COPY --from=build /myapp/prisma /myapp/prisma