Issue #10437 - Refactor Local Deployment Scanning #12583

joakime · 2024-11-26T21:48:34Z

A single scanner for all Environments.
Environment attributes are how the environment specific deployment configuration is controlled.
Existing properties behaviors maintained.
Moved optional Environment XML resolution from ${jetty.base}/webapps/<env>.xml to ${jetty.base}/environments/<env>.xml to avoid name collision with deployable XML contexts.

…ify-deploy

...-core/jetty-deploy/src/main/java/org/eclipse/jetty/deploy/providers/ScanningAppProvider.java

jetty-core/jetty-deploy/src/main/java/org/eclipse/jetty/deploy/providers/ContextProvider.java

jetty-core/jetty-deploy/src/main/config/etc/jetty-deploy.xml

...loy/src/test/java/org/eclipse/jetty/deploy/providers/ContextProviderDeferredStartupTest.java

...ploy/src/test/java/org/eclipse/jetty/deploy/providers/ContextProviderRuntimeUpdatesTest.java

...etty-deploy/src/test/java/org/eclipse/jetty/deploy/providers/ContextProviderStartupTest.java

jetty-core/jetty-server/src/main/java/org/eclipse/jetty/server/Deployable.java

jetty-ee10/jetty-ee10-webapp/src/main/java/org/eclipse/jetty/ee10/webapp/WebAppContext.java

jetty-core/jetty-deploy/src/main/java/org/eclipse/jetty/deploy/providers/ContextProvider.java

jetty-core/jetty-deploy/src/main/config/etc/jetty-deployment-manager.xml

jetty-core/jetty-deploy/src/main/config/modules/deployment-manager.mod

sbordet · 2024-12-10T12:06:13Z

I'd like to see:

alphabetical sort of scanned files
DeploymentManager does not need to know AppProviders. It's AppProviders that call the DeploymentManager to deploy Apps. AppProviders can just be added as beans to DeploymentManager
Documentation
ContextProvider renamed to something more telling. DeploymentScanningAppProvider? The word "Context" has no meaning in this class, and it is lost in the current class name that it is a ScanningAppProvider.

jetty-core/jetty-deploy/src/main/java/org/eclipse/jetty/deploy/providers/ContextProvider.java

gregw · 2025-03-12T15:34:48Z

@joakime @sbordet I've almost convinced myself that we should do the following renames:

DirectDeployer -> StandardDeployer
PathContextHandlerFactory -> StandardContextHandlerFactory

I could be convinced to do s/Standard/Default/. Yes I know I've argued against both of these before.... but if both the interface implementations are named the same way, it makes more sense.

joakime · 2025-03-12T15:39:51Z

@joakime @sbordet I've almost convinced myself that we should do the following renames:
* `DirectDeployer` -> `StandardDeployer`

* `PathContextHandlerFactory` -> `StandardContextHandlerFactory`
I could be convinced to do s/Standard/Default/. Yes I know I've argued against both of these before.... but if both the interface implementations are named the same way, it makes more sense.

Looking at the current jetty-deploy, we see only the following java files now ...

[joakim@hyperion 12.1.x][fix/12.1.x/unify-deploy*]$ ls -la jetty-core/jetty-deploy/src/main/java/org/eclipse/jetty/deploy/
total 116
drwxrwxr-x 2 joakim joakim  4096 Mar 12 08:59 .
drwxrwxr-x 3 joakim joakim  4096 Mar  3  2022 ..
-rw-rw-r-- 1 joakim joakim  3662 Mar 12 08:59 ContextHandlerFactory.java
-rw-rw-r-- 1 joakim joakim  5938 Mar 12 08:39 Deployer.java
-rw-rw-r-- 1 joakim joakim 61407 Mar 12 08:42 DeploymentScanner.java
-rw-rw-r-- 1 joakim joakim 10159 Mar 12 08:39 DirectDeployer.java
-rw-rw-r-- 1 joakim joakim   647 Mar 12 08:41 package-info.java
-rw-rw-r-- 1 joakim joakim 18949 Mar 10 11:18 PathsContextHandlerFactory.java

I can see it just being 4 files ...

Deployer - what the DirectDeployer is now
ContextScanner - what the DeploymentScanner is
StandardContextHandlerFactory - what the PathsContextHandlerFactory is
ContextHandlerFactory - no change

