@hero-design/snowflake-guard 1.0.11 → 1.0.12

package/src/graphql/__tests__/queryGenerators.spec.ts

@@ -1,97 +0,0 @@
-import {
-  generateFetchReportQuery,
-  generateCreateReportQuery,
-  generateUpdateReportQuery,
-} from '../queryGenerators';
-
-const replaceWhiteSpace = (str: string) => str.replace(/\s/g, '');
-
-describe('generateFetchReportQuery', () => {
-  it('returns correct query', () => {
-    const query = generateFetchReportQuery({
-      repoName: 'repoName',
-      prNumber: 123,
-    });
-
-    expect(replaceWhiteSpace(query)).toBe(
-      replaceWhiteSpace(`
-        query {
-          fetchHdSnowflakeGuardReport(repoName: "repoName", prNumber: 123) {
-            id
-            originalCount
-            latestCount
-            approvedCount
-          }
-        }
-      `)
-    );
-  });
-});
-
-describe('generateCreateReportQuery', () => {
-  it('returns correct query', () => {
-    const query = generateCreateReportQuery({
-      repoName: 'repoName',
-      prNumber: 123,
-      owner: 'owner',
-      originalCount: 3,
-      latestCount: 1,
-      approvedCount: 2,
-    });
-
-    expect(replaceWhiteSpace(query)).toBe(
-      replaceWhiteSpace(`
-        mutation {
-          createHdSnowflakeGuardReport(
-            input: {
-              params: {
-                  repoName: "repoName"
-                  prNumber: 123
-                  owner: "owner"
-                  originalCount: 3
-                  latestCount: 1
-                  approvedCount: 2
-              }
-            }
-          ) {
-            hdSnowflakeGuardReport {
-              id
-              repoName
-              prNumber
-              originalCount
-              latestCount
-              approvedCount
-            }
-          }
-        }
-      `)
-    );
-  });
-});
-
-describe('generateUpdateReportQuery', () => {
-  it('returns correct query', () => {
-    const query = generateUpdateReportQuery({
-      id: 'id',
-      latestCount: 1,
-      approvedCount: 2,
-    });
-
-    expect(replaceWhiteSpace(query)).toBe(
-      replaceWhiteSpace(`
-        mutation {
-          updateHdSnowflakeGuardReport(
-            input: { id: "id", latestCount: 1, approvedCount: 2 }
-          ) {
-            hdSnowflakeGuardReport {
-              id
-              latestCount
-              originalCount
-              approvedCount
-            }
-          }
-        }
-      `)
-    );
-  });
-});

package/src/graphql/fetchGraphql.ts

@@ -1,13 +0,0 @@
-const fetchGraphql = async (query: string) => {
-  const host = process.env.DB_HOST || 'http://localhost:3000';
-  return fetch(`${host}/graphql`, {
-    method: 'POST',
-    headers: {
-      'Content-Type': 'application/json',
-      'Snowflake-Guard-Auth': process.env.SNOWFLAKE_GUARD_SECRET || '',
-    },
-    body: JSON.stringify({ query }),
-  }).then((response) => response.json());
-};
-
-export default fetchGraphql;

package/src/graphql/queryGenerators.ts

@@ -1,91 +0,0 @@
-const generateFetchReportQuery = ({
-  repoName,
-  prNumber,
-}: {
-  repoName: string;
-  prNumber: number;
-}) => {
-  return `
-    query {
-      fetchHdSnowflakeGuardReport(repoName: "${repoName}", prNumber: ${prNumber}) {
-        id
-        originalCount
-        latestCount
-        approvedCount
-      }
-    }
-  `;
-};
-
-const generateCreateReportQuery = ({
-  repoName,
-  prNumber,
-  owner,
-  originalCount,
-  latestCount,
-  approvedCount,
-}: {
-  repoName: string;
-  prNumber: number;
-  owner: string;
-  originalCount: number;
-  latestCount: number;
-  approvedCount: number;
-}) => {
-  return `
-    mutation {
-      createHdSnowflakeGuardReport(
-        input: {
-          params: {
-              repoName: "${repoName}"
-              prNumber: ${prNumber}
-              owner: "${owner}"
-              originalCount: ${originalCount}
-              latestCount: ${latestCount}
-              approvedCount: ${approvedCount}
-          }
-        }
-      ) {
-        hdSnowflakeGuardReport {
-          id
-          repoName
-          prNumber
-          originalCount
-          latestCount
-          approvedCount
-        }
-      }
-    }
-  `;
-};
-
-const generateUpdateReportQuery = ({
-  id,
-  latestCount,
-  approvedCount,
-}: {
-  id: string;
-  latestCount: number;
-  approvedCount: number;
-}) => {
-  return `
-    mutation {
-      updateHdSnowflakeGuardReport(
-        input: { id: "${id}", latestCount: ${latestCount}, approvedCount: ${approvedCount} }
-      ) {
-        hdSnowflakeGuardReport {
-          id
-          latestCount
-          originalCount
-          approvedCount
-        }
-      }
-    }
-  `;
-};
-
-export {
-  generateFetchReportQuery,
-  generateCreateReportQuery,
-  generateUpdateReportQuery,
-};

