@alfalab/arui-scripts-artifacts 0.0.0-beta-20260824133302

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (142) hide show
  1. package/.eslintignore +2 -0
  2. package/.eslintrc.js +8 -0
  3. package/.prettierignore +2 -0
  4. package/.turbo/turbo-build.log +0 -0
  5. package/.turbo/turbo-test.log +15 -0
  6. package/CHANGELOG.md +42 -0
  7. package/README.md +298 -0
  8. package/build/archive/build-archive.d.ts +14 -0
  9. package/build/archive/build-archive.js +69 -0
  10. package/build/archive/constants.d.ts +6 -0
  11. package/build/archive/constants.js +6 -0
  12. package/build/archive/index.d.ts +2 -0
  13. package/build/archive/index.js +2 -0
  14. package/build/cjs/archive/build-archive.d.ts +14 -0
  15. package/build/cjs/archive/build-archive.js +75 -0
  16. package/build/cjs/archive/constants.d.ts +6 -0
  17. package/build/cjs/archive/constants.js +9 -0
  18. package/build/cjs/archive/index.d.ts +2 -0
  19. package/build/cjs/archive/index.js +9 -0
  20. package/build/cjs/bin/index.d.ts +2 -0
  21. package/build/cjs/bin/index.js +58 -0
  22. package/build/cjs/cli/config-file.d.ts +46 -0
  23. package/build/cjs/cli/config-file.js +117 -0
  24. package/build/cjs/cli/create-cli.d.ts +25 -0
  25. package/build/cjs/cli/create-cli.js +75 -0
  26. package/build/cjs/cli/index.d.ts +3 -0
  27. package/build/cjs/cli/index.js +17 -0
  28. package/build/cjs/cli/load-config-file.d.ts +15 -0
  29. package/build/cjs/cli/load-config-file.js +62 -0
  30. package/build/cjs/config/index.d.ts +10 -0
  31. package/build/cjs/config/index.js +132 -0
  32. package/build/cjs/config/types.d.ts +226 -0
  33. package/build/cjs/config/types.js +2 -0
  34. package/build/cjs/docker/build-command.d.ts +13 -0
  35. package/build/cjs/docker/build-command.js +65 -0
  36. package/build/cjs/docker/build-docker-image.d.ts +21 -0
  37. package/build/cjs/docker/build-docker-image.js +65 -0
  38. package/build/cjs/docker/build-params.d.ts +20 -0
  39. package/build/cjs/docker/build-params.js +52 -0
  40. package/build/cjs/docker/constants.d.ts +19 -0
  41. package/build/cjs/docker/constants.js +22 -0
  42. package/build/cjs/docker/index.d.ts +7 -0
  43. package/build/cjs/docker/index.js +26 -0
  44. package/build/cjs/docker/prepare-files.d.ts +19 -0
  45. package/build/cjs/docker/prepare-files.js +81 -0
  46. package/build/cjs/docker/templates/dockerfile-compiled.template.d.ts +6 -0
  47. package/build/cjs/docker/templates/dockerfile-compiled.template.js +52 -0
  48. package/build/cjs/docker/templates/dockerfile.template.d.ts +5 -0
  49. package/build/cjs/docker/templates/dockerfile.template.js +46 -0
  50. package/build/cjs/index.d.ts +15 -0
  51. package/build/cjs/index.js +45 -0
  52. package/build/cjs/nginx/constants.d.ts +11 -0
  53. package/build/cjs/nginx/constants.js +19 -0
  54. package/build/cjs/nginx/index.d.ts +3 -0
  55. package/build/cjs/nginx/index.js +13 -0
  56. package/build/cjs/nginx/templates/base-nginx.conf.template.d.ts +7 -0
  57. package/build/cjs/nginx/templates/base-nginx.conf.template.js +57 -0
  58. package/build/cjs/nginx/templates/nginx.conf.template.d.ts +5 -0
  59. package/build/cjs/nginx/templates/nginx.conf.template.js +52 -0
  60. package/build/cjs/pipeline/build-artifact.d.ts +8 -0
  61. package/build/cjs/pipeline/build-artifact.js +16 -0
  62. package/build/cjs/pipeline/host-pipeline.d.ts +9 -0
  63. package/build/cjs/pipeline/host-pipeline.js +33 -0
  64. package/build/cjs/pipeline/index.d.ts +3 -0
  65. package/build/cjs/pipeline/index.js +9 -0
  66. package/build/cjs/pipeline/render.d.ts +16 -0
  67. package/build/cjs/pipeline/render.js +38 -0
  68. package/build/cjs/start-script/constants.d.ts +4 -0
  69. package/build/cjs/start-script/constants.js +7 -0
  70. package/build/cjs/start-script/index.d.ts +2 -0
  71. package/build/cjs/start-script/index.js +8 -0
  72. package/build/cjs/start-script/start.template.d.ts +6 -0
  73. package/build/cjs/start-script/start.template.js +74 -0
  74. package/build/cjs/utils/exec.d.ts +12 -0
  75. package/build/cjs/utils/exec.js +36 -0
  76. package/build/cjs/utils/shell.d.ts +6 -0
  77. package/build/cjs/utils/shell.js +16 -0
  78. package/build/cjs/utils/yarn.d.ts +25 -0
  79. package/build/cjs/utils/yarn.js +70 -0
  80. package/build/cli/config-file.d.ts +46 -0
  81. package/build/cli/config-file.js +110 -0
  82. package/build/cli/create-cli.d.ts +25 -0
  83. package/build/cli/create-cli.js +71 -0
  84. package/build/cli/index.d.ts +3 -0
  85. package/build/cli/index.js +3 -0
  86. package/build/cli/load-config-file.d.ts +15 -0
  87. package/build/cli/load-config-file.js +53 -0
  88. package/build/config/index.d.ts +10 -0
  89. package/build/config/index.js +126 -0
  90. package/build/config/types.d.ts +226 -0
  91. package/build/config/types.js +1 -0
  92. package/build/docker/build-command.d.ts +13 -0
  93. package/build/docker/build-command.js +57 -0
  94. package/build/docker/build-docker-image.d.ts +21 -0
  95. package/build/docker/build-docker-image.js +59 -0
  96. package/build/docker/build-params.d.ts +20 -0
  97. package/build/docker/build-params.js +44 -0
  98. package/build/docker/constants.d.ts +19 -0
  99. package/build/docker/constants.js +19 -0
  100. package/build/docker/index.d.ts +7 -0
  101. package/build/docker/index.js +7 -0
  102. package/build/docker/prepare-files.d.ts +19 -0
  103. package/build/docker/prepare-files.js +75 -0
  104. package/build/docker/templates/dockerfile-compiled.template.d.ts +6 -0
  105. package/build/docker/templates/dockerfile-compiled.template.js +49 -0
  106. package/build/docker/templates/dockerfile.template.d.ts +5 -0
  107. package/build/docker/templates/dockerfile.template.js +43 -0
  108. package/build/index.d.ts +15 -0
  109. package/build/index.js +20 -0
  110. package/build/nginx/constants.d.ts +11 -0
  111. package/build/nginx/constants.js +16 -0
  112. package/build/nginx/index.d.ts +3 -0
  113. package/build/nginx/index.js +3 -0
  114. package/build/nginx/templates/base-nginx.conf.template.d.ts +7 -0
  115. package/build/nginx/templates/base-nginx.conf.template.js +54 -0
  116. package/build/nginx/templates/nginx.conf.template.d.ts +5 -0
  117. package/build/nginx/templates/nginx.conf.template.js +49 -0
  118. package/build/pipeline/build-artifact.d.ts +8 -0
  119. package/build/pipeline/build-artifact.js +13 -0
  120. package/build/pipeline/host-pipeline.d.ts +9 -0
  121. package/build/pipeline/host-pipeline.js +27 -0
  122. package/build/pipeline/index.d.ts +3 -0
  123. package/build/pipeline/index.js +3 -0
  124. package/build/pipeline/render.d.ts +16 -0
  125. package/build/pipeline/render.js +35 -0
  126. package/build/start-script/constants.d.ts +4 -0
  127. package/build/start-script/constants.js +4 -0
  128. package/build/start-script/index.d.ts +2 -0
  129. package/build/start-script/index.js +2 -0
  130. package/build/start-script/start.template.d.ts +6 -0
  131. package/build/start-script/start.template.js +71 -0
  132. package/build/utils/exec.d.ts +12 -0
  133. package/build/utils/exec.js +28 -0
  134. package/build/utils/shell.d.ts +6 -0
  135. package/build/utils/shell.js +13 -0
  136. package/build/utils/yarn.d.ts +25 -0
  137. package/build/utils/yarn.js +61 -0
  138. package/jest.config.js +12 -0
  139. package/package.json +57 -0
  140. package/tsconfig.cjs.json +13 -0
  141. package/tsconfig.eslint.json +7 -0
  142. package/tsconfig.json +22 -0