janbartel · 2025-03-12T15:54:27Z

I can see it just being 4 files ...

Deployer - what the DirectDeployer is now

ContextScanner - what the DeploymentScanner is

StandardContextHandlerFactory - what the PathsContextHandlerFactory is

ContextHandlerFactory - no change

It still seems the wrong way around that we configure something called a Scanner that then hands off to a Deployer. It still seems much more correct to me to configure something called Deployer that has-a Scanner.

joakime · 2025-03-12T16:06:56Z

It still seems the wrong way around that we configure something called a Scanner that then hands off to a Deployer. It still seems much more correct to me to configure something called Deployer that has-a Scanner.

It's a separation of concerns.
Talking about this in FileSystem terms ...

Scanner is the source
Deployer is the action - Files.copy(src,dest)
ContextHandlerCollection is the destination.

gregw · 2025-03-12T16:11:58Z

I can see it just being 4 files ...

Deployer - what the DirectDeployer is now

That only works if we lose the interface. We can do that, but then we should do the same with the ContextHandlerFactory interface.
The interface is a good place to define the listeners, but they could also be done at the top level

ContextScanner - what the DeploymentScanner is
I think DeploymentScanner is about the only name I'm 100% happy with. Leave it!

StandardContextHandlerFactory - what the PathsContextHandlerFactory is

ContextHandlerFactory - no change
Again - whatever pattern we use here, we should use the same pattern for the Deployer.

So I see

Option 1

interface Deployer
- interface Listener
interface ContextHandlerCollection
class DeploymentScanner
class StandardDeployer implements Deployer
class StandardContextHandlerFactory implements ContextHandlerFactory

Option 2

class DeploymentScanner
class Deployer
- interface Listener
class ContextHandlerFactory

Option 2 is simplest. A user can still extend Deployer and CHF, but they get the standard implementations as their super, because there is no interface.
So I'm 40% Option 1; 60% option 2

@janbartel @sbordet @joakime thoughts?

sbordet · 2025-03-12T17:38:21Z

@gregw I'm 90% option 1.

With option 1, IIUC, OSGi will be an OSGiDeployerListener + OSGiContextHandlerFactory.

With option 2, OSGiContextHandlerFactory extends StandardContextHandlerFactory, again IIUC it will carry over a bunch of "standard" things that are not necessary for OSGi, am I right? If so, I'd prefer it to be an interface, although it is very specific to file system.

Also, I like that Deployer is an interface, as it can be implemented as a REST call for fancy deployments: you can have a local file scanner that monitors files that, when they change, get uploaded somewhere for the real deployment.

gregw · 2025-03-12T17:53:03Z

@gregw I'm 90% option 1.

OK so now I'm 70% option 1 30% option 2. Any other bidders?

gregw · 2025-03-13T07:09:42Z

@gregw I'm 90% option 1.

OK so now I'm 70% option 1 30% option 2. Any other bidders?

I did the rename to option 1 and did a first pass through the documentation.

gregw · 2025-03-13T08:15:21Z

jetty-core/jetty-deploy/src/main/java/org/eclipse/jetty/deploy/ContextHandlerFactory.java

+    /**
+     * Attributes that start with this name return a String pointing to XML on the filesystem that should be used for Environment based
+     * modifications to the ContextHandler that was created.
+     *
+     * <pre>
+     * jetty.deploy.environmentXml=config/base-ee8.xml
+     * jetty.deploy.environmentXml.auditing=config/auditing-ee8.xml
+     * </pre>
+     */
+    String ENVIRONMENT_XML_ATTRIBUTE = "jetty.deploy.environmentXml";
+    /**
+     * Attribute name that stores the {@code List<Path>} pointing to XML files that represent
+     * the Environment XML files to apply to the ContextHandler has been created.
+     */
+    String ENVIRONMENT_XML_PATHS_ATTRIBUTE = "jetty.deploy.paths.environmentXmls";


Now that we have the environments directory, is this mechanism still necessary?

The first one can go.
The second one is the result of using the /environments/ directory, so I would like to keep that one.

Actually, the first one can be used to have context specific environment XML.
Not sure the value of that nuanced behavior is.

The second one is almost an internal implementation detail, not to be used by users.

