@hero-design/snowflake-guard 1.4.9 → 1.4.11

package/lib/src/graphql/__tests__/queryGenerators.spec.js

@@ -1,82 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const queryGenerators_1 = require("../queryGenerators");
-const replaceWhiteSpace = (str) => str.replace(/\s/g, '');
-describe('generateFetchReportQuery', () => {
-    it('returns correct query', () => {
-        const query = (0, queryGenerators_1.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 = (0, queryGenerators_1.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 = (0, queryGenerators_1.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/lib/src/graphql/fetchGraphql.d.ts

@@ -1,2 +0,0 @@
-declare const fetchGraphql: (query: string) => Promise<any>;
-export default fetchGraphql;

package/lib/src/graphql/fetchGraphql.js

@@ -1,23 +0,0 @@
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const fetchGraphql = (query) => __awaiter(void 0, void 0, void 0, function* () {
-    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());
-});
-exports.default = fetchGraphql;

package/lib/src/graphql/queryGenerators.d.ts

@@ -1,18 +0,0 @@
-declare const generateFetchReportQuery: ({ repoName, prNumber, }: {
-    repoName: string;
-    prNumber: number;
-}) => string;
-declare const generateCreateReportQuery: ({ repoName, prNumber, owner, originalCount, latestCount, approvedCount, }: {
-    repoName: string;
-    prNumber: number;
-    owner: string;
-    originalCount: number;
-    latestCount: number;
-    approvedCount: number;
-}) => string;
-declare const generateUpdateReportQuery: ({ id, latestCount, approvedCount, }: {
-    id: string;
-    latestCount: number;
-    approvedCount: number;
-}) => string;
-export { generateFetchReportQuery, generateCreateReportQuery, generateUpdateReportQuery, };

package/lib/src/graphql/queryGenerators.js

@@ -1,61 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.generateUpdateReportQuery = exports.generateCreateReportQuery = exports.generateFetchReportQuery = void 0;
-const generateFetchReportQuery = ({ repoName, prNumber, }) => {
-    return `
-    query {
-      fetchHdSnowflakeGuardReport(repoName: "${repoName}", prNumber: ${prNumber}) {
-        id
-        originalCount
-        latestCount
-        approvedCount
-      }
-    }
-  `;
-};
-exports.generateFetchReportQuery = generateFetchReportQuery;
-const generateCreateReportQuery = ({ repoName, prNumber, owner, originalCount, latestCount, approvedCount, }) => {
-    return `
-    mutation {
-      createHdSnowflakeGuardReport(
-        input: {
-          params: {
-              repoName: "${repoName}"
-              prNumber: ${prNumber}
-              owner: "${owner}"
-              originalCount: ${originalCount}
-              latestCount: ${latestCount}
-              approvedCount: ${approvedCount}
-          }
-        }
-      ) {
-        hdSnowflakeGuardReport {
-          id
-          repoName
-          prNumber
-          originalCount
-          latestCount
-          approvedCount
-        }
-      }
-    }
-  `;
-};
-exports.generateCreateReportQuery = generateCreateReportQuery;
-const generateUpdateReportQuery = ({ id, latestCount, approvedCount, }) => {
-    return `
-    mutation {
-      updateHdSnowflakeGuardReport(
-        input: { id: "${id}", latestCount: ${latestCount}, approvedCount: ${approvedCount} }
-      ) {
-        hdSnowflakeGuardReport {
-          id
-          latestCount
-          originalCount
-          approvedCount
-        }
-      }
-    }
-  `;
-};
-exports.generateUpdateReportQuery = generateUpdateReportQuery;

package/lib/src/graphql/types.d.ts

@@ -1,18 +0,0 @@
-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'>;
-    };
-};
-export {};

package/lib/src/graphql/types.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/lib/src/index.d.ts

@@ -1,3 +0,0 @@
-import type { Probot } from 'probot';
-declare const _default: (app: Probot) => void;
-export = _default;

package/lib/src/index.js

@@ -1,175 +0,0 @@
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-const parseMobileSource_1 = __importDefault(require("./parseMobileSource"));
-const parseSource_1 = __importDefault(require("./parseSource"));
-const constants_1 = require("./reports/constants");
-const fetchGraphql_1 = __importDefault(require("./graphql/fetchGraphql"));
-const queryGenerators_1 = require("./graphql/queryGenerators");
-const getDiffLocs_1 = require("./utils/getDiffLocs");
-const WEB_REGEX = /\.tsx$/;
-const MOBILE_REGEX = /\.(tsx|jsx|js)$/;
-const TEST_REGEX = /__tests__/;
-const SNOWFLAKE_COMMENTS_WEB = {
-    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 \`${constants_1.APPROVED_CLASSNAME_COMMENT}\`.`,
-};
-const SNOWFLAKE_COMMENTS_MOBILE = {
-    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?gid=1761479144#gid=1761479144).',
-    'styled-component': 'Please do not use styled-component to customize this component.',
-};
-const MOBILE_REPO_NAMES = JSON.parse(process.env.MOBILE_REPO_NAMES || '[]');
-const APPROVED_USER_LIST = JSON.parse(process.env.APPROVED_USER_LIST || '[]');
-const checkIfDetectedSnowflakesInDiff = (diffLocs, locToComment) => {
-    const locIdx = diffLocs.findIndex(([start, end]) => {
-        return locToComment >= start && locToComment <= end;
-    });
-    return locIdx !== -1;
-};
-module.exports = (app) => {
-    app.on(['pull_request.opened', 'pull_request.synchronize'], (context) => __awaiter(void 0, void 0, void 0, function* () {
-        var _a;
-        // 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 = yield context.octokit.pulls.listFiles(Object.assign(Object.assign({}, repoInfo), { pull_number: prNumber }));
-        const isMobile = MOBILE_REPO_NAMES.includes(repoInfo.repo);
-        const parseSource = isMobile ? parseMobileSource_1.default : parseSource_1.default;
-        const SOURCE_REGEX = isMobile ? MOBILE_REGEX : WEB_REGEX;
-        const sourceFiles = prFiles.data.filter((file) => SOURCE_REGEX.test(file.filename) &&
-            !TEST_REGEX.test(file.filename) &&
-            file.status !== 'removed');
-        // Saving file patches to get diff locations
-        const prFilePatches = sourceFiles.reduce((acc, file) => {
-            acc[file.filename] = file.patch || '';
-            return acc;
-        }, {});
-        // Get file contents
-        const prFileContentPromises = sourceFiles.map((file) => context.octokit.repos.getContent(Object.assign(Object.assign({}, repoInfo), { path: file.filename, ref: prBranch })));
-        const prFileContents = yield Promise.all(prFileContentPromises);
-        const snowflakeComments = [];
-        const approvedSnowflakeLocs = [];
-        prFileContents.forEach((file) => __awaiter(void 0, void 0, void 0, function* () {
-            // eslint-disable-next-line @typescript-eslint/ban-ts-comment
-            // @ts-ignore
-            const filePath = file.data.path;
-            const diffLocs = (0, getDiffLocs_1.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: isMobile
-                            ? SNOWFLAKE_COMMENTS_MOBILE['style']
-                            : SNOWFLAKE_COMMENTS_WEB['style'],
-                        line: loc,
-                    });
-                }
-            });
-            snowflakeReport.styledComponentLocs.forEach((loc) => {
-                if (checkIfDetectedSnowflakesInDiff(diffLocs, loc)) {
-                    snowflakeComments.push({
-                        path: filePath,
-                        body: isMobile
-                            ? SNOWFLAKE_COMMENTS_MOBILE['styled-component']
-                            : SNOWFLAKE_COMMENTS_WEB['styled-component'],
-                        line: loc,
-                    });
-                }
-            });
-            snowflakeReport.approvedLocs.forEach((loc) => {
-                if (checkIfDetectedSnowflakesInDiff(diffLocs, loc)) {
-                    approvedSnowflakeLocs.push(loc);
-                }
-            });
-            if (!isMobile) {
-                snowflakeReport.sxLocs.forEach((loc) => {
-                    if (checkIfDetectedSnowflakesInDiff(diffLocs, loc)) {
-                        snowflakeComments.push({
-                            path: filePath,
-                            body: SNOWFLAKE_COMMENTS_WEB['sx'],
-                            line: loc,
-                        });
-                    }
-                });
-                snowflakeReport.classNameLocs.forEach((loc) => {
-                    if (checkIfDetectedSnowflakesInDiff(diffLocs, loc)) {
-                        snowflakeComments.push({
-                            path: filePath,
-                            body: SNOWFLAKE_COMMENTS_WEB['className'],
-                            line: loc,
-                        });
-                    }
-                });
-            }
-        }));
-        // Saving report
-        const snowflakeCount = snowflakeComments.length;
-        const report = (yield (0, fetchGraphql_1.default)((0, queryGenerators_1.generateFetchReportQuery)({ repoName: repoInfo.repo, prNumber })));
-        const reportData = (_a = report.data) === null || _a === void 0 ? void 0 : _a.fetchHdSnowflakeGuardReport;
-        if (reportData) {
-            yield (0, fetchGraphql_1.default)((0, queryGenerators_1.generateUpdateReportQuery)({
-                id: reportData.id,
-                latestCount: snowflakeCount,
-                approvedCount: approvedSnowflakeLocs.length,
-            }));
-        }
-        else {
-            yield (0, fetchGraphql_1.default)((0, queryGenerators_1.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(Object.assign(Object.assign({}, repoInfo), { name: 'SnowflakeGuard/Check', head_sha: context.payload.pull_request.head.sha, status: 'completed', conclusion: 'success' }));
-        }
-        // Snowflakes detected
-        // Create failed check-run & comment
-        yield context.octokit.checks.create(Object.assign(Object.assign({}, repoInfo), { name: 'SnowflakeGuard/Check', head_sha: context.payload.pull_request.head.sha, status: 'completed', conclusion: 'failure' }));
-        return context.octokit.pulls.createReview(Object.assign(Object.assign({}, 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 }));
-    }));
-    app.on('pull_request_review.submitted', (context) => {
-        const submittedType = context.payload.review.state;
-        const submittedUser = context.payload.review.user.login;
-        if (submittedType !== 'approved' ||
-            !APPROVED_USER_LIST.includes(submittedUser)) {
-            return;
-        }
-        return context.octokit.checks.create({
-            repo: context.payload.repository.name,
-            owner: context.payload.repository.owner.login,
-            name: 'SnowflakeGuard/Check',
-            head_sha: context.payload.pull_request.head.sha,
-            status: 'completed',
-            conclusion: 'success',
-        });
-    });
-};

package/lib/src/parseMobileSource.d.ts

@@ -1,15 +0,0 @@
-import type { InlineStyleProps } from './reports/mobile/reportInlineStyle';
-import type { CompoundMobileComponentName } from './reports/mobile/types';
-declare const parseMobileSource: (source: string) => {
-    styleLocs: number[];
-    styledComponentLocs: number[];
-    approvedLocs: number[];
-    violatingAttributes: {
-        attributeName: string;
-        attributeValue: string | null;
-        inlineStyleProps: InlineStyleProps;
-        componentName: CompoundMobileComponentName;
-        loc: number | undefined;
-    }[];
-};
-export default parseMobileSource;

package/lib/src/parseMobileSource.js

@@ -1,135 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || (function () {
-    var ownKeys = function(o) {
-        ownKeys = Object.getOwnPropertyNames || function (o) {
-            var ar = [];
-            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
-            return ar;
-        };
-        return ownKeys(o);
-    };
-    return function (mod) {
-        if (mod && mod.__esModule) return mod;
-        var result = {};
-        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
-        __setModuleDefault(result, mod);
-        return result;
-    };
-})();
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const recast = __importStar(require("recast"));
-const flowParser = __importStar(require("./parsers/flow"));
-const tsParser = __importStar(require("./parsers/typescript"));
-const constants_1 = require("./reports/mobile/constants");
-const constants_2 = require("./reports/constants");
-const reportCustomStyleProperties_1 = __importDefault(require("./reports/mobile/reportCustomStyleProperties"));
-const reportStyledComponents_1 = __importDefault(require("./reports/mobile/reportStyledComponents"));
-const parseMobileSource = (source) => {
-    let hasHeroDesignImport = false;
-    let hasStyledComponentsImport = false;
-    const componentList = {};
-    let styledAliasName = 'styled';
-    let styledComponentLocs = [];
-    let styleLocs = [];
-    let violatingAttributes = [];
-    const approvedInlineStyleCmts = [];
-    const approvedStyledComponentLocs = [];
-    const ast = recast.parse(source, {
-        parser: source.includes('@flow') ? flowParser : tsParser,
-    });
-    recast.visit(ast, {
-        visitImportDeclaration(path) {
-            this.traverse(path);
-            const importedFrom = path.value.source.value;
-            // Check if file imports components from '@hero-design/rn'
-            if (importedFrom === '@hero-design/rn') {
-                recast.visit(path.node, {
-                    visitImportSpecifier(importPath) {
-                        this.traverse(importPath);
-                        if (constants_1.HD_MOBILE_COMPONENTS.includes(importPath.value.imported.name)) {
-                            componentList[importPath.value.local.name] =
-                                importPath.value.imported.name;
-                            hasHeroDesignImport = true;
-                        }
-                    },
-                });
-            }
-            // Check if file imports from '@emotion/native'
-            if (importedFrom === '@emotion/native') {
-                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;
-            if (comment
-                .toLowerCase()
-                .includes(constants_2.APPROVED_INLINE_STYLE_COMMENT.toLowerCase())) {
-                approvedInlineStyleCmts.push({
-                    loc: path.value.loc.start.line,
-                    comment,
-                });
-            }
-            if (comment
-                .toLowerCase()
-                .includes(constants_2.APPROVED_STYLED_COMPONENTS_COMMENT.toLowerCase())) {
-                approvedStyledComponentLocs.push(path.value.loc.start.line);
-            }
-        },
-    });
-    const isNotApprovedStyledComponentSnowflakes = (loc) => !approvedStyledComponentLocs.includes(loc - 1);
-    if (hasHeroDesignImport) {
-        // Case 1: Using style and other style config objects to customise components
-        const customPropLocs = (0, reportCustomStyleProperties_1.default)(ast, componentList, {
-            styleCmts: approvedInlineStyleCmts,
-        });
-        styleLocs = [
-            ...new Set([
-                ...customPropLocs.style,
-                ...customPropLocs.barStyle,
-                ...customPropLocs.containerStyle,
-                ...customPropLocs.textStyle,
-            ]),
-        ];
-        // Case 2: Using styled-components to customise components
-        if (hasStyledComponentsImport) {
-            styledComponentLocs = (0, reportStyledComponents_1.default)(ast, componentList, styledAliasName).filter(isNotApprovedStyledComponentSnowflakes);
-        }
-        violatingAttributes = customPropLocs.violatingAttributes;
-    }
-    return {
-        styleLocs,
-        styledComponentLocs,
-        approvedLocs: [
-            ...approvedInlineStyleCmts.map((cmt) => cmt.loc),
-            ...approvedStyledComponentLocs,
-        ],
-        violatingAttributes,
-    };
-};
-exports.default = parseMobileSource;

package/lib/src/parseSource.d.ts

@@ -1,17 +0,0 @@
-import type { CompoundComponentName } from './reports/types';
-import type { InlineStyleProps } from './reports/reportInlineStyle';
-declare const parseSource: (source: string) => {
-    classNameLocs: number[];
-    styleLocs: number[];
-    sxLocs: number[];
-    styledComponentLocs: number[];
-    approvedLocs: number[];
-    violatingAttributes: {
-        attributeName: string;
-        attributeValue: string | null;
-        inlineStyleProps: InlineStyleProps;
-        componentName: CompoundComponentName;
-        loc: number | undefined;
-    }[];
-};
-export default parseSource;