All files / publisher/pages/Builds RepoSelector.tsx

80.29% Statements 110/137
75.38% Branches 49/65
82.35% Functions 14/17
80% Lines 108/135

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420                                                              2x       7x                 3x       3x 3x 3x                               3x 3x   3x       56x 56x 56x 56x 56x 56x 56x 56x 56x 56x 56x 56x 56x 56x   56x     56x   56x 7x       7x   7x   7x 7x       6x         6x   6x 4x 4x 4x   2x   2x       2x 2x 2x     1x   7x         56x 55x   55x           14x 10x 6x 6x 6x     10x       56x 10x   10x   10x 2x     10x 10x   10x       10x 10x         10x       56x 56x 56x 56x                   56x 56x 5x     51x 3x     48x     56x 10x   10x 10x 10x 10x 10x 10x 10x 10x   10x 10x   10x 8x   2x     10x           56x 17x 17x   17x 17x 17x   17x 1x 1x 1x 1x     33x   16x   16x 1x       56x                                                         56x                                                                                           81x                                                                                                                                                                          
import {
  ChangeEvent,
  Dispatch,
  SetStateAction,
  useState,
  useEffect,
  useRef,
} from "react";
import { useParams } from "react-router-dom";
import { useSetAtom } from "jotai";
import {
  Strip,
  Row,
  Col,
  Select,
  Button,
  Input,
} from "@canonical/react-components";
 
import { buildRepoConnectedState } from "../../state/buildsState";
 
import type { GithubData } from "../../types/";
 
type Repo = { name: string; nameWithOwner: string };
 
type Props = {
  githubData: GithubData;
  setAutoTriggerBuild: Dispatch<SetStateAction<boolean>>;
};
 
// Utility function for formatting repository names with owner
const getRepoNameWithOwner = (
  selectedOrg: string | null,
  repo: Repo,
): string => {
  return selectedOrg ? `${selectedOrg}/${repo.name}` : repo.nameWithOwner;
};
 
function generateYamlTemplateUrl(
  org: string | null,
  repo: string | undefined,
  branch: string | null,
  snapId: string,
) {
  Iif (!org || !repo) {
    return;
  }
 
  const url = `https://github.com/${org}/${repo}/new/${branch}`;
  const searchParams = new URLSearchParams();
  const templateContent = `# After registering a name on snapcraft.io, commit an uncommented line:
# name: ${snapId}
version: '0.1' # just for humans, typically '1.2+git' or '1.3.2'
summary: Single-line elevator pitch for your amazing snap # 79 char long summary
description: |
  This is my-snap's description. You have a paragraph or two to tell the
  most important story about your snap. Keep it under 100 words though,
  your description wants to look good in the snap
  store.
grade: devel # must be 'stable' to release into candidate/stable channels
confinement: devmode # use 'strict' once you have the right plugs and slots
parts:
  my-part:
    # See 'snapcraft plugins'
    plugin: nil`;
 
  searchParams.set("filename", "snap/snapcraft.yaml");
  searchParams.set("value", templateContent);
 
  return `${url}?${searchParams.toString()}`;
}
 
