mrc-6062 Skeleton app #1
Conversation
| import morgan from "morgan"; | ||
| import { Dict } from "./types"; | ||
|
|
||
| export const initialiseLogging = (app: Application) => { |
There was a problem hiding this comment.
This format largely stolen from WODIN.
| registry: ghcr.io | ||
| username: ${{ github.actor }} | ||
| password: ${{ secrets.GITHUB_TOKEN }} | ||
| - name: Build docker image |
There was a problem hiding this comment.
we should probably be testing code first before pushing? because then we create bad images
There was a problem hiding this comment.
This just builds and pushes the image for the SHA tag though, and then we run that for the integration tests. The branch tag only gets pushed once the tests pass, so branch tag should always be good. We've used this pattern elsewhere.
| this.rootDir = rootDir; | ||
| } | ||
|
|
||
| readConfigFile(...filePath: string[]): object | null { |
There was a problem hiding this comment.
if the function / class is for reading config files, should it be allowed to have parameters? I think the filePath could be something known by ConfigReader. are we expecting there to be other config files to read?
There was a problem hiding this comment.
Debatable I think. This class was largely ripped off from WODIN where we certainly does have multiple config files. We may end up with multiple config files in grout, I think it's still tbd.
Either way I think it's ok for the server module to centralise knowledge of where all the folders are. That's the approach I've been taking anyway!
|
|
||
| export class IndexController { | ||
| static getIndex = (_req: Request, res: Response) => { | ||
| const version = process.env.npm_package_version; |
There was a problem hiding this comment.
How does this value get into the process.env object?
There was a problem hiding this comment.
Through the magic of running from an npm script :)
https://docs.npmjs.com/cli/v9/using-npm/scripts#packagejson-vars
|
|
||
| export const initialiseLogging = (app: Application) => { | ||
| const customFormat = ( | ||
| tokens: Dict<(req: Request, res: Response, header?: string) => string>, |
There was a problem hiding this comment.
Not able to parse this - what does 'tokens' refer to?
There was a problem hiding this comment.
It refers to the bits of information relating to a request/response pair which can be logged by morgan (the logging package). As you can see from the type, these are actually functions, and this whole customFormat method is passed to morgan to tell it how to log requests.
There was a problem hiding this comment.
It's confusing, but I guess all is explained in the morgan docs.
This branch implements a basic express server that doesn't do anything except return package version. It includes:
The next branch will include some example datasets and returning tile data.
To do, in subsequent tickets: coverage and error handling