feat(help): Skip version checks if it will cause permission prompts

When a user hasn't granted net permissions to the default upgrade provider,
they would be prompted to allow it when running the `help`/`--help` command.

This commit adds an extra method to `Provider` where a provider should check
any permissions it needs to return available versions have been pre-granted.

If the necessary permissions have NOT been granted, the help command will
skip checking for newer versions. The upgrade command is not affected.

BREAKING CHANGE: Custom `Provider` implementations will have to implement `hasRequiredPermissions()`

Author: annervisser

command/upgrade/_check_version.ts

@@ -10,6 +10,11 @@ export async function checkVersion(cmd: Command<any>): Promise<void> {
   if (!isUpgradeCommand(upgradeCommand)) {
     return;
   }
+
+  if (!await upgradeCommand.hasRequiredPermissions()) {
+    // If not all required permissions were pre-granted, skip the version check to prevent prompting user
+    return;
+  }
   const latestVersion = await upgradeCommand.getLatestVersion();
   const currentVersion = mainCommand.getVersion();
 
@@ -23,9 +28,11 @@ export async function checkVersion(cmd: Command<any>): Promise<void> {
 }
 
 function isUpgradeCommand(command: unknown): command is UpgradeCommandImpl {
-  return command instanceof Command && "getLatestVersion" in command;
+  return command instanceof Command && "getLatestVersion" in command &&
+    "hasRequiredPermissions" in command;
 }
 
 interface UpgradeCommandImpl {
+  hasRequiredPermissions(): Promise<boolean>;
   getLatestVersion(): Promise<string>;
 }

command/upgrade/provider.ts

@@ -61,6 +61,8 @@ export abstract class Provider {
     this.logger = logger;
   }
 
+  abstract hasRequiredPermissions(): Promise<boolean>;
+
   abstract getVersions(name: string): Promise<Versions>;
 
   abstract getRepositoryUrl(name: string, version?: string): string;

command/upgrade/provider/deno_land.ts

@@ -8,18 +8,28 @@ export class DenoLandProvider extends Provider {
   name = "deno.land";
   private readonly repositoryUrl = "https://deno.land/x/";
   private readonly registryUrl = "https://deno.land/x/";
+  private readonly apiUrl = "https://cdn.deno.land/";
   private readonly moduleName?: string;
 
   constructor({ name, main, logger }: DenoLandProviderOptions = {}) {
     super({ main, logger });
     this.moduleName = name;
   }
 
+  async hasRequiredPermissions(): Promise<boolean> {
+    const apiUrl = new URL(this.apiUrl);
+    const permissionStatus = await Deno.permissions.query({
+      name: "net",
+      host: apiUrl.host,
+    });
+    return permissionStatus.state === "granted";
+  }
+
   async getVersions(
     name: string,
   ): Promise<Versions> {
     const response = await fetch(
-      `https://cdn.deno.land/${this.moduleName ?? name}/meta/versions.json`,
+      `${this.apiUrl}${this.moduleName ?? name}/meta/versions.json`,
     );
     if (!response.ok) {
       throw new Error(

command/upgrade/provider/github.ts

@@ -30,6 +30,15 @@ export class GithubProvider extends Provider {
     this.githubToken = token;
   }
 
+  async hasRequiredPermissions(): Promise<boolean> {
+    const apiUrl = new URL(this.apiUrl);
+    const permissionStatus = await Deno.permissions.query({
+      name: "net",
+      host: apiUrl.host,
+    });
+    return permissionStatus.state === "granted";
+  }
+
   async getVersions(
     _name: string,
   ): Promise<GithubVersions> {

command/upgrade/provider/jsr.ts

@@ -40,6 +40,15 @@ export class JsrProvider extends Provider {
       : options.name;
   }
 
+  async hasRequiredPermissions(): Promise<boolean> {
+    const apiUrl = new URL(this.repositoryUrl);
+    const permissionStatus = await Deno.permissions.query({
+      name: "net",
+      host: apiUrl.host,
+    });
+    return permissionStatus.state === "granted";
+  }
+
   async getVersions(
     name: string,
   ): Promise<Versions> {

command/upgrade/provider/nest_land.ts

@@ -8,17 +8,27 @@ export class NestLandProvider extends Provider {
   name = "nest.land";
   private readonly repositoryUrl = "https://nest.land/package/";
   private readonly registryUrl = "https://x.nest.land/";
+  private readonly apiUrl = "https://nest.land/api/";
   private readonly moduleName?: string;
 
   constructor({ name, main, logger }: NestLandProviderOptions = {}) {
     super({ main, logger });
     this.moduleName = name;
   }
 
+  async hasRequiredPermissions(): Promise<boolean> {
+    const apiUrl = new URL(this.apiUrl);
+    const permissionStatus = await Deno.permissions.query({
+      name: "net",
+      host: apiUrl.host,
+    });
+    return permissionStatus.state === "granted";
+  }
+
   async getVersions(
     name: string,
   ): Promise<Versions> {
-    const response = await fetch(`https://nest.land/api/package-client`, {
+    const response = await fetch(`${this.apiUrl}package-client`, {
       method: "post",
       body: JSON.stringify({ data: { name: this.moduleName ?? name } }),
       headers: { "Content-Type": "application/json" },

command/upgrade/provider/npm.ts

@@ -31,6 +31,15 @@ export class NpmProvider extends Provider {
     }
   }
 
+  async hasRequiredPermissions(): Promise<boolean> {
+    const apiUrl = new URL(this.apiUrl);
+    const permissionStatus = await Deno.permissions.query({
+      name: "net",
+      host: apiUrl.host,
+    });
+    return permissionStatus.state === "granted";
+  }
+
   async getVersions(
     name: string,
   ): Promise<Versions> {

command/upgrade/upgrade_command.ts

@@ -169,6 +169,10 @@ export class UpgradeCommand extends Command {
     return versions;
   }
 
+  public async hasRequiredPermissions(): Promise<boolean> {
+    return await this.getProvider().hasRequiredPermissions();
+  }
+
   public async getLatestVersion(): Promise<string> {
     const { latest } = await this.getVersions();
     return latest;