#224 - Run In Place and Use Provided Startup Script features #334

jeffrpowell · 2021-12-01T17:22:49Z

Implemented two new features:

Run In Place:
- When disabled (default; same behavior as before), newly added servers will have parts of their folder structure copied to a separate workspace (specified by the 'Tomcat Servers workspace' setting).
- When this setting is enabled, newly added servers are managed and run in their original location.
- Changing the setting has no effect on previously added servers
Use Provided Startup/Shutdown Scripts
- When disabled (default; same behavior as before), the extension will manually run Java and load the necessary tomcat jar files into the classpath.
- When this setting is enabled, the extension will attempt to execute the .bat/.sh files that come with fresh tomcat installations to start and stop the server.

…er from its originally installed location

…e plumbing is done just not running script correctly; fixed bug that caused runInPlace servers to be set as copied servers when closing and reopening VSC

… with catalina_opts and the fact that the startup script spawns another window

…tdown scripts! Just need to fix debugging while using startup scripts

…s using the provided scripts

jeffrpowell · 2021-12-01T17:25:09Z

src/DialogMessage.ts

    export const invalidWebappFolder: string = localize('tomcatExt.invalidWebappFolder', 'The folder is not a valid web app to run on Tomcat Server.');
    export const invalidWarFile: string = localize('tomcatExt.invalidWarFile', 'Please select a .war file.');
    export const pickFolderToGenerateWar: string = localize('tomcatExt.pickFolderToGenerateWar', 'Please select the folder(s) you want to generate war package');
+    export const serverAlreadyAdded: string = localize('tomcatExt.serverAlreadyAdded', 'That server has already been added to the list.');


New error condition when using the Run In Place feature. It was previously impossible to have two server entries pointing to the same CATALINA_BASE.

jeffrpowell · 2021-12-01T17:26:47Z

src/Tomcat/TomcatController.ts

-        Utility.infoTelemetryStep(operationId, 'construct server name');
-        const existingServerNames: string[] = this._tomcatModel.getServerSet().map((item: TomcatServer) => { return item.getName(); });
-        const serverName: string = await Utility.getServerName(tomcatInstallPath, this._tomcatModel.defaultStoragePath, existingServerNames);
-        const catalinaBasePath: string = await Utility.getServerStoragePath(this._tomcatModel.defaultStoragePath, serverName);
-        await fse.remove(catalinaBasePath);
-        await Utility.trackTelemetryStep(operationId, 'copy files', () => Promise.all([
-            fse.copy(path.join(tomcatInstallPath, 'conf'), path.join(catalinaBasePath, 'conf'), {dereference: true}),
-            fse.copy(path.join(this._extensionPath, 'resources', 'jvm.options'), path.join(catalinaBasePath, 'jvm.options')),
-            fse.copy(path.join(this._extensionPath, 'resources', 'index.jsp'), path.join(catalinaBasePath, 'webapps', 'ROOT', 'index.jsp')),
-            fse.copy(path.join(this._extensionPath, 'resources', 'icon.png'), path.join(catalinaBasePath, 'webapps', 'ROOT', 'icon.png')),
-            fse.mkdirs(path.join(catalinaBasePath, 'logs')),
-            fse.mkdirs(path.join(catalinaBasePath, 'temp')),
-            fse.mkdirs(path.join(catalinaBasePath, 'work'))
-        ]));
-
-        await Utility.copyServerConfig(path.join(tomcatInstallPath, 'conf', 'server.xml'), path.join(catalinaBasePath, 'conf', 'server.xml'));
-        const tomcatServer: TomcatServer = new TomcatServer(serverName, tomcatInstallPath, catalinaBasePath);
-        Utility.trackTelemetryStep(operationId, 'add server', () => this._tomcatModel.addServer(tomcatServer));
-        return tomcatServer;


All of this code was preserved and moved to a separate addServerToWorkspace function below

jeffrpowell · 2021-12-01T17:28:36Z

src/Tomcat/TomcatController.ts

+    private async addInPlaceServer(operationId: string, tomcatInstallPath: string, runInPlace: boolean) : Promise<TomcatServer> {
+        Utility.infoTelemetryStep(operationId, 'construct server name');
+        const existingServerNames: string[] = this._tomcatModel.getServerSet().map((item: TomcatServer) => { return item.getName(); });
+        const serverName: string = await Utility.getServerName(tomcatInstallPath, this._tomcatModel.defaultStoragePath, existingServerNames, runInPlace);
+        const tomcatServer: TomcatServer = new TomcatServer(serverName, tomcatInstallPath, tomcatInstallPath, runInPlace);
+        Utility.trackTelemetryStep(operationId, 'add server', () => this._tomcatModel.addServer(tomcatServer));
+        return tomcatServer;
+    }


This is new code that handles adding a new in-place server.

jeffrpowell · 2021-12-01T17:30:21Z

src/Tomcat/TomcatController.ts

            }
