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.

Sign up for GitHub

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

Jump to bottom

Fix name collision with import in generated code #688

Merged
merged 2 commits into from
Jan 29, 2024
Merged

Fix name collision with import in generated code #688

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2d23803
Fix name collision with import in generated code
timostamm Jan 29, 2024
729b9f3
Fix
timostamm Jan 29, 2024
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
7 changes: 7 additions & 0 deletions packages/protobuf-test/extra/name-clash.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,13 @@
syntax = "proto3";
package spec;

import "extra/example.proto";

// This message class will clash with the imported message class
message User {
docs.User u = 1; // Reference the import with the same name to trigger a clash
}
Comment on lines +18 to +23
Copy link
Member Author

Choose a reason for hiding this comment

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

We trigger the issue by declaring a message, and importing a message with the same name from a different namespace.


message ReservedPropertyNames {
message BuiltIn {
string constructor = 2; // built-in constructor()
Expand Down
29 changes: 29 additions & 0 deletions packages/protobuf-test/src/gen/js/extra/name-clash_pb.d.ts
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

13 changes: 13 additions & 0 deletions packages/protobuf-test/src/gen/js/extra/name-clash_pb.js
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

42 changes: 42 additions & 0 deletions packages/protobuf-test/src/gen/ts/extra/name-clash_pb.ts
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

13 changes: 13 additions & 0 deletions packages/protoplugin-test/src/file-export-decl.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,19 @@ describe("file exportDecl", () => {
expect(lines).toStrictEqual(["export const SomeEnum = 123;"]);
});

test("forces import with same name to be aliased", async () => {
const lines = await testGenerate((f) => {
f.print(f.import("Foo", "pkg"));
f.print(f.exportDecl("const", "Foo"), " = 123;");
});
expect(lines).toStrictEqual([
`import { Foo as Foo$1 } from "pkg";`,
``,
`Foo$1`,
`export const Foo = 123;`,
]);
});
Comment on lines +51 to +62
Copy link
Member Author

Choose a reason for hiding this comment

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

Fails with:

    - Expected  - 2
    + Received  + 2

      Array [
    -   "import { Foo as Foo$1 } from \"pkg\";",
    +   "import { Foo } from \"pkg\";",
        "",
    -   "Foo$1",
    +   "Foo",
        "export const Foo = 123;",
      ]


async function testGenerate(
gen: (
f: GeneratedFile,
Expand Down
27 changes: 17 additions & 10 deletions packages/protoplugin/src/ecmascript/generated-file.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -431,18 +431,25 @@ function processImports(

// Walk through all symbols used and populate the collections above.
for (const s of el) {
if (typeof s != "object" || s.kind !== "es_symbol") {
if (typeof s != "object") {
continue;
}
symbolToIdentifier.set(s.id, s.name);
if (!s.typeOnly) {
// a symbol is only type-imported as long as all uses are type-only
symbolToIsValue.set(s.id, true);
}
if (s.from === importerPath) {
identifiersTaken.add(s.name);
} else {
foreignSymbols.push(s);
switch (s.kind) {
case "es_symbol":
symbolToIdentifier.set(s.id, s.name);
if (!s.typeOnly) {
// a symbol is only type-imported as long as all uses are type-only
symbolToIsValue.set(s.id, true);
}
if (s.from === importerPath) {
identifiersTaken.add(s.name);
} else {
foreignSymbols.push(s);
}
break;
case "es_export_stmt":
identifiersTaken.add(s.name);
break;
}
}

Expand Down
Loading