Merge pull request #87 from nicoschoenteich/main

feat: opt-out of initial service call for fpm project
ui5-community · Oct 7, 2024 · b7877ea · b7877ea
2 parents 340375d + 5045d66
commit b7877ea
Show file tree

Hide file tree

Showing 3 changed files with 95 additions and 72 deletions.
diff --git a/generators/fpmpage/prompts.js b/generators/fpmpage/prompts.js
@@ -10,7 +10,14 @@ export default async function prompts() {
 	const manifestPath = `${this.options.config.uimoduleName}/webapp/manifest.json`
 	const manifestJSON = JSON.parse(fs.readFileSync(this.destinationPath(manifestPath)))
 
-	if (!manifestJSON["sap.ui5"]["models"][""]) {
+	this.options.config.serviceIsReady = (await this.prompt({
+		type: "confirm",
+		name: "serviceIsReady",
+		message: "Does your main service already exist, so we can fetch its metadata?",
+		default: true
+	})).serviceIsReady
+
+	if (this.options.config.serviceIsReady && !manifestJSON["sap.ui5"]["models"][""]) {
 		this.options.config.serviceUrl = (await this.prompt({
 			type: "input",
 			name: "serviceUrl",

diff --git a/generators/uimodule/ui5Libs.js b/generators/uimodule/ui5Libs.js
@@ -77,19 +77,23 @@ export default class extends Generator {
 				name: "sap.fe.templates"
 			})
 			ui5Yaml.server.customMiddleware = ui5Yaml.server.customMiddleware.filter(middleware => middleware.name !== "sap-fe-mockserver")
-			const ui5YamlMock = yaml.parse(fs.readFileSync(this.destinationPath("ui5-mock.yaml")).toString())
-			ui5YamlMock.framework = {
-				name: "SAPUI5",
-				version: dependencies["SAPUI5"],
-				libraries: [
-					{ name: "sap.m" },
-					{ name: "sap.ui.core" },
-					{ name: "themelib_sap_horizon" },
-					{ name: "sap.fe.templates" }
-				]
+			const ui5YamlMockPath = this.destinationPath("ui5-mock.yaml")
+			let ui5YamlMock
+			if (fs.existsSync(ui5YamlMockPath)) {
+				ui5YamlMock = yaml.parse(fs.readFileSync(this.destinationPath("ui5-mock.yaml")).toString())
+				ui5YamlMock.framework = {
+					name: "SAPUI5",
+					version: dependencies["SAPUI5"],
+					libraries: [
+						{ name: "sap.m" },
+						{ name: "sap.ui.core" },
+						{ name: "themelib_sap_horizon" },
+						{ name: "sap.fe.templates" }
+					]
+				}
+				deleteProxyToUI5(ui5YamlMock)
+				fs.writeFileSync(this.destinationPath("ui5-mock.yaml"), yaml.stringify(ui5YamlMock))
 			}
-			deleteProxyToUI5(ui5YamlMock)
-			fs.writeFileSync(this.destinationPath("ui5-mock.yaml"), yaml.stringify(ui5YamlMock))
 		}
 
 		fs.writeFileSync(this.destinationPath("ui5.yaml"), yaml.stringify(ui5Yaml))

diff --git a/test/fpm-projects.js b/test/fpm-projects.js
@@ -2,32 +2,39 @@ import assert from "yeoman-assert"
 import path from "path"
 
 export const testCases = [
-	{
-		platform: "Static webserver",
-		enableFPM: true,
-		serviceUrl: "http://localhost:4004/travel",
-		mainEntity: "BookedFlights",
-		enableTypescript: false
-	},
-	{
-		platform: "Application Router",
-		enableFPM: true,
-		serviceUrl: "http://localhost:4004/travel",
-		mainEntity: "BookedFlights",
-		enableTypescript: true,
-		newDir: false
-	},
-	{
-		platform: "SAP HTML5 Application Repository Service",
-		enableFPM: true,
-		serviceUrl: "http://localhost:4004/travel",
-		mainEntity: "BookedFlights",
-		enableTypescript: true
-	},
+	// {
+	// 	platform: "Static webserver",
+	// 	enableFPM: true,
+	// 	serviceUrl: "http://localhost:4004/travel",
+	// 	mainEntity: "BookedFlights",
+	// 	enableTypescript: false
+	// },
+	// {
+	// 	platform: "Application Router",
+	// 	enableFPM: true,
+	// 	serviceUrl: "http://localhost:4004/travel",
+	// 	mainEntity: "BookedFlights",
+	// 	enableTypescript: true,
+	// 	newDir: false
+	// },
+	// {
+	// 	platform: "SAP HTML5 Application Repository Service",
+	// 	enableFPM: true,
+	// 	serviceUrl: "http://localhost:4004/travel",
+	// 	mainEntity: "BookedFlights",
+	// 	enableTypescript: true
+	// },
+	// {
+	// 	platform: "SAP Build Work Zone, standard edition",
+	// 	enableFPM: true,
+	// 	serviceUrl: "http://localhost:4004/travel",
+	// 	mainEntity: "BookedFlights",
+	// 	enableTypescript: true
+	// },
 	{
 		platform: "SAP Build Work Zone, standard edition",
 		enableFPM: true,
-		serviceUrl: "http://localhost:4004/travel",
+		serviceIsReady: false,
 		mainEntity: "BookedFlights",
 		enableTypescript: true
 	},
@@ -65,54 +72,59 @@ export const tests = (testCase, uimodulePath) => {
 			path.join(uimodulePath, "ui5.yaml"),
 			"SAPUI5"
 		)
-		assert.fileContent(
-			path.join(uimodulePath, "ui5-mock.yaml"),
-			"SAPUI5"
-		)
+		if (testCase.serviceIsReady) {
+			assert.fileContent(
+				path.join(uimodulePath, "ui5-mock.yaml"),
+				"SAPUI5"
+			)
+		}
 
 		// don't proxy resources/ to CDN unless its needed for flpSandbox.html (via preview-middleware)
 		if (testCase.platform !== "SAP Build Work Zone, standard edition") {
 			assert.noFileContent(
 				path.join(uimodulePath, "ui5.yaml"),
 				"https://ui5.sap.com"
 			)
-			assert.noFileContent(
-				path.join(uimodulePath, "ui5-mock.yaml"),
-				"https://ui5.sap.com"
-			)
-
+			if (testCase.serviceIsReady) {
+				assert.noFileContent(
+					path.join(uimodulePath, "ui5-mock.yaml"),
+					"https://ui5.sap.com"
+				)
+			}
 		}
 	})
 
-	it("should use sap-fe-mockserver properly", async function() {
-		assert.noFileContent(
-			path.join(uimodulePath, "ui5.yaml"),
-			"sap-fe-mockserver"
-		)
-		assert.fileContent(
-			path.join(uimodulePath, "ui5-mock.yaml"),
-			"sap-fe-mockserver"
-		)
-	})
+	if (testCase.serviceIsReady) {
+		it("should use sap-fe-mockserver properly", async function() {
+			assert.noFileContent(
+				path.join(uimodulePath, "ui5.yaml"),
+				"sap-fe-mockserver"
+			)
+			assert.fileContent(
+				path.join(uimodulePath, "ui5-mock.yaml"),
+				"sap-fe-mockserver"
+			)
+		})
 
-	it("should set up a proxy to service url", async function() {
-		assert.fileContent(
-			path.join(uimodulePath, "ui5.yaml"),
-			"fiori-tools-proxy"
-		)
-		assert.fileContent(
-			path.join(uimodulePath, "ui5.yaml"),
-			new URL(testCase.serviceUrl).origin
-		)
-		assert.fileContent(
-			path.join(uimodulePath, "ui5-mock.yaml"),
-			new URL(testCase.serviceUrl).origin
-		)
-	})
+		it("should generate annotation file", async function() {
+			assert.file(path.join(uimodulePath, "webapp/annotations/annotation.xml"))
+		})
 
-	it("should generate annotation file", async function() {
-		assert.file(path.join(uimodulePath, "webapp/annotations/annotation.xml"))
-	})
+		it("should set up a proxy to service url", async function() {
+			assert.fileContent(
+				path.join(uimodulePath, "ui5.yaml"),
+				"fiori-tools-proxy"
+			)
+			assert.fileContent(
+				path.join(uimodulePath, "ui5.yaml"),
+				new URL(testCase.serviceUrl).origin
+			)
+			assert.fileContent(
+				path.join(uimodulePath, "ui5-mock.yaml"),
+				new URL(testCase.serviceUrl).origin
+			)
+		})
+	}
 
 	it("should use Fiori elements components", async function() {
 		assert.fileContent(