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: require distinct argument and property names #272

Merged
merged 2 commits into from
Oct 23, 2018
Merged
Show file tree
Hide file tree
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
81 changes: 79 additions & 2 deletions packages/jsii/lib/assembler.ts
Original file line number Diff line number Diff line change
Expand Up @@ -190,7 +190,7 @@ export class Assembler implements Emitter {
*
* @returns the de-referenced type, if it was found, otherwise ``undefined``.
*/
private _dereference(ref: spec.NamedTypeReference, referencingNode: ts.Node): spec.Type | undefined {
private _dereference(ref: spec.NamedTypeReference, referencingNode: ts.Node | null): spec.Type | undefined {
const [assm, ] = ref.fqn.split('.');
let type;
if (assm === this.projectInfo.name) {
Expand Down Expand Up @@ -601,11 +601,13 @@ export class Assembler implements Emitter {
this._diagnostic(declaration, ts.DiagnosticCategory.Error, `Unable to compute signature for ${type.fqn}#${symbol.name}`);
return;
}
const parameters = await Promise.all(signature.getParameters().map(p => this._toParameter(p)));

const returnType = signature.getReturnType();
const method: spec.Method = {
abstract: _isAbstract(symbol, type),
name: symbol.name,
parameters: await Promise.all(signature.getParameters().map(p => this._toParameter(p))),
parameters,
protected: _isProtected(symbol),
returns: _isVoid(returnType) ? undefined : await this._typeReference(returnType, declaration),
static: _isStatic(symbol),
Expand All @@ -614,6 +616,29 @@ export class Assembler implements Emitter {

this._visitDocumentation(symbol, method);

// If the last parameter is a datatype, verify that it does not share any field names with
// other function arguments, so that it can be turned into keyword arguments by jsii frontends
// that support such.
const lastParamTypeRef = apply(last(parameters), x => x.type);
const lastParamSymbol = last(signature.getParameters());
if (lastParamTypeRef && spec.isNamedTypeReference(lastParamTypeRef)) {
this._deferUntilTypesAvailable(symbol.name, [lastParamTypeRef], lastParamSymbol!.declarations[0], (lastParamType) => {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am worried about this programming model. I really liked your idea of phases as a safer and more deterministic alternative.

if (!spec.isInterfaceType(lastParamType) || !lastParamType.datatype) { return; }

// Liftable datatype, make sure no parameter names match any of the properties in the datatype
const propNames = this.allProperties(lastParamType);
const paramNames = new Set(parameters.slice(0, parameters.length - 1).map(x => x.name));
const sharedNames = intersection(propNames, paramNames);

if (sharedNames.size > 0) {
this._diagnostic(
declaration,
ts.DiagnosticCategory.Error,
`Name occurs in both function arguments and in datatype properties, rename one: ${Array.from(sharedNames).join(', ')}`);
}
});
}

type.methods = type.methods || [];
type.methods.push(method);
}
Expand Down Expand Up @@ -853,6 +878,31 @@ export class Assembler implements Emitter {
def.dependedFqns = def.dependedFqns.filter(fqns.has.bind(fqns));
}
}

/**
* Return the set of all (inherited) properties of an interface
*/
private allProperties(root: spec.InterfaceType): Set<string> {
const self = this;

const ret = new Set<string>();
recurse(root);
return ret;

function recurse(int: spec.InterfaceType) {
for (const property of int.properties || []) {
ret.add(property.name);
}

for (const baseRef of int.interfaces || []) {
const base = self._dereference(baseRef, null);
if (!base) { throw new Error('Impossible to have unresolvable base in allProperties()'); }
if (!spec.isInterfaceType(base)) { throw new Error('Impossible to have non-interface base in allProperties()'); }

recurse(base);
}
}
}
}

/**
Expand Down Expand Up @@ -1008,4 +1058,31 @@ interface DeferredRecord {
* Callback representing the action to run.
*/
cb: () => void;
}

/**
* Return the last element from a list
*/
function last<T>(xs: T[]): T | undefined {
return xs.length > 0 ? xs[xs.length - 1] : undefined;
}

/**
* Apply a function to a value if it's not equal to undefined
*/
function apply<T, U>(x: T | undefined, fn: (x: T) => U | undefined): U | undefined {
return x !== undefined ? fn(x) : undefined;
}

/**
* Return the intersection of two sets
*/
function intersection<T>(xs: Set<T>, ys: Set<T>): Set<T> {
const ret = new Set<T>();
for (const x of xs) {
if (ys.has(x)) {
ret.add(x);
}
}
return ret;
}
15 changes: 15 additions & 0 deletions packages/jsii/test/negatives/neg.mix-datatype-and-arg-name.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
///!MATCH_ERROR: Name occurs in both function arguments and in datatype properties, rename one: dontWorry

export interface Lyrics {
dontWorry: string;
beHappy: string;
}

export class MyClass {
// Can't have an argument name 'dontWorry' if the last parameter is a datatype
// which also has a field 'dontWorry'--that will give errors if the datatype
// argument fields are lifted to keyword arguments.
public dance(dontWorry: string, lyrics: Lyrics) {
return `${dontWorry}: ${lyrics.beHappy}`;
}
}