@useprint/preview 0.1.1 → 0.1.2

package/src/actions/document-validation/check-compatibility.ts

@@ -1,333 +0,0 @@
-'use server';
-import { parse } from '@babel/parser';
-import traverse from '@babel/traverse';
-import {
-  convertLocationIntoObject,
-  getObjectVariables,
-  type SourceLocation,
-} from '../../utils/canidocument/ast/get-object-variables';
-import type { StylePropertyUsage } from '../../utils/canidocument/ast/get-used-style-properties';
-import {
-  doesPropertyHaveLocation,
-  getUsedStyleProperties,
-} from '../../utils/canidocument/ast/get-used-style-properties';
-import type {
-  CompatibilityStats,
-  SupportStatus,
-} from '../../utils/canidocument/get-compatibility-stats-for-entry';
-import { getCompatibilityStatsForEntry } from '../../utils/canidocument/get-compatibility-stats-for-entry';
-import { getCssFunctions } from '../../utils/canidocument/get-css-functions';
-import { getCssPropertyNames } from '../../utils/canidocument/get-css-property-names';
-import { getCssPropertyWithValue } from '../../utils/canidocument/get-css-property-with-value';
-import { getCssUnit } from '../../utils/canidocument/get-css-unit';
-import { getElementAttributes } from '../../utils/canidocument/get-element-attributes';
-import { getElementNames } from '../../utils/canidocument/get-element-names';
-import { supportEntries } from './canidocument-data';
-
-export interface CompatibilityCheckingResult {
-  location: SourceLocation;
-  source: string;
-  entry: SupportEntry;
-  status: SupportStatus;
-  statsPerDocumentClient: CompatibilityStats['perDocumentClient'];
-}
-
-export type DocumentClient =
-  | 'gmail'
-  | 'outlook'
-  | 'yahoo'
-  | 'apple-mail'
-  | 'aol'
-  | 'thunderbird'
-  | 'microsoft'
-  | 'samsung-document'
-  | 'sfr'
-  | 'orange'
-  | 'protonmail'
-  | 'hey'
-  | 'mail-ru'
-  | 'fastmail'
-  | 'laposte'
-  | 't-online-de'
-  | 'free-fr'
-  | 'gmx'
-  | 'web-de'
-  | 'ionos-1and1'
-  | 'rainloop'
-  | 'wp-pl';
-
-export type Platform =
-  | 'desktop-app'
-  | 'desktop-webmail'
-  | 'mobile-webmail'
-  | 'webmail'
-  | 'ios'
-  | 'android'
-  | 'windows'
-  | 'macos'
-  | 'windows-mail'
-  | 'outlook-com';
-
-export type SupportEntryCategory = 'html' | 'css' | 'image' | 'others';
-
-export interface SupportEntry {
-  slug: string;
-  title: string;
-  description: string | null;
-  url: string;
-  category: SupportEntryCategory;
-  tags: string[];
-  keywords: string | null;
-  last_test_date: string;
-  test_url: string;
-  test_results_url: string | null;
-  stats: Partial<
-    Record<
-      DocumentClient,
-      Partial<
-        Record<
-          Platform,
-          /*
-            This last Record<string, string> has only one key, as the
-            ordered version of canidocument's data is meant to be something like:
-           
-            [
-              { "1.0": "u" },
-              { "2.0": "y" },
-              { "3.0": "p #1" },
-            ]
-           
-            So only one key for each object inside of this array, TypeScript can't really
-            describe this though AFAIK.
-          */
-          Record</* version */ string, string>[]
-        >
-      >
-    >
-  >;
-  notes: string | null;
-  notes_by_num: Record<number, string> | null;
-}
-
-const relevantDocumentClients: DocumentClient[] = [
-  'gmail',
-  'apple-mail',
-  'outlook',
-  'yahoo',
-];
-
-export const checkCompatibility = async (
-  reactCode: string,
-  documentPath: string,
-) => {
-  const ast = parse(reactCode, {
-    strictMode: false,
-    errorRecovery: true,
-    sourceType: 'unambiguous',
-    plugins: ['jsx', 'typescript', 'decorators'],
-  });
-
-  const getSourceCodeAt = (location: SourceLocation) => {
-    const codeLines = reactCode.split(/\n|\r|\r\n/);
-    const source = codeLines
-      .slice(
-        Math.max(location.start.line - 2, 0),
-        Math.min(location.end.line + 2, codeLines.length),
-      )
-      .join('\n');
-    return source;
-  };
-
-  const objectVariables = getObjectVariables(ast);
-  const usedStyleProperties = await getUsedStyleProperties(
-    ast,
-    reactCode,
-    documentPath,
-    objectVariables,
-  );
-  const readableStream = new ReadableStream<CompatibilityCheckingResult>({
-    async start(controller) {
-      for (const entry of supportEntries) {
-        const compatibilityStats = getCompatibilityStatsForEntry(
-          entry,
-          relevantDocumentClients,
-        );
-        if (Object.keys(compatibilityStats.perDocumentClient).length === 0)
-          continue;
-        if (
-          compatibilityStats.status === 'success' ||
-          compatibilityStats.status === 'warning'
-        )
-          continue;
-
-        if (entry.category === 'html') {
-          const entryElements = getElementNames(entry.title, entry.keywords);
-          const entryAttributes = getElementAttributes(entry.title);
-          const htmlEntryType = (() => {
-            if (entryElements.length > 0) {
-              return 'element';
-            }
-
-            if (entryAttributes.length > 0) {
-              return 'attribute';
-            }
-          })();
-
-          if (!htmlEntryType) continue;
-
-          let addedInsight = false;
-          if (htmlEntryType === 'element') {
-            traverse(ast, {
-              JSXOpeningElement(path) {
-                if (path.node.name.type === 'JSXIdentifier' && !addedInsight) {
-                  const elementName = path.node.name.name;
-                  if (
-                    entryElements.includes(elementName) &&
-                    path.node.name.loc
-                  ) {
-                    addedInsight = true;
-                    controller.enqueue({
-                      entry,
-                      source: getSourceCodeAt(path.node.name.loc),
-                      location: convertLocationIntoObject(path.node.name.loc),
-                      statsPerDocumentClient: compatibilityStats.perDocumentClient,
-                      status: compatibilityStats.status,
-                    });
-                  }
-                }
-              },
-            });
-          } else {
-            traverse(ast, {
-              JSXAttribute(path) {
-                if (path.node.name.type === 'JSXIdentifier' && !addedInsight) {
-                  const attributeName = path.node.name.name;
-                  if (
-                    entryAttributes.includes(attributeName) &&
-                    path.node.name.loc
-                  ) {
-                    addedInsight = true;
-                    controller.enqueue({
-                      entry,
-                      source: getSourceCodeAt(path.node.name.loc),
-                      location: convertLocationIntoObject(path.node.name.loc),
-                      statsPerDocumentClient: compatibilityStats.perDocumentClient,
-                      status: compatibilityStats.status,
-                    });
-                  }
-                }
-              },
-            });
-          }
-        }
-
-        if (entry.category === 'css') {
-          const entryFullProperty = getCssPropertyWithValue(entry.title);
-          const entryProperties = getCssPropertyNames(
-            entry.title,
-            entry.keywords,
-          );
-          const entryUnit = getCssUnit(entry.title);
-          const entryFunctions = getCssFunctions(entry.title);
-
-          const cssEntryType = (() => {
-            if (entryFullProperty?.name && entryFullProperty.value) {
-              return 'full property';
-            }
-
-            if (entryFunctions.length > 0) {
-              return 'function';
-            }
-
-            if (entryUnit) {
-              return 'unit';
-            }
-
-            if (entryProperties.length > 0) {
-              return 'property name';
-            }
-          })();
-
-          if (!cssEntryType) continue;
-          const addToInsights = (
-            property: StylePropertyUsage & { location: SourceLocation },
-          ) => {
-            controller.enqueue({
-              entry,
-              location: convertLocationIntoObject(property.location),
-              source: getSourceCodeAt(property.location),
-              statsPerDocumentClient: compatibilityStats.perDocumentClient,
-              status: compatibilityStats.status,
-            });
-          };
-
-          for (const property of usedStyleProperties) {
-            if (!doesPropertyHaveLocation(property)) {
-              throw new Error(
-                "One of the properties' node did not contain the proper location for it on the source code. This must be an issue because we always need access to the source.",
-                {
-                  cause: {
-                    property,
-                    entry,
-                    reactCode,
-                    ast,
-                  },
-                },
-              );
-            }
-
-            if (cssEntryType === 'full property') {
-              if (
-                snakeToCamel(property.name) ===
-                  snakeToCamel(entryFullProperty!.name) &&
-                property.value === entryFullProperty!.value
-              ) {
-                addToInsights(property);
-                break;
-              }
-            } else if (cssEntryType === 'function') {
-              const functionRegex =
-                /(?<functionName>[a-zA-Z_][a-zA-Z0-9_-]*)\s*\(/g;
-              const functionName = functionRegex.exec(property.value)?.groups
-                ?.functionName;
-              if (functionName !== undefined) {
-                if (entryFunctions.includes(functionName)) {
-                  addToInsights(property);
-                  break;
-                }
-              }
-            } else if (cssEntryType === 'unit') {
-              const match = property.value.match(/[0-9](?<unit>[a-zA-Z%]+)$/g);
-              if (match) {
-                const unit = match.groups?.unit;
-                if (entryUnit && unit && entryUnit === unit) {
-                  addToInsights(property);
-                  break;
-                }
-              }
-            } else if (
-              entryProperties.some(
-                (propertyName) =>
-                  snakeToCamel(property.name) === snakeToCamel(propertyName),
-              )
-            ) {
-              addToInsights(property);
-              break;
-            }
-          }
-        }
-      }
-      controller.close();
-    },
-  });
-
-  return readableStream;
-};
-
-const snakeToCamel = (snakeStr: string) => {
-  return snakeStr
-    .toLowerCase()
-    .replace(/-+([a-z])/g, (_match, letter) => letter.toUpperCase());
-};
-
-export type AST = ReturnType<typeof parse>;

package/src/actions/document-validation/check-images.spec.tsx

@@ -1,21 +0,0 @@
-import { checkImages, type ImageCheckingResult } from './check-images';
-
-test('checkImages()', async () => {
-  const results: ImageCheckingResult[] = [];
-  const html = `<div>
-  <img src="https://useprint.com/static/brand/useprint-icon-white.png" />,
-  <img src="/static/codepen-challengers.png" alt="codepen challenges" />,
-</div>`;
-  const stream = await checkImages(html, 'https://demo.useprint.dev');
-  const reader = stream.getReader();
-  while (true) {
-    const { done, value } = await reader.read();
-    if (value) {
-      results.push(value);
-    }
-    if (done) {
-      break;
-    }
-  }
-  expect(results).toMatchSnapshot();
-});

package/src/actions/document-validation/check-images.ts

@@ -1,160 +0,0 @@
-'use server';
-
-import type { IncomingMessage } from 'node:http';
-import { parse } from 'node-html-parser';
-import {
-  type CodeLocation,
-  getCodeLocationFromAstElement,
-} from './get-code-location-from-ast-element';
-import { quickFetch } from './quick-fetch';
-
-export type ImageCheck = { passed: boolean } & (
-  | {
-      type: 'accessibility';
-      metadata: {
-        alt: string | undefined;
-      };
-    }
-  | {
-      type: 'fetch_attempt';
-      metadata: {
-        fetchStatusCode: number | undefined;
-      };
-    }
-  | {
-      type: 'image_size';
-      metadata: {
-        byteCount: number | undefined;
-      };
-    }
-  | {
-      type: 'syntax';
-    }
-  | {
-      type: 'security';
-    }
-);
-
-export interface ImageCheckingResult {
-  status: 'success' | 'warning' | 'error';
-  source: string;
-  codeLocation: CodeLocation;
-  checks: ImageCheck[];
-}
-
-const getResponseSizeInBytes = async (res: IncomingMessage) => {
-  let totalBytes = 0;
-  for await (const chunk of res) {
-    totalBytes += chunk.byteLength;
-  }
-  return totalBytes;
-};
-
-export const checkImages = async (code: string, base: string) => {
-  const ast = parse(code);
-
-  const readableStream = new ReadableStream<ImageCheckingResult>({
-    async start(controller) {
-      const images = ast.querySelectorAll('img');
-      for await (const image of images) {
-        const rawSource = image.attributes.src;
-        if (!rawSource) continue;
-
-        const source = rawSource?.startsWith('/')
-          ? `${base}${rawSource}`
-          : rawSource;
-
-        const result: ImageCheckingResult = {
-          source: rawSource,
-          codeLocation: getCodeLocationFromAstElement(image, code),
-          status: 'success',
-          checks: [],
-        };
-
-        const alt = image.attributes.alt;
-        result.checks.push({
-          passed: alt !== undefined,
-          type: 'accessibility',
-          metadata: {
-            alt,
-          },
-        });
-        if (alt === undefined) {
-          result.status = 'warning';
-        }
-
-        try {
-          const url = new URL(source);
-          result.checks.push({
-            passed: true,
-            type: 'syntax',
-          });
-
-          if (rawSource.startsWith('http://')) {
-            result.checks.push({
-              passed: false,
-              type: 'security',
-            });
-            result.status = 'warning';
-          } else {
-            result.checks.push({
-              passed: true,
-              type: 'security',
-            });
-          }
-
-          let res: IncomingMessage | undefined;
-          try {
-            res = await quickFetch(url);
-            const hasSucceeded =
-              res.statusCode?.toString().startsWith('2') ?? false;
-            result.checks.push({
-              type: 'fetch_attempt',
-              passed: hasSucceeded,
-              metadata: {
-                fetchStatusCode: res.statusCode,
-              },
-            });
-            if (!hasSucceeded) {
-              result.status = res.statusCode?.toString().startsWith('3')
-                ? 'warning'
-                : 'error';
-            }
-
-            const responseSizeBytes = await getResponseSizeInBytes(res);
-            result.checks.push({
-              type: 'image_size',
-              passed: responseSizeBytes < 1_048_576, // 1024 x 1024 bytes
-              metadata: {
-                byteCount: responseSizeBytes,
-              },
-            });
-            if (responseSizeBytes > 1_048_576 && result.status !== 'error') {
-              result.status = 'warning';
-            }
-          } catch (_exception) {
-            result.checks.push({
-              type: 'fetch_attempt',
-              passed: false,
-              metadata: {
-                fetchStatusCode: undefined,
-              },
-            });
-            result.status = 'error';
-          }
-        } catch (_exception) {
-          result.checks.push({
-            passed: false,
-            type: 'syntax',
-          });
-          result.status = 'error';
-        }
-
-        controller.enqueue(result);
-      }
-      controller.close();
-    },
-  });
-
-  return readableStream;
-};

package/src/actions/document-validation/check-links.spec.tsx

@@ -1,113 +0,0 @@
-import { checkLinks, type LinkCheckingResult } from './check-links';
-
-test('checkLinks()', async () => {
-  const results: LinkCheckingResult[] = [];
-  const html = `<div>
-  <a href="/">Root</a>
-  <a href="https://useprint.com">UsePrint</a>
-  <a href="https://notion.so">Notion</a>
-  <a href="http://useprint.dev">UsePrint unsafe</a>
-</div>`;
-  const stream = await checkLinks(html);
-  const reader = stream.getReader();
-  while (true) {
-    const { done, value } = await reader.read();
-    if (value) {
-      results.push(value);
-    }
-    if (done) {
-      break;
-    }
-  }
-  expect(results).toEqual([
-    {
-      status: 'error',
-      codeLocation: {
-        line: 2,
-        column: 3,
-      },
-      checks: [
-        {
-          type: 'syntax',
-          passed: false,
-        },
-      ],
-      link: '/',
-    },
-    {
-      status: 'success',
-      codeLocation: {
-        line: 3,
-        column: 3,
-      },
-      checks: [
-        {
-          type: 'syntax',
-          passed: true,
-        },
-        {
-          type: 'security',
-          passed: true,
-        },
-        {
-          type: 'fetch_attempt',
-          passed: true,
-          metadata: {
-            fetchStatusCode: 200,
-          },
-        },
-      ],
-      link: 'https://useprint.com',
-    },
-    {
-      status: 'warning',
-      codeLocation: {
-        line: 4,
-        column: 3,
-      },
-      checks: [
-        {
-          type: 'syntax',
-          passed: true,
-        },
-        {
-          type: 'security',
-          passed: true,
-        },
-        {
-          type: 'fetch_attempt',
-          metadata: {
-            fetchStatusCode: 301,
-          },
-          passed: false,
-        },
-      ],
-      link: 'https://notion.so',
-    },
-    {
-      status: 'warning',
-      codeLocation: {
-        line: 5,
-        column: 3,
-      },
-      checks: [
-        {
-          type: 'syntax',
-          passed: true,
-        },
-        {
-          type: 'security',
-          passed: false,
-        },
-        {
-          type: 'fetch_attempt',
-          metadata: {
-            fetchStatusCode: 308,
-          },
-          passed: false,
-        },
-      ],
-      link: 'http://useprint.dev',
-    },
-  ] satisfies LinkCheckingResult[]);
-});