Merge branch 'main-enterprise' into bug/archived-repo

Author: decyjphr

lib/plugins/variables.js

@@ -1,196 +1,71 @@
-const _ = require('lodash')
 const Diffable = require('./diffable')
+const NopCommand = require('../nopcommand')
 
 module.exports = class Variables extends Diffable {
   constructor (...args) {
     super(...args)
 
     if (this.entries) {
-      // Force all names to uppercase to avoid comparison issues.
       this.entries.forEach((variable) => {
         variable.name = variable.name.toUpperCase()
       })
     }
   }
 
-  /**
-     * Look-up existing variables for a given repository
-     *
-     * @see {@link https://docs.github.com/en/rest/actions/variables?apiVersion=2026-03-10#list-repository-variables} list repository variables
-     * @returns {Array.<object>} Returns a list of variables that exist in a repository
-     */
-  async find () {
+  find () {
     this.log.debug(`Finding repo vars for ${this.repo.owner}/${this.repo.repo}`)
-    const { data: { variables } } = await this.github.request('GET /repos/:org/:repo/actions/variables', {
+    return this.github.request('GET /repos/:org/:repo/actions/variables', {
       org: this.repo.owner,
       repo: this.repo.repo
-    })
-    return variables
-  }
-
-  /**
-     * Compare the existing variables with what we've defined as code
-     *
-     * @param {Array.<object>} existing Existing variables defined in the repository
-     * @param {Array.<object>} variables Variables that we have defined as code
-     *
-     * @returns {object} The results of a list comparison
-     */
-  getChanged (existing, variables = []) {
-    const result =
-            JSON.stringify(
-              existing.sort((x1, x2) => {
-                return x1.name.toUpperCase().localeCompare(x2.name.toUpperCase())
-              })
-            ) !==
-            JSON.stringify(
-              variables.sort((x1, x2) => {
-                return x1.name.toUpperCase().localeCompare(x2.name.toUpperCase())
-              })
-            )
-    return result
+    }).then(({ data: { variables } }) => variables.map(({ name, value }) => ({ name, value })))
   }
 
-  /**
-     * Compare existing variables with what's defined
-     *
-     * @param {Object} existing The existing entries in GitHub
-     * @param {Object} attrs The entries defined as code
-     *
-     * @returns
-     */
   comparator (existing, attrs) {
     return existing.name === attrs.name
   }
 
-  /**
-     * Return a list of changed entries
-     *
-     * @param {Object} existing The existing entries in GitHub
-     * @param {Object} attrs The entries defined as code
-     *
-     * @returns
-     */
   changed (existing, attrs) {
-    return this.getChanged(_.castArray(existing), _.castArray(attrs))
+    return existing.value !== attrs.value
   }
 
-  /**
-     * Update an existing variable if the value has changed
-     *
-     * @param {Array.<object>} existing Existing variables defined in the repository
-     * @param {Array.<object>} variables Variables that we have defined as code
-     *
-     * @see {@link https://docs.github.com/en/rest/actions/variables?apiVersion=2026-03-10#update-a-repository-variable} update a repository variable
-     * @returns
-     */
-  async update (existing, variables = []) {
-    this.log.debug(`Updating a repo var existing params ${JSON.stringify(existing)} and new ${JSON.stringify(variables)}`)
-    existing = _.castArray(existing)
-    variables = _.castArray(variables)
-    const changed = this.getChanged(existing, variables)
-
-    if (changed) {
-      let existingVariables = [...existing]
-      for (const variable of variables) {
-        const existingVariable = existingVariables.find((_var) => _var.name === variable.name)
-        if (existingVariable) {
-          existingVariables = existingVariables.filter((_var) => _var.name !== variable.name)
-          if (existingVariable.value !== variable.value) {
-            await this.github
-              .request('PATCH /repos/:org/:repo/actions/variables/:variable_name', {
-                org: this.repo.owner,
-                repo: this.repo.repo,
-                variable_name: variable.name.toUpperCase(),
-                value: variable.value.toString()
-              })
-              .then((res) => {
-                return res
-              })
-              .catch((e) => {
-                this.logError(e)
-              })
-          }
-        } else {
-          await this.github
-            .request('POST /repos/:org/:repo/actions/variables', {
-              org: this.repo.owner,
-              repo: this.repo.repo,
-              name: variable.name.toUpperCase(),
-              value: variable.value.toString()
-            })
-            .then((res) => {
-              return res
-            })
-            .catch((e) => {
-              this.logError(e)
-            })
-        }
-      }
-
-      for (const variable of existingVariables) {
-        await this.github
-          .request('DELETE /repos/:org/:repo/actions/variables/:variable_name', {
-            org: this.repo.owner,
-            repo: this.repo.repo,
-            variable_name: variable.name.toUpperCase()
-          })
-          .then((res) => {
-            return res
-          })
-          .catch((e) => {
-            this.logError(e)
-          })
-      }
+  update (existing, attrs) {
+    if (this.nop) {
+      return Promise.resolve([
+        new NopCommand(this.constructor.name, this.repo, null, `Update variable ${attrs.name}`)
+      ])
     }
+    return this.github.request('PATCH /repos/:org/:repo/actions/variables/:variable_name', {
+      org: this.repo.owner,
+      repo: this.repo.repo,
+      variable_name: attrs.name.toUpperCase(),
+      value: attrs.value.toString()
+    })
   }
 
-  /**
-     * Add a new variable to a given repository
-     *
-     * @param {object} variable The variable to add, with name and value
-     *
-     * @see {@link https://docs.github.com/en/rest/actions/variables?apiVersion=2026-03-10#create-a-repository-variable} create a repository variable
-     * @returns
-     */
-  async add (variable) {
-    this.log.debug(`Adding a repo var with the params ${JSON.stringify(variable)}`)
-    await this.github
-      .request('POST /repos/:org/:repo/actions/variables', {
-        org: this.repo.owner,
-        repo: this.repo.repo,
-        name: variable.name,
-        value: variable.value.toString()
-      })
-      .then((res) => {
-        return res
-      })
-      .catch((e) => {
-        this.logError(e)
-      })
+  add (attrs) {
+    if (this.nop) {
+      return Promise.resolve([
+        new NopCommand(this.constructor.name, this.repo, null, `Add variable ${attrs.name}`)
+      ])
+    }
+    return this.github.request('POST /repos/:org/:repo/actions/variables', {
+      org: this.repo.owner,
+      repo: this.repo.repo,
+      name: attrs.name.toUpperCase(),
+      value: attrs.value.toString()
+    })
   }
 
-  /**
-     * Remove variables that aren't defined as code
-     *
-     * @param {String} existing Name of the existing variable to remove
-     *
-     * @see {@link https://docs.github.com/en/rest/actions/variables?apiVersion=2026-03-10#delete-a-repository-variable} delete a repository variable
-     * @returns
-     */
-  async remove (existing) {
-    this.log.debug(`Removing a repo var with the params ${JSON.stringify(existing)}`)
-    await this.github
-      .request('DELETE /repos/:org/:repo/actions/variables/:variable_name', {
-        org: this.repo.owner,
-        repo: this.repo.repo,
-        variable_name: existing.name
-      })
-      .then((res) => {
-        return res
-      })
-      .catch((e) => {
-        this.logError(e)
-      })
+  remove (existing) {
+    if (this.nop) {
+      return Promise.resolve([
+        new NopCommand(this.constructor.name, this.repo, null, `Remove variable ${existing.name}`)
+      ])
+    }
+    return this.github.request('DELETE /repos/:org/:repo/actions/variables/:variable_name', {
+      org: this.repo.owner,
+      repo: this.repo.repo,
+      variable_name: existing.name.toUpperCase()
+    })
   }
 }

package-lock.json

@@ -30,7 +30,7 @@
     "deepmerge": "^4.3.1",
     "eta": "^3.5.0",
     "js-yaml": "^4.1.0",
-    "lodash": "^4.17.21",
+    "lodash": "^4.18.1",
     "minimatch": "^10.2.1",
     "node-cron": "^4.2.1",
     "octokit": "^5.0.2",