Skip to content

Commit

Permalink
Feature/project initializer service (#158)
Browse files Browse the repository at this point in the history 
* fix: npm login

previously the login on publish was broken with new versions of npm.
Now it will launch a terminal window for the user to login, which will launch the login flow.
Also it now distributes and installs npm as necessary so we no longer need npm in order to install it.
next we can provide it as a full gui desktop app.

* feat: added project initializer service

* added prompt to select npm account

* improved styling of npm account chooser dialog

* Update integration_tests.yml

Removed java 8 pipelines.  Will no longer be supported

* removed npm account management out of core and into the gui app

* added jdk 8 back to integration tests

* promptForNpmAccount now returns boolean.  false indicates cancel publish
  • Loading branch information
@shannah
shannah authored Dec 31, 2024
1 parent 135d8b0 commit c84d37c
Show file tree
Hide file tree
Showing 20 changed files with 2,162 additions and 434 deletions.
5 changes: 5 additions & 0 deletions bin/env.sh
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
#!/bin/bash
set -e
SCRIPTPATH="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
echo "Adding $SCRIPTPATH to PATH"
export PATH=$SCRIPTPATH:$PATH
0 bin/jdeploy.sh → bin/jdeploy
View file
File renamed without changes.
6 changes: 6 additions & 0 deletions cli/pom.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -101,6 +101,12 @@
<version>4.4.14</version>
</dependency>

<!-- https://mvnrepository.com/artifact/com.vdurmont/semver4j -->
<dependency>
<groupId>com.vdurmont</groupId>
<artifactId>semver4j</artifactId>
<version>2.0.1</version>
</dependency>

<dependency>
<groupId>ca.weblite</groupId>
Expand Down
218 changes: 106 additions & 112 deletions cli/src/main/java/ca/weblite/jdeploy/JDeploy.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@
import ca.weblite.jdeploy.helpers.PackageInfoBuilder;
import ca.weblite.jdeploy.helpers.PrereleaseHelper;
import ca.weblite.jdeploy.npm.NPM;
import ca.weblite.jdeploy.npm.TerminalLoginLauncher;
import ca.weblite.jdeploy.services.*;
import ca.weblite.tools.io.*;
import ca.weblite.tools.platform.Platform;
Expand Down Expand Up @@ -100,6 +101,12 @@ public class JDeploy implements BundleConstants {

private PackageSigningService packageSigningService;

private boolean useManagedNode = false;

private NPM npm = null;

private String npmToken = null;

public static String JDEPLOY_REGISTRY = "https://www.jdeploy.com/";
static {
if (System.getenv("JDEPLOY_REGISTRY_URL") != null) {
Expand All @@ -113,6 +120,22 @@ public class JDeploy implements BundleConstants {
}
}

public void setNpmToken(String token) {
if (!Objects.equals(token, this.npmToken)) {
this.npm = null;
}
this.npmToken = token;
}

private NPM getNPM() {
if (npm == null) {
npm = new NPM(out, err, useManagedNode);
npm.setNpmToken(npmToken);
}

return npm;
}

public PrintStream getOut() {
return out;
}
Expand Down Expand Up @@ -264,6 +287,13 @@ public File getPackageJsonFile() {
}
return packageJsonFile;
}

public void setUseManagedNode(boolean useManagedNode) {
if (this.useManagedNode != useManagedNode) {
this.npm = null;
}
this.useManagedNode = useManagedNode;
}

private File f() {
return getPackageJsonFile();
Expand Down Expand Up @@ -734,7 +764,7 @@ private File[] findJarCandidates() throws IOException {
}
return out.toArray(new File[out.size()]);
}

private File findBestCandidate() throws IOException{
File[] jars = findJarCandidates();
File[] wars = findWarCandidates();
Expand Down Expand Up @@ -1351,120 +1381,74 @@ private static String toTitleCase(String str) {
* @throws IOException
*/
private void init(String commandName, boolean prompt, boolean generateGithubWorkflow) throws IOException {
final int javaVersionInt = new JavaVersionExtractor().extractJavaVersionFromSystemProperties(11);

commandName = directory.getAbsoluteFile().getName().toLowerCase();
if (".".equals(commandName)) {
commandName = directory.getAbsoluteFile().getParentFile().getName().toLowerCase();
ProjectInitializer projectInitializer = DIContext.getInstance().getInstance(ProjectInitializer.class);
boolean dryRun = prompt; // If prompting, then we should do dry run first
ProjectInitializer.Response plan = null;
try {
plan = projectInitializer.decorate(
new ProjectInitializer.Request(
directory.getAbsolutePath(),
null,
dryRun,
generateGithubWorkflow,
null
)
);
} catch (ProjectInitializer.ValidationFailedException e) {
out.println("Validation failed: "+e.getMessage());
return;
}
if (!prompt) {
return;
}
File packageJson = new File(directory, "package.json");
if (packageJson.exists()) {
updatePackageJson(commandName);
} else {
File candidate = findBestCandidate();
if (candidate != null) {
commandName = candidate.getName();
if (commandName.endsWith(".jar") || commandName.endsWith(".war")) {
commandName = commandName.substring(0, commandName.lastIndexOf("."));
}
commandName = commandName.replaceAll("[^a-zA-Z0-9_\\-]", "-");
}

Map m = new HashMap(); // for package.json
m.put("name", commandName);
m.put("version", "1.0.0");
m.put("repository", "");
m.put("description", "");
m.put("main", "index.js");
Map bin = new HashMap();
bin.put(commandName, getBinDir()+"/jdeploy.js");
m.put("bin", bin);
m.put("preferGlobal", true);
m.put("author", "");

Map scripts = new HashMap();
scripts.put("test", "echo \"Error: no test specified\" && exit 1");


m.put("scripts", scripts);
m.put("license", "ISC");
out.println("Creating your package.json file with following content:\n ");
out.println(plan.packageJsonContents);
out.println("");
out.print("Proceed? (y/N)");
final Scanner reader = new Scanner(System.in);
final String response = reader.next();

Map dependencies = new HashMap();
dependencies.put("shelljs", "^0.8.4");
dependencies.put("command-exists-promise", "^2.0.2");
dependencies.put("node-fetch", "2.6.7");
dependencies.put("tar", "^4.4.8");
dependencies.put("yauzl", "^2.10.0");
m.put("dependencies", dependencies);
if (!"y".equals(response.toLowerCase().trim())) {
out.println("Cancelled");
return;
}
if (generateGithubWorkflow && plan.githubWorkflowExists) {
out.print("Would you like to generate a workflow run jDeploy with Github Actions? (y/N)");
final String githubWorkflowResponse = reader.next();
generateGithubWorkflow = "y".equalsIgnoreCase(githubWorkflowResponse.trim());
}

List files = new ArrayList();
files.add("jdeploy-bundle");
try {
projectInitializer.decorate(new ProjectInitializer.Request(
directory.getAbsolutePath(),
plan.jarFilePath,
false,
generateGithubWorkflow,
new ProjectInitializer.Delegate() {
@Override
public void onBeforeWritePackageJson(String path, String contents) {
out.print("Writing " + path+"...");
}

m.put("files", files);
@Override
public void onAfterWritePackageJson(String path, String contents) {
out.println("Done.");
}

Map jdeploy = new HashMap();
if (candidate == null) {
} else if (candidate.getName().endsWith(".jar")) {
jdeploy.put("jar", getRelativePath(candidate));
} else {
jdeploy.put("war", getRelativePath(candidate));
}
@Override
public void onBeforeWriteGithubWorkflow(String path) {
out.print("Writing " + path+"...");
}

jdeploy.put("javaVersion", String.valueOf(javaVersionInt));
jdeploy.put("javafx", false);
jdeploy.put("jdk", false);

String title = toTitleCase(commandName);

jdeploy.put("title", title);

m.put("jdeploy", jdeploy);

final Result res = Result.fromContent(m);
final String jsonStr = res.toString();
final GithubWorkflowGenerator githubWorkflowGenerator = new GithubWorkflowGenerator(directory);
if (prompt) {
out.println("Creating your package.json file with following content:\n ");
out.println(jsonStr);
out.println("");
out.print("Proceed? (y/N)");
final Scanner reader = new Scanner(System.in);
final String response = reader.next();
if ("y".equals(response.toLowerCase().trim())) {
out.println("Writing package.json...");
FileUtils.writeStringToFile(packageJson, jsonStr, "UTF-8");
out.println("Complete!");

if (generateGithubWorkflow && !githubWorkflowGenerator.getGithubWorkflowFile().exists()) {
out.print("Would you like to generate a workflow run jDeploy with Github Actions? (y/N)");
final String githubWorkflowResponse = reader.next();
if ("y".equalsIgnoreCase(githubWorkflowResponse.trim())) {
try {
out.println("Generating Github workflow...");
githubWorkflowGenerator.generateGithubWorkflow(javaVersionInt, "master");
out.println("Github Workflow generated at " + githubWorkflowGenerator.getGithubWorkflowFile());
} catch (IOException ex) {
err.println("Failed to generate workflow file");
ex.printStackTrace(err);
}
@Override
public void onAfterWriteGithubWorkflow(String path) {
out.println("Done.");
}
}
} else {
out.println("Cancelled");
}
} else {
FileUtils.writeStringToFile(packageJson, jsonStr, "UTF-8");
if (generateGithubWorkflow && !githubWorkflowGenerator.getGithubWorkflowFile().exists()) {
try {
out.println("Generating Github workflow...");
githubWorkflowGenerator.generateGithubWorkflow(javaVersionInt, "master");
out.println("Github Workflow generated at " + githubWorkflowGenerator.getGithubWorkflowFile());
} catch (IOException ex) {
err.println("Failed to generate workflow file");
ex.printStackTrace(err);
}
}
}
));
} catch (ProjectInitializer.ValidationFailedException e) {
out.println("Validation failed: "+e.getMessage());
}
}

Expand Down Expand Up @@ -2128,7 +2112,7 @@ private void _package(BundlerSettings bundlerSettings) throws IOException {
private void install() throws IOException {

_package();
new NPM(out, err).link(exitOnFail);
getNPM().link(exitOnFail);
}

private File getGithubReleaseFilesDir() {
Expand Down Expand Up @@ -2218,12 +2202,12 @@ private void uploadResources() throws IOException {
}

private JSONObject fetchPackageInfoFromNpm(String packageName, String source) throws IOException {
return new NPM(out, err).fetchPackageInfoFromNpm(packageName, source);
return getNPM().fetchPackageInfoFromNpm(packageName, source);

}

private boolean isVersionPublished(String packageName, String version, String source) {
return new NPM(out, err).isVersionPublished(packageName, version, source);
return getNPM().isVersionPublished(packageName, version, source);
}

// This variable is set in prepublish(). It points to a directory where the publishable
Expand Down Expand Up @@ -2381,7 +2365,7 @@ public void prepareGithubRelease(BundlerSettings bundlerSettings, InputStream ol

JSONObject packageJSON = prepublish(bundlerSettings);
getGithubReleaseFilesDir().mkdirs();
new NPM(out, err).pack(publishDir, getGithubReleaseFilesDir(), exitOnFail);
getNPM().pack(publishDir, getGithubReleaseFilesDir(), exitOnFail);
saveGithubReleaseFiles();
PackageInfoBuilder builder = new PackageInfoBuilder();
if (oldPackageInfo != null) {
Expand Down Expand Up @@ -2409,11 +2393,15 @@ public void prepareGithubRelease(BundlerSettings bundlerSettings, InputStream ol
}

public void publish() throws IOException {
publish(null);
}

public void publish(String npmToken) throws IOException {
if (alwaysPackageOnPublish) {
_package();
}
JSONObject packageJSON = prepublish(new BundlerSettings());
new NPM(out, err).publish(publishDir, exitOnFail);
getNPM().publish(publishDir, exitOnFail);
out.println("Package published to npm successfully.");
out.println("Waiting for npm to update its registry...");

Expand Down Expand Up @@ -2650,7 +2638,13 @@ public static void main(String[] args) {
}
}

if ("dmg".equals(stripFlags(args)[0])) {
if ("login".equals(args[0])) {
new NPMLoginController().run();
System.exit(0);
} else if ("launch-login".equals(args[0])) {
TerminalLoginLauncher.launchLoginTerminal();
System.exit(0);
} else if ("dmg".equals(stripFlags(args)[0])) {
prog.overrideInstallers(BUNDLE_MAC_X64_DMG, BUNDLE_MAC_ARM64_DMG);
BundlerSettings bundlerSettings = new BundlerSettings();
bundlerSettings.setAutoUpdateEnabled(isWithAutoUpdateEnabled(args));
Expand Down
17 changes: 17 additions & 0 deletions cli/src/main/java/ca/weblite/jdeploy/cli/controllers/NPMLoginController.java
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
package ca.weblite.jdeploy.cli.controllers;

import ca.weblite.jdeploy.npm.NPM;

import java.io.IOException;

public class NPMLoginController {

public void run() {
NPM npm = new NPM(System.out, System.err, true);
try {
npm.startInteractiveLogin();
} catch (IOException e) {
throw new RuntimeException(e);
}
}
}
1 change: 1 addition & 0 deletions cli/src/main/java/ca/weblite/jdeploy/cli/di/JDeployCliModule.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,4 +24,5 @@ public ChatThreadDispatcher promptHandler(CliChatThreadDispatcher impl) {
public ProjectLoader projectLoader(DefaultProjectLoader impl) {
return impl;
}

}
Loading

0 comments on commit c84d37c

Please sign in to comment.