Use nc parameter if available when generating project

Checks the Code Quarkus openapi for the `nc` parameter.
If it is available for the given Code Quarkus API,
then it will pass `nc=true` to the project generation API
when the user wants to exclude example code,
instead of the deprecated `ne=true` parameter.

Addresses comments on #322

Signed-off-by: David Thompson <[email protected]>

Author: datho7561

.github/workflows/tests.yml

@@ -5,10 +5,8 @@ jobs:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        os: [macos-latest, ubuntu-latest]
+        os: [ubuntu-latest]
         include:
-          - os: macos-latest
-            label: 'darwin'
           - os: ubuntu-latest
             label: 'linux'
     steps:

src/definitions/inputState.ts

@@ -34,7 +34,7 @@ export interface ProjectGenState extends State {
   packageName: string;
   resourceName: string;
   targetDir: Uri;
-  isGenerateSampleCode: boolean;
+  shouldGenerateCode: boolean;
 }
 
 export interface AddExtensionsState extends State {

src/test/vscodeUiTest/suite/projectGenerationTest.ts

@@ -63,7 +63,7 @@ describe('Project generation tests', function() {
    * in the command palette
    */
   it('should open project generation wizard', async function() {
-    this.timeout(30000);
+    this.timeout(60000);
     const wizard: ProjectGenerationWizard = await ProjectGenerationWizard.openWizard(driver);
     expect(await wizardExists(), 'wizard did not open').to.be.true;
     await wizard.cancel();

src/utils/codeQuarkusApiUtils.ts

@@ -22,8 +22,20 @@ import { QuarkusConfig } from "../QuarkusConfig";
 
 const HTTP_MATCHER = new RegExp('^http://');
 
+/**
+ * Represents the capabilities of a Code Quarkus API, such as code.quarkus.io/api or code.quarkus.redhat.com/api
+ */
 export interface CodeQuarkusFunctionality {
-  canExcludeSampleCode: boolean;
+  /**
+   * This Code Quarkus API supports the `ne=...` parameter to specify that example code should not be generated
+   *
+   * @deprecated the `ne=...` parameter will be removed in favour of the `nc=...` parameter
+   */
+  supportsNoExamplesParameter: boolean;
+  /**
+   * This Code Quarkus API supports the `nc=...` to specify that starter code should not be generated
+   */
+  supportsNoCodeParameter: boolean;
 }
 
 /**
@@ -46,7 +58,8 @@ export async function getCodeQuarkusApiFunctionality(): Promise<CodeQuarkusFunct
   const openApiData: any = yaml.load(openApiYaml);
 
   return {
-    canExcludeSampleCode: openApiData?.paths?.['/api/download']?.get?.parameters?.filter(p => p?.name === 'ne').length > 0
+    supportsNoExamplesParameter: openApiData?.paths?.['/api/download']?.get?.parameters?.filter(p => p?.name === 'ne').length > 0,
+    supportsNoCodeParameter: openApiData?.paths?.['/api/download']?.get?.parameters?.filter(p => p?.name === 'nc').length > 0,
   } as CodeQuarkusFunctionality;
 }
 
@@ -57,7 +70,8 @@ export async function getCodeQuarkusApiFunctionality(): Promise<CodeQuarkusFunct
  */
 export function getDefaultFunctionality() {
   return {
-    canExcludeSampleCode: false
+    supportsNoExamplesParameter: false,
+    supportsNoCodeParameter: false,
   } as CodeQuarkusFunctionality;
 }
 

src/utils/requestUtils.ts

@@ -24,6 +24,7 @@ import { QExtension, APIExtension } from '../definitions/QExtension';
 import { Readable } from 'stream';
 import { ZipFile, fromBuffer } from 'yauzl';
 import { convertToQExtension } from '../definitions/QExtension';
+import { CodeQuarkusFunctionality } from './codeQuarkusApiUtils';
 
 const HEADERS = {
   'Client-Name': 'vscode-quarkus',
@@ -65,17 +66,20 @@ function removeDuplicateArtifactIds(extensions: QExtension[]): QExtension[] {
   }, [] as QExtension[]);
 }
 
-export async function downloadProject(state: ProjectGenState): Promise<ZipFile> {
+export async function downloadProject(state: ProjectGenState, codeQuarkusFunctionality: CodeQuarkusFunctionality): Promise<ZipFile> {
   const apiUrl: string = QuarkusConfig.getApiUrl();
   const chosenIds: string[] = state.extensions!.map((it) => `${it.groupId}:${it.artifactId}`);
 
+  const canSpecifyGenerateCode = codeQuarkusFunctionality.supportsNoCodeParameter || codeQuarkusFunctionality.supportsNoExamplesParameter;
+  const parameterToSpecifyGenerateCode = codeQuarkusFunctionality.supportsNoCodeParameter ? 'nc' : 'ne';
+
   const qProjectUrl: string = `${apiUrl}/download?` +
     `b=${state.buildTool.toUpperCase()}&` +
     `g=${state.groupId}&` +
     `a=${state.artifactId}&` +
     `v=${state.projectVersion}&` +
     `c=${state.packageName}.${state.resourceName}&` +
-    `${(state.isGenerateSampleCode === undefined ? '' : `ne=${!state.isGenerateSampleCode}&`)}` +
+    `${(canSpecifyGenerateCode ? `${parameterToSpecifyGenerateCode}=${!state.shouldGenerateCode}&` : '')}` +
     `e=${chosenIds.join('&e=')}`;
 
   const buffer: Buffer = await tryGetProjectBuffer(qProjectUrl);
@@ -109,7 +113,7 @@ function promisify(api) {
 }
 
 async function extract(content: Buffer, path: string): Promise<ZipFile> {
-  const zipfile: ZipFile = (await yauzlFromBuffer(content, {lazyEntries: true})) as ZipFile;
+  const zipfile: ZipFile = (await yauzlFromBuffer(content, { lazyEntries: true })) as ZipFile;
   const openReadStream = promisify(zipfile.openReadStream.bind(zipfile));
 
   zipfile.readEntry();
@@ -121,7 +125,7 @@ async function extract(content: Buffer, path: string): Promise<ZipFile> {
         fs.mkdirSync(mappedPath);
       } else {
         const stream: Readable = (await openReadStream(entry)) as Readable;
-        stream.pipe(fs.createWriteStream(mappedPath, {mode: entry.externalFileAttributes >>> 16}));
+        stream.pipe(fs.createWriteStream(mappedPath, { mode: entry.externalFileAttributes >>> 16 }));
       }
     }
     zipfile.readEntry();

src/wizards/generateProject/generationWizard.ts

@@ -33,7 +33,7 @@ export async function generateProjectWizard() {
   }
 
   const state: Partial<ProjectGenState> = {
-    totalSteps: 7 + (apiCapabilities.canExcludeSampleCode ? 1 : 0)
+    totalSteps: 7 + (apiCapabilities.supportsNoCodeParameter || apiCapabilities.supportsNoExamplesParameter ? 1 : 0)
   };
 
   async function collectInputs(state: Partial<ProjectGenState>) {
@@ -149,18 +149,18 @@ export async function generateProjectWizard() {
     });
     return (input: MultiStepInput) => ExtensionsPicker.createExtensionsPicker(
       input, state, { showLastUsed: true, showRequiredExtensions: true, allowZeroExtensions: true },
-      (apiCapabilities.canExcludeSampleCode ? inputGenerateSampleCode: undefined));
+      (apiCapabilities.supportsNoCodeParameter || apiCapabilities.supportsNoExamplesParameter ? inputGenerateSampleCode : undefined));
   }
 
   async function inputGenerateSampleCode(input: MultiStepInput, state: Partial<ProjectGenState>) {
-    const YES: string = 'Include sample code';
-    const NO: string = 'Do not include sample code';
+    const YES: string = `Include ${apiCapabilities.supportsNoCodeParameter ? 'starter' : 'example'} code`;
+    const NO: string = `Do not include ${apiCapabilities.supportsNoCodeParameter ? 'starter' : 'example'} code`;
     const quickPickItems: QuickPickItem[] = [
-      {label: YES, picked: true},
-      {label: NO}
+      { label: YES, picked: true },
+      { label: NO }
     ];
 
-    state.isGenerateSampleCode = (await input.showQuickPick<QuickPickItem, QuickPickParameters<QuickPickItem>>({
+    state.shouldGenerateCode = (await input.showQuickPick<QuickPickItem, QuickPickParameters<QuickPickItem>>({
       title: INPUT_TITLE,
       placeholder: 'Should sample code be included? Additional dependencies may be added along with the sample.',
       step: input.getStepNumber(),
@@ -176,7 +176,7 @@ export async function generateProjectWizard() {
   const projectGenState: ProjectGenState = state as ProjectGenState;
   saveDefaults(projectGenState);
   deleteFolderIfExists(getNewProjectDirectory(projectGenState));
-  await downloadAndSetupProject(projectGenState);
+  await downloadAndSetupProject(projectGenState, apiCapabilities);
 }
 
 async function getTargetDirectory(projectName: string) {
@@ -249,9 +249,9 @@ function getNewProjectDirectory(state: ProjectGenState): Uri {
   return Uri.file(path.join(state.targetDir.fsPath, state.artifactId));
 }
 
-async function downloadAndSetupProject(state: ProjectGenState): Promise<void> {
+async function downloadAndSetupProject(state: ProjectGenState, codeQuarkusFunctionality: CodeQuarkusFunctionality): Promise<void> {
   const projectDir: Uri = getNewProjectDirectory(state);
-  const zip: ZipFile = await downloadProject(state);
+  const zip: ZipFile = await downloadProject(state, codeQuarkusFunctionality);
   zip.on('end', () => {
     openProject(projectDir);
   });