Examples with ModuleState io.quarkus.devtools.project.state.ModuleState used on opensource projects

Example 1 with ModuleState

use of io.quarkus.devtools.project.state.ModuleState in project quarkus by quarkusio.

the class UpdateCommandHandler method resolveRecommendedState.

private static ProjectState resolveRecommendedState(ProjectState currentState, ExtensionCatalog latestCatalog, MessageWriter log) {
    if (currentState.getPlatformBoms().isEmpty()) {
        return currentState;
    }
    if (currentState.getExtensions().isEmpty()) {
        return currentState;
    }
    final ExtensionMap extensionInfo = new ExtensionMap();
    for (TopExtensionDependency dep : currentState.getExtensions()) {
        extensionInfo.add(new ExtensionInfo(dep));
    }
    for (Extension e : latestCatalog.getExtensions()) {
        final ExtensionInfo candidate = extensionInfo.get(e.getArtifact().getKey());
        if (candidate != null && candidate.latestMetadata == null) {
            // if the latestMetadata has already been initialized, it's already the preferred one
            // that could happen if an artifact has relocated
            candidate.latestMetadata = e;
        }
    }
    final List<ExtensionInfo> unknownExtensions = new ArrayList<>(0);
    final List<Extension> updateCandidates = new ArrayList<>(extensionInfo.size());
    final Map<String, ExtensionMap> updateCandidatesByOrigin = new HashMap<>();
    for (ExtensionInfo i : extensionInfo.values()) {
        if (i.latestMetadata == null) {
            unknownExtensions.add(i);
        } else {
            updateCandidates.add(i.latestMetadata);
            for (ExtensionOrigin o : i.latestMetadata.getOrigins()) {
                updateCandidatesByOrigin.computeIfAbsent(o.getId(), k -> new ExtensionMap()).add(i);
            }
        }
    }
    if (extensionInfo.isEmpty()) {
        return currentState;
    }
    if (!unknownExtensions.isEmpty()) {
        log.warn("The configured Quarkus registries did not provide any compatibility information for the following extensions in the context of the currently recommended Quarkus platforms:");
        unknownExtensions.forEach(e -> log.warn(" " + e.currentDep.getArtifact().toCompactCoords()));
    }
    final List<ExtensionCatalog> recommendedOrigins;
    try {
        recommendedOrigins = getRecommendedOrigins(latestCatalog, updateCandidates);
    } catch (QuarkusCommandException e) {
        log.info("Failed to find a compatible configuration update for the project");
        return currentState;
    }
    int collectedUpdates = 0;
    for (ExtensionCatalog recommendedOrigin : recommendedOrigins) {
        final ExtensionMap candidates = updateCandidatesByOrigin.get(recommendedOrigin.getId());
        for (Extension e : recommendedOrigin.getExtensions()) {
            final ExtensionInfo info = candidates.get(e.getArtifact().getKey());
            if (info != null && info.recommendedMetadata == null) {
                info.setRecommendedMetadata(e);
                if (++collectedUpdates == updateCandidates.size()) {
                    break;
                }
            }
        }
    }
    final ProjectState.Builder stateBuilder = ProjectState.builder();
    for (ExtensionCatalog c : recommendedOrigins) {
        if (c.isPlatform()) {
            stateBuilder.addPlatformBom(c.getBom());
        }
    }
    final Map<String, ExtensionProvider.Builder> extProviders = new LinkedHashMap<>(recommendedOrigins.size());
    for (ExtensionInfo info : extensionInfo.values()) {
        final TopExtensionDependency ext = info.getRecommendedDependency();
        stateBuilder.addExtensionDependency(ext);
        extProviders.computeIfAbsent(ext.getProviderKey(), k -> ExtensionProvider.builder().setOrigin(ext.getOrigin())).addExtension(ext);
    }
    extProviders.values().forEach(b -> stateBuilder.addExtensionProvider(b.build()));
    for (ModuleState module : currentState.getModules()) {
        final ModuleState.Builder moduleBuilder = ModuleState.builder().setMainModule(module.isMain()).setWorkspaceModule(module.getWorkspaceModule());
        for (TopExtensionDependency dep : module.getExtensions()) {
            final TopExtensionDependency recommendedDep = extensionInfo.get(dep.getKey()).getRecommendedDependency();
            moduleBuilder.addExtensionDependency(recommendedDep);
            final ExtensionOrigin origin = recommendedDep.getOrigin();
            if (origin != null && origin.isPlatform()) {
                moduleBuilder.addPlatformBom(origin.getBom());
            }
        }
        stateBuilder.addModule(moduleBuilder.build());
    }
    return stateBuilder.build();
}

