Skip to content

Commit

Permalink
Code styling
Browse files Browse the repository at this point in the history
  • Loading branch information
@HazAT
HazAT committed Apr 13, 2024
1 parent 97da740 commit c021cfc
Show file tree
Hide file tree
Showing 3 changed files with 166 additions and 57 deletions.
6 changes: 6 additions & 0 deletions webserver/app/Services/PackageInfoService.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -55,4 +55,10 @@ public function getFeatures(): array
{
return $this->data['features'];
}

public function getCreatedAt(): string
{
$date = new \DateTime($this->data['createdAt']);
return $date->format('Y-m-d H:i:s');
}
}
215 changes: 159 additions & 56 deletions webserver/app/Services/RegistryService.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,106 +3,163 @@
namespace App\Services;

use Illuminate\Support\Facades\File;
use Illuminate\Support\Collection;
use Illuminate\Support\Str;

class RegistryService
{
const NAMESPACE_FILE_MARKER = '__NAMESPACE__';

protected $path;

/**
* RegistryService constructor.
*/
public function __construct()
{
$this->path = dirname(base_path());
}

protected function _path(...$args)
/**
* Validate the canonical format and unpack into registry and package.
*
* @param string $canonical The canonical name of the package.
* @return array An array with elements: registry and package.
* @throws \ValueError
*/
protected function validateCanonical($canonical): array
{
return implode(DIRECTORY_SEPARATOR, array_merge([$this->path], $args));
}

protected function validateCanonical($canonical)
{
if (! str_contains($canonical, ':')) {
return throw new \ValueError("Invalid canonical: {$canonical}");
if (!Str::contains($canonical, ':')) {
throw new \ValueError("Invalid canonical: {$canonical}");
}

[$registry, $package] = explode(':', $canonical, 2);
$package = str_replace(':', '/', $package);

return [$registry, $package];
}

public function getPackage($canonical, $version = 'latest')
/**
* Fetches a package by its canonical name and version.
*
* @param string $canonical The canonical name of the package.
* @param string $version The version of the package.
* @return PackageInfoService|null
*/
public function getPackage($canonical, $version = 'latest'): ?PackageInfoService
{
[$registry, $package] = $this->validateCanonical($canonical);
$package = str_replace(':', '/', $package);

$path = $this->_path('packages', $registry, $package, "{$version}.json");
$content = File::get($path);
$path = $this->buildPackagePath($registry, $package, $version);
if (!File::exists($path)) {
return null;
}

$content = File::get($path);
return new PackageInfoService(json_decode($content, true));
}

public function getPackageVersions($canonical)
/**
* Builds the filesystem path for a package.
*
* @param string $registry The name of the registry.
* @param string $package The name of the package.
* @param string $version The version of the package.
* @return string
*/
protected function buildPackagePath($registry, $package, $version): string
{
return $this->fileSystemPath('packages', $registry, $package, "{$version}.json");
}

/**
* Build a filesystem path based on given segments.
*
* @param mixed ...$segments Path segments.
* @return string
*/
protected function fileSystemPath(...$segments): string
{
return implode(DIRECTORY_SEPARATOR, array_merge([$this->path], $segments));
}


/**
* Retrieves all versions of a package.
*
* @param string $canonical The canonical name of the package.
* @return array An array of all versions of the package.
*/
public function getPackageVersions($canonical): array
{
[$registry, $package] = $this->validateCanonical($canonical);
$versions = collect();
$versions = new Collection();

$files = File::files($this->_path('packages', $registry, $package));
$files = File::files($this->fileSystemPath('packages', $registry, $package));
foreach ($files as $file) {
if (str_ends_with($file->getFilename(), '.json')) {
$content = File::get($file->getPathname());
$versions->add(json_decode($content, true)['version']);
if ($file->getExtension() === 'json') {
$versions->push($this->getJsonContent($file->getPathname())['version']);
}
}

return $versions->sort(function ($a, $b) {
return version_compare($a, $b);
})->values()->all();
return $versions->sort('version_compare')->values()->all();
}

public function iteratePackages()
/**
* Iterates over all packages in the registry.
*
* This method iterates over all directories in the 'packages' directory. For each directory, it checks if it is a namespace marker.
* If it is, it yields all packages in the namespace. If it's not, it yields the package directly.
*
* @return \Generator A generator yielding package names in the format 'registry:package'.
*/
public function iteratePackages(): \Generator
{
$packageRegistries = File::directories($this->_path('packages'));
foreach ($packageRegistries as $packageRegistry) {
$items = File::directories($packageRegistry);
foreach ($items as $item) {
$namespaceFilePath = implode(DIRECTORY_SEPARATOR, [realpath($item), self::NAMESPACE_FILE_MARKER]);
if (File::exists($namespaceFilePath)) {
$subitems = File::directories(realpath($item));
foreach ($subitems as $subitem) {
if (basename($subitem) !== self::NAMESPACE_FILE_MARKER) {
yield basename($packageRegistry).':'.basename($item).'/'.basename($subitem);
}
}
foreach (File::directories($this->fileSystemPath('packages')) as $packageRegistry) {
foreach (File::directories($packageRegistry) as $item) {
if ($this->isNamespaceMarker($item)) {
yield from $this->iterateNamespacePackages($item, $packageRegistry);
} else {
yield basename($packageRegistry).':'.basename($item);
yield basename($packageRegistry) . ':' . basename($item);
}
}
}
}

public function getPackages($strict = false)
/**
* Retrieves all packages in the registry.
*
* This method iterates over all packages in the registry. For each package, it tries to get the package details.
* If the package details are successfully retrieved, it adds the package to the packages array.
*
* @param bool $strict If set to true, an exception will be thrown if a package cannot be retrieved. If set to false, the method will continue to the next package.
* @return array An associative array of packages, with the canonical name as the key and the package details as the value.
*/
public function getPackages($strict = false): array
{
$packages = [];
foreach ($this->iteratePackages() as $packageName) {
$pkg = $this->getPackage($packageName);
if ($pkg === null) {
if ($strict) {
throw new \ValueError("Package does not exist or invalid canonical: {$packageName}");
}
} else {
$packages[$pkg->getCanonical()] = $pkg;
$package = $this->tryGetPackage($packageName, $strict);
if ($package !== null) {
$packages[$package->getCanonical()] = $package;
}
}

return $packages;
}

public function getSdks($strict = false)
/**
* Retrieves all SDKs in the registry.
*
* This method iterates over all directories in the 'sdks' directory. For each directory, it tries to get the package details.
* If the package details are successfully retrieved, it adds the package to the sdks array.
*
* @param bool $strict If set to true, an exception will be thrown if a package cannot be retrieved. If set to false, the method will continue to the next package.
* @return array An associative array of SDKs, with the SDK id as the key and the package details as the value.
*/
public function getSdks($strict = false): array
{
$sdks = [];
$links = File::directories($this->_path('sdks'));
$links = File::directories($this->fileSystemPath('sdks'));
foreach ($links as $link) {
try {
$content = File::get(implode(DIRECTORY_SEPARATOR, [realpath($link), 'latest.json']));
Expand All @@ -111,7 +168,7 @@ public function getSdks($strict = false)

if ($pkg === null) {
if ($strict) {
throw new \ValueError('Package '.basename($link).", canonical cannot be resolved: {$canonical}");
throw new \ValueError('Package ' . basename($link) . ", canonical cannot be resolved: {$canonical}");
}
} else {
$sdks[basename($link)] = $pkg;
Expand All @@ -125,10 +182,20 @@ public function getSdks($strict = false)
return $sdks;
}

public function getSdk($sdkId, $version = 'latest')
/**
* Retrieves a specific SDK in the registry by its ID.
*
* This method tries to get the package details of the SDK. If the package details are successfully retrieved, it returns the package.
* If the package details cannot be retrieved, it returns null.
*
* @param string $sdkId The ID of the SDK.
* @param string $version The version of the SDK. Defaults to 'latest'.
* @return PackageInfoService|null The package details of the SDK, or null if the package details cannot be retrieved.
*/
public function getSdk($sdkId, $version = 'latest'): ?PackageInfoService
{
try {
$content = File::get($this->_path('sdks', $sdkId, 'latest.json'));
$content = File::get($this->fileSystemPath('sdks', $sdkId, 'latest.json'));
$canonical = json_decode($content, true)['canonical'];

return $this->getPackage($canonical, $version);
Expand All @@ -137,10 +204,10 @@ public function getSdk($sdkId, $version = 'latest')
}
}

public function getAwsLambdaLayers()
public function getAwsLambdaLayers(): array
{
$layers = [];
$links = File::directories($this->_path('aws-lambda-layers'));
$links = File::directories($this->fileSystemPath('aws-lambda-layers'));
foreach ($links as $link) {
try {
$content = File::get(implode(DIRECTORY_SEPARATOR, [realpath($link), 'latest.json']));
Expand All @@ -154,10 +221,10 @@ public function getAwsLambdaLayers()
return $layers;
}

public function getApps()
public function getApps(): array
{
$apps = [];
$links = File::directories($this->_path('apps'));
$links = File::directories($this->fileSystemPath('apps'));
foreach ($links as $link) {
try {
$app = $this->getApp(basename($link));
Expand All @@ -175,7 +242,7 @@ public function getApps()
public function getApp($appId, $version = 'latest')
{
try {
$content = File::get($this->_path('apps', $appId, "{$version}.json"));
$content = File::get($this->fileSystemPath('apps', $appId, "{$version}.json"));

return json_decode($content, true);
} catch (\Exception $e) {
Expand All @@ -185,12 +252,12 @@ public function getApp($appId, $version = 'latest')

public function getMarketingSlugs()
{
$content = File::get($this->_path('misc', 'marketing-slugs.json'));
$content = File::get($this->fileSystemPath('misc', 'marketing-slugs.json'));

return json_decode($content, true);
}

public function resolveMarketingSlug($slug)
public function resolveMarketingSlug($slug): ?array
{
$slugs = $this->getMarketingSlugs();
$data = $slugs[$slug] ?? null;
Expand Down Expand Up @@ -224,4 +291,40 @@ public function resolveMarketingSlug($slug)
'target' => $target,
];
}

private function getJsonContent($path)
{
if (!File::exists($path)) {
return [];
}
return json_decode(File::get($path), true);
}

private function isNamespaceMarker($item): bool
{
$namespaceFilePath = implode(DIRECTORY_SEPARATOR, [$item, self::NAMESPACE_FILE_MARKER]);
return File::exists($namespaceFilePath);
}

private function iterateNamespacePackages($item, $packageRegistry): \Generator
{
foreach (File::directories($item) as $subitem) {
if (basename($subitem) !== self::NAMESPACE_FILE_MARKER) {
yield basename($packageRegistry) . ':' . basename($item) . '/' . basename($subitem);
}
}
}

private function tryGetPackage($packageName, $strict): ?PackageInfoService
{
try {
$pkg = $this->getPackage($packageName);
} catch (\Exception $e) {
if ($strict) {
throw $e;
}
return null;
}
return $pkg;
}
}
2 changes: 1 addition & 1 deletion webserver/resources/views/livewire/feature-matrix.blade.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
<dt>
@include('components/platformicon', ['icon' => $sdkIdentifer])

<p class="ml-16 truncate text-sm font-medium text-gray-500">{{ $sdk->getVersion() }} | {{ $sdkIdentifer }}</p>
<p class="ml-16 truncate text-sm font-medium text-gray-500">{{ $sdk->getVersion() }} ({{ $sdk->getCreatedAt() }}) | {{ $sdkIdentifer }}</p>
</dt>
<dd class="ml-16 flex items-baseline pb-6 sm:pb-7">
<p class="text-2xl font-semibold text-gray-900">{{ $sdk->getName() }}</p>
Expand Down

0 comments on commit c021cfc

Please sign in to comment.