janbartel · 2025-03-13T09:07:50Z

jetty-core/jetty-osgi/src/main/java/org/eclipse/jetty/osgi/JettyServerFactory.java

-
+            //ensure a deployer
+            StandardDeployer deployer = ensureDeployer(server);
+            deployer.addEventListener(new OSGiDeploymentListener());


There's a risk that the deployer might already exist and already have an OSGIDeploymentListener.

True, have to noodle out a better way for you then.

Fixed in 2194b55

gregw

I think this is good enough to commit. We can refine we other PRs.

joakime · 2025-03-14T16:44:31Z

@gregw So, for the other branch where we fix the git history here (like file renames/moves), how about this ...

Renames in jetty-core/jetty-deploy

From Jetty 12.0.x	To Jetty 12.1.x
`DeploymentManager.java`	`StandardDeployer.java`
`providers/ScanningAppProvider.java`	`DeploymentScanner.java`
`providers/ContextProvider.java`	`StandardContextHandlerFactory.java`

I don't think there's really going to be much else to focus on.
Thoughts?

…ify-deploy

joakime · 2025-03-14T19:23:34Z

I've created a new branch called fix/12.1.x/deployer-refactor-rename-fixes that has the changes from this branch including proper renames/moves of the relevant files.

If you pull from origin, you can verify that these branches are the same, content wise, via the command line ...

git diff origin/fix/12.1.x/deployer-refactor-rename-fixes...origin/fix/12.1.x/unify-deploy

gregw · 2025-03-16T10:44:42Z

I've created a new branch called fix/12.1.x/deployer-refactor-rename-fixes that has the changes from this branch including proper renames/moves of the relevant files.

If you pull from origin, you can verify that these branches are the same, content wise, via the command line ...
git diff origin/fix/12.1.x/deployer-refactor-rename-fixes...origin/fix/12.1.x/unify-deploy

Maybe make a new PR from https://github.com/jetty/jetty.project/tree/fix/12.1.x/deployer-refactor-rename-fixes

joakime · 2025-03-17T19:09:18Z

I've created a new branch called fix/12.1.x/deployer-refactor-rename-fixes that has the changes from this branch including proper renames/moves of the relevant files.
If you pull from origin, you can verify that these branches are the same, content wise, via the command line ...
git diff origin/fix/12.1.x/deployer-refactor-rename-fixes...origin/fix/12.1.x/unify-deploy
Maybe make a new PR from https://github.com/jetty/jetty.project/tree/fix/12.1.x/deployer-refactor-rename-fixes

Done.

Issue #10437 - Simplify jetty-deploy with eye on Environment use #12914

I had to create a new branch, as I was unhappy with the result of the older one.
New Branch: fix/12.1.x/deploy-refactor-minimal-commits

joakime added 8 commits November 22, 2024 15:01

Initial pass at implementation of EnvironmentContextProvider

8878567

Fixing javadoc errors

3a46e37

Moving things around

c5c07c2

Moving changes back into ContextProvider

e0bdeb3

Introducing ContextProvider.configureEnvironment(String name)

7588d5f

Fixing <env>[-zzz].properties sorting

42015b3

Allow an Environment to be removed (needed for testing with Environment)

f9c90ce

Fixing test cases

83fc5f1

joakime added Enhancement Bug For general bugs on Jetty side labels Nov 26, 2024

joakime requested a review from sbordet November 26, 2024 21:48

joakime self-assigned this Nov 26, 2024

joakime changed the base branch from jetty-12.0.x to jetty-12.1.x November 26, 2024 21:48

joakime linked an issue Nov 26, 2024 that may be closed by this pull request

Review DeploymentManager and ScanningAppProvider #10437

Open

joakime added 10 commits November 27, 2024 07:45

Merge remote-tracking branch 'origin/jetty-12.1.x' into fix/12.1.x/un…

a0c9058

…ify-deploy

Fix javadoc

249679f

Fix method names

bef04d9

Fixing Environment contextClass loading

add337a

Fixing test cases

2e9660d

Fixing quickstart XML references to provider

9bfab80

Merge remote-tracking branch 'origin/jetty-12.1.x' into fix/12.1.x/un…

2c651ea

…ify-deploy

Fixing quickstart XML

0e534f7

