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

Jump to bottom

fetch list of popular archetypes on the fly #63

Merged
merged 3 commits into from
Jun 8, 2018
Merged

fetch list of popular archetypes on the fly #63

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
bb7839f
fetch list of popular archetypes on the fly
Eskibear Jun 7, 2018
7d72673
change wording
Eskibear Jun 7, 2018
d955232
use constant for URL
Eskibear Jun 8, 2018
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
14 changes: 7 additions & 7 deletions package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion resources/archetypes.json
View file
Open in desktop

Large diffs are not rendered by default.

40 changes: 22 additions & 18 deletions src/ArchetypeModule.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import { Utils } from "./Utils";
import { VSCodeUI } from "./VSCodeUI";
// tslint:disable-next-line:no-http-string
const REMOTE_ARCHETYPE_CATALOG_URL: string = "http://repo.maven.apache.org/maven2/archetype-catalog.xml";

const POPULAR_ARCHETYPES_URL: string = "https://vscodemaventelemetry.blob.core.windows.net/public/popular_archetypes.json";
class Step {
public readonly name: string;
public readonly info: string;
Expand Down Expand Up @@ -50,7 +50,7 @@ export namespace ArchetypeModule {
}

export async function updateArchetypeCatalog(): Promise<void> {
const xml: string = await Utils.httpGetContent(REMOTE_ARCHETYPE_CATALOG_URL);
const xml: string = await Utils.downloadFile(REMOTE_ARCHETYPE_CATALOG_URL, true);
const archetypes: Archetype[] = await Utils.listArchetypeFromXml(xml);
const targetFilePath: string = path.join(Utils.getPathToExtensionRoot(), "resources", "archetypes.json");
await fs.ensureFile(targetFilePath);
Expand All @@ -63,7 +63,7 @@ export namespace ArchetypeModule {
(item: Archetype) => item.artifactId ? `$(package) ${item.artifactId} ` : "More ...",
(item: Archetype) => item.groupId ? `${item.groupId}` : "",
(item: Archetype) => item.description,
{ matchOnDescription: true, placeHolder: "Select archetype with <groupId>:<artifactId> ..." }
{ matchOnDescription: true, placeHolder: "Select an archetype ..." }
);
}

Expand Down Expand Up @@ -110,21 +110,25 @@ export namespace ArchetypeModule {
}

async function getRecomendedItems(allItems: Archetype[]): Promise<Archetype[]> {
// tslint:disable-next-line:no-suspicious-comment
// TODO: should not hard code.
// Top 10 popular archetypes according to usage data
const fixedList: string[] = [
"org.apache.maven.archetypes:maven-archetype-quickstart",
"org.apache.maven.archetypes:maven-archetype-archetype",
"org.apache.maven.archetypes:maven-archetype-webapp",
"org.apache.maven.archetypes:maven-archetype-j2ee-simple",
"com.microsoft.azure:azure-functions-archetype",
"am.ik.archetype:maven-reactjs-blank-archetype",
"com.microsoft.azure.gateway.archetypes:gateway-module-simple",
"org.apache.maven.archetypes:maven-archetype-site-simple",
"com.github.ngeor:archetype-quickstart-jdk8",
"org.apache.maven.archetypes:maven-archetype-plugin"
];
// Top popular archetypes according to usage data
let fixedList: string[];
try {
const rawlist: string = await Utils.downloadFile(POPULAR_ARCHETYPES_URL, true);
fixedList = JSON.parse(rawlist);
} catch (error) {
fixedList = [
"org.apache.maven.archetypes:maven-archetype-quickstart",
"org.apache.maven.archetypes:maven-archetype-archetype",
"org.apache.maven.archetypes:maven-archetype-webapp",
"org.apache.maven.archetypes:maven-archetype-j2ee-simple",
"com.microsoft.azure:azure-functions-archetype",
"am.ik.archetype:maven-reactjs-blank-archetype",
"com.microsoft.azure.gateway.archetypes:gateway-module-simple",
"org.apache.maven.archetypes:maven-archetype-site-simple",
"com.github.ngeor:archetype-quickstart-jdk8",
"org.apache.maven.archetypes:maven-archetype-plugin"
];
}
return fixedList.map((fullname: string) => allItems.find((item: Archetype) => fullname === `${item.groupId}:${item.artifactId}`));
}
}
65 changes: 48 additions & 17 deletions src/Utils.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,12 @@

import * as fse from "fs-extra";
import * as http from "http";
import * as https from "https";
import * as md5 from "md5";
import * as minimatch from "minimatch";
import * as os from "os";
import * as path from "path";
import * as url from "url";
import { ExtensionContext, extensions, Uri, workspace } from 'vscode';
import * as xml2js from "xml2js";
import { Archetype } from "./model/Archetype";
Expand Down Expand Up @@ -52,6 +54,10 @@ export namespace Utils {
return path.join(os.tmpdir(), EXTENSION_NAME, ...args);
}

export function getTempFolder(): string {
return path.join(os.tmpdir(), getExtensionId());
}

export function getPathToExtensionRoot(...args: string[]): string {
return path.join(extensions.getExtension(getExtensionId()).extensionPath, ...args);
}
Expand Down Expand Up @@ -161,27 +167,52 @@ export namespace Utils {
return path.join(Utils.getPathToExtensionRoot(), "resources", "archetype-catalog.xml");
}

export async function httpGetContent(url: string): Promise<string> {
const filepath: string = getTempFolderPath(md5(url));
if (await fse.pathExists(filepath)) {
await fse.unlink(filepath);
export async function downloadFile(targetUrl: string, readContent?: boolean, customHeaders?: {}): Promise<string> {
const tempFilePath: string = path.join(getTempFolder(), md5(targetUrl));
await fse.ensureDir(getTempFolder());
if (await fse.pathExists(tempFilePath)) {
await fse.remove(tempFilePath);
}
await fse.ensureFile(filepath);
const file: fse.WriteStream = fse.createWriteStream(filepath);
return new Promise<string>(
(resolve: (value: string) => void, reject: (e: Error) => void): void => {
const request: http.ClientRequest = http.get(url, (response: http.IncomingMessage) => {
response.pipe(file);
file.on('finish', async () => {
file.close();
const buf: Buffer = await fse.readFile(filepath);
resolve(buf.toString());
});

return await new Promise((resolve: (res: string) => void, reject: (e: Error) => void): void => {
const urlObj: url.Url = url.parse(targetUrl);
const options: Object = Object.assign({ headers: Object.assign({}, customHeaders, { 'User-Agent': `vscode/${getExtensionVersion()}` }) }, urlObj);
let client: any;
if (urlObj.protocol === "https:") {
client = https;
// tslint:disable-next-line:no-http-string
} else if (urlObj.protocol === "http:") {
client = http;
} else {
return reject(new Error("Unsupported protocol."));
}
client.get(options, (res: http.IncomingMessage) => {
let rawData: string;
let ws: fse.WriteStream;
if (readContent) {
rawData = "";
} else {
ws = fse.createWriteStream(tempFilePath);
}
res.on('data', (chunk: string | Buffer) => {
if (readContent) {
rawData += chunk;
} else {
ws.write(chunk);
}
});
request.on("error", (e: Error) => {
reject(e);
res.on('end', () => {
if (readContent) {
resolve(rawData);
} else {
ws.end();
resolve(tempFilePath);
}
});
}).on("error", (err: Error) => {
reject(err);
});
});
}

export async function findAllInDir(currentPath: string, targetFileName: string, depth: number, exclusion: string[] = ["**/.*"]): Promise<string[]> {
Expand Down