Refactor department configuration to support multiple script IDs, updating related documentation and functions for improved project management. Introduce new utility functions for loading and validating script IDs, enhancing the deployment process across multiple Apps Script projects.

This commit is contained in:
Dmitriy_Kravchenko 2026-10-09 12:02:45 +03:00
parent aa1c8da024
commit a0f673c2e8
13 changed files with 230 additions and 89 deletions

View File

@ -14,7 +14,7 @@ npm run push -- universal
npm run deploy -- universal
```
`deploy` гоняет тесты, собирает бандл отдела и делает `clasp push` в его `scriptId`.
`deploy` гоняет тесты, собирает бандл отдела и делает `clasp push` в каждый проект из его `scriptIds`.
Перед первым push: `npx clasp login`.
@ -26,7 +26,7 @@ npm run deploy -- universal
- `src/departments/<id>/entry.ts` — точка сборки
- `tests` — Vitest, без SpreadsheetApp
- `dist/<id>` — собранный проект для clasp (в git не кладётся)
- `departments.json` — `scriptId` целевого Apps Script
- `departments.json` — `scriptIds` целевых проектов Apps Script
Лист `Config` и Script Properties по-прежнему runtime-настройки конкретной таблицы. Профиль отдела задаёт **какой код** в неё попадает.
@ -34,7 +34,15 @@ npm run deploy -- universal
1. Скопируйте `src/departments/universal/` в `src/departments/<id>/`.
2. В профиле оставьте только нужные плагины. Чтобы подменить логику отчёта, импортируйте свою реализацию с тем же `id` и теми же именами `handlers`.
3. Добавьте `scriptId` в `departments.json`.
3. Добавьте `scriptIds` в `departments.json`. Один профиль можно отправить в несколько проектов: перечислите их id в массиве. Поле `scriptId` со строкой по-прежнему означает один проект.
```json
"salesOriginal": {
"scriptIds": ["SCRIPT_ID_TABLE_1", "SCRIPT_ID_TABLE_2"],
"htmlFiles": ["DateRangeDialog.html"]
}
```
4. `npm run deploy -- <id>`.
Уникальный отчёт кладите в `src/reports/<newId>/` и подключайте только в профилях, которым он нужен.
@ -50,6 +58,6 @@ npm run deploy -- universal
## Выкат в таблицу
Сборка кладёт в `dist/<id>/` файлы `Code.js`, `appsscript.json`, HTML и `.clasp.json`. Push идёт только из этой папки, а не из корня репозитория.
Сборка кладёт в `dist/<id>/` файлы `Code.js`, `appsscript.json`, HTML и `.clasp.json`. Push идёт только из этой папки, а не из корня репозитория. Если в профиле несколько `scriptIds`, один и тот же бандл отправляется в каждый проект по очереди.
Секреты (HMAC, webhook Bitrix) задаются в Script Properties целевого проекта. Что писать на лист `Config` — в [config/README.md](config/README.md).

View File

@ -11,7 +11,7 @@ npm test
npm run deploy -- universal
```
Это тесты, сборка `dist/universal` и `clasp push` в `scriptId` из `departments.json`. Редактор Apps Script не используйте как место правок исходников.
Это тесты, сборка `dist/universal` и `clasp push` в каждый id из `scriptIds` в `departments.json`. Редактор Apps Script не используйте как место правок исходников.
Для новой таблицы:

View File

