Skip to content

feat(annotation): Handle JSX member expressions #690

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

Merged
merged 1 commit into from
Mar 4, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
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
23 changes: 23 additions & 0 deletions packages/babel-plugin-component-annotate/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -533,6 +533,29 @@ function getPathName(t: typeof Babel.types, path: Babel.NodePath): string {
return name.name.name;
}

// Handle JSX member expressions like Tab.Group
if (t.isJSXMemberExpression(name)) {
const objectName = getJSXMemberExpressionObjectName(t, name.object);
const propertyName = name.property.name;
return `${objectName}.${propertyName}`;
}

return UNKNOWN_ELEMENT_NAME;
}

// Recursively handle nested member expressions (e.g. Components.UI.Header)
function getJSXMemberExpressionObjectName(
t: typeof Babel.types,
object: Babel.types.JSXMemberExpression | Babel.types.JSXIdentifier
): string {
if (t.isJSXIdentifier(object)) {
return object.name;
}
if (t.isJSXMemberExpression(object)) {
const objectName = getJSXMemberExpressionObjectName(t, object.object);
return `${objectName}.${object.property.name}`;
}

return UNKNOWN_ELEMENT_NAME;
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -223,6 +223,20 @@ class componentName extends Component {
export default componentName;"
`;

exports[`handles nested member expressions in component names 1`] = `
"import React from 'react';
import { Components } from 'my-ui-library';
export default function TestComponent() {
return /*#__PURE__*/React.createElement(\\"div\\", {
\\"data-sentry-component\\": \\"TestComponent\\",
\\"data-sentry-source-file\\": \\"filename-test.js\\"
}, /*#__PURE__*/React.createElement(Components.UI.Button, null, \\"Click me\\"), /*#__PURE__*/React.createElement(Components.UI.Card.Header, {
\\"data-sentry-element\\": \\"Components.UI.Card.Header\\",
\\"data-sentry-source-file\\": \\"filename-test.js\\"
}, \\"Title\\"));
}"
`;

exports[`handles ternary operation returned by function body 1`] = `
"const maybeTrue = Math.random() > 0.5;
export default function componentName() {
Expand All @@ -233,6 +247,30 @@ export default function componentName() {
}"
`;

exports[`ignores React.Fragment with member expression handling 1`] = `
"import React from 'react';
export default function TestComponent() {
return /*#__PURE__*/React.createElement(React.Fragment, null, /*#__PURE__*/React.createElement(\\"div\\", null, \\"Content\\"));
}"
`;

exports[`ignores components with member expressions when in ignoredComponents 1`] = `
"import React from 'react';
import { Tab } from '@headlessui/react';
export default function TestComponent() {
return /*#__PURE__*/React.createElement(\\"div\\", {
\\"data-sentry-component\\": \\"TestComponent\\",
\\"data-sentry-source-file\\": \\"filename-test.js\\"
}, /*#__PURE__*/React.createElement(Tab.Group, null, /*#__PURE__*/React.createElement(Tab.List, null, /*#__PURE__*/React.createElement(Tab, {
\\"data-sentry-element\\": \\"Tab\\",
\\"data-sentry-source-file\\": \\"filename-test.js\\"
}, \\"Tab 1\\"), /*#__PURE__*/React.createElement(Tab, {
\\"data-sentry-element\\": \\"Tab\\",
\\"data-sentry-source-file\\": \\"filename-test.js\\"
}, \\"Tab 2\\")), /*#__PURE__*/React.createElement(Tab.Panels, null, /*#__PURE__*/React.createElement(Tab.Panel, null, \\"Content 1\\"), /*#__PURE__*/React.createElement(Tab.Panel, null, \\"Content 2\\"))));
}"
`;

exports[`nonJSX snapshot matches 1`] = `
"import React, { Component } from 'react';
class TestClass extends Component {
Expand Down
93 changes: 93 additions & 0 deletions packages/babel-plugin-component-annotate/test/test-plugin.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -1187,3 +1187,96 @@ export default function componentName() {
);
expect(result?.code).toMatchSnapshot();
});

it("ignores components with member expressions when in ignoredComponents", () => {
const result = transform(
`import React from 'react';
import { Tab } from '@headlessui/react';

export default function TestComponent() {
return (
<div>
<Tab.Group>
<Tab.List>
<Tab>Tab 1</Tab>
<Tab>Tab 2</Tab>
</Tab.List>
<Tab.Panels>
<Tab.Panel>Content 1</Tab.Panel>
<Tab.Panel>Content 2</Tab.Panel>
</Tab.Panels>
</Tab.Group>
</div>
);
}`,
{
filename: "/filename-test.js",
configFile: false,
presets: ["@babel/preset-react"],
plugins: [
[plugin, { ignoredComponents: ["Tab.Group", "Tab.List", "Tab.Panels", "Tab.Panel"] }],
],
}
);

// The component should be transformed but Tab.* components should not have annotations
expect(result?.code).toContain("React.createElement(Tab.Group");
expect(result?.code).not.toContain('"data-sentry-element": "Tab.Group"');
expect(result?.code).toContain("React.createElement(Tab.List");
expect(result?.code).not.toContain('"data-sentry-element": "Tab.List"');
expect(result?.code).toMatchSnapshot();
});

it("handles nested member expressions in component names", () => {
const result = transform(
`import React from 'react';
import { Components } from 'my-ui-library';

export default function TestComponent() {
return (
<div>
<Components.UI.Button>Click me</Components.UI.Button>
<Components.UI.Card.Header>Title</Components.UI.Card.Header>
</div>
);
}`,
{
filename: "/filename-test.js",
configFile: false,
presets: ["@babel/preset-react"],
plugins: [[plugin, { ignoredComponents: ["Components.UI.Button"] }]],
}
);

// Components.UI.Button should be ignored but Components.UI.Card.Header should be annotated
expect(result?.code).toContain("React.createElement(Components.UI.Button");
expect(result?.code).not.toContain('"data-sentry-element": "Components.UI.Button"');
expect(result?.code).toContain("React.createElement(Components.UI.Card.Header");
expect(result?.code).toContain('"data-sentry-element": "Components.UI.Card.Header"');
expect(result?.code).toMatchSnapshot();
});

it("ignores React.Fragment with member expression handling", () => {
const result = transform(
`import React from 'react';

export default function TestComponent() {
return (
<React.Fragment>
<div>Content</div>
</React.Fragment>
);
}`,
{
filename: "/filename-test.js",
configFile: false,
presets: ["@babel/preset-react"],
plugins: [plugin],
}
);

// React.Fragment should be ignored by default
expect(result?.code).toContain("React.createElement(React.Fragment");
expect(result?.code).not.toContain('"data-sentry-element": "React.Fragment"');
expect(result?.code).toMatchSnapshot();
});
Loading