Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

POR-1793 read in default build settings from porter.yaml #3623

Merged
merged 2 commits into from
Sep 21, 2023
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
5 changes: 3 additions & 2 deletions dashboard/src/lib/hooks/usePorterYaml.ts
Original file line number Diff line number Diff line change
Expand Up @@ -121,13 +121,14 @@ export const usePorterYaml = ({
.parseAsync(res.data);
const proto = PorterApp.fromJsonString(atob(data.b64_app_proto));

const { services, predeploy } = serviceOverrides({
const { services, predeploy, build } = serviceOverrides({
overrides: proto,
useDefaults,
});

if (services.length || predeploy) {
if (services.length || predeploy || build) {
setDetectedServices({
build,
services,
predeploy,
});
Expand Down
18 changes: 18 additions & 0 deletions dashboard/src/lib/porter-apps/build.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
import { buildpackSchema } from "main/home/app-dashboard/types/buildpack";
import { z } from "zod";

// buildValidator is used to validate inputs for build setting fields
export const buildValidator = z.discriminatedUnion("method", [
z.object({
method: z.literal("pack"),
context: z.string().min(1).default("./").catch("./"),
buildpacks: z.array(buildpackSchema).default([]),
builder: z.string(),
}),
z.object({
method: z.literal("docker"),
context: z.string().min(1).default("./").catch("./"),
dockerfile: z.string().min(1).default("./Dockerfile").catch("./Dockerfile"),
}),
]);
export type BuildOptions = z.infer<typeof buildValidator>;
39 changes: 17 additions & 22 deletions dashboard/src/lib/porter-apps/index.ts
Original file line number Diff line number Diff line change
@@ -1,13 +1,9 @@
import {
BUILDPACK_TO_NAME,
buildpackSchema,
} from "main/home/app-dashboard/types/buildpack";
import { BUILDPACK_TO_NAME } from "main/home/app-dashboard/types/buildpack";
import { z } from "zod";
import {
DetectedServices,
defaultSerialized,
deserializeService,
isPredeployService,
serializeService,
serializedServiceFromProto,
serviceProto,
Expand All @@ -16,22 +12,7 @@ import {
import { Build, PorterApp, Service } from "@porter-dev/api-contracts";
import { match } from "ts-pattern";
import { KeyValueType } from "main/home/cluster-dashboard/env-groups/EnvGroupArray";

// buildValidator is used to validate inputs for build setting fields
export const buildValidator = z.discriminatedUnion("method", [
z.object({
method: z.literal("pack"),
context: z.string().default("./"),
buildpacks: z.array(buildpackSchema).default([]),
builder: z.string(),
}),
z.object({
method: z.literal("docker"),
context: z.string().default("./"),
dockerfile: z.string().default("./Dockerfile"),
}),
]);
export type BuildOptions = z.infer<typeof buildValidator>;
import { BuildOptions, buildValidator } from "./build";

// sourceValidator is used to validate inputs for source setting fields
export const sourceValidator = z.discriminatedUnion("type", [
Expand Down Expand Up @@ -117,7 +98,10 @@ export function serviceOverrides({
.map((svc) => {
if (useDefaults) {
return deserializeService({
service: defaultSerialized({ name: svc.name, type: svc.config.type }),
service: defaultSerialized({
name: svc.name,
type: svc.config.type,
}),
override: svc,
expanded: true,
});
Expand All @@ -126,6 +110,15 @@ export function serviceOverrides({
return deserializeService({ service: svc });
});

const validatedBuild = buildValidator
.default({
method: "pack",
context: "./",
buildpacks: [],
builder: "",
})
.parse(overrides.build);

if (!overrides.predeploy) {
return {
services,
Expand All @@ -134,6 +127,7 @@ export function serviceOverrides({

if (useDefaults) {
return {
build: validatedBuild,
services,
predeploy: deserializeService({
service: defaultSerialized({
Expand All @@ -151,6 +145,7 @@ export function serviceOverrides({
}

return {
build: validatedBuild,
services,
predeploy: deserializeService({
service: serializedServiceFromProto({
Expand Down
2 changes: 2 additions & 0 deletions dashboard/src/lib/porter-apps/services.ts
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,12 @@ import {
ServiceField,
} from "./values";
import { Service, ServiceType } from "@porter-dev/api-contracts";
import { BuildOptions } from "./build";

export type DetectedServices = {
services: ClientService[];
predeploy?: ClientService;
build?: BuildOptions;
};
type ClientServiceType = "web" | "worker" | "job" | "predeploy";

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -185,7 +185,7 @@ const CreateApp: React.FC<CreateAppProps> = ({ history }) => {
loading: isLoadingPorterYaml,
} = usePorterYaml({
source: source?.type === "github" ? source : null,
appName: name.value,
appName: "", // only want to know if porter.yaml has name set, otherwise use name from input
});
const deploymentTarget = useDefaultDeploymentTarget();
const { updateAppStep } = useAppAnalytics(name.value);
Expand Down Expand Up @@ -426,9 +426,13 @@ const CreateApp: React.FC<CreateAppProps> = ({ history }) => {

useEffect(() => {
if (servicesFromYaml && !detectedServices.detected) {
const { services, predeploy } = servicesFromYaml;
const { services, predeploy, build: detectedBuild } = servicesFromYaml;
setValue("app.services", services);
setValue("app.predeploy", [predeploy].filter(valueExists));

if (detectedBuild) {
setValue("app.build", detectedBuild);
}
setDetectedServices({
detected: true,
count: services.length,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,12 @@ import { ControlledInput } from "components/porter/ControlledInput";
import Select from "components/porter/Select";
import AnimateHeight from "react-animate-height";
import { z } from "zod";
import {
BuildOptions,
PorterAppFormData,
SourceOptions,
} from "lib/porter-apps";
import { PorterAppFormData, SourceOptions } from "lib/porter-apps";
import RepositorySelector from "../build-settings/RepositorySelector";
import BranchSelector from "../build-settings/BranchSelector";
import BuildpackSettings from "../validate-apply/build-settings/buildpacks/BuildpackSettings";
import { match } from "ts-pattern";
import { BuildOptions } from "lib/porter-apps/build";

type Props = {
projectId: number;
Expand Down Expand Up @@ -85,6 +82,9 @@ const RepoSettings: React.FC<Props> = ({
item.path.includes("Dockerfile")
);
setValue("app.build.method", hasDockerfile ? "docker" : "pack");
if (!hasDockerfile) {
setValue("app.build.buildpacks", []);
}
}, [branchContents]);

return (
Expand Down Expand Up @@ -235,7 +235,7 @@ const RepoSettings: React.FC<Props> = ({
]}
setValue={(option: string) => {
if (option == "docker") {
setValue("app.build.method", "docker");4
setValue("app.build.method", "docker");
} else if (option == "pack") {
// if toggling from docker to pack, initialize buildpacks to empty array
setValue("app.build.method", "pack");
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,8 @@ import Select from "components/porter/Select";
import stars from "assets/stars-white.svg";
import { Buildpack } from "main/home/app-dashboard/types/buildpack";
import { Controller, useFieldArray, useFormContext } from "react-hook-form";
import { BuildOptions, PorterAppFormData } from "lib/porter-apps";
import { PorterAppFormData } from "lib/porter-apps";
import { BuildOptions } from "lib/porter-apps/build";

type Props = {
build: BuildOptions & {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,8 @@ import Error from "components/porter/Error";
import { Droppable, DragDropContext } from "react-beautiful-dnd";
import { Buildpack } from "main/home/app-dashboard/types/buildpack";
import { useFieldArray, useFormContext } from "react-hook-form";
import { BuildOptions, PorterAppFormData } from "lib/porter-apps";
import { PorterAppFormData } from "lib/porter-apps";
import { BuildOptions } from "lib/porter-apps/build";

interface Props {
build: BuildOptions & {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,11 +18,8 @@ import Button from "components/porter/Button";
import BuildpackList from "./BuildpackList";
import BuildpackConfigurationModal from "./BuildpackConfigurationModal";
import { useFieldArray, useFormContext } from "react-hook-form";
import {
BuildOptions,
PorterAppFormData,
SourceOptions,
} from "lib/porter-apps";
import { PorterAppFormData, SourceOptions } from "lib/porter-apps";
import { BuildOptions } from "lib/porter-apps/build";

type Props = {
projectId: number;
Expand Down
3 changes: 0 additions & 3 deletions internal/porter_app/v1/yaml.go
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,6 @@ func AppProtoFromYaml(ctx context.Context, porterYamlBytes []byte, appName strin
ctx, span := telemetry.NewSpan(ctx, "v1-app-proto-from-yaml")
defer span.End()

if appName == "" {
return nil, nil, telemetry.Error(ctx, span, nil, "app name is empty")
}
telemetry.WithAttributes(span, telemetry.AttributeKV{Key: "app-name", Value: appName})

if porterYamlBytes == nil {
Expand Down
3 changes: 0 additions & 3 deletions internal/porter_app/v2/yaml.go
Original file line number Diff line number Diff line change
Expand Up @@ -39,9 +39,6 @@ func AppProtoFromYaml(ctx context.Context, porterYamlBytes []byte, appName strin
Name: porterYaml.Name,
}

if appProto.Name == "" {
return nil, nil, telemetry.Error(ctx, span, nil, "app name is empty")
}

if porterYaml.Build != nil {
appProto.Build = &porterv1.Build{
Expand Down
Loading