Add support for service variables to Railway integration, add docs for Railway

This commit is contained in:
Tuan Dang
2023-04-09 15:00:40 +03:00
parent f6e23127ac
commit 710364e3a1
35 changed files with 307 additions and 16 deletions
@@ -45,6 +45,7 @@ type Props = {
handleDeleteIntegration: (args: { integration: Integration }) => void;
};
// TODO: refactor
const IntegrationTile = ({
integration,
integrations,
@@ -55,7 +56,6 @@ const IntegrationTile = ({
handleDeleteIntegration
}: Props) => {
// set initial environment. This find will only execute when component is mounting
const [integrationEnvironment, setIntegrationEnvironment] = useState<Props['environments'][0]>(
environments.find(({ slug }) => slug === integration?.environment) || {
name: '',
@@ -176,6 +176,21 @@ const IntegrationTile = ({
/>
</div>
);
case 'railway':
return (
<div>
<div className="mb-2 text-xs font-semibold text-gray-400">ENVIRONMENT</div>
<ListBox
data={
!integration.isActive
? ['Production', 'Deploy previews', 'Branch deploys', 'Local development']
: null
}
isSelected={integration.targetEnvironment}
onChange={setIntegrationTargetEnvironment}
/>
</div>
);
default:
return <div />;
}
@@ -1,7 +1,7 @@
export {
useGetIntegrationAuthApps,
useGetIntegrationAuthById,
useGetIntegrationAuthRailwayEnvironments,
useGetIntegrationAuthRailwayServices,
useGetIntegrationAuthTeams,
useGetIntegrationAuthVercelBranches,
useGetRailwayEnvironments
} from './queries';
useGetIntegrationAuthVercelBranches} from './queries';
@@ -6,6 +6,7 @@ import {
App,
Environment,
IntegrationAuth,
Service,
Team
} from './types';
@@ -27,6 +28,13 @@ const integrationAuthKeys = {
integrationAuthId: string;
appId: string;
}) => [{ integrationAuthId, appId }, 'integrationAuthRailwayEnvironments'] as const,
getIntegrationAuthRailwayServices: ({
integrationAuthId,
appId
}: {
integrationAuthId: string;
appId: string;
}) => [{ integrationAuthId, appId }, 'integrationAuthRailwayServices'] as const
}
const fetchIntegrationAuthById = async (integrationAuthId: string) => {
@@ -86,6 +94,22 @@ const fetchIntegrationAuthRailwayEnvironments = async ({
return environments;
}
const fetchIntegrationAuthRailwayServices = async ({
integrationAuthId,
appId
}: {
integrationAuthId: string;
appId: string;
}) => {
const { data: { services } } = await apiRequest.get<{ services: Service[] }>(`/api/v1/integration-auth/${integrationAuthId}/railway/services`, {
params: {
appId
}
});
return services;
}
export const useGetIntegrationAuthById = (integrationAuthId: string) => {
return useQuery({
queryKey: integrationAuthKeys.getIntegrationAuthById(integrationAuthId),
@@ -139,7 +163,7 @@ export const useGetIntegrationAuthVercelBranches = ({
});
}
export const useGetRailwayEnvironments = ({
export const useGetIntegrationAuthRailwayEnvironments = ({
integrationAuthId,
appId
}: {
@@ -158,3 +182,23 @@ export const useGetRailwayEnvironments = ({
enabled: true
});
}
export const useGetIntegrationAuthRailwayServices = ({
integrationAuthId,
appId
}: {
integrationAuthId: string;
appId: string;
}) => {
return useQuery({
queryKey: integrationAuthKeys.getIntegrationAuthRailwayServices({
integrationAuthId,
appId,
}),
queryFn: () => fetchIntegrationAuthRailwayServices({
integrationAuthId,
appId,
}),
enabled: true
});
}
@@ -20,4 +20,9 @@ export type Team = {
export type Environment = {
name: string;
environmentId: string;
}
export type Service = {
name: string;
serviceId: string;
}
@@ -8,6 +8,8 @@ interface Props {
sourceEnvironment: string;
targetEnvironment: string | null;
targetEnvironmentId: string | null;
targetService: string | null;
targetServiceId: string | null;
owner: string | null;
path: string | null;
region: string | null;
@@ -26,6 +28,8 @@ const createIntegration = ({
sourceEnvironment,
targetEnvironment,
targetEnvironmentId,
targetService,
targetServiceId,
owner,
path,
region
@@ -43,6 +47,8 @@ const createIntegration = ({
sourceEnvironment,
targetEnvironment,
targetEnvironmentId,
targetService,
targetServiceId,
owner,
path,
region
@@ -99,6 +99,8 @@ export default function AWSParameterStoreCreateIntegrationPage() {
sourceEnvironment: selectedSourceEnvironment,
targetEnvironment: null,
targetEnvironmentId: null,
targetService: null,
targetServiceId: null,
owner: null,
path,
region: selectedAWSRegion
@@ -98,6 +98,8 @@ export default function AWSSecretManagerCreateIntegrationPage() {
sourceEnvironment: selectedSourceEnvironment,
targetEnvironment: null,
targetEnvironmentId: null,
targetService: null,
targetServiceId: null,
owner: null,
path: null,
region: selectedAWSRegion
@@ -63,6 +63,8 @@ export default function AzureKeyVaultCreateIntegrationPage() {
sourceEnvironment: selectedSourceEnvironment,
targetEnvironment: null,
targetEnvironmentId: null,
targetService: null,
targetServiceId: null,
owner: null,
path: null,
region: null
@@ -61,6 +61,8 @@ export default function CircleCICreateIntegrationPage() {
sourceEnvironment: selectedSourceEnvironment,
targetEnvironment: null,
targetEnvironmentId: null,
targetService: null,
targetServiceId: null,
owner: null,
path: null,
region: null,
@@ -62,6 +62,8 @@ export default function FlyioCreateIntegrationPage() {
sourceEnvironment: selectedSourceEnvironment,
targetEnvironment: null,
targetEnvironmentId: null,
targetService: null,
targetServiceId: null,
owner: null,
path: null,
region: null
@@ -65,6 +65,8 @@ export default function GitHubCreateIntegrationPage() {
sourceEnvironment: selectedSourceEnvironment,
targetEnvironment: null,
targetEnvironmentId: null,
targetService: null,
targetServiceId: null,
owner: targetApp.owner,
path: null,
region: null
@@ -90,6 +90,8 @@ export default function GitLabCreateIntegrationPage() {
sourceEnvironment: selectedSourceEnvironment,
targetEnvironment: null,
targetEnvironmentId: null,
targetService: null,
targetServiceId: null,
owner: null,
path: null,
region: null
@@ -61,6 +61,8 @@ export default function HerokuCreateIntegrationPage() {
sourceEnvironment: selectedSourceEnvironment,
targetEnvironment: null,
targetEnvironmentId: null,
targetService: null,
targetServiceId: null,
owner: null,
path: null,
region: null
@@ -70,6 +70,8 @@ export default function NetlifyCreateIntegrationPage() {
sourceEnvironment: selectedSourceEnvironment,
targetEnvironment,
targetEnvironmentId: null,
targetService: null,
targetServiceId: null,
owner: null,
path: null,
region: null
@@ -14,7 +14,8 @@ import {
import {
useGetIntegrationAuthApps,
useGetIntegrationAuthById,
useGetRailwayEnvironments
useGetIntegrationAuthRailwayEnvironments,
useGetIntegrationAuthRailwayServices
} from '../../../hooks/api/integrationAuth';
import { useGetWorkspaceById } from '../../../hooks/api/workspace';
import createIntegration from "../../api/integrations/createIntegration";
@@ -24,6 +25,8 @@ export default function RailwayCreateIntegrationPage() {
const [targetAppId, setTargetAppId] = useState('');
const [targetEnvironmentId, setTargetEnvironmentId] = useState('');
const [targetServiceId, setTargetServiceId] = useState('');
const [selectedSourceEnvironment, setSelectedSourceEnvironment] = useState('');
const [isLoading, setIsLoading] = useState(false);
@@ -33,8 +36,11 @@ export default function RailwayCreateIntegrationPage() {
const { data: integrationAuthApps } = useGetIntegrationAuthApps({
integrationAuthId: integrationAuthId as string ?? ''
});
const { data: targetEnvironments } = useGetRailwayEnvironments({
const { data: targetEnvironments } = useGetIntegrationAuthRailwayEnvironments({
integrationAuthId: integrationAuthId as string ?? '',
appId: targetAppId
});
const { data: targetServices } = useGetIntegrationAuthRailwayServices({
integrationAuthId: integrationAuthId as string ?? '',
appId: targetAppId
});
@@ -64,6 +70,12 @@ export default function RailwayCreateIntegrationPage() {
}
}
}, [targetEnvironments]);
const filteredServices = targetServices
?.concat({
name: '',
serviceId: ''
});
const handleButtonClick = async () => {
try {
@@ -75,6 +87,8 @@ export default function RailwayCreateIntegrationPage() {
const targetEnvironment = targetEnvironments?.find((environment) => environment.environmentId === targetEnvironmentId);
if (!targetApp || !targetApp.appId || !targetEnvironment) return;
const targetService = targetServices?.find((service) => service.serviceId === targetServiceId);
await createIntegration({
integrationAuthId: integrationAuth?._id,
@@ -84,6 +98,8 @@ export default function RailwayCreateIntegrationPage() {
sourceEnvironment: selectedSourceEnvironment,
targetEnvironment: targetEnvironment.name,
targetEnvironmentId: targetEnvironment.environmentId,
targetService: targetService ? targetService.name : null,
targetServiceId: targetService ? targetService.serviceId : null,
owner: null,
path: null,
region: null
@@ -99,7 +115,7 @@ export default function RailwayCreateIntegrationPage() {
}
}
return workspace && selectedSourceEnvironment && integrationAuthApps && targetEnvironments ? (
return workspace && selectedSourceEnvironment && integrationAuthApps && targetEnvironments && filteredServices ? (
<div className="h-full w-full flex justify-center items-center">
<Card className="max-w-md p-8 rounded-md">
<CardTitle className="text-center">Railway Integration</CardTitle>
@@ -158,6 +174,19 @@ export default function RailwayCreateIntegrationPage() {
)}
</Select>
</FormControl>
<FormControl label="Railway Service (Optional)">
<Select
value={targetServiceId}
onValueChange={(val) => setTargetServiceId(val)}
className='w-full border border-mineshaft-500'
>
{filteredServices.map((targetService) => (
<SelectItem value={targetService.serviceId as string} key={`target-service-${targetService.serviceId as string}`}>
{targetService.name}
</SelectItem>
))}
</Select>
</FormControl>
<Button
onClick={handleButtonClick}
color="mineshaft"
@@ -61,6 +61,8 @@ export default function RenderCreateIntegrationPage() {
sourceEnvironment: selectedSourceEnvironment,
targetEnvironment: null,
targetEnvironmentId: null,
targetService: null,
targetServiceId: null,
owner: null,
path: null,
region: null
@@ -61,6 +61,8 @@ export default function TravisCICreateIntegrationPage() {
sourceEnvironment: selectedSourceEnvironment,
targetEnvironment: null,
targetEnvironmentId: null,
targetService: null,
targetServiceId: null,
owner: null,
path: null,
region: null,
@@ -88,6 +88,8 @@ export default function VercelCreateIntegrationPage() {
sourceEnvironment: selectedSourceEnvironment,
targetEnvironment,
targetEnvironmentId: null,
targetService: null,
targetServiceId: null,
owner: null,
path,
region: null