Example 2 with ModuleState

use of io.quarkus.devtools.project.state.ModuleState in project quarkus by quarkusio.

the class InfoCommandHandler method logState.

// TODO: instead of returning a boolean, the info about available
// recommendations should be reflected in ProjectState
protected static boolean logState(ProjectState projectState, boolean perModule, boolean rectify, MessageWriter log) {
    boolean recommendationsAvailable = false;
    final Map<ArtifactKey, PlatformInfo> providerInfo = new LinkedHashMap<>();
    for (ArtifactCoords bom : projectState.getPlatformBoms()) {
        providerInfo.computeIfAbsent(bom.getKey(), k -> new PlatformInfo()).imported = bom;
    }
    for (TopExtensionDependency dep : projectState.getExtensions()) {
        final ExtensionOrigin origin = dep.getOrigin();
        if (origin != null && origin.isPlatform()) {
            providerInfo.computeIfAbsent(origin.getBom().getKey(), k -> new PlatformInfo()).recommended = origin.getBom();
        }
    }
    if (providerInfo.isEmpty()) {
        log.info("No Quarkus platform BOMs found");
    } else {
        log.info("Quarkus platform BOMs:");
        boolean recommendExtraImports = false;
        for (PlatformInfo platform : providerInfo.values()) {
            if (platform.imported == null) {
                recommendExtraImports = true;
                continue;
            }
            final StringBuilder sb = new StringBuilder();
            if (platform.recommended == null) {
                if (rectify) {
                    sb.append(String.format(UpdateCommandHandler.PLATFORM_RECTIFY_FORMAT, UpdateCommandHandler.REMOVE, platform.imported.toCompactCoords()));
                    recommendationsAvailable = true;
                } else {
                    sb.append("  ");
                    sb.append(platform.imported.toCompactCoords());
                    if (!projectState.getExtensions().isEmpty()) {
                        // The extension check is for modules that are aggregating modules (e.g. parent POMs)
                        // that import common BOMs. It's however not how it should be done.
                        sb.append(" | unnecessary");
                        recommendationsAvailable = true;
                    }
                }
            } else if (platform.isVersionUpdateRecommended()) {
                if (rectify) {
                    sb.append(String.format(UpdateCommandHandler.PLATFORM_RECTIFY_FORMAT, UpdateCommandHandler.UPDATE, platform.imported.toCompactCoords()));
                    sb.append(platform.imported.toCompactCoords()).append(" -> ").append(platform.getRecommendedVersion());
                } else {
                    sb.append("  ");
                    sb.append(platform.imported.toCompactCoords()).append(" | misaligned");
                }
                recommendationsAvailable = true;
            } else {
                if (rectify) {
                    sb.append(String.format(UpdateCommandHandler.PLATFORM_RECTIFY_FORMAT, "", platform.imported.toCompactCoords()));
                } else {
                    sb.append("  ").append(platform.imported.toCompactCoords());
                }
            }
            log.info(sb.toString());
        }
        if (rectify && recommendExtraImports) {
            for (PlatformInfo platform : providerInfo.values()) {
                if (platform.imported == null) {
                    log.info(String.format(UpdateCommandHandler.PLATFORM_RECTIFY_FORMAT, UpdateCommandHandler.ADD, platform.recommended.toCompactCoords()));
                }
            }
            recommendationsAvailable = true;
        }
    }
    if (projectState.getExtensions().isEmpty()) {
        log.info("");
        log.info("No Quarkus extensions found among the project dependencies");
        return recommendationsAvailable;
    }
    log.info("");
    if (perModule) {
        final ModuleState mainModule = projectState.getMainModule();
        final Path baseDir = mainModule.getModuleDir();
        recommendationsAvailable |= logModuleInfo(projectState, mainModule, baseDir, log, rectify);
        for (ModuleState module : projectState.getModules()) {
            if (!module.isMain()) {
                recommendationsAvailable |= logModuleInfo(projectState, module, baseDir, log, rectify);
            }
        }
    } else {
        for (ExtensionProvider provider : projectState.getExtensionProviders()) {
            if (provider.isPlatform()) {
                recommendationsAvailable = logProvidedExtensions(provider, rectify, log, recommendationsAvailable);
            }
        }
        for (ExtensionProvider provider : projectState.getExtensionProviders()) {
            if (!provider.isPlatform()) {
                recommendationsAvailable = logProvidedExtensions(provider, rectify, log, recommendationsAvailable);
            }
        }
    }
    return recommendationsAvailable;
}

