Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -2,20 +2,19 @@ import {pollAppLogs} from './poll-app-logs.js'
import {writeAppLogsToFile} from './write-app-logs.js'
import {FunctionRunLog} from '../types.js'
import {testDeveloperPlatformClient} from '../../../models/app/app.test-data.js'
import {partnersFqdn} from '@shopify/cli-kit/node/context/fqdn'
import {describe, expect, test, vi, beforeEach, afterEach} from 'vitest'
import * as components from '@shopify/cli-kit/node/ui/components'
import * as output from '@shopify/cli-kit/node/output'
import camelcaseKeys from 'camelcase-keys'
import {appManagementFqdn} from '@shopify/cli-kit/node/context/fqdn'

const JWT_TOKEN = 'jwtToken'
const API_KEY = 'apiKey'
const TEST_LOGS_DIR = '/test/logs/dir'

vi.mock('./write-app-logs.js')
vi.mock('@shopify/cli-kit/node/http')

const FQDN = await partnersFqdn()
const FQDN = await appManagementFqdn()
const LOGS = '1\\n2\\n3\\n4\\n'
const FUNCTION_ERROR = 'function_error'
const FUNCTION_RUN = 'function_run'
Expand Down
24 changes: 18 additions & 6 deletions packages/app/src/cli/services/dev/fetch.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +43,9 @@ afterEach(() => {
})

describe('fetchOrganizations', async () => {
test('returns fetched organizations from Partners and App Management', async () => {
test('returns fetched organizations from Partners and App Management for 1P development', async () => {
// Given
vi.stubEnv('SHOPIFY_CLI_1P_DEV', 'true')
const partnersClient: PartnersClient = testDeveloperPlatformClient({
organizations: () => Promise.resolve([ORG1]),
}) as PartnersClient
Expand All @@ -63,23 +64,34 @@ describe('fetchOrganizations', async () => {
expect(appManagementClient.organizations).toHaveBeenCalled()
})

test('returns fetched organizations from App Management for 3P development', async () => {
// Given
const appManagementClient: AppManagementClient = testDeveloperPlatformClient({
organizations: () => Promise.resolve([ORG2]),
}) as AppManagementClient
vi.mocked(AppManagementClient.getInstance).mockReturnValue(appManagementClient)

// When
const got = await fetchOrganizations()

// Then
expect(got).toEqual([ORG2])
expect(PartnersClient.getInstance).not.toHaveBeenCalled()
expect(appManagementClient.organizations).toHaveBeenCalled()
})

test('throws if there are no organizations', async () => {
// Given
const partnersClient: PartnersClient = testDeveloperPlatformClient({
organizations: () => Promise.resolve([]),
}) as PartnersClient
const appManagementClient: AppManagementClient = testDeveloperPlatformClient({
organizations: () => Promise.resolve([]),
}) as AppManagementClient
vi.mocked(PartnersClient.getInstance).mockReturnValue(partnersClient)
vi.mocked(AppManagementClient.getInstance).mockReturnValue(appManagementClient)

// When
const got = fetchOrganizations()

// Then
await expect(got).rejects.toThrow('No Organization found')
expect(partnersClient.organizations).toHaveBeenCalled()
expect(appManagementClient.organizations).toHaveBeenCalled()
})
})
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -96,14 +96,20 @@ export function selectDeveloperPlatformClient({
organization,
}: SelectDeveloperPlatformClientOptions = {}): DeveloperPlatformClient {
if (organization) return selectDeveloperPlatformClientByOrg(organization)
return PartnersClient.getInstance()
return defaultDeveloperPlatformClient()
}

function selectDeveloperPlatformClientByOrg(organization: Organization): DeveloperPlatformClient {
if (organization.source === OrganizationSource.BusinessPlatform) return AppManagementClient.getInstance()
return PartnersClient.getInstance()
}

function defaultDeveloperPlatformClient(): DeveloperPlatformClient {
if (blockPartnersAccess()) return AppManagementClient.getInstance()

return PartnersClient.getInstance()
}

export interface CreateAppOptions {
name: string
isLaunchable?: boolean
Expand Down
4 changes: 4 additions & 0 deletions packages/cli-kit/src/public/node/context/fqdn.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,11 @@ import {
adminFqdn,
} from './fqdn.js'
import {Environment, serviceEnvironment} from '../../../private/node/context/service.js'
import {blockPartnersAccess} from '../environment.js'
import {expect, describe, test, vi} from 'vitest'

vi.mock('../../../private/node/context/service.js')
vi.mock('../environment.js')

vi.mock('../vendor/dev_server/index.js', () => {
return {
Expand All @@ -32,6 +34,7 @@ describe('partners', () => {
test('returns the local fqdn when the environment is local', async () => {
// Given
vi.mocked(serviceEnvironment).mockReturnValue(Environment.Local)
vi.mocked(blockPartnersAccess).mockReturnValue(false)

// When
const got = await partnersFqdn()
Expand All @@ -43,6 +46,7 @@ describe('partners', () => {
test('returns the production fqdn when the environment is production', async () => {
// Given
vi.mocked(serviceEnvironment).mockReturnValue(Environment.Production)
vi.mocked(blockPartnersAccess).mockReturnValue(false)

// When
const got = await partnersFqdn()
Expand Down
2 changes: 1 addition & 1 deletion packages/cli-kit/src/public/node/context/fqdn.ts
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ export const NotProvidedStoreFQDNError = new AbortError(
*/
export async function partnersFqdn(): Promise<string> {
if (blockPartnersAccess()) {
throw new BugError('Partners API is blocked by the SHOPIFY_CLI_NEVER_USE_PARTNERS_API environment variable.')
throw new BugError('Partners API is is no longer available.')
}
const environment = serviceEnvironment()
const productionFqdn = 'partners.shopify.com'
Expand Down
7 changes: 5 additions & 2 deletions packages/cli-kit/src/public/node/environment.ts
Original file line number Diff line number Diff line change
Expand Up @@ -86,10 +86,13 @@ export function jsonOutputEnabled(environment = getEnvironmentVariables()): bool
/**
* If true, the CLI should not use the Partners API.
*
* @returns True if the SHOPIFY_CLI_NEVER_USE_PARTNERS_API environment variable is set.
* @returns True when SHOPIFY_CLI_NEVER_USE_PARTNERS_API is set or SHOPIFY_CLI_1P_DEV is not set.
*/
export function blockPartnersAccess(): boolean {
return isTruthy(getEnvironmentVariables()[environmentVariables.neverUsePartnersApi])
return (
isTruthy(getEnvironmentVariables()[environmentVariables.neverUsePartnersApi]) ||
!isTruthy(getEnvironmentVariables()[environmentVariables.firstPartyDev])
)
}

/**
Expand Down