feat: allow configuring jsii namespaces for files-as-submodules (in addition to directories) (#2407)

When a submodule is created, it needs to have a namespace assigned for each target language (e.g. `My.Library.SubmoduleName`, `my_library.submodule_name`, etc).. Those names are usually derived, but can be configured explicitly via a `.jsiirc.json` file. We already used to look for `.jsiirc.json` in the same directory to read the jsii language namespaces for the classes in the subdirectories, but this was intended for use only when a *directory* is exported as a submodule. It starts to conflict when multiple source files in the same directory are exported as submodules: they would all share the same `.jsiirc.json` file, but that would mean they all share the same submodule namespaces which is nonsenical. Consider: ``` - root.ts export * as submodule from './submodule'; - submodule +-- index.ts export * as subsubmodule from './subsubmodule'; +-- subsubmodule.ts +-- .jsiirc.json // <-- gets used for both submodules! ``` In this PR, we make it so the directory-level `.jsiirc.json` is only read if the exported file is `index.ts`. This works both when the directory is exported, as well as if the file is directly exported. Otherwise, for files-as-submodules, read the jsii config from `.<file-base-name>.jsiirc.json`. This also adds a validation for multiple submodules not accidentally sharing the same Python module name (or Go, or Java, ...), which did in fact happen for us but doesn't make sense and should be caught. --- By submitting this pull request, I confirm that my contribution is made under the terms of the [Apache 2.0 license]. [Apache 2.0 license]: https://www.apache.org/licenses/LICENSE-2.0

Author: rix0rrr

src/assembler.ts

@@ -17,7 +17,7 @@ import { normalizeConfigPath } from './helpers';
 import { JsiiDiagnostic } from './jsii-diagnostic';
 import * as literate from './literate';
 import * as bindings from './node-bindings';
-import { ProjectInfo } from './project-info';
+import { AssemblyTargets, ProjectInfo } from './project-info';
 import { isReservedName } from './reserved-words';
 import { Sets } from './sets';
 import { DeprecatedRemover } from './transforms/deprecated-remover';
@@ -181,6 +181,8 @@ export class Assembler implements Emitter {
 
  this.validateTypesAgainstPositions();
 
+ this.validateSubmoduleConfigs();
+
  // Skip emitting if any diagnostic message is an error
  if (this._diagnostics.find((diag) => diag.category === ts.DiagnosticCategory.Error) != null) {
  LOG.debug('Skipping emit due to errors.');
@@ -705,8 +707,17 @@ export class Assembler implements Emitter {
  }
 
  function loadSubmoduleTargetConfig(submoduleMain: string): SubmoduleSpec['targets'] {
- const jsiirc = path.resolve(submoduleMain, '..', '.jsiirc.json');
- if (!fs.existsSync(jsiirc)) {
+ const dirname = path.dirname(submoduleMain);
+ const basenameWithoutExtension = path.basename(submoduleMain).replace(/\.ts$/, '');
+
+ let jsiirc;
+ if (basenameWithoutExtension === 'index') {
+ jsiirc = path.resolve(submoduleMain, '..', '.jsiirc.json');
+ } else {
+ jsiirc = path.resolve(dirname, `.${basenameWithoutExtension}.jsiirc.json`);
+ }
+
+ if (!jsiirc || !fs.existsSync(jsiirc)) {
  return undefined;
  }
  const data = JSON.parse(fs.readFileSync(jsiirc, 'utf-8'));
@@ -2749,6 +2760,56 @@ export class Assembler implements Emitter {
  });
  }
  }
+
+ /**
+ * Make sure that no 2 submodules are emitting into the same target namespaces
+ */
+ private validateSubmoduleConfigs() {
+ const self = this;
+ const dotNetnamespaces: Record<string, string[]> = {};
+ const javaPackages: Record<string, string[]> = {};
+ const pythonModules: Record<string, string[]> = {};
+ const goPackages: Record<string, string[]> = {};
+
+ for (const submodule of this._submodules.values()) {
+ const targets = submodule.targets as AssemblyTargets | undefined;
+
+ if (targets?.dotnet?.namespace) {
+ accumList(dotNetnamespaces, targets.dotnet.namespace, submodule.fqn);
+ }
+ if (targets?.java?.package) {
+ accumList(javaPackages, targets.java.package, submodule.fqn);
+ }
+ if (targets?.python?.module) {
+ accumList(pythonModules, targets.python.module, submodule.fqn);
+ }
+ if (targets?.go?.packageName) {
+ accumList(goPackages, targets.go.packageName, submodule.fqn);
+ }
+ }
+
+ maybeError('dotnet', dotNetnamespaces);
+ maybeError('java', javaPackages);
+ maybeError('python', pythonModules);
+ maybeError('go', goPackages);
+
+ function accumList(set: Record<string, string[]>, key: string, value: string) {
+ if (!set[key]) {
+ set[key] = [];
+ }
+ set[key].push(value);
+ }
+
+ function maybeError(language: string, set: Record<string, string[]>) {
+ for (const [namespace, modules] of Object.entries(set)) {
+ if (modules.length > 1) {
+ self._diagnostics.push(
+ JsiiDiagnostic.JSII_4010_SUBMODULE_NAMESPACE_CONFLICT.create(undefined, language, namespace, modules),
+ );
+ }
+ }
+ }
+ }
 }
 
 export interface AssemblerOptions {

src/jsii-diagnostic.ts

@@ -479,6 +479,13 @@ export class JsiiDiagnostic implements ts.Diagnostic {
  name: 'typescript-config/disabled-tsconfig-validation',
  });
 
+ public static readonly JSII_4010_SUBMODULE_NAMESPACE_CONFLICT = Code.warning({
+ code: 4010,
+ formatter: (language: string, namespace: string, modules: string[]) =>
+ `Multiple modules emit to the same ${language} namespace "${namespace}": ${modules.join(', ')}`,
+ name: 'jsii-config/submodule-conflict',
+ });
+
  //////////////////////////////////////////////////////////////////////////////
  // 5000 => 5999 -- LANGUAGE COMPATIBILITY ERRORS
 

test/submodules.test.ts

@@ -55,6 +55,26 @@ test('submodules loaded from directories can have targets', () => {
  );
 });
 
+test('submodules loaded from files can have targets', () => {
+ const assembly = sourceToAssemblyHelper({
+ 'index.ts': 'export * as submodule from "./subfile"',
+ 'subfile.ts': 'export class Foo { }',
+ '.subfile.jsiirc.json': JSON.stringify({
+ targets: {
+ python: 'fun',
+ },
+ }),
+ });
+
+ expect(assembly.submodules!['testpkg.submodule']).toEqual(
+ expect.objectContaining({
+ targets: {
+ python: 'fun',
+ },
+ }),
+ );
+});
+
 test('submodule READMEs can have literate source references', () => {
  const assembly = sourceToAssemblyHelper({
  'index.ts': 'export * as submodule from "./subdir"',