feat: validate submodule target configurations (backport #2415) #2418
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Extends the target configuration validation from #2398 to also validate `.jsiirc.json` files used for submodule-specific target configurations. Additionally enhances validation to ensure target configurations are well-formed objects with only valid keys for each language. ## Why Submodules can have their own target configurations via `.jsiirc.json` files (for directory-based submodules) or `.<filename>.jsiirc.json` files (for file-based submodules). These configurations were not being validated, allowing invalid configurations to slip through until code generation time. This PR ensures configuration errors are caught early during compilation with clear error messages, rather than failing later during package generation. ## Changes * Exports `validateTargets` function from `project-info.ts` for reuse * Calls `validateTargets` when loading `.jsiirc.json` files in `assembler.ts` * Adds comprehensive validation for target configuration structure * Adds 21 new tests covering: - File-based `.jsiirc.json` validation (e.g., `.subfile.jsiirc.json`) - Namespace conflict detection across all target languages - Target configuration structure validation - Unknown language and key detection ## Validation Rules ### Identifier Validation Target language package names must contain only valid identifier characters: * **Go**: `packageName` must be a valid identifier * **.NET**: `namespace` parts (split by `.`) must be valid identifiers * **Java**: `package` parts (split by `.`) must be valid identifiers * **Python**: `module` parts (split by `.`) must be valid identifiers An identifier is defined as matching the regex: `/^[\w_][\w\d_]*$/u` ### Structure Validation * Target language entries must be objects (not strings or primitives) * Only known target languages are allowed: `java`, `python`, `dotnet`, `go` * Only valid configuration keys are allowed for each language: - **Java**: `package`, `maven`, `versionSuffix` - **Python**: `module`, `distName`, `classifiers` - **.NET**: `namespace`, `packageId`, `iconUrl`, `versionSuffix` - **Go**: `moduleName`, `packageName`, `versionSuffix` ### Namespace Conflict Detection Warns when multiple submodules emit to the same target language namespace, which would cause conflicts during code generation. --- By submitting this pull request, I confirm that my contribution is made under the terms of the [Apache 2.0 license](https://www.apache.org/licenses/LICENSE-2.0). --------- Signed-off-by: github-actions <github-actions@github.com> Co-authored-by: github-actions <github-actions@github.com> (cherry picked from commit 558c3ee)
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Backport
This will backport the following commits from
maintomaintenance/v5.8:Questions ?
Please refer to the Backport tool documentation