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

[FEATURE] builder: Improve support for ES6+ syntax #774

Merged
merged 11 commits into from
Sep 19, 2022
+1,707 −206
Merged

[FEATURE] builder: Improve support for ES6+ syntax #774

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
f3df91a
[INTERNAL] Improve support for ES6+ Syntax
matz3 Jul 29, 2022
8842249
[INTERNAL] Add tests with async factory function
flovogt Aug 23, 2022
62a8e5b
JSModuleAnalyzer: Conditional handling of LogicalExpression
matz3 Aug 23, 2022
d9d3d2a
[INTERNAL] log warning when asynchronous factory function is used for…
flovogt Aug 25, 2022
e4783b1
[INTERNAL] FioriElementsAnalyzer/SmartTemplateAnalyzer: Add tests for…
flovogt Aug 25, 2022
bd0dd80
[INTERNAL] move sinon sanbox creation into beforeEach hook and enable…
flovogt Aug 29, 2022
dd123ff
[INTERNAL] log module name when async factory function is used
flovogt Aug 29, 2022
78a3b0f
Revert async warning log
matz3 Sep 19, 2022
30bb341
Typo
matz3 Sep 19, 2022
2681467
Improve comment
matz3 Sep 19, 2022
d5ce05a
ASTUtils: Add missing test cases
matz3 Sep 19, 2022
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
4 changes: 4 additions & 0 deletions lib/lbt/analyzer/FioriElementsAnalyzer.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -181,6 +181,10 @@ class FioriElementsAnalyzer {
}
});
}
if (defineCall.factory.async) {
log.warn("Using 'sap.ui.define' with an asynchronous function callback " +
"is currently not supported by the UI5 runtime.");
}
}
}
return templateName;
Expand Down
4 changes: 4 additions & 0 deletions lib/lbt/analyzer/SmartTemplateAnalyzer.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -150,6 +150,10 @@ class TemplateComponentAnalyzer {
}
});
}
if (defineCall.factory.async) {
Copy link
Member

Choose a reason for hiding this comment

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

This message is IMO misleading. The ui5loader can handle async callbacks. The returned promise is just used as export value and delivered to anyone importing the module.

Here, the smart templates (FE v2) cannot handle such a promise. That's the reason why we should log a message.

Copy link
Member

Choose a reason for hiding this comment

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

Thanks Frank. Correct. So what should we log in case of the XMLComposite here the artefact can be placed in the view declaratively. The sap.ui.core.mvc.XMLView does not support returning a promise, correct? But do we know who consumes the XMLComposite. A typed view might import the asynchronously defined XMLComposite and can handle the asynchronism.

Copy link
Member Author

Choose a reason for hiding this comment

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

Let's handle this in a follow-up PR, so that we can merge the current changes.

log.warn("Using 'sap.ui.define' with an asynchronous function callback " +
"is currently not supported by the UI5 runtime.");
}
}
}
return templateName;
Expand Down
4 changes: 4 additions & 0 deletions lib/lbt/analyzer/XMLCompositeAnalyzer.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,10 @@ class XMLCompositeAnalyzer {
log.verbose("fragment control: add dependency to template fragment %s", fragmentModule);
info.addDependency(fragmentModule);
}
if (defineCall.factory.async) {
log.warn("Using 'sap.ui.define' with an asynchronous function callback " +
"is currently not supported by the UI5 runtime.");
}
}
}
}
Expand Down
115 changes: 80 additions & 35 deletions test/lib/lbt/analyzer/FioriElementsAnalyzer.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,27 @@
const test = require("ava");
const FioriElementsAnalyzer = require("../../../../lib/lbt/analyzer/FioriElementsAnalyzer");
const sinon = require("sinon");
const parseUtils = require("../../../../lib/lbt/utils/parseUtils");
const sinonGlobal = require("sinon");
const logger = require("@ui5/logger");
const loggerInstance = logger.getLogger();
const mock = require("mock-require");

test.before((t) => {
const sinon = t.context.sinon = sinonGlobal.createSandbox();
t.context.warningLogSpy = sinon.spy(loggerInstance, "warn");
sinon.stub(logger, "getLogger").returns(loggerInstance);
t.context.FioriElementsAnalyzerWithStubbedLogger =
mock.reRequire("../../../../lib/lbt/analyzer/FioriElementsAnalyzer");
});

test.after((t) => {
mock.stopAll();
t.context.sinon.restore();
});

