Skip to content

feat: Add dedicated method to load init scripts #40323

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.

Sign up for GitHub

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 1 commit into from
Sep 8, 2023
Merged

feat: Add dedicated method to load init scripts #40323

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 26 additions & 11 deletions lib/public/Util.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@
use OC\AppScriptDependency;
use OC\AppScriptSort;
use bantu\IniGetWrapper\IniGetWrapper;
use OCP\Share\IManager;
use Psr\Container\ContainerExceptionInterface;

/**
Expand All @@ -57,17 +58,11 @@
* @since 4.0.0
*/
class Util {
/** @var \OCP\Share\IManager */
private static $shareManager;
private static ?IManager $shareManager = null;

/** @var array */
private static $scripts = [];

/** @var array */
private static $scriptDeps = [];

/** @var array */
private static $sortedScriptDeps = [];
private static array $scriptsInit = [];
private static array $scripts = [];
private static array $scriptDeps = [];

/**
* get the current installed version of Nextcloud
Expand Down Expand Up @@ -163,6 +158,25 @@ public static function addStyle($application, $file = null) {
\OC_Util::addStyle($application, $file);
}

/**
* Add a standalone init js file that is loaded for initialization
*
* Be careful loading scripts using this method as they are loaded early
* and block the initial page rendering. They should not have dependencies
* on any other scripts than core-common and core-main.
*
* @since 28.0.0
*/
public static function addInitScript(string $application, string $file): void {
if (!empty($application)) {
$path = "$application/js/$file";
} else {
$path = "js/$file";
}

self::$scriptsInit[] = $path;
}

/**
* add a javascript file
*
Expand Down Expand Up @@ -214,7 +228,8 @@ public static function getScripts(): array {
$sortedScripts = $scriptSort->sort(self::$scripts, self::$scriptDeps);

// Flatten array and remove duplicates
$sortedScripts = $sortedScripts ? array_merge(...array_values(($sortedScripts))) : [];
$sortedScripts = array_merge([self::$scriptsInit], $sortedScripts);
$sortedScripts = array_merge(...array_values($sortedScripts));

// Override core-common and core-main order
if (in_array('core/js/main', $sortedScripts)) {
Expand Down