FEATURE: Do not install demo site and instead offer a choice #42

kitsunet · 2019-10-18T16:22:39Z

This can be tested via:

composer create-project --repository '{"type":"vcs", "url":"git@github.com:kitsunet/neos-base-distribution.git"}' neos/neos-base-distribution neos-dev-dist-demo-installer dev-feature/demo-installer

followup: kitsunet#1
related: https://discuss.neos.io/t/rfc-post-create-project-tasks/5141

mficzel

I totally like this but cannot Test on my phone. So only two nitpicks as a start

Build/Classes/Composer/InstallSitePackage.php

composer.json

gerhard-boden · 2019-10-18T17:20:40Z

looks good so far, wanted to test it locally, but when running composer create-project (with this PR checkout out ofc) composer starts to run into a endless loop with the message Something's changed, looking at all rules again (pass #305) (verbose output)

What ist the best way to test the changes locally @kitsunet?

gerhard-boden · 2019-10-18T19:10:19Z

Tried it at home now on a completely different machine, same story (also for composer update). I think that 67a62e2 might have something to do with it, although I can't see what's wrong.

gerhard-boden · 2019-10-18T19:40:41Z

Okay here is a hack:

Remove all packages except for neos/neos
Run composer update
Add all other packages

Now composer update will succeed. It looks like composer is running into a dependency check endless loop, never seen anything like this before.

This way was at least able to test this PR, but the general issue inside the base distribution has to be addressed. I would have opened an issue, but we don't do issues in the base distribution.

Build/Classes/Composer/InstallSitePackage.php

gerhard-boden

