build(ui-alerts,console): make documentation preview builds show console logs

INSTUI-4522

Author: ToMESSKa

.github/workflows/preview.yml

@@ -24,6 +24,8 @@ jobs:
       - name: Build docs-app
         run: npm run build:docs
         if: github.event.action != 'closed'
+        env:
+          GITHUB_PULL_REQUEST_PREVIEW: 'true'
       - uses: rossjrw/pr-preview-action@v1
         with:
           source-dir: ./packages/__docs__/__build__

packages/__docs__/babel.config.js

@@ -27,7 +27,8 @@ module.exports = {
     [
       require('@instructure/ui-babel-preset'),
       {
-        transformImports: false // needed for webpack reload on change to work,
+        transformImports: false,
+        removeConsole: false // needed for webpack reload on change to work,
       }
     ]
   ]

packages/__docs__/webpack.config.mjs

@@ -30,9 +30,12 @@ import { globbySync } from 'globby'
 import { merge } from 'webpack-merge'
 import { processSingleFile } from './lib/build-docs.mjs'
 import resolve from './resolve.mjs'
+import webpack from 'webpack'
+import TerserPlugin from 'terser-webpack-plugin'
 
 const ENV = process.env.NODE_ENV || 'production'
 const DEBUG = process.env.DEBUG || ENV === 'development'
+const GITHUB_PULL_REQUEST_PREVIEW = process.env.GITHUB_PULL_REQUEST_PREVIEW || 'false'
 
 const outputPath = resolvePath(import.meta.dirname, '__build__')
 const resolveAliases = DEBUG ? { resolve } : {}
@@ -79,6 +82,9 @@ const config = merge(baseConfig, {
       template: './src/index.html',
       chunks: ['main'],
     }),
+    new webpack.DefinePlugin({
+      'process.env.GITHUB_PULL_REQUEST_PREVIEW': JSON.stringify(GITHUB_PULL_REQUEST_PREVIEW),
+    }),
   ],
   optimization: {
     usedExports: true,

packages/console/src/console.ts

@@ -55,7 +55,11 @@ function logMessage(
   message: string,
   ...args: unknown[]
 ) {
-  if (process.env.NODE_ENV !== 'production' && !condition) {
+  if (
+    (process.env.GITHUB_PULL_REQUEST_PREVIEW ||
+      process.env.NODE_ENV !== 'production') &&
+    !condition
+  ) {
     if (typeof console[level] === 'function') {
       const renderStack = withRenderStack ? getRenderStack() : ''
       //@ts-expect-error level can be 'constructor' which is not callable

packages/ui-alerts/src/Alert/README.md

@@ -134,10 +134,11 @@ For more information about live regions, see
             return (
               <View key={alert.key} display="block" margin="small 0">
                 <Alert
+                  screenReaderOnly
                   variant={alert.variant}
                   renderCloseButtonLabel="Close"
                   onDismiss={alert.onDismiss}
-                  liveRegion={() => document.getElementById('flash-messages')}
+                  //liveRegion={() => document.getElementById('flash-messages')}
                   liveRegionPoliteness={alert.politeness}
                   margin="small 0"
                   variantScreenReaderLabel={this.getScreenReaderLabel(

packages/ui-alerts/src/Alert/index.tsx

@@ -308,6 +308,9 @@ class Alert extends Component<AlertProps, AlertState> {
   }
 
   render() {
+    // eslint-disable-next-line no-console
+    console.log('Hello from Alert')
+    console.warn('Warning from Alert')
     const liveRegion = this.getLiveRegion()
     const screenReaderContent = liveRegion
       ? this.createScreenReaderPortal(liveRegion)