From 91318ee133c019964605e43d9077852345c20b70 Mon Sep 17 00:00:00 2001 From: SakshiKoli-CS Date: Wed, 18 Nov 2026 16:40:39 +0530 Subject: [PATCH] CL-8826 | say --org takes a UID when it is given an organization name --org takes an organization UID only. A name passed with it went to the Launch API unchanged as x-organization-uid, so the user got the API's rejection, which never said what was wrong. organizationResolution.org now has a normalize step: a value passed with --org is trimmed and must look like a Contentstack organization UID (blt + 16 hex). Anything else exits 2 before any request with "--org accepts an organization UID, not a name." Values from .cs-launch.json and the organization picker are UIDs already and are not checked. Tests that passed placeholder org values ('org1', 'org-from-flag', random 18-hex strings) with --org now use UID-shaped constants, the resources test no longer pins org as having no normalize step, and the Talisman checksums of the four edited test files are refreshed. --- .talismanrc | 8 +- src/commands/launch/projects/get.test.ts | 10 ++- src/commands/launch/projects/update.test.ts | 28 +++--- src/core/launch-command.test.ts | 25 +++--- src/core/resolve.test.ts | 89 ++++++++++--------- src/organizations/organization.inputs.test.ts | 44 +++++++++ src/organizations/organization.inputs.ts | 20 ++++- src/resources.test.ts | 15 ++-- test/integration/cache-purge.test.ts | 2 +- test/integration/organization-prompt.test.ts | 15 ++++ test/integration/site-open.test.ts | 2 +- 11 files changed, 173 insertions(+), 85 deletions(-) create mode 100644 src/organizations/organization.inputs.test.ts diff --git a/.talismanrc b/.talismanrc index 0f96875b..be3f278a 100644 --- a/.talismanrc +++ b/.talismanrc @@ -231,7 +231,7 @@ fileignoreconfig: allowed_patterns: - "FlagKey" - filename: src/resources.test.ts - checksum: 6ff9df735323c036cbd5eb5fb321fef110a05b7ae99e61d7687bebc2c0b6dde1 + checksum: 6c2a0938d406767bbc80890aece988fbef1b01f809bd4b488403946aaef2ad37 allowed_patterns: - "a project name passed on argv to the project resolver" - "expect\\(Object.keys\\(DEPENDENCIES\\)\\).toEqual\\(\\['project', 'env'\\]\\)" @@ -253,7 +253,7 @@ fileignoreconfig: - filename: src/core/resolve.ts checksum: a5608d22286efdd4915639faff6e05a588e60e205c74e0398e389822eb8c7292 - filename: src/core/resolve.test.ts - checksum: 8740a27f759a106e0ddcf38874f83394d2226dd8a908d9499898d774fea3a7a0 + checksum: 7491778e802793695ae6a63e0d0652dd36f1058d8a608f28c9991807adf1cfd2 - filename: src/git/local-repository.ts checksum: b9091ed135dfebdf590a5412bbfba2b2f96d4a177cf944a20909b93405268e9f - filename: test/guards/layering.test.ts @@ -267,7 +267,7 @@ fileignoreconfig: - filename: src/core/launch-command.ts checksum: 999468661532665870b81face9086998e543df648175e2417045840dc97cb1dd - filename: src/core/launch-command.test.ts - checksum: c4488f07834e0c6e765a954cd30b3222eba05944f48bec01839f024b1cb7622f + checksum: 40c554e420c60e38d738190128588bc43c6f347da2d1e648b65d93419ca9f2c3 - filename: src/projects/project.inputs.test.ts checksum: 8242f4d40388f1a7f1d08c11d2571cb45a9294069a8248a5272bc5606807bb60 - filename: test/integration/projects-command-flows.test.ts @@ -279,7 +279,7 @@ fileignoreconfig: - filename: src/commands/launch/env/list.test.ts checksum: f5de16e0fd37a85ceb31a7fbc8e9058347ccc072f53c95d4f49ef15e923f4e95 - filename: src/commands/launch/projects/get.test.ts - checksum: ecc48c6a381de44858eafa57fdfd8c24c087837d2869909c8326db8e77148f29 + checksum: 3aeffc4e4742ea9c5b3d9e6c5ea2248ced1d19a273bbc7d7948d471774b0d739 - filename: test/integration/projects-list-command.test.ts checksum: 5f49dc7f384fb9e33c8fb91f1c67b17ffc2fd3bbde3663f90f820056407e98a0 - filename: src/functions/cloud-functions.test.ts diff --git a/src/commands/launch/projects/get.test.ts b/src/commands/launch/projects/get.test.ts index 41b363c0..8e468f5b 100644 --- a/src/commands/launch/projects/get.test.ts +++ b/src/commands/launch/projects/get.test.ts @@ -3,6 +3,8 @@ import { resolveInputs } from '../../../core/resolve'; import type { UxLike } from '../../../core/prompt'; import ProjectsGet from './get'; +const ORG_UID = 'blt1111111111111111'; + function commandUnderTest(project: unknown) { const lines: string[] = []; const ux: UxLike = { @@ -16,7 +18,7 @@ function commandUnderTest(project: unknown) { Object.assign(command, { ux, - resolved: { org: 'org1', project: 'a'.repeat(24) }, + resolved: { org: ORG_UID, project: 'a'.repeat(24) }, services: { ux, isTTY: false, @@ -45,7 +47,7 @@ describe('launch:projects:get', () => { await command.run(); - expect(fetched).toEqual([{ org: 'org1', project: 'a'.repeat(24) }]); + expect(fetched).toEqual([{ org: ORG_UID, project: 'a'.repeat(24) }]); expect(lines).toEqual([ '\u250c\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u252c\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u252c\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u252c\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2510', '\u2502 NAME \u2502 TYPE \u2502 PROJECT UID \u2502 DESCRIPTION \u2502', @@ -107,7 +109,7 @@ describe('launch:projects:get', () => { } as unknown as ApiSurface; const resolved = await resolveInputs(ProjectsGet.inputs, { - parsed: { org: 'org1', project: 'site' }, + parsed: { org: ORG_UID, project: 'site' }, projectConfig: {}, services: { api, ux, isTTY: false }, }); @@ -117,6 +119,6 @@ describe('launch:projects:get', () => { await command.run(); expect(resolved.project).toBe('a'.repeat(24)); - expect(fetched).toEqual([{ org: 'org1', project: 'a'.repeat(24) }]); + expect(fetched).toEqual([{ org: ORG_UID, project: 'a'.repeat(24) }]); }); }); diff --git a/src/commands/launch/projects/update.test.ts b/src/commands/launch/projects/update.test.ts index 1e667988..72cdaa34 100644 --- a/src/commands/launch/projects/update.test.ts +++ b/src/commands/launch/projects/update.test.ts @@ -5,6 +5,8 @@ import type { ApiSurface } from '../../../resources'; import type { Project } from '../../../projects/types'; import ProjectsUpdate from './update'; +const ORG_UID = 'blt1111111111111111'; + const PROJECT_UID = 'a1b2c3d4e5f60718293a4b5c'; interface Terminal { @@ -37,7 +39,7 @@ function commandUnderTest( Object.assign(command, { ux, - resolved: { org: 'org1', project: PROJECT_UID, ...resolved }, + resolved: { org: ORG_UID, project: PROJECT_UID, ...resolved }, services: { ux, isTTY: terminal !== undefined, @@ -68,7 +70,7 @@ function commandUnderTest( function fakeServices() { const ux: UxLike = { print: () => undefined, inquire: async () => undefined as never }; - const projects = { get: async () => ({ uid: PROJECT_UID, organizationUid: 'org1' }) }; + const projects = { get: async () => ({ uid: PROJECT_UID, organizationUid: ORG_UID }) }; return { api: { projects } as unknown as ApiSurface, ux, isTTY: false }; } @@ -78,7 +80,7 @@ describe('launch:projects:update', () => { await command.run(); - expect(sent).toEqual([{ org: 'org1', project: PROJECT_UID, update: { name: 'Renamed Site' } }]); + expect(sent).toEqual([{ org: ORG_UID, project: PROJECT_UID, update: { name: 'Renamed Site' } }]); expect(lines).toEqual(['✔ Project updated successfully.']); }); @@ -94,7 +96,7 @@ describe('launch:projects:update', () => { await command.run(); - expect(sent).toEqual([{ org: 'org1', project: PROJECT_UID, update: { description: 'A new blurb' } }]); + expect(sent).toEqual([{ org: ORG_UID, project: PROJECT_UID, update: { description: 'A new blurb' } }]); expect(lines).toEqual(['✔ Project updated successfully.']); }); @@ -111,7 +113,7 @@ describe('launch:projects:update', () => { await command.run(); expect(sent).toEqual([ - { org: 'org1', project: PROJECT_UID, update: { name: 'Renamed Site', description: 'A new blurb' } }, + { org: ORG_UID, project: PROJECT_UID, update: { name: 'Renamed Site', description: 'A new blurb' } }, ]); expect(lines).toEqual(['✔ Project updated successfully.']); }); @@ -159,7 +161,7 @@ describe('launch:projects:update', () => { await command.run(); expect(asked).toHaveLength(2); - expect(sent).toEqual([{ org: 'org1', project: PROJECT_UID, update: { name: 'test-renamed' } }]); + expect(sent).toEqual([{ org: ORG_UID, project: PROJECT_UID, update: { name: 'test-renamed' } }]); expect(lines).toEqual(['✔ Project updated successfully.']); }); @@ -173,7 +175,7 @@ describe('launch:projects:update', () => { await command.run(); - expect(sent).toEqual([{ org: 'org1', project: PROJECT_UID, update: { description: 'Marketing site for Q4' } }]); + expect(sent).toEqual([{ org: ORG_UID, project: PROJECT_UID, update: { description: 'Marketing site for Q4' } }]); expect(lines).toEqual(['✔ Project updated successfully.']); }); @@ -190,7 +192,7 @@ describe('launch:projects:update', () => { expect(asked).toEqual([]); expect(fetched).toEqual([]); expect(sent).toEqual([ - { org: 'org1', project: PROJECT_UID, update: { name: 'Renamed Site', description: undefined } }, + { org: ORG_UID, project: PROJECT_UID, update: { name: 'Renamed Site', description: undefined } }, ]); expect(lines).toEqual(['✔ Project updated successfully.']); }); @@ -208,7 +210,7 @@ describe('launch:projects:update', () => { expect(asked).toEqual([]); expect(fetched).toEqual([]); expect(sent).toEqual([ - { org: 'org1', project: PROJECT_UID, update: { name: undefined, description: 'A new blurb' } }, + { org: ORG_UID, project: PROJECT_UID, update: { name: undefined, description: 'A new blurb' } }, ]); expect(lines).toEqual(['✔ Project updated successfully.']); }); @@ -226,7 +228,7 @@ describe('launch:projects:update', () => { expect(asked).toEqual([]); expect(fetched).toEqual([]); expect(sent).toEqual([ - { org: 'org1', project: PROJECT_UID, update: { name: 'Renamed Site', description: 'A new blurb' } }, + { org: ORG_UID, project: PROJECT_UID, update: { name: 'Renamed Site', description: 'A new blurb' } }, ]); }); @@ -238,7 +240,7 @@ describe('launch:projects:update', () => { expect(asked).toEqual([]); expect(fetched).toEqual([]); expect(sent).toEqual([ - { org: 'org1', project: PROJECT_UID, update: { name: 'Renamed Site', description: undefined } }, + { org: ORG_UID, project: PROJECT_UID, update: { name: 'Renamed Site', description: undefined } }, ]); }); @@ -288,7 +290,7 @@ describe('launch:projects:update', () => { it('accepts a resolution carrying only one of the two updatable fields', async () => { await expect( resolveInputs(ProjectsUpdate.inputs, { - parsed: { org: 'org1', project: PROJECT_UID, description: 'A new blurb' }, + parsed: { org: ORG_UID, project: PROJECT_UID, description: 'A new blurb' }, projectConfig: {}, services: fakeServices(), }), @@ -297,7 +299,7 @@ describe('launch:projects:update', () => { it('rejects a name over the server limit as a usage error before sending', async () => { const error = (await resolveInputs(ProjectsUpdate.inputs, { - parsed: { org: 'org1', project: PROJECT_UID, name: 'n'.repeat(201) }, + parsed: { org: ORG_UID, project: PROJECT_UID, name: 'n'.repeat(201) }, projectConfig: {}, services: fakeServices(), }).catch((thrown: unknown) => thrown)) as UsageError; diff --git a/src/core/launch-command.test.ts b/src/core/launch-command.test.ts index 3705dfca..9db1980d 100644 --- a/src/core/launch-command.test.ts +++ b/src/core/launch-command.test.ts @@ -19,6 +19,9 @@ import type { SearchListClass } from './search-list'; import { promptLibrary, utilitiesLoader } from './search-list'; import { pretendTerminal, stdinReportingTTY, stdoutReportingTTY } from '../../test/support/terminal'; +const ORG_UID = 'blt1111111111111111'; +const ORG_FROM_FLAG = 'blt2222222222222222'; + class Probe extends LaunchCommand { static flags = {}; static inputs = {}; @@ -322,7 +325,7 @@ describe('LaunchCommand.init', () => { })); await instance.init(); - await instance['services'].api.projects.list({ org: 'org1' }); + await instance['services'].api.projects.list({ org: ORG_UID }); expect(parseMock).toHaveBeenCalledWith({ flags: Probe.flags, baseFlags: LaunchCommand.baseFlags, strict: true }); expect(capturedBaseUrl).toBe(getManageApiBaseUrl('https://launch-api.test')); @@ -389,7 +392,7 @@ describe('LaunchCommand.init', () => { const contextSpy = jest.spyOn(serviceContext, 'buildServiceContext'); await instance.init(); - await instance['services'].api.projects.list({ org: 'org1' }); + await instance['services'].api.projects.list({ org: ORG_UID }); expect(capturedBaseUrl).toBe(getManageApiBaseUrl('https://launch-api.contentstack.com')); expect(contextSpy).toHaveBeenCalledWith( @@ -543,8 +546,8 @@ describe('LaunchCommand.init terminal detection', () => { ); await instance.init(); - await instance['services'].api.projects.list({ org: 'org1', limit: 5, skip: 10 }); - await instance['services'].api.projects.update({ org: 'org1', project: 'p1', update: { name: 'Renamed' } }); + await instance['services'].api.projects.list({ org: ORG_UID, limit: 5, skip: 10 }); + await instance['services'].api.projects.update({ org: ORG_UID, project: 'p1', update: { name: 'Renamed' } }); expect(capturedHeaders?.['X-CS-CLI']).toBe('csdx-cli/2.0.0 darwin-arm64'); expect(wire.sent).toEqual([ @@ -616,7 +619,7 @@ describe('LaunchCommand.init config file notice', () => { }); it('prints nothing when every value came from a flag', async () => { - const { printed } = await initInFolderHoldingAnOrg({ org: 'org-from-flag' }); + const { printed } = await initInFolderHoldingAnOrg({ org: ORG_FROM_FLAG }); expect(printed).toEqual([]); }); @@ -634,7 +637,7 @@ describe('LaunchCommand.init rules', () => { Object.defineProperty(instance, 'config', { value: { userAgent: 'cli/2.0.0' }, configurable: true }); (instance as unknown as { parse: jest.Mock }).parse = jest .fn() - .mockResolvedValue({ flags: { org: 'org1', limit: 10 } }); + .mockResolvedValue({ flags: { org: ORG_UID, limit: 10 } }); await expect(instance.init()).rejects.toThrow('Pass exactly one of --org, --limit; --org, --limit were supplied.'); @@ -645,7 +648,7 @@ describe('LaunchCommand.init rules', () => { describe('resolveLaunchContext rules', () => { it('passes the declared rules through to the resolver, which evaluates them', async () => { const promise = resolveLaunchContext({ - flags: { org: 'org1', limit: 10 }, + flags: { org: ORG_UID, limit: 10 }, inputs: { org: {}, limit: {} }, rules: [exactlyOneOf('org', 'limit')], launchHubUrl: 'https://launch-api.test', @@ -781,7 +784,7 @@ describe('resolveLaunchContext', () => { }); it('words no notice when the flags supplied every value the config file also holds', async () => { - const result = await contextInFolderHoldingAnOrg({ org: 'org-from-flag' }); + const result = await contextInFolderHoldingAnOrg({ org: ORG_FROM_FLAG }); expect(result.configNotice).toBeUndefined(); }); @@ -795,14 +798,14 @@ describe('projectConfigLoader', () => { } it('reads a default-location config only when a value is first needed, and only once', () => { - const { store: lazy, load } = store({ organizationUid: 'org1' }); + const { store: lazy, load } = store({ organizationUid: ORG_UID }); const loader = projectConfigLoader(lazy, false); expect(load).not.toHaveBeenCalled(); expect(typeof loader).toBe('function'); - expect((loader as () => object)()).toEqual({ organizationUid: 'org1' }); - expect((loader as () => object)()).toEqual({ organizationUid: 'org1' }); + expect((loader as () => object)()).toEqual({ organizationUid: ORG_UID }); + expect((loader as () => object)()).toEqual({ organizationUid: ORG_UID }); expect(load).toHaveBeenCalledTimes(1); }); diff --git a/src/core/resolve.test.ts b/src/core/resolve.test.ts index 7e9f78bf..931be0e4 100644 --- a/src/core/resolve.test.ts +++ b/src/core/resolve.test.ts @@ -9,6 +9,9 @@ import type { AnyResolutionSpec } from './resolution'; import { resolveInputs, resolveInputsTraced } from './resolve'; import { atLeastOneOf, exactlyOneOf } from './rules'; +const ORG_UID = 'blt1111111111111111'; +const ORG_FROM_FLAG = 'blt2222222222222222'; + function withResolution(replacement: Record, run: () => Promise): Promise { const holder = resolutionModule as unknown as { resolutionTable: Record }; const original = holder.resolutionTable; @@ -73,12 +76,12 @@ function services(overrides: Partial<{ isTTY: boolean; answer: unknown }> = {}) describe('resolveInputs', () => { it('prefers the flag, then config, then the default', async () => { const resolved = await resolveInputs(inputs({ org: { required: true }, limit: {}, skip: {} }), { - parsed: { org: 'from-flag' }, + parsed: { org: ORG_FROM_FLAG }, projectConfig: { organizationUid: 'from-config' }, services: services(), }); - expect(resolved).toEqual({ org: 'from-flag', limit: 100, skip: 0 }); + expect(resolved).toEqual({ org: ORG_FROM_FLAG, limit: 100, skip: 0 }); }); it('falls back to config when the flag is absent', async () => { @@ -93,7 +96,7 @@ describe('resolveInputs', () => { it('prompts when there is a TTY and no earlier source', async () => { const resolved = await resolveInputs(inputs({ org: { required: true }, project: { required: true } }), { - parsed: { org: 'org1' }, + parsed: { org: ORG_UID }, projectConfig: {}, services: services({ isTTY: true, answer: PROJECT_UID }), }); @@ -163,13 +166,13 @@ describe('resolveInputs', () => { } as unknown as ApiSurface; const resolved = await resolveInputs(inputs({ project: { required: true }, org: { required: true } }), { - parsed: { org: 'org-from-flag' }, + parsed: { org: ORG_FROM_FLAG }, projectConfig: {}, services: { api, ux, isTTY: true }, }); - expect(seen).toEqual(['org-from-flag']); - expect(resolved).toEqual({ org: 'org-from-flag', project: PROJECT_UID }); + expect(seen).toEqual([ORG_FROM_FLAG]); + expect(resolved).toEqual({ org: ORG_FROM_FLAG, project: PROJECT_UID }); }); it('resolves inputs in declaration order so a later prompt can read an earlier value', async () => { @@ -191,12 +194,12 @@ describe('resolveInputs', () => { } as unknown as ApiSurface; await resolveInputs(inputs({ org: { required: true }, project: { required: true } }), { - parsed: { org: 'org-from-flag' }, + parsed: { org: ORG_FROM_FLAG }, projectConfig: {}, services: { api, ux, isTTY: true }, }); - expect(seen).toEqual(['org-from-flag']); + expect(seen).toEqual([ORG_FROM_FLAG]); }); it('keeps an explicitly passed --skip 0 rather than treating it as absent', async () => { @@ -221,7 +224,7 @@ describe('resolveInputs', () => { it('reads the project uid straight out of the config block', async () => { const resolved = await resolveInputs(inputs({ org: {}, project: { required: true } }), { - parsed: { org: 'org1' }, + parsed: { org: ORG_UID }, projectConfig: { uid: PROJECT_UID }, services: services(), }); @@ -241,7 +244,7 @@ describe('resolveInputs', () => { it('normalises a project name supplied by flag into its uid', async () => { const resolved = await resolveInputs(inputs({ org: { required: true }, project: { required: true } }), { - parsed: { org: 'org1', project: 'Project One' }, + parsed: { org: ORG_UID, project: 'Project One' }, projectConfig: {}, services: services(), }); @@ -251,7 +254,7 @@ describe('resolveInputs', () => { it('takes the config file uid field as a uid even when it reads like a name', async () => { const resolved = await resolveInputs(inputs({ org: { required: true }, project: { required: true } }), { - parsed: { org: 'org1' }, + parsed: { org: ORG_UID }, projectConfig: { uid: 'Project One' }, services: services(), }); @@ -272,7 +275,7 @@ describe('resolveInputs', () => { it('prompts when the config file holds a null value rather than accepting it', async () => { const resolved = await resolveInputs(inputs({ org: { required: true }, project: { required: true } }), { - parsed: { org: 'org1' }, + parsed: { org: ORG_UID }, projectConfig: { uid: null }, services: services({ isTTY: true, answer: PROJECT_UID }), }); @@ -303,7 +306,7 @@ describe('resolveInputs', () => { it('does not normalise a project input that resolved to nothing', async () => { const resolved = await resolveInputs(inputs({ org: { required: true }, project: {} }), { - parsed: { org: 'org1' }, + parsed: { org: ORG_UID }, projectConfig: {}, services: services(), }); @@ -313,7 +316,7 @@ describe('resolveInputs', () => { it('propagates the cancellation the picker raises when the user chooses nothing', async () => { const promise = resolveInputs(inputs({ org: { required: true }, project: { required: true } }), { - parsed: { org: 'org1' }, + parsed: { org: ORG_UID }, projectConfig: {}, services: services({ isTTY: true, answer: undefined }), }); @@ -348,7 +351,7 @@ describe('resolveInputs', () => { } as unknown as ApiSurface; const resolved = await resolveInputs(inputs({ org: { required: true }, project: { required: true } }), { - parsed: { org: 'org1', project: PROJECT_UID }, + parsed: { org: ORG_UID, project: PROJECT_UID }, projectConfig: {}, services: { api, ux, isTTY: true }, }); @@ -383,7 +386,7 @@ describe('resolveInputs', () => { } as unknown as ApiSurface; const resolved = await resolveInputs(inputs({ org: { required: true }, project: { required: true } }), { - parsed: { org: 'org1' }, + parsed: { org: ORG_UID }, projectConfig: { uid: PROJECT_UID }, services: { api, ux, isTTY: true }, }); @@ -394,7 +397,7 @@ describe('resolveInputs', () => { it('propagates a usage error raised while normalising a value', async () => { const promise = resolveInputs(inputs({ org: { required: true }, project: { required: true } }), { - parsed: { org: 'org1', project: 'ghost' }, + parsed: { org: ORG_UID, project: 'ghost' }, projectConfig: {}, services: services(), }); @@ -415,12 +418,12 @@ describe('resolveInputs', () => { it('excludes parsed flags the spec does not declare', async () => { const resolved = await resolveInputs(inputs({ org: { required: true } }), { - parsed: { org: 'org1', limit: 10, skip: 5, config: '/tmp/.cs-launch.json' }, + parsed: { org: ORG_UID, limit: 10, skip: 5, config: '/tmp/.cs-launch.json' }, projectConfig: {}, services: services(), }); - expect(resolved).toEqual({ org: 'org1' }); + expect(resolved).toEqual({ org: ORG_UID }); expect(Object.keys(resolved)).toEqual(['org']); }); @@ -483,7 +486,7 @@ describe('resolveInputs', () => { } as unknown as ApiSurface; const resolved = await resolveInputs(inputs({ org: { required: true }, project: { required: true } }), { - parsed: { org: 'org1', project: blank }, + parsed: { org: ORG_UID, project: blank }, projectConfig: {}, services: { api, ux, isTTY: true }, }); @@ -567,14 +570,14 @@ describe('resolveInputs dependency ordering', () => { const resolved = await withResolution(reversedResolution(), () => resolveInputs(inputs({ org: { required: true }, project: { required: true } }), { - parsed: { org: 'org-from-flag', project: 'Project One' }, + parsed: { org: ORG_FROM_FLAG, project: 'Project One' }, projectConfig: {}, services: recordingServices(seen), }), ); - expect(seen).toEqual(['org-from-flag']); - expect(resolved).toEqual({ org: 'org-from-flag', project: PROJECT_UID }); + expect(seen).toEqual([ORG_FROM_FLAG]); + expect(resolved).toEqual({ org: ORG_FROM_FLAG, project: PROJECT_UID }); }); it('prompts project against the resolved org even when the resolution entries are reversed', async () => { @@ -582,14 +585,14 @@ describe('resolveInputs dependency ordering', () => { const resolved = await withResolution(reversedResolution(), () => resolveInputs(inputs({ org: { required: true }, project: { required: true } }), { - parsed: { org: 'org-from-flag' }, + parsed: { org: ORG_FROM_FLAG }, projectConfig: {}, services: recordingServices(seen), }), ); - expect(seen).toEqual(['org-from-flag']); - expect(resolved).toEqual({ org: 'org-from-flag', project: PROJECT_UID }); + expect(seen).toEqual([ORG_FROM_FLAG]); + expect(resolved).toEqual({ org: ORG_FROM_FLAG, project: PROJECT_UID }); }); it('throws naming both flags when a command declares project without org', async () => { @@ -615,7 +618,7 @@ describe('resolveInputs dependency ordering', () => { const promise = withResolution(cyclic, () => resolveInputs(inputs({ org: { required: true }, project: { required: true } }), { - parsed: { org: 'org1', project: 'Project One' }, + parsed: { org: ORG_UID, project: 'Project One' }, projectConfig: {}, services: recordingServices([]), }), @@ -672,20 +675,20 @@ describe('resolveInputs dependency ordering', () => { const seen: unknown[] = []; const resolved = await resolveInputs(inputs({ org: {}, project: {} }), { - parsed: { org: 'org1', project: 'Project One' }, + parsed: { org: ORG_UID, project: 'Project One' }, projectConfig: {}, services: recordingServices(seen), }); - expect(resolved).toEqual({ org: 'org1', project: PROJECT_UID }); - expect(seen).toEqual(['org1']); + expect(resolved).toEqual({ org: ORG_UID, project: PROJECT_UID }); + expect(seen).toEqual([ORG_UID]); }); it('takes a config-supplied project uid as a uid rather than sniffing its shape', async () => { const seen: unknown[] = []; const resolved = await resolveInputs(inputs({ org: { required: true }, project: { required: true } }), { - parsed: { org: 'org1' }, + parsed: { org: ORG_UID }, projectConfig: { uid: 'blt4d9e2a7c1f6b3085' }, services: { ...recordingServices(seen), isTTY: false }, }); @@ -698,13 +701,13 @@ describe('resolveInputs dependency ordering', () => { const seen: unknown[] = []; const resolved = await resolveInputs(inputs({ org: { required: true }, project: { required: true } }), { - parsed: { org: 'org1', project: 'Project One' }, + parsed: { org: ORG_UID, project: 'Project One' }, projectConfig: {}, services: recordingServices(seen), }); expect(resolved.project).toBe(PROJECT_UID); - expect(seen).toEqual(['org1']); + expect(seen).toEqual([ORG_UID]); }); it('takes a picked project uid as a uid rather than sniffing its shape', async () => { @@ -717,13 +720,13 @@ describe('resolveInputs dependency ordering', () => { }; const resolved = await resolveInputs(inputs({ org: { required: true }, project: { required: true } }), { - parsed: { org: 'org1' }, + parsed: { org: ORG_UID }, projectConfig: {}, services, }); expect(resolved.project).toBe('blt4d9e2a7c1f6b3085'); - expect(seen).toEqual(['org1']); + expect(seen).toEqual([ORG_UID]); }); it('runs a normalize that declares no dependency at all without demanding one', async () => { @@ -734,18 +737,18 @@ describe('resolveInputs dependency ordering', () => { const resolved = await withResolution(custom, () => resolveInputs(inputs({ org: { required: true } }), { - parsed: { org: 'org1' }, + parsed: { org: ORG_UID }, projectConfig: {}, services: recordingServices([]), }), ); - expect(resolved).toEqual({ org: 'org1-normalised' }); + expect(resolved).toEqual({ org: `${ORG_UID}-normalised` }); }); it('restores the catalog order for inputs that declare no dependency at all', async () => { const resolved = await resolveInputs(inputs({ org: { required: true }, limit: {}, skip: {} }), { - parsed: { org: 'org1' }, + parsed: { org: ORG_UID }, projectConfig: {}, services: services(), }); @@ -757,18 +760,18 @@ describe('resolveInputs dependency ordering', () => { describe('resolveInputs cross-flag rules', () => { it('evaluates declared rules against the resolved values and returns them when every rule passes', async () => { const resolved = await resolveInputs(inputs({ org: { required: true }, limit: {} }), { - parsed: { org: 'org1', limit: 10 }, + parsed: { org: ORG_UID, limit: 10 }, projectConfig: {}, services: services(), rules: [exactlyOneOf('org', 'skip')], }); - expect(resolved).toEqual({ org: 'org1', limit: 10 }); + expect(resolved).toEqual({ org: ORG_UID, limit: 10 }); }); it('throws the rule usage error when a rule fails against the resolved values', async () => { const promise = resolveInputs(inputs({ org: { required: true }, limit: {} }), { - parsed: { org: 'org1', limit: 10 }, + parsed: { org: ORG_UID, limit: 10 }, projectConfig: {}, services: services(), rules: [exactlyOneOf('org', 'limit')], @@ -816,7 +819,7 @@ describe('resolveInputs cross-flag rules and where a value came from', () => { it('counts a value from the config file as supplied', async () => { const promise = resolveInputs(inputs({ org: {}, limit: {} }), { parsed: { limit: 10 }, - projectConfig: { organizationUid: 'org1' }, + projectConfig: { organizationUid: ORG_UID }, services: services(), rules: [exactlyOneOf('org', 'limit')], }); @@ -826,7 +829,7 @@ describe('resolveInputs cross-flag rules and where a value came from', () => { it('counts a value the user answered at a prompt as supplied', async () => { const promise = resolveInputs(inputs({ org: { required: true }, project: {} }), { - parsed: { org: 'org1' }, + parsed: { org: ORG_UID }, projectConfig: {}, services: services({ isTTY: true, answer: PROJECT_UID }), rules: [exactlyOneOf('org', 'project')], diff --git a/src/organizations/organization.inputs.test.ts b/src/organizations/organization.inputs.test.ts new file mode 100644 index 00000000..fdd0a627 --- /dev/null +++ b/src/organizations/organization.inputs.test.ts @@ -0,0 +1,44 @@ +import { UsageError } from '../core/errors'; +import type { InputSource, ResolveServices } from '../core/resolution'; +import type { UxLike } from '../core/prompt'; +import type { ApiSurface } from '../resources'; +import { organizationResolution } from './organization.inputs'; + +const NOT_A_UID = '--org accepts an organization UID, not a name.'; + +function services(): ResolveServices { + const ux: UxLike = { print: () => undefined, inquire: async () => undefined as never }; + + return { api: {} as ApiSurface, ux, isTTY: false }; +} + +function normalizeOrg(value: string, source: InputSource = 'flag'): Promise { + const spec = organizationResolution.org as { normalize(value: string, args: unknown): Promise }; + + return spec.normalize(value, { services: services(), resolved: {}, source }); +} + +describe('organization inputs', () => { + it('refuses an organization name given to --org, saying the flag takes a UID', async () => { + await expect(normalizeOrg('Acme Marketing')).rejects.toThrow(new UsageError(NOT_A_UID)); + }); + + it('accepts an organization UID given to --org unchanged', async () => { + await expect(normalizeOrg('blt3ec265bf83fbcf0d')).resolves.toBe('blt3ec265bf83fbcf0d'); + }); + + it('refuses a one-word organization name given to --org as well', async () => { + await expect(normalizeOrg('Acme')).rejects.toThrow(new UsageError(NOT_A_UID)); + }); + + it('trims whitespace around an organization UID given to --org', async () => { + await expect(normalizeOrg(' blt3ec265bf83fbcf0d \n')).resolves.toBe('blt3ec265bf83fbcf0d'); + }); + + it.each(['config', 'prompt'])( + 'leaves an organization UID that came from the %s unchecked', + async (source) => { + await expect(normalizeOrg('org-from-elsewhere', source)).resolves.toBe('org-from-elsewhere'); + }, + ); +}); diff --git a/src/organizations/organization.inputs.ts b/src/organizations/organization.inputs.ts index df99ebf3..60b803b8 100644 --- a/src/organizations/organization.inputs.ts +++ b/src/organizations/organization.inputs.ts @@ -1,16 +1,34 @@ import { Flags } from '@contentstack/cli-utilities'; -import type { ResolutionSpec } from '../core/resolution'; +import { UsageError } from '../core/errors'; +import type { InputSource, ResolutionSpec } from '../core/resolution'; import { promptForOrganization } from './organization.prompt'; +const ORGANIZATION_UID_PATTERN = /^blt[0-9a-f]{16}$/i; + export const organizationFlags = { org: Flags.string({ description: 'Organization UID' }), }; +async function organizationUidOf(value: string, { source }: { source: InputSource }): Promise { + if (source !== 'flag') { + return value; + } + + const uid = value.trim(); + + if (!ORGANIZATION_UID_PATTERN.test(uid)) { + throw new UsageError('--org accepts an organization UID, not a name.'); + } + + return uid; +} + export const organizationResolution = { org: { configPath: 'organizationUid', configLabel: 'organization', prompt: ({ services }) => promptForOrganization(services), + normalize: organizationUidOf, } satisfies ResolutionSpec, }; diff --git a/src/resources.test.ts b/src/resources.test.ts index 0704999d..e5934fd6 100644 --- a/src/resources.test.ts +++ b/src/resources.test.ts @@ -20,6 +20,8 @@ import type { CmaSession } from './transport/cma-client'; import type { EventStreamClient } from './transport/event-stream'; import type { RestApiClient, RestRequest } from './transport/rest-client'; +const ORG_UID = 'blt1111111111111111'; + const UNUSED_CMA: CmaSession = { fetchOrganizations: async () => { throw new Error('this test lists no organizations'); @@ -57,7 +59,7 @@ function args() { }, } as unknown as ApiSurface; - return { services: { api, ux, isTTY: true }, resolved: { org: 'org1' } }; + return { services: { api, ux, isTTY: true }, resolved: { org: ORG_UID } }; } describe('resolution', () => { @@ -105,7 +107,7 @@ describe('resolution', () => { await expect(table.project.prompt?.({ input: {}, services, resolved })).resolves.toBe(PROJECT_UID); - expect(spy).toHaveBeenCalledWith(services, 'org1'); + expect(spy).toHaveBeenCalledWith(services, ORG_UID); spy.mockRestore(); }); @@ -117,7 +119,7 @@ describe('resolution', () => { PROJECT_UID, ); - expect(spy).toHaveBeenCalledWith('org1', { kind: 'name', name: 'Project One' }); + expect(spy).toHaveBeenCalledWith(ORG_UID, { kind: 'name', name: 'Project One' }); spy.mockRestore(); }); @@ -129,7 +131,7 @@ describe('resolution', () => { PROJECT_UID, ); - expect(spy).toHaveBeenCalledWith('org1', { kind: 'uid', uid: PROJECT_UID }); + expect(spy).toHaveBeenCalledWith(ORG_UID, { kind: 'uid', uid: PROJECT_UID }); spy.mockRestore(); }); @@ -141,7 +143,7 @@ describe('resolution', () => { await expect(table.project.normalize?.('Project One', { services, resolved, source })).resolves.toBe(PROJECT_UID); - expect(spy).toHaveBeenCalledWith('org1', { kind: 'uid', uid: 'Project One' }); + expect(spy).toHaveBeenCalledWith(ORG_UID, { kind: 'uid', uid: 'Project One' }); spy.mockRestore(); }, ); @@ -178,13 +180,12 @@ describe('resolution', () => { expect(DEPENDENCIES.deployment).toEqual(['org', 'project', 'env']); }); - it('delegates the org prompt to the organization picker and normalises nothing', async () => { + it('delegates the org prompt to the organization picker and depends on nothing', async () => { const spy = jest.spyOn(organizationPrompt, 'promptForOrganization').mockResolvedValue('org9'); const { services } = args(); await expect(table.org.prompt?.({ input: {}, services, resolved: {} })).resolves.toBe('org9'); expect(spy).toHaveBeenCalledWith(services); - expect(table.org.normalize).toBeUndefined(); expect(table.org.dependsOn).toBeUndefined(); }); }); diff --git a/test/integration/cache-purge.test.ts b/test/integration/cache-purge.test.ts index 819b5b93..7b9f844d 100644 --- a/test/integration/cache-purge.test.ts +++ b/test/integration/cache-purge.test.ts @@ -21,7 +21,7 @@ const ENV_UID = randomBytes(12).toString('hex'); const ENV_PATH = `/manage/projects/${PROJECT_UID}/environments/${ENV_UID}`; const PURGE_PATH = `${ENV_PATH}/revalidate-cdn-cache`; const FOREIGN_ENV_UID = randomBytes(12).toString('hex'); -const OTHER_ORG_UID = randomBytes(9).toString('hex'); +const OTHER_ORG_UID = `blt${randomBytes(8).toString('hex')}`; const DATA_DIR = tmpdir(); const QUOTA_CODE = 'launch.ORGANIZATION.REVALIDATE_RATE_LIMIT_EXCEEDED'; const QUOTA_MESSAGE = "You have reached today's cache revalidation limit for this organization. It resets at 00:00 UTC."; diff --git a/test/integration/organization-prompt.test.ts b/test/integration/organization-prompt.test.ts index c948f265..fa4adcba 100644 --- a/test/integration/organization-prompt.test.ts +++ b/test/integration/organization-prompt.test.ts @@ -293,4 +293,19 @@ describe('integration: the organization prompt', () => { expect(inquired).toEqual([]); expect(onWire).toEqual([]); }); + + it('exits 2 saying --org takes a UID when it is given an organization name, and sends no request', async () => { + useSession(session()); + const inquired = answering([]); + const projects = nock(LAUNCH_HUB_URL).get('/manage/projects').query(true).reply(200, listFixture); + + // runCommand re-splits its argv on spaces, so the shell's quoting is spelled out + const { error } = await onTerminal(['launch:projects:list', '--org', '"Acme Production"', '--data-dir', DATA_DIR]); + + expect(error?.oclif?.exit).toBe(2); + expect(error?.message).toBe('--org accepts an organization UID, not a name.'); + expect(projects.isDone()).toBe(false); + expect(inquired).toEqual([]); + expect(onWire).toEqual([]); + }); }); diff --git a/test/integration/site-open.test.ts b/test/integration/site-open.test.ts index b9dab9bb..7dc42419 100644 --- a/test/integration/site-open.test.ts +++ b/test/integration/site-open.test.ts @@ -21,7 +21,7 @@ jest.mock('../../src/core/browser', () => jest.requireActual('../support/browser const LAUNCH_HUB_URL = 'https://launch-api.integration.test'; const ORG_UID = 'blt4d9e2a7c1f6b3085'; -const OTHER_ORG_UID = randomBytes(9).toString('hex'); +const OTHER_ORG_UID = `blt${randomBytes(8).toString('hex')}`; const PROJECT_UID = randomBytes(12).toString('hex'); const ENV_UID = randomBytes(12).toString('hex'); const OTHER_PROJECT_ENV_UID = randomBytes(12).toString('hex');