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
3 changes: 2 additions & 1 deletion src/actions/sdk/record-published-sdk.ts
Original file line number Diff line number Diff line change
Expand Up @@ -57,8 +57,9 @@ export class RecordPublishedSdkAction {
this.prompts.noSourceRepository(language);
}

const packageSettings = publishingProfile.getPackageSettingsStateForLanguage(language);
const written = await config.merge(RECORDED_BLOCKS, (document) =>
document.with('languages', withLanguage(languagesOf(document), language, entry))
document.with('languages', withLanguage(languagesOf(document), language, entry, packageSettings))
);
if (written.isErr()) {
switch (written.error) {
Expand Down
15 changes: 12 additions & 3 deletions src/types/apimatic-config/languages-block.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
import { isJsonObject, JsonObject } from '../../utils/json-utils.js';
import { GitConfiguration, PackageConfigurationForLanguage } from '../publish/package-settings-configuration.js';
import {
GitConfiguration,
PackageConfigurationForLanguage,
PackageSettingsState
} from '../publish/package-settings-configuration.js';
import { SemVersion, SemVersionString } from '../publish/version.js';
import { Language } from '../sdk/generate.js';
import { ApimaticConfigDocument } from './document.js';
Expand Down Expand Up @@ -65,7 +69,8 @@ export function buildLanguageEntry<L extends Language>(
export function withLanguage<L extends Language>(
languages: PluginLanguages,
language: L,
entry: PluginLanguageEntry<L>
entry: PluginLanguageEntry<L>,
packageSettings: PackageSettingsState
): PluginLanguages {
const existingEntry = languages[language];
const existingPublishing = existingEntry?.publishing;
Expand All @@ -74,7 +79,11 @@ export function withLanguage<L extends Language>(
...existingPublishing,
...entry.publishing,
source: entry.publishing.source ?? existingPublishing?.source,
package: entry.publishing.package ?? existingPublishing?.package
package: entry.publishing.package ?? existingPublishing?.package,
packageConfiguration:
packageSettings === 'disabled'
? undefined
: entry.publishing.packageConfiguration ?? existingPublishing?.packageConfiguration
}
: existingPublishing;

Expand Down
3 changes: 3 additions & 0 deletions src/types/publish/package-settings-configuration.ts
Original file line number Diff line number Diff line change
Expand Up @@ -102,3 +102,6 @@ export interface PackageConfigurationForLanguage {
}

export type PackageConfigurationData = PackageConfigurationForLanguage[Language];

/** A profile that never configured a language is not the same as one that turned it off. */
export type PackageSettingsState = 'configured' | 'disabled' | 'absent';
19 changes: 19 additions & 0 deletions src/types/publish/publishing-profile.ts
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
GoPackageConfiguration,
JavaPackageConfiguration,
PackageConfigurationForLanguage,
PackageSettingsState,
PhpPackageConfiguration,
PythonPackageConfiguration,
RubyPackageConfiguration,
Expand All @@ -31,10 +32,15 @@
return Object.fromEntries(Object.entries(configs).filter(([, config]) => config !== undefined)) as Partial<T>;
}

function settingsState(item: { isEnabled: boolean } | null | undefined): PackageSettingsState {
return item ? (item.isEnabled ? 'configured' : 'disabled') : 'absent';

Check warning on line 36 in src/types/publish/publishing-profile.ts

View check run for this annotation

SonarQubeCloud / SonarCloud Code Analysis

Extract this nested ternary operation into an independent statement.

See more on https://sonarcloud.io/project/issues?id=apimatic_apimatic-cli&issues=AaDnQ6Jpgawf37Ml8SgB&open=AaDnQ6Jpgawf37Ml8SgB&pullRequest=392
}

export class PublishingProfile {
private readonly profile: PublishingProfileItem;
private readonly languageConfigs: { [L in Language]?: PackageConfigurationForLanguage[L] };
private readonly gitConfigs: Partial<Record<Language, GitConfiguration>>;
private readonly packageSettings: Record<Language, PackageSettingsState>;

private constructor(profile: PublishingProfileItem) {
this.profile = profile;
Expand All @@ -47,6 +53,15 @@
[Language.RUBY]: profile.rubyConfiguration?.isEnabled ? PublishingProfile.createRubyConfiguration(profile.rubyConfiguration) : undefined,
[Language.TYPESCRIPT]: profile.typeScriptConfiguration?.isEnabled ? PublishingProfile.createTypeScriptConfiguration(profile.typeScriptConfiguration) : undefined
});
this.packageSettings = {
[Language.CSHARP]: settingsState(profile.cSharpConfiguration),
[Language.GO]: settingsState(profile.goConfiguration),
[Language.JAVA]: settingsState(profile.javaConfiguration),
[Language.PHP]: settingsState(profile.phpConfiguration),
[Language.PYTHON]: settingsState(profile.pythonConfiguration),
[Language.RUBY]: settingsState(profile.rubyConfiguration),
[Language.TYPESCRIPT]: settingsState(profile.typeScriptConfiguration)
};
this.gitConfigs = enabledOnly<Record<Language, GitConfiguration | undefined>>({
[Language.CSHARP]: profile.cSharpGitConfiguration?.isEnabled ? profile.cSharpGitConfiguration : undefined,
[Language.GO]: profile.goGitConfiguration?.isEnabled ? profile.goGitConfiguration : undefined,
Expand Down Expand Up @@ -115,6 +130,10 @@
return this.languageConfigs[language];
}

public getPackageSettingsStateForLanguage(language: Language): PackageSettingsState {
return this.packageSettings[language];
}

public getGitConfigurationForLanguage(language: Language): GitConfiguration | undefined {
return this.gitConfigs[language];
}
Expand Down
10 changes: 8 additions & 2 deletions test/actions/sdk/record-published-sdk.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ import { PluginLanguages } from '../../../src/types/apimatic-config/languages-bl
import { PluginIdentityData } from '../../../src/types/plugin/plugin-config.js';
import { ProjectContext } from '../../../src/types/project-context.js';
import { PublishType } from '../../../src/types/publish-api/publishing-profile-item.js';
import { PackageSettingsState } from '../../../src/types/publish/package-settings-configuration.js';
import { PublishingProfile } from '../../../src/types/publish/publishing-profile.js';
import { SemVersion } from '../../../src/types/publish/version.js';
import { Language } from '../../../src/types/sdk/generate.js';
Expand All @@ -20,10 +21,15 @@ const BOTH = [PublishType.SourceCodePublishing, PublishType.PackagePublishing];

const VERSION = SemVersion.tryCreate('1.2.3')._unsafeUnwrap();

const profileWith = (gitConfiguration: object | undefined, packageConfiguration: object | undefined = undefined) =>
const profileWith = (
gitConfiguration: object | undefined,
packageConfiguration: object | undefined = undefined,
packageSettings: PackageSettingsState = packageConfiguration ? 'configured' : 'absent'
) =>
({
getGitConfigurationForLanguage: () => gitConfiguration,
getPackageConfigurationDataForLanguage: () => packageConfiguration
getPackageConfigurationDataForLanguage: () => packageConfiguration,
getPackageSettingsStateForLanguage: () => packageSettings
} as unknown as PublishingProfile);

const RECORDED_SOURCE_ENTRY = {
Expand Down
52 changes: 50 additions & 2 deletions test/types/apimatic-config/languages-block.test.ts
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
import { expect } from 'chai';
import { buildLanguageEntry } from '../../../src/types/apimatic-config/languages-block';
import { buildLanguageEntry, PluginLanguages, withLanguage } from '../../../src/types/apimatic-config/languages-block';
import {
CSharpPackageConfiguration,
GitConfiguration,
PackageConfigurationForLanguage
PackageConfigurationForLanguage,
PackageSettingsState
} from '../../../src/types/publish/package-settings-configuration';
import { SemVersion } from '../../../src/types/publish/version';
import { Language } from '../../../src/types/sdk/generate';
Expand Down Expand Up @@ -107,3 +108,50 @@ describe('buildLanguageEntry', () => {
});
});
});

describe('withLanguage', () => {
const recorded: PluginLanguages = {
[Language.CSHARP]: {
publishing: {
source: { repositoryUrl: 'https://github.com/acme/sdk', branch: 'main' },
package: { version: '1.0.0' },
packageConfiguration: CSHARP_CONFIGURATION
}
}
};

const publishedWith = (packageSettings: PackageSettingsState, configuration?: CSharpPackageConfiguration) =>
withLanguage(
recorded,
Language.CSHARP,
buildLanguageEntry(Language.CSHARP, gitConfig('acme/sdk'), configuration, undefined),
packageSettings
)[Language.CSHARP]?.publishing;

it('keeps the recorded release a source-only publish did not write', () => {
expect(publishedWith('configured', CSHARP_CONFIGURATION)?.package).to.deep.equal({ version: '1.0.0' });
});

it('writes the configuration the profile holds', () => {
const renamed = { ...CSHARP_CONFIGURATION, packageId: 'Acme.Payments.Sdk.V2' };

expect(publishedWith('configured', renamed)?.packageConfiguration).to.deep.equal(renamed);
});

it('keeps the recorded configuration when the profile has none', () => {
expect(publishedWith('absent')?.packageConfiguration).to.deep.equal(CSHARP_CONFIGURATION);
});

it('drops the recorded configuration when the profile turned the settings off', () => {
expect(publishedWith('disabled')?.packageConfiguration).to.be.undefined;
});

it('records a language the file does not yet carry', () => {
const entry = buildLanguageEntry(Language.PYTHON, gitConfig('acme/sdk-python'), undefined, VERSION);

const languages = withLanguage({}, Language.PYTHON, entry, 'absent');

expect(languages[Language.PYTHON]?.publishing?.package).to.deep.equal({ version: '1.2.3' });
expect(languages[Language.CSHARP]).to.be.undefined;
});
});
Loading