-
-
Notifications
You must be signed in to change notification settings - Fork 4.7k
Sort app scripts topologically by its dependencies #30385
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,97 @@ | ||
| <?php | ||
| /** | ||
| * @copyright Copyright (c) 2021, Jonas Meurer <jonas@freesources.org> | ||
| * | ||
| * @author Jonas Meurer <jonas@freesources.org> | ||
| * | ||
| * @license GNU AGPL version 3 or any later version | ||
| * | ||
| * This program is free software: you can redistribute it and/or modify | ||
| * it under the terms of the GNU Affero General Public License as | ||
| * published by the Free Software Foundation, either version 3 of the | ||
| * License, or (at your option) any later version. | ||
| * | ||
| * This program is distributed in the hope that it will be useful, | ||
| * but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
| * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
| * GNU Affero General Public License for more details. | ||
| * | ||
| * You should have received a copy of the GNU Affero General Public License | ||
| * along with this program. If not, see <http://www.gnu.org/licenses/>. | ||
| * | ||
| */ | ||
|
|
||
| namespace OC; | ||
|
|
||
| class AppScriptDependency { | ||
| /** @var string */ | ||
| private $id; | ||
|
|
||
| /** @var array */ | ||
| private $deps; | ||
|
|
||
| /** @var bool */ | ||
| private $visited; | ||
|
|
||
| /** | ||
| * @param string $id | ||
| * @param array $deps | ||
| * @param bool $visited | ||
| */ | ||
| public function __construct(string $id, array $deps = [], bool $visited = false) { | ||
| $this->setId($id); | ||
| $this->setDeps($deps); | ||
| $this->setVisited($visited); | ||
| } | ||
|
|
||
| /** | ||
| * @return string | ||
| */ | ||
| public function getId(): string { | ||
| return $this->id; | ||
| } | ||
|
|
||
| /** | ||
| * @param string $id | ||
| */ | ||
| public function setId(string $id): void { | ||
| $this->id = $id; | ||
| } | ||
|
|
||
| /** | ||
| * @return array | ||
| */ | ||
| public function getDeps(): array { | ||
| return $this->deps; | ||
| } | ||
|
|
||
| /** | ||
| * @param array $deps | ||
| */ | ||
| public function setDeps(array $deps): void { | ||
| $this->deps = $deps; | ||
| } | ||
|
|
||
| /** | ||
| * @param string $dep | ||
| */ | ||
| public function addDep(string $dep): void { | ||
| if (!in_array($dep, $this->deps, true)) { | ||
| $this->deps[] = $dep; | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * @return bool | ||
| */ | ||
| public function isVisited(): bool { | ||
| return $this->visited; | ||
| } | ||
|
|
||
| /** | ||
| * @param bool $visited | ||
| */ | ||
| public function setVisited(bool $visited): void { | ||
| $this->visited = $visited; | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,105 @@ | ||
| <?php | ||
| /** | ||
| * @copyright Copyright (c) 2021, Jonas Meurer <jonas@freesources.org> | ||
| * | ||
| * @author Jonas Meurer <jonas@freesources.org> | ||
| * | ||
| * @license GNU AGPL version 3 or any later version | ||
| * | ||
| * This program is free software: you can redistribute it and/or modify | ||
| * it under the terms of the GNU Affero General Public License as | ||
| * published by the Free Software Foundation, either version 3 of the | ||
| * License, or (at your option) any later version. | ||
| * | ||
| * This program is distributed in the hope that it will be useful, | ||
| * but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
| * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
| * GNU Affero General Public License for more details. | ||
| * | ||
| * You should have received a copy of the GNU Affero General Public License | ||
| * along with this program. If not, see <http://www.gnu.org/licenses/>. | ||
| * | ||
| */ | ||
|
|
||
| namespace OC; | ||
|
|
||
| use Psr\Log\LoggerInterface; | ||
|
|
||
| /** | ||
| * Sort scripts topologically by their dependencies | ||
| * Implementation based on https://github.com/marcj/topsort.php | ||
| */ | ||
| class AppScriptSort { | ||
| /** @var LoggerInterface */ | ||
| private $logger; | ||
|
|
||
| public function __construct(LoggerInterface $logger) { | ||
| $this->logger = $logger; | ||
| } | ||
|
|
||
| /** | ||
| * Recursive topological sorting | ||
| * | ||
| * @param AppScriptDependency $app | ||
| * @param array $parents | ||
| * @param array $scriptDeps | ||
| * @param array $sortedScriptDeps | ||
| */ | ||
| private function topSortVisit( | ||
| AppScriptDependency $app, | ||
| array &$parents, | ||
| array &$scriptDeps, | ||
| array &$sortedScriptDeps): void { | ||
| // Detect and log circular dependencies | ||
| if (isset($parents[$app->getId()])) { | ||
| $this->logger->error('Circular dependency in app scripts at app ' . $app->getId()); | ||
| } | ||
|
|
||
| // If app has not been visited | ||
| if (!$app->isVisited()) { | ||
| $parents[$app->getId()] = true; | ||
| $app->setVisited(true); | ||
|
|
||
| foreach ($app->getDeps() as $dep) { | ||
| if ($app->getId() === $dep) { | ||
| // Ignore dependency on itself | ||
| continue; | ||
| } | ||
|
|
||
| if (isset($scriptDeps[$dep])) { | ||
| $newParents = $parents; | ||
| $this->topSortVisit($scriptDeps[$dep], $newParents, $scriptDeps, $sortedScriptDeps); | ||
| } | ||
| } | ||
|
|
||
| $sortedScriptDeps[] = $app->getId(); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * @return array scripts sorted by dependencies | ||
| */ | ||
| public function sort(array $scripts, array $scriptDeps): array { | ||
| // Sort scriptDeps into sortedScriptDeps | ||
| $sortedScriptDeps = []; | ||
| foreach ($scriptDeps as $app) { | ||
| $parents = []; | ||
| $this->topSortVisit($app, $parents, $scriptDeps, $sortedScriptDeps); | ||
| } | ||
|
|
||
| // Sort scripts into sortedScripts based on sortedScriptDeps order | ||
| $sortedScripts = []; | ||
| foreach ($sortedScriptDeps as $app) { | ||
| $sortedScripts[$app] = $scripts[$app] ?? []; | ||
| } | ||
|
|
||
| // Add remaining scripts | ||
| foreach (array_keys($scripts) as $app) { | ||
| if (!isset($sortedScripts[$app])) { | ||
| $sortedScripts[$app] = $scripts[$app]; | ||
| } | ||
| } | ||
|
|
||
| return $sortedScripts; | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Unfortunately, this causes an psalm warning, since now OCP depends on OC. This wasn't found earlier since psalm was broken but it appear on #30508
I'm not sure if we can ignore this issue and just add it to the baseline or if we should fix it
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fine to add to the baseline from my perspective as it is only used in the method implementation and not exposed in any kinds.