feat: add more ACTOR_ env vars, add a test, rename ENV_VARS

packages/consts/src/consts.ts

@@ -251,7 +251,7 @@ export const REQUEST_QUEUE_HEAD_MAX_LIMIT = 1000;
 /**
  * Dictionary of APIFY_XXX environment variable names.
  */
-export const ENV_VARS = {
+export const APIFY_ENV_VARS = {
     IS_AT_HOME: 'APIFY_IS_AT_HOME',
     ACTOR_ID: 'APIFY_ACTOR_ID',
     ACTOR_RUN_ID: 'APIFY_ACTOR_RUN_ID',
@@ -297,20 +297,29 @@ export const ENV_VARS = {
     ACT_RUN_ID: 'APIFY_ACT_RUN_ID',
 } as const;
 
+/**
+ * @deprecated `ENV_VARS` were replaced by `APIFY_ENV_VARS`. We currently keep this for backwards compatibility.
+ */
+export const ENV_VARS = APIFY_ENV_VARS;
+
 /**
  * Dictionary of environment variable names prefixed with "ACTOR_".
  * Follows from Actor specs https://github.com/apify/actor-specs/#environment-variables
  */
 export const ACTOR_ENV_VARS = {
+    BUILD_ID: 'ACTOR_BUILD_ID',
+    BUILD_NUMBER: 'ACTOR_BUILD_NUMBER',
     DEFAULT_DATASET_ID: 'ACTOR_DEFAULT_DATASET_ID',
     DEFAULT_KEY_VALUE_STORE_ID: 'ACTOR_DEFAULT_KEY_VALUE_STORE_ID',
     DEFAULT_REQUEST_QUEUE_ID: 'ACTOR_DEFAULT_REQUEST_QUEUE_ID',
     EVENTS_WEBSOCKET_URL: 'ACTOR_EVENTS_WEBSOCKET_URL',
+    ID: 'ACTOR_ID',
     INPUT_KEY: 'ACTOR_INPUT_KEY',
     MAX_PAID_DATASET_ITEMS: 'ACTOR_MAX_PAID_DATASET_ITEMS',
     MEMORY_MBYTES: 'ACTOR_MEMORY_MBYTES',
     RUN_ID: 'ACTOR_RUN_ID',
     STARTED_AT: 'ACTOR_STARTED_AT',
+    TASK_ID: 'ACTOR_TASK_ID',
     TIMEOUT_AT: 'ACTOR_TIMEOUT_AT',
     WEB_SERVER_PORT: 'ACTOR_WEB_SERVER_PORT',
     WEB_SERVER_URL: 'ACTOR_WEB_SERVER_URL',

test/consts.test.ts

@@ -1,4 +1,4 @@
-import { USERNAME, APIFY_ID_REGEX } from '@apify/consts';
+import { USERNAME, APIFY_ID_REGEX, ACTOR_ENV_VARS, ENV_VARS, APIFY_ENV_VARS } from '@apify/consts';
 import { cryptoRandomObjectId } from '@apify/utilities';
 
 describe('consts', () => {
@@ -49,4 +49,29 @@ describe('consts', () => {
             }
         });
     });
+
+    describe('ACTOR_ENV_VARS', () => {
+        it('every value is "ACTOR_" + key', () => {
+            Object.entries(ACTOR_ENV_VARS).forEach(([k, v]) => {
+                expect(v).toBe(`ACTOR_${k}`);
+            });
+        });
+    });
+
+    describe('APIFY_ENV_VARS', () => {
+        it('is the same as ENV_VARS', () => {
+            Object.keys(APIFY_ENV_VARS).forEach((k) => {
+                expect(APIFY_ENV_VARS[k]).toBe(ENV_VARS[k]);
+            });
+        });
+
+        it('every value is "APIFY_" + key', () => {
+            Object.entries(APIFY_ENV_VARS).forEach(([k, v]) => {
+                // TODO: remove this once ACTOR_MAX_PAID_DATASET_ITEMS is removed from APIFY_ENV_VARS
+                if (k === 'ACTOR_MAX_PAID_DATASET_ITEMS') return;
+
+                expect(v).toBe(`APIFY_${k}`);
+            });
+        });
+    });
 });