@@ -0,0 +1,19 @@
1
+ import { type RenderedTemplates, type ResolvedArtifactsConfig } from '../config/types';
2
+ type PrepareFilesForDockerParams = {
3
+ config: ResolvedArtifactsConfig;
4
+ templates: RenderedTemplates;
5
+ };
6
+ export type PrepareFilesForDockerResult = {
7
+ /**
8
+ * Возвращает `.dockerignore` проекта в исходное состояние. Вызывать после `docker build` —
9
+ * иначе дописанный `node_modules` останется в рабочей копии пользователя.
10
+ */
11
+ restoreDockerIgnore: () => Promise<void>;
12
+ };
13
+ /**
14
+ * Готовит временную директорию со всеми файлами, необходимыми для `docker build`: Dockerfile,
15
+ * nginx-конфиги и start.sh. Локальные файлы проекта (если разрешены и заданы) имеют приоритет над
16
+ * сгенерированными шаблонами.
17
+ */
18
+ export declare function prepareFilesForDocker({ config, templates, }: PrepareFilesForDockerParams): Promise<PrepareFilesForDockerResult>;
19
+ export {};
@@ -0,0 +1,75 @@
1
+ import path from 'path';
2
+ import fs from 'fs-extra';
3
+ import { BASE_NGINX_CONFIG_FILENAME, NGINX_CONFIG_FILENAME } from '../nginx/constants';
4
+ import { START_SCRIPT_FILENAME } from '../start-script/constants';
5
+ import { getBuildParams } from './build-params';
6
+ import { DOCKERFILE_FILENAME, DOCKERIGNORE_FILENAME } from './constants';
7
+ /**
8
+ * Готовит временную директорию со всеми файлами, необходимыми для `docker build`: Dockerfile,
9
+ * nginx-конфиги и start.sh. Локальные файлы проекта (если разрешены и заданы) имеют приоритет над
10
+ * сгенерированными шаблонами.
11
+ */
12
+ export async function prepareFilesForDocker({ config, templates, }) {
13
+ const { cwd, nginx, localFiles, docker } = config;
14
+ const { addNodeModulesToDockerIgnore } = docker;
15
+ const { pathToTempDir } = getBuildParams(config);
16
+ await fs.emptyDir(pathToTempDir);
17
+ let nginxBaseConf = '';
18
+ if (nginx.baseConf) {
19
+ nginxBaseConf = localFiles.nginxBaseConf
20
+ ? await fs.readFile(localFiles.nginxBaseConf, 'utf8')
21
+ : templates.nginxBaseConf;
22
+ }
23
+ const nginxConf = localFiles.nginxConf
24
+ ? await fs.readFile(localFiles.nginxConf, 'utf8')
25
+ : templates.nginxConf;
26
+ const dockerfile = localFiles.dockerfile && localFiles.allowDockerfile
27
+ ? await fs.readFile(localFiles.dockerfile, 'utf8')
28
+ : templates.dockerfile;
29
+ const startScript = localFiles.startScript && localFiles.allowStartScript
30
+ ? await fs.readFile(localFiles.startScript, 'utf8')
31
+ : templates.startScript;
32
+ const dockerIgnoreFilePath = path.join(cwd, DOCKERIGNORE_FILENAME);
33
+ // запоминаем исходное состояние, чтобы вернуть файл как было: `node_modules` нужен только на
34
+ // время сборки образа и не должен оставаться в рабочей копии
35
+ const originalDockerIgnore = addNodeModulesToDockerIgnore && fs.existsSync(dockerIgnoreFilePath)
36
+ ? await fs.readFile(dockerIgnoreFilePath, 'utf-8')
37
+ : null;
38
+ const dockerIgnoreFileContent = addNodeModulesToDockerIgnore &&
39
+ (await getAndModifyDockerIgnoreContent(dockerIgnoreFilePath));
40
+ await Promise.all([
41
+ fs.writeFile(path.join(pathToTempDir, DOCKERFILE_FILENAME), dockerfile, 'utf8'),
42
+ fs.writeFile(path.join(pathToTempDir, NGINX_CONFIG_FILENAME), nginxConf, 'utf8'),
43
+ nginxBaseConf &&
44
+ fs.writeFile(path.join(pathToTempDir, BASE_NGINX_CONFIG_FILENAME), nginxBaseConf, 'utf8'),
45
+ fs.writeFile(path.join(pathToTempDir, START_SCRIPT_FILENAME), startScript, {
46
+ encoding: 'utf8',
47
+ mode: 0o555,
48
+ }),
49
+ addNodeModulesToDockerIgnore &&
50
+ dockerIgnoreFileContent &&
51
+ fs.writeFile(dockerIgnoreFilePath, dockerIgnoreFileContent, 'utf-8'),
52
+ ].filter(Boolean));
53
+ return {
54
+ restoreDockerIgnore: async () => {
55
+ if (!addNodeModulesToDockerIgnore) {
56
+ return;
57
+ }
58
+ if (originalDockerIgnore === null) {
59
+ await fs.remove(dockerIgnoreFilePath);
60
+ }
61
+ else {
62
+ await fs.writeFile(dockerIgnoreFilePath, originalDockerIgnore, 'utf-8');
63
+ }
64
+ },
65
+ };
66
+ }
67
+ async function getAndModifyDockerIgnoreContent(dockerIgnoreFilePath) {
68
+ if (fs.existsSync(dockerIgnoreFilePath)) {
69
+ return fs
70
+ .readFile(dockerIgnoreFilePath, 'utf-8')
71
+ .then((ignores) => `${ignores}\nnode_modules`);
72
+ }
73
+ await fs.createFile(dockerIgnoreFilePath);
74
+ return 'node_modules';
75
+ }
@@ -0,0 +1,6 @@
1
+ import { type ResolvedArtifactsConfig } from '../../config/types';
2
+ /**
3
+ * Dockerfile для compiled-образа: зависимости и сборка приложения происходят внутри образа, что
4
+ * позволяет кешировать установку зависимостей на уровне docker-слоев.
5
+ */
6
+ export declare function renderDockerfileCompiled(config: ResolvedArtifactsConfig): string;
@@ -0,0 +1,49 @@
1
+ /**
2
+ * Dockerfile для compiled-образа: зависимости и сборка приложения происходят внутри образа, что
3
+ * позволяет кешировать установку зависимостей на уровне docker-слоев.
4
+ */
5
+ export function renderDockerfileCompiled(config) {
6
+ const { docker, nginx, packageManager } = config;
7
+ const { yarnVersion, installProductionCommand } = packageManager;
8
+ // В зависимости от используемого менеджера зависимостей для их установки нужно копировать разный
9
+ // набор файлов
10
+ const filesRequiredToInstallDependencies = [
11
+ 'package.json',
12
+ 'yarn.lock',
13
+ yarnVersion === '2+' && '.yarnrc.yml',
14
+ yarnVersion === '2+' && '.yarn',
15
+ yarnVersion === 'unavailable' && 'package-lock.json',
16
+ ].filter(Boolean);
17
+ return `
18
+ FROM ${docker.baseImage}
19
+ ARG START_SH_LOCATION
20
+ ARG NGINX_CONF_LOCATION
21
+ ARG NGINX_BASE_CONF_LOCATION
22
+
23
+ WORKDIR /src
24
+
25
+ # Полу-статичные файлы, могут легко кешироваться
26
+ ADD $START_SH_LOCATION /src/start.sh
27
+ ADD $NGINX_CONF_LOCATION /src/nginx.conf
28
+ ${nginx.baseConf ? 'ADD $NGINX_BASE_CONF_LOCATION /etc/nginx/nginx.conf' : ''}
29
+
30
+ # Зависимости. При некоторой удаче могут кешироваться и соответственно кешировать установку зависимостей
31
+ ${filesRequiredToInstallDependencies
32
+ .map((file) => `ADD --chown=nginx:nginx ${file} /src/${file}`)
33
+ .join('\n')}
34
+
35
+ RUN ${installProductionCommand} && \\
36
+ ${yarnVersion === 'unavailable' ? 'npm cache clean --force' : 'yarn cache clean --all'}
37
+
38
+ ADD --chown=nginx:nginx . /src
39
+
40
+ # Создаем директории для nginx и выставляем правильные права
41
+ RUN mkdir -p /var/lib/nginx && \
42
+ chown -R nginx:nginx /var/lib/nginx && \
43
+ chown -R nginx:nginx /var/log/nginx && \
44
+ chown -R nginx:nginx /etc/nginx/conf.d
45
+ RUN touch /var/run/nginx.pid && \
46
+ chown -R nginx:nginx /var/run/nginx.pid
47
+ USER nginx
48
+ `;
49
+ }
@@ -0,0 +1,5 @@
1
+ import { type ResolvedArtifactsConfig } from '../../config/types';
2
+ /**
3
+ * Dockerfile для «сырого» образа: приложение собирается на хосте, в образ кладется результат сборки.
4
+ */
5
+ export declare function renderDockerfile(config: ResolvedArtifactsConfig): string;
@@ -0,0 +1,43 @@
1
+ /**
2
+ * Dockerfile для «сырого» образа: приложение собирается на хосте, в образ кладется результат сборки.
3
+ */
4
+ export function renderDockerfile(config) {
5
+ const { clientOnly, buildPath, docker, nginx } = config;
6
+ const { runFromNonRootUser, baseImage } = docker;
7
+ const appPathToAdd = clientOnly ? buildPath : '.';
8
+ const appTargetPath = clientOnly ? `/src/${buildPath}` : '/src';
9
+ const nginxConfTargetLocation = clientOnly
10
+ ? '/etc/nginx/conf.d/default.conf'
11
+ : '/src/nginx.conf';
12
+ const nginxNonRootPart = runFromNonRootUser
13
+ ? `RUN chown -R nginx:nginx /src && \\
14
+ mkdir -p /var/lib/nginx && \\
15
+ chown -R nginx:nginx /var/lib/nginx && \\
16
+ chown -R nginx:nginx /var/log/nginx && \\
17
+ chown -R nginx:nginx /etc/nginx/conf.d
18
+
19
+ RUN touch /var/run/nginx.pid && \\
20
+ chown -R nginx:nginx /var/run/nginx.pid
21
+
22
+ USER nginx`
23
+ : '';
24
+ return `
25
+ FROM ${baseImage}
26
+ ARG START_SH_LOCATION
27
+ ARG NGINX_CONF_LOCATION
28
+ ARG NGINX_BASE_CONF_LOCATION
29
+
30
+ WORKDIR /src
31
+ ADD $START_SH_LOCATION /src/start.sh
32
+ ADD $NGINX_CONF_LOCATION ${nginxConfTargetLocation}
33
+ ${nginx.baseConf ? 'ADD $NGINX_BASE_CONF_LOCATION /etc/nginx/nginx.conf' : ''}
34
+
35
+ ${nginxNonRootPart}
36
+
37
+ ${runFromNonRootUser
38
+ ? `ADD --chown=nginx:nginx ${appPathToAdd} ${appTargetPath}`
39
+ : `ADD ${appPathToAdd} ${appTargetPath}`}
40
+ ${clientOnly ? 'COPY env-config.jso[n] /src/' : ''}
41
+ ${clientOnly ? 'CMD ["nginx"]' : ''}
42
+ `;
43
+ }
@@ -0,0 +1,15 @@
1
+ /**
2
+ * Публичное API пакета. Реэкспортит доменные модули: конфиг, общий пайплайн и по одному модулю на
3
+ * тип артефакта (`docker`, `archive`) и на файлы, которые в них кладутся (`nginx`, `start-script`).
4
+ */
5
+ export { resolveArtifactsConfig } from './config';
6
+ export type { ArchiveOptions, ArtifactKind, ArtifactsOptions, ArtifactTemplateOverrides, ArtifactTemplates, BuildOptions, DockerfileVariant, DockerOptions, DockerPlatform, LocalFilesOptions, NginxBaseConfOptions, NginxOptions, PackageManagerOptions, RenderedTemplates, ResolvedArchiveConfig, ResolvedArtifactsConfig, ResolvedBuildConfig, ResolvedDockerConfig, ResolvedLocalFilesConfig, ResolvedNginxBaseConf, ResolvedNginxConfig, ResolvedPackageManagerConfig, TemplateKey, TemplateOverride, TemplateRenderer, YarnVersion, } from './config/types';
7
+ export * from './pipeline';
8
+ export * from './docker';
9
+ export * from './archive';
10
+ export * from './nginx';
11
+ export * from './start-script';
12
+ export * from './cli';
13
+ export { exec, ExecError } from './utils/exec';
14
+ export { shellQuote } from './utils/shell';
15
+ export { detectUseYarn, getInstallProductionCommand, getPruningCommand, getYarnVersion, } from './utils/yarn';
package/build/index.js ADDED
@@ -0,0 +1,20 @@
1
+ /**
2
+ * Публичное API пакета. Реэкспортит доменные модули: конфиг, общий пайплайн и по одному модулю на
3
+ * тип артефакта (`docker`, `archive`) и на файлы, которые в них кладутся (`nginx`, `start-script`).
4
+ */
5
+ /* Конфиг */
6
+ export { resolveArtifactsConfig } from './config';
7
+ /* Общий пайплайн сборки артефакта */
8
+ export * from './pipeline';
9
+ /* Артефакты */
10
+ export * from './docker';
11
+ export * from './archive';
12
+ /* Файлы, которые кладутся в артефакт */
13
+ export * from './nginx';
14
+ export * from './start-script';
15
+ /* CLI и файл конфига */
16
+ export * from './cli';
17
+ /* Утилиты */
18
+ export { exec, ExecError } from './utils/exec';
19
+ export { shellQuote } from './utils/shell';
20
+ export { detectUseYarn, getInstallProductionCommand, getPruningCommand, getYarnVersion, } from './utils/yarn';
@@ -0,0 +1,11 @@
1
+ import { type ResolvedNginxBaseConf } from '../config/types';
2
+ /** Имя файла с nginx-конфигом сервера (server-блок), который кладется в артефакт. */
3
+ export declare const NGINX_CONFIG_FILENAME = "nginx.conf";
4
+ /** Имя файла с базовым nginx-конфигом (http-блок), который кладется в артефакт. */
5
+ export declare const BASE_NGINX_CONFIG_FILENAME = "base-nginx.conf";
6
+ /** Порт, который nginx слушает внутри контейнера. */
7
+ export declare const DEFAULT_NGINX_PORT = 8080;
8
+ /** Корень, из которого nginx раздает статику. */
9
+ export declare const DEFAULT_NGINX_ROOT_PATH = "/src";
10
+ /** Значения по умолчанию для базового конфига (http-блок). */
11
+ export declare const DEFAULT_NGINX_BASE_CONF: ResolvedNginxBaseConf;
@@ -0,0 +1,16 @@
1
+ /** Имя файла с nginx-конфигом сервера (server-блок), который кладется в артефакт. */
2
+ export const NGINX_CONFIG_FILENAME = 'nginx.conf';
3
+ /** Имя файла с базовым nginx-конфигом (http-блок), который кладется в артефакт. */
4
+ export const BASE_NGINX_CONFIG_FILENAME = 'base-nginx.conf';
5
+ /** Порт, который nginx слушает внутри контейнера. */
6
+ export const DEFAULT_NGINX_PORT = 8080;
7
+ /** Корень, из которого nginx раздает статику. */
8
+ export const DEFAULT_NGINX_ROOT_PATH = '/src';
9
+ /** Значения по умолчанию для базового конфига (http-блок). */
10
+ export const DEFAULT_NGINX_BASE_CONF = {
11
+ workerProcesses: 2,
12
+ workerRlimitNoFile: 20000,
13
+ workerConnections: 19000,
14
+ eventsUse: 'epoll',
15
+ daemon: 'off',
16
+ };
@@ -0,0 +1,3 @@
1
+ export { renderNginxConf } from './templates/nginx.conf.template';
2
+ export { renderBaseNginxConf } from './templates/base-nginx.conf.template';
3
+ export { BASE_NGINX_CONFIG_FILENAME, DEFAULT_NGINX_BASE_CONF, DEFAULT_NGINX_PORT, DEFAULT_NGINX_ROOT_PATH, NGINX_CONFIG_FILENAME, } from './constants';
@@ -0,0 +1,3 @@
1
+ export { renderNginxConf } from './templates/nginx.conf.template';
2
+ export { renderBaseNginxConf } from './templates/base-nginx.conf.template';
3
+ export { BASE_NGINX_CONFIG_FILENAME, DEFAULT_NGINX_BASE_CONF, DEFAULT_NGINX_PORT, DEFAULT_NGINX_ROOT_PATH, NGINX_CONFIG_FILENAME, } from './constants';
@@ -0,0 +1,7 @@
1
+ import { type ResolvedArtifactsConfig } from '../../config/types';
2
+ /**
3
+ * http-блок nginx-конфига (базовый nginx.conf). Значения приходят из `nginx.baseConf` уже
4
+ * донасыщенными дефолтами; если базовый конфиг выключен (`baseConf: null`), рендерится с дефолтами —
5
+ * решение о том, класть ли его в артефакт, принимает `renderTemplates`.
6
+ */
7
+ export declare function renderBaseNginxConf(config: ResolvedArtifactsConfig): string;
@@ -0,0 +1,54 @@
1
+ import { DEFAULT_NGINX_BASE_CONF } from '../constants';
2
+ /**
3
+ * http-блок nginx-конфига (базовый nginx.conf). Значения приходят из `nginx.baseConf` уже
4
+ * донасыщенными дефолтами; если базовый конфиг выключен (`baseConf: null`), рендерится с дефолтами —
5
+ * решение о том, класть ли его в артефакт, принимает `renderTemplates`.
6
+ */
7
+ export function renderBaseNginxConf(config) {
8
+ const nginx = config.nginx.baseConf ?? DEFAULT_NGINX_BASE_CONF;
9
+ return `
10
+ worker_processes ${nginx.workerProcesses};
11
+ worker_rlimit_nofile ${nginx.workerRlimitNoFile};
12
+ daemon ${nginx.daemon};
13
+
14
+ error_log /var/log/nginx/error.log;
15
+ pid /var/run/nginx.pid;
16
+
17
+ events {
18
+ worker_connections ${nginx.workerConnections};
19
+ use ${nginx.eventsUse};
20
+ }
21
+
22
+ http {
23
+ include /etc/nginx/mime.types;
24
+ default_type application/octet-stream;
25
+
26
+ server_tokens off;
27
+ access_log off;
28
+ keepalive_timeout 65;
29
+ proxy_read_timeout 200;
30
+ sendfile on;
31
+ tcp_nopush on;
32
+ tcp_nodelay on;
33
+
34
+ gzip_static on;
35
+ brotli on;
36
+ brotli_static on;
37
+ brotli_types application/atom+xml application/javascript application/json application/rss+xml
38
+ application/vnd.ms-fontobject application/x-font-opentype application/x-font-truetype
39
+ application/x-font-ttf application/x-javascript application/xhtml+xml application/xml
40
+ font/eot font/opentype font/otf font/truetype image/svg+xml image/vnd.microsoft.icon
41
+ image/x-icon image/x-win-bitmap text/css text/javascript text/plain text/xml application/wasm;
42
+
43
+
44
+ # Only retry if there was a communication error, not a timeout
45
+ # on the Node server (to avoid propagating "queries of death"
46
+ # to all frontends)
47
+ proxy_next_upstream error;
48
+
49
+ #cache
50
+ proxy_cache_path /var/cache/nginx levels=1:2 keys_zone=all:32m max_size=1g;
51
+
52
+ include /etc/nginx/conf.d/*.conf;
53
+ }`;
54
+ }
@@ -0,0 +1,5 @@
1
+ import { type ResolvedArtifactsConfig } from '../../config/types';
2
+ /**
3
+ * server-блок nginx-конфига, который раздает статику и (в не-clientOnly режиме) проксирует на nodejs.
4
+ */
5
+ export declare function renderNginxConf(config: ResolvedArtifactsConfig): string;
@@ -0,0 +1,49 @@
1
+ /**
2
+ * server-блок nginx-конфига, который раздает статику и (в не-clientOnly режиме) проксирует на nodejs.
3
+ */
4
+ export function renderNginxConf(config) {
5
+ const { clientOnly, buildPath, serverPort, publicPath, nginx } = config;
6
+ const { port, rootPath, enablePreviousVersionHeaders } = nginx;
7
+ return `client_max_body_size 20m;
8
+
9
+ server {
10
+ listen ${port};
11
+ server_tokens off;
12
+ ${enablePreviousVersionHeaders ? 'brotli_auto_dictionary on;' : ''}
13
+
14
+ ${clientOnly
15
+ ? `location / {
16
+ root ${rootPath}/${buildPath};
17
+ index index.html;
18
+ }`
19
+ : ` location / {
20
+ proxy_set_header Host $host;
21
+ proxy_pass http://127.0.0.1:${serverPort};
22
+ }`}
23
+
24
+ location /${publicPath} {
25
+ expires max;
26
+ add_header Cache-Control public;
27
+ root ${rootPath}/${buildPath};
28
+ }
29
+
30
+ location = /${publicPath}remoteEntry.js {
31
+ add_header Cache-Control "no-store, no-cache, must-revalidate, proxy-revalidate, max-age=0";
32
+ add_header Pragma "no-cache";
33
+ add_header Expires "0";
34
+ root ${rootPath}/${buildPath};
35
+ types {
36
+ text/javascript js;
37
+ }
38
+ }
39
+
40
+ location ~ /${publicPath}.*\\.js$ {
41
+ expires max;
42
+ add_header Cache-Control public;
43
+ root ${rootPath}/${buildPath};
44
+ types {
45
+ text/javascript js;
46
+ }
47
+ }
48
+ }`;
49
+ }
@@ -0,0 +1,8 @@
1
+ import { type BuildDockerImageOptions } from '../docker/build-docker-image';
2
+ export type BuildArtifactOptions = BuildDockerImageOptions;
3
+ /**
4
+ * Собирает артефакт поставки согласно `artifact` в опциях: docker-образ (по умолчанию) или tar-архив.
5
+ * Именно эту функцию вызывает CLI, поэтому любая команда из конфига проекта может собирать любой тип
6
+ * артефакта.
7
+ */
8
+ export declare function buildArtifact(options?: BuildArtifactOptions): Promise<void>;
@@ -0,0 +1,13 @@
1
+ import { buildArchive } from '../archive/build-archive';
2
+ import { buildDockerImage } from '../docker/build-docker-image';
3
+ /**
4
+ * Собирает артефакт поставки согласно `artifact` в опциях: docker-образ (по умолчанию) или tar-архив.
5
+ * Именно эту функцию вызывает CLI, поэтому любая команда из конфига проекта может собирать любой тип
6
+ * артефакта.
7
+ */
8
+ export async function buildArtifact(options = {}) {
9
+ if (options.artifact === 'archive') {
10
+ return buildArchive(options);
11
+ }
12
+ return buildDockerImage(options);
13
+ }
@@ -0,0 +1,9 @@
1
+ import { type ResolvedArtifactsConfig } from '../config/types';
2
+ /** Хук, вызываемый после очистки `buildPath`, но до сборки приложения. */
3
+ export type BeforeBuildHook = (config: ResolvedArtifactsConfig) => void | Promise<void>;
4
+ /**
5
+ * Шаги, которые выполняются на хосте перед упаковкой артефакта: очистка прошлой сборки, сборка
6
+ * приложения и удаление dev-зависимостей. Общие для docker-образа и tar-архива — какие именно шаги
7
+ * выполнятся, определяет секция `build` конфига.
8
+ */
9
+ export declare function runHostPipeline(config: ResolvedArtifactsConfig, beforeBuild?: BeforeBuildHook): Promise<void>;
@@ -0,0 +1,27 @@
1
+ import path from 'path';
2
+ import fs from 'fs-extra';
3
+ import { exec } from '../utils/exec';
4
+ /**
5
+ * Шаги, которые выполняются на хосте перед упаковкой артефакта: очистка прошлой сборки, сборка
6
+ * приложения и удаление dev-зависимостей. Общие для docker-образа и tar-архива — какие именно шаги
7
+ * выполнятся, определяет секция `build` конфига.
8
+ */
9
+ export async function runHostPipeline(config, beforeBuild) {
10
+ const { build, packageManager } = config;
11
+ if (build.cleanBuildPath) {
12
+ await fs.remove(path.resolve(config.cwd, config.buildPath));
13
+ }
14
+ if (beforeBuild) {
15
+ await beforeBuild(config);
16
+ }
17
+ if (build.command) {
18
+ console.time('Build application time');
19
+ await exec(build.command);
20
+ console.timeEnd('Build application time');
21
+ }
22
+ if (build.removeDevDependencies && packageManager.pruneCommand) {
23
+ console.time('Remove dev dependencies time');
24
+ await exec(packageManager.pruneCommand);
25
+ console.timeEnd('Remove dev dependencies time');
26
+ }
27
+ }
@@ -0,0 +1,3 @@
1
+ export { buildArtifact, type BuildArtifactOptions } from './build-artifact';
2
+ export { runHostPipeline, type BeforeBuildHook } from './host-pipeline';
3
+ export { renderTemplates, type RenderTemplatesParams } from './render';
@@ -0,0 +1,3 @@
1
+ export { buildArtifact } from './build-artifact';
2
+ export { runHostPipeline } from './host-pipeline';
3
+ export { renderTemplates } from './render';
@@ -0,0 +1,16 @@
1
+ import { type ArtifactTemplateOverrides, type ArtifactTemplates, type DockerfileVariant, type RenderedTemplates, type ResolvedArtifactsConfig } from '../config/types';
2
+ export type RenderTemplatesParams = {
3
+ config: ResolvedArtifactsConfig;
4
+ /** Какой Dockerfile генерировать. По умолчанию — `config.docker.variant`. */
5
+ variant?: DockerfileVariant;
6
+ /** Полная замена рендереров отдельных шаблонов. */
7
+ templates?: ArtifactTemplates;
8
+ /** Точечные оверрайды поверх сгенерированных шаблонов. */
9
+ overrides?: ArtifactTemplateOverrides;
10
+ };
11
+ /**
12
+ * Рендерит все файлы, которые кладутся в артефакт, применяя (в порядке приоритета) кастомные
13
+ * рендереры из `templates` и точечные оверрайды из `overrides`. Результат готов к передаче в
14
+ * `prepareFilesForDocker`.
15
+ */
16
+ export declare function renderTemplates(params: RenderTemplatesParams): RenderedTemplates;
@@ -0,0 +1,35 @@
1
+ import { renderDockerfile } from '../docker/templates/dockerfile.template';
2
+ import { renderDockerfileCompiled } from '../docker/templates/dockerfile-compiled.template';
3
+ import { renderBaseNginxConf } from '../nginx/templates/base-nginx.conf.template';
4
+ import { renderNginxConf } from '../nginx/templates/nginx.conf.template';
5
+ import { renderStartScript } from '../start-script/start.template';
6
+ function renderTemplate(key, defaultRenderer, params) {
7
+ const { config, templates, overrides } = params;
8
+ const renderer = templates?.[key] ?? defaultRenderer;
9
+ let content = renderer(config);
10
+ const override = overrides?.[key];
11
+ if (override) {
12
+ content = override(content, config);
13
+ }
14
+ return content;
15
+ }
16
+ /**
17
+ * Рендерит все файлы, которые кладутся в артефакт, применяя (в порядке приоритета) кастомные
18
+ * рендереры из `templates` и точечные оверрайды из `overrides`. Результат готов к передаче в
19
+ * `prepareFilesForDocker`.
20
+ */
21
+ export function renderTemplates(params) {
22
+ const { config, variant = config.docker.variant } = params;
23
+ const dockerfileKey = variant === 'compiled' ? 'dockerfileCompiled' : 'dockerfile';
24
+ const dockerfileRenderer = variant === 'compiled' ? renderDockerfileCompiled : renderDockerfile;
25
+ return {
26
+ dockerfile: renderTemplate(dockerfileKey, dockerfileRenderer, params),
27
+ nginxConf: renderTemplate('nginxConf', renderNginxConf, params),
28
+ // при выключенном базовом конфиге он не попадает в артефакт, поэтому и рендерить (и звать
29
+ // оверрайд, результат которого все равно будет отброшен) нечего
30
+ nginxBaseConf: config.nginx.baseConf
31
+ ? renderTemplate('baseNginxConf', renderBaseNginxConf, params)
32
+ : '',
33
+ startScript: renderTemplate('startScript', renderStartScript, params),
34
+ };
35
+ }
@@ -0,0 +1,4 @@
1
+ /** Имя entrypoint-скрипта, который кладется в артефакт. */
2
+ export declare const START_SCRIPT_FILENAME = "start.sh";
3
+ /** Имя файла с рантайм-конфигом клиентского приложения. */
4
+ export declare const ENV_CONFIG_FILENAME = "env-config.json";
@@ -0,0 +1,4 @@
1
+ /** Имя entrypoint-скрипта, который кладется в артефакт. */
2
+ export const START_SCRIPT_FILENAME = 'start.sh';
3
+ /** Имя файла с рантайм-конфигом клиентского приложения. */
4
+ export const ENV_CONFIG_FILENAME = 'env-config.json';
@@ -0,0 +1,2 @@
1
+ export { renderStartScript } from './start.template';
2
+ export { ENV_CONFIG_FILENAME, START_SCRIPT_FILENAME } from './constants';
@@ -0,0 +1,2 @@
1
+ export { renderStartScript } from './start.template';
2
+ export { ENV_CONFIG_FILENAME, START_SCRIPT_FILENAME } from './constants';
@@ -0,0 +1,6 @@
1
+ import { type ResolvedArtifactsConfig } from '../config/types';
2
+ /**
3
+ * start.sh — entrypoint артефакта: используется и docker-образом, и tar-архивом. Для serverful-режима
4
+ * поднимает nginx + nodejs, для clientOnly — подставляет env-config и запускает nginx.
5
+ */
6
+ export declare function renderStartScript(config: ResolvedArtifactsConfig): string;
@@ -0,0 +1,71 @@
1
+ import { ENV_CONFIG_FILENAME } from './constants';
2
+ /**
3
+ * start.sh — entrypoint артефакта: используется и docker-образом, и tar-архивом. Для serverful-режима
4
+ * поднимает nginx + nodejs, для clientOnly — подставляет env-config и запускает nginx.
5
+ */
6
+ export function renderStartScript(config) {
7
+ const { clientOnly, buildPath, serverOutput } = config;
8
+ const serverStartTemplate = `#!/bin/sh
9
+
10
+ # Подменяем env переменные в nginx конфиге перед стартом
11
+ # Сначала заменяем все слова, начинающиеся на $ но без \${} на ~~слово~~
12
+ # затем запускаем envsubst, после этого обратно заменяем ~~слово~~ на $слово.
13
+ # Это нужно для того, чтоб специальные переменные nginx не подменялись envsubst'ом на
14
+ # пустые строки. envsubst будет заменять только \${слово}.
15
+ cat ./nginx.conf \\
16
+ | sed 's/\\$\\([a-zA-Z0-9_-]\\{1,\\}\\)/~~\\1~~/g' \\
17
+ | envsubst \\
18
+ | sed 's/~~\\([a-zA-Z0-9_-]\\{1,\\}\\)~~/$\\1/g' \\
19
+ > /etc/nginx/conf.d/default.conf
20
+
21
+ # Достаем лимит памяти из cgroup, это то, как его докер задает.
22
+ if [[ -f /sys/fs/cgroup/cgroup.controllers ]]; then
23
+ max_total_memory=$(cat /sys/fs/cgroup/memory.max)
24
+ else
25
+ max_total_memory=$(cat /sys/fs/cgroup/memory/memory.limit_in_bytes)
26
+ fi
27
+ # Самой nodejs мы не можем отдать совсем всю память, операционная система+nginx все же требуют какого то количества.
28
+ # Поэтому мы вычитаем 100мб на нужды ос
29
+ node_memory_limit="$(($max_total_memory / 1024 / 1024 - 100))"
30
+
31
+ # Start the nginx process in background
32
+ nginx &
33
+
34
+ # Start nodejs process
35
+ exec node --max-old-space-size="$node_memory_limit" ./${buildPath}/${serverOutput}
36
+ `;
37
+ const envConfigTargetPath = `/src/${buildPath}/${ENV_CONFIG_FILENAME}`;
38
+ const envConfigPath = `/src/${ENV_CONFIG_FILENAME}`;
39
+ const htmlPath = `/src/${buildPath}/index.html`;
40
+ const clientOnlyStartTemplate = `#!/bin/sh
41
+
42
+ # Мы подставляем значения из env в env-config.json если он есть, и кладем его в публичную папку.
43
+ # Дополнительно подставляем контент полученного файла в index.html
44
+ # Так как контент env-config может быть многострочным - дополнительно обрабатываем его через awk.
45
+ if [ -f ${envConfigPath} ]; then
46
+ cat ${envConfigPath} \\
47
+ | envsubst \\
48
+ > ${envConfigTargetPath}
49
+
50
+ # Define the placeholder and the file paths
51
+ PLACEHOLDER='<%= envConfig %>'
52
+ SETTINGS_FILE='${envConfigTargetPath}'
53
+ TARGET_FILE='${htmlPath}'
54
+
55
+ # Escape the placeholder for sed usage
56
+ ESCAPED_PLACEHOLDER=$(echo "$PLACEHOLDER" | sed 's/[\\/&]/\\\\&/g')
57
+
58
+ # Read the content of the settings and prepare it for substitution
59
+ SETTINGS_CONTENT=$(awk '{printf "%s\\\\n", $0}' "$SETTINGS_FILE")
60
+
61
+ # Replace the placeholder in the target file with the content of settings
62
+ cat ${htmlPath} \\
63
+ | sed "s/$ESCAPED_PLACEHOLDER/$SETTINGS_CONTENT/" \\
64
+ > /tmp/index.html
65
+
66
+ mv /tmp/index.html ${htmlPath}
67
+ fi
68
+
69
+ nginx`;
70
+ return clientOnly ? clientOnlyStartTemplate : serverStartTemplate;
71
+ }