refactor(platform-server): Add private profiler. (angular#56274)

The commit adds a private profiler to investigate SSR performance.

PR Close angular#56274

Author: JeanMeche

packages/platform-server/src/private_export.ts

@@ -11,3 +11,7 @@ export {
   SERVER_RENDER_PROVIDERS as ɵSERVER_RENDER_PROVIDERS,
 } from './server';
 export {SERVER_CONTEXT as ɵSERVER_CONTEXT} from './utils';
+export {
+  enableSsrProfiling as ɵenableSsrProfiling,
+  disableSsrProfiling as ɵdisableSsrProfiling,
+} from './profiler';

packages/platform-server/src/profiler.ts

@@ -0,0 +1,64 @@
+/**
+ * @license
+ * Copyright Google LLC All Rights Reserved.
+ *
+ * Use of this source code is governed by an MIT-style license that can be
+ * found in the LICENSE file at https://angular.io/license
+ */
+
+const PERFORMANCE_MARK_PREFIX = '🅰️';
+
+let enablePerfLogging = false;
+
+export function runAndMeasurePerf<T>(label: string, method: () => T): T {
+  if (!enablePerfLogging) {
+    return method();
+  }
+
+  const labelName = `${PERFORMANCE_MARK_PREFIX}:${label}`;
+  const startLabel = `start:${labelName}`;
+  const endLabel = `end:${labelName}`;
+
+  const end = () => {
+    /* tslint:disable:ban */
+    performance.mark(endLabel);
+    performance.measure(labelName, startLabel, endLabel);
+    performance.clearMarks(startLabel);
+    performance.clearMarks(endLabel);
+    /* tslint:enable:ban */
+  };
+
+  /* tslint:disable:ban */
+  performance.mark(startLabel);
+  /* tslint:enable:ban */
+
+  const returnValue = method();
+  if (returnValue instanceof Promise) {
+    return returnValue.finally(() => end()) as T;
+  } else {
+    end();
+    return returnValue;
+  }
+}
+
+let warningLogged = false;
+/**
+ * This enables an internal performance profiler for SSR apps
+ *
+ * It should not be imported in application code
+ */
+export function enableSsrProfiling() {
+  if (
+    !warningLogged &&
+    (typeof performance === 'undefined' || !performance.mark || !performance.measure)
+  ) {
+    warningLogged = true;
+    console.warn('Performance API is not supported on this platform');
+    return;
+  }
+
+  enablePerfLogging = true;
+}
+export function disableSsrProfiling() {
+  enablePerfLogging = false;
+}

packages/platform-server/src/utils.ts

@@ -26,6 +26,7 @@ import {PlatformState} from './platform_state';
 import {platformServer} from './server';
 import {BEFORE_APP_SERIALIZED, INITIAL_CONFIG} from './tokens';
 import {createScript} from './transfer_state';
+import {runAndMeasurePerf} from './profiler';
 
 /**
  * Event dispatch (JSAction) script is inlined into the HTML by the build
@@ -145,7 +146,9 @@ function insertEventRecordScript(
     // This is defined in packages/core/primitives/event-dispatch/contract_binary.ts
     const replayScriptContents = `window.__jsaction_bootstrap('ngContracts', document.body, ${JSON.stringify(
       appId,
-    )}, ${JSON.stringify(Array.from(regular))}${capture.size ? ',' + JSON.stringify(Array.from(capture)) : ''});`;
+    )}, ${JSON.stringify(Array.from(regular))}${
+      capture.size ? ',' + JSON.stringify(Array.from(capture)) : ''
+    });`;
 
     const replayScript = createScript(doc, replayScriptContents, nonce);
 
@@ -272,7 +275,10 @@ export async function renderApplication<T>(
   bootstrap: () => Promise<ApplicationRef>,
   options: {document?: string | Document; url?: string; platformProviders?: Provider[]},
 ): Promise<string> {
-  const platformRef = createServerPlatform(options);
-  const applicationRef = await bootstrap();
-  return _render(platformRef, applicationRef);
+  return runAndMeasurePerf('renderApplication', async () => {
+    const platformRef = createServerPlatform(options);
+
+    const applicationRef = await bootstrap();
+    return _render(platformRef, applicationRef);
+  });
 }