@platforma-sdk/tengo-builder 1.17.5 → 1.17.7

package/src/compiler/compileroptions.ts

@@ -1,5 +1,5 @@
-import { TemplateData, TemplateLibData } from '@milaboratories/pl-model-backend';
-import { CompilerOption } from './package';
+import type { TemplateData, TemplateLibData } from '@milaboratories/pl-model-backend';
+import type { CompilerOption } from './package';
 import * as util from './util';
 
 export function applyTemplateCompilerOptions(opts: CompilerOption[], tpl: TemplateData) {
@@ -18,10 +18,10 @@ export function applyLibraryCompilerOptions(opts: CompilerOption[], lib: Templat
     switch (opt.name) {
       case 'hash_override': {
         throw new Error(
-          `hash_override compiler option can be used ONLY on template level. Even in templates it is already dangerous enough` +
-            ` to potentially break everything in Platforma Backend. In libraries with the transitive dependencies`+
-            ` resolution and flattening of libraries list on template level, it becomes so unpredictibally disasterous, that`+
-            ` we are doomed to never find the ends of a knot if anything goes wrong.`
+          `hash_override compiler option can be used ONLY on template level. Even in templates it is already dangerous enough`
+          + ` to potentially break everything in Platforma Backend. In libraries with the transitive dependencies`
+          + ` resolution and flattening of libraries list on template level, it becomes so unpredictibally disasterous, that`
+          + ` we are doomed to never find the ends of a knot if anything goes wrong.`,
         );
       }
     }
@@ -31,7 +31,7 @@ export function applyLibraryCompilerOptions(opts: CompilerOption[], lib: Templat
 export function hashOverride(args: string[]): string {
   if (args.length != 1) {
     throw new Error(
-      'hash_override compiler option expects exactly one argument: hash_override <some string>. Note, you can use only UUID as a value.'
+      'hash_override compiler option expects exactly one argument: hash_override <some string>. Note, you can use only UUID as a value.',
     );
   }
 
@@ -39,11 +39,11 @@ export function hashOverride(args: string[]): string {
 
   if (!util.isUUID(override)) {
     throw new Error(
-      'hash_override must contain valid UUID as an override. As hash_override affects deduplication,' +
-        " it becomes completely not possible to distinguish several different templates from each other on backend's side." +
-        ' This means, if you set hash_override to a simple value (say, letter "a") on two completely different templates,' +
-        " they will be marked as interchangeable on backend's side with unpredictable consequences." +
-        ' UUID looks like a safe enough tradeoff between the feature usage simplicity and duplication safety'
+      'hash_override must contain valid UUID as an override. As hash_override affects deduplication,'
+      + ' it becomes completely not possible to distinguish several different templates from each other on backend\'s side.'
+      + ' This means, if you set hash_override to a simple value (say, letter "a") on two completely different templates,'
+      + ' they will be marked as interchangeable on backend\'s side with unpredictable consequences.'
+      + ' UUID looks like a safe enough tradeoff between the feature usage simplicity and duplication safety',
     );
   }
 

package/src/compiler/main.ts

@@ -3,17 +3,19 @@
 import * as path from 'node:path';
 import * as fs from 'node:fs';
 import { findNodeModules, pathType } from './util';
-import { TemplatesAndLibs, TengoTemplateCompiler } from './compiler';
+import type { TemplatesAndLibs } from './compiler';
+import { TengoTemplateCompiler } from './compiler';
+import type {
+  CompileMode,
+  FullArtifactName } from './package';
 import {
   artifactNameToString,
-  CompileMode,
-  FullArtifactName,
   fullNameToString,
-  typedArtifactNameToString
+  typedArtifactNameToString,
 } from './package';
 import { ArtifactSource, parseSourceFile } from './source';
 import { Template } from './template';
-import winston from 'winston';
+import type winston from 'winston';
 
 interface PackageJson {
   name: string;
@@ -38,7 +40,7 @@ const srcAssetSuffix = '.as.json';
 const compilableSuffixes = [srcLibSuffix, srcTplSuffix, srcSoftwareSuffix, srcAssetSuffix];
 
 export function getPackageInfo(): PackageJson {
-  const packageInfo: PackageJson = JSON.parse(fs.readFileSync('package.json').toString());
+  const packageInfo: PackageJson = JSON.parse(fs.readFileSync('package.json').toString()) as PackageJson;
   return packageInfo;
 }
 
@@ -63,7 +65,7 @@ function loadDependencies(
   compiler: TengoTemplateCompiler,
   packageInfo: PackageJson,
   searchIn: string,
-  isLink: boolean = false
+  isLink: boolean = false,
 ): void {
   const packageJsonPath = path.resolve(searchIn, 'package.json');
 
@@ -98,14 +100,14 @@ function loadDependencies(
     return;
 
   // we are in tengo dependency folder
-  const packageJson: PackageJson = JSON.parse(fs.readFileSync(packageJsonPath).toString());
+  const packageJson: PackageJson = JSON.parse(fs.readFileSync(packageJsonPath).toString()) as PackageJson;
 
   // in a workspace we will find ourselves in node_modules, ignoring
   if (packageJson.name === packageInfo.name) return;
 
   if (pathType(path.resolve(searchIn, 'node_modules')) === 'dir' && isLink)
     throw new Error(
-      `nested node_modules is a sign of library dependencies version incompatibility in ${searchIn}`
+      `nested node_modules is a sign of library dependencies version incompatibility in ${searchIn}`,
     );
 
   if (libDistExists) {
@@ -130,7 +132,7 @@ function loadLibsFromDir(
   packageJson: PackageJson,
   mode: CompileMode,
   folder: string,
-  compiler: TengoTemplateCompiler
+  compiler: TengoTemplateCompiler,
 ) {
   for (const f of fs.readdirSync(folder)) {
     const file = path.resolve(folder, f);
@@ -139,7 +141,7 @@ function loadLibsFromDir(
       type: 'library',
       pkg: packageJson.name,
       id: f.slice(0, f.length - compiledLibSuffix.length),
-      version: packageJson.version
+      version: packageJson.version,
     };
     const src = parseSourceFile(logger, mode, file, fullName, true);
     compiler.addLib(src);
@@ -156,7 +158,7 @@ function loadTemplatesFromDir(
   packageJson: PackageJson,
   mode: CompileMode,
   folder: string,
-  compiler: TengoTemplateCompiler
+  compiler: TengoTemplateCompiler,
 ) {
   // adding templates
   for (const f of fs.readdirSync(folder)) {
@@ -166,7 +168,7 @@ function loadTemplatesFromDir(
       type: 'template',
       pkg: packageJson.name,
       id: f.slice(0, f.length - compiledTplSuffix.length),
-      version: packageJson.version
+      version: packageJson.version,
     };
     const tpl = new Template(mode, fullName, { content: fs.readFileSync(file) });
     compiler.addTemplate(tpl);
@@ -179,7 +181,7 @@ function loadSoftwareFromDir(
   packageJson: PackageJson,
   mode: CompileMode,
   folder: string,
-  compiler: TengoTemplateCompiler
+  compiler: TengoTemplateCompiler,
 ) {
   for (const f of fs.readdirSync(folder)) {
     const file = path.resolve(folder, f);
@@ -189,7 +191,7 @@ function loadSoftwareFromDir(
       type: 'software',
       pkg: packageJson.name,
       id: f.slice(0, f.length - compiledSoftwareSuffix.length),
-      version: packageJson.version
+      version: packageJson.version,
     };
 
     const software = new ArtifactSource(mode, fullName, fs.readFileSync(file).toString(), file, [], []);
@@ -204,7 +206,7 @@ function loadAssetsFromDir(
   packageJson: PackageJson,
   mode: CompileMode,
   folder: string,
-  compiler: TengoTemplateCompiler
+  compiler: TengoTemplateCompiler,
 ) {
   for (const f of fs.readdirSync(folder)) {
     const file = path.resolve(folder, f);
@@ -214,7 +216,7 @@ function loadAssetsFromDir(
       type: 'asset',
       pkg: packageJson.name,
       id: f.slice(0, f.length - compiledAssetSuffix.length),
-      version: packageJson.version
+      version: packageJson.version,
     };
 
     const asset = new ArtifactSource(mode, fullName, fs.readFileSync(file).toString(), file, [], []);
@@ -229,7 +231,7 @@ export function parseSources(
   packageInfo: PackageJson,
   mode: CompileMode,
   root: string,
-  subdir: string
+  subdir: string,
 ): ArtifactSource[] {
   const sources: ArtifactSource[] = [];
 
@@ -243,8 +245,8 @@ export function parseSources(
       continue;
     }
 
-    const artifactName =
-      f === 'index.lib.tengo' ? `${path.dirname(inRootPath)}.lib.tengo` : inRootPath;
+    const artifactName
+      = f === 'index.lib.tengo' ? `${path.dirname(inRootPath)}.lib.tengo` : inRootPath;
 
     const fullName = fullNameFromFileName(packageInfo, artifactName.replaceAll(path.sep, '.'));
     if (!fullName) {
@@ -275,7 +277,7 @@ export function parseSources(
 export function newCompiler(
   logger: winston.Logger,
   packageInfo: PackageJson,
-  mode: CompileMode
+  mode: CompileMode,
 ): TengoTemplateCompiler {
   const compiler = new TengoTemplateCompiler(mode);
 
@@ -287,14 +289,14 @@ export function newCompiler(
 
 function fullNameFromFileName(
   packageJson: PackageJson,
-  artifactName: string
+  artifactName: string,
 ): FullArtifactName | null {
   const pkgAndVersion = { pkg: packageJson.name, version: packageJson.version };
   if (artifactName.endsWith(srcLibSuffix)) {
     return {
       ...pkgAndVersion,
       id: artifactName.substring(0, artifactName.length - srcLibSuffix.length),
-      type: 'library'
+      type: 'library',
     };
   }
 
@@ -302,7 +304,7 @@ function fullNameFromFileName(
     return {
       ...pkgAndVersion,
       id: artifactName.substring(0, artifactName.length - srcTplSuffix.length),
-      type: 'template'
+      type: 'template',
     };
   }
 
@@ -310,7 +312,7 @@ function fullNameFromFileName(
     return {
       ...pkgAndVersion,
       id: artifactName.substring(0, artifactName.length - srcSoftwareSuffix.length),
-      type: 'software'
+      type: 'software',
     };
   }
 
@@ -318,7 +320,7 @@ function fullNameFromFileName(
     return {
       ...pkgAndVersion,
       id: artifactName.substring(0, artifactName.length - srcAssetSuffix.length),
-      type: 'asset'
+      type: 'asset',
     };
   }
 
@@ -326,7 +328,7 @@ function fullNameFromFileName(
     return {
       ...pkgAndVersion,
       id: artifactName.substring(0, artifactName.length - srcTestSuffix.length),
-      type: 'test'
+      type: 'test',
     };
   }
 

package/src/compiler/package.ts

@@ -67,7 +67,7 @@ export function typedArtifactNameToString(name: TypedArtifactName): string {
 
 export function typedArtifactNamesEquals(
   name1: TypedArtifactName,
-  name2: TypedArtifactName
+  name2: TypedArtifactName,
 ): boolean {
   return name1.type == name2.type && name1.pkg == name2.pkg && name1.id == name2.id;
 }

package/src/compiler/source.ts

@@ -1,22 +1,23 @@
 import { readFileSync } from 'node:fs';
-import winston from 'winston';
-import {
+import type winston from 'winston';
+import type {
   TypedArtifactName,
   FullArtifactName,
   ArtifactType,
   CompileMode,
-  CompilerOption
+  CompilerOption,
 } from './package';
-import { ArtifactMap, createArtifactNameSet } from './artifactset';
+import type { ArtifactMap } from './artifactset';
+import { createArtifactNameSet } from './artifactset';
 
 // matches any valid name in tengo. Don't forget to use '\b' when needed to limit the boundaries!
 const namePattern = '[_a-zA-Z][_a-zA-Z0-9]*';
 
 const functionCallRE = (moduleName: string, fnName: string) => {
   return new RegExp(
-    `\\b${moduleName}\\.(?<fnCall>(?<fnName>` +
-      fnName +
-      `)\\s*\\(\\s*"(?<templateName>[^"]+)"\\s*\\))`
+    `\\b${moduleName}\\.(?<fnCall>(?<fnName>`
+    + fnName
+    + `)\\s*\\(\\s*"(?<templateName>[^"]+)"\\s*\\))`,
   );
 };
 
@@ -45,7 +46,7 @@ const multilineCommentStartRE = /^\s*\/\*/;
 const multilineCommentEndRE = /\*\//;
 const importRE = /\s*:=\s*import\s*\(\s*"(?<moduleName>[^"]+)"\s*\)/;
 const importNameRE = new RegExp(
-  `\\b(?<importName>${namePattern}(\\.${namePattern})*)${importRE.source}`
+  `\\b(?<importName>${namePattern}(\\.${namePattern})*)${importRE.source}`,
 );
 const dependencyRE = /(?<pkgName>[^"]+)?:(?<depID>[^"]+)/; // use it to parse <moduleName> from importPattern or <templateName> акщь getTemplateID
 
@@ -62,14 +63,14 @@ const parseComplierOption = (opt: string): CompilerOption => {
   const namePart = parts[0].split(':');
   if (namePart.length != 2) {
     throw new Error(
-      "compiler option format is wrong: expect to have option name after 'tengo:' prefix, like 'tengo:MyOption'"
+      'compiler option format is wrong: expect to have option name after \'tengo:\' prefix, like \'tengo:MyOption\'',
     );
   }
   const optName = namePart[1];
 
   return {
     name: optName,
-    args: parts.slice(1)
+    args: parts.slice(1),
   };
 };
 
@@ -86,7 +87,7 @@ export class ArtifactSource {
     /** List of dependencies */
     public readonly dependencies: TypedArtifactName[],
     /** Additional compiler options detected in source code */
-    public readonly compilerOptions: CompilerOption[]
+    public readonly compilerOptions: CompilerOption[],
   ) {}
 }
 
@@ -95,7 +96,7 @@ export function parseSourceFile(
   mode: CompileMode,
   srcFile: string,
   fullSourceName: FullArtifactName,
-  normalize: boolean
+  normalize: boolean,
 ): ArtifactSource {
   const src = readFileSync(srcFile).toString();
   const { deps, normalized, opts } = parseSourceData(logger, src, fullSourceName, normalize);
@@ -108,7 +109,7 @@ export function parseSource(
   mode: CompileMode,
   src: string,
   fullSourceName: FullArtifactName,
-  normalize: boolean
+  normalize: boolean,
 ): ArtifactSource {
   const { deps, normalized, opts } = parseSourceData(logger, src, fullSourceName, normalize);
 
@@ -119,12 +120,12 @@ function parseSourceData(
   logger: winston.Logger,
   src: string,
   fullSourceName: FullArtifactName,
-  globalizeImports: boolean
+  globalizeImports: boolean,
 ): {
-  normalized: string;
-  deps: ArtifactMap<TypedArtifactName>;
-  opts: CompilerOption[];
-} {
+    normalized: string;
+    deps: ArtifactMap<TypedArtifactName>;
+    opts: CompilerOption[];
+  } {
   const dependencySet = createArtifactNameSet();
   const optionList: CompilerOption[] = [];
 
@@ -140,7 +141,7 @@ function parseSourceData(
     isInCommentBlock: false,
     canDetectOptions: true,
     tplDepREs: new Map<string, [ArtifactType, RegExp][]>(),
-    lineNo: 0
+    lineNo: 0,
   };
 
   for (const line of lines) {
@@ -152,7 +153,7 @@ function parseSourceData(
         line,
         parserContext,
         fullSourceName.pkg,
-        globalizeImports
+        globalizeImports,
       );
       processedLines.push(result.line);
       parserContext = result.context;
@@ -163,15 +164,16 @@ function parseSourceData(
       if (result.option) {
         optionList.push(result.option);
       }
-    } catch (error: any) {
-      throw new Error(`[line ${parserContext.lineNo}]: ${error.message}\n\t${line}`);
+    } catch (error: unknown) {
+      const err = error as Error;
+      throw new Error(`[line ${parserContext.lineNo}]: ${err.message}\n\t${line}`);
     }
   }
 
   return {
     normalized: processedLines.join('\n'),
     deps: dependencySet,
-    opts: optionList
+    opts: optionList,
   };
 }
 
@@ -187,13 +189,13 @@ function parseSingleSourceLine(
   line: string,
   context: sourceParserContext,
   localPackageName: string,
-  globalizeImports?: boolean
+  globalizeImports?: boolean,
 ): {
-  line: string;
-  context: sourceParserContext;
-  artifact: TypedArtifactName | undefined;
-  option: CompilerOption | undefined;
-} {
+    line: string;
+    context: sourceParserContext;
+    artifact: TypedArtifactName | undefined;
+    option: CompilerOption | undefined;
+  } {
   if (context.isInCommentBlock) {
     if (multilineCommentEndRE.exec(line)) {
       context.isInCommentBlock = false;
@@ -204,16 +206,16 @@ function parseSingleSourceLine(
   if (compilerOptionRE.exec(line)) {
     if (!context.canDetectOptions) {
       logger.error(
-        `[line ${context.lineNo}]: compiler option '//tengo:' was detected, but it cannot be applied as compiler options can be set only at the file header, before any code line'`
+        `[line ${context.lineNo}]: compiler option '//tengo:' was detected, but it cannot be applied as compiler options can be set only at the file header, before any code line'`,
       );
-      throw new Error("tengo compiler options ('//tengo:' comments) can be set only in file header");
+      throw new Error('tengo compiler options (\'//tengo:\' comments) can be set only in file header');
     }
     return { line, context, artifact: undefined, option: parseComplierOption(line) };
   }
 
   if (wrongCompilerOptionRE.exec(line) && context.canDetectOptions) {
     logger.warn(
-      `[line ${context.lineNo}]: text simillar to compiler option ('//tengo:...') was detected, but it has wrong format. Leave it as is, if you did not mean to use a line as compiler option. Or format it to '//tengo:<option>' otherwise (no spaces between '//' and 'tengo', no spaces between ':' and option name)`
+      `[line ${context.lineNo}]: text simillar to compiler option ('//tengo:...') was detected, but it has wrong format. Leave it as is, if you did not mean to use a line as compiler option. Or format it to '//tengo:<option>' otherwise (no spaces between '//' and 'tengo', no spaces between ':' and option name)`,
     );
     return { line, context, artifact: undefined, option: undefined };
   }
@@ -242,39 +244,39 @@ function parseSingleSourceLine(
       if (!context.tplDepREs.has(iInfo.module)) {
         context.tplDepREs.set(iInfo.module, [
           ['template', newGetTemplateIdRE(iInfo.alias)],
-          ['software', newGetSoftwareInfoRE(iInfo.alias)]
+          ['software', newGetSoftwareInfoRE(iInfo.alias)],
         ]);
       }
       return { line, context, artifact: undefined, option: undefined };
     }
 
     if (
-      iInfo.module === '@milaboratory/tengo-sdk:ll' ||
-      iInfo.module === '@platforma-sdk/workflow-tengo:ll' ||
-      ((localPackageName === '@milaboratory/tengo-sdk' ||
-        localPackageName === '@platforma-sdk/workflow-tengo') &&
-        iInfo.module === ':ll')
+      iInfo.module === '@milaboratory/tengo-sdk:ll'
+      || iInfo.module === '@platforma-sdk/workflow-tengo:ll'
+      || ((localPackageName === '@milaboratory/tengo-sdk'
+        || localPackageName === '@platforma-sdk/workflow-tengo')
+      && iInfo.module === ':ll')
     ) {
       if (!context.tplDepREs.has(iInfo.module)) {
         context.tplDepREs.set(iInfo.module, [
           ['template', newImportTemplateRE(iInfo.alias)],
-          ['software', newImportSoftwareRE(iInfo.alias)]
+          ['software', newImportSoftwareRE(iInfo.alias)],
         ]);
       }
     }
 
     if (
-      iInfo.module === '@milaboratory/tengo-sdk:assets' ||
-      iInfo.module === '@platforma-sdk/workflow-tengo:assets' ||
-      ((localPackageName === '@milaboratory/tengo-sdk' ||
-        localPackageName === '@platforma-sdk/workflow-tengo') &&
-        iInfo.module === ':assets')
+      iInfo.module === '@milaboratory/tengo-sdk:assets'
+      || iInfo.module === '@platforma-sdk/workflow-tengo:assets'
+      || ((localPackageName === '@milaboratory/tengo-sdk'
+        || localPackageName === '@platforma-sdk/workflow-tengo')
+      && iInfo.module === ':assets')
     ) {
       if (!context.tplDepREs.has(iInfo.module)) {
         context.tplDepREs.set(iInfo.module, [
           ['template', newImportTemplateRE(iInfo.alias)],
           ['software', newImportSoftwareRE(iInfo.alias)],
-          ['asset', newImportAssetRE(iInfo.alias)]
+          ['asset', newImportAssetRE(iInfo.alias)],
         ]);
       }
     }
@@ -342,14 +344,14 @@ function parseImport(line: string): ImportInfo {
 
   return {
     module: moduleName,
-    alias: importName
+    alias: importName,
   };
 }
 
 function parseArtifactName(
   moduleName: string,
   aType: ArtifactType,
-  localPackageName: string
+  localPackageName: string,
 ): TypedArtifactName | undefined {
   const depInfo = dependencyRE.exec(moduleName);
   if (!depInfo) {
@@ -358,14 +360,14 @@ function parseArtifactName(
 
   if (!depInfo.groups) {
     throw Error(
-      `failed to parse dependency name inside 'import' statement. The dependency name should have format '<package>:<templateName>'`
+      `failed to parse dependency name inside 'import' statement. The dependency name should have format '<package>:<templateName>'`,
     );
   }
 
   const { pkgName, depID } = depInfo.groups;
   if (!depID) {
     throw Error(
-      `failed to parse dependency name inside 'import' statement. The dependency name should have format '<package>:<templateName>'`
+      `failed to parse dependency name inside 'import' statement. The dependency name should have format '<package>:<templateName>'`,
     );
   }
 
@@ -382,14 +384,14 @@ function parseTemplateUse(match: RegExpExecArray, localPackageName: string): Typ
   const depInfo = dependencyRE.exec(templateName);
   if (!depInfo || !depInfo.groups) {
     throw Error(
-      `failed to parse dependency name inside 'getTemplateId' statement. The dependency name should have format '<package>:<templateName>'`
+      `failed to parse dependency name inside 'getTemplateId' statement. The dependency name should have format '<package>:<templateName>'`,
     );
   }
 
   const { pkgName, depID } = depInfo.groups;
   if (!pkgName || !depID) {
     throw Error(
-      `failed to parse dependency name inside 'getTemplateId' statement. The dependency name should have format '<package>:<templateName>'`
+      `failed to parse dependency name inside 'getTemplateId' statement. The dependency name should have format '<package>:<templateName>'`,
     );
   }