function RepoSelector({ githubData, setAutoTriggerBuild }: Props) {
  const { snapId } = useParams();
  const [selectedOrg, setSelectedOrg] = useState<string | null>(null);
  const [selectedRepo, setSelectedRepo] = useState<Repo | undefined>();
  const [building, setBuilding] = useState<boolean>(false);
  const setRepoConnected = useSetAtom(buildRepoConnectedState);
  const [validating, setValidating] = useState<boolean>(false);
  const [validationMessage, setValidationMessage] = useState<string>("");
  const [repos, setRepos] = useState<Repo[]>([]);
  const [reposLoading, setReposLoading] = useState<boolean>(false);
  const [validRepo, setValidRepo] = useState<boolean | null>(null);
  const [validationError, setValidationError] = useState<boolean>(false);
  const [repoInputValue, setRepoInputValue] = useState<string>("");
  const [repoFetchError, setRepoFetchError] = useState<string>("");
  const [repoConnectError, setRepoConnectError] = useState<string>("");
 
  const [defaultBranch, setDefaultBranch] = useState<string | null>(null);
 
  // Track autofill attempts to avoid unnecessary re-runs
  const autofillAttemptedRef = useRef<string | null>(null);
 
  const validateRepo = async (repo: Repo | undefined) => {
    Iif (!repo) {
      return;
    }
 
    setValidating(true);
 
    const repoName = getRepoNameWithOwner(selectedOrg, repo);
 
    try {
      const response = await fetch(
        `/api/${snapId}/builds/validate-repo?repo=${repoName}`,
      );
 
      Iif (!response.ok) {
        setValidationError(true);
        throw new Error("Not a valid repo");
      }
 
      const responseData = await response.json();
 
      if (responseData.success) {
        setValidRepo(true);
        setValidationMessage("");
        setValidationError(false);
      } else {
        const error = responseData.error;
 
        Iif (error.type === "MISSING_YAML_FILE") {
          setDefaultBranch(responseData.data.default_branch);
        }
 
        setValidationMessage(responseData.error.message);
        setValidationError(true);
        setValidRepo(null);
      }
    } catch {
      setValidationError(true);
    } finally {
      setValidating(false);
    }
  };
 
  // Autofill effect with proper dependencies
  useEffect(() => {
    const currentOrgKey = `${selectedOrg || "user"}-${snapId}`;
 
    if (
      repos.length > 0 &&
      snapId &&
      !repoInputValue &&
      autofillAttemptedRef.current !== currentOrgKey
    ) {
      const matchingRepo = repos.find((repo: Repo) => repo.name === snapId);
      if (matchingRepo) {
        setRepoInputValue(matchingRepo.name);
        setSelectedRepo(matchingRepo);
        validateRepo(matchingRepo);
      }
      // Mark autofill as attempted for this org/snap combination
      autofillAttemptedRef.current = currentOrgKey;
    }
  }, [repos, snapId, repoInputValue, selectedOrg]);
 
  const getRepos = async (org?: string) => {
    setReposLoading(true);
 
    let apiUrl = "/publisher/github/get-repos";
 
    if (org) {
      apiUrl += `?org=${org}`;
    }
 
    try {
      const response = await fetch(apiUrl);
 
      Iif (!response.ok) {
        throw Error("Unable to fetch repos");
      }
 
      const responseData = await response.json();
      setRepos(responseData);
    } catch (_error) {
      setRepoFetchError("Failed to fetch repositories. Please try again.");
      setRepos([]);
    } finally {
      setReposLoading(false);
    }
  };
 
  const getOrgs = (): { label: string; value: string }[] => {
    Eif (githubData) {
      return githubData.github_orgs.map((org) => {
        return {
          label: org.name,
          value: org.login,
        };
      });
    }
 
    return [];
  };
 
  const getValidationStatusClassName = (): string => {
    if (validRepo) {
      return "is-success";
    }
 
    if (validationError) {
      return "is-error";
    }
 
    return "";
  };
 
  const handleOrganizationChange = (e: ChangeEvent) => {
    const target = e.target as HTMLInputElement;
 
    setRepoInputValue("");
    setSelectedRepo(undefined);
    setValidRepo(null);
    setValidationError(false);
    setRepoFetchError("");
    setRepoConnectError("");
    setRepos([]);
    autofillAttemptedRef.current = null;
 
    if (target.value) {
      const org = target.value;
 
      if (org === githubData.github_user.login) {
        getRepos();
      } else {
        getRepos(org);
      }
 
      setSelectedOrg(org);
    } else E{
      setSelectedOrg(null);
    }
  };
 
  const handleRepoChange = (e: ChangeEvent) => {
    const target = e.target as HTMLInputElement;
    const searchTerm = target.value;
 
    setRepoInputValue(searchTerm);
    setRepoFetchError("");
    setRepoConnectError("");
 
    if (!searchTerm) {
      setValidationError(false);
      setValidRepo(null);
      setSelectedRepo(undefined);
      return;
    }
 
    const selectedRepo = repos.find((repo: Repo) => repo.name === searchTerm);
 
    setSelectedRepo(selectedRepo);
 
    if (selectedRepo) {
      validateRepo(selectedRepo);
    }
  };
 
  const connectRepo = async () => {
    setBuilding(true);
    setRepoConnectError("");
    const formData = new FormData();
    formData.set("csrf_token", window.CSRF_TOKEN);
    if (selectedRepo) {
      const repoName = getRepoNameWithOwner(selectedOrg, selectedRepo);
      formData.set("github_repository", repoName);
    }
 
    try {
      const response = await fetch(`/api/${snapId}/builds`, {
        method: "POST",
        body: formData,
      });
 
      if (response.ok) {
        setAutoTriggerBuild(true);
        setRepoConnected(true);
      } else {
        setRepoConnectError("Failed to connect repository. Please try again.");
      }
    } catch (_error) {
      setRepoConnectError("Failed to connect repository. Please try again.");
    } finally {
      setBuilding(false);
    }
  };
 
  return (
    <Strip shallow>
      <p>
        Your repo needs a snapcraft.yaml file, so that Snapcraft can make it
        buildable, installable, and runnable.
      </p>
      <Row>
        <Col size={4}>
          <Select
            label="Select an organization"
            defaultValue=""
            options={[
              { label: "Select organization", value: "" },
              {
                label:
                  githubData?.github_user.name || githubData?.github_user.login,
                value: githubData?.github_user.login,
              },
              ...getOrgs(),
            ]}
            onChange={handleOrganizationChange}
          />
        </Col>
        <Col
          size={6}
          className={`p-form-validation ${getValidationStatusClassName()}`}
          style={{ position: "relative" }}
        >
          <Input
            type="text"
            label="Select a repository"
            list="repo-list"
            placeholder="Search your repos"
            disabled={selectedOrg === null || validating}
            className="p-form-validation__input"
            value={repoInputValue}
            onChange={handleRepoChange}
          />
          {reposLoading ||
            (validating && (
              <span className="p-icon-container">
                <i className="p-icon--spinner u-animation--spin" />
              </span>
            ))}
          <datalist id="repo-list">
            {repos.map((repo: Repo) => (
              <option value={repo.name} key={repo.name} />
            ))}
          </datalist>
          {repoFetchError && (
            <p className="p-form-validation__message" role="alert">
              {repoFetchError}
            </p>
          )}
        </Col>
        <Col size={2}>
          <div style={{ display: "flex", alignItems: "end", height: "100%" }}>
            {validRepo === true && (
              <Button
                appearance="positive"
                disabled={building}
                onClick={() => {
                  connectRepo();
                }}
              >
                Start building
              </Button>
            )}
            {validationError && (
              <Button
                className="p-tooltip--btm-center"
                aria-describedby="recheck-tooltip"
                onClick={() => {
                  validateRepo(selectedRepo);
                }}
              >
                <i className="p-icon--restart"></i>
                <span
                  className="p-tooltip__message"
                  role="tooltip"
                  id="recheck-tooltip"
                >
                  Check again
                </span>
              </Button>
            )}
          </div>
        </Col>
      </Row>
      {validationError && (
        <div className="u-fixed-width">
          <p>{validationMessage}</p>
          <p>
            <a href="/docs/creating-a-snap">Learn the basics</a>, or{" "}
            <a
              target="_blank"
              rel="noreferrer"
              href={generateYamlTemplateUrl(
                selectedOrg,
                selectedRepo?.name,
                defaultBranch,
                snapId || "",
              )}
            >
              get started with a template
            </a>
            .
          </p>
          <p>
            Don't have snapcraft?{" "}
            <a href="/docs/snapcraft-overview">
              Install it on your own PC for testing
            </a>
            .
          </p>
        </div>
      )}
      {repoConnectError && (
        <Row>
          <Col size={12}>
            <p className="p-form-validation__message" role="alert">
              {repoConnectError}
            </p>
          </Col>
        </Row>
      )}
    </Strip>
  );
}
 
export default RepoSelector;