Set the CODEQL_WRAPPER env var

The CODEQL_WRAPPER environment variable will be set to "action" if
running in an actions context and "runner" otherwise. This variable
will be used in the cli to determine which context it is in.

Also, use a similar mechanism to provide a different user agent
when communicating with the github api.

lib/api-client.js

@@ -27,7 +27,7 @@ exports.getApiClient = function (apiDetails, { allowLocalRun = false, allowExter
     const auth = (allowExternal && apiDetails.externalRepoAuth) || apiDetails.auth;
     return new githubUtils.GitHub(githubUtils.getOctokitOptions(auth, {
         baseUrl: getApiUrl(apiDetails.url),
-        userAgent: "CodeQL Action",
+        userAgent: util_1.isAction() ? "CodeQL Action" : "CodeQL Runner",
         log: console_log_level_1.default({ level: "debug" }),
     }));
 };

lib/api-client.js.map

@@ -1 +1 @@
-{"version":3,"file":"api-client.js","sourceRoot":"","sources":["../src/api-client.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,2CAA6B;AAE7B,uEAAyD;AACzD,0EAAgD;AAEhD,iDAAuE;AACvE,iCAAoC;AAEpC,IAAY,0BAGX;AAHD,WAAY,0BAA0B;IACpC,+FAAc,CAAA;IACd,+FAAc,CAAA;AAChB,CAAC,EAHW,0BAA0B,GAA1B,kCAA0B,KAA1B,kCAA0B,QAGrC;AAeY,QAAA,YAAY,GAAG,UAC1B,UAAoC,EACpC,EAAE,aAAa,GAAG,KAAK,EAAE,aAAa,GAAG,KAAK,EAAE,GAAG,EAAE;IAErD,IAAI,iBAAU,EAAE,IAAI,CAAC,aAAa,EAAE;QAClC,MAAM,IAAI,KAAK,CAAC,+BAA+B,CAAC,CAAC;KAClD;IAED,MAAM,IAAI,GACR,CAAC,aAAa,IAAI,UAAU,CAAC,gBAAgB,CAAC,IAAI,UAAU,CAAC,IAAI,CAAC;IACpE,OAAO,IAAI,WAAW,CAAC,MAAM,CAC3B,WAAW,CAAC,iBAAiB,CAAC,IAAI,EAAE;QAClC,OAAO,EAAE,SAAS,CAAC,UAAU,CAAC,GAAG,CAAC;QAClC,SAAS,EAAE,eAAe;QAC1B,GAAG,EAAE,2BAAe,CAAC,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC;KACzC,CAAC,CACH,CAAC;AACJ,CAAC,CAAC;AAEF,SAAS,SAAS,CAAC,SAAiB;IAClC,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,SAAS,CAAC,CAAC;IAE/B,uDAAuD;IACvD,0CAA0C;IAC1C,IAAI,GAAG,CAAC,QAAQ,KAAK,YAAY,IAAI,GAAG,CAAC,QAAQ,KAAK,gBAAgB,EAAE;QACtE,OAAO,wBAAwB,CAAC;KACjC;IAED,6BAA6B;IAC7B,GAAG,CAAC,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC;IACpD,OAAO,GAAG,CAAC,QAAQ,EAAE,CAAC;AACxB,CAAC;AAED,uFAAuF;AACvF,qFAAqF;AACrF,+CAA+C;AAC/C,SAAgB,mBAAmB,CAAC,aAAa,GAAG,KAAK;IACvD,MAAM,UAAU,GAAG;QACjB,IAAI,EAAE,+BAAgB,CAAC,OAAO,CAAC;QAC/B,GAAG,EAAE,kCAAmB,CAAC,mBAAmB,CAAC;KAC9C,CAAC;IAEF,OAAO,oBAAY,CAAC,UAAU,EAAE,EAAE,aAAa,EAAE,CAAC,CAAC;AACrD,CAAC;AAPD,kDAOC"}
+{"version":3,"file":"api-client.js","sourceRoot":"","sources":["../src/api-client.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,2CAA6B;AAE7B,uEAAyD;AACzD,0EAAgD;AAEhD,iDAAuE;AACvE,iCAA8C;AAE9C,IAAY,0BAGX;AAHD,WAAY,0BAA0B;IACpC,+FAAc,CAAA;IACd,+FAAc,CAAA;AAChB,CAAC,EAHW,0BAA0B,GAA1B,kCAA0B,KAA1B,kCAA0B,QAGrC;AAeY,QAAA,YAAY,GAAG,UAC1B,UAAoC,EACpC,EAAE,aAAa,GAAG,KAAK,EAAE,aAAa,GAAG,KAAK,EAAE,GAAG,EAAE;IAErD,IAAI,iBAAU,EAAE,IAAI,CAAC,aAAa,EAAE;QAClC,MAAM,IAAI,KAAK,CAAC,+BAA+B,CAAC,CAAC;KAClD;IAED,MAAM,IAAI,GACR,CAAC,aAAa,IAAI,UAAU,CAAC,gBAAgB,CAAC,IAAI,UAAU,CAAC,IAAI,CAAC;IACpE,OAAO,IAAI,WAAW,CAAC,MAAM,CAC3B,WAAW,CAAC,iBAAiB,CAAC,IAAI,EAAE;QAClC,OAAO,EAAE,SAAS,CAAC,UAAU,CAAC,GAAG,CAAC;QAClC,SAAS,EAAE,eAAQ,EAAE,CAAC,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,eAAe;QACzD,GAAG,EAAE,2BAAe,CAAC,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC;KACzC,CAAC,CACH,CAAC;AACJ,CAAC,CAAC;AAEF,SAAS,SAAS,CAAC,SAAiB;IAClC,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,SAAS,CAAC,CAAC;IAE/B,uDAAuD;IACvD,0CAA0C;IAC1C,IAAI,GAAG,CAAC,QAAQ,KAAK,YAAY,IAAI,GAAG,CAAC,QAAQ,KAAK,gBAAgB,EAAE;QACtE,OAAO,wBAAwB,CAAC;KACjC;IAED,6BAA6B;IAC7B,GAAG,CAAC,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC;IACpD,OAAO,GAAG,CAAC,QAAQ,EAAE,CAAC;AACxB,CAAC;AAED,uFAAuF;AACvF,qFAAqF;AACrF,+CAA+C;AAC/C,SAAgB,mBAAmB,CAAC,aAAa,GAAG,KAAK;IACvD,MAAM,UAAU,GAAG;QACjB,IAAI,EAAE,+BAAgB,CAAC,OAAO,CAAC;QAC/B,GAAG,EAAE,kCAAmB,CAAC,mBAAmB,CAAC;KAC9C,CAAC;IAEF,OAAO,oBAAY,CAAC,UAAU,EAAE,EAAE,aAAa,EAAE,CAAC,CAAC;AACrD,CAAC;AAPD,kDAOC"}

lib/codeql.js

@@ -216,6 +216,8 @@ async function setupCodeQL(codeqlURL, apiDetails, tempDir, toolCacheDir, mode, v
         else if (process.platform !== "linux" && process.platform !== "darwin") {
             throw new Error(`Unsupported platform: ${process.platform}`);
         }
+        // set a  environment variable to let CodeQL know where we are running
+        process.env.CODEQL_WRAPPER = util.isAction() ? "action" : "runner";
         cachedCodeQL = getCodeQLForCmd(codeqlCmd);
         return { codeql: cachedCodeQL, toolsVersion: codeqlURLVersion };
     }

lib/util.js

@@ -320,4 +320,12 @@ async function getGitHubAuth(logger, githubAuth, fromStdIn, readable = process.s
     throw new Error("No GitHub authentication token was specified. Please provide a token via the GITHUB_TOKEN environment variable, or by adding the `--github-auth-stdin` flag and passing the token via standard input.");
 }
 exports.getGitHubAuth = getGitHubAuth;
+/**
+ * Returns true if this process is running as part of github actions.
+ * False otherwise.
+ */
+function isAction() {
+    return "GITHUB_ACTIONS" in process.env;
+}
+exports.isAction = isAction;
 //# sourceMappingURL=util.js.map

lib/util.test.js

@@ -204,4 +204,10 @@ async function mockStdInForAuthExpectError(t, mockLogger, ...text) {
     const stdin = stream.Readable.from(text);
     await t.throwsAsync(async () => util.getGitHubAuth(mockLogger, undefined, true, stdin));
 }
+ava_1.default("isAction", async (t) => {
+    process.env.GITHUB_ACTIONS = "true";
+    t.assert(util.isAction(), "Should be running in actions");
+    delete process.env.GITHUB_ACTIONS;
+    t.assert(!util.isAction(), "Should be running in runner");
+});
 //# sourceMappingURL=util.test.js.map

src/api-client.ts

@@ -4,7 +4,7 @@ import * as githubUtils from "@actions/github/lib/utils";
 import consoleLogLevel from "console-log-level";
 
 import { getRequiredEnvParam, getRequiredInput } from "./actions-util";
-import { isLocalRun } from "./util";
+import { isLocalRun, isAction } from "./util";
 
 export enum DisallowedAPIVersionReason {
   ACTION_TOO_OLD,
@@ -37,7 +37,7 @@ export const getApiClient = function (
   return new githubUtils.GitHub(
     githubUtils.getOctokitOptions(auth, {
       baseUrl: getApiUrl(apiDetails.url),
-      userAgent: "CodeQL Action",
+      userAgent: isAction() ? "CodeQL Action" : "CodeQL Runner",
       log: consoleLogLevel({ level: "debug" }),
     })
   );

src/codeql.ts

@@ -399,6 +399,9 @@ export async function setupCodeQL(
       throw new Error(`Unsupported platform: ${process.platform}`);
     }
 
+    // set a  environment variable to let CodeQL know where we are running
+    process.env.CODEQL_WRAPPER = util.isAction() ? "action" : "runner";
+
     cachedCodeQL = getCodeQLForCmd(codeqlCmd);
     return { codeql: cachedCodeQL, toolsVersion: codeqlURLVersion };
   } catch (e) {

src/util.test.ts

@@ -305,3 +305,10 @@ async function mockStdInForAuthExpectError(
     util.getGitHubAuth(mockLogger, undefined, true, stdin)
   );
 }
+
+test("isAction", async (t) => {
+  process.env.GITHUB_ACTIONS = "true";
+  t.assert(util.isAction(), "Should be running in actions");
+  delete process.env.GITHUB_ACTIONS;
+  t.assert(!util.isAction(), "Should be running in runner");
+});

src/util.ts

@@ -390,3 +390,11 @@ export async function getGitHubAuth(
     "No GitHub authentication token was specified. Please provide a token via the GITHUB_TOKEN environment variable, or by adding the `--github-auth-stdin` flag and passing the token via standard input."
   );
 }
+
+/**
+ * Returns true if this process is running as part of github actions.
+ * False otherwise.
+ */
+export function isAction() {
+  return "GITHUB_ACTIONS" in process.env;
+}