@lwc/sfdc-lwc-compiler 13.2.17 → 13.2.19

package/dist/__tests__/compile-apex-logging.spec.js

@@ -0,0 +1,729 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const common_tags_1 = require("common-tags");
+const apexLoggingRollupPlugin_1 = require("../compiler/plugins/apexLoggingRollupPlugin");
+const main_1 = require("../main");
+const MODULE_NAMESPACE = 'x';
+const MODULE_NAME = 'foo';
+function compileApexLogging(bundleConfig) {
+    return (0, main_1.compile)({
+        bundle: {
+            namespace: MODULE_NAMESPACE,
+            name: MODULE_NAME,
+            type: 'platform',
+            files: {},
+            options: {
+                enableLwcPluginImperativeApexLogging: true,
+            },
+            ...bundleConfig,
+        },
+    });
+}
+function transformWithLuvioPlugin(src, overrideTransformOptions = {}) {
+    return (0, apexLoggingRollupPlugin_1.transformSync)(src, 'foo.js', {
+        sourcemap: true,
+        name: MODULE_NAME,
+        namespace: MODULE_NAMESPACE,
+        ...overrideTransformOptions,
+    });
+}
+// Normalize version numbers to avoid snapshot failures on version updates
+function normalizeVersion(code) {
+    return code.replace(/v\d+\.\d+\.\d+/g, 'vX.X.X');
+}
+describe('babel transform with luvio plugin', () => {
+    describe('apex logging transform', () => {
+        test('injects tagName for default Apex import with 0 args', () => {
+            const src = (0, common_tags_1.stripIndents) `
+                import { LightningElement } from 'lwc';
+                import methodA from '@salesforce/apex/MyClass.methodA';
+
+                export default class Test extends LightningElement {
+                    connectedCallback() {
+                        methodA();
+                    }
+                }
+            `;
+            const result = transformWithLuvioPlugin(src);
+            expect(result.code).toMatchInlineSnapshot(`
+              "import { LightningElement } from 'lwc';
+              import methodA from '@salesforce/apex/MyClass.methodA';
+              export default class Test extends LightningElement {
+                connectedCallback() {
+                  methodA(undefined, {
+                    sourceContext: {
+                      tagName: "x/foo"
+                    }
+                  });
+                }
+              }"
+            `);
+        });
+        test('injects tagName for default Apex import with 1 arg', () => {
+            const src = (0, common_tags_1.stripIndents) `
+                import { LightningElement } from 'lwc';
+                import methodA from '@salesforce/apex/MyClass.methodA';
+
+                export default class Test extends LightningElement {
+                    connectedCallback() {
+                        methodA({ abc: 123 });
+                    }
+                }
+            `;
+            const result = transformWithLuvioPlugin(src);
+            expect(result.code).toMatchInlineSnapshot(`
+              "import { LightningElement } from 'lwc';
+              import methodA from '@salesforce/apex/MyClass.methodA';
+              export default class Test extends LightningElement {
+                connectedCallback() {
+                  methodA({
+                    abc: 123
+                  }, {
+                    sourceContext: {
+                      tagName: "x/foo"
+                    }
+                  });
+                }
+              }"
+            `);
+        });
+        test('does not modify when 2 args are present', () => {
+            const src = (0, common_tags_1.stripIndents) `
+                import { LightningElement } from 'lwc';
+                import methodA from '@salesforce/apex/MyClass.methodA';
+
+                export default class Test extends LightningElement {
+                    connectedCallback() {
+                        methodA({ abc: 123 }, { extraData: 'foo'});
+                    }
+                }
+            `;
+            const result = transformWithLuvioPlugin(src);
+            expect(result.code).toMatchInlineSnapshot(`
+              "import { LightningElement } from 'lwc';
+              import methodA from '@salesforce/apex/MyClass.methodA';
+              export default class Test extends LightningElement {
+                connectedCallback() {
+                  methodA({
+                    abc: 123
+                  }, {
+                    extraData: 'foo'
+                  });
+                }
+              }"
+            `);
+            expect(result.code).not.toContain("'x/foo'");
+        });
+        test('does not modify when more than 2 args are present', () => {
+            const src = (0, common_tags_1.stripIndents) `
+                import { LightningElement } from 'lwc';
+                import methodA from '@salesforce/apex/MyClass.methodA';
+
+                export default class Test extends LightningElement {
+                    connectedCallback() {
+                        methodA({ abc: 123 }, { extraData: 'foo'}, { extraData: 'bar'});
+                    }
+                }
+            `;
+            const result = transformWithLuvioPlugin(src);
+            expect(result.code).toMatchInlineSnapshot(`
+              "import { LightningElement } from 'lwc';
+              import methodA from '@salesforce/apex/MyClass.methodA';
+              export default class Test extends LightningElement {
+                connectedCallback() {
+                  methodA({
+                    abc: 123
+                  }, {
+                    extraData: 'foo'
+                  }, {
+                    extraData: 'bar'
+                  });
+                }
+              }"
+            `);
+            expect(result.code).not.toContain("'x/foo'");
+        });
+        test('does not modify when using a spread operator', () => {
+            const src = (0, common_tags_1.stripIndents) `
+                import { LightningElement } from 'lwc';
+                import methodA from '@salesforce/apex/MyClass.methodA';
+                const args = { abc: 123 };
+                const args2 = { extraData: 'foo' };
+                export default class Test extends LightningElement {
+                    connectedCallback() {
+                        methodA(...args, ...args2);
+                    }
+                }
+            `;
+            const result = transformWithLuvioPlugin(src);
+            expect(result.code).toMatchInlineSnapshot(`
+              "import { LightningElement } from 'lwc';
+              import methodA from '@salesforce/apex/MyClass.methodA';
+              const args = {
+                abc: 123
+              };
+              const args2 = {
+                extraData: 'foo'
+              };
+              export default class Test extends LightningElement {
+                connectedCallback() {
+                  methodA(...args, ...args2);
+                }
+              }"
+            `);
+            expect(result.code).not.toContain("'x/foo'");
+        });
+        test('resolves module for unnamed default class export', () => {
+            const src = (0, common_tags_1.stripIndents) `
+                import { LightningElement } from 'lwc';
+                import methodA from '@salesforce/apex/MyClass.methodA';
+
+                export default class extends LightningElement {
+                    connectedCallback() {
+                        methodA();
+                    }
+                }
+            `;
+            const result = transformWithLuvioPlugin(src);
+            expect(result.code).toMatchInlineSnapshot(`
+              "import { LightningElement } from 'lwc';
+              import methodA from '@salesforce/apex/MyClass.methodA';
+              export default class extends LightningElement {
+                connectedCallback() {
+                  methodA(undefined, {
+                    sourceContext: {
+                      tagName: "x/foo"
+                    }
+                  });
+                }
+              }"
+            `);
+        });
+        test('resolves component class name from default export identifier bound to named class expression', () => {
+            const src = (0, common_tags_1.stripIndents) `
+                import { LightningElement } from 'lwc';
+                import methodA from '@salesforce/apex/MyClass.methodA';
+
+                const Comp = class NamedComp extends LightningElement {
+                    connectedCallback() {
+                        methodA();
+                    }
+                };
+
+                export default Comp;
+            `;
+            const result = transformWithLuvioPlugin(src);
+            expect(result.code).toMatchInlineSnapshot(`
+              "import { LightningElement } from 'lwc';
+              import methodA from '@salesforce/apex/MyClass.methodA';
+              const Comp = class NamedComp extends LightningElement {
+                connectedCallback() {
+                  methodA(undefined, {
+                    sourceContext: {
+                      tagName: "x/foo"
+                    }
+                  });
+                }
+              };
+              export default Comp;"
+            `);
+        });
+        test('injects tagName for apexContinuation import', () => {
+            const src = (0, common_tags_1.stripIndents) `
+                import { LightningElement } from 'lwc';
+                import cont from '@salesforce/apexContinuation/MyClass.methodB';
+
+                export default class Test extends LightningElement {
+                    connectedCallback() {
+                        cont();
+                    }
+                }
+            `;
+            const result = transformWithLuvioPlugin(src);
+            expect(result.code).toMatchInlineSnapshot(`
+              "import { LightningElement } from 'lwc';
+              import cont from '@salesforce/apexContinuation/MyClass.methodB';
+              export default class Test extends LightningElement {
+                connectedCallback() {
+                  cont(undefined, {
+                    sourceContext: {
+                      tagName: "x/foo"
+                    }
+                  });
+                }
+              }"
+            `);
+        });
+        test('injects tagName for non default exported functions', () => {
+            const src = (0, common_tags_1.stripIndents) `
+                import foo from '@salesforce/apex/ns.class.fooMethod';
+                import bar from '@salesforce/apex/ns.class.barMethod';
+
+                export function callFoo() {
+                    foo();
+                }
+
+                export function callBar() {
+                    bar();
+                }
+            `;
+            const result = transformWithLuvioPlugin(src);
+            expect(result.code).toMatchInlineSnapshot(`
+              "import foo from '@salesforce/apex/ns.class.fooMethod';
+              import bar from '@salesforce/apex/ns.class.barMethod';
+              export function callFoo() {
+                foo(undefined, {
+                  sourceContext: {
+                    tagName: "x/foo"
+                  }
+                });
+              }
+              export function callBar() {
+                bar(undefined, {
+                  sourceContext: {
+                    tagName: "x/foo"
+                  }
+                });
+              }"
+            `);
+        });
+        test('injects tagName for default imported function', () => {
+            const src = (0, common_tags_1.stripIndents) `
+                import { LightningElement } from 'lwc';
+                import { default as methodA } from '@salesforce/apex/MyClass.methodA';
+
+                export default class Test extends LightningElement {
+                    connectedCallback() {
+                        methodA({ abc: 123 });
+                    }
+                }
+            `;
+            const result = transformWithLuvioPlugin(src);
+            expect(result.code).toMatchInlineSnapshot(`
+              "import { LightningElement } from 'lwc';
+              import { default as methodA } from '@salesforce/apex/MyClass.methodA';
+              export default class Test extends LightningElement {
+                connectedCallback() {
+                  methodA({
+                    abc: 123
+                  }, {
+                    sourceContext: {
+                      tagName: "x/foo"
+                    }
+                  });
+                }
+              }"
+            `);
+        });
+        test('injects tagName for non default exported functions with 1 arg', () => {
+            const src = (0, common_tags_1.stripIndents) `
+                import foo from '@salesforce/apex/ns.class.fooMethod';
+                import bar from '@salesforce/apex/ns.class.barMethod';
+
+                export function callFoo() {
+                    foo({ abc: 123 });
+                }
+
+                export function callBar() {
+                    bar({ abc: 123 });
+                }
+            `;
+            const result = transformWithLuvioPlugin(src);
+            expect(result.code).toMatchInlineSnapshot(`
+              "import foo from '@salesforce/apex/ns.class.fooMethod';
+              import bar from '@salesforce/apex/ns.class.barMethod';
+              export function callFoo() {
+                foo({
+                  abc: 123
+                }, {
+                  sourceContext: {
+                    tagName: "x/foo"
+                  }
+                });
+              }
+              export function callBar() {
+                bar({
+                  abc: 123
+                }, {
+                  sourceContext: {
+                    tagName: "x/foo"
+                  }
+                });
+              }"
+            `);
+        });
+        test('does not inject tagName for non default exported functions with 2 args', () => {
+            const src = (0, common_tags_1.stripIndents) `
+                import foo from '@salesforce/apex/ns.class.fooMethod';
+                import bar from '@salesforce/apex/ns.class.barMethod';
+
+                export function callFoo() {
+                    foo({ abc: 123 }, { extraData: 'foo'});
+                }
+
+                export function callBar() {
+                    bar({ abc: 123 }, { extraData: 'foo'});
+                }
+            `;
+            const result = transformWithLuvioPlugin(src);
+            expect(result.code).toMatchInlineSnapshot(`
+              "import foo from '@salesforce/apex/ns.class.fooMethod';
+              import bar from '@salesforce/apex/ns.class.barMethod';
+              export function callFoo() {
+                foo({
+                  abc: 123
+                }, {
+                  extraData: 'foo'
+                });
+              }
+              export function callBar() {
+                bar({
+                  abc: 123
+                }, {
+                  extraData: 'foo'
+                });
+              }"
+            `);
+        });
+        test('does not inject tagName for non default exported functions with 2 empty args', () => {
+            const src = (0, common_tags_1.stripIndents) `
+                import foo from '@salesforce/apex/ns.class.fooMethod';
+                import bar from '@salesforce/apex/ns.class.barMethod';
+
+                export function callFoo() {
+                    foo({}, {});
+                }
+
+                export function callBar() {
+                    bar({}, {});
+                }
+            `;
+            const result = transformWithLuvioPlugin(src);
+            expect(result.code).toMatchInlineSnapshot(`
+              "import foo from '@salesforce/apex/ns.class.fooMethod';
+              import bar from '@salesforce/apex/ns.class.barMethod';
+              export function callFoo() {
+                foo({}, {});
+              }
+              export function callBar() {
+                bar({}, {});
+              }"
+            `);
+        });
+        test('does not inject tagName for re-exported apex function', () => {
+            const src = (0, common_tags_1.stripIndents) `
+                import foo from '@salesforce/apex/ns.class.fooMethod';
+                export const fooAsBar = foo;
+            `;
+            const result = transformWithLuvioPlugin(src);
+            expect(result.code).toMatchInlineSnapshot(`
+              "import foo from '@salesforce/apex/ns.class.fooMethod';
+              export const fooAsBar = foo;"
+            `);
+        });
+        test('does not inject tagName for exported function with parameter shadowing', () => {
+            const src = (0, common_tags_1.stripIndents) `
+                import foo from '@salesforce/apex/ns.class.fooMethod';
+
+                export function callFoo() {
+                    foo();
+                }
+
+                export function callBar(foo) {
+                    foo({abc: 123});
+                }
+            `;
+            const result = transformWithLuvioPlugin(src);
+            expect(result.code).toMatchInlineSnapshot(`
+              "import foo from '@salesforce/apex/ns.class.fooMethod';
+              export function callFoo() {
+                foo(undefined, {
+                  sourceContext: {
+                    tagName: "x/foo"
+                  }
+                });
+              }
+              export function callBar(foo) {
+                foo({
+                  abc: 123
+                });
+              }"
+            `);
+        });
+        test('does not inject tagName for exported function with parameter shadowing, variation 1', () => {
+            const src = (0, common_tags_1.stripIndents) `
+                import getContactList from '@salesforce/apex/ContactController.getContactList';
+
+                export default class ApexWireMethodToProperty extends LightningElement {
+
+                    foo() {
+                        function getContactList() {}
+                        getContactList(); // should not be transformed
+                    }
+                    @wire(getContactList, {
+                        abc: 123
+                    })
+                    contacts;
+                }
+            `;
+            const result = transformWithLuvioPlugin(src);
+            expect(result.code).toMatchInlineSnapshot(`
+              "import getContactList from '@salesforce/apex/ContactController.getContactList';
+              export default class ApexWireMethodToProperty extends LightningElement {
+                foo() {
+                  function getContactList() {}
+                  getContactList(); // should not be transformed
+                }
+                @wire(getContactList, {
+                  abc: 123
+                })
+                contacts;
+              }"
+            `);
+        });
+        test('does not inject tagName for exported function with parameter shadowing, variation 2', () => {
+            const src = (0, common_tags_1.stripIndents) `
+                import getContactList from '@salesforce/apex/ContactController.getContactList';
+
+                export default class ApexWireMethodToProperty extends LightningElement {
+
+                    foo() {
+                        function getContactList() {}
+                        getContactList(); // should not be transformed
+                    }
+                    @wire(getContactList, {
+                        abc: 123
+                    })
+                    contacts;
+                }
+            `;
+            const result = transformWithLuvioPlugin(src);
+            expect(result.code).toMatchInlineSnapshot(`
+              "import getContactList from '@salesforce/apex/ContactController.getContactList';
+              export default class ApexWireMethodToProperty extends LightningElement {
+                foo() {
+                  function getContactList() {}
+                  getContactList(); // should not be transformed
+                }
+                @wire(getContactList, {
+                  abc: 123
+                })
+                contacts;
+              }"
+            `);
+        });
+        test('does not inject for refreshApex usages', () => {
+            const src = (0, common_tags_1.stripIndents) `
+                // Example of refreshing data for a wired property
+                // after you update data via imperative Apex.
+                import { LightningElement, wire } from 'lwc';
+                import { refreshApex } from '@salesforce/apex';
+                import { notifyRecordUpdateAvailable } from 'lightning/uiRecordApi';
+                import getOpptyOverAmount from '@salesforce/apex/OpptyController.getOpptyOverAmount';
+                import apexUpdateRecord from '@salesforce/apex/Controller.apexUpdateRecord';
+
+                export default class RefreshDataImperativeExample extends LightningElement {
+                    @wire(getOpptyOverAmount, { amount: '$amount' })
+                    opptiesOverAmount;
+
+                    // Update the record in Apex, such as via a button click
+                    // Refresh Apex data that the wire service provisioned
+                    async handler() {
+                        try {
+                            await apexUpdateRecord(recordIds);
+                            refreshApex(this.opptiesOverAmount);
+                            notifyRecordUpdateAvailable(recordIds); // Refresh the Lightning Data Service cache
+                        } catch (error) {
+                            this.error = error;
+                        }
+                    }
+                }
+            `;
+            const result = transformWithLuvioPlugin(src);
+            expect(result.code).toMatchInlineSnapshot(`
+              "// Example of refreshing data for a wired property
+              // after you update data via imperative Apex.
+              import { LightningElement, wire } from 'lwc';
+              import { refreshApex } from '@salesforce/apex';
+              import { notifyRecordUpdateAvailable } from 'lightning/uiRecordApi';
+              import getOpptyOverAmount from '@salesforce/apex/OpptyController.getOpptyOverAmount';
+              import apexUpdateRecord from '@salesforce/apex/Controller.apexUpdateRecord';
+              export default class RefreshDataImperativeExample extends LightningElement {
+                @wire(getOpptyOverAmount, {
+                  amount: '$amount'
+                })
+                opptiesOverAmount;
+
+                // Update the record in Apex, such as via a button click
+                // Refresh Apex data that the wire service provisioned
+                async handler() {
+                  try {
+                    await apexUpdateRecord(recordIds, {
+                      sourceContext: {
+                        tagName: "x/foo"
+                      }
+                    });
+                    refreshApex(this.opptiesOverAmount);
+                    notifyRecordUpdateAvailable(recordIds); // Refresh the Lightning Data Service cache
+                  } catch (error) {
+                    this.error = error;
+                  }
+                }
+              }"
+            `);
+        });
+        test('does not inject for non-apex imports', () => {
+            const src = (0, common_tags_1.stripIndents) `
+                import { LightningElement } from 'lwc';
+                import doThing from 'c/someModule';
+
+                export default class Test extends LightningElement {
+                    connectedCallback() {
+                        doThing();
+                    }
+                }
+            `;
+            const result = transformWithLuvioPlugin(src);
+            expect(result.code).toMatchInlineSnapshot(`
+              "import { LightningElement } from 'lwc';
+              import doThing from 'c/someModule';
+              export default class Test extends LightningElement {
+                connectedCallback() {
+                  doThing();
+                }
+              }"
+            `);
+        });
+        test('does not inject for @wire apex usages', () => {
+            const src = (0, common_tags_1.stripIndents) `
+                import { LightningElement, wire } from 'lwc';
+                import getContactList from '@salesforce/apex/ContactController.getContactList';
+
+                export default class ApexWireMethodToProperty extends LightningElement {
+                    @wire(getContactList, { abc: 123 }) contacts;
+                }
+            `;
+            const result = transformWithLuvioPlugin(src);
+            expect(result.code).toMatchInlineSnapshot(`
+              "import { LightningElement, wire } from 'lwc';
+              import getContactList from '@salesforce/apex/ContactController.getContactList';
+              export default class ApexWireMethodToProperty extends LightningElement {
+                @wire(getContactList, {
+                  abc: 123
+                })
+                contacts;
+              }"
+            `);
+        });
+    });
+});
+describe('rollup compilation with luvio plugin enabled', () => {
+    test('verify the correctness of the compiler output on a valid source foo.js', async () => {
+        const res = await compileApexLogging({
+            type: 'platform',
+            files: {
+                'foo.js': (0, common_tags_1.stripIndents) `
+                    import { LightningElement } from 'lwc';
+                    import methodA from '@salesforce/apex/MyClass.methodA';
+
+                    export default class Test extends LightningElement {
+                        connectedCallback() {
+                            methodA();
+                        }
+                    }
+                `,
+            },
+            namespaceMapping: {
+                x: 'ns',
+            },
+        });
+        const { success, results, diagnostics } = res;
+        expect(success).toBe(true);
+        expect(diagnostics.length).toBe(0);
+        expect(normalizeVersion(results[0].code)).toMatchInlineSnapshot(`
+          "define('ns/foo', ['lwc', '@salesforce/apex/MyClass.methodA'], (function (lwc, methodA) {
+
+          	function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
+
+          	var methodA__default = /*#__PURE__*/_interopDefaultCompat(methodA);
+
+          	var _tmpl = void 0;
+
+          	class Test extends lwc.LightningElement {
+          	  connectedCallback() {
+          	    methodA__default.default(undefined, {
+          	      sourceContext: {
+          	        tagName: "ns/foo"
+          	      }
+          	    });
+          	  }
+          	  /*LWC compiler vX.X.X*/
+          	}
+          	const __lwc_component_class_internal = lwc.registerComponent(Test, {
+          	  tmpl: _tmpl,
+          	  sel: "x-foo",
+          	  apiVersion: 66
+          	});
+
+          	return __lwc_component_class_internal;
+
+          }));
+          "
+        `);
+    });
+    test('verify the correctness of the compiler output on a valid source foo.ts', async () => {
+        const res = await compileApexLogging({
+            type: 'internal',
+            files: {
+                'foo.ts': (0, common_tags_1.stripIndents) `
+                    import { LightningElement } from 'lwc';
+                    import methodA from '@salesforce/apex/MyClass.methodA';
+
+                    export default class Test extends LightningElement {
+                        connectedCallback() {
+                            methodA();
+                        }
+                    }
+                `,
+            },
+            namespaceMapping: {
+                x: 'ns',
+            },
+        });
+        const { success, results, diagnostics } = res;
+        expect(success).toBe(true);
+        expect(diagnostics.length).toBe(0);
+        expect(normalizeVersion(results[0].code)).toMatchInlineSnapshot(`
+          "define('ns/foo', ['lwc', '@salesforce/apex/MyClass.methodA'], (function (lwc, methodA) {
+
+          	function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
+
+          	var methodA__default = /*#__PURE__*/_interopDefaultCompat(methodA);
+
+          	var _tmpl = void 0;
+
+          	class Test extends lwc.LightningElement {
+          	  connectedCallback() {
+          	    methodA__default.default(undefined, {
+          	      sourceContext: {
+          	        tagName: "ns/foo"
+          	      }
+          	    });
+          	  }
+          	  /*LWC compiler vX.X.X*/
+          	}
+          	const __lwc_component_class_internal = lwc.registerComponent(Test, {
+          	  tmpl: _tmpl,
+          	  sel: "x-foo",
+          	  apiVersion: 66,
+          	  enableSyntheticElementInternals: true
+          	});
+
+          	return __lwc_component_class_internal;
+
+          }));
+          "
+        `);
+    });
+});
+//# sourceMappingURL=compile-apex-logging.spec.js.map