Fixing deploy containerScanJarPattern for ee9/ee8

43eb679

Merge remote-tracking branch 'origin/jetty-12.1.x' into fix/12.1.x/un…

c5a00b8

…ify-deploy

joakime marked this pull request as ready for review December 3, 2024 00:01

janbartel requested a review from gregw December 10, 2024 04:35

janbartel requested changes Dec 10, 2024

View reviewed changes

sbordet requested changes Dec 10, 2024

View reviewed changes

jetty-core/jetty-deploy/src/main/java/org/eclipse/jetty/deploy/providers/ContextProvider.java Outdated Show resolved Hide resolved

WIP

eda46aa

joakime and others added 4 commits March 12, 2025 14:30

cleanup modules

19af94f

Fixing build/test

1010583

Fixing test string

cee4f64

renames to standard

4182a44

Added template environment files

c792124

gregw requested changes Mar 13, 2025

View reviewed changes

Rename constructor/method params to deployer

4499beb

janbartel reviewed Mar 13, 2025

View reviewed changes

gregw and others added 2 commits March 13, 2025 10:11

Added template environment files and documentation

8e37355

fixing build

dd3bc27

gregw approved these changes Mar 14, 2025

View reviewed changes

gregw requested review from janbartel and sbordet March 14, 2025 07:09

Ensure that OSGiDeploymentListener exists once.

2194b55

Merge remote-tracking branch 'origin/jetty-12.1.x' into fix/12.1.x/un…

257e1f7

…ify-deploy

joakime added a commit that referenced this pull request Mar 14, 2025

Rollup of all deploy changes from PR #12583

819211f

joakime mentioned this pull request Mar 17, 2025

Issue #10437 - Simplify jetty-deploy with eye on Environment use #12914

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Issue #10437 - Refactor Local Deployment Scanning #12583

Issue #10437 - Refactor Local Deployment Scanning #12583

joakime commented Nov 26, 2024 •

edited

Loading

sbordet commented Dec 10, 2024 •

edited by joakime

Loading

gregw commented Mar 12, 2025

joakime commented Mar 12, 2025

janbartel commented Mar 12, 2025

joakime commented Mar 12, 2025 •

edited

Loading

gregw commented Mar 12, 2025

sbordet commented Mar 12, 2025

gregw commented Mar 12, 2025

gregw commented Mar 13, 2025

gregw Mar 13, 2025

joakime Mar 13, 2025

joakime Mar 13, 2025

joakime Mar 13, 2025

janbartel Mar 13, 2025

joakime Mar 13, 2025

joakime Mar 14, 2025

gregw left a comment

joakime commented Mar 14, 2025

joakime commented Mar 14, 2025

gregw commented Mar 16, 2025

joakime commented Mar 17, 2025

Issue #10437 - Refactor Local Deployment Scanning #12583

Are you sure you want to change the base?

Issue #10437 - Refactor Local Deployment Scanning #12583

Conversation

joakime commented Nov 26, 2024 • edited Loading

sbordet commented Dec 10, 2024 • edited by joakime Loading

gregw commented Mar 12, 2025

joakime commented Mar 12, 2025

janbartel commented Mar 12, 2025

joakime commented Mar 12, 2025 • edited Loading

gregw commented Mar 12, 2025

sbordet commented Mar 12, 2025

gregw commented Mar 12, 2025

gregw commented Mar 13, 2025

gregw Mar 13, 2025

Choose a reason for hiding this comment

joakime Mar 13, 2025

Choose a reason for hiding this comment

joakime Mar 13, 2025

Choose a reason for hiding this comment

joakime Mar 13, 2025

Choose a reason for hiding this comment

janbartel Mar 13, 2025

Choose a reason for hiding this comment

joakime Mar 13, 2025

Choose a reason for hiding this comment

joakime Mar 14, 2025

Choose a reason for hiding this comment

gregw left a comment

Choose a reason for hiding this comment

joakime commented Mar 14, 2025

joakime commented Mar 14, 2025

gregw commented Mar 16, 2025

joakime commented Mar 17, 2025

joakime commented Nov 26, 2024 •

edited

Loading

sbordet commented Dec 10, 2024 •

edited by joakime

Loading

joakime commented Mar 12, 2025 •

edited

Loading