package/src/graphql/types.ts

@@ -1,19 +0,0 @@
-export type Report = {
-  id: string;
-  repoName: string;
-  prNumber: number;
-  owner: string;
-  originalCount: number;
-  latestCount: number;
-  approvedCount: number;
-};
-
-export type FetchReportResponse = {
-  errors: { message: string }[];
-  data: null | {
-    fetchHdSnowflakeGuardReport: Pick<
-      Report,
-      'id' | 'originalCount' | 'latestCount' | 'approvedCount'
-    >;
-  };
-};

package/src/index.ts

@@ -1,208 +0,0 @@
-import { Probot } from 'probot';
-import parseSource from './parseSource';
-import { APPROVED_CLASSNAME_COMMENT } from './reports/constants';
-import fetchGraphql from './graphql/fetchGraphql';
-import {
-  generateFetchReportQuery,
-  generateUpdateReportQuery,
-  generateCreateReportQuery,
-} from './graphql/queryGenerators';
-import type { FetchReportResponse } from './graphql/types';
-import { getDiffLocs } from './utils/getDiffLocs';
-import type { DiffLocs } from './utils/getDiffLocs';
-
-type Comment = {
-  path: string;
-  body: string;
-  line: number;
-};
-
-const TSX_REGEX = /\.tsx$/;
-const TEST_REGEX = /__tests__/;
-
-const SNOWFLAKE_COMMENTS = {
-  style:
-    'Snowflake detected! A component is customized using inline styles. Make sure to not use [prohibited CSS properties](https://docs.google.com/spreadsheets/d/1Dj8vqLdFaf-CSaSVoYqyYZIkGqF6OoyP7K4G1_9L62U/edit?usp=sharing).',
-  sx: 'Snowflake detected! A component is customized via sx prop. Make sure to not use [prohibited CSS properties](https://docs.google.com/spreadsheets/d/1Dj8vqLdFaf-CSaSVoYqyYZIkGqF6OoyP7K4G1_9L62U/edit?usp=sharing).',
-  'styled-component':
-    'Please do not use styled-component to customize this component, use sx prop or inline style instead.',
-  className: `Please make sure that this className is not used as a CSS classname for component customization purposes, use sx prop or inline style instead. In case this is none-css classname, please flag it with this comment \`${APPROVED_CLASSNAME_COMMENT}\`.`,
-};
-
-const checkIfDetectedSnowflakesInDiff = (
-  diffLocs: DiffLocs,
-  locToComment: number
-) => {
-  const locIdx = diffLocs.findIndex(([start, end]) => {
-    return locToComment >= start && locToComment <= end;
-  });
-
-  return locIdx !== -1;
-};
-
-export = (app: Probot) => {
-  app.on(
-    ['pull_request.opened', 'pull_request.synchronize'],
-    async (context) => {
-      // Get PR info
-      const prNumber = context.payload.number;
-      const repoInfo = {
-        repo: context.payload.repository.name,
-        owner: context.payload.repository.owner.login,
-      };
-      const prBranch = context.payload.pull_request.head.ref;
-
-      // List all changed files
-      const prFiles = await context.octokit.pulls.listFiles({
-        ...repoInfo,
-        pull_number: prNumber,
-      });
-      const tsxFiles = prFiles.data.filter(
-        (file) =>
-          TSX_REGEX.test(file.filename) &&
-          !TEST_REGEX.test(file.filename) &&
-          file.status !== 'removed'
-      );
-
-      // Saving file patches to get diff locations
-      const prFilePatches = tsxFiles.reduce((acc, file) => {
-        acc[file.filename] = file.patch || '';
-        return acc;
-      }, {} as { [key: string]: string });
-
-      // Get file contents
-      const prFileContentPromises = tsxFiles.map((file) =>
-        context.octokit.repos.getContent({
-          ...repoInfo,
-          path: file.filename,
-          ref: prBranch,
-        })
-      );
-      const prFileContents = await Promise.all(prFileContentPromises);
-
-      const snowflakeComments: Comment[] = [];
-      const approvedSnowflakeLocs: number[] = [];
-
-      prFileContents.forEach(async (file) => {
-        // eslint-disable-next-line @typescript-eslint/ban-ts-comment
-        // @ts-ignore
-        const filePath = file.data.path;
-        const diffLocs = getDiffLocs(prFilePatches[filePath]);
-
-        const stringContent = Buffer.from(
-          // eslint-disable-next-line @typescript-eslint/ban-ts-comment
-          // @ts-ignore
-          file.data.content,
-          'base64'
-        ).toString();
-
-        // Parse file content to check for snowflakes
-        const snowflakeReport = parseSource(stringContent);
-
-        snowflakeReport.styleLocs.forEach((loc) => {
-          if (checkIfDetectedSnowflakesInDiff(diffLocs, loc)) {
-            snowflakeComments.push({
-              path: filePath,
-              body: SNOWFLAKE_COMMENTS['style'],
-              line: loc,
-            });
-          }
-        });
-
-        snowflakeReport.sxLocs.forEach((loc) => {
-          if (checkIfDetectedSnowflakesInDiff(diffLocs, loc)) {
-            snowflakeComments.push({
-              path: filePath,
-              body: SNOWFLAKE_COMMENTS['sx'],
-              line: loc,
-            });
-          }
-        });
-
-        snowflakeReport.styledComponentLocs.forEach((loc) => {
-          if (checkIfDetectedSnowflakesInDiff(diffLocs, loc)) {
-            snowflakeComments.push({
-              path: filePath,
-              body: SNOWFLAKE_COMMENTS['styled-component'],
-              line: loc,
-            });
-          }
-        });
-
-        snowflakeReport.classNameLocs.forEach((loc) => {
-          if (checkIfDetectedSnowflakesInDiff(diffLocs, loc)) {
-            snowflakeComments.push({
-              path: filePath,
-              body: SNOWFLAKE_COMMENTS['className'],
-              line: loc,
-            });
-          }
-        });
-
-        snowflakeReport.approvedLocs.forEach((loc) => {
-          if (checkIfDetectedSnowflakesInDiff(diffLocs, loc)) {
-            approvedSnowflakeLocs.push(loc);
-          }
-        });
-      });
-
-      // Saving report
-      const snowflakeCount = snowflakeComments.length;
-      const report = (await fetchGraphql(
-        generateFetchReportQuery({ repoName: repoInfo.repo, prNumber })
-      )) as FetchReportResponse;
-      const reportData = report.data?.fetchHdSnowflakeGuardReport;
-      if (reportData) {
-        await fetchGraphql(
-          generateUpdateReportQuery({
-            id: reportData.id,
-            latestCount: snowflakeCount,
-            approvedCount: approvedSnowflakeLocs.length,
-          })
-        );
-      } else {
-        await fetchGraphql(
-          generateCreateReportQuery({
-            repoName: repoInfo.repo,
-            prNumber,
-            owner: repoInfo.owner,
-            originalCount: snowflakeCount,
-            latestCount: snowflakeCount,
-            approvedCount: approvedSnowflakeLocs.length,
-          })
-        );
-      }
-
-      // No snowflakes detected
-      // Create success check-run
-      if (snowflakeCount === 0) {
-        return context.octokit.checks.create({
-          ...repoInfo,
-          name: 'SnowflakeGuard/Check',
-          head_sha: context.payload.pull_request.head.sha,
-          status: 'completed',
-          conclusion: 'success',
-        });
-      }
-
-      // Snowflakes detected
-      // Create failed check-run & comment
-      await context.octokit.checks.create({
-        ...repoInfo,
-        name: 'SnowflakeGuard/Check',
-        head_sha: context.payload.pull_request.head.sha,
-        status: 'completed',
-        conclusion: 'failure',
-      });
-
-      return context.octokit.pulls.createReview({
-        ...repoInfo,
-        pull_number: prNumber,
-        commit_id: context.payload.pull_request.head.sha,
-        event: 'COMMENT',
-        body: 'Snowflake Guard Bot has detected some snowflakes in this PR. Please review the following comments.',
-        comments: snowflakeComments,
-      });
-    }
-  );
-};

