Skip to content

Commit

Permalink
fix: separate core and commercial components version files (#14014) …
Browse files Browse the repository at this point in the history 
…(CP: 2.7)

This is a manual cherry-pick to collect
all changes that are done in #14014,
#14079, and #14083.

Related to #14092
  • Loading branch information
@taefi
taefi committed Jul 1, 2022
1 parent 4ff9aef commit 9004c08
Show file tree
Hide file tree
Showing 7 changed files with 317 additions and 56 deletions.
9 changes: 7 additions & 2 deletions flow-server/src/main/java/com/vaadin/flow/server/Constants.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -500,9 +500,14 @@ public final class Constants implements Serializable {
public static final String DEFAULT_EXTERNAL_STATS_URL = "/vaadin-static/VAADIN/config/stats.json";

/**
* The name of platform versions file.
* The name of platform core components and tools versions file.
*/
public static final String VAADIN_VERSIONS_JSON = "vaadin_versions.json";
public static final String VAADIN_CORE_VERSIONS_JSON = "vaadin-core-versions.json";

/**
* The name of platform commercial components and tools versions file.
*/
public static final String VAADIN_VERSIONS_JSON = "vaadin-versions.json";

/**
* @deprecated Use
Expand Down
55 changes: 37 additions & 18 deletions flow-server/src/main/java/com/vaadin/flow/server/frontend/NodeUpdater.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -135,32 +135,51 @@ private File getPackageJsonFile() {
/**
* Gets the platform pinned versions that are not overridden by the user in
* package.json.
*
*
* @return json object with the dependencies or {@code null}
* @throws IOException
* when versions file could not be read
*/
JsonObject getPlatformPinnedDependencies() throws IOException {
URL resource = finder.getResource(Constants.VAADIN_VERSIONS_JSON);
if (resource == null) {
URL coreVersionsResource = finder
.getResource(Constants.VAADIN_CORE_VERSIONS_JSON);
if (coreVersionsResource == null) {
log().info(
"Couldn't find {} file to pin dependency versions."
+ " Transitive dependencies won't be pinned for pnpm.",
Constants.VAADIN_VERSIONS_JSON);
"Couldn't find {} file to pin dependency versions for core components."
+ " Transitive dependencies won't be pinned for npm/pnpm.",
Constants.VAADIN_CORE_VERSIONS_JSON);
return null;
}

JsonObject versionsJson = null;
try (InputStream content = resource == null ? null
: resource.openStream()) {

if (content != null) {
VersionsJsonConverter convert = new VersionsJsonConverter(
Json.parse(IOUtils.toString(content,
StandardCharsets.UTF_8)));
versionsJson = convert.getConvertedJson();
versionsJson = new VersionsJsonFilter(getPackageJson(),
DEPENDENCIES).getFilteredVersions(versionsJson);
}
JsonObject versionsJson = getFilteredVersionsFromResource(
coreVersionsResource, Constants.VAADIN_CORE_VERSIONS_JSON);

URL vaadinVersionsResource = finder
.getResource(Constants.VAADIN_VERSIONS_JSON);
if (vaadinVersionsResource == null) {
// vaadin is not on the classpath, only vaadin-core is present.
return versionsJson;
}

JsonObject vaadinVersionsJson = getFilteredVersionsFromResource(
vaadinVersionsResource, Constants.VAADIN_VERSIONS_JSON);
for (String key : vaadinVersionsJson.keys()) {
versionsJson.put(key, vaadinVersionsJson.getString(key));
}

return versionsJson;
}

private JsonObject getFilteredVersionsFromResource(URL versionsResource,
String versionsOrigin) throws IOException {
JsonObject versionsJson;
try (InputStream content = versionsResource.openStream()) {
VersionsJsonConverter convert = new VersionsJsonConverter(Json
.parse(IOUtils.toString(content, StandardCharsets.UTF_8)));
versionsJson = convert.getConvertedJson();
versionsJson = new VersionsJsonFilter(getPackageJson(),
DEPENDENCIES)
.getFilteredVersions(versionsJson, versionsOrigin);
}
return versionsJson;
}
Expand Down
7 changes: 4 additions & 3 deletions flow-server/src/main/java/com/vaadin/flow/server/frontend/VersionsJsonFilter.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -51,14 +51,15 @@ class VersionsJsonFilter {
*
* @param versions
* to be filtered for user managed ones
* @param versionOrigin
* origin of the version (like a file), used in error message
* @return filtered versions json
*/
JsonObject getFilteredVersions(JsonObject versions) {
JsonObject getFilteredVersions(JsonObject versions, String versionOrigin) {
JsonObject json = Json.createObject();
for (String key : versions.keys()) {
final FrontendVersion version = FrontendUtils
.getPackageVersionFromJson(versions, key,
"vaadin_version.json");
.getPackageVersionFromJson(versions, key, versionOrigin);
if (version == null) {
continue;
}
Expand Down
180 changes: 180 additions & 0 deletions flow-server/src/test/java/com/vaadin/flow/server/frontend/NodeUpdaterTest.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,12 @@
import org.junit.Rule;
import org.junit.Test;
import org.junit.rules.TemporaryFolder;
import org.mockito.MockedStatic;
import org.mockito.Mockito;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import com.vaadin.flow.server.Constants;
import com.vaadin.flow.server.frontend.scanner.ClassFinder;
import com.vaadin.flow.server.frontend.scanner.FrontendDependencies;

Expand Down Expand Up @@ -210,6 +214,95 @@ public void getJsonFileContent_incorrectPackageJsonContent_throwsExceptionWithFi
StringContains.containsString("broken-package.json"));
}

@Test
public void testGetPlatformPinnedDependencies_vaadinCoreVersionIsNotPresent_outputIsNull()
throws IOException {
Logger logger = Mockito.spy(Logger.class);
try (MockedStatic<LoggerFactory> loggerFactoryMocked = Mockito
.mockStatic(LoggerFactory.class)) {
loggerFactoryMocked
.when(() -> LoggerFactory.getLogger(nodeUpdater.getClass()))
.thenReturn(logger);

Mockito.when(finder.getResource(Constants.VAADIN_CORE_VERSIONS_JSON))
.thenReturn(null);
Mockito.when(finder.getResource(Constants.VAADIN_VERSIONS_JSON))
.thenReturn(null);

JsonObject pinnedVersions = nodeUpdater
.getPlatformPinnedDependencies();
Assert.assertNull(pinnedVersions);

Mockito.verify(logger, Mockito.times(1)).info(
"Couldn't find {} file to pin dependency versions for core components."
+ " Transitive dependencies won't be pinned for npm/pnpm.",
Constants.VAADIN_CORE_VERSIONS_JSON);
}
}

@Test
public void testGetPlatformPinnedDependencies_onlyVaadinCoreVersionIsPresent_outputContainsOnlyCoreVersions()
throws IOException {
File coreVersionsFile = File.createTempFile("vaadin-core-versions",
".json", temporaryFolder.newFolder());
JsonObject mockedVaadinCoreJson = getMockVaadinCoreVersionsJson();
Assert.assertTrue(mockedVaadinCoreJson.hasKey("core"));
Assert.assertTrue(
mockedVaadinCoreJson.getObject("core").hasKey("button"));
Assert.assertFalse(mockedVaadinCoreJson.hasKey("vaadin"));

FileUtils.write(coreVersionsFile, mockedVaadinCoreJson.toJson(),
UTF_8);
Mockito.when(finder.getResource(Constants.VAADIN_CORE_VERSIONS_JSON))
.thenReturn(coreVersionsFile.toURI().toURL());
Mockito.when(finder.getResource(Constants.VAADIN_VERSIONS_JSON))
.thenReturn(null);

JsonObject pinnedVersions = nodeUpdater.getPlatformPinnedDependencies();

Assert.assertTrue(pinnedVersions.hasKey("@vaadin/button"));
Assert.assertFalse(pinnedVersions.hasKey("@vaadin/grid-pro"));
Assert.assertFalse(pinnedVersions.hasKey("@vaadin/vaadin-grid-pro"));
}

@Test
public void testGetPlatformPinnedDependencies_VaadinAndVaadinCoreVersionsArePresent_outputContainsBothCoreAndCommercialVersions()
throws IOException {
File coreVersionsFile = File.createTempFile("vaadin-core-versions",
".json", temporaryFolder.newFolder());
JsonObject mockedVaadinCoreJson = getMockVaadinCoreVersionsJson();
Assert.assertTrue(mockedVaadinCoreJson.hasKey("core"));
Assert.assertTrue(
mockedVaadinCoreJson.getObject("core").hasKey("button"));
Assert.assertFalse(mockedVaadinCoreJson.hasKey("vaadin"));

FileUtils.write(coreVersionsFile, mockedVaadinCoreJson.toJson(),
UTF_8);
Mockito.when(finder.getResource(Constants.VAADIN_CORE_VERSIONS_JSON))
.thenReturn(coreVersionsFile.toURI().toURL());

File vaadinVersionsFile = File.createTempFile("vaadin-versions",
".json", temporaryFolder.newFolder());
JsonObject mockedVaadinJson = getMockVaadinVersionsJson();
Assert.assertFalse(mockedVaadinJson.hasKey("core"));
Assert.assertTrue(mockedVaadinJson.hasKey("vaadin"));
Assert.assertTrue(
mockedVaadinJson.getObject("vaadin").hasKey("grid-pro"));
Assert.assertTrue(
mockedVaadinJson.getObject("vaadin").hasKey("vaadin-grid-pro"));

FileUtils.write(vaadinVersionsFile, mockedVaadinJson.toJson(),
UTF_8);
Mockito.when(finder.getResource(Constants.VAADIN_VERSIONS_JSON))
.thenReturn(vaadinVersionsFile.toURI().toURL());

JsonObject pinnedVersions = nodeUpdater.getPlatformPinnedDependencies();

Assert.assertTrue(pinnedVersions.hasKey("@vaadin/button"));
Assert.assertTrue(pinnedVersions.hasKey("@vaadin/grid-pro"));
Assert.assertTrue(pinnedVersions.hasKey("@vaadin/vaadin-grid-pro"));
}

private String getPolymerVersion(JsonObject object) {
JsonObject deps = object.get("dependencies");
String version = deps.getString("@polymer/polymer");
Expand All @@ -231,4 +324,91 @@ private void resolveResource_unhappyPath(String resourceFolder) {
Assert.assertEquals("foo", nodeUpdater.resolveResource("foo", true));
Assert.assertEquals("foo", nodeUpdater.resolveResource("foo", false));
}

private JsonObject getMockVaadinCoreVersionsJson() {
// @formatter:off
return Json.parse(
"{\n" +
" \"bundles\": {\n" +
" \"vaadin\": {\n" +
" \"jsVersion\": \"23.2.0\",\n" +
" \"npmName\": \"@vaadin/bundles\"\n" +
" }\n" +
" },\n" +
" \"core\": {\n" +
" \"accordion\": {\n" +
" \"jsVersion\": \"23.2.0\",\n" +
" \"npmName\": \"@vaadin/accordion\"\n" +
" },\n" +
" \"app-layout\": {\n" +
" \"jsVersion\": \"23.2.0\",\n" +
" \"npmName\": \"@vaadin/app-layout\"\n" +
" },\n" +
" \"avatar\": {\n" +
" \"jsVersion\": \"23.2.0\",\n" +
" \"npmName\": \"@vaadin/avatar\"\n" +
" },\n" +
" \"avatar-group\": {\n" +
" \"jsVersion\": \"23.2.0\",\n" +
" \"npmName\": \"@vaadin/avatar-group\"\n" +
" },\n" +
" \"button\": {\n" +
" \"jsVersion\": \"23.2.0\",\n" +
" \"npmName\": \"@vaadin/button\"\n" +
" },\n" +
" \"checkbox\": {\n" +
" \"jsVersion\": \"23.2.0\",\n" +
" \"npmName\": \"@vaadin/checkbox\"\n" +
" }" +
" },\n" +
" \"platform\": \"23.2.0\"\n" +
"}"
);
// @formatter:on
}

private JsonObject getMockVaadinVersionsJson() {
// @formatter:off
return Json.parse(
"{\n" +
" \"vaadin\": {\n" +
" \"board\": {\n" +
" \"jsVersion\": \"23.2.0\",\n" +
" \"npmName\": \"@vaadin/board\"\n" +
" },\n" +
" \"charts\": {\n" +
" \"jsVersion\": \"23.2.0\",\n" +
" \"npmName\": \"@vaadin/charts\"\n" +
" },\n" +
" \"grid-pro\": {\n" +
" \"jsVersion\": \"23.2.0\",\n" +
" \"npmName\": \"@vaadin/grid-pro\"\n" +
" },\n" +
" \"vaadin-board\": {\n" +
" \"component\": true,\n" +
" \"javaVersion\": \"23.2.0\",\n" +
" \"jsVersion\": \"23.2.0\",\n" +
" \"npmName\": \"@vaadin/vaadin-board\",\n" +
" \"pro\": true\n" +
" },\n" +
" \"vaadin-charts\": {\n" +
" \"component\": true,\n" +
" \"javaVersion\": \"23.2.0\",\n" +
" \"jsVersion\": \"23.2.0\",\n" +
" \"npmName\": \"@vaadin/vaadin-charts\",\n" +
" \"pro\": true\n" +
" },\n" +
" \"vaadin-grid-pro\": {\n" +
" \"component\": true,\n" +
" \"javaVersion\": \"23.2.0\",\n" +
" \"jsVersion\": \"23.2.0\",\n" +
" \"npmName\": \"@vaadin/vaadin-grid-pro\",\n" +
" \"pro\": true\n" +
" },\n" +
" },\n" +
" \"platform\": \"23.2.0\"\n" +
"}"
);
// @formatter:on
}
}
23 changes: 13 additions & 10 deletions flow-server/src/test/java/com/vaadin/flow/server/frontend/TaskRunPnpmInstallTest.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -488,11 +488,12 @@ public void runPnpmInstall_userVersionNewerThanPinned_installedOverlayVersionIsN
final VersionsJsonFilter versionsJsonFilter = new VersionsJsonFilter(
Json.parse(packageJsonContent), NodeUpdater.DEPENDENCIES);
// Platform defines a pinned version
TaskRunNpmInstall task = createTask(
versionsJsonFilter.getFilteredVersions(
TaskRunNpmInstall task = createTask(versionsJsonFilter
.getFilteredVersions(
Json.parse("{ \"@vaadin/vaadin-overlay\":\""
+ PINNED_VERSION + "\"}"))
.toJson());
+ PINNED_VERSION + "\"}"),
"test-versions.json")
.toJson());
task.execute();

File overlayPackageJson = new File(getNodeUpdater().nodeModulesFolder,
Expand Down Expand Up @@ -535,11 +536,12 @@ public void runPnpmInstall_frameworkCollectedVersionNewerThanPinned_installedOve
final VersionsJsonFilter versionsJsonFilter = new VersionsJsonFilter(
Json.parse(packageJsonContent), NodeUpdater.DEPENDENCIES);
// Platform defines a pinned version
TaskRunNpmInstall task = createTask(
versionsJsonFilter.getFilteredVersions(
TaskRunNpmInstall task = createTask(versionsJsonFilter
.getFilteredVersions(
Json.parse("{ \"@vaadin/vaadin-overlay\":\""
+ PINNED_VERSION + "\"}"))
.toJson());
+ PINNED_VERSION + "\"}"),
"test-versions.json")
.toJson());
task.execute();

File overlayPackageJson = new File(getNodeUpdater().nodeModulesFolder,
Expand Down Expand Up @@ -616,7 +618,8 @@ protected String generateVersionsJson() {
private JsonObject getGeneratedVersionsContent(File versions)
throws IOException {
ClassFinder classFinder = getClassFinder();
Mockito.when(classFinder.getResource(Constants.VAADIN_VERSIONS_JSON))
Mockito.when(
classFinder.getResource(Constants.VAADIN_CORE_VERSIONS_JSON))
.thenReturn(versions.toURI().toURL());

TaskRunNpmInstall task = new TaskRunNpmInstall(getClassFinder(),
Expand All @@ -635,4 +638,4 @@ private JsonObject getGeneratedVersionsContent(File versions)

}

}
}
10 changes: 5 additions & 5 deletions flow-server/src/test/java/com/vaadin/flow/server/frontend/TaskUpdatePackagesNpmTest.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ public void setUp() throws IOException {
generatedPath.mkdir();
versionJsonFile = new File(npmFolder, "versions.json");
finder = Mockito.mock(ClassFinder.class);
Mockito.when(finder.getResource(Constants.VAADIN_VERSIONS_JSON))
Mockito.when(finder.getResource(Constants.VAADIN_CORE_VERSIONS_JSON))
.thenReturn(versionJsonFile.toURI().toURL());
}

Expand Down Expand Up @@ -324,14 +324,14 @@ public void npmIsInUse_platformVersionIsBumped_versionsAreUpdated()
@Test
public void npmIsInUse_noPlatformVersionJsonPresent_noFailure()
throws IOException {
Mockito.when(finder.getResource(Constants.VAADIN_VERSIONS_JSON))
Mockito.when(finder.getResource(Constants.VAADIN_CORE_VERSIONS_JSON))
.thenReturn(null);
final TaskUpdatePackages task = createTask(
createApplicationDependencies());
task.execute();
Assert.assertTrue("Updates not picked", task.modified);

Mockito.when(finder.getResource(Constants.VAADIN_VERSIONS_JSON))
Mockito.when(finder.getResource(Constants.VAADIN_CORE_VERSIONS_JSON))
.thenReturn(versionJsonFile.toURI().toURL());
JsonObject dependencies = getOrCreatePackageJson()
.getObject(DEPENDENCIES);
Expand All @@ -342,11 +342,11 @@ public void npmIsInUse_noPlatformVersionJsonPresent_noFailure()
@Test
public void npmIsInUse_platformVersionsJsonAdded_versionsPinned()
throws IOException {
Mockito.when(finder.getResource(Constants.VAADIN_VERSIONS_JSON))
Mockito.when(finder.getResource(Constants.VAADIN_CORE_VERSIONS_JSON))
.thenReturn(null);
createTask(createApplicationDependencies()).execute();

Mockito.when(finder.getResource(Constants.VAADIN_VERSIONS_JSON))
Mockito.when(finder.getResource(Constants.VAADIN_CORE_VERSIONS_JSON))
.thenReturn(versionJsonFile.toURI().toURL());
final String newVersion = "20.0.0";
createVaadinVersionsJson(newVersion, newVersion, newVersion);
Expand Down
Loading

0 comments on commit 9004c08

Please sign in to comment.