Fix backend logic bugs: add default opts, accept version info in warning, prevent recursion, filter false versions

Author: cursoragent

lib/backend-manager.js

@@ -54,7 +54,7 @@ class BackendManager {
    * Returns a fully wired `Engine` instance ready for use by `lando.engine`.
    *
    * @param {string} [id='lando'] - The Lando instance identifier.
-   * @returns {Engine} A configured Engine instance.
+   * @return {Engine} A configured Engine instance.
    */
   createEngine(id = 'lando') {
     const engineType = this.config.engine || 'auto';
@@ -80,7 +80,7 @@ class BackendManager {
    * - Returns `new Engine(daemon, docker, compose, config)`
    *
    * @param {string} id - The Lando instance identifier.
-   * @returns {Engine} A Docker-backed Engine instance.
+   * @return {Engine} A Docker-backed Engine instance.
    * @private
    */
   _createDockerEngine(id) {
@@ -104,7 +104,7 @@ class BackendManager {
     );
 
     const compose = (cmd, datum) => {
-      const run = dockerCompose[cmd](datum.compose, datum.project, datum.opts);
+      const run = dockerCompose[cmd](datum.compose, datum.project, datum.opts || {});
       return this.shell.sh([orchestratorBin].concat(run.cmd), run.opts);
     };
 
@@ -124,7 +124,7 @@ class BackendManager {
    * `{cmd, opts}` shell descriptor, then executes via `shell.sh([nerdctlBin, ...cmd], opts)`.
    *
    * @param {string} id - The Lando instance identifier.
-   * @returns {Engine} A containerd-backed Engine instance.
+   * @return {Engine} A containerd-backed Engine instance.
    * @private
    */
   _createContainerdEngine(id) {
@@ -171,7 +171,7 @@ class BackendManager {
     // as the Docker path. Gets {cmd, opts} from NerdctlCompose, then executes
     // via shell.sh([nerdctlBin, ...cmd], opts).
     const compose = (cmd, datum) => {
-      const run = nerdctlCompose[cmd](datum.compose, datum.project, datum.opts);
+      const run = nerdctlCompose[cmd](datum.compose, datum.project, datum.opts || {});
       return this.shell.sh([nerdctlBin].concat(run.cmd), run.opts);
     };
 
@@ -193,7 +193,7 @@ class BackendManager {
    * Logs which engine was selected.
    *
    * @param {string} id - The Lando instance identifier.
-   * @returns {Engine} An Engine instance using the auto-detected backend.
+   * @return {Engine} An Engine instance using the auto-detected backend.
    * @private
    */
   _createAutoEngine(id) {

lib/backends/containerd/containerd-container.js

@@ -15,7 +15,7 @@ const runCommand = require('../../../utils/run-command');
  * Helper to determine if any file exists in an array of files.
  *
  * @param {Array<string>} files - Array of file paths to check.
- * @returns {boolean}
+ * @return {boolean}
  * @private
  */
 const srcExists = (files = []) => _.reduce(files, (exists, file) => fs.existsSync(file) || exists, false);
@@ -33,7 +33,7 @@ const srcExists = (files = []) => _.reduce(files, (exists, file) => fs.existsSyn
  * - Labels whose values contain `,` within values that also contain `=`
  *
  * @param {string|Object} labels - Labels string from nerdctl or object from inspect.
- * @returns {Object} Docker-compatible labels object.
+ * @return {Object} Docker-compatible labels object.
  * @private
  */
 const parseLabels = labels => {
@@ -91,7 +91,7 @@ const parseLabels = labels => {
  * - `Status`   → status text
  *
  * @param {Object} nerdctlContainer - A parsed JSON line from `nerdctl ps --format json`.
- * @returns {Object} Docker API-compatible container object.
+ * @return {Object} Docker API-compatible container object.
  * @private
  */
 const normalizeContainer = nerdctlContainer => {
@@ -164,7 +164,7 @@ class ContainerdContainer extends ContainerBackend {
    * "No such container", "no such object", "not found".
    *
    * @param {Error} err - The error to inspect.
-   * @returns {boolean} `true` if the error indicates a missing resource.
+   * @return {boolean} `true` if the error indicates a missing resource.
    * @private
    */
   _isNotFoundError(err) {
@@ -184,7 +184,7 @@ class ContainerdContainer extends ContainerBackend {
    * @param {Array<string>} args - nerdctl subcommand and arguments.
    * @param {Object} [opts={}] - Additional options passed to `run-command`.
    * @param {boolean} [opts.ignoreReturnCode=false] - Whether to suppress non-zero exit errors.
-   * @returns {Promise<string>} The trimmed stdout from the command.
+   * @return {Promise<string>} The trimmed stdout from the command.
    * @throws {Error} If the command exits non-zero and `ignoreReturnCode` is false.
    * @private
    */
@@ -216,7 +216,7 @@ class ContainerdContainer extends ContainerBackend {
    *
    * @param {string} name - The name of the network to create.
    * @param {Object} [opts={}] - Additional network creation options.
-   * @returns {Promise<Object>} Network inspect data.
+   * @return {Promise<Object>} Network inspect data.
    */
   async createNet(name, opts = {}) {
     const args = ['network', 'create'];
@@ -254,7 +254,7 @@ class ContainerdContainer extends ContainerBackend {
    * Docker-compatible JSON.
    *
    * @param {string} cid - A container identifier (hash, name, or short id).
-   * @returns {Promise<Object>} Container inspect data.
+   * @return {Promise<Object>} Container inspect data.
    * @throws {Error} If the container does not exist.
    */
   async scan(cid) {
@@ -270,7 +270,7 @@ class ContainerdContainer extends ContainerBackend {
    * to prevent race conditions when containers are removed between checks.
    *
    * @param {string} cid - A container identifier.
-   * @returns {Promise<boolean>}
+   * @return {Promise<boolean>}
    */
   async isRunning(cid) {
     try {
@@ -303,9 +303,10 @@ class ContainerdContainer extends ContainerBackend {
    * @param {string}  [options.project] - Filter to a specific project name.
    * @param {Array<string>} [options.filter] - Additional `key=value` filters.
    * @param {string}  [separator='_'] - Container name separator.
-   * @returns {Promise<Array<Object>>} Array of Lando container descriptors.
+   * @param {number}  [_retryCount=0] - Internal retry counter to prevent unbounded recursion.
+   * @return {Promise<Array<Object>>} Array of Lando container descriptors.
    */
-  async list(options = {}, separator = '_') {
+  async list(options = {}, separator = '_', _retryCount = 0) {
     // Get raw container list from nerdctl (JSONL: one JSON object per line)
     let rawOutput;
     try {
@@ -380,7 +381,10 @@ class ContainerdContainer extends ContainerBackend {
     // If any container has been up for only a brief moment, retry
     // (matches Landerode behavior to avoid transient states)
     if (_.find(containers, container => container.status === 'Up Less than a second')) {
-      return this.list(options, separator);
+      if (_retryCount < 10) {
+        return this.list(options, separator, _retryCount + 1);
+      }
+      this.debug('list retry limit reached, proceeding with transient container states');
     }
 
     // Add running status flag
@@ -401,7 +405,7 @@ class ContainerdContainer extends ContainerBackend {
    * @param {Object} [opts={v: true, force: false}] - Removal options.
    * @param {boolean} [opts.v=true] - Also remove associated anonymous volumes.
    * @param {boolean} [opts.force=false] - Force-remove a running container.
-   * @returns {Promise<void>}
+   * @return {Promise<void>}
    */
   async remove(cid, opts = {v: true, force: false}) {
     const args = ['rm'];
@@ -428,7 +432,7 @@ class ContainerdContainer extends ContainerBackend {
    *
    * @param {string} cid - A container identifier.
    * @param {Object} [opts={}] - Stop options (e.g. `{t: 10}` for timeout in seconds).
-   * @returns {Promise<void>}
+   * @return {Promise<void>}
    */
   async stop(cid, opts = {}) {
     const args = ['stop'];
@@ -458,7 +462,7 @@ class ContainerdContainer extends ContainerBackend {
    * handle interface.
    *
    * @param {string} id - The network id or name.
-   * @returns {Object} A network handle with `inspect()` and `remove()` methods.
+   * @return {Object} A network handle with `inspect()` and `remove()` methods.
    */
   getNetwork(id) {
     return {
@@ -467,7 +471,7 @@ class ContainerdContainer extends ContainerBackend {
 
       /**
        * Inspect the network and return its metadata.
-       * @returns {Promise<Object>} Network inspect data.
+       * @return {Promise<Object>} Network inspect data.
        */
       inspect: async () => {
         const data = await this._nerdctl(['network', 'inspect', id]);
@@ -477,7 +481,7 @@ class ContainerdContainer extends ContainerBackend {
 
       /**
        * Remove the network.
-       * @returns {Promise<void>}
+       * @return {Promise<void>}
        */
       remove: async () => {
         try {
@@ -498,7 +502,7 @@ class ContainerdContainer extends ContainerBackend {
    *
    * @param {Object} [opts={}] - Filter options.
    * @param {Object} [opts.filters] - Filters object (e.g. `{name: ['mynet']}` or `{id: ['abc']}`).
-   * @returns {Promise<Array<Object>>} Array of network objects.
+   * @return {Promise<Array<Object>>} Array of network objects.
    */
   async listNetworks(opts = {}) {
     let rawOutput;
@@ -565,7 +569,7 @@ class ContainerdContainer extends ContainerBackend {
    * Dockerode Container handle interface.
    *
    * @param {string} cid - The container id or name.
-   * @returns {Object} A container handle with `inspect()`, `remove()`, and `stop()` methods.
+   * @return {Object} A container handle with `inspect()`, `remove()`, and `stop()` methods.
    */
   getContainer(cid) {
     return {
@@ -574,21 +578,21 @@ class ContainerdContainer extends ContainerBackend {
 
       /**
        * Inspect the container and return its metadata.
-       * @returns {Promise<Object>} Container inspect data.
+       * @return {Promise<Object>} Container inspect data.
        */
       inspect: () => this.scan(cid),
 
       /**
        * Remove the container.
        * @param {Object} [opts] - Removal options.
-       * @returns {Promise<void>}
+       * @return {Promise<void>}
        */
       remove: opts => this.remove(cid, opts),
 
       /**
        * Stop the container.
        * @param {Object} [opts] - Stop options.
-       * @returns {Promise<void>}
+       * @return {Promise<void>}
        */
       stop: opts => this.stop(cid, opts),
     };

lib/engine.js

@@ -194,7 +194,7 @@ module.exports = class Engine {
     const semver = require('semver');
 
     // helper to normalize a supported versions object into comparison-ready format
-    const normalize = (sv) => _(sv)
+    const normalize = sv => _(sv)
       .map((data, name) => _.merge({}, data, {name}))
       .map(data => ([data.name, {
         satisfies: data.satisfies || `${data.min} - ${data.max}`,
@@ -207,12 +207,19 @@ module.exports = class Engine {
 
     return this.daemon.getVersions().then(versions => {
       // Detect containerd backend: versions have containerd key instead of desktop/engine
-      const isContainerd = versions.hasOwnProperty('containerd');
+      const isContainerd = Object.prototype.hasOwnProperty.call(versions, 'containerd');
 
       let normalizedVersions;
       if (isContainerd) {
         // containerd format: {containerd, buildkit, nerdctl}
         normalizedVersions = normalize(this.supportedContainerdVersions);
+
+        // Remove false values (binaries that couldn't be versioned)
+        Object.keys(versions).forEach(key => {
+          if (versions[key] === false || versions[key] === 'skip') {
+            delete versions[key];
+          }
+        });
       } else {
         // Docker format: {desktop, engine, compose}
         normalizedVersions = normalize(supportedVersions);

messages/update-nerdctl-warning.js

@@ -1,13 +1,14 @@
 'use strict';
 
 // checks to see if a setting is disabled
-module.exports = () => ({
+module.exports = ({version, update, link} = {}) => ({
   type: 'warning',
   title: 'Recommend updating NERDCTL',
   detail: [
-    'Looks like you might be falling a bit behind on nerdctl.',
+    `You have version ${version || 'unknown'} but we recommend updating to ${update || 'the latest version'}.`,
     'In order to ensure the best stability and support we recommend you update',
     'by running the hidden "lando setup" command.',
   ],
   command: 'lando setup --skip-common-plugins',
+  url: link,
 });