-            startArguments.push('start');
-            const javaProcess: Promise<void> = Utility.executeCMD(this._outputChannel, serverInfo.getName(), Utility.getJavaExecutable(), { shell: true }, ...startArguments);
+            process = Utility.executeCMD(this._outputChannel, serverInfo.getName(), Utility.getStartExecutable(serverInfo.getInstallPath()), { env: await this._tomcatModel.getEnvironmentVars(serverInfo, true), shell: true }, true, ...startArguments);


Notable thing that changed: explicitly supplying the correct CATALINA_HOME, CATALINA_BASE, and JPDA_OPTS environment variables to the shell.

jeffrpowell · 2021-12-01T17:31:40Z

src/Tomcat/TomcatModel.ts

        try {
            await fse.outputJson(this._serversJsonFile, this._serverList.map((s: TomcatServer) => {
-                return { _name: s.getName(), _installPath: s.getInstallPath(), _storagePath: s.getStoragePath() };
+                return { _name: s.getName(), _installPath: s.getInstallPath(), _storagePath: s.getStoragePath(), _runInPlace: s.isRunInPlace() };


The "Delete server" behavior had to change based on if the server was in-place or copied to the workspace, so I had to add this new param to the TomcatModel

jeffrpowell · 2021-12-01T17:32:42Z

src/Tomcat/TomcatModel.ts


-    public async updateJVMOptions(serverName: string) : Promise<void> {
-        const server: TomcatServer = this.getTomcatServer(serverName);
+    public async updateJVMOptions(server: TomcatServer) : Promise<void> {


This method didn't semantically change much. Just sent portions of it to separate functions so that the branching changes I implemented were clearer to maintain.

jeffrpowell · 2021-12-01T17:34:02Z

src/Utility.ts

+        function spawnWindowsScript(scriptFile: string, args: string[], options: child_process.SpawnOptions): child_process.ChildProcess {
+            args.unshift(scriptFile);
+            const quotedArgs: string = '"'.concat(args.reduce((accumulator: string, currentVal: string) => accumulator.concat(" ", currentVal), ""), '"');
+            return child_process.spawn(Constants.WINDOWS_CMD, ['/c', quotedArgs], options);
+        }


Windows can't straight spawn a .bat script file. You have to spawn cmd.exe and pass the .bat file as an arg instead.

jeffrpowell · 2021-12-01T17:35:44Z

I ran manual tests on all combinations of in-place/copied-to-workspace servers and starting/debugging/stopping manually/with provided tomcat scripts. Everything seems to be in working order to me.

jeffrpowell added 5 commits November 27, 2021 06:46

adashen#224 - created new Run In Place setting to run the tomcat serv…

48bf5c2

…er from its originally installed location

adashen#224 WIP; added new tomcat startup scripts setting, most of th…

b27412c

…e plumbing is done just not running script correctly; fixed bug that caused runInPlace servers to be set as copied servers when closing and reopening VSC

adashen#224 - WIP: successfully executing startup script; now dealing…

8be8dac

… with catalina_opts and the fact that the startup script spawns another window

adashen#224 - WIP; successfully running server off of startup and shu…

e488cf7

…tdown scripts! Just need to fix debugging while using startup scripts

adashen#224 - finished the ability to run, debug, and shutdown server…

598c757

…s using the provided scripts

jeffrpowell commented Dec 1, 2021

View reviewed changes

jeffrpowell marked this pull request as ready for review December 1, 2021 17:35

jeffrpowell mentioned this pull request Dec 1, 2021

Can't change CATALINA_BASE #224

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

#224 - Run In Place and Use Provided Startup Script features #334

#224 - Run In Place and Use Provided Startup Script features #334

Uh oh!

jeffrpowell commented Dec 1, 2021

Uh oh!

jeffrpowell Dec 1, 2021

Uh oh!

jeffrpowell Dec 1, 2021

Uh oh!

jeffrpowell Dec 1, 2021

Uh oh!

jeffrpowell Dec 1, 2021

Uh oh!

jeffrpowell Dec 1, 2021

Uh oh!

jeffrpowell Dec 1, 2021

Uh oh!

jeffrpowell Dec 1, 2021

Uh oh!

jeffrpowell commented Dec 1, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

#224 - Run In Place and Use Provided Startup Script features #334

Are you sure you want to change the base?

#224 - Run In Place and Use Provided Startup Script features #334

Uh oh!

Conversation

jeffrpowell commented Dec 1, 2021

Uh oh!

jeffrpowell Dec 1, 2021

Choose a reason for hiding this comment

Uh oh!

jeffrpowell Dec 1, 2021

Choose a reason for hiding this comment

Uh oh!

jeffrpowell Dec 1, 2021

Choose a reason for hiding this comment

Uh oh!

jeffrpowell Dec 1, 2021

Choose a reason for hiding this comment

Uh oh!

jeffrpowell Dec 1, 2021

Choose a reason for hiding this comment

Uh oh!

jeffrpowell Dec 1, 2021

Choose a reason for hiding this comment

Uh oh!

jeffrpowell Dec 1, 2021

Choose a reason for hiding this comment

Uh oh!

jeffrpowell commented Dec 1, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant