-
Notifications
You must be signed in to change notification settings - Fork 242
/
submodules.test.ts
321 lines (288 loc) · 9.27 KB
/
submodules.test.ts
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
import * as spec from '@jsii/spec';
import * as fs from 'fs-extra';
import * as path from 'path';
import {
sourceToAssemblyHelper,
TestWorkspace,
compileJsiiForTest,
} from '../lib';
test('submodules loaded from directories can have a README', async () => {
const assembly = await sourceToAssemblyHelper({
'index.ts': 'export * as submodule from "./subdir"',
'subdir/index.ts': 'export class Foo { }',
'subdir/README.md': 'This is the README',
});
expect(assembly.submodules!['testpkg.submodule']).toEqual(
expect.objectContaining({
readme: {
markdown: 'This is the README',
},
}),
);
});
test('submodules loaded from files can have a README', async () => {
const assembly = await sourceToAssemblyHelper({
'index.ts': 'export * as submodule from "./submod"',
'submod.ts': 'export class Foo { }',
'submod.README.md': 'This is the README',
});
expect(assembly.submodules!['testpkg.submodule']).toEqual(
expect.objectContaining({
readme: {
markdown: 'This is the README',
},
}),
);
});
test('submodules loaded from directories can have targets', async () => {
const assembly = await sourceToAssemblyHelper({
'index.ts': 'export * as submodule from "./subdir"',
'subdir/index.ts': 'export class Foo { }',
'subdir/.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', async () => {
const assembly = await sourceToAssemblyHelper({
'index.ts': 'export * as submodule from "./subdir"',
'subdir/index.ts': 'export class Foo { }',
'subdir/README.md':
'This is the README\n\n[includable](./test/includeme.lit.ts)',
'subdir/test/includeme.lit.ts': '// Include me',
});
expect(assembly.submodules!['testpkg.submodule']).toEqual(
expect.objectContaining({
readme: {
markdown: [
'This is the README',
'',
'```ts lit=subdir/test/includeme.lit.ts',
'// Include me',
'```',
].join('\n'),
},
}),
);
});
type ImportStyle = 'directly' | 'as namespace' | 'with alias';
test.each(['directly', 'as namespace', 'with alias'] as ImportStyle[])(
'can reference submodule types, importing %s',
(importStyle) =>
TestWorkspace.withWorkspace(async (ws) => {
// There are 2 import styles:
//
// import { submodule } from 'lib';
// import * as submodule from 'lib/submodule';
//
// We need to support both import styles.
// Dependency that exports a submodule
await ws.addDependency(await makeDependencyWithSubmodule());
let importStatement;
let prefix;
switch (importStyle) {
case 'directly':
importStatement =
"import { Foo, FooInterface, IProtocol } from 'testpkg/subdir'";
prefix = '';
break;
case 'as namespace':
importStatement = "import { submodule } from 'testpkg'";
prefix = 'submodule.';
break;
case 'with alias':
importStatement = "import { submodule as sub } from 'testpkg'";
prefix = 'sub.';
break;
}
// Main library that imports the submodule class directly
// Use the type in all possible positions
const result = await compileJsiiForTest(
{
'index.ts': `
${importStatement};
export interface BarProps {
readonly foo?: ${prefix}Foo;
}
export class Bar {
constructor(public readonly foo: ${prefix}Foo, props: BarProps = {}) {
Array.isArray(props);
}
public returnValue(): ${prefix}Foo {
return new ${prefix}Foo();
}
}
export class SubFoo extends ${prefix}Foo {}
export interface SubInterface extends ${prefix}FooInterface {}
export class Implementor implements ${prefix}IProtocol {}
`,
},
{
packageJson: {
// Must be a different name from the dependency
name: 'consumerpkg',
peerDependencies: { testpkg: '*' },
},
compilationDirectory: ws.rootDirectory,
},
);
expect(
(result.assembly.types?.['consumerpkg.Bar'] as spec.ClassType)
?.initializer?.parameters,
).toEqual([
{
name: 'foo',
type: { fqn: 'testpkg.submodule.Foo' },
},
{
name: 'props',
optional: true,
type: { fqn: 'consumerpkg.BarProps' },
},
]);
}),
);
test.each(['directly', 'as namespace', 'with alias'] as ImportStyle[])(
'can reference nested types in submodules, importing %s',
(importStyle) =>
TestWorkspace.withWorkspace(async (ws) => {
// There are 2 import styles:
//
// import { submodule } from 'lib';
// import * as submodule from 'lib/submodule';
//
// We need to support both import styles.
// Dependency that exports a submodule
await ws.addDependency(await makeDependencyWithSubmoduleAndNamespace());
let importStatement;
let prefix;
switch (importStyle) {
case 'directly':
importStatement = "import { Namespace } from 'testpkg/subdir'";
prefix = 'Namespace.';
break;
case 'as namespace':
importStatement = "import { submodule } from 'testpkg'";
prefix = 'submodule.Namespace.';
break;
case 'with alias':
importStatement = "import { submodule as sub } from 'testpkg'";
prefix = 'sub.Namespace.';
break;
}
// Main library that imports the submodule class directly
// Use the type in all possible positions
const result = await compileJsiiForTest(
{
'index.ts': `
${importStatement};
export interface BarProps {
readonly foo?: ${prefix}Foo;
}
export class Bar {
constructor(public readonly foo: ${prefix}Foo, props: BarProps = {}) {
Array.isArray(props);
}
public returnValue(): ${prefix}Foo {
return new ${prefix}Foo();
}
}
export class SubFoo extends ${prefix}Foo {}
export interface SubInterface extends ${prefix}FooInterface {}
export class Implementor implements ${prefix}IProtocol {}
`,
},
{
packageJson: {
// Must be a different name from the dependency
name: 'consumerpkg',
peerDependencies: { testpkg: '*' },
},
compilationDirectory: ws.rootDirectory,
},
);
expect(
(result.assembly.types?.['consumerpkg.Bar'] as spec.ClassType)
?.initializer?.parameters,
).toEqual([
{
name: 'foo',
type: { fqn: 'testpkg.submodule.Namespace.Foo' },
},
{
name: 'props',
optional: true,
type: { fqn: 'consumerpkg.BarProps' },
},
]);
}),
);
// Backwards compatibility test, for versions of libraries compiled before jsii 1.39.0
// which introduced the symbol identifier table
test('will detect types from submodules even if the symbol identifier table is missing', () =>
TestWorkspace.withWorkspace(async (ws) => {
await ws.addDependency(await makeDependencyWithSubmodule());
// Strip the symbolidentifiers from the assembly
const asmFile = path.join(ws.dependencyDir('testpkg'), '.jsii');
const asm: spec.Assembly = await fs.readJson(asmFile);
for (const mod of Object.values(asm.submodules ?? {})) {
delete mod.symbolId;
}
for (const type of Object.values(asm.types ?? {})) {
delete type.symbolId;
}
await fs.writeJson(asmFile, asm);
// We can still use those types if we have a full-library import
await compileJsiiForTest(
{
'index.ts': `
import { submodule } from 'testpkg';
export class Bar {
constructor(public readonly foo: submodule.Foo) {}
}
`,
},
{
packageJson: {
// Must be a different name from the dependency
name: 'consumerpkg',
peerDependencies: { testpkg: '*' },
},
compilationDirectory: ws.rootDirectory,
},
);
}));
async function makeDependencyWithSubmodule() {
return compileJsiiForTest({
'index.ts': 'export * as submodule from "./subdir"',
'subdir/index.ts': [
'export class Foo { };',
'export interface FooInterface { readonly value?: string }',
'export interface IProtocol { readonly value?: string; }',
].join('\n'),
'subdir/README.md': 'This is the README',
});
}
async function makeDependencyWithSubmoduleAndNamespace() {
return compileJsiiForTest({
'index.ts': 'export * as submodule from "./subdir"',
'subdir/index.ts': [
'export class Namespace {};',
'export namespace Namespace {',
' export class Foo { };',
' export interface FooInterface { readonly value?: string }',
' export interface IProtocol { readonly value?: string; }',
'}',
].join('\n'),
'subdir/README.md': 'This is the README',
});
}