package/src/parseSource.ts

@@ -1,115 +0,0 @@
-import * as recast from 'recast';
-import * as tsParser from './parsers/typescript';
-import reportCustomProperties from './reports/reportCustomStyleProperties';
-import reportStyledComponents from './reports/reportStyledComponents';
-import {
-  HD_COMPONENTS,
-  APPROVED_COMMENT,
-  APPROVED_CLASSNAME_COMMENT,
-} from './reports/constants';
-import type { ComponentName } from './reports/types';
-
-const parseSource = (source: string) => {
-  let hasHeroDesignImport = false;
-  let hasStyledComponentsImport = false;
-
-  const componentList: { [k: string]: ComponentName } = {};
-  let styledAliasName = 'styled';
-
-  let styledComponentLocs: number[] = [];
-  let classNameLocs: number[] = [];
-  let styleLocs: number[] = [];
-  let sxLocs: number[] = [];
-  const approvedCmtLocs: number[] = [];
-  const approvedClassnameLocs: number[] = [];
-
-  const ast = recast.parse(source, { parser: tsParser });
-
-  recast.visit(ast, {
-    visitImportDeclaration(path) {
-      this.traverse(path);
-
-      const importedFrom = path.value.source.value as string;
-
-      // Check if file imports components from '@hero-design/react'
-      if (importedFrom === '@hero-design/react') {
-        recast.visit(path.node, {
-          visitImportSpecifier(importPath) {
-            this.traverse(importPath);
-
-            if (HD_COMPONENTS.includes(importPath.value.imported.name)) {
-              componentList[importPath.value.local.name] =
-                importPath.value.imported.name;
-              hasHeroDesignImport = true;
-            }
-          },
-        });
-      }
-
-      // Check if file imports from 'styled-components'
-      if (importedFrom === 'styled-components') {
-        recast.visit(path.node, {
-          visitImportDefaultSpecifier(importPath) {
-            this.traverse(importPath);
-
-            styledAliasName = importPath.value.local.name;
-            hasStyledComponentsImport = true;
-          },
-        });
-      }
-    },
-
-    visitComment(path) {
-      this.traverse(path);
-
-      const comment = path.value.value as string;
-      if (comment.toLowerCase().includes(APPROVED_COMMENT.toLowerCase())) {
-        approvedCmtLocs.push(path.value.loc.start.line);
-      }
-
-      if (
-        comment.toLowerCase().includes(APPROVED_CLASSNAME_COMMENT.toLowerCase())
-      ) {
-        approvedClassnameLocs.push(path.value.loc.start.line);
-      }
-    },
-  });
-
-  const isNotApprovedSnowflakes = (loc: number) =>
-    !approvedCmtLocs.includes(loc);
-
-  const isNotApprovedClassnameSnowflakes = (loc: number) =>
-    !approvedClassnameLocs.includes(loc);
-
-  if (hasHeroDesignImport) {
-    // Case 1: Using className to customise components
-    // Case 2: Using style object to customise components
-    // Case 3: Using sx object to customise components
-    const customPropLocs = reportCustomProperties(ast, componentList);
-    classNameLocs = customPropLocs.className.filter(
-      (loc) =>
-        isNotApprovedSnowflakes(loc) && isNotApprovedClassnameSnowflakes(loc)
-    );
-    styleLocs = customPropLocs.style.filter(isNotApprovedSnowflakes);
-    sxLocs = customPropLocs.sx.filter(isNotApprovedSnowflakes);
-
-    // Case 4: Using styled-components to customise components
-    if (hasStyledComponentsImport) {
-      styledComponentLocs = reportStyledComponents(
-        ast,
-        componentList,
-        styledAliasName
-      ).filter(isNotApprovedSnowflakes);
-    }
-  }
-
-  return {
-    classNameLocs,
-    styleLocs,
-    sxLocs,
-    styledComponentLocs,
-    approvedLocs: [...approvedCmtLocs, ...approvedClassnameLocs],
-  };
-};
-
-export default parseSource;

package/src/parsers/typescript.ts

@@ -1,8 +0,0 @@
-import * as babelParser from '@babel/parser';
-import getBabelOptions, { Overrides } from 'recast/parsers/_babel_options';
-
-export const parse = (source: string, options?: Overrides) => {
-  const babelOptions = getBabelOptions(options);
-  babelOptions.plugins.push('jsx', 'typescript');
-  return babelParser.parse(source, babelOptions);
-};