CLI-1711: [NCI] Database and File commands support

.github/workflows/ci.yml

@@ -96,6 +96,13 @@ jobs:
           echo AMPLITUDE_KEY=${{ secrets.AMPLITUDE_KEY }} >> .env
           echo ACLI_VERSION=${{ steps.acli-version.outputs.ACLI_VERSION }} >> .env
           echo ACLI_BUILD_DATE=$(date -u +"%Y-%m-%dT%H:%M:%SZ") >> .env
+      - name: 'Extract additional API specs from secrets'
+        run: |
+          # Extract additional acquia-spec if available
+          if [ -n "${{ secrets.ACQUIA_SPEC_ADDITIONAL }}" ]; then
+            echo "${{ secrets.ACQUIA_SPEC_ADDITIONAL }}" > assets/acquia-spec-additional.json
+            echo "ACLI_ADDITIONAL_SPEC_FILE_ACQUIA_SPEC=$(pwd)/assets/acquia-spec-additional.json" >> $GITHUB_ENV
+          fi
       - name: Build
         run: |
           composer install --no-dev --optimize-autoloader

assets/acquia-spec.version

@@ -1 +1 @@
-c1a6c6733a1ec7a8d3344cc2a2390f694ab73335
+4d2927c3f9fa1ec1770717ba363d164d9cac5e94

src/Command/Api/ApiBaseCommand.php

@@ -130,28 +130,48 @@ protected function execute(InputInterface $input, OutputInterface $output): int
             $exitCode = 1;
         }
 
