feat: Added wait block that only continues after github is connected. Added globalEnvNodeVersion parameter to configure pnpm to install NodeJs

Author: kevinwang5658

package.json

@@ -23,7 +23,7 @@
     "ajv": "^8.12.0",
     "ajv-formats": "^2.1.1",
     "semver": "^7.6.0",
-    "codify-plugin-lib": "1.0.171",
+    "codify-plugin-lib": "1.0.173",
     "codify-schemas": "1.0.63",
     "chalk": "^5.3.0",
     "debug": "^4.3.4",

src/index.ts

@@ -11,6 +11,7 @@ import { AwsProfileResource } from './resources/aws-cli/profile/aws-profile.js';
 import { GitCloneResource } from './resources/git/clone/git-repository.js';
 import { GitResource } from './resources/git/git/git-resource.js';
 import { GitLfsResource } from './resources/git/lfs/git-lfs.js';
+import { WaitGithubSshKey } from './resources/git/wait-github-ssh-key/wait-github-ssh-key.js';
 import { HomebrewResource } from './resources/homebrew/homebrew.js';
 import { JenvResource } from './resources/java/jenv/jenv.js';
 import { NvmResource } from './resources/node/nvm/nvm.js';
@@ -61,6 +62,7 @@ runPlugin(Plugin.create(
     new FileResource(),
     new Virtualenv(),
     new VirtualenvProject(),
-    new Pnpm()
+    new Pnpm(),
+    new WaitGithubSshKey()
   ])
 )

src/resources/git/wait-github-ssh-key/wait-github-ssh-key.ts

@@ -0,0 +1,54 @@
+import {
+  CodifyCliSender,
+  Resource,
+  ResourceSettings,
+  getPty
+} from 'codify-plugin-lib';
+import { ResourceConfig } from 'codify-schemas';
+
+import { codifySpawn } from '../../../utils/codify-spawn.js';
+
+export interface WaitGithubSshKeyConfig extends ResourceConfig {}
+
+export class WaitGithubSshKey extends Resource<WaitGithubSshKeyConfig> {
+  getSettings(): ResourceSettings<WaitGithubSshKeyConfig> {
+    return {
+      id: 'wait-github-ssh-key',
+    }
+  }
+
+  async refresh(): Promise<Partial<WaitGithubSshKeyConfig> | null> {
+    const pty = getPty()
+
+    const { data: githubConnectionStatus } = await pty.spawnSafe('ssh -o StrictHostKeychecking=no -T git@github.com 2>&1')
+    if (githubConnectionStatus.includes('You\'ve successfully authenticated, but GitHub does not provide shell access.')) {
+      return {};
+    }
+
+    return null;
+  }
+
+  async create(): Promise<void> {
+    let attemptCount = 0;
+
+    do {
+      if (attemptCount > 0) {
+        console.error('Unable to verify that github ssh access is connected.')
+      }
+
+      await CodifyCliSender.requestPressKeyToContinuePrompt(
+        (attemptCount > 0 ? 'Unable to verify that github ssh access is connected. Please try again. \n\n' : '') +
+        'Waiting for user to add ssh-key to github. For instructions please follow: https://docs.github.com/en/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account.')
+      attemptCount++;
+    } while(!(await this.isConnectedToGithub()));
+  }
+
+  async destroy(): Promise<void> {
+    console.error('This resource cannot be destroyed. Skipping.')
+  }
+
+  private async isConnectedToGithub(): Promise<boolean> {
+    const { data: githubConnectionStatus } = await codifySpawn('ssh -o StrictHostKeychecking=no -T git@github.com 2>&1', { throws: false })
+    return githubConnectionStatus.includes('You\'ve successfully authenticated, but GitHub does not provide shell access.')
+  }
+}

src/resources/node/pnpm/pnpm-global-env-stateful-parameter.ts

@@ -0,0 +1,40 @@
+import { ParameterSetting, Plan, StatefulParameter, getPty } from 'codify-plugin-lib';
+import fs from 'node:fs/promises';
+
+import { codifySpawn } from '../../../utils/codify-spawn.js';
+import { FileUtils } from '../../../utils/file-utils.js';
+import { PnpmConfig } from './pnpm.js';
+
+export class PnpmGlobalEnvStatefulParameter extends StatefulParameter<PnpmConfig, string> {
+
+  getSettings(): ParameterSetting {
+    return {
+      type: 'version',
+    }
+  }
+
+  async refresh(): Promise<null | string> {
+    const pty = getPty()
+
+    const { data: path } = await pty.spawnSafe('echo $PNPM_HOME/node')
+    if (!path || !(await FileUtils.fileExists(path))) {
+      return null;
+    }
+
+    const { data: version } = await pty.spawn(`${path} -v`)
+    return version.trim().slice(1);
+  }
+
+  async add(valueToAdd: string): Promise<void> {
+    await codifySpawn(`pnpm env use --global ${valueToAdd}`);
+  }
+
+  async modify(newValue: string): Promise<void> {
+    await codifySpawn(`pnpm env use --global ${newValue}`)
+  }
+
+  async remove(): Promise<void> {
+    const { data: path } = await codifySpawn('echo $PNPM_HOME/nodejs')
+    await fs.rm(path!, { recursive: true, force: true });
+  }
+}

src/resources/node/pnpm/pnpm-schema.json

@@ -8,6 +8,10 @@
     "version": {
       "type": "string",
       "description": "A specific version of pnpm to install. (defaults to the latest)"
+    },
+    "globalEnv": {
+      "type": "string",
+      "description": "Set the global node version. Corresponds to pnpm env --global use"
     }
   },
   "additionalProperties": false

src/resources/node/pnpm/pnpm.ts

@@ -6,10 +6,12 @@ import path from 'node:path';
 
 import { codifySpawn } from '../../../utils/codify-spawn.js';
 import { FileUtils } from '../../../utils/file-utils.js';
+import { PnpmGlobalEnvStatefulParameter } from './pnpm-global-env-stateful-parameter.js';
 import schema from './pnpm-schema.json';
 
 export interface PnpmConfig extends ResourceConfig {
   version?: string;
+  globalEnvNodeVersion?: string;
 }
 
 export class Pnpm extends Resource<PnpmConfig> {
@@ -18,7 +20,8 @@ export class Pnpm extends Resource<PnpmConfig> {
       id: 'pnpm',
       schema,
       parameterSettings: {
-        version: { type: 'version' }
+        version: { type: 'version' },
+        globalEnvNodeVersion: { type: 'stateful', definition: new PnpmGlobalEnvStatefulParameter() }
       }
     }
   }