Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Browse files
Browse the repository at this point in the history
Move more files into src/webhooks (#36578)
- Loading branch information
Showing
8 changed files
with
125 additions
and
119 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
118 changes: 4 additions & 114 deletions
118
pages/[versionId]/webhooks-and-events/webhooks/webhook-events-and-payloads.tsx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,114 +1,4 @@ | ||
| import { GetServerSideProps } from 'next' | ||
| import { useRouter } from 'next/router' | ||
| import { useEffect } from 'react' | ||
|
|
||
| import { getInitialPageWebhooks } from 'src/webhooks/lib' | ||
| import { getMainContext, MainContext, MainContextT } from 'components/context/MainContext' | ||
| import { | ||
| getAutomatedPageContextFromRequest, | ||
| AutomatedPageContext, | ||
| AutomatedPageContextT, | ||
| } from 'components/context/AutomatedPageContext' | ||
| import { WebhookAction } from 'components/webhooks/types' | ||
| import { Webhook } from 'components/webhooks/Webhook' | ||
| import { getAutomatedPageMiniTocItems } from 'lib/get-mini-toc-items' | ||
| import { AutomatedPage } from 'components/article/AutomatedPage' | ||
|
|
||
| type Props = { | ||
| mainContext: MainContextT | ||
| automatedPageContext: AutomatedPageContextT | ||
| webhooks: WebhookAction[] | ||
| } | ||
|
|
||
| export default function WebhooksEventsAndPayloads({ | ||
| mainContext, | ||
| automatedPageContext, | ||
| webhooks, | ||
| }: Props) { | ||
| const router = useRouter() | ||
| const { locale } = router | ||
| const content = webhooks.map((webhook: WebhookAction, index) => { | ||
| return ( | ||
| <div key={`${webhook.data.requestPath}-${index}`}> | ||
| <Webhook webhook={webhook} /> | ||
| </div> | ||
| ) | ||
| }) | ||
|
|
||
| // When someone clicks on a minitoc hash anchor link on this page, we want to | ||
| // remove the type query parameter from the URL because the type won't make | ||
| // sense anymore (e.g. ?actionTtype=closed#issues and you click on the fork minitoc | ||
| // we don't want the URL to be ?actionType=closed#fork). | ||
| useEffect(() => { | ||
| const hashChangeHandler = () => { | ||
| const { asPath } = router | ||
| let [pathRoot, pathQuery = ''] = asPath.split('?') | ||
|
|
||
| if (pathRoot.includes('#')) { | ||
| pathRoot = pathRoot.split('#')[0] | ||
| } | ||
|
|
||
| // carry over any other query parameters besides `actionType` for the webhook | ||
| // action type | ||
| if (pathQuery.includes('#')) { | ||
| pathQuery = pathQuery.split('#')[0] | ||
| } | ||
| const params = new URLSearchParams(pathQuery) | ||
| params.delete('actionType') | ||
|
|
||
| if (location.hash) { | ||
| router.replace( | ||
| { pathname: pathRoot, query: params.toString(), hash: location.hash }, | ||
| undefined, | ||
| { | ||
| shallow: true, | ||
| locale, | ||
| } | ||
| ) | ||
| } | ||
| } | ||
|
|
||
| window.addEventListener('hashchange', hashChangeHandler) | ||
|
|
||
| return () => { | ||
| window.removeEventListener('hashchange', hashChangeHandler) | ||
| } | ||
| }, [locale]) | ||
|
|
||
| return ( | ||
| <MainContext.Provider value={mainContext}> | ||
| <AutomatedPageContext.Provider value={automatedPageContext}> | ||
| <AutomatedPage>{content}</AutomatedPage> | ||
| </AutomatedPageContext.Provider> | ||
| </MainContext.Provider> | ||
| ) | ||
| } | ||
|
|
||
| export const getServerSideProps: GetServerSideProps<Props> = async (context) => { | ||
| const req = context.req as object | ||
| const res = context.res as object | ||
| const currentVersion = context.query.versionId as string | ||
| const mainContext = await getMainContext(req, res) | ||
| const { miniTocItems } = getAutomatedPageContextFromRequest(req) | ||
|
|
||
| // Get data for initial webhooks page (i.e. only 1 action type per webhook and | ||
| // no nested parameters) | ||
| const webhooks = (await getInitialPageWebhooks(currentVersion)) as WebhookAction[] | ||
|
|
||
| // Build the minitocs for the webhooks page which is based on the webhook | ||
| // categories in addition to the Markdown in the webhook-events-and-payloads.md | ||
| // content file | ||
| const webhooksMiniTocs = await getAutomatedPageMiniTocItems( | ||
| webhooks.map((webhook) => webhook.data.category), | ||
| context | ||
| ) | ||
| webhooksMiniTocs && miniTocItems.push(...webhooksMiniTocs) | ||
|
|
||
| return { | ||
| props: { | ||
| webhooks, | ||
| mainContext, | ||
| automatedPageContext: getAutomatedPageContextFromRequest(req), | ||
| }, | ||
| } | ||
| } | ||
| export { | ||
| default, | ||
| getServerSideProps, | ||
| } from '../../../../src/webhooks/pages/webhook-events-and-payloads' |
File renamed without changes.
File renamed without changes.
2 changes: 1 addition & 1 deletion
2
components/webhooks/types.ts → src/webhooks/components/types.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
6 changes: 3 additions & 3 deletions
6
middleware/api/webhooks.js → src/webhooks/middleware/webhooks.js
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,115 @@ | ||
| import { GetServerSideProps } from 'next' | ||
| import { useRouter } from 'next/router' | ||
| import { useEffect } from 'react' | ||
|
|
||
| import { getMainContext, MainContext, MainContextT } from 'components/context/MainContext' | ||
| import { | ||
| getAutomatedPageContextFromRequest, | ||
| AutomatedPageContext, | ||
| AutomatedPageContextT, | ||
| } from 'components/context/AutomatedPageContext' | ||
| import { WebhookAction } from 'src/webhooks/components/types' | ||
| import { Webhook } from 'src/webhooks/components/Webhook' | ||
| import { AutomatedPage } from 'components/article/AutomatedPage' | ||
|
|
||
| type Props = { | ||
| mainContext: MainContextT | ||
| automatedPageContext: AutomatedPageContextT | ||
| webhooks: WebhookAction[] | ||
| } | ||
|
|
||
| export default function WebhooksEventsAndPayloads({ | ||
| mainContext, | ||
| automatedPageContext, | ||
| webhooks, | ||
| }: Props) { | ||
| const router = useRouter() | ||
| const { locale } = router | ||
| const content = webhooks.map((webhook: WebhookAction, index) => { | ||
| return ( | ||
| <div key={`${webhook.data.requestPath}-${index}`}> | ||
| <Webhook webhook={webhook} /> | ||
| </div> | ||
| ) | ||
| }) | ||
|
|
||
| // When someone clicks on a minitoc hash anchor link on this page, we want to | ||
| // remove the type query parameter from the URL because the type won't make | ||
| // sense anymore (e.g. ?actionTtype=closed#issues and you click on the fork minitoc | ||
| // we don't want the URL to be ?actionType=closed#fork). | ||
| useEffect(() => { | ||
| const hashChangeHandler = () => { | ||
| const { asPath } = router | ||
| let [pathRoot, pathQuery = ''] = asPath.split('?') | ||
|
|
||
| if (pathRoot.includes('#')) { | ||
| pathRoot = pathRoot.split('#')[0] | ||
| } | ||
|
|
||
| // carry over any other query parameters besides `actionType` for the webhook | ||
| // action type | ||
| if (pathQuery.includes('#')) { | ||
| pathQuery = pathQuery.split('#')[0] | ||
| } | ||
| const params = new URLSearchParams(pathQuery) | ||
| params.delete('actionType') | ||
|
|
||
| if (location.hash) { | ||
| router.replace( | ||
| { pathname: pathRoot, query: params.toString(), hash: location.hash }, | ||
| undefined, | ||
| { | ||
| shallow: true, | ||
| locale, | ||
| } | ||
| ) | ||
| } | ||
| } | ||
|
|
||
| window.addEventListener('hashchange', hashChangeHandler) | ||
|
|
||
| return () => { | ||
| window.removeEventListener('hashchange', hashChangeHandler) | ||
| } | ||
| }, [locale]) | ||
|
|
||
| return ( | ||
| <MainContext.Provider value={mainContext}> | ||
| <AutomatedPageContext.Provider value={automatedPageContext}> | ||
| <AutomatedPage>{content}</AutomatedPage> | ||
| </AutomatedPageContext.Provider> | ||
| </MainContext.Provider> | ||
| ) | ||
| } | ||
|
|
||
| export const getServerSideProps: GetServerSideProps<Props> = async (context) => { | ||
| const { getInitialPageWebhooks } = await import('src/webhooks/lib') | ||
| const { getAutomatedPageMiniTocItems } = await import('lib/get-mini-toc-items') | ||
|
|
||
| const req = context.req as object | ||
| const res = context.res as object | ||
| const currentVersion = context.query.versionId as string | ||
| const mainContext = await getMainContext(req, res) | ||
| const { miniTocItems } = getAutomatedPageContextFromRequest(req) | ||
|
|
||
| // Get data for initial webhooks page (i.e. only 1 action type per webhook and | ||
| // no nested parameters) | ||
| const webhooks = (await getInitialPageWebhooks(currentVersion)) as WebhookAction[] | ||
|
|
||
| // Build the minitocs for the webhooks page which is based on the webhook | ||
| // categories in addition to the Markdown in the webhook-events-and-payloads.md | ||
| // content file | ||
| const webhooksMiniTocs = await getAutomatedPageMiniTocItems( | ||
| webhooks.map((webhook) => webhook.data.category), | ||
| context | ||
| ) | ||
| webhooksMiniTocs && miniTocItems.push(...webhooksMiniTocs) | ||
|
|
||
| return { | ||
| props: { | ||
| webhooks, | ||
| mainContext, | ||
| automatedPageContext: getAutomatedPageContextFromRequest(req), | ||
| }, | ||
| } | ||
| } |