Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(pacmak): generated dependencies are not consistent with source npm module #1141

Merged
merged 8 commits into from
Dec 27, 2019
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 20 additions & 32 deletions packages/@jsii/spec/lib/assembly.ts
Original file line number Diff line number Diff line change
@@ -3,7 +3,7 @@ export const SPEC_FILE_NAME = '.jsii';
/**
* A JSII assembly specification.
*/
export interface Assembly extends Documentable {
export interface Assembly extends AssemblyConfiguration, Documentable {
/**
* The version of the spec schema
*/
@@ -88,14 +88,6 @@ export interface Assembly extends Documentable {
*/
license: string;

/**
* A map of target name to configuration, which is used when generating
* packages for various languages.
*
* @default none
*/
targets?: AssemblyTargets;

/**
* Arbitrary key-value pairs of metadata, which the maintainer chose to
* document with the assembly. These entries do not carry normative
@@ -115,18 +107,20 @@ export interface Assembly extends Documentable {

/**
* Direct dependencies on other assemblies (with semver), the key is the JSII
* assembly name.
* assembly name, and the value is a SemVer expression..
*
* @default none
*/
dependencies?: { [assembly: string]: PackageVersion };
dependencies?: { [assembly: string]: string };

/**
* Closure of all dependency assemblies, direct and transitive.
* Target configuration for all the assemblies that are direct or transitive
* dependencies of this assembly. This is needed to generate correct native
* type names for any transitively inherited member, in certain languages.
*
* @default none
*/
dependencyClosure?: { [assembly: string]: PackageVersion };
dependencyClosure?: { [assembly: string]: AssemblyConfiguration };

/**
* List if bundled dependencies (these are not expected to be jsii
@@ -151,6 +145,19 @@ export interface Assembly extends Documentable {
readme?: { markdown: string };
}

/**
* Shareable configuration of a jsii Assembly.
*/
export interface AssemblyConfiguration {
/**
* A map of target name to configuration, which is used when generating
* packages for various languages.
*
* @default none
*/
targets?: AssemblyTargets;
rix0rrr marked this conversation as resolved.
Show resolved Hide resolved
}

/**
* Versions of the JSII Assembly Specification.
*/
@@ -214,25 +221,6 @@ export interface AssemblyTargets {
[language: string]: { [key: string]: any } | undefined;
}

/**
* The version of a package.
*/
export interface PackageVersion {
/**
* Version of the package.
*
* @minLength 1
*/
version: string;

/**
* Targets for a given assembly.
*
* @default none
*/
targets?: AssemblyTargets;
}

/**
* Where in the module source the definition for this API item was found
*/
2 changes: 1 addition & 1 deletion packages/@jsii/spec/lib/index.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
export * from './assembly';
export * from './configuration';
export * from './name-tree';
export * from './validate-assembly';
export * from './configuration';
4 changes: 2 additions & 2 deletions packages/@scope/jsii-calc-base/package.json
Original file line number Diff line number Diff line change
@@ -29,10 +29,10 @@
"test:update": "npm run build && UPDATE_DIFF=1 npm run test"
},
"dependencies": {
"@scope/jsii-calc-base-of-base": "^0.20.11"
"@scope/jsii-calc-base-of-base": "0.20.11"
},
"peerDependencies": {
"@scope/jsii-calc-base-of-base": "^0.20.11"
"@scope/jsii-calc-base-of-base": "0.20.11"
},
"devDependencies": {
"@types/node": "^10.17.11",
29 changes: 3 additions & 26 deletions packages/@scope/jsii-calc-base/test/assembly.jsii
Original file line number Diff line number Diff line change
@@ -8,29 +8,7 @@
"url": "https://aws.amazon.com"
},
"dependencies": {
"@scope/jsii-calc-base-of-base": {
"targets": {
"dotnet": {
"namespace": "Amazon.JSII.Tests.CalculatorNamespace.BaseOfBaseNamespace",
"packageId": "Amazon.JSII.Tests.CalculatorPackageId.BaseOfBasePackageId"
},
"java": {
"maven": {
"artifactId": "calculator-base-of-base",
"groupId": "software.amazon.jsii.tests"
},
"package": "software.amazon.jsii.tests.calculator.baseofbase"
},
"js": {
"npm": "@scope/jsii-calc-base-of-base"
},
"python": {
"distName": "scope.jsii-calc-base-of-base",
"module": "scope.jsii_calc_base_of_base"
}
},
"version": "0.20.11"
}
"@scope/jsii-calc-base-of-base": "0.20.11"
},
"dependencyClosure": {
"@scope/jsii-calc-base-of-base": {
@@ -53,8 +31,7 @@
"distName": "scope.jsii-calc-base-of-base",
"module": "scope.jsii_calc_base_of_base"
}
},
"version": "0.20.11"
}
}
},
"description": "An example direct dependency for jsii-calc.",
@@ -174,5 +151,5 @@
}
},
"version": "0.20.11",
"fingerprint": "lSQlk5mMPd7fxaZoCdCekSFY4rDOAu3VnLuIcFUXA6o="
"fingerprint": "vaUHiWCfpSsCfXz18WPVQ3HhCBTPj23pDky4IqmEWxw="
}
32 changes: 4 additions & 28 deletions packages/@scope/jsii-calc-lib/test/assembly.jsii
Original file line number Diff line number Diff line change
@@ -8,29 +8,7 @@
"url": "https://aws.amazon.com"
},
"dependencies": {
"@scope/jsii-calc-base": {
"targets": {
"dotnet": {
"namespace": "Amazon.JSII.Tests.CalculatorNamespace.BaseNamespace",
"packageId": "Amazon.JSII.Tests.CalculatorPackageId.BasePackageId"
},
"java": {
"maven": {
"artifactId": "calculator-base",
"groupId": "software.amazon.jsii.tests"
},
"package": "software.amazon.jsii.tests.calculator.base"
},
"js": {
"npm": "@scope/jsii-calc-base"
},
"python": {
"distName": "scope.jsii-calc-base",
"module": "scope.jsii_calc_base"
}
},
"version": "0.20.11"
}
"@scope/jsii-calc-base": "^0.20.11"
},
"dependencyClosure": {
"@scope/jsii-calc-base": {
@@ -53,8 +31,7 @@
"distName": "scope.jsii-calc-base",
"module": "scope.jsii_calc_base"
}
},
"version": "0.20.11"
}
},
"@scope/jsii-calc-base-of-base": {
"targets": {
@@ -76,8 +53,7 @@
"distName": "scope.jsii-calc-base-of-base",
"module": "scope.jsii_calc_base_of_base"
}
},
"version": "0.20.11"
}
}
},
"description": "A simple calcuator library built on JSII.",
@@ -539,5 +515,5 @@
}
},
"version": "0.20.11",
"fingerprint": "D1VJJVqcvEKInLQ3r/WxIN332Yo1IRlVWkCPByyIIb0="
"fingerprint": "c16s32RYOhQkY/FmEPgjMN+m4/lpF3Rj5a9nsUQpf6Q="
}
85 changes: 7 additions & 78 deletions packages/jsii-calc/test/assembly.jsii
Original file line number Diff line number Diff line change
@@ -34,77 +34,9 @@
}
],
"dependencies": {
"@scope/jsii-calc-base": {
"targets": {
"dotnet": {
"namespace": "Amazon.JSII.Tests.CalculatorNamespace.BaseNamespace",
"packageId": "Amazon.JSII.Tests.CalculatorPackageId.BasePackageId"
},
"java": {
"maven": {
"artifactId": "calculator-base",
"groupId": "software.amazon.jsii.tests"
},
"package": "software.amazon.jsii.tests.calculator.base"
},
"js": {
"npm": "@scope/jsii-calc-base"
},
"python": {
"distName": "scope.jsii-calc-base",
"module": "scope.jsii_calc_base"
}
},
"version": "0.20.11"
},
"@scope/jsii-calc-base-of-base": {
"targets": {
"dotnet": {
"namespace": "Amazon.JSII.Tests.CalculatorNamespace.BaseOfBaseNamespace",
"packageId": "Amazon.JSII.Tests.CalculatorPackageId.BaseOfBasePackageId"
},
"java": {
"maven": {
"artifactId": "calculator-base-of-base",
"groupId": "software.amazon.jsii.tests"
},
"package": "software.amazon.jsii.tests.calculator.baseofbase"
},
"js": {
"npm": "@scope/jsii-calc-base-of-base"
},
"python": {
"distName": "scope.jsii-calc-base-of-base",
"module": "scope.jsii_calc_base_of_base"
}
},
"version": "0.20.11"
},
"@scope/jsii-calc-lib": {
"targets": {
"dotnet": {
"namespace": "Amazon.JSII.Tests.CalculatorNamespace.LibNamespace",
"packageId": "Amazon.JSII.Tests.CalculatorPackageId.LibPackageId",
"versionSuffix": "-devpreview"
},
"java": {
"maven": {
"artifactId": "calculator-lib",
"groupId": "software.amazon.jsii.tests",
"versionSuffix": ".DEVPREVIEW"
},
"package": "software.amazon.jsii.tests.calculator.lib"
},
"js": {
"npm": "@scope/jsii-calc-lib"
},
"python": {
"distName": "scope.jsii-calc-lib",
"module": "scope.jsii_calc_lib"
}
},
"version": "0.20.11"
}
"@scope/jsii-calc-base": "^0.20.11",
"@scope/jsii-calc-base-of-base": "^0.20.11",
"@scope/jsii-calc-lib": "^0.20.11"
},
"dependencyClosure": {
"@scope/jsii-calc-base": {
@@ -127,8 +59,7 @@
"distName": "scope.jsii-calc-base",
"module": "scope.jsii_calc_base"
}
},
"version": "0.20.11"
}
},
"@scope/jsii-calc-base-of-base": {
"targets": {
@@ -150,8 +81,7 @@
"distName": "scope.jsii-calc-base-of-base",
"module": "scope.jsii_calc_base_of_base"
}
},
"version": "0.20.11"
}
},
"@scope/jsii-calc-lib": {
"targets": {
@@ -175,8 +105,7 @@
"distName": "scope.jsii-calc-lib",
"module": "scope.jsii_calc_lib"
}
},
"version": "0.20.11"
}
}
},
"description": "A simple calcuator built on JSII.",
@@ -12002,5 +11931,5 @@
}
},
"version": "0.20.11",
"fingerprint": "eenqZx1+dNMvfZCY02AIrinXeK98iQC4XLLj0yPIXuM="
"fingerprint": "JMTWeMHDPnC/01VAtTulHbaZ1mSgip2tVym5dlwrBZE="
}
4 changes: 2 additions & 2 deletions packages/jsii-pacmak/lib/generator.ts
Original file line number Diff line number Diff line change
@@ -502,7 +502,7 @@ export abstract class Generator implements IGenerator {
* Looks up a jsii module in the dependency tree.
* @param name The name of the jsii module to look up
*/
protected findModule(name: string): spec.PackageVersion {
protected findModule(name: string): spec.AssemblyConfiguration {

// if this is the current module, return it
if (this.assembly.name === name) {
@@ -515,7 +515,7 @@ export abstract class Generator implements IGenerator {
return found;
}

throw new Error(`Unable to find module ${name} as a direct or indirect dependency of ${this.assembly.name}`);
throw new Error(`Unable to find module ${name} as a dependency of ${this.assembly.name}`);
}

protected findType(fqn: string): spec.Type {
17 changes: 17 additions & 0 deletions packages/jsii-pacmak/lib/targets/dotnet/dotnetgenerator.ts
Original file line number Diff line number Diff line change
@@ -76,13 +76,30 @@ export class DotNetGenerator extends Generator {
await fs.mkdirp(path.join(outdir, packageId));
await fs.copyFile(tarball, path.join(outdir, packageId, tarballFileName));

// Create an anchor file for the current model
this.generateDependencyAnchorFile();

// Copying the .jsii file
await fs.copyFile(this.jsiiFilePath, path.join(outdir, packageId, spec.SPEC_FILE_NAME));

// Saving the generated code.
return this.code.save(outdir);
}

/**
* Generates the anchor file
*/
protected generateDependencyAnchorFile() {
const namespace = `${this.assembly.targets!.dotnet!.namespace}.Internal.DependencyResolution`;
this.openFileIfNeeded('Anchor', namespace, false, false);
this.code.openBlock('public sealed class Anchor');
this.code.openBlock('public Anchor()');
this.typeresolver.namespaceDependencies.forEach(value => this.code.line(`new ${value.namespace}.Internal.DependencyResolution.Anchor();`));
this.code.closeBlock();
this.code.closeBlock();
this.closeFileIfNeeded('Anchor', namespace, false);
}

/**
* Not used as we override the save() method
*/
Loading