Example 3 with ModuleState

use of io.quarkus.devtools.project.state.ModuleState in project quarkus by quarkusio.

the class InfoCommandHandler method logModuleInfo.

private static boolean logModuleInfo(ProjectState project, ModuleState module, Path baseDir, MessageWriter log, boolean rectify) {
    if (module.getExtensions().isEmpty() && module.getPlatformBoms().isEmpty() && !module.isMain()) {
        return false;
    }
    boolean recommendationsAvailable = false;
    final StringBuilder sb = new StringBuilder();
    if (module.isMain()) {
        sb.append("Main application module ");
    } else {
        sb.append("Module ");
    }
    sb.append(module.getId().getGroupId()).append(':').append(module.getId().getArtifactId()).append(':');
    log.info(sb.toString());
    final Iterator<Path> i = module.getWorkspaceModule().getBuildFiles().iterator();
    if (i.hasNext()) {
        sb.setLength(0);
        sb.append("  Build file: ");
        sb.append(baseDir.relativize(i.next()));
        while (i.hasNext()) {
            sb.append(", ").append(baseDir.relativize(i.next()));
        }
        log.info(sb.toString());
    }
    if (!module.getPlatformBoms().isEmpty()) {
        log.info("  Platform BOMs:");
        for (ArtifactCoords bom : module.getPlatformBoms()) {
            log.info("    " + bom.toCompactCoords());
        }
    }
    if (!module.getExtensions().isEmpty()) {
        final Map<String, List<TopExtensionDependency>> extDepsByProvider = new LinkedHashMap<>();
        for (TopExtensionDependency dep : module.getExtensions()) {
            extDepsByProvider.computeIfAbsent(dep.getProviderKey(), k -> new ArrayList<>()).add(dep);
        }
        for (ExtensionProvider provider : project.getExtensionProviders()) {
            if (!provider.isPlatform()) {
                continue;
            }
            final List<TopExtensionDependency> extList = extDepsByProvider.getOrDefault(provider.getKey(), Collections.emptyList());
            if (!extList.isEmpty()) {
                log.info("  Extensions from " + provider.getKey() + ":");
                for (TopExtensionDependency dep : extList) {
                    sb.setLength(0);
                    sb.append("  ");
                    recommendationsAvailable = logExtensionInfo(dep, rectify, sb, recommendationsAvailable);
                    log.info(sb.toString());
                }
                log.info("");
            }
        }
        for (ExtensionProvider provider : project.getExtensionProviders()) {
            if (provider.isPlatform()) {
                continue;
            }
            final List<TopExtensionDependency> extList = extDepsByProvider.getOrDefault(provider.getKey(), Collections.emptyList());
            if (!extList.isEmpty()) {
                log.info("  Extensions from " + provider.getKey() + ":");
                for (TopExtensionDependency dep : extList) {
                    sb.setLength(0);
                    sb.append("  ");
                    recommendationsAvailable = logExtensionInfo(dep, rectify, sb, recommendationsAvailable);
                    log.info(sb.toString());
                }
                log.info("");
            }
        }
    }
    return recommendationsAvailable;
}