test.beforeEach((t) => {
t.context.warningLogSpy.resetHistory();
});

test("analyze: with Component.js", async (t) => {
const emptyPool = {};
Expand All @@ -27,7 +47,7 @@ test("analyze: without manifest", async (t) => {

const analyzer = new FioriElementsAnalyzer(mockPool);

const stubAnalyzeManifest = sinon.stub(analyzer, "_analyzeManifest").resolves();
const stubAnalyzeManifest = t.context.sinon.stub(analyzer, "_analyzeManifest").resolves();

const name = "MyComponent.js";
const result = await analyzer.analyze({name}, moduleInfo);
Expand Down Expand Up @@ -60,7 +80,7 @@ test("analyze: with manifest", async (t) => {

const analyzer = new FioriElementsAnalyzer(mockPool);

const stubAnalyzeManifest = sinon.stub(analyzer, "_analyzeManifest").resolves();
const stubAnalyzeManifest = t.context.sinon.stub(analyzer, "_analyzeManifest").resolves();

const name = "MyComponent.js";
await analyzer.analyze({name}, moduleInfo);
Expand All @@ -86,11 +106,11 @@ test("_analyzeManifest: Manifest with TemplateAssembler code", async (t) => {
const moduleInfo = {
addDependency: function() {}
};
const stubAddDependency = sinon.spy(moduleInfo, "addDependency");
const stubAddDependency = t.context.sinon.spy(moduleInfo, "addDependency");

const analyzer = new FioriElementsAnalyzer();

const stubAnalyzeTemplateComponent = sinon.stub(analyzer, "_analyzeTemplateComponent").resolves();
const stubAnalyzeTemplateComponent = t.context.sinon.stub(analyzer, "_analyzeTemplateComponent").resolves();

await analyzer._analyzeManifest(manifest, moduleInfo);

Expand Down Expand Up @@ -130,7 +150,7 @@ test.serial("_analyzeTemplateComponent: Manifest with TemplateAssembler code", a
const moduleInfo = {
addDependency: function() {}
};
const stubAddDependency = sinon.spy(moduleInfo, "addDependency");
const stubAddDependency = t.context.sinon.spy(moduleInfo, "addDependency");

const mockPool = {
async findResource() {
Expand All @@ -142,8 +162,8 @@ test.serial("_analyzeTemplateComponent: Manifest with TemplateAssembler code", a

const analyzer = new FioriElementsAnalyzer(mockPool);

const stubAnalyzeAST = sinon.stub(analyzer, "_analyzeAST").returns("mytpl");
const stubParse = sinon.stub(parseUtils, "parseJS").returns("");
const stubAnalyzeAST = t.context.sinon.stub(analyzer, "_analyzeAST").returns("mytpl");
const stubParse = t.context.sinon.stub(parseUtils, "parseJS").returns("");

await analyzer._analyzeTemplateComponent("pony",
{}, moduleInfo);
Expand All @@ -164,7 +184,7 @@ test.serial("_analyzeTemplateComponent: no default template name", async (t) =>
const moduleInfo = {
addDependency: function() {}
};
const stubAddDependency = sinon.spy(moduleInfo, "addDependency");
const stubAddDependency = t.context.sinon.spy(moduleInfo, "addDependency");

const mockPool = {
async findResource() {
Expand All @@ -176,8 +196,8 @@ test.serial("_analyzeTemplateComponent: no default template name", async (t) =>

const analyzer = new FioriElementsAnalyzer(mockPool);

const stubAnalyzeAST = sinon.stub(analyzer, "_analyzeAST").returns("");
const stubParse = sinon.stub(parseUtils, "parseJS").returns("");
const stubAnalyzeAST = t.context.sinon.stub(analyzer, "_analyzeAST").returns("");
const stubParse = t.context.sinon.stub(parseUtils, "parseJS").returns("");

await analyzer._analyzeTemplateComponent("pony",
{}, moduleInfo);
Expand All @@ -193,7 +213,7 @@ test.serial("_analyzeTemplateComponent: with template name from pageConfig", asy
const moduleInfo = {
addDependency: function() {}
};
const stubAddDependency = sinon.spy(moduleInfo, "addDependency");
const stubAddDependency = t.context.sinon.spy(moduleInfo, "addDependency");

const mockPool = {
async findResource() {
Expand All @@ -205,8 +225,8 @@ test.serial("_analyzeTemplateComponent: with template name from pageConfig", asy

const analyzer = new FioriElementsAnalyzer(mockPool);

const stubAnalyzeAST = sinon.stub(analyzer, "_analyzeAST").returns("");
const stubParse = sinon.stub(parseUtils, "parseJS").returns("");
const stubAnalyzeAST = t.context.sinon.stub(analyzer, "_analyzeAST").returns("");
const stubParse = t.context.sinon.stub(parseUtils, "parseJS").returns("");

await analyzer._analyzeTemplateComponent("pony", {
component: {
Expand All @@ -225,7 +245,7 @@ test.serial("_analyzeTemplateComponent: with template name from pageConfig", asy
stubParse.restore();
});

test("_analyzeAST: get template name from ast", async (t) => {
test("_analyzeAST: get template name from ast", (t) => {
const code = `sap.ui.define(["a", "sap/fe/core/TemplateAssembler"], function(a, TemplateAssembler){
return TemplateAssembler.getTemplateComponent(getMethods,
"sap.fe.templates.Page.Component", {
Expand All @@ -241,11 +261,11 @@ test("_analyzeAST: get template name from ast", async (t) => {
});});`;
const ast = parseUtils.parseJS(code);
const analyzer = new FioriElementsAnalyzer();
const templateName = await analyzer._analyzeAST("sap.fe.templates.Page.Component", ast);
const templateName = analyzer._analyzeAST("sap.fe.templates.Page.Component", ast);
t.is(templateName, "sap.fe.templates.Page.view.Page");
});

test("_analyzeAST: get template name from ast (async function)", async (t) => {
test.serial("_analyzeAST: get template name from ast (async function)", (t) => {
const code = `sap.ui.define(["a", "sap/fe/core/TemplateAssembler"], async function(a, TemplateAssembler){
return TemplateAssembler.getTemplateComponent(getMethods,
"sap.fe.templates.Page.Component", {
Expand All @@ -259,14 +279,16 @@ test("_analyzeAST: get template name from ast (async function)", async (t) => {
"manifest": "json"
}
});});`;
const {FioriElementsAnalyzerWithStubbedLogger, warningLogSpy} = t.context;
const ast = parseUtils.parseJS(code);
const analyzer = new FioriElementsAnalyzer();
const templateName = await analyzer._analyzeAST("sap.fe.templates.Page.Component", ast);
const analyzer = new FioriElementsAnalyzerWithStubbedLogger();
const templateName = analyzer._analyzeAST("sap.fe.templates.Page.Component", ast);
t.is(templateName, "sap.fe.templates.Page.view.Page");
t.is(warningLogSpy.callCount, 1, "Warning log is called once");
});

test("_analyzeAST: get template name from ast (ArrowFunction)", async (t) => {
const code = `sap.ui.define(["a", "sap/fe/core/TemplateAssembler"], (a, TemplateAssembler) => {
test.serial("_analyzeAST: get template name from ast (async ArrowFunction)", (t) => {
const code = `sap.ui.define(["a", "sap/fe/core/TemplateAssembler"], async (a, TemplateAssembler) => {
return TemplateAssembler.getTemplateComponent(getMethods,
"sap.fe.templates.Page.Component", {
metadata: {
Expand All @@ -279,15 +301,17 @@ test("_analyzeAST: get template name from ast (ArrowFunction)", async (t) => {
"manifest": "json"
}
});});`;
const {FioriElementsAnalyzerWithStubbedLogger, warningLogSpy} = t.context;
const ast = parseUtils.parseJS(code);
const analyzer = new FioriElementsAnalyzer();
const templateName = await analyzer._analyzeAST("sap.fe.templates.Page.Component", ast);
const analyzer = new FioriElementsAnalyzerWithStubbedLogger();
const templateName = analyzer._analyzeAST("sap.fe.templates.Page.Component", ast);
t.is(templateName, "sap.fe.templates.Page.view.Page");
t.is(warningLogSpy.callCount, 1, "Warning log is called once");
});

test("_analyzeAST: get template name from ast (ArrowFunction with implicit return)", async (t) => {
test.serial("_analyzeAST: get template name from ast (async ArrowFunction with implicit return)", (t) => {
const code = `sap.ui.define(["a", "sap/fe/core/TemplateAssembler"],
(a, TemplateAssembler) => TemplateAssembler.getTemplateComponent(getMethods,
async (a, TemplateAssembler) => TemplateAssembler.getTemplateComponent(getMethods,
"sap.fe.templates.Page.Component", {
metadata: {
properties: {
Expand All @@ -299,15 +323,37 @@ test("_analyzeAST: get template name from ast (ArrowFunction with implicit retur
"manifest": "json"
}
}));`;
const {FioriElementsAnalyzerWithStubbedLogger, warningLogSpy} = t.context;
const ast = parseUtils.parseJS(code);
const analyzer = new FioriElementsAnalyzerWithStubbedLogger();
const templateName = analyzer._analyzeAST("sap.fe.templates.Page.Component", ast);
t.is(templateName, "sap.fe.templates.Page.view.Page");
t.is(warningLogSpy.callCount, 1, "Warning log is called once");
});

test("_analyzeAST: get template name from ast (ArrowFunction)", (t) => {
const code = `sap.ui.define(["a", "sap/fe/core/TemplateAssembler"], (a, TemplateAssembler) => {
return TemplateAssembler.getTemplateComponent(getMethods,
"sap.fe.templates.Page.Component", {
metadata: {
properties: {
"templateName": {
"type": "string",
"defaultValue": "sap.fe.templates.Page.view.Page"
}
},
"manifest": "json"
}
});});`;
const ast = parseUtils.parseJS(code);
const analyzer = new FioriElementsAnalyzer();
const templateName = await analyzer._analyzeAST("sap.fe.templates.Page.Component", ast);
const templateName = analyzer._analyzeAST("sap.fe.templates.Page.Component", ast);
t.is(templateName, "sap.fe.templates.Page.view.Page");
});

test("_analyzeAST: get template name from ast (async factory function)", async (t) => {
test("_analyzeAST: get template name from ast (ArrowFunction with implicit return)", (t) => {
const code = `sap.ui.define(["a", "sap/fe/core/TemplateAssembler"],
async (a, TemplateAssembler) => TemplateAssembler.getTemplateComponent(getMethods,
(a, TemplateAssembler) => TemplateAssembler.getTemplateComponent(getMethods,
"sap.fe.templates.Page.Component", {
metadata: {
properties: {
Expand All @@ -321,11 +367,11 @@ test("_analyzeAST: get template name from ast (async factory function)", async (
}));`;
const ast = parseUtils.parseJS(code);
const analyzer = new FioriElementsAnalyzer();
const templateName = await analyzer._analyzeAST("sap.fe.templates.Page.Component", ast);
const templateName = analyzer._analyzeAST("sap.fe.templates.Page.Component", ast);
t.is(templateName, "sap.fe.templates.Page.view.Page");
});

test("_analyzeAST: get template name from ast (with SpreadElement)", async (t) => {
test("_analyzeAST: get template name from ast (with SpreadElement)", (t) => {
const code = `sap.ui.define(["a", "sap/fe/core/TemplateAssembler"], (a, TemplateAssembler) => {
const myTemplate = {
templateName: {
Expand All @@ -344,14 +390,14 @@ test("_analyzeAST: get template name from ast (with SpreadElement)", async (t) =
});});`;
const ast = parseUtils.parseJS(code);
const analyzer = new FioriElementsAnalyzer();
const templateName = await analyzer._analyzeAST("sap.fe.templates.Page.Component", ast);
const templateName = analyzer._analyzeAST("sap.fe.templates.Page.Component", ast);

t.is(templateName, "", "The TemplateName is correctly empty");
// TODO: Support SpreadElement
// t.is(templateName, "sap.fe.templates.Page.view.Page", "The TemplateName is correctly determined");
});

test("_analyzeAST: no template name from ast", async (t) => {
test("_analyzeAST: no template name from ast", (t) => {
const code = `sap.ui.define(["a", "sap/fe/core/TemplateAssembler"], function(a, TemplateAssembler){
return TemplateAssembler.getTemplateComponent(getMethods,
"sap.fe.templates.Page.Component", {
Expand All @@ -369,11 +415,10 @@ test("_analyzeAST: no template name from ast", async (t) => {

const analyzer = new FioriElementsAnalyzer();

const stubAnalyzeTemplateClassDefinition = sinon.stub(analyzer,
const stubAnalyzeTemplateClassDefinition = t.context.sinon.stub(analyzer,
"_analyzeTemplateClassDefinition").returns(false);

const result = await analyzer._analyzeAST("pony", ast);

const result = analyzer._analyzeAST("pony", ast);

t.true(stubAnalyzeTemplateClassDefinition.calledOnce, "_analyzeTemplateClassDefinition was called once");

Expand Down
Loading