Skip to content

Commit 0d606c8

Browse files
fix(build): include protobuf and Connect license notices
1 parent e39429e commit 0d606c8

4 files changed

Lines changed: 111 additions & 11 deletions

File tree

‎docs/internals/open-source-licenses.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,8 @@ metadata:
7676
}
7777
```
7878

79+
For packages containing separately licensed code, use `generatedNotices` with an array of templates instead of `generatedNotice`. The generator includes every notice in the package row.
80+
7981
`version`, `license`, and `sourceUrl` are optional. Omitting `version` applies the override to every
8082
installed version of that package. An override can use `repositoryUrl` instead of `name` when
8183
several packages from one monorepo share the same notice:

‎scripts/lib/third-party-licenses.test.ts‎

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -325,6 +325,59 @@ describe("third-party license generation", () => {
325325
expect(manifest.entries[0]?.noticeText).toBe("Override text");
326326
});
327327

328+
it("keeps all licenses and attributions in a package with multiple generated notices", async () => {
329+
const fixture = await createFixture();
330+
await NodeFSP.rm(NodePath.join(fixture.dependencyRoot, "LICENSE"));
331+
for (const licenseId of ["Apache-2.0", "BSD-3-Clause"]) {
332+
await writeJson(
333+
NodePath.join(
334+
fixture.root,
335+
`.generated/third-party-licenses/spdx/v3.28.0/${licenseId}.json`,
336+
),
337+
{ licenseId, licenseText: `${licenseId} terms` },
338+
);
339+
}
340+
await writeJson(fixture.configFile, {
341+
packageOverrides: [
342+
{
343+
name: "demo-dependency",
344+
license: "(Apache-2.0 AND BSD-3-Clause)",
345+
generatedNotices: [
346+
{ licenseId: "Apache-2.0", copyrights: ["Copyright primary author"] },
347+
{ licenseId: "BSD-3-Clause", copyrights: ["Copyright vendored author"] },
348+
],
349+
},
350+
],
351+
});
352+
const manifest = await generateThirdPartyLicenseManifest({
353+
configFile: fixture.configFile,
354+
packageManifests: [{ bundle: "web", path: fixture.appManifest }],
355+
});
356+
expect(manifest.entries[0]?.license).toBe("(Apache-2.0 AND BSD-3-Clause)");
357+
expect(manifest.entries[0]?.noticeText).toBe(
358+
"Copyright primary author\n\nApache-2.0 terms\n\n---\n\nCopyright vendored author\n\nBSD-3-Clause terms",
359+
);
360+
});
361+
362+
it("rejects conflicting package notice sources", async () => {
363+
const fixture = await createFixture();
364+
await writeJson(fixture.configFile, {
365+
packageOverrides: [
366+
{
367+
name: "demo-dependency",
368+
generatedNotice: { licenseId: "MIT" },
369+
generatedNotices: [{ licenseId: "BSD-3-Clause" }],
370+
},
371+
],
372+
});
373+
await expect(
374+
generateThirdPartyLicenseManifest({
375+
configFile: fixture.configFile,
376+
packageManifests: [{ bundle: "web", path: fixture.appManifest }],
377+
}),
378+
).rejects.toThrow("can define only one");
379+
});
380+
328381
it("applies repository overrides across monorepo packages", async () => {
329382
const fixture = await createFixture();
330383
await NodeFSP.rm(NodePath.join(fixture.dependencyRoot, "LICENSE"));

‎scripts/lib/third-party-licenses.ts‎

Lines changed: 17 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ interface CustomNoticeConfigEntry {
6767
}
6868

6969
interface PackageNoticeOverrideConfigEntry {
70-
readonly generatedNotice?: GeneratedNoticeConfigEntry;
70+
readonly generatedNotices?: ReadonlyArray<GeneratedNoticeConfigEntry>;
7171
readonly license?: string;
7272
readonly name?: string;
7373
readonly noticeFile?: string;
@@ -257,8 +257,16 @@ function decodePackageOverrides(value: unknown): ReadonlyArray<PackageNoticeOver
257257
entry.generatedNotice === undefined
258258
? undefined
259259
: decodeGeneratedNotice(entry.generatedNotice, `${context} generated notice`);
260-
if (noticeFile !== undefined && generatedNotice !== undefined) {
261-
throw new Error(`${context} cannot define both "noticeFile" and "generatedNotice".`);
260+
const generatedNotices = decodeGeneratedNotices(entry.generatedNotices, context);
261+
if (
262+
Number(noticeFile !== undefined) +
263+
Number(generatedNotice !== undefined) +
264+
Number(generatedNotices !== undefined) >
265+
1
266+
) {
267+
throw new Error(
268+
`${context} can define only one of "noticeFile", "generatedNotice", or "generatedNotices".`,
269+
);
262270
}
263271
const sourceUrl = readOptionalString(entry, "sourceUrl", context);
264272
return {
@@ -267,7 +275,8 @@ function decodePackageOverrides(value: unknown): ReadonlyArray<PackageNoticeOver
267275
...(version !== undefined ? { version } : {}),
268276
...(license !== undefined ? { license } : {}),
269277
...(noticeFile !== undefined ? { noticeFile } : {}),
270-
...(generatedNotice !== undefined ? { generatedNotice } : {}),
278+
...(generatedNotice !== undefined ? { generatedNotices: [generatedNotice] } : {}),
279+
...(generatedNotices !== undefined ? { generatedNotices } : {}),
271280
...(sourceUrl !== undefined ? { sourceUrl } : {}),
272281
};
273282
});
@@ -396,9 +405,7 @@ function configuredGeneratedNotices(
396405
): ReadonlyArray<GeneratedNoticeConfigEntry> {
397406
return [
398407
...config.customNotices.flatMap((notice) => notice.generatedNotices ?? []),
399-
...config.packageOverrides.flatMap((override) =>
400-
override.generatedNotice ? [override.generatedNotice] : [],
401-
),
408+
...config.packageOverrides.flatMap((override) => override.generatedNotices ?? []),
402409
];
403410
}
404411

@@ -780,9 +787,9 @@ async function packageEntry(
780787
}
781788

782789
const repositoryKey = repositoryNoticeKey(collected.packageJson, license);
783-
const noticeText = override?.generatedNotice
790+
const noticeText = override?.generatedNotices
784791
? await generatedNoticeText(
785-
[override.generatedNotice],
792+
override.generatedNotices,
786793
configDirectory,
787794
allowMissingGeneratedNotices,
788795
)
@@ -793,7 +800,7 @@ async function packageEntry(
793800
: ((await packageNoticeText(collected.packageRoot, packageNotices)) ??
794801
(repositoryKey ? repositoryNotices.get(repositoryKey) : undefined));
795802
if (!noticeText) {
796-
if (override?.generatedNotice && allowMissingGeneratedNotices) return null;
803+
if (override?.generatedNotices && allowMissingGeneratedNotices) return null;
797804
throw new Error(
798805
`${name}@${version} does not include a license or notice file. Add a package override with "noticeFile" or "generatedNotice" in the third-party license config.`,
799806
);

‎third-party-licenses.config.json‎

Lines changed: 39 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,7 @@
103103
"generatedNotices": [
104104
{
105105
"licenseId": "Apache-2.0",
106-
"copyrights": ["Copyright 2009, 2010, 2013 André Berg"]
106+
"copyrights": ["Copyright 2009, 2010, 2013 Andr\u00e9 Berg"]
107107
}
108108
]
109109
},
@@ -124,6 +124,44 @@
124124
}
125125
],
126126
"packageOverrides": [
127+
{
128+
"name": "@bufbuild/protobuf",
129+
"version": "1.10.0",
130+
"generatedNotices": [
131+
{
132+
"licenseId": "Apache-2.0",
133+
"copyrights": ["Copyright 2021-2024 Buf Technologies, Inc."]
134+
},
135+
{
136+
"licenseId": "BSD-3-Clause",
137+
"copyrights": ["Copyright 2008 Google Inc. All rights reserved."]
138+
}
139+
]
140+
},
141+
{
142+
"name": "@connectrpc/connect",
143+
"version": "1.7.0",
144+
"generatedNotice": {
145+
"licenseId": "Apache-2.0",
146+
"copyrights": ["Copyright 2021-2024 The Connect Authors"]
147+
}
148+
},
149+
{
150+
"name": "@connectrpc/connect-node",
151+
"version": "1.7.0",
152+
"generatedNotice": {
153+
"licenseId": "Apache-2.0",
154+
"copyrights": ["Copyright 2021-2024 The Connect Authors"]
155+
}
156+
},
157+
{
158+
"name": "@connectrpc/connect-web",
159+
"version": "1.7.0",
160+
"generatedNotice": {
161+
"licenseId": "Apache-2.0",
162+
"copyrights": ["Copyright 2021-2024 The Connect Authors"]
163+
}
164+
},
127165
{
128166
"license": "MIT",
129167
"name": "@react-grab/cli",

0 commit comments

Comments
 (0)