mrc-6023 Add static build in wodin #236
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| const doc = ` | ||
| Usage: | ||
| builder <path-to-config> <dest-path> <path-to-mustache-views> | ||
|
There was a problem hiding this comment. Yeah. the views path doesn't seem like it needs to be a parameter as it's not something that should change per build..? There was a problem hiding this comment. it can change between development and production, it depends on the folder structure of the dist folder, which may not be the same as the folder structure of our app/server directory, i guess we can also force them to be the same and hardcode that path in wodin builder as well but felt nice to give that flexibility There was a problem hiding this comment. I'd assumed this would always be done from a development context, but yeah I suppose it doesn't have to be! |
||
| `; | ||
|
|
||
| import { docopt } from "docopt"; | ||
| import { version } from "../version"; | ||
|
|
||
| export const processArgs = (argv: string[] = process.argv) => { | ||
| const opts = docopt(doc, { argv: argv.slice(2), version, exit: false }); | ||
| const configPath = opts["<path-to-config>"] as string; | ||
| const destPath = opts["<dest-path>"] as string; | ||
| const viewsPath = opts["<path-to-mustache-views>"] as string; | ||
| return { configPath, destPath, viewsPath }; | ||
| }; | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,97 @@ | ||
| import path from "path"; | ||
| import fs from "fs"; | ||
| import { ConfigReader } from "../configReader"; | ||
| import { AppConfig, WodinConfig } from "../types"; | ||
| import { version as wodinVersion } from "../version"; | ||
| import { render } from "mustache"; | ||
| import { ConfigController } from "../controllers/configController"; | ||
| import { AppFileReader } from "../appFileReader"; | ||
| import axios from "axios"; | ||
| import { processArgs } from "./args"; | ||
|
|
||
| const mkdirForce = (path: string) => { | ||
| if (!fs.existsSync(path)) { | ||
| fs.mkdirSync(path); | ||
| } | ||
| }; | ||
|
|
||
| const { configPath, destPath, viewsPath } = processArgs(); | ||
|
|
||
| const pathResolved = path.resolve(configPath); | ||
| const configReader = new ConfigReader(pathResolved); | ||
| const defaultCodeReader = new AppFileReader(`${pathResolved}/defaultCode`, "R"); | ||
| const appHelpReader = new AppFileReader(`${pathResolved}/help`, "md"); | ||
| const wodinConfig = configReader.readConfigFile("wodin.config.json") as WodinConfig; | ||
|
|
||
| mkdirForce(destPath); | ||
| const appsPathFull = path.resolve(destPath, wodinConfig.appsPath); | ||
| if (fs.existsSync(appsPathFull)) { | ||
| fs.rmSync(appsPathFull, { recursive: true }); | ||
| } | ||
| fs.mkdirSync(appsPathFull); | ||
|
|
||
| const sessionId = null; | ||
| const shareNotFound = null; | ||
| const baseUrl = wodinConfig.baseUrl.replace(/\/$/, ""); | ||
|
|
||
| const appNames = fs.readdirSync(path.resolve(configPath, wodinConfig.appsPath)).map(fileName => { | ||
| return /(.*)\.config\.json/.exec(fileName)![1]; | ||
| }); | ||
|
|
||
| appNames.forEach(async appName => { | ||
| const appNamePath = path.resolve(appsPathFull, appName); | ||
| fs.mkdirSync(appNamePath); | ||
|
|
||
| const configWithDefaults = ConfigController.readAppConfigFile( | ||
| appName, wodinConfig.appsPath, baseUrl, configReader, defaultCodeReader, appHelpReader | ||
| ); | ||
| const readOnlyConfigWithDefaults = { ...configWithDefaults, readOnlyCode: true }; | ||
| const configResponse = { | ||
| status: "success", | ||
| errors: null, | ||
| data: readOnlyConfigWithDefaults | ||
| }; | ||
| fs.writeFileSync(path.resolve(appNamePath, "config.json"), JSON.stringify(configResponse)); | ||
|
There was a problem hiding this comment. So it's writing out a pre-canned response file, status and all, for config etc, which will be read by the front end rather than talking to the server? I'd assumed that the apiService in the front end would, when configured as static, just read this data directly from the public path of the site, but I guess it makes the code simpler if it assumes that all these "responses" are going to be in the same format as for the dynamic site. I see you're doing a similar thing for the version and runner responses, just piping the the response direct to file. There was a problem hiding this comment. yep exactly i went back and forth in terms of how to get these responses, also considered them just being javascript files or something like that, all the other options just required a bit more code change which isnt a problem but this seemed the neatest to me, its literally just a fake local api but yh all logic works exactly the same, we dont need to do any extra processing of the response or anything like that i feel like the more "branches" we add with these two modes diverging the more maintenance we add |
||
|
|
||
|
|
||
| const versionsResponse = await axios.get("http://localhost:8001/"); | ||
|
There was a problem hiding this comment. I guess for the full implementation we'll make the api path configurable, deal with error handling etc. There was a problem hiding this comment. yes definitely! |
||
| fs.writeFileSync(path.resolve(appNamePath, "versions.json"), JSON.stringify(versionsResponse.data)); | ||
|
There was a problem hiding this comment. I wonder if we could make the mappings between the api paths and the file names a bit less arbitrary. So if the path to the json file was always the same as the url in the backend that is called in the dynamic app e.g. There was a problem hiding this comment. sure yh i dont think having folders per app is that bad personally if we want to keep them consistent with the api urls |
||
|
|
||
|
|
||
| const runnerResponse = await axios.get("http://localhost:8001/support/runner-ode"); | ||
| fs.writeFileSync(path.resolve(appNamePath, "runnerOde.json"), JSON.stringify(runnerResponse.data)); | ||
|
|
||
| if (configWithDefaults.appType === "stochastic") { | ||
| const runnerResponse = await axios.get("http://localhost:8001/support/runner-discrete"); | ||
| fs.writeFileSync(path.resolve(appNamePath, "runnerDiscrete.json"), JSON.stringify(runnerResponse.data)); | ||
| } | ||
|
There was a problem hiding this comment. These responses are identical for every model aren't they? so I guess they don't need to be fetched or even saved per app? There was a problem hiding this comment. they are! the reason i did it per app is the request fired is relative to the app, so like apps/day1/runner/ode or something like that, so it was easier to have a duplicate in each app, obviously this doesnt scale well but i dont think people ever have more than 5-6 apps, so that much duplication of that file seemed alright for slightly simpler code but happy to change it if needed |
||
|
|
||
| const modelResponse = await axios.post("http://localhost:8001/compile", { | ||
| model: defaultCodeReader.readFile(appName), | ||
| requirements: { timeType: configWithDefaults.appType === "stochastic" ? "discrete" : "continuous" } | ||
| }); | ||
| fs.writeFileSync(path.resolve(appNamePath, "modelCode.json"), JSON.stringify(modelResponse.data)); | ||
|
|
||
|
|
||
| const config = configReader.readConfigFile(wodinConfig.appsPath, `${appName}.config.json`) as AppConfig; | ||
| const viewOptions = { | ||
| appName, | ||
| baseUrl, | ||
| appsPath: wodinConfig.appsPath, | ||
| appType: config.appType, | ||
| title: `${config.title} - ${wodinConfig.courseTitle}`, | ||
| appTitle: config.title, | ||
| courseTitle: wodinConfig.courseTitle, | ||
| wodinVersion, | ||
| loadSessionId: sessionId || "", | ||
|
There was a problem hiding this comment. This should always be null, right? Same for shareNotFound. There was a problem hiding this comment. ooo yes, completely forgot to just change those to null! |
||
| shareNotFound: shareNotFound || "", | ||
| mathjaxSrc: "https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-chtml.js", | ||
| enableI18n: wodinConfig.enableI18n ?? false, // if option not set then false by default | ||
| defaultLanguage: wodinConfig?.defaultLanguage || "en", | ||
| hotReload: false | ||
| }; | ||
|
|
||
| const mustacheTemplate = fs.readFileSync(path.resolve(viewsPath, "app.mustache")).toString(); | ||
| const htmlFile = render(mustacheTemplate, viewOptions); | ||
| fs.writeFileSync(path.resolve(appNamePath, "index.html"), htmlFile); | ||
| }); | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I guess we'll pull this out of the controller when we implement for real.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
actually we dont have to! we need the whole config controller any and tree shaking means that we only get that and not everything else, we just put wodinBuilder as the entry point
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
we don't have to but it seems odd to use a part of the server controller from the static build script.