From 24346f2dce59e4245413dcdf79fe2ee26c83462e Mon Sep 17 00:00:00 2001 From: Erik Engervall Date: Wed, 5 May 2021 17:10:00 +0200 Subject: [PATCH] Rename successCb to onSuccess Signed-off-by: Erik Engervall --- plugins/git-release-manager/dev/index.tsx | 2 +- .../CreateReleaseCandidate.tsx | 6 +++--- .../hooks/useCreateReleaseCandidate.test.tsx | 4 ++-- .../hooks/useCreateReleaseCandidate.ts | 12 ++++++------ .../git-release-manager/src/features/Features.tsx | 6 +++--- .../src/features/Patch/Patch.tsx | 10 +++++----- .../src/features/Patch/PatchBody.tsx | 6 +++--- .../src/features/Patch/hooks/usePatch.test.ts | 4 ++-- .../src/features/Patch/hooks/usePatch.ts | 12 ++++++------ .../src/features/PromoteRc/PromoteRc.tsx | 6 +++--- .../src/features/PromoteRc/PromoteRcBody.tsx | 6 +++--- .../features/PromoteRc/hooks/usePromoteRc.test.ts | 4 ++-- .../src/features/PromoteRc/hooks/usePromoteRc.ts | 12 ++++++------ plugins/git-release-manager/src/types/types.ts | 14 +++++++------- 14 files changed, 52 insertions(+), 52 deletions(-) diff --git a/plugins/git-release-manager/dev/index.tsx b/plugins/git-release-manager/dev/index.tsx index ba794e7b21..cad8aaa9dc 100644 --- a/plugins/git-release-manager/dev/index.tsx +++ b/plugins/git-release-manager/dev/index.tsx @@ -79,7 +79,7 @@ createDevApp() }} features={{ createRc: { - successCb: ({ + onSuccess: ({ comparisonUrl, createdTag, gitReleaseName, diff --git a/plugins/git-release-manager/src/features/CreateReleaseCandidate/CreateReleaseCandidate.tsx b/plugins/git-release-manager/src/features/CreateReleaseCandidate/CreateReleaseCandidate.tsx index 011c827e3c..8f99610fb3 100644 --- a/plugins/git-release-manager/src/features/CreateReleaseCandidate/CreateReleaseCandidate.tsx +++ b/plugins/git-release-manager/src/features/CreateReleaseCandidate/CreateReleaseCandidate.tsx @@ -45,7 +45,7 @@ interface CreateReleaseCandidateProps { defaultBranch: GetRepositoryResult['repository']['defaultBranch']; latestRelease: GetLatestReleaseResult['latestRelease']; releaseBranch: GetBranchResult['branch'] | null; - successCb?: ComponentConfigCreateRc['successCb']; + onSuccess?: ComponentConfigCreateRc['onSuccess']; } const InfoCardPlusWrapper = ({ children }: { children: React.ReactNode }) => { @@ -63,7 +63,7 @@ export const CreateReleaseCandidate = ({ defaultBranch, latestRelease, releaseBranch, - successCb, + onSuccess, }: CreateReleaseCandidateProps) => { const { project } = useProjectContext(); @@ -90,7 +90,7 @@ export const CreateReleaseCandidate = ({ latestRelease, releaseCandidateGitInfo, project, - successCb, + onSuccess, }); if (responseSteps.length > 0) { return ( diff --git a/plugins/git-release-manager/src/features/CreateReleaseCandidate/hooks/useCreateReleaseCandidate.test.tsx b/plugins/git-release-manager/src/features/CreateReleaseCandidate/hooks/useCreateReleaseCandidate.test.tsx index b4551083a3..cd7f212531 100644 --- a/plugins/git-release-manager/src/features/CreateReleaseCandidate/hooks/useCreateReleaseCandidate.test.tsx +++ b/plugins/git-release-manager/src/features/CreateReleaseCandidate/hooks/useCreateReleaseCandidate.test.tsx @@ -56,14 +56,14 @@ describe('useCreateReleaseCandidate', () => { expect(result.current.responseSteps).toHaveLength(6); }); - it('should return the expected responseSteps and progress (with successCb)', async () => { + it('should return the expected responseSteps and progress (with onSuccess)', async () => { const { result } = renderHook(() => useCreateReleaseCandidate({ defaultBranch: mockDefaultBranch, latestRelease: mockReleaseVersionCalver, releaseCandidateGitInfo: mockNextGitInfoCalver, project: mockCalverProject, - successCb: jest.fn(), + onSuccess: jest.fn(), }), ); diff --git a/plugins/git-release-manager/src/features/CreateReleaseCandidate/hooks/useCreateReleaseCandidate.ts b/plugins/git-release-manager/src/features/CreateReleaseCandidate/hooks/useCreateReleaseCandidate.ts index 17ae878c46..dbef49d185 100644 --- a/plugins/git-release-manager/src/features/CreateReleaseCandidate/hooks/useCreateReleaseCandidate.ts +++ b/plugins/git-release-manager/src/features/CreateReleaseCandidate/hooks/useCreateReleaseCandidate.ts @@ -36,7 +36,7 @@ interface UseCreateReleaseCandidate { latestRelease: GetLatestReleaseResult['latestRelease']; releaseCandidateGitInfo: ReturnType; project: Project; - successCb?: ComponentConfigCreateRc['successCb']; + onSuccess?: ComponentConfigCreateRc['onSuccess']; } export function useCreateReleaseCandidate({ @@ -44,7 +44,7 @@ export function useCreateReleaseCandidate({ latestRelease, releaseCandidateGitInfo, project, - successCb, + onSuccess, }: UseCreateReleaseCandidate): CardHook { const pluginApiClient = useApi(gitReleaseManagerApiRef); const { user } = useUserContext(); @@ -258,14 +258,14 @@ export function useCreateReleaseCandidate({ }, [getComparisonRes.value, getComparisonRes.error]); /** - * (7) Run successCb if defined + * (7) Run onSuccess if defined */ useAsync(async () => { - if (successCb && !!createReleaseRes.value && !!getComparisonRes.value) { + if (onSuccess && !!createReleaseRes.value && !!getComparisonRes.value) { abortIfError(createReleaseRes.error); try { - await successCb({ + await onSuccess({ comparisonUrl: getComparisonRes.value.htmlUrl, createdTag: createReleaseRes.value.tagName, gitReleaseName: createReleaseRes.value.name, @@ -283,7 +283,7 @@ export function useCreateReleaseCandidate({ } }, [createReleaseRes.value]); - const TOTAL_STEPS = 6 + (!!successCb ? 1 : 0); + const TOTAL_STEPS = 6 + (!!onSuccess ? 1 : 0); const [progress, setProgress] = useState(0); useEffect(() => { setProgress((responseSteps.length / TOTAL_STEPS) * 100); diff --git a/plugins/git-release-manager/src/features/Features.tsx b/plugins/git-release-manager/src/features/Features.tsx index 3649b0c3f7..fa6fc1198b 100644 --- a/plugins/git-release-manager/src/features/Features.tsx +++ b/plugins/git-release-manager/src/features/Features.tsx @@ -125,14 +125,14 @@ export function Features({ latestRelease={gitBatchInfo.value.latestRelease} releaseBranch={gitBatchInfo.value.releaseBranch} defaultBranch={gitBatchInfo.value.repository.defaultBranch} - successCb={features?.createRc?.successCb} + onSuccess={features?.createRc?.onSuccess} /> )} {!features?.promoteRc?.omit && ( )} @@ -140,7 +140,7 @@ export function Features({ )} diff --git a/plugins/git-release-manager/src/features/Patch/Patch.tsx b/plugins/git-release-manager/src/features/Patch/Patch.tsx index 11bc25486a..ac54f01398 100644 --- a/plugins/git-release-manager/src/features/Patch/Patch.tsx +++ b/plugins/git-release-manager/src/features/Patch/Patch.tsx @@ -32,13 +32,13 @@ import { useProjectContext } from '../../contexts/ProjectContext'; interface PatchProps { latestRelease: GetLatestReleaseResult['latestRelease']; releaseBranch: GetBranchResult['branch'] | null; - successCb?: ComponentConfigPatch['successCb']; + onSuccess?: ComponentConfigPatch['onSuccess']; } export const Patch = ({ latestRelease, releaseBranch, - successCb, + onSuccess, }: PatchProps) => { return ( @@ -51,13 +51,13 @@ export const Patch = ({ ); }; -function BodyWrapper({ latestRelease, releaseBranch, successCb }: PatchProps) { +function BodyWrapper({ latestRelease, releaseBranch, onSuccess }: PatchProps) { const { project } = useProjectContext(); if (latestRelease === null) { @@ -91,7 +91,7 @@ function BodyWrapper({ latestRelease, releaseBranch, successCb }: PatchProps) { bumpedTag={bumpedTag.bumpedTag} latestRelease={latestRelease} releaseBranch={releaseBranch} - successCb={successCb} + onSuccess={onSuccess} tagParts={bumpedTag.tagParts} /> ); diff --git a/plugins/git-release-manager/src/features/Patch/PatchBody.tsx b/plugins/git-release-manager/src/features/Patch/PatchBody.tsx index 42f9550652..4298724511 100644 --- a/plugins/git-release-manager/src/features/Patch/PatchBody.tsx +++ b/plugins/git-release-manager/src/features/Patch/PatchBody.tsx @@ -56,7 +56,7 @@ interface PatchBodyProps { bumpedTag: string; latestRelease: NonNullable; releaseBranch: GetBranchResult['branch']; - successCb?: ComponentConfigPatch['successCb']; + onSuccess?: ComponentConfigPatch['onSuccess']; tagParts: NonNullable; } @@ -64,7 +64,7 @@ export const PatchBody = ({ bumpedTag, latestRelease, releaseBranch, - successCb, + onSuccess, tagParts, }: PatchBodyProps) => { const pluginApiClient = useApi(gitReleaseManagerApiRef); @@ -98,7 +98,7 @@ export const PatchBody = ({ latestRelease, project, tagParts, - successCb, + onSuccess, }); if (responseSteps.length > 0) { diff --git a/plugins/git-release-manager/src/features/Patch/hooks/usePatch.test.ts b/plugins/git-release-manager/src/features/Patch/hooks/usePatch.test.ts index 9b8646b75e..1a343cb51c 100644 --- a/plugins/git-release-manager/src/features/Patch/hooks/usePatch.test.ts +++ b/plugins/git-release-manager/src/features/Patch/hooks/usePatch.test.ts @@ -57,14 +57,14 @@ describe('patch', () => { expect(result.current.responseSteps).toHaveLength(9); }); - it('should return the expected responseSteps and progress (with successCb)', async () => { + it('should return the expected responseSteps and progress (with onSuccess)', async () => { const { result } = renderHook(() => usePatch({ bumpedTag: mockBumpedTag, latestRelease: mockReleaseVersionCalver, project: mockCalverProject, tagParts: mockTagParts, - successCb: jest.fn(), + onSuccess: jest.fn(), }), ); diff --git a/plugins/git-release-manager/src/features/Patch/hooks/usePatch.ts b/plugins/git-release-manager/src/features/Patch/hooks/usePatch.ts index 0f5007bb34..d0f22fba4f 100644 --- a/plugins/git-release-manager/src/features/Patch/hooks/usePatch.ts +++ b/plugins/git-release-manager/src/features/Patch/hooks/usePatch.ts @@ -37,7 +37,7 @@ interface Patch { latestRelease: NonNullable; project: Project; tagParts: NonNullable; - successCb?: ComponentConfigPatch['successCb']; + onSuccess?: ComponentConfigPatch['onSuccess']; } // Inspiration: https://stackoverflow.com/questions/53859199/how-to-cherry-pick-through-githubs-api @@ -46,7 +46,7 @@ export function usePatch({ latestRelease, project, tagParts, - successCb, + onSuccess, }: Patch): CardHook { const pluginApiClient = useApi(gitReleaseManagerApiRef); const { user } = useUserContext(); @@ -327,16 +327,16 @@ ${selectedPatchCommit.commit.message}`, }, [createdReferenceRes.value, createdReferenceRes.error]); /** - * (10) Run successCb if defined + * (10) Run onSuccess if defined */ useAsync(async () => { - if (!successCb) return; + if (!onSuccess) return; abortIfError(updatedReleaseRes.error); if (!updatedReleaseRes.value || !releaseBranchRes.value) return; try { - await successCb?.({ + await onSuccess?.({ updatedReleaseUrl: updatedReleaseRes.value.htmlUrl, updatedReleaseName: updatedReleaseRes.value.name, previousTag: latestRelease.tagName, @@ -355,7 +355,7 @@ ${selectedPatchCommit.commit.message}`, }); }, [updatedReleaseRes.value]); - const TOTAL_STEPS = 9 + (!!successCb ? 1 : 0); + const TOTAL_STEPS = 9 + (!!onSuccess ? 1 : 0); const [progress, setProgress] = useState(0); useEffect(() => { setProgress((responseSteps.length / TOTAL_STEPS) * 100); diff --git a/plugins/git-release-manager/src/features/PromoteRc/PromoteRc.tsx b/plugins/git-release-manager/src/features/PromoteRc/PromoteRc.tsx index af02c52d4d..6166fde1b6 100644 --- a/plugins/git-release-manager/src/features/PromoteRc/PromoteRc.tsx +++ b/plugins/git-release-manager/src/features/PromoteRc/PromoteRc.tsx @@ -27,10 +27,10 @@ import { TEST_IDS } from '../../test-helpers/test-ids'; interface PromoteRcProps { latestRelease: GetLatestReleaseResult['latestRelease']; - successCb?: ComponentConfigPromoteRc['successCb']; + onSuccess?: ComponentConfigPromoteRc['onSuccess']; } -export const PromoteRc = ({ latestRelease, successCb }: PromoteRcProps) => { +export const PromoteRc = ({ latestRelease, onSuccess }: PromoteRcProps) => { function Body() { if (latestRelease === null) { return ; @@ -52,7 +52,7 @@ export const PromoteRc = ({ latestRelease, successCb }: PromoteRcProps) => { ); } - return ; + return ; } return ( diff --git a/plugins/git-release-manager/src/features/PromoteRc/PromoteRcBody.tsx b/plugins/git-release-manager/src/features/PromoteRc/PromoteRcBody.tsx index 6f8695b37b..3ca1d916f3 100644 --- a/plugins/git-release-manager/src/features/PromoteRc/PromoteRcBody.tsx +++ b/plugins/git-release-manager/src/features/PromoteRc/PromoteRcBody.tsx @@ -26,16 +26,16 @@ import { usePromoteRc } from './hooks/usePromoteRc'; interface PromoteRcBodyProps { rcRelease: NonNullable; - successCb?: ComponentConfigPromoteRc['successCb']; + onSuccess?: ComponentConfigPromoteRc['onSuccess']; } -export const PromoteRcBody = ({ rcRelease, successCb }: PromoteRcBodyProps) => { +export const PromoteRcBody = ({ rcRelease, onSuccess }: PromoteRcBodyProps) => { const releaseVersion = rcRelease.tagName.replace('rc-', 'version-'); const { progress, responseSteps, run, runInvoked } = usePromoteRc({ rcRelease, releaseVersion, - successCb, + onSuccess, }); if (responseSteps.length > 0) { diff --git a/plugins/git-release-manager/src/features/PromoteRc/hooks/usePromoteRc.test.ts b/plugins/git-release-manager/src/features/PromoteRc/hooks/usePromoteRc.test.ts index 84953d4059..ba0f4421a6 100644 --- a/plugins/git-release-manager/src/features/PromoteRc/hooks/usePromoteRc.test.ts +++ b/plugins/git-release-manager/src/features/PromoteRc/hooks/usePromoteRc.test.ts @@ -57,12 +57,12 @@ describe('usePromoteRc', () => { expect(result.current.responseSteps).toHaveLength(4); }); - it('should return the expected responseSteps and progress (with successCb)', async () => { + it('should return the expected responseSteps and progress (with onSuccess)', async () => { const { result } = renderHook(() => usePromoteRc({ rcRelease: mockReleaseCandidateCalver, releaseVersion: 'version-1.2.3', - successCb: jest.fn(), + onSuccess: jest.fn(), }), ); diff --git a/plugins/git-release-manager/src/features/PromoteRc/hooks/usePromoteRc.ts b/plugins/git-release-manager/src/features/PromoteRc/hooks/usePromoteRc.ts index 60ecd26ae9..1d78895aee 100644 --- a/plugins/git-release-manager/src/features/PromoteRc/hooks/usePromoteRc.ts +++ b/plugins/git-release-manager/src/features/PromoteRc/hooks/usePromoteRc.ts @@ -30,13 +30,13 @@ import { useUserContext } from '../../../contexts/UserContext'; interface PromoteRc { rcRelease: NonNullable; releaseVersion: string; - successCb?: ComponentConfigPromoteRc['successCb']; + onSuccess?: ComponentConfigPromoteRc['onSuccess']; } export function usePromoteRc({ rcRelease, releaseVersion, - successCb, + onSuccess, }: PromoteRc): CardHook { const pluginApiClient = useApi(gitReleaseManagerApiRef); const { user } = useUserContext(); @@ -162,14 +162,14 @@ export function usePromoteRc({ }, [createRcRes.value, createRcRes.error]); /** - * (5) Run successCb if defined + * (5) Run onSuccess if defined */ useAsync(async () => { - if (successCb && !!promotedReleaseRes.value) { + if (onSuccess && !!promotedReleaseRes.value) { abortIfError(promotedReleaseRes.error); try { - await successCb?.({ + await onSuccess?.({ gitReleaseUrl: promotedReleaseRes.value.htmlUrl, gitReleaseName: promotedReleaseRes.value.name, previousTagUrl: rcRelease.htmlUrl, @@ -188,7 +188,7 @@ export function usePromoteRc({ } }, [promotedReleaseRes.value]); - const TOTAL_STEPS = 4 + (!!successCb ? 1 : 0); + const TOTAL_STEPS = 4 + (!!onSuccess ? 1 : 0); const [progress, setProgress] = useState(0); useEffect(() => { setProgress((responseSteps.length / TOTAL_STEPS) * 100); diff --git a/plugins/git-release-manager/src/types/types.ts b/plugins/git-release-manager/src/types/types.ts index 8e2a034d3a..5feac149ca 100644 --- a/plugins/git-release-manager/src/types/types.ts +++ b/plugins/git-release-manager/src/types/types.ts @@ -16,19 +16,19 @@ export type ComponentConfig = { omit?: boolean; - successCb?: (args: Args) => Promise | void; + onSuccess?: (args: Args) => Promise | void; }; -interface CreateRcSuccessCbArgs { +interface CreateRcOnSuccessArgs { gitReleaseUrl: string; gitReleaseName: string | null; comparisonUrl: string; previousTag?: string; createdTag: string; } -export type ComponentConfigCreateRc = ComponentConfig; +export type ComponentConfigCreateRc = ComponentConfig; -interface PromoteRcSuccessCbArgs { +interface PromoteRcOnSuccessArgs { gitReleaseUrl: string; gitReleaseName: string | null; previousTagUrl: string; @@ -36,9 +36,9 @@ interface PromoteRcSuccessCbArgs { updatedTagUrl: string; updatedTag: string; } -export type ComponentConfigPromoteRc = ComponentConfig; +export type ComponentConfigPromoteRc = ComponentConfig; -interface PatchSuccessCbArgs { +interface PatchOnSuccessArgs { updatedReleaseUrl: string; updatedReleaseName: string | null; previousTag: string; @@ -46,7 +46,7 @@ interface PatchSuccessCbArgs { patchCommitUrl: string; patchCommitMessage: string; } -export type ComponentConfigPatch = ComponentConfig; +export type ComponentConfigPatch = ComponentConfig; export interface ResponseStep { message: string | React.ReactNode;