feat: server side rendering

sonallux · sonallux · commit 70e2730f89cf · 2024-03-14T22:07:35.000+01:00
diff --git a/angular.json b/angular.json
@@ -25,7 +25,12 @@
             "inlineStyleLanguage": "scss",
             "assets": ["src/favicon.ico", "src/assets"],
             "styles": ["src/styles.scss"],
-            "scripts": []
+            "scripts": [],
+            "server": "src/main.server.ts",
+            "prerender": false,
+            "ssr": {
+              "entry": "server.ts"
+            }
           },
           "configurations": {
             "production": {
diff --git a/package.json b/package.json
@@ -9,7 +9,8 @@
     "watch": "ng build --watch --configuration development",
     "test": "ng test",
     "test:ci": "ng test --browsers=ChromeHeadless --watch=false --code-coverage",
-    "measure": "node scripts/measure.mjs"
+    "measure": "node scripts/measure.mjs",
+    "serve:ssr": "node dist/angular-music/server/server.mjs"
   },
   "private": true,
   "dependencies": {
diff --git a/server.ts b/server.ts
@@ -0,0 +1,70 @@
+import { APP_BASE_HREF } from '@angular/common';
+import { CommonEngine } from '@angular/ssr';
+import express from 'express';
+import cookieParser from 'cookie-parser';
+import { fileURLToPath } from 'node:url';
+import { dirname, join, resolve } from 'node:path';
+import bootstrap from './src/main.server';
+import { REQUEST, RESPONSE } from './src/app/ssr.tokens';
+
+// The Express app is exported so that it can be used by serverless Functions.
+export function app(): express.Express {
+  const server = express();
+  const serverDistFolder = dirname(fileURLToPath(import.meta.url));
+  const browserDistFolder = resolve(serverDistFolder, '../browser');
+  const indexHtml = join(serverDistFolder, 'index.server.html');
+
+  server.use(cookieParser());
+
+  const commonEngine = new CommonEngine();
+
+  server.set('view engine', 'html');
+  server.set('views', browserDistFolder);
+
+  // Example Express Rest API endpoints
+  // server.get('/api/**', (req, res) => { });
+  // Serve static files from /browser
+  server.get(
+    '*.*',
+    express.static(browserDistFolder, {
+      maxAge: '1y',
+    }),
+  );
+
+  // All regular routes use the Angular engine
+  server.get('*', (req, res, next) => {
+    const { protocol, originalUrl, baseUrl, headers } = req;
+
+    // The server.ts not used for ng serve, so REQUEST and RESPONSE tokens won't be set
+    // https://github.com/angular/angular-cli/issues/26323
+
+    commonEngine
+      .render({
+        bootstrap,
+        documentFilePath: indexHtml,
+        url: `${protocol}://${headers.host}${originalUrl}`,
+        publicPath: browserDistFolder,
+        providers: [
+          { provide: APP_BASE_HREF, useValue: baseUrl },
+          { provide: REQUEST, useValue: req },
+          { provide: RESPONSE, useValue: res },
+        ],
+      })
+      .then((html) => res.send(html))
+      .catch((err) => next(err));
+  });
+
+  return server;
+}
+
+// function run(): void {
+//   const port = process.env['PORT'] || 4000;
+//
+//   // Start up the Node server
+//   const server = app();
+//   server.listen(port, () => {
+//     console.log(`Node Express server listening on http://localhost:${port}`);
+//   });
+// }
+//
+// run();
diff --git a/src/app/app.config.server.ts b/src/app/app.config.server.ts
@@ -0,0 +1,22 @@
+import { ApplicationConfig, mergeApplicationConfig } from '@angular/core';
+import { provideServerRendering } from '@angular/platform-server';
+import { appConfig } from './app.config';
+import { ServerCacheStoreService } from './spotify-client/server-cache-store.service';
+import { CACHE_STORE_TOKEN } from './spotify-client/spotify-client.service';
+import { mockResizeObserverFactory, RESIZE_OBSERVER_FACTORY } from './shared/resize-observer';
+
+const serverConfig: ApplicationConfig = {
+  providers: [
+    provideServerRendering(),
+    {
+      provide: CACHE_STORE_TOKEN,
+      useClass: ServerCacheStoreService,
+    },
+    {
+      provide: RESIZE_OBSERVER_FACTORY,
+      useValue: mockResizeObserverFactory,
+    },
+  ],
+};
+
+export const config = mergeApplicationConfig(appConfig, serverConfig);
diff --git a/src/app/app.config.ts b/src/app/app.config.ts
@@ -1,23 +1,30 @@
 import { ApplicationConfig } from '@angular/core';
 import { provideAnimationsAsync } from '@angular/platform-browser/animations/async';
-import { provideRouter, withRouterConfig } from '@angular/router';
+import {
+  provideRouter,
+  withEnabledBlockingInitialNavigation,
+  withRouterConfig,
+} from '@angular/router';
 import { routes } from './app.routes';
-import { provideHttpClient, withInterceptors } from '@angular/common/http';
+import { provideHttpClient, withFetch, withInterceptors } from '@angular/common/http';
 import { authenticationInterceptor } from './spotify-client/authentication.interceptor';
 import { CACHE_STORE_TOKEN } from './spotify-client/spotify-client.service';
 import { BrowserCacheStoreService } from './spotify-client/browser-cache-store.service';
+import { provideClientHydration } from '@angular/platform-browser';
 
 export const appConfig: ApplicationConfig = {
   providers: [
     provideAnimationsAsync(),
     provideRouter(
       routes,
       withRouterConfig({ onSameUrlNavigation: 'reload' }),
+      withEnabledBlockingInitialNavigation(),
     ),
-    provideHttpClient(withInterceptors([authenticationInterceptor])),
+    provideHttpClient(withFetch(), withInterceptors([authenticationInterceptor])),
     {
       provide: CACHE_STORE_TOKEN,
       useClass: BrowserCacheStoreService,
     },
+    provideClientHydration(),
   ],
 };
diff --git a/src/app/shared/card-list/card-list.component.ts b/src/app/shared/card-list/card-list.component.ts
@@ -4,13 +4,15 @@ import {
   Component,
   ElementRef,
   EventEmitter,
+  Inject,
   Input,
   OnDestroy,
   Output,
   ViewChild,
 } from '@angular/core';
 import { CardItem, ClickableCardComponent } from '../clickable-card/clickable-card.component';
 import { NgClass } from '@angular/common';
+import { RESIZE_OBSERVER_FACTORY, ResizeObserverFactory } from '../resize-observer';
 
 const CARD_WIDTH = 128;
 const GAB_WIDTH = 24;
@@ -38,8 +40,11 @@ export class CardListComponent implements AfterViewInit, OnDestroy {
 
   private resizeObserver: ResizeObserver;
 
-  constructor(private cdr: ChangeDetectorRef) {
-    this.resizeObserver = new ResizeObserver(this.onResize);
+  constructor(
+    private cdr: ChangeDetectorRef,
+    @Inject(RESIZE_OBSERVER_FACTORY) resizeObserverFactory: ResizeObserverFactory,
+  ) {
+    this.resizeObserver = resizeObserverFactory(this.onResize);
   }
 
   ngAfterViewInit(): void {
diff --git a/src/app/shared/hero-header/hero-header.component.ts b/src/app/shared/hero-header/hero-header.component.ts
@@ -1,5 +1,5 @@
-import { Component, inject, Input, NgZone, OnChanges, SimpleChanges } from '@angular/core';
-import { NgOptimizedImage } from '@angular/common';
+import { Component, inject, Input, NgZone, OnChanges, PLATFORM_ID, SimpleChanges } from '@angular/core';
+import { isPlatformBrowser, NgOptimizedImage } from '@angular/common';
 import { injectLazy } from 'ngxtension/inject-lazy';
 import { findBestMatchingImage, Image } from '../images';
 
@@ -15,6 +15,7 @@ export class HeroHeaderComponent implements OnChanges {
     () => import('./hero-header-animation.service'),
   );
   private readonly ngZone = inject(NgZone);
+  private isBrowser = isPlatformBrowser(inject(PLATFORM_ID));
 
   @Input({ required: true }) heroData!: HeroData | null;
   headerImage = '';
@@ -30,9 +31,11 @@ export class HeroHeaderComponent implements OnChanges {
   }
 
   private initAnimation() {
-    this.heroHeaderAnimation$.subscribe((animation) =>
-      this.ngZone.runOutsideAngular(() => animation.init()),
-    );
+    if (this.isBrowser) {
+      this.heroHeaderAnimation$.subscribe((animation) =>
+        this.ngZone.runOutsideAngular(() => animation.init()),
+      );
+    }
   }
 }
 
diff --git a/src/app/shared/resize-observer.ts b/src/app/shared/resize-observer.ts
@@ -0,0 +1,21 @@
+import { InjectionToken } from '@angular/core';
+
+export type ResizeObserverFactory = (callback: ResizeObserverCallback) => ResizeObserver;
+
+const browserResizeObserverFactory: ResizeObserverFactory = (callback) =>
+  new ResizeObserver(callback);
+
+export const RESIZE_OBSERVER_FACTORY = new InjectionToken<ResizeObserverFactory>(
+  'ResizeObserverFactory',
+  {
+    factory: () => browserResizeObserverFactory,
+  },
+);
+
+export const mockResizeObserverFactory: ResizeObserverFactory = () => mockResizeObserver;
+
+const mockResizeObserver: ResizeObserver = {
+  observe() {},
+  disconnect() {},
+  unobserve() {},
+};
diff --git a/src/app/spotify-client/server-cache-store.service.ts b/src/app/spotify-client/server-cache-store.service.ts
@@ -0,0 +1,49 @@
+import { inject, Injectable } from '@angular/core';
+import { ICacheStore } from '@spotify/web-api-ts-sdk/src/caching/ICacheStore';
+import { REQUEST, RESPONSE } from '../ssr.tokens';
+
+// Firebase hosting only allows the `__session` cookie
+// https://firebase.google.com/docs/hosting/manage-cache#using_cookies
+const sessionCookieKey = '__session';
+
+@Injectable()
+export class ServerCacheStoreService implements ICacheStore {
+  // use "optional: true" to work with pre rendering and ng serve
+  // https://github.com/angular/angular-cli/issues/26323
+  private readonly request = inject(REQUEST, { optional: true });
+  private readonly response = inject(RESPONSE, { optional: true });
+
+  get(key: string): string | null {
+    return this.getSessionCookie()?.[key] ?? null;
+  }
+
+  remove(key: string): void {
+    const sessionCookie = this.getSessionCookie();
+    if (sessionCookie) {
+      delete sessionCookie[key];
+      this.saveSessionCookie(sessionCookie);
+    }
+  }
+
+  set(key: string, value: string): void {
+    const sessionCookie = this.getSessionCookie() ?? {};
+    sessionCookie[key] = value;
+    this.saveSessionCookie(sessionCookie);
+  }
+
+  private getSessionCookie(): Record<string, string> | null {
+    const sessionCookie = this.request?.cookies[sessionCookieKey];
+    if (!sessionCookie) {
+      return null;
+    }
+    return JSON.parse(sessionCookie);
+  }
+
+  private saveSessionCookie(sessionCookie: Record<string, string>) {
+    if (Object.keys(sessionCookie).length === 0) {
+      this.response?.clearCookie(sessionCookieKey);
+    } else {
+      this.response?.cookie(sessionCookieKey, JSON.stringify(sessionCookie), { maxAge: 604800000 });
+    }
+  }
+}
diff --git a/src/app/spotify-client/spotify-client.service.ts b/src/app/spotify-client/spotify-client.service.ts
@@ -1,7 +1,9 @@
-import { Inject, Injectable, InjectionToken } from '@angular/core';
+import { Inject, Injectable, InjectionToken, Optional } from '@angular/core';
 import { SpotifyAuthentication } from './spotify-authentication';
 import { ICacheStore } from '@spotify/web-api-ts-sdk';
 import { DOCUMENT } from '@angular/common';
+import { REQUEST } from '../ssr.tokens';
+import { Request } from 'express';
 
 const CLIENT_ID = 'eda234756aae490988e32cb92412225d';
 
@@ -16,8 +18,13 @@ export class SpotifyClientService {
   constructor(
     @Inject(CACHE_STORE_TOKEN) cacheStore: ICacheStore,
     @Inject(DOCUMENT) document: Document,
+    @Inject(REQUEST) @Optional() request: Request,
   ) {
-    const redirectUri = `${document.location.origin}/callback`;
+    // TODO move somewhere else
+    const host = request
+      ? request.header('x-forwarded-proto') + `://` + request.header('x-forwarded-host')
+      : document.location.origin;
+    const redirectUri = `${host}/callback`;
     this.spotifyAuthentication = new SpotifyAuthentication(
       CLIENT_ID,
       redirectUri,
diff --git a/src/app/ssr.tokens.ts b/src/app/ssr.tokens.ts
@@ -0,0 +1,6 @@
+import { InjectionToken } from '@angular/core';
+import { Request, Response } from 'express';
+
+// https://github.com/angular/angular-cli/issues/26110
+export const REQUEST: InjectionToken<Request> = new InjectionToken<Request>('REQUEST');
+export const RESPONSE: InjectionToken<Response> = new InjectionToken<Response>('RESPONSE');
diff --git a/src/main.server.ts b/src/main.server.ts
@@ -0,0 +1,7 @@
+import { bootstrapApplication } from '@angular/platform-browser';
+import { AppComponent } from './app/app.component';
+import { config } from './app/app.config.server';
+
+const bootstrap = () => bootstrapApplication(AppComponent, config);
+
+export default bootstrap;
diff --git a/tsconfig.app.json b/tsconfig.app.json
@@ -3,8 +3,8 @@
   "extends": "./tsconfig.json",
   "compilerOptions": {
     "outDir": "./out-tsc/app",
-    "types": []
+    "types": ["node"]
   },
-  "files": ["src/main.ts"],
+  "files": ["src/main.ts", "src/main.server.ts", "server.ts"],
   "include": ["src/**/*.d.ts"]
 }
