playframework / playframework/play1

Play Framework Module Configuration Issue: Detection of Plugins Absent in addModule Method

Open
#1,486 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Java
Stars
1.6k
Forks
671
Avg merge
12d 15h
Merged PRs (30d)
1

Description

I'm currently encountering an issue with Play not recognizing a plugin within one of my modules. It seems that Play only detects the plugin if I place my play.plugins file directly in the module, under the app directory.

Upon examining the addModule method in Play.java, I noticed that there's no provision for handling the module's configuration directory (conf). This absence raises questions about the inclusion of the conf directory for modules.

Code Snippet:

public static void addModule(VirtualFile appRoot, String name, File path) {
    VirtualFile root = VirtualFile.open(path);
    modules.put(name, root);
    if (root.child("app").exists()) {
        javaPath.add(root.child("app"));
    }
    if (root.child("app/views").exists() || (usePrecompiled
            && appRoot.child("precompiled/templates/from_module_" + name + "/app/views").exists())) {
        templatesPath.add(root.child("app/views"));
    }
    // Missing handling for the 'conf' directory
    roots.add(root);
    if (!name.startsWith("_")) {
        Logger.info("Module %s is available (%s)", name, path.getAbsolutePath());
    }
}

Issue:
The absence of inclusion of the module's conf directory in the addModule method raises questions about its intended handling. Specifically, I'm curious why the conf directory for modules isn't considered within this method. Is there a particular reason for this?

Expected Clarification:
Could someone shed light on why the module's conf directory is excluded from the addModule method? This omission has prompted inquiries, especially regarding the detection and usage of certain module configurations, such as the play.plugins file. Could anyone assist me in understanding how I should properly utilize the play.plugins file within a module?

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start in Play.java at addModule and trace how module configuration and play.plugins files are discovered. Compare the module app and conf paths with the existing plugin-loading logic. Done means establishing the intended module configuration behavior and documenting or testing the resulting handling.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
backend
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.