dmno build - flatten services config for use within docker (or similar) scenarios
#118
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| --- | ||
| "@dmno/1password-plugin": patch | ||
| "dmno": patch | ||
| --- | ||
|
|
||
| dmno build - flattening config for situation without access to the full monorepo |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,135 @@ | ||
| import { | ||
| copyFile, rm, cp, writeFile, | ||
| } from 'fs/promises'; | ||
| import { exec } from 'child_process'; | ||
| import { rollup, RollupBuild } from 'rollup'; | ||
| import { nodeResolve } from '@rollup/plugin-node-resolve'; | ||
| import commonjsRollupPlugin from '@rollup/plugin-commonjs'; | ||
| // import typescriptRollupPlugin from '@rollup/plugin-typescript'; | ||
| import sucraseRollupPlugin from '@rollup/plugin-sucrase'; | ||
|
|
||
| import kleur from 'kleur'; | ||
| import _ from 'lodash-es'; | ||
| import { DmnoCommand } from '../lib/dmno-command'; | ||
|
|
||
| import { addServiceSelection } from '../lib/selection-helpers'; | ||
| import { getCliRunCtx } from '../lib/cli-ctx'; | ||
| import { addCacheFlags } from '../lib/cache-helpers'; | ||
| import { addWatchMode } from '../lib/watch-mode-helpers'; | ||
| import { checkForSchemaErrors } from '../lib/check-errors-helpers'; | ||
| import { CliExitError } from '../lib/cli-error'; | ||
| import { DmnoBuildInfo } from '../../config-loader/find-services'; | ||
|
|
||
| const program = new DmnoCommand('build') | ||
| .summary('build compiled dmno config') | ||
| .description('Builds DMNO config files into minimal code appropriate for deployed contexts without access to all dependencies') | ||
| .example('dmno build', 'Build the config using current detected service') | ||
| .example('dmno build --service service1', 'Build dmno config files for use in service1'); | ||
|
|
||
| addWatchMode(program); // must be first | ||
| addCacheFlags(program); | ||
| addServiceSelection(program); | ||
|
|
||
| program.action(async (opts: { | ||
| // these args should be handled already by the helpers | ||
| // service?: string, | ||
| // watch?: boolean, | ||
| // skipCache?: boolean, | ||
| // clearCache?: boolean, | ||
|
|
||
| format?: string, | ||
| public?: boolean, | ||
| showAll?: boolean, | ||
| }, thisCommand) => { | ||
| const ctx = getCliRunCtx(); | ||
|
|
||
| if (opts.format) ctx.expectingOutput = true; | ||
|
|
||
| if (!ctx.selectedService) return; // error message already handled | ||
|
|
||
| ctx.log(`\nResolving config for service ${kleur.magenta(ctx.selectedService.serviceName)}\n`); | ||
|
|
||
| const workspace = ctx.workspace!; | ||
| const service = ctx.selectedService; | ||
| checkForSchemaErrors(workspace); | ||
|
|
||
| if (!ctx.configLoader.workspaceInfo.isMonorepo) { | ||
| throw new CliExitError('`dmno build` only works in monorepos'); | ||
|
There was a problem hiding this comment. maybe something slightly more explicit here, like " There was a problem hiding this comment. maybe just link to docs page |
||
| } | ||
|
|
||
| const buildDirPath = `${service.path}/.dmno-built`; | ||
| // delete existing build folder | ||
| try { | ||
| await rm(buildDirPath, { recursive: true }); | ||
| } catch (err) {} | ||
|
|
||
| if (!ctx.workspace) throw new Error('workspace not loaded'); | ||
|
|
||
| // TODO: do we want to write a top level json file with metadata? | ||
| const buildMetadata: DmnoBuildInfo = { | ||
| isMonorepo: ctx.configLoader.workspaceInfo.isMonorepo, | ||
| rootService: ctx.workspace.rootService.serviceName, | ||
| selectedService: ctx.selectedService.serviceName, | ||
| }; | ||
|
|
||
| const buildMeta = ctx.workspace.getServiceMetaForBuild(service.serviceName); | ||
|
|
||
|
|
||
|
|
||
| for (const workspaceService of ctx.workspace?.allServices || []) { | ||
| // skip any unrelated services according to the DAG (related via parent or pick) | ||
| if ( | ||
| workspaceService !== ctx.selectedService | ||
| && !buildMeta.requiredServices.includes(workspaceService.serviceName) | ||
| ) continue; | ||
|
|
||
| const configFilePath = `${workspaceService.path}/.dmno/config.mts`; | ||
| const buildPackageDirPath = `${buildDirPath}/${workspaceService.serviceName.replaceAll('/', '__')}`; | ||
| console.log('Bundling dmno config file for service ', workspaceService.serviceName); | ||
| console.log('> config file:', configFilePath); | ||
| console.log('> bundled config package dir:', buildPackageDirPath); | ||
|
|
||
| let bundle: RollupBuild | undefined; | ||
| bundle = await rollup({ | ||
| input: configFilePath, | ||
| external: ['dmno', /@dmno\/.*/], | ||
| plugins: [ | ||
| commonjsRollupPlugin(), | ||
| nodeResolve({ | ||
| preferBuiltins: true, // not sure about this - but false and undefined show warnings | ||
| }), | ||
|
|
||
| // typescriptRollupPlugin({ | ||
| // include: ['**/*.{mts,ts}'], | ||
| // }), | ||
|
|
||
| // alternative to @rollup/plugin-typescript which does faster builds without typechecking | ||
| sucraseRollupPlugin({ | ||
| include: ['**/*.{mts,ts}'], | ||
| exclude: ['node_modules/**'], | ||
| transforms: ['typescript'], | ||
| }), | ||
| ], | ||
| }); | ||
|
|
||
| // write built JS config file | ||
| await bundle.write({ | ||
| file: `${buildPackageDirPath}/.dmno/config.js`, | ||
| }); | ||
| await bundle?.close(); | ||
|
|
||
|
|
||
| // copy vault file(s) | ||
| // TODO: will need to figure out how to generalize this | ||
| // we could copy everything that is not git-ignored? | ||
| // we could let plugins specify a list of patterns to copy | ||
| await exec(`cp ${workspaceService.path}/.dmno/*.vault.json ${buildPackageDirPath}/.dmno`); | ||
|
There was a problem hiding this comment. there are other items in the |
||
|
|
||
| // copy package.json file | ||
| await copyFile(`${workspaceService.path}/package.json`, `${buildPackageDirPath}/package.json`); | ||
|
There was a problem hiding this comment. I'm copying the package.json files. Currently it's only used to get the package name, but we could skip this and store it elsewhere. We also probably want to remove the strict need for having a package.json file anyway, to start supporting more polyglot use-cases. |
||
| } | ||
|
|
||
| await writeFile(`${buildDirPath}/dmno-build-info.json`, JSON.stringify(buildMetadata, null, 2), 'utf8'); | ||
|
There was a problem hiding this comment. Not much in this file yet (see above) but it at least gives us somewhere to put extra data. |
||
| }); | ||
|
|
||
| export const BuildCommand = program; | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
most of the logic in here should probably move somewhere else, but just wanted to get it working as a POC.