-        if (substr($this->path, 0, 12) === '/translation') {
-            $this->mungeResponse($response);
+        // Extract notification UUID before removing _links if task-wait is enabled.
+        $notificationUuid = null;
+        if (!$exitCode && $this->getParamFromInput($input, 'task-wait')) {
+            $notificationUuid = CommandBase::getNotificationUuidFromResponse($response);
         }
 
-        if ($exitCode || !$this->getParamFromInput($input, 'task-wait')) {
+        // Remove _links from response for all commands.
+        $this->mungeResponse($response);
+
+        if ($exitCode || !$notificationUuid) {
             $contents = json_encode($response, JSON_THROW_ON_ERROR | JSON_PRETTY_PRINT);
             $this->output->writeln($contents);
             return $exitCode;
         }
-        $notificationUuid = CommandBase::getNotificationUuidFromResponse($response);
         $success = $this->waitForNotificationToComplete($this->cloudApiClientService->getClient(), $notificationUuid, "Waiting for task $notificationUuid to complete");
         return $success ? Command::SUCCESS : Command::FAILURE;
     }
 
-    private function mungeResponse(mixed $response): void
+    private function mungeResponse(mixed &$response): void
     {
-        if (is_object($response) && property_exists($response, '_links')) {
-            unset($response->_links);
+        if (!is_object($response) && !is_array($response)) {
+            throw new \InvalidArgumentException('mungeResponse() expects an object or array, got ' . gettype($response));
         }
-        foreach ($response as $value) {
-            if (property_exists($value, '_links')) {
-                unset($value->_links);
+
+        if (is_object($response)) {
+            if (property_exists($response, '_links')) {
+                unset($response->_links);
+            }
+            // Recursively remove _links from nested objects.
+            foreach ($response as $key => $value) {
+                if (is_object($value) || is_array($value)) {
+                    $this->mungeResponse($value);
+                }
+            }
+        } elseif (is_array($response)) {
+            if (array_key_exists('_links', $response)) {
+                unset($response['_links']);
+            }
+            foreach ($response as $key => $value) {
+                if (is_object($value) || is_array($value)) {
+                    $this->mungeResponse($response[$key]);
+                }
             }
         }
     }

src/Command/Api/ApiCommandHelper.php

@@ -326,29 +326,132 @@ private function getCloudApiSpec(string $specFilePath): array
 
         // When running the phar, the original file may not exist. In that case, always use the cache.
         if (!file_exists($specFilePath) && $cacheItemSpec->isHit()) {
-            return $cacheItemSpec->get();
+            $spec = $cacheItemSpec->get();
+        } else {
+            // Otherwise, only use cache when it is valid.
+            $checksum = md5_file($specFilePath);
+            if (
+                $this->useCloudApiSpecCache()
+                && $this->isApiSpecChecksumCacheValid($cacheItemChecksum, $checksum) && $cacheItemSpec->isHit()
+            ) {
+                $spec = $cacheItemSpec->get();
+            } else {
+                // Parse file. This can take a long while!
+                $this->logger->debug("Rebuilding caches...");
+                $spec = json_decode(file_get_contents($specFilePath), true);
+
+                $cache->warmUp([
+                    $cacheKey => $spec,
+                    $cacheKey . '.checksum' => $checksum,
+                ]);
+            }
         }
 
-        // Otherwise, only use cache when it is valid.
-        $checksum = md5_file($specFilePath);
-        // @infection-ignore-all
-        if (
-            $this->useCloudApiSpecCache()
-            && $this->isApiSpecChecksumCacheValid($cacheItemChecksum, $checksum) && $cacheItemSpec->isHit()
-        ) {
-            return $cacheItemSpec->get();
+        // Merge additional specs from environment variables or files.
+        $spec = $this->mergeAdditionalSpecs($spec, $specFilePath);
+
+        return $spec;
+    }
+
+    /**
+     * Merge additional API specs from environment variables or files.
+     *
+     * Additional specs can be provided via:
+     * - Environment variable ACLI_ADDITIONAL_SPEC_FILE_<SPECNAME> pointing to a JSON file
+     * - Environment variable ACLI_ADDITIONAL_SPEC_JSON_<SPECNAME> containing JSON directly
+     *
+     * @param array<mixed> $baseSpec The base API spec
+     * @param string $baseSpecFilePath Path to the base spec file (used for determining env var name)
+     * @return array<mixed> The merged spec
+     */
+    private function mergeAdditionalSpecs(array $baseSpec, string $baseSpecFilePath): array
+    {
+        $specName = basename($baseSpecFilePath, '.json');
+        // Normalize spec name: acquia-spec -> ACQUIA_SPEC, acsf-spec -> ACSF_SPEC.
+        $specNameNormalized = strtoupper(str_replace('-', '_', $specName));
+        $envVarFile = 'ACLI_ADDITIONAL_SPEC_FILE_' . $specNameNormalized;
+        $envVarJson = 'ACLI_ADDITIONAL_SPEC_JSON_' . $specNameNormalized;
+
+        $additionalSpec = null;
+
+        // Try to load from file path in environment variable.
+        $envFileValue = getenv($envVarFile);
+        if ($envFileValue && file_exists($envFileValue)) {
+            $this->logger->debug("Loading additional spec from file: $envFileValue");
+            $additionalSpecContent = file_get_contents($envFileValue);
+            $additionalSpec = json_decode($additionalSpecContent, true);
+            if (json_last_error() !== JSON_ERROR_NONE) {
+                $this->logger->warning("Failed to parse additional spec from file: " . json_last_error_msg());
+                $additionalSpec = null;
+            }
         }
 
-        // Parse file. This can take a long while!
-        $this->logger->debug("Rebuilding caches...");
-        $spec = json_decode(file_get_contents($specFilePath), true);
+        // Try to load from JSON in environment variable.
+        if (!$additionalSpec) {
+            $envJsonValue = getenv($envVarJson);
+            if ($envJsonValue) {
+                $this->logger->debug("Loading additional spec from environment variable: $envVarJson");
+                $additionalSpec = json_decode($envJsonValue, true);
+                if (json_last_error() !== JSON_ERROR_NONE) {
+                    $this->logger->warning("Failed to parse additional spec from env var: " . json_last_error_msg());
+                    $additionalSpec = null;
+                }
+            }
+        }
 
-        $cache->warmUp([
-            $cacheKey => $spec,
-            $cacheKey . '.checksum' => $checksum,
-        ]);
+        if (!is_array($additionalSpec) || $additionalSpec === []) {
+            return $baseSpec;
+        }
+        $keyCount = count($additionalSpec);
+        if ($keyCount === 0) {
+            throw new \LogicException('Unexpected empty additionalSpec');
+        }
 
-        return $spec;
+        // Merge paths from additional spec into base spec.
+        if (isset($additionalSpec['paths']) && is_array($additionalSpec['paths'])) {
+            if (!isset($baseSpec['paths'])) {
+                $baseSpec['paths'] = [];
+            }
+            foreach ($additionalSpec['paths'] as $path => $endpoint) {
+                if (!is_array($endpoint)) {
+                    continue;
+                }
+                // Mark all commands from additional specs as deprecated.
+                foreach ($endpoint as $method => $schema) {
+                    if (is_array($schema)) {
+                        $schema['deprecated'] = true;
+                        $endpoint[$method] = $schema;
+                    }
+                }
+                // If path already exists, merge methods; otherwise add new path.
+                if (isset($baseSpec['paths'][$path])) {
+                    $baseSpec['paths'][$path] = array_merge($baseSpec['paths'][$path], $endpoint);
+                } else {
+                    $baseSpec['paths'][$path] = $endpoint;
+                }
+            }
+            $this->logger->debug("Merged " . count($additionalSpec['paths']) . " additional paths into spec (marked as deprecated)");
+        }
+
+        // Merge components if present.
+        if (isset($additionalSpec['components']) && is_array($additionalSpec['components'])) {
+            if (!isset($baseSpec['components'])) {
+                $baseSpec['components'] = [];
+            }
+            foreach ($additionalSpec['components'] as $componentType => $components) {
+                if (!isset($baseSpec['components'][$componentType])) {
+                    $baseSpec['components'][$componentType] = [];
+                }
+                if (is_array($components)) {
+                    $baseSpec['components'][$componentType] = array_merge(
+                        $baseSpec['components'][$componentType],
+                        $components
+                    );
+                }
+            }
+        }
+
+        return $baseSpec;
     }
 
     /**

src/EventListener/ExceptionListener.php

@@ -85,9 +85,6 @@ public function onConsoleError(ConsoleErrorEvent $event): void
         }
 
         if ($error instanceof ApiErrorException) {
-            if (($command = $event->getCommand()) && $error->getResponseBody()->error === 'not_found' && $command->getName() === 'api:environments:log-download') {
-                $this->helpMessages[] = "You must create logs (api:environments:log-create) prior to downloading them";
-            }
             switch ($errorMessage) {
                 case "There are no available Cloud IDEs for this application.\n":
                     $this->helpMessages[] = "Delete an existing IDE via <bg=$this->messagesBgColor;fg=$this->messagesFgColor;options=bold>acli ide:delete</> or contact your Account Manager or Acquia Sales to purchase additional IDEs.";