fix morgan middleware request logging

Author: Phil Varner

CHANGELOG.md

@@ -14,8 +14,10 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 ### Changed
 
 - Log level must be configured with lowercase values error, warn, info, http, verbose, debug, silly instead of uppercase values (this config had no effect before)
-- Search query and response body is now logged at level debug rather than info
-- Ingested item body is now logged at level debug rather than info
+- Default request logging format is now "tiny" instead of "dev". Previously, the "dev" format
+  wrote color codes into CloudWatch logs, which cluttered output, as they were not used in display.
+- Search query and response body is now logged at level "debug" rather than "info"
+- Ingested item body is now logged at level "debug" rather than "info"
 
 ## [0.5.2] - 2023-01-17
 

README.md

@@ -404,6 +404,8 @@ There are some settings that should be reviewed and updated as needeed in the se
 | STAC_DOCS_URL                    | URL to documentation                                                                                                                                                                             | [https://stac-utils.github.io/stac-server](https://stac-utils.github.io/stac-server) |
 | INGEST_BATCH_SIZE                | Number of records to ingest in single batch                                                                                                                                                      | 500                                                                                  |
 | LOG_LEVEL                        | Level for logging (error, warn, info, http, verbose, debug, silly)                                                                                                                               | INFO                                                                                 |
+| REQUEST_LOGGING_ENABLED                        | Express request logging enabled. String 'false' disables.                                                                                                                               | enabled                                                                                 |
+| REQUEST_LOGGING_FORMAT                        | Express request logging format to use. Any of the [Morgan predefined formats](https://github.com/expressjs/morgan#predefined-formats).                                                                                                                           | tiny                                                                                 |
 | STAC_API_URL                     | The root endpoint of this API                                                                                                                                                                    | Inferred from request                                                                |
 | ENABLE_TRANSACTIONS_EXTENSION    | Boolean specifying if the [Transaction Extension](https://github.com/radiantearth/stac-api-spec/tree/master/ogcapi-features/extensions/transaction) should be activated                          | false                                                                                |
 | STAC_API_ROOTPATH                | The path to append to URLs if this is not deployed at the server root. For example, if the server is deployed without a custom domain name, it will have the stage name (e.g., dev) in the path. | ""                                                                                   |

bin/system-tests.sh

@@ -7,6 +7,7 @@ TEST_PATTERN=${1:-test-*.[jt]s}
 export AWS_ACCESS_KEY_ID='none'
 export AWS_SECRET_ACCESS_KEY='none'
 export ENABLE_TRANSACTIONS_EXTENSION=true
+export REQUEST_LOGGING_ENABLED=false
 
 echo "Running tests"
 set +e

package.json

@@ -19,7 +19,7 @@
     "audit-prod": "npx better-npm-audit audit --production",
     "deploy": "sls deploy",
     "package": "sls package",
-    "serve": "LOG_LEVEL=debug STAC_API_URL=http://localhost:3000 ENABLE_TRANSACTIONS_EXTENSION=true nodemon ./src/lambdas/api/local.ts",
+    "serve": "REQUEST_LOGGING_FORMAT=dev LOG_LEVEL=debug STAC_API_URL=http://localhost:3000 ENABLE_TRANSACTIONS_EXTENSION=true nodemon ./src/lambdas/api/local.ts",
     "build-api-docs": "npm run widdershins --search false --language_tabs 'nodejs:NodeJS' 'python:Python' --summary ./packages/api-lib/api-spec.yaml -o ./docs/api.md & npm run shins --inline --logo ./docs/images/logo.png -o ./docs/index.html ./docs/api.md"
   },
   "pre-commit": {

src/lambdas/api/app.js

@@ -22,7 +22,10 @@ const txnEnabled = process.env['ENABLE_TRANSACTIONS_EXTENSION'] === 'true'
 
 const app = express()
 
-app.use(morgan('dev'))
+if (process.env['REQUEST_LOGGING_ENABLED'] !== 'false') {
+  app.use(morgan(process.env['REQUEST_LOGGING_FORMAT'] || 'tiny'))
+}
+
 app.use(cors())
 app.use(express.json({ limit: '1mb' }))
 app.use(addEndpoint)