#243: improve internet detection checks

CHANGELOG.md

@@ -3,7 +3,8 @@
 ### New Features & Improvements
 
 * Changed `lando setup` to pull common plugins based on release `channel` to better mimic fatcore
-* Rebased `axios` on `@npmcli/agent` to improve request consistency across environments
+* Improved internet detection tests [#243](https://github.com/lando/core/issues/243)
+* Rebased `axios` and `octokit`  on `@npmcli/agent` to improve request consistency across environments
 * Updated default Docker Desktop version to `4.34.3`
 * Updated default Docker Engine version to `27.3.1`
 * Udpated recommended Docker Destkop range to `>=4.34.0`
@@ -19,6 +20,7 @@
 * Added `debugShim` to `lando.utils`
 * Added `downloadX` to `lando.utils`
 * Added `getAxios` to `lando.utils`
+* Added `getOctokit` to `lando.utils`
 * Added `getUserShell` to `lando.utils`
 * Added `getUserShellProfile` to `lando.utils`
 * Added `isVersionLte` to `lando.utils`

components/plugin.js

@@ -292,11 +292,6 @@ class Plugin {
     const channel = this.channel === 'stable' ? 'latest' : this.channel;
 
     try {
-      // check internet connection
-      const online = await require('is-online')();
-      // throw error if not online
-      if (!online) throw new Error('Cannot detect connection to internet!');
-      // process to check
       // get release data
       const data = await packument(this.spec, merge({}, [Plugin.config, {fullMetadata: true}]));
       // build a list of highest available versions

hooks/lando-setup-build-engine-darwin.js

@@ -1,5 +1,6 @@
 'use strict';
 
+const axios = require('../utils/get-axios')();
 const os = require('os');
 const path = require('path');
 const semver = require('semver');
@@ -86,6 +87,9 @@ module.exports = async (lando, options) => {
   // cosmetics
   const install = version ? `v${version}` : `build ${build}`;
 
+  // download url
+  const url = getEngineDownloadUrl(build);
+
   // darwin install task
   options.tasks.push({
     title: `Downloading build engine`,
@@ -112,8 +116,8 @@ module.exports = async (lando, options) => {
     canRun: async () => {
       // throw if we cannot resolve a semantic version to a buildid
       if (!build) throw new Error(`Could not resolve ${install} to an installable version!`);
-      // throw error if not online
-      if (!await require('is-online')()) throw new Error('Cannot detect connection to internet!');
+      // throw error if we cannot ping the download link
+      await axios.head(url);
       // throw if user is not an admin
       if (!await require('../utils/is-admin-user')()) {
         throw new Error([
@@ -127,7 +131,7 @@ module.exports = async (lando, options) => {
     task: async (ctx, task) => {
       try {
         // download the installer
-        ctx.download = await downloadDockerDesktop(getEngineDownloadUrl(build), {ctx, debug, task});
+        ctx.download = await downloadDockerDesktop(url, {ctx, debug, task});
 
         // prompt for password if interactive
         if (ctx.password === undefined && lando.config.isInteractive) {

hooks/lando-setup-build-engine-linux.js

@@ -1,5 +1,6 @@
 'use strict';
 
+const axios = require('../utils/get-axios')();
 const os = require('os');
 const path = require('path');
 
@@ -31,6 +32,7 @@ module.exports = async (lando, options) => {
   if (options.buildEngine === false) return;
 
   const version = options.buildEngine;
+  const url = 'https://get.docker.com';
 
   // darwin install task
   options.tasks.push({
@@ -46,8 +48,8 @@ module.exports = async (lando, options) => {
     canRun: async () => {
       // throw if we cannot resolve a semantic version to a buildid
       if (!version) throw new Error(`Could not resolve ${version} to an installable version!`);
-      // throw error if not online
-      if (!await require('is-online')()) throw new Error('Cannot detect connection to internet!');
+      // throw error if we cannot ping the download link
+      await axios.head(url);
       // throw if user is not an admin
       if (!await require('../utils/is-admin-user')()) {
         throw new Error([
@@ -61,7 +63,7 @@ module.exports = async (lando, options) => {
     task: async (ctx, task) => {
       try {
         // download the installer
-        ctx.download = await downloadDockerEngine('https://get.docker.com', {ctx, debug, task});
+        ctx.download = await downloadDockerEngine(url, {ctx, debug, task});
 
         // prompt for password if interactive and we dont have it
         if (ctx.password === undefined && lando.config.isInteractive) {

hooks/lando-setup-build-engine-win32.js

@@ -1,5 +1,6 @@
 'use strict';
 
+const axios = require('../utils/get-axios')();
 const os = require('os');
 const path = require('path');
 const semver = require('semver');
@@ -90,10 +91,13 @@ module.exports = async (lando, options) => {
   // get stuff from config/opts
   const build = getId(options.buildEngine);
   const version = getVersion(options.buildEngine);
+
   // cosmetics
   const buildEngine = process.platform === 'linux' ? 'docker-engine' : 'docker-desktop';
   const install = version ? `v${version}` : `build ${build}`;
 
+  const url = getEngineDownloadUrl(build);
+
   // win32 install docker desktop task
   options.tasks.push({
     title: `Downloading build engine`,
@@ -120,8 +124,8 @@ module.exports = async (lando, options) => {
     canRun: async () => {
       // throw if we cannot resolve a semantic version to a buildid
       if (!build) throw new Error(`Could not resolve ${install} to an installable version!`);
-      // throw error if not online
-      if (!await require('is-online')()) throw new Error('Cannot detect connection to internet!');
+      // throw error if we cannot ping the download link
+      await axios.head(url);
       // @TODO: check for wsl2?
       return true;
     },
@@ -135,7 +139,7 @@ module.exports = async (lando, options) => {
     task: async (ctx, task) => {
       try {
         // download the installer
-        ctx.download = await downloadDockerDesktop(getEngineDownloadUrl(build), {ctx, debug, task});
+        ctx.download = await downloadDockerDesktop(url, {ctx, debug, task});
         // script
         const script = [path.join(lando.config.userConfRoot, 'scripts', 'install-docker-desktop.ps1')];
         // args

hooks/lando-setup-install-ca-linux.js

@@ -40,8 +40,6 @@ module.exports = async (lando, options) => {
       }
     },
     canRun: async () => {
-      // Check for internet connection
-      if (!await require('is-online')()) throw new Error('Cannot detect connection to internet!');
       // Check for admin privileges
       if (!await require('../utils/is-admin-user')()) {
         throw new Error([

hooks/lando-setup-orchestrator.js

@@ -1,5 +1,6 @@
 'use strict';
 
+const axios = require('../utils/get-axios')();
 const fs = require('fs');
 const path = require('path');
 
@@ -64,10 +65,9 @@ module.exports = async (lando, options) => {
       return !!orchestratorBin && typeof orchestrator === 'string' && fs.existsSync(dest);
     },
     canRun: async () => {
-      const online = await require('is-online')();
-      // throw error if not online
-      if (!online) throw new Error('Cannot detect connection to internet!');
-
+      // throw error if we cannot ping the download link
+      await axios.head(url);
+      // true if we get here
       return true;
     },
     task: async (ctx, task) => new Promise((resolve, reject) => {

lib/lando.js

@@ -273,6 +273,7 @@ module.exports = class Lando {
 
     // updater is more complex now
     this.updates = new UpdateManager({
+      agent: this.config.userAgent,
       channel: this.config.channel,
       cli: _.get(this, 'config.cli'),
       config: getPluginConfig(this.config.pluginConfigFile, this.config.pluginConfig),

lib/updates.js

@@ -1,14 +1,15 @@
 'use strict';
 
+const axios = require('../utils/get-axios')();
 const fs = require('fs');
 const get = require('lodash/get');
+const getOctokit = require('../utils/get-octokit');
 const os = require('os');
 const path = require('path');
 const semver = require('semver');
 const uniqBy = require('lodash/uniqBy');
 
 const {color} = require('listr2');
-const {Octokit} = require('@octokit/rest');
 
 const getOS = () => {
   switch (process.platform) {
@@ -32,6 +33,7 @@ const getPluginClass = ({channel, config, debug} = {}) => {
 
 module.exports = class UpdateManager {
   constructor({
+    agent = 'Lando',
     config = {},
     cli,
     channel = 'stable',
@@ -40,6 +42,7 @@ module.exports = class UpdateManager {
     plugins = [],
   } = {}) {
     // set things
+    this.agent = agent;
     this._plugins = plugins;
     this.channel = channel;
     this.cli = cli;
@@ -108,11 +111,7 @@ module.exports = class UpdateManager {
 
       checks.push(new Promise(async resolve => {
         // summon the katkraken
-        const octokit = new Octokit({auth: get(process, 'env.LANDO_GITHUB_TOKEN')});
-        // check internet connection
-        const online = await require('is-online')();
-        // throw error if not online
-        if (!online) throw new Error('Cannot detect connection to internet!');
+        const octokit = getOctokit({auth: get(process, 'env.LANDO_GITHUB_TOKEN'), userAgent: this.agent});
         // just a helper to give consistent prez
         const extra = color.dim('@lando/cli');
 
@@ -230,8 +229,8 @@ module.exports = class UpdateManager {
             throw new Error(`Lando cannot write to ${this._cli.installPath}!`);
           }
 
-          // throw error if not online
-          if (!await require('is-online')()) throw new Error('Cannot detect connection to internet!');
+          // throw error if we cannot ping the download link
+          await axios.head(this._cli.update.download);
 
           // or true
           return true;
@@ -320,7 +319,7 @@ module.exports = class UpdateManager {
     });
 
     // summon the katkraken
-    const octokit = new Octokit({auth: get(process, 'env.LANDO_GITHUB_TOKEN')});
+    const octokit = getOctokit({auth: get(process, 'env.LANDO_GITHUB_TOKEN'), userAgent: this.agent});
 
     // get latest
     try {

lib/utils.js

@@ -110,6 +110,7 @@ module.exports = {
   debugShim: (...args) => require('../utils/debug-shim')(...args),
   downloadX: (...args) => require('../utils/download-x')(...args),
   getAxios: (...args) => require('../utils/get-axios')(...args),
+  getOctokit: (...args) => require('../utils/get-octokit')(...args),
   getUserShell: (...args) => require('../utils/get-user-shell')(...args),
   getUserShellProfile: (...args) => require('../utils/get-user-shell-profile')(...args),
   isVersionLte: (...args) => require('../utils/is-lte-version')(...args),