1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
|
import os
from enum import auto, StrEnum
from typing import Any, Literal, TYPE_CHECKING
# noinspection PyUnresolvedReferences
import ymake
import _dart_fields as df
import ytest
from _common import (
rootrel_arc_src,
sort_uniq,
strip_roots,
to_yesno,
)
from _dart_fields import create_dart_record
if TYPE_CHECKING:
from lib.nots.erm_json_lite import ErmJsonLite
from lib.nots.package_manager import PackageManagerType, BasePackageManager
from lib.nots.semver import Version
from lib.nots.typescript import TsConfig
# 1 is 60 files per chunk for TIMEOUT(60) - default timeout for SIZE(SMALL)
# 0.5 is 120 files per chunk for TIMEOUT(60) - default timeout for SIZE(SMALL)
# 0.2 is 300 files per chunk for TIMEOUT(60) - default timeout for SIZE(SMALL)
ESLINT_FILE_PROCESSING_TIME_DEFAULT = 0.2 # seconds per file
REQUIRED_MISSING = "~~required~~"
class COLORS:
"""
See https://en.m.wikipedia.org/wiki/ANSI_escape_code#Colors for details
"""
@staticmethod
def _wrap_color(color_code: int) -> str:
return f"\033[0;{color_code}m"
red = _wrap_color(31)
green = _wrap_color(32)
yellow = _wrap_color(33)
cyan = _wrap_color(36)
reset = _wrap_color(49)
class TsTestType(StrEnum):
ESLINT = auto()
HERMIONE = auto()
JEST = auto()
PLAYWRIGHT = auto()
PLAYWRIGHT_LARGE = auto()
TSC_TYPECHECK = auto()
TS_STYLELINT = auto()
class UnitType:
MessageType = Literal["INFO", "WARN", "ERROR"]
PluginArgs = str | list[str] | tuple[str]
def message(self, args: list[MessageType | str]) -> None:
"""
Print message to the log
"""
def get(self, var_name: str) -> str | None:
"""
Get variable value
"""
def set(self, args: PluginArgs) -> None:
"""
Set variable value
"""
def enabled(self, var_name: str) -> None:
"""
Set variable value to "yes"
"""
def disabled(self, var_name: str) -> None:
"""
Set variable value to "no"
"""
def set_property(self, args: PluginArgs) -> None:
"""
TODO (set vs set_property?)
"""
def resolve(self, path: str) -> str:
"""
Resolve path TODO?
"""
def resolve_arc_path(self, path: str) -> str:
"""
Resolve path TODO?
"""
def path(self) -> str:
"""
Get the project path
"""
def ondepends(self, deps: PluginArgs) -> None:
"""
Run DEPENDS(...)
"""
def onpeerdir(self, args: str | list[str]) -> None:
"""
Run PEERDIR(...)
"""
class NotsUnitType(UnitType):
def on_peerdir_ts_resource(self, *resources: str):
"""
Ensure dependency installed on the project
Also check its version (is it supported by erm)
"""
def on_do_ts_yndexing(self) -> None:
"""
Turn on code navigation indexing
"""
def on_from_npm(self, args: UnitType.PluginArgs) -> None:
"""
TODO remove after removing on_from_pnpm_lockfiles
"""
def on_setup_install_node_modules_recipe(self) -> None:
"""
Setup test recipe to install node_modules before running tests
"""
def on_setup_extract_node_modules_recipe(self, args: UnitType.PluginArgs) -> None:
"""
Setup test recipe to extract workspace-node_modules.tar before running tests
"""
def on_setup_extract_output_tars_recipe(self, args: UnitType.PluginArgs) -> None:
"""
Setup test recipe to extract peer's output before running tests
"""
TS_TEST_FIELDS_BASE = (
df.BinaryPath.normalized,
df.BuildFolderPath.normalized,
df.ForkMode.test_fork_mode,
df.NodejsRootVarName.value,
df.ScriptRelPath.first_flat,
df.SourceFolderPath.normalized,
df.SplitFactor.from_unit,
df.TestData.from_unit,
df.TestedProjectName.filename_without_ext,
df.TestEnv.value,
df.TestName.value,
df.TestRecipes.value,
df.TestTimeout.from_unit,
)
TS_TEST_SPECIFIC_FIELDS = {
TsTestType.ESLINT: (
df.Size.from_unit,
df.TestCwd.moddir,
df.Tag.from_unit,
df.Requirements.from_unit,
df.EslintConfigPath.value,
),
TsTestType.HERMIONE: (
df.Tag.from_unit_fat_external_no_retries,
df.Requirements.from_unit_with_full_network,
df.ConfigPath.value,
df.TsTestDataDirs.value,
df.TsTestDataDirsRename.value,
df.TsResources.value,
df.TsTestForPath.value,
),
TsTestType.JEST: (
df.Size.from_unit,
df.Tag.from_unit,
df.Requirements.from_unit,
df.ConfigPath.value,
df.TsTestDataDirs.value,
df.TsTestDataDirsRename.value,
df.TsResources.value,
df.TsTestForPath.value,
),
TsTestType.PLAYWRIGHT: (
df.Size.from_unit,
df.Tag.from_unit,
df.Requirements.from_unit,
df.ConfigPath.value,
df.TsTestDataDirs.value,
df.TsTestDataDirsRename.value,
df.TsResources.value,
df.TsTestForPath.value,
),
TsTestType.PLAYWRIGHT_LARGE: (
df.ConfigPath.value,
df.Size.from_unit,
df.Tag.from_unit_fat_external_no_retries,
df.Requirements.from_unit_with_full_network,
df.TsResources.value,
df.TsTestDataDirs.value,
df.TsTestDataDirsRename.value,
df.TsTestForPath.value,
),
TsTestType.TSC_TYPECHECK: (
df.Size.from_unit,
df.TestCwd.moddir,
df.Tag.from_unit,
df.Requirements.from_unit,
),
TsTestType.TS_STYLELINT: (
df.TsStylelintConfig.value,
df.TestFiles.stylesheets,
df.NodeModulesBundleFilename.value,
),
}
class PluginLogger(object):
unit: UnitType = None
prefix = ""
def reset(self, unit: NotsUnitType | None, prefix=""):
self.unit = unit
self.prefix = prefix
def get_state(self):
return self.unit, self.prefix
def _stringify_messages(self, messages: tuple[Any, ...]):
parts = []
for m in messages:
if m is None:
parts.append("None")
else:
parts.append(m if isinstance(m, str) else repr(m))
# cyan color (code 36) for messages
return f"{COLORS.green}{self.prefix}{COLORS.reset}\n{COLORS.cyan}{" ".join(parts)}{COLORS.reset}"
def info(self, *messages: Any) -> None:
if self.unit:
self.unit.message(["INFO", self._stringify_messages(messages)])
def warn(self, *messages: Any) -> None:
if self.unit:
self.unit.message(["WARN", self._stringify_messages(messages)])
def error(self, *messages: Any) -> None:
if self.unit:
self.unit.message(["ERROR", self._stringify_messages(messages)])
def print_vars(self, *variables: str):
if self.unit:
values = ["{}={}".format(v, self.unit.get(v)) for v in variables]
self.info("\n".join(values))
logger = PluginLogger()
def _with_report_configure_error(fn):
"""
Handle exceptions, report them as ymake configure error
Also wraps plugin function like `on<macro_name>` to register `unit` in the PluginLogger
"""
def _wrapper(*args, **kwargs):
last_state = logger.get_state()
unit = args[0]
logger.reset(unit if unit.get("TS_LOG") == "yes" else None, fn.__name__)
try:
fn(*args, **kwargs)
except Exception as exc:
ymake.report_configure_error(str(exc))
if unit.get("TS_RAISE") == "yes":
raise
else:
unit.message(["WARN", "Configure error is reported. Add -DTS_RAISE to see actual exception"])
finally:
logger.reset(*last_state)
return _wrapper
def _build_directives(name: str, flags: list[str] | tuple[str], paths: list[str]) -> str:
parts = [p for p in [name] + (flags or []) if p]
parts_str = ";".join(parts)
expressions = ['${{{parts}:"{path}"}}'.format(parts=parts_str, path=path) for path in paths]
return " ".join(expressions)
def _build_cmd_input_paths(paths: list[str] | tuple[str], hide=False, disable_include_processor=False):
hide_part = "hide" if hide else ""
disable_ip_part = "context=TEXT" if disable_include_processor else ""
return _build_directives("input", [hide_part, disable_ip_part], paths)
def _create_erm_json(unit: NotsUnitType):
from lib.nots.erm_json_lite import ErmJsonLite
erm_packages_path = unit.get("ERM_PACKAGES_PATH")
path = unit.resolve(unit.resolve_arc_path(erm_packages_path))
return ErmJsonLite.load(path)
def _get_pm_type(unit: NotsUnitType) -> 'PackageManagerType':
resolved: PackageManagerType | None = unit.get("PM_TYPE")
if not resolved:
raise Exception("PM_TYPE is not set yet. Macro _SET_PACKAGE_MANAGER() should be called before.")
return resolved
def _get_source_path(unit: NotsUnitType) -> str:
sources_path = unit.get("TS_TEST_FOR_DIR") if unit.get("TS_TEST_FOR") else unit.path()
return sources_path
def _create_pm(unit: NotsUnitType) -> 'BasePackageManager':
from lib.nots.package_manager import get_package_manager_type
sources_path = _get_source_path(unit)
module_path = unit.get("TS_TEST_FOR_PATH") if unit.get("TS_TEST_FOR") else unit.get("MODDIR")
# noinspection PyPep8Naming
PackageManager = get_package_manager_type(_get_pm_type(unit))
return PackageManager(
sources_path=unit.resolve(sources_path),
build_root="$B",
build_path=unit.path().replace("$S", "$B", 1),
nodejs_bin_path=None,
script_path=None,
module_path=module_path,
)
@_with_report_configure_error
def on_set_package_manager(unit: NotsUnitType) -> None:
pm_type = "pnpm" # projects without any lockfile are processed by pnpm
source_path = _get_source_path(unit)
for pm_key, lockfile_name in [("pnpm", "pnpm-lock.yaml"), ("npm", "package-lock.json")]:
lf_path = os.path.join(source_path, lockfile_name)
lf_path_resolved = unit.resolve_arc_path(strip_roots(lf_path))
if lf_path_resolved:
pm_type = pm_key
break
if pm_type == 'npm' and "devtools/dummy_arcadia/typescript/npm" not in source_path:
ymake.report_configure_error(
"\n"
"Project is configured to use npm as a package manager. \n"
"Only pnpm is supported at the moment.\n"
"Please follow the instruction to migrate your project:\n"
"https://docs.yandex-team.ru/frontend-in-arcadia/tutorials/migrate#migrate-to-pnpm"
)
unit.on_peerdir_ts_resource(pm_type)
unit.set(["PM_TYPE", pm_type])
unit.set(["PM_SCRIPT", f"${pm_type.upper()}_SCRIPT"])
@_with_report_configure_error
def on_set_append_with_directive(unit: NotsUnitType, var_name: str, directive: str, *values: str) -> None:
wrapped = [f'${{{directive}:"{v}"}}' for v in values]
__set_append(unit, var_name, " ".join(wrapped))
def _check_nodejs_version(unit: NotsUnitType, major: int) -> None:
if major < 14:
raise Exception(
"Node.js {} is unsupported. Update Node.js please. See https://nda.ya.ru/t/joB9Mivm6h4znu".format(major)
)
if major < 18:
unit.message(
[
"WARN",
"Node.js {} is deprecated. Update Node.js please. See https://nda.ya.ru/t/joB9Mivm6h4znu".format(major),
]
)
@_with_report_configure_error
def on_peerdir_ts_resource(unit: NotsUnitType, *resources: str) -> None:
from lib.nots.package_manager import BasePackageManager
pj = BasePackageManager.load_package_json_from_dir(unit.resolve(_get_source_path(unit)))
erm_json = _create_erm_json(unit)
dirs = []
nodejs_version = _select_matching_version(erm_json, "nodejs", pj.get_nodejs_version())
_check_nodejs_version(unit, nodejs_version.major)
for tool in resources:
dir_name = erm_json.canonize_name(tool)
if erm_json.use_resource_directly(tool):
# raises the configuration error when the version is unsupported
_select_matching_version(erm_json, tool, pj.get_dep_specifier(tool), dep_is_required=True)
elif tool == "nodejs":
dirs.append(os.path.join("build", "platform", dir_name, str(nodejs_version)))
_set_resource_vars(unit, erm_json, tool, nodejs_version)
elif erm_json.is_resource_multiplatform(tool):
v = _select_matching_version(erm_json, tool, pj.get_dep_specifier(tool))
sb_resources = [
sbr for sbr in erm_json.get_sb_resources(tool, v) if sbr.get("nodejs") == nodejs_version.major
]
nodejs_dir = "NODEJS_{}".format(nodejs_version.major)
if len(sb_resources) > 0:
dirs.append(os.path.join("build", "external_resources", dir_name, str(v), nodejs_dir))
_set_resource_vars(unit, erm_json, tool, v, nodejs_version.major)
else:
unit.message(["WARN", "Missing {}@{} for {}".format(tool, str(v), nodejs_dir)])
else:
v = _select_matching_version(erm_json, tool, pj.get_dep_specifier(tool))
dirs.append(os.path.join("build", "external_resources", dir_name, str(v)))
_set_resource_vars(unit, erm_json, tool, v, nodejs_version.major)
if dirs:
unit.onpeerdir(dirs)
@_with_report_configure_error
def on_ts_configure(unit: NotsUnitType) -> None:
from lib.nots.package_manager.base import PackageJson
from lib.nots.package_manager.base.utils import build_pj_path
from lib.nots.typescript import TsConfig
tsconfig_paths = unit.get("TS_CONFIG_PATH").split()
# for use in CMD as inputs
__set_append(
unit, "TS_CONFIG_FILES", _build_cmd_input_paths(tsconfig_paths, hide=True, disable_include_processor=True)
)
mod_dir = unit.get("MODDIR")
cur_dir = unit.get("TS_TEST_FOR_PATH") if unit.get("TS_TEST_FOR") else mod_dir
pj_path = build_pj_path(unit.resolve(unit.resolve_arc_path(cur_dir)))
dep_paths = PackageJson.load(pj_path).get_dep_paths_by_names()
# reversed for using the first tsconfig as the config for include processor (legacy)
for tsconfig_path in reversed(tsconfig_paths):
abs_tsconfig_path = unit.resolve(unit.resolve_arc_path(tsconfig_path))
if not abs_tsconfig_path:
raise Exception("tsconfig not found: {}".format(tsconfig_path))
tsconfig = TsConfig.load(abs_tsconfig_path)
config_files = tsconfig.inline_extend(dep_paths)
config_files = _resolve_module_files(unit, mod_dir, config_files)
use_tsconfig_outdir = unit.get("TS_CONFIG_USE_OUTDIR") == "yes"
tsconfig.validate(use_tsconfig_outdir)
# add tsconfig files from which root tsconfig files were extended
__set_append(
unit, "TS_CONFIG_FILES", _build_cmd_input_paths(config_files, hide=True, disable_include_processor=True)
)
# region include processor
unit.set(["TS_CONFIG_ROOT_DIR", tsconfig.compiler_option("rootDir")]) # also for hermione
if use_tsconfig_outdir:
unit.set(["TS_CONFIG_OUT_DIR", tsconfig.compiler_option("outDir")]) # also for hermione
unit.set(["TS_CONFIG_SOURCE_MAP", to_yesno(tsconfig.compiler_option("sourceMap"))])
unit.set(["TS_CONFIG_DECLARATION", to_yesno(tsconfig.compiler_option("declaration"))])
unit.set(["TS_CONFIG_DECLARATION_MAP", to_yesno(tsconfig.compiler_option("declarationMap"))])
unit.set(["TS_CONFIG_PRESERVE_JSX", to_yesno(tsconfig.compiler_option("jsx") == "preserve")])
# endregion
_filter_inputs_by_rules_from_tsconfig(unit, tsconfig)
# Code navigation
if unit.get("TS_YNDEXING") == "yes":
unit.on_do_ts_yndexing()
# Style tests
_setup_eslint(unit)
_setup_tsc_typecheck(unit)
_setup_stylelint(unit)
@_with_report_configure_error
def on_setup_build_env(unit: NotsUnitType) -> None:
build_env_var = unit.get("TS_BUILD_ENV")
if not build_env_var:
return
options = []
for name in build_env_var.split(","):
options.append("--env")
value = unit.get(f"TS_ENV_{name}")
if value is None:
ymake.report_configure_error(f"Env var '{name}' is provided in a list, but var value is not provided")
continue
double_quote_escaped_value = value.replace('"', '\\"')
options.append(f'"{name}={double_quote_escaped_value}"')
unit.set(["NOTS_TOOL_BUILD_ENV", " ".join(options)])
def __set_append(unit: NotsUnitType, var_name: str, value: UnitType.PluginArgs) -> None:
"""
SET_APPEND() python naive implementation - append value/values to the list of values
"""
previous_value = unit.get(var_name) or ""
value_in_str = " ".join(value) if isinstance(value, list) or isinstance(value, tuple) else value
new_value = previous_value + " " + value_in_str
unit.set([var_name, new_value])
def __strip_prefix(prefix: str, line: str) -> str:
if line.startswith(prefix):
prefix_len = len(prefix)
return line[prefix_len:]
return line
def _filter_inputs_by_rules_from_tsconfig(unit: NotsUnitType, tsconfig: 'TsConfig') -> None:
"""
Reduce file list from the TS_GLOB_FILES variable following tsconfig.json rules
"""
mod_dir = unit.get("MODDIR")
target_path = os.path.join("${ARCADIA_ROOT}", mod_dir, "") # To have "/" in the end
all_files = [__strip_prefix(target_path, f) for f in unit.get("TS_GLOB_FILES").split(" ")]
filtered_files = tsconfig.filter_files(all_files)
__set_append(unit, "TS_INPUT_FILES", [os.path.join(target_path, f) for f in filtered_files])
def _is_tests_enabled(unit: NotsUnitType) -> bool:
return unit.get("TIDY") != "yes"
def _setup_eslint(unit: NotsUnitType) -> None:
if not _is_tests_enabled(unit):
return
if unit.get("_NO_LINT_VALUE") == "none":
return
test_files = df.TestFiles.ts_lint_srcs(unit, (), {})[df.TestFiles.KEY]
if not test_files:
return
unit.on_peerdir_ts_resource("eslint")
user_recipes = unit.get("TEST_RECIPES_VALUE")
unit.on_setup_install_node_modules_recipe()
test_type = TsTestType.ESLINT
from lib.nots.package_manager import constants
peers = _create_pm(unit).get_peers_from_package_json()
deps = df.CustomDependencies.nots_with_recipies(unit, (peers,), {})[df.CustomDependencies.KEY].split()
if deps:
joined_deps = "\n".join(deps)
logger.info(f"{test_type} deps: \n{joined_deps}")
unit.ondepends(deps)
flat_args = (test_type, "MODDIR")
dart_record = create_dart_record(
TS_TEST_FIELDS_BASE + TS_TEST_SPECIFIC_FIELDS[test_type],
unit,
flat_args,
{},
)
dart_record[df.TestFiles.KEY] = test_files
dart_record[df.NodeModulesBundleFilename.KEY] = constants.NODE_MODULES_WORKSPACE_BUNDLE_FILENAME
extra_deps = df.CustomDependencies.test_depends_only(unit, (), {})[df.CustomDependencies.KEY].split()
dart_record[df.CustomDependencies.KEY] = " ".join(sort_uniq(deps + extra_deps))
dart_record[df.LintFileProcessingTime.KEY] = str(ESLINT_FILE_PROCESSING_TIME_DEFAULT)
data = ytest.dump_test(unit, dart_record)
if data:
unit.set_property(["DART_DATA", data])
unit.set(["TEST_RECIPES_VALUE", user_recipes])
@_with_report_configure_error
def _setup_tsc_typecheck(unit: NotsUnitType) -> None:
if not _is_tests_enabled(unit):
return
if unit.get("_TS_TYPECHECK_VALUE") == "none":
return
test_files = df.TestFiles.ts_input_files(unit, (), {})[df.TestFiles.KEY]
if not test_files:
return
tsconfig_paths = unit.get("TS_CONFIG_PATH").split()
tsconfig_path = tsconfig_paths[0]
if len(tsconfig_paths) > 1:
tsconfig_path = unit.get("_TS_TYPECHECK_TSCONFIG")
if not tsconfig_path:
macros = " or ".join([f"TS_TYPECHECK({p})" for p in tsconfig_paths])
raise Exception(f"Module uses several tsconfig files, specify which one to use for typecheck: {macros}")
abs_tsconfig_path = unit.resolve(unit.resolve_arc_path(tsconfig_path))
if not abs_tsconfig_path:
raise Exception(f"tsconfig for typecheck not found: {tsconfig_path}")
unit.on_peerdir_ts_resource("typescript")
user_recipes = unit.get("TEST_RECIPES_VALUE")
unit.on_setup_install_node_modules_recipe()
unit.on_setup_extract_output_tars_recipe([unit.get("MODDIR")])
test_type = TsTestType.TSC_TYPECHECK
from lib.nots.package_manager import constants
peers = _create_pm(unit).get_peers_from_package_json()
deps = df.CustomDependencies.nots_with_recipies(unit, (peers,), {})[df.CustomDependencies.KEY].split()
if deps:
joined_deps = "\n".join(deps)
logger.info(f"{test_type} deps: \n{joined_deps}")
unit.ondepends(deps)
flat_args = (test_type,)
dart_record = create_dart_record(
TS_TEST_FIELDS_BASE + TS_TEST_SPECIFIC_FIELDS[test_type],
unit,
flat_args,
{},
)
dart_record[df.TestFiles.KEY] = test_files
dart_record[df.NodeModulesBundleFilename.KEY] = constants.NODE_MODULES_WORKSPACE_BUNDLE_FILENAME
extra_deps = df.CustomDependencies.test_depends_only(unit, (), {})[df.CustomDependencies.KEY].split()
dart_record[df.CustomDependencies.KEY] = " ".join(sort_uniq(deps + extra_deps))
dart_record[df.TsConfigPath.KEY] = tsconfig_path
data = ytest.dump_test(unit, dart_record)
if data:
unit.set_property(["DART_DATA", data])
unit.set(["TEST_RECIPES_VALUE", user_recipes])
@_with_report_configure_error
def _setup_stylelint(unit: NotsUnitType) -> None:
if not _is_tests_enabled(unit):
return
if unit.get("_TS_STYLELINT_VALUE") == "no":
return
test_files = df.TestFiles.stylesheets(unit, (), {})[df.TestFiles.KEY]
if not test_files:
return
unit.on_peerdir_ts_resource("stylelint")
from lib.nots.package_manager import constants
recipes_value = unit.get("TEST_RECIPES_VALUE")
unit.on_setup_install_node_modules_recipe()
unit.on_setup_extract_output_tars_recipe([unit.get("MODDIR")])
test_type = TsTestType.TS_STYLELINT
peers = _create_pm(unit).get_peers_from_package_json()
deps = df.CustomDependencies.nots_with_recipies(unit, (peers,), {})[df.CustomDependencies.KEY].split()
if deps:
joined_deps = "\n".join(deps)
logger.info(f"{test_type} deps: \n{joined_deps}")
unit.ondepends(deps)
flat_args = (test_type,)
spec_args = dict(nm_bundle=constants.NODE_MODULES_WORKSPACE_BUNDLE_FILENAME)
dart_record = create_dart_record(
TS_TEST_FIELDS_BASE + TS_TEST_SPECIFIC_FIELDS[test_type], unit, flat_args, spec_args
)
extra_deps = df.CustomDependencies.test_depends_only(unit, (), {})[df.CustomDependencies.KEY].split()
dart_record[df.CustomDependencies.KEY] = " ".join(sort_uniq(deps + extra_deps))
data = ytest.dump_test(unit, dart_record)
if data:
unit.set_property(["DART_DATA", data])
unit.set(["TEST_RECIPES_VALUE", recipes_value])
def _resolve_module_files(unit: NotsUnitType, mod_dir: str, file_paths: list[str]) -> list[str]:
mod_dir_with_sep_len = len(mod_dir) + 1
resolved_files = []
for path in file_paths:
resolved = rootrel_arc_src(path, unit)
if resolved.startswith(mod_dir):
resolved = resolved[mod_dir_with_sep_len:]
resolved_files.append(resolved)
return resolved_files
def _set_resource_vars(
unit: NotsUnitType, erm_json: 'ErmJsonLite', tool: str, version: 'Version', nodejs_major: int = None
) -> None:
resource_name = erm_json.canonize_name(tool).upper()
# example: NODEJS_12_18_4 | HERMIONE_7_0_4_NODEJS_18
version_str = str(version).replace(".", "_")
yamake_resource_name = "{}_{}".format(resource_name, version_str)
if erm_json.is_resource_multiplatform(tool):
yamake_resource_name += "_NODEJS_{}".format(nodejs_major)
yamake_resource_var = "{}_RESOURCE_GLOBAL".format(yamake_resource_name)
unit.set(["{}_ROOT".format(resource_name), "${}".format(yamake_resource_var)])
unit.set(["{}-ROOT-VAR-NAME".format(resource_name), yamake_resource_var])
def _select_matching_version(
erm_json: 'ErmJsonLite', resource_name: str, range_str: str, dep_is_required=False
) -> 'Version':
if dep_is_required and range_str is None:
raise Exception(
"Please install the '{tool}' package to the project. Run the command:\n"
" ya tool nots add -D {tool}".format(tool=resource_name)
)
try:
version = erm_json.select_version_of(resource_name, range_str)
if version:
return version
raise ValueError("There is no allowed version to satisfy this range: '{}'".format(range_str))
except Exception as error:
toolchain_versions = erm_json.get_versions_of(erm_json.get_resource(resource_name))
raise Exception(
"Requested {} version range '{}' could not be satisfied. \n"
"Please use a range that would include one of the following: {}. \n"
"For further details please visit the link: {} \nOriginal error: {} \n".format(
resource_name,
range_str,
", ".join(map(str, toolchain_versions)),
"https://docs.yandex-team.ru/frontend-in-arcadia/_generated/toolchain",
str(error),
)
)
@_with_report_configure_error
def on_prepare_deps_configure(unit: NotsUnitType) -> None:
pm = _create_pm(unit)
pj = pm.load_package_json_from_dir(pm.sources_path)
has_deps = pj.has_dependencies()
ins, outs, resources = pm.calc_prepare_deps_inouts_and_resources(unit.get("_TARBALLS_STORE"), has_deps)
if has_deps:
unit.onpeerdir(pm.get_local_peers_from_package_json())
__set_append(unit, "_PREPARE_DEPS_INOUTS", _build_directives("input", ["hide"], sorted(ins)))
__set_append(unit, "_PREPARE_DEPS_INOUTS", _build_directives("output", ["hide"], sorted(outs)))
unit.set(["_PREPARE_DEPS_RESOURCES", " ".join([f'${{resource:"{uri}"}}' for uri in sorted(resources)])])
unit.set(["_PREPARE_DEPS_USE_RESOURCES_FLAG", "--resource-root $(RESOURCE_ROOT)"])
else:
__set_append(unit, "_PREPARE_DEPS_INOUTS", _build_directives("output", [], sorted(outs)))
unit.set(["_PREPARE_DEPS_CMD", "$_PREPARE_NO_DEPS_CMD"])
@_with_report_configure_error
def on_node_modules_configure(unit: NotsUnitType) -> None:
pm = _create_pm(unit)
pj = pm.load_package_json_from_dir(pm.sources_path)
if pj.has_dependencies():
unit.onpeerdir(pm.get_local_peers_from_package_json())
local_cli = unit.get("TS_LOCAL_CLI") == "yes"
ins, outs = pm.calc_node_modules_inouts(local_cli)
__set_append(unit, "_NODE_MODULES_INOUTS", _build_directives("input", ["hide"], sorted(ins)))
if not unit.get("TS_TEST_FOR"):
__set_append(unit, "_NODE_MODULES_INOUTS", _build_directives("output", ["hide"], sorted(outs)))
if pj.get_use_prebuilder():
unit.on_peerdir_ts_resource("@yatool/prebuilder")
unit.set(
[
"_YATOOL_PREBUILDER_ARG",
"--yatool-prebuilder-path $YATOOL_PREBUILDER_ROOT/node_modules/@yatool/prebuilder",
]
)
# YATOOL_PREBUILDER_0_7_0_RESOURCE_GLOBAL
prebuilder_major = unit.get("YATOOL_PREBUILDER-ROOT-VAR-NAME").split("_")[2]
logger.info(f"Detected prebuilder {COLORS.green}{prebuilder_major}.x.x{COLORS.reset}")
if prebuilder_major == "0":
# TODO: FBP-1408
lf = pm.load_lockfile_from_dir(pm.sources_path)
is_valid, invalid_keys = lf.validate_has_addons_flags()
if not is_valid:
ymake.report_configure_error(
"Project is configured to use @yatool/prebuilder. \n"
+ "Some packages in the pnpm-lock.yaml are misconfigured.\n"
+ "Run {COLORS.green}`ya tool nots update-lockfile`{COLORS.reset} to fix lockfile.\n"
+ "All packages with `requiresBuild:true` have to be marked with `hasAddons:true/false`.\n"
+ "Misconfigured keys: \n"
+ " - "
+ "\n - ".join(invalid_keys)
)
else:
lf = pm.load_lockfile_from_dir(pm.sources_path)
requires_build_packages = lf.get_requires_build_packages()
is_valid, validation_messages = pj.validate_prebuilds(requires_build_packages)
if not is_valid:
ymake.report_configure_error(
"Project is configured to use @yatool/prebuilder. \n"
+ "Some packages are misconfigured.\n"
+ "Run {COLORS.green}`ya tool nots update-lockfile`{COLORS.reset} to fix pnpm-lock.yaml and package.json.\n"
+ "Validation details: \n"
+ "\n".join(validation_messages)
)
@_with_report_configure_error
def on_ts_test_for_configure(
unit: NotsUnitType, test_runner: TsTestType, default_config: str, node_modules_filename: str
) -> None:
if not _is_tests_enabled(unit):
return
if unit.enabled('TS_COVERAGE'):
unit.on_peerdir_ts_resource("nyc")
for_mod_path = df.TsTestForPath.value(unit, (), {})[df.TsTestForPath.KEY]
unit.onpeerdir([for_mod_path])
unit.on_setup_extract_node_modules_recipe([for_mod_path])
unit.on_setup_extract_output_tars_recipe([for_mod_path])
build_root = "$B" if test_runner in [TsTestType.HERMIONE, TsTestType.PLAYWRIGHT_LARGE] else "$(BUILD_ROOT)"
unit.set(["TS_TEST_NM", os.path.join(build_root, for_mod_path, node_modules_filename)])
config_path = unit.get("TS_TEST_CONFIG_PATH")
if not config_path:
config_path = os.path.join(for_mod_path, default_config)
unit.set(["TS_TEST_CONFIG_PATH", config_path])
test_files = df.TestFiles.ts_test_srcs(unit, (), {})[df.TestFiles.KEY]
if not test_files:
ymake.report_configure_error("No tests found")
return
from lib.nots.package_manager import constants
peers = _create_pm(unit).get_peers_from_package_json()
deps = df.CustomDependencies.nots_with_recipies(unit, (peers,), {})[df.CustomDependencies.KEY].split()
if deps:
joined_deps = "\n".join(deps)
logger.info(f"{test_runner} deps: \n{joined_deps}")
unit.ondepends(deps)
flat_args = (test_runner, "TS_TEST_FOR_PATH")
spec_args = {'erm_json': _create_erm_json(unit)}
dart_record = create_dart_record(
TS_TEST_FIELDS_BASE + TS_TEST_SPECIFIC_FIELDS[test_runner],
unit,
flat_args,
spec_args,
)
dart_record[df.TestFiles.KEY] = test_files
dart_record[df.NodeModulesBundleFilename.KEY] = constants.NODE_MODULES_WORKSPACE_BUNDLE_FILENAME
extra_deps = df.CustomDependencies.test_depends_only(unit, (), {})[df.CustomDependencies.KEY].split()
dart_record[df.CustomDependencies.KEY] = " ".join(sort_uniq(deps + extra_deps))
if test_runner in [TsTestType.HERMIONE, TsTestType.PLAYWRIGHT_LARGE]:
dart_record[df.Size.KEY] = "LARGE"
data = ytest.dump_test(unit, dart_record)
if data:
unit.set_property(["DART_DATA", data])
# noinspection PyUnusedLocal
@_with_report_configure_error
def on_validate_ts_test_for_args(unit: NotsUnitType, for_mod: str, root: str) -> None:
# FBP-1085
is_arc_root = root == "${ARCADIA_ROOT}"
is_rel_for_mod = for_mod.startswith(".")
if is_arc_root and is_rel_for_mod:
ymake.report_configure_error(
"You are using a relative path for a module. "
+ "You have to add RELATIVE key, like (RELATIVE {})".format(for_mod)
)
@_with_report_configure_error
def on_set_ts_test_for_vars(unit: NotsUnitType, for_mod: str) -> None:
unit.set(["TS_TEST_FOR", "yes"])
unit.set(["TS_TEST_FOR_DIR", unit.resolve_arc_path(for_mod)])
unit.set(["TS_TEST_FOR_PATH", rootrel_arc_src(for_mod, unit)])
@_with_report_configure_error
def on_ts_files(unit: NotsUnitType, *files: str) -> None:
new_cmds = ['$COPY_CMD ${{input;context=TEXT:"{0}"}} ${{output;noauto:"{0}"}}'.format(f) for f in files]
all_cmds = unit.get("_TS_FILES_COPY_CMD")
if all_cmds:
new_cmds.insert(0, all_cmds)
unit.set(["_TS_FILES_COPY_CMD", " && ".join(new_cmds)])
@_with_report_configure_error
def on_ts_large_files(unit: NotsUnitType, destination: str, *files: list[str]) -> None:
if destination == REQUIRED_MISSING:
ymake.report_configure_error(
"Macro TS_LARGE_FILES() requires to use DESTINATION parameter.\n"
" TS_LARGE_FILES(\n"
" DESTINATION some_dir\n"
" large/file1\n"
" large/file2\n"
" )\n"
"Docs: https://docs.yandex-team.ru/frontend-in-arcadia/references/TS_PACKAGE#ts-large-files."
)
return
# TODO: FBP-1795
# ${BINDIR} prefix for input is important to resolve to result of LARGE_FILES and not to SOURCEDIR
new_cmds = [
'$COPY_CMD ${{input;context=TEXT:"${{BINDIR}}/{0}"}} ${{output;noauto:"{1}/{0}"}}'.format(f, destination)
for f in files
]
all_cmds = unit.get("_TS_FILES_COPY_CMD")
if all_cmds:
new_cmds.insert(0, all_cmds)
unit.set(["_TS_FILES_COPY_CMD", " && ".join(new_cmds)])
@_with_report_configure_error
def on_ts_package_check_files(unit: NotsUnitType) -> None:
ts_files = unit.get("_TS_FILES_COPY_CMD")
if ts_files == "":
ymake.report_configure_error(
"\n"
"In the TS_PACKAGE module, you should define at least one file using the TS_FILES() macro.\n"
"If you use the TS_FILES_GLOB, check the expression. For example, use `src/**/*` instead of `src/*`.\n"
"Docs: https://docs.yandex-team.ru/frontend-in-arcadia/references/TS_PACKAGE#ts-files."
)
@_with_report_configure_error
def on_depends_on_mod(unit: NotsUnitType) -> None:
if unit.get("_TS_TEST_DEPENDS_ON_BUILD"):
for_mod_path = unit.get("TS_TEST_FOR_PATH")
unit.ondepends([for_mod_path])
|