@ -1,14 +1,18 @@
{
"universal": {
"scriptId": "1AqL4PgNLkch4pp-Bq6WaL1pBmu3K4mL_sIxojO5AUraoeKI9RP4lBByX",
"scriptIds": ["1AqL4PgNLkch4pp-Bq6WaL1pBmu3K4mL_sIxojO5AUraoeKI9RP4lBByX"],
"htmlFiles": ["DateRangeDialog.html"]
},
"salesOriginal": {
"scriptId": "1Fy_9bPmflJF1UO3lBG8Gmxwo3yOMdsyh0CzwYxAFRlaSuLYSA1gVogbc",
"universalTest": {
"scriptIds": ["1AqL4PgNLkch4pp-Bq6WaL1pBmu3K4mL_sIxojO5AUraoeKI9RP4lBByX"],
"htmlFiles": ["DateRangeDialog.html"]
},
"salesOriginalTest": {
"scriptId": "1_uIw9bNqPzLk6l5_hEMUeeJAfw78w3v8xXTjOf2l5pQvWueuREKBBKVs",
"scriptIds": ["1Fy_9bPmflJF1UO3lBG8Gmxwo3yOMdsyh0CzwYxAFRlaSuLYSA1gVogbc"],
"htmlFiles": ["DateRangeDialog.html"]
},
"salesOriginal": {
"scriptIds": ["1_uIw9bNqPzLk6l5_hEMUeeJAfw78w3v8xXTjOf2l5pQvWueuREKBBKVs"],
"htmlFiles": ["DateRangeDialog.html"]
}
}

View File

@ -16,6 +16,29 @@ export function saveConfig(config: Record<string, string>): void {
file.setContent(JSON.stringify(config, null, 2));
}
const EXECUTOR_SPREADSHEET_PREFIX = 'Задачи - ';
export function getOrCreateExecutorSpreadsheet(
executorName: string,
config: Record<string, string>
): GoogleAppsScript.Spreadsheet.Spreadsheet {
const spreadsheetId = config[executorName];
if (spreadsheetId) {
try {
return SpreadsheetApp.openById(spreadsheetId);
} catch (_error) {
Logger.log(`Не удалось открыть таблицу исполнителя "${executorName}", создаю новую`);
}
}
const spreadsheet = SpreadsheetApp.create(EXECUTOR_SPREADSHEET_PREFIX + executorName);
config[executorName] = spreadsheet.getId();
saveConfig(config);
Logger.log(`Создана таблица для исполнителя "${executorName}"`);
return spreadsheet;
}
export function clearSheetsForMissingPeople(names: string[], sheetName: string): void {
const config = loadConfig();
const namesSet = new Set(names);

View File

@ -1,7 +1,7 @@
import { EXECUTOR_SHEET_NAMES } from '../../../core/constants';
import { getBitrixTaskViewUrl, getSourceSheet } from '../../../core/config';
import { getUserEmailMap } from '../../../core/mail/emailConfig';
import { clearSheetsForMissingPeople, loadConfig } from '../../../core/mail/executorTables';
import { clearSheetsForMissingPeople, getOrCreateExecutorSpreadsheet, loadConfig } from '../../../core/mail/executorTables';
import { dateDiffToMs, getNextWorkday, msToDuration } from '../../../core/dates';
import { applyReportSheetLayout } from '../../../core/sheets/columnLayout';
import { setReportSheetFormat } from '../../../core/sheets/reportLifecycle';
@ -64,13 +64,10 @@ export function exportActualTasks(): void {
clearSheetsForMissingPeople(existingExecutors, SHEET_NAME);
Object.entries(executorTasks).forEach(([executor, tasks]) => {
const spreadsheetId = config[executor];
if (!spreadsheetId) {
Logger.log('Не найдена таблица: ' + executor);
return;
}
if (!tasks || tasks.length == 0) return;
const ss = getOrCreateExecutorSpreadsheet(executor, config);
metricsStorage.updateMetric(now, executor, 'totalTasks', tasks.length);
tasks.sort((a, b) => {
@ -83,7 +80,6 @@ export function exportActualTasks(): void {
return da - db;
});
const ss = SpreadsheetApp.openById(spreadsheetId);
let sheet = ss.getSheetByName(SHEET_NAME);
if (!sheet) sheet = ss.insertSheet(SHEET_NAME);
sheet.clear();

View File

@ -2,7 +2,7 @@ import { EXECUTOR_SHEET_NAMES } from '../../../core/constants';
import { taskCodeDecodeHeader } from '../../../core/taskCodes';
import { askUser } from '../../../core/ui';
import { getUserEmailMap } from '../../../core/mail/emailConfig';
import { loadConfig } from '../../../core/mail/executorTables';
import { getOrCreateExecutorSpreadsheet, loadConfig } from '../../../core/mail/executorTables';
export function distributeOverdueTasksToExecutors(): void {
const confirmed = askUser('Подтвеждаете отправку?');
@ -91,14 +91,8 @@ export function distributeOverdueTasksToExecutors(): void {
const emailMap = getUserEmailMap();
Object.entries(executorTasks).forEach(([executorName, executorRows]) => {
const spreadsheetId = config[executorName];
if (!spreadsheetId) {
Logger.log(`Для исполнителя "${executorName}" не найдена таблица`);
return;
}
try {
const targetSpreadsheet = SpreadsheetApp.openById(spreadsheetId);
const targetSpreadsheet = getOrCreateExecutorSpreadsheet(executorName, config);
let targetSheet = targetSpreadsheet.getSheetByName(SHEET_NAME);
if (!targetSheet) {
targetSheet = targetSpreadsheet.insertSheet(SHEET_NAME);
@ -134,7 +128,7 @@ export function distributeOverdueTasksToExecutors(): void {
sendOverdueExecutorEmail(
emailMap[executorName],
SpreadsheetApp.openById(spreadsheetId).getUrl() + '#gid=' + targetSheet.getSheetId()
targetSpreadsheet.getUrl() + '#gid=' + targetSheet.getSheetId()
);
}
} catch (error) {

View File

@ -1,7 +1,7 @@
import { EXECUTOR_SHEET_NAMES } from '../../core/constants';
import { askUser } from '../../core/ui';
import { getUserEmailMap } from '../../core/mail/emailConfig';
import { loadConfig, saveConfig } from '../../core/mail/executorTables';
import { getOrCreateExecutorSpreadsheet, loadConfig } from '../../core/mail/executorTables';
import { taskCodeDecodeHeader } from '../../core/taskCodes';
import { sendExecutorNotification } from './executorEmail';
@ -91,28 +91,10 @@ export function distributeTasksToExecutors(): void {
});
Object.keys(grouped).forEach(executor => {
let spreadsheetId = config[executor];
let spreadsheet: GoogleAppsScript.Spreadsheet.Spreadsheet | null = null;
if (spreadsheetId) {
try {
spreadsheet = SpreadsheetApp.openById(spreadsheetId);
} catch (_e) {
spreadsheet = null;
}
}
if (!spreadsheet) {
spreadsheet = SpreadsheetApp.create('Задачи - ' + executor);
spreadsheetId = spreadsheet.getId();
config[executor] = spreadsheetId;
}
const spreadsheet = getOrCreateExecutorSpreadsheet(executor, config);
const sheet = prepareExecutorSpreadsheet(spreadsheet, grouped[executor]);
sendExecutorNotification({ executor, spreadsheet, usersMap, sheet });
});
saveConfig(config);
}
function prepareExecutorSpreadsheet(

View File

@ -2,7 +2,7 @@ import { EXECUTOR_SHEET_NAMES } from '../../core/constants';
import { getBitrixTaskViewUrl, getSourceSheet } from '../../core/config';
import { askUser } from '../../core/ui';
import { getUserEmailMap } from '../../core/mail/emailConfig';
import { loadConfig } from '../../core/mail/executorTables';
import { getOrCreateExecutorSpreadsheet, loadConfig } from '../../core/mail/executorTables';
import { diffMinutes } from '../../core/dates';
import { applyReportSheetLayout } from '../../core/sheets/columnLayout';
import { setReportSheetFormat } from '../../core/sheets/reportLifecycle';
@ -66,13 +66,10 @@ export function exportActualTasks(): void {
const SHEET_NAME = EXECUTOR_SHEET_NAMES.actualTasks;
Object.entries(executorTasks).forEach(([executor, tasks]) => {
const spreadsheetId = config[executor];
if (!spreadsheetId) {
Logger.log('Не найдена таблица: ' + executor);
return;
}
if (!tasks || tasks.length == 0) return;
const ss = getOrCreateExecutorSpreadsheet(executor, config);
metricsStorage.updateMetric(now, executor, 'totalTasks', tasks.length);
tasks.sort((a, b) => {
@ -85,7 +82,6 @@ export function exportActualTasks(): void {
return da - db;
});
const ss = SpreadsheetApp.openById(spreadsheetId);
let sheet = ss.getSheetByName(SHEET_NAME);
if (!sheet) sheet = ss.insertSheet(SHEET_NAME);
sheet.clear();

View File

@ -2,7 +2,7 @@ import { EXECUTOR_SHEET_NAMES } from '../../core/constants';
import { taskCodeDecodeHeader } from '../../core/taskCodes';
import { askUser } from '../../core/ui';
import { getUserEmailMap } from '../../core/mail/emailConfig';
import { loadConfig } from '../../core/mail/executorTables';
import { getOrCreateExecutorSpreadsheet, loadConfig } from '../../core/mail/executorTables';
export function distributeOverdueTasksToExecutors(): void {
const confirmed = askUser('Подтвеждаете отправку?');
@ -91,14 +91,8 @@ export function distributeOverdueTasksToExecutors(): void {
const emailMap = getUserEmailMap();
Object.entries(executorTasks).forEach(([executorName, executorRows]) => {
const spreadsheetId = config[executorName];
if (!spreadsheetId) {
Logger.log(`Для исполнителя "${executorName}" не найдена таблица`);
return;
}
try {
const targetSpreadsheet = SpreadsheetApp.openById(spreadsheetId);
const targetSpreadsheet = getOrCreateExecutorSpreadsheet(executorName, config);
let targetSheet = targetSpreadsheet.getSheetByName(SHEET_NAME);
if (!targetSheet) {
targetSheet = targetSpreadsheet.insertSheet(SHEET_NAME);
@ -134,7 +128,7 @@ export function distributeOverdueTasksToExecutors(): void {
sendOverdueExecutorEmail(
emailMap[executorName],
SpreadsheetApp.openById(spreadsheetId).getUrl() + '#gid=' + targetSheet.getSheetId()
targetSpreadsheet.getUrl() + '#gid=' + targetSheet.getSheetId()
);
}
} catch (error) {

View File

@ -0,0 +1,33 @@
import { describe, expect, it } from 'vitest';
import { scriptIdsFromConfig } from '../tools/departmentConfig.mjs';
describe('scriptIdsFromConfig', () => {
it('принимает один scriptId', () => {
expect(scriptIdsFromConfig({ scriptId: ' alpha ' }, 'universal')).toEqual(['alpha']);
});
it('принимает несколько scriptIds', () => {
expect(
scriptIdsFromConfig(
{ scriptIds: [' first ', 'second', 'first'] },
'universal'
)
).toEqual(['first', 'second']);
});
it('принимает массив в scriptId', () => {
expect(scriptIdsFromConfig({ scriptId: ['one', 'two'] }, 'universal')).toEqual([
'one',
'two',
]);
});
it('отклоняет пустой список и одновременное указание обоих полей', () => {
expect(() => scriptIdsFromConfig({ scriptIds: [] }, 'universal')).toThrow(
/empty/
);
expect(() =>
scriptIdsFromConfig({ scriptId: 'one', scriptIds: ['two'] }, 'universal')
).toThrow(/not both/);
});
});

View File

@ -2,6 +2,7 @@ import * as esbuild from 'esbuild';
import fs from 'fs';
import path from 'path';
import { fileURLToPath } from 'url';
import { loadDepartmentConfig, writeClaspConfig } from './departmentConfig.mjs';
import { rewriteGeneratedVarKeywords } from './rewriteGeneratedVars.mjs';
const root = path.join(path.dirname(fileURLToPath(import.meta.url)), '..');
@ -12,12 +13,13 @@ if (!department) {
process.exit(1);
}
const departmentsPath = path.join(root, 'departments.json');
const departments = JSON.parse(fs.readFileSync(departmentsPath, 'utf8'));
const config = departments[department];
let config;
let scriptIds;
if (!config || !config.scriptId) {
console.error(`Unknown department or missing scriptId: ${department}`);
try {
({ config, scriptIds } = loadDepartmentConfig(root, department));
} catch (error) {
console.error(error instanceof Error ? error.message : error);
process.exit(1);
}
@ -66,23 +68,10 @@ for (const fileName of htmlFiles) {
fs.copyFileSync(source, path.join(outDir, fileName));
}
fs.writeFileSync(
path.join(outDir, '.clasp.json'),
JSON.stringify(
{
scriptId: config.scriptId,
rootDir: '.',
scriptExtensions: ['.js', '.gs'],
htmlExtensions: ['.html'],
jsonExtensions: ['.json'],
skipSubdirectories: true,
},
null,
2
)
);
writeClaspConfig(outDir, scriptIds[0]);
console.log(`Built ${department} → dist/${department}`);
console.log(`Script targets: ${scriptIds.join(', ')}`);
function collectGasFunctionNames(code) {
const names = new Set(['onOpen', 'menuSetup']);

View File

@ -0,0 +1,94 @@
import fs from 'fs';
import path from 'path';
export function loadDepartmentConfig(root, department) {
const departmentsPath = path.join(root, 'departments.json');
const departments = JSON.parse(fs.readFileSync(departmentsPath, 'utf8'));
const config = departments[department];
if (!config) {
throw new Error(`Unknown department: ${department}`);
}
return {
config,
scriptIds: scriptIdsFromConfig(config, department),
};
}
export function scriptIdsFromConfig(config, department = 'department') {
const hasScriptIds = Object.prototype.hasOwnProperty.call(config, 'scriptIds');
const hasScriptId = Object.prototype.hasOwnProperty.call(config, 'scriptId');
if (hasScriptIds && hasScriptId) {
throw new Error(
`${department}: use either scriptIds or scriptId, not both`
);
}
if (!hasScriptIds && !hasScriptId) {
throw new Error(
`${department}: missing scriptIds. Set a non-empty array of Apps Script project ids`
);
}
const rawIds = hasScriptIds ? config.scriptIds : config.scriptId;
const label = hasScriptIds ? 'scriptIds' : 'scriptId';
if (hasScriptId && typeof rawIds === 'string') {
return dedupeScriptIds([rawIds], department, label);
}
if (!Array.isArray(rawIds)) {
throw new Error(
`${department}: ${label} must be ${
hasScriptIds ? 'an array of script ids' : 'a script id or an array of script ids'
}`
);
}
return dedupeScriptIds(rawIds, department, label);
}
export function writeClaspConfig(dir, scriptId) {
fs.writeFileSync(
path.join(dir, '.clasp.json'),
JSON.stringify(
{
scriptId,
rootDir: '.',
scriptExtensions: ['.js', '.gs'],
htmlExtensions: ['.html'],
jsonExtensions: ['.json'],
skipSubdirectories: true,
},
null,
2
)
);
}
function dedupeScriptIds(rawIds, department, label) {
const scriptIds = [];
const seen = new Set();
for (const rawId of rawIds) {
if (typeof rawId !== 'string' || rawId.trim() === '') {
throw new Error(`${department}: ${label} must contain non-empty strings`);
}
const scriptId = rawId.trim();
if (seen.has(scriptId)) {
continue;
}
seen.add(scriptId);
scriptIds.push(scriptId);
}
if (scriptIds.length === 0) {
throw new Error(`${department}: ${label} is empty`);
}
return scriptIds;
}

View File

@ -2,6 +2,7 @@ import { spawnSync } from 'child_process';
import fs from 'fs';
import path from 'path';
import { fileURLToPath } from 'url';
import { loadDepartmentConfig, writeClaspConfig } from './departmentConfig.mjs';
const root = path.join(path.dirname(fileURLToPath(import.meta.url)), '..');
const department = process.argv[2];
@ -12,17 +13,44 @@ if (!department) {
}
const distDir = path.join(root, 'dist', department);
const claspConfig = path.join(distDir, '.clasp.json');
if (!fs.existsSync(claspConfig)) {
if (!fs.existsSync(path.join(distDir, 'Code.js'))) {
console.error(`Nothing to push. Run: npm run build -- ${department}`);
process.exit(1);
}
const result = spawnSync('npx', ['clasp', 'push', '--force'], {
cwd: distDir,
stdio: 'inherit',
shell: true,
});
let scriptIds;
process.exit(result.status ?? 1);
try {
({ scriptIds } = loadDepartmentConfig(root, department));
} catch (error) {
console.error(error instanceof Error ? error.message : error);
process.exit(1);
}
for (let index = 0; index < scriptIds.length; index += 1) {
const scriptId = scriptIds[index];
writeClaspConfig(distDir, scriptId);
console.log(
`Pushing ${department} → ${scriptId} (${index + 1}/${scriptIds.length})`
);
const result = spawnSync('npx', ['clasp', 'push', '--force'], {
cwd: distDir,
stdio: 'inherit',
shell: true,
});
if ((result.status ?? 1) !== 0) {
console.error(`Push failed for ${scriptId}.`);
if (index > 0) {
console.error(`Already pushed: ${scriptIds.slice(0, index).join(', ')}`);
}
if (index < scriptIds.length - 1) {
console.error(`Not pushed: ${scriptIds.slice(index + 1).join(', ')}`);
}
process.exit(result.status ?? 1);
}
}
console.log(`Pushed ${department} to ${scriptIds.length} Apps Script project(s).`);