From c044d962ba058483b1279bd865fdbac5cfd7c114 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ji=C5=99=C3=AD=20Morav=C4=8D=C3=ADk?= Date: Mon, 10 Jul 2023 15:23:51 +0200 Subject: [PATCH 1/4] feat: add more ACTOR_ env vars, add a test, rename ENV_VARS --- packages/consts/src/consts.ts | 11 ++++++++++- test/consts.test.ts | 18 +++++++++++++++++- 2 files changed, 27 insertions(+), 2 deletions(-) diff --git a/packages/consts/src/consts.ts b/packages/consts/src/consts.ts index 1e715afb8..928c065b1 100644 --- a/packages/consts/src/consts.ts +++ b/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; +/** + * `ENV_VARS` were replaced by `APIFY_ENV_VARS`. We 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', diff --git a/test/consts.test.ts b/test/consts.test.ts index 11fb1d15d..cc14ec29c 100644 --- a/test/consts.test.ts +++ b/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,20 @@ describe('consts', () => { } }); }); + + describe('ACTOR_ENV_VARS', () => { + it('every value begins with "ACTOR_"', () => { + Object.values(ACTOR_ENV_VARS).forEach((v) => { + expect(v.startsWith('ACTOR_')).toBe(true); + }); + }); + }); + + 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]); + }); + }); + }); }); From 992aacba574cf39327e37a27b7a4fb78659d8f3b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ji=C5=99=C3=AD=20Morav=C4=8D=C3=ADk?= Date: Tue, 11 Jul 2023 00:31:36 +0200 Subject: [PATCH 2/4] feat: deprecate ENV_VARS --- packages/consts/src/consts.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/consts/src/consts.ts b/packages/consts/src/consts.ts index 928c065b1..bfdfe661b 100644 --- a/packages/consts/src/consts.ts +++ b/packages/consts/src/consts.ts @@ -298,7 +298,7 @@ export const APIFY_ENV_VARS = { } as const; /** - * `ENV_VARS` were replaced by `APIFY_ENV_VARS`. We keep this for backwards compatibility. + * @deprecated `ENV_VARS` were replaced by `APIFY_ENV_VARS`. We currently keep this for backwards compatibility. */ export const ENV_VARS = APIFY_ENV_VARS; From 318afb722c63f24ede98b252f1807146a2c195a3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ji=C5=99=C3=AD=20Morav=C4=8D=C3=ADk?= Date: Tue, 11 Jul 2023 09:59:47 +0200 Subject: [PATCH 3/4] Update test/consts.test.ts MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: František Nesveda --- test/consts.test.ts | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/test/consts.test.ts b/test/consts.test.ts index cc14ec29c..f91fda585 100644 --- a/test/consts.test.ts +++ b/test/consts.test.ts @@ -51,9 +51,9 @@ describe('consts', () => { }); describe('ACTOR_ENV_VARS', () => { - it('every value begins with "ACTOR_"', () => { - Object.values(ACTOR_ENV_VARS).forEach((v) => { - expect(v.startsWith('ACTOR_')).toBe(true); + it('every value is "ACTOR_" + key', () => { + Object.entries(ACTOR_ENV_VARS).forEach(([k, v]) => { + expect(v).toBe(`ACTOR_${k}`); }); }); }); From d428d0b9841c67844cd59e6ed3fa5bb3b1c3f92a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ji=C5=99=C3=AD=20Morav=C4=8D=C3=ADk?= Date: Tue, 11 Jul 2023 10:00:14 +0200 Subject: [PATCH 4/4] Update test/consts.test.ts MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: František Nesveda --- test/consts.test.ts | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/test/consts.test.ts b/test/consts.test.ts index f91fda585..6f999faf6 100644 --- a/test/consts.test.ts +++ b/test/consts.test.ts @@ -64,5 +64,14 @@ describe('consts', () => { 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}`); + }); + }); }); });