Works great 👍 (but there's an general issue within the master branch of neos-base-distribution, see above).

We could have also gone with a Y/n dialogue for now, but for me it's good as it is. There's also an unused constant, but that can be easily removed before merging.

kitsunet · 2019-10-18T21:16:12Z

Alright, removed a lot of superfluous stuff from this, actually trying it is rather hard. while working on it I was using a branch in this repo that I then asked for in create-project ( composer create-project neos/neos-base-distribution my-folder dev-mybranch ) . Now I probably could move this PR over to the original repo if you want and it makes testing easier.

gerhard-boden · 2019-10-18T21:37:21Z

Now I probably could move this PR over to the original repo if you want and it makes testing easier.

Naw, I was able to test it in the end after some composer.json back and forth as mentioned above. Afterwards composer create-project within the folder would trigger the script. But the real troublemaker is that there is an issue in the master branch of the base distro (could you give composer create-project neos/neos-base-distribution . dev-master -vvv a try? Or should that never work because we have the dev distro for that?)

kitsunet · 2019-10-19T06:55:48Z

I can install base-distribution dev-master just fine, but it takes quite a lot of memory and time. Probably composer resolving dependencies. Eventually it could install though.

gerhard-boden · 2019-10-19T09:50:28Z

I can install base-distribution dev-master just fine, but it takes quite a lot of memory and time. Probably composer resolving dependencies. Eventually it could install though.

Thanks for checking, just tried it again:

Something's changed, looking at all rules again (pass #619)
Dependency resolution completed in 492.679 seconds
Analyzed 14727 packages to resolve dependencies
Analyzed 1402061 rules to resolve dependencies
Resolving dependencies through SAT
Looking at all rules.

I guess I wasn't patient enough on the train to wait 8 minutes for composer to just even start downloading packages 🙈

But at least it's working in general and this "issue" (if it is in one at some point), is definitely out of scope for this change. Just brought it up in here, because I noticed it while testing. 😊

mficzel

In general it works like a charm with the "empty" option but when choosing "Neos.Demo" i run into the following composer errors:

./composer.json has been updated
Loading composer repositories with package information
Updating dependencies (including require-dev)
Your requirements could not be resolved to an installable set of packages.

  Problem 1
    - Installation request for neos/demo ^6.0 -> satisfiable by neos/demo[6.0.0].
    - Conclusion: remove neos/neos dev-master
    - Conclusion: don't install neos/neos dev-master
    - neos/demo 6.0.0 requires neos/neos ^5.0 -> satisfiable by neos/neos[5.0.0, 5.0.1, 5.0.2, 5.0.x-dev].
    - Can only install one of: neos/neos[5.0.0, dev-master].
    - Can only install one of: neos/neos[5.0.1, dev-master].
    - Can only install one of: neos/neos[5.0.2, dev-master].
    - Can only install one of: neos/neos[5.0.x-dev, dev-master].
    - Installation request for neos/neos (locked at dev-master, required as @dev) -> satisfiable by neos/neos[dev-master].

Installation failed, reverting ./composer.json to its original content.

Your Neos was prepared successfully.

The last line "Neos was installed sucessfully" is a bit misleading, maybe we can check wether the composer command was successfull before writing this. I suggest to not render any message when errors occured so the last output is the composer error so it can be spotted easily.

The fix to underlying dependency problem is to adjust the neos/neos constraints in Neos.Demo to allow dev-master.

mficzel · 2019-10-21T11:19:44Z

FYI this line allows to test this without messing with the composer-configuration:

composer create-project --repository '{"type":"vcs", "url":"git@github.com:kitsunet/neos-base-distribution.git"}' neos/neos-base-distribution neos-dev-dist-demo-installer dev-feature/demo-installer

kitsunet · 2019-10-21T11:53:33Z

Interesting for me it installed jusut fine, apparently something changed with some dependency declaration? I can try to test for success, but not sure I get any info about that....

mficzel · 2019-10-21T18:18:36Z

@kitsunet https://github.com/symfony/symfony/blob/master/src/Symfony/Component/Console/Application.php#L194 returns 0 if all went fine and the composer application passes this trough. So this should be simple.

mficzel · 2019-10-22T09:08:56Z

I am suspecting that the neos-base-distribution has a dependency problem on master:
I get Installing neos/flow (4.0.25): Loading from cache which is a bit oldish and also

Package typo3/neos-nodetypes is abandoned, you should avoid using it. Use neos/nodetypes instead.
Package typo3/kickstart is abandoned, you should avoid using it. Use neos/kickstarter instead.

The reason seems to be that dev-dist(master) requires (neos: @dev) which requires (flow: *).

How should the dependencies look on master?

mficzel · 2019-10-24T06:25:02Z

@kitsunet i think i understand the problem now. The solution here requires neos/demo without version constraint wich allows composer to make all sorts of decisions.

As solution i suggest to use the "extras" section of the composer manifest as source like this.

{
    "extra": {
        "neos": {
            "create-project-sitePackageOptions": [
                {
                    "composerName": "",
                    "versionConstraint": "",
                    "description": "empty Neos"
                },
                {
                    "composerName": "neos/demo", 
                    "versionConstraint": "@dev", 
                    "description": "start with the Neos Demo content"
                }
            ]
        }
    }
}

or more compact

{
    "extra": {
        "neos": {
            "create-project-sitePackageOptions": {
                "": "empty Neos",
                "neos/demo:@dev": "start with the Neos Demo content"
            }
        }
    }
}

As side effect this will also make the life of release managers easier as they can still adjust all constraints in the composer.json of the base-dist. Also it will be much more intuitive to add more flavors of neos like neos/skeleton or neos/headless to the base distribution.

kitsunet · 2019-10-24T07:23:21Z

Mmm, yes, that could work, let me think about the syntax, because I have some more ideas in mind about this in the future...

daniellienert

Apart of nitpicks, it looks good. Haven't testes it yet.

daniellienert · 2019-11-06T08:06:54Z

Build/Classes/Composer/InstallSitePackage.php

@@ -0,0 +1,77 @@
+<?php
+namespace Neos\BaseDistribution\Composer;


Suggested change

namespace Neos\BaseDistribution\Composer;

declare(strict_types=1);

namespace Neos\BaseDistribution\Composer;

daniellienert · 2019-11-06T08:08:26Z

Build/Classes/Composer/InstallSitePackage.php

+        if ((int)$selection === 1) {
+            $io->write('No package will be installed.');
+            $io->write($distributionReadyMessagesBase);
+            $io->write('3. Create your site package "./flow site:create"');


Suggested change

$io->write('3. Create your site package "./flow site:create"');

$io->write('3. Create your own site package "./flow site:create"');

mficzel · 2019-11-08T07:36:32Z

@kitsunet a way to make this even more useful and clean be to move the InstallSitePackage.php to Neos\Flow\Composer\InstallerScripts->PostCreateProjectCmd and use the path extra.neos.create-project-packageOptions from the main manifest for configuration. That way it would be available for the flow-base-distribution and even custom neos distributions.

Offcourse this would add a composer dependency to flow which we just added in neos/flow-development-collection#1837 anyways.

mficzel · 2019-11-21T20:38:18Z

@kitsunet i played with moving the post create project command to the composer scripts in flow:
neos/flow-development-collection#1852 what do you think about this solution.

albe · 2020-04-01T20:04:37Z

So, what's the status on this one?

mficzel · 2020-04-02T08:09:33Z

It seems a bit unelegant to add a special class where all other composer magic is usually done in Neos\Flow\Composer\InstallerScripts .

I would really prefer a configurable solution via the Flow Composer Installer Scripts that can also be used for custom distributions like i sketched in neos/flow-development-collection#1852 . That would reduce this pr to some lines in the composer.json of the neos-base-distribution.

However as the other or did not get any feedback and this is still an improvement we might consider to merge this as it is an intermediate improvement.

Dismissed to avoid blocking as i mainly suggested a more flexible solution but this here is an improvement already

bwaidelich

First test works great, I would just suggest to tweak the initial choices slightly (see comment)

bwaidelich · 2020-04-06T07:25:53Z

Build/Classes/Composer/InstallSitePackage.php

+
+        $choices = [
+            'start with the Neos Demo content',
+            'empty Neos'


Just a mini suggestion:
Wouldn't it make more sense to have empty Neos the first (i.e. default) option since there will be more example content in the future probably.
Also is "empty Neos" a good name? It installs some packages that are not required per se (like neos/seo and neos/redirecthandler-*). I would totally love some kind of "bare bones" installation, too, that only requires the absolutely required packages

..I guess it was an intentional decision to keep the current behavior the default, makes sense I guess! But it could be the default and not be the first option, too

bwaidelich · 2020-04-06T07:37:39Z

Build/Classes/Composer/InstallSitePackage.php

+use Neos\Splash\DistributionBuilder\Domain\ValueObjects\PackageRequirement;
+
+/**
+ * A comopser post-create-project script to allow a choice of adding the demo site (and possible other things in the future)


Suggested change

* A comopser post-create-project script to allow a choice of adding the demo site (and possible other things in the future)

* A composer post-create-project script to allow a choice of adding the demo site (and possible other things in the future)

bwaidelich · 2020-04-06T07:39:09Z

Build/Classes/Composer/InstallSitePackage.php

+     * Setup the neos distribution
+     *
+     * @param Event $event
+     * @throws \Neos\Utility\Exception\FilesException


Suggested change

* @throws \Neos\Utility\Exception\FilesException

bwaidelich · 2020-04-06T07:39:29Z

Build/Classes/Composer/InstallSitePackage.php

+     * @throws \Neos\Utility\Exception\FilesException
+     * @throws \Exception
+     */
+    public static function setupDistribution(Event $event)


Suggested change

public static function setupDistribution(Event $event)

public static function setupDistribution(Event $event): void

bwaidelich · 2020-04-06T07:42:18Z

Build/Classes/Composer/InstallSitePackage.php

+        ];
+
+        $packages = [
+          'neos/demo',


If we make this a 1:n map we can easily add new distributions

bwaidelich · 2020-04-06T07:51:29Z

Build/Classes/Composer/InstallSitePackage.php

+        ]);
+
+        if (!$io->isInteractive()) {
+            $io->write('Non-Interacctive installation, installing no additional package(s).');


Suggested change

$io->write('Non-Interacctive installation, installing no additional package(s).');

$io->write('Non-interactive installation, installing no additional package(s).');

bwaidelich · 2020-04-06T07:52:08Z

Build/Classes/Composer/InstallSitePackage.php

+use Symfony\Component\Console\Output\ConsoleOutput;
+use Neos\Splash\DistributionBuilder\Service\PackageService;
+use Neos\Splash\DistributionBuilder\Service\JsonFileService;
+use Neos\Splash\DistributionBuilder\Domain\ValueObjects\PackageRequirement;


Are those used at all?

bwaidelich · 2020-04-06T08:01:16Z

Build/Classes/Composer/InstallSitePackage.php

+        if ((int)$selection === 1) {
+            $io->write('No package will be installed.');
+            $io->write($distributionReadyMessagesBase);
+            $io->write('3. Create your site package "./flow site:create"');


The site:create command will not kickstart a Site package!
I guess at least a package:create call is required first

bwaidelich

I had some nitpicks first, but I found some more issues that we should iron out before merging this one

bwaidelich · 2020-04-06T08:56:39Z

FYI: I'll prepare a PR-PR with the suggested changes

* Apply cosmetic fixes from neos#42 (typos, unused namespace imports, ...) * Extract installable "distributions" to static method (to make it easier to adjust/extend) * Replace "empty Neos" with a bare bones installation that only contains the necessary packages

bwaidelich · 2020-04-06T09:33:10Z

=> kitsunet#1

bwaidelich · 2020-09-15T08:51:41Z

Related discussion: https://discuss.neos.io/t/rfc-post-create-project-tasks/5141/14

mhsdesign · 2021-12-09T15:46:06Z

this would be a really valuable thing (especially for newcomers, then they wont get confused with uninstalling the demo site etc...)

i have another idea: how about that the Neos.Demo site is 'installed' in the DistributionPackages folder as one is likely to play around with it and this seems the right place. (maybe this could even work for custom git repos...).

mficzel · 2021-12-09T16:46:21Z

I would like to eventually remove the Language Configuration from Neos.Demo ... that way it could coexist with other site packages without problems. In which case it could still be installed by default without doing harm. We could even move it to the neos-dev-collection.

... plus cli-commands to add remove dimensions/dimensionvalues.

kdambekalns

Isn't this solved by now and can be closed?

mhsdesign · 2022-05-30T08:03:42Z

as far as i know this is not solved. we only have a ./flow welcome command to setup neos but we want to hack into pre composer install logic ...

mficzel · 2022-05-30T08:12:43Z

I also think this is not solved yet fully but am not sure we should keep this pr open as we will probably end up with a different solution anyways?

FEATURE: Do not install demo site and instead offer a choice

0e7e42d

kitsunet requested review from mficzel and daniellienert October 18, 2019 16:22

mficzel reviewed Oct 18, 2019

View reviewed changes

Build/Classes/Composer/InstallSitePackage.php Outdated Show resolved Hide resolved

composer.json Show resolved Hide resolved

gerhard-boden reviewed Oct 18, 2019

View reviewed changes

Build/Classes/Composer/InstallSitePackage.php Show resolved Hide resolved

gerhard-boden approved these changes Oct 18, 2019

View reviewed changes

kdambekalns self-requested a review October 18, 2019 20:25

Remove superfluous code and clean up

9807f5a

mficzel previously requested changes Oct 21, 2019

View reviewed changes

daniellienert reviewed Nov 6, 2019

View reviewed changes

bwaidelich added the Feature label Nov 30, 2019

albe changed the base branch from master to 5.2 April 4, 2020 12:08

bwaidelich reviewed Apr 6, 2020

View reviewed changes

bwaidelich requested changes Apr 6, 2020

View reviewed changes

bwaidelich mentioned this pull request Apr 6, 2020

Some Tweaks to the InstallSitePackage installer kitsunet/neos-base-distribution#1

Closed

kdambekalns reviewed May 30, 2022

View reviewed changes

mhsdesign mentioned this pull request Jun 19, 2024

TASK: Deprecate additional site kickstart generators and show helpful output for default afx case neos/neos-development-collection#5151

Merged

6 tasks

		@@ -0,0 +1,77 @@
		<?php
		namespace Neos\BaseDistribution\Composer;

	$io->write('3. Create your site package "./flow site:create"');
	$io->write('3. Create your own site package "./flow site:create"');

	* A comopser post-create-project script to allow a choice of adding the demo site (and possible other things in the future)
	* A composer post-create-project script to allow a choice of adding the demo site (and possible other things in the future)

	public static function setupDistribution(Event $event)
	public static function setupDistribution(Event $event): void

	$io->write('Non-Interacctive installation, installing no additional package(s).');
	$io->write('Non-interactive installation, installing no additional package(s).');

FEATURE: Do not install demo site and instead offer a choice #42

Are you sure you want to change the base?

FEATURE: Do not install demo site and instead offer a choice #42

Conversation

kitsunet commented Oct 18, 2019 • edited by mhsdesign Loading

mficzel left a comment

Choose a reason for hiding this comment

gerhard-boden commented Oct 18, 2019 • edited Loading

gerhard-boden commented Oct 18, 2019 • edited Loading

gerhard-boden commented Oct 18, 2019

gerhard-boden left a comment • edited Loading

Choose a reason for hiding this comment

kitsunet commented Oct 18, 2019

gerhard-boden commented Oct 18, 2019 • edited Loading

kitsunet commented Oct 19, 2019

gerhard-boden commented Oct 19, 2019

mficzel left a comment • edited Loading

Choose a reason for hiding this comment

mficzel commented Oct 21, 2019

kitsunet commented Oct 21, 2019

mficzel commented Oct 21, 2019

mficzel commented Oct 22, 2019

mficzel commented Oct 24, 2019 • edited Loading

kitsunet commented Oct 24, 2019

daniellienert left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mficzel commented Nov 8, 2019 • edited Loading

mficzel commented Nov 21, 2019

albe commented Apr 1, 2020

mficzel commented Apr 2, 2020 • edited Loading

bwaidelich left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bwaidelich left a comment

Choose a reason for hiding this comment

bwaidelich commented Apr 6, 2020

bwaidelich commented Apr 6, 2020

bwaidelich commented Sep 15, 2020

mhsdesign commented Dec 9, 2021

mficzel commented Dec 9, 2021

kdambekalns left a comment

Choose a reason for hiding this comment

mhsdesign commented May 30, 2022

mficzel commented May 30, 2022

kitsunet commented Oct 18, 2019 •

edited by mhsdesign

Loading

gerhard-boden commented Oct 18, 2019 •

edited

Loading

gerhard-boden commented Oct 18, 2019 •

edited

Loading

gerhard-boden left a comment •

edited

Loading

gerhard-boden commented Oct 18, 2019 •

edited

Loading

mficzel left a comment •

edited

Loading

mficzel commented Oct 24, 2019 •

edited

Loading

mficzel commented Nov 8, 2019 •

edited

Loading

mficzel commented Apr 2, 2020 •

edited

Loading