@appland/scanner 1.83.0 → 1.83.1

package/built/rules/saveWithoutValidation.d.ts

@@ -0,0 +1,3 @@
+import RuleInstance from '../ruleInstance';
+declare const RULE: RuleInstance;
+export default RULE;

package/built/rules/secretInLog.d.ts

@@ -0,0 +1,3 @@
+import RuleInstance from '../ruleInstance';
+declare const RULE: RuleInstance;
+export default RULE;

package/built/rules/slowFunctionCall.d.ts

@@ -0,0 +1,3 @@
+import RuleInstance from '../ruleInstance';
+declare const RULE: RuleInstance;
+export default RULE;

package/built/rules/slowHttpServerRequest.d.ts

@@ -0,0 +1,3 @@
+import RuleInstance from '../ruleInstance';
+declare const RULE: RuleInstance;
+export default RULE;

package/built/rules/slowQuery.d.ts

@@ -0,0 +1,3 @@
+import RuleInstance from '../ruleInstance';
+declare const RULE: RuleInstance;
+export default RULE;

package/built/rules/too-many-joins/metadata.d.ts

@@ -0,0 +1,3 @@
+import { Metadata } from '../lib/metadata';
+declare const _default: Metadata;
+export default _default;

package/built/rules/too-many-joins/options.d.ts

@@ -0,0 +1,6 @@
+import MatchPatternConfig from '../../configuration/types/matchPatternConfig';
+import { TooManyJoins } from '../types';
+export default class Options implements TooManyJoins.Options {
+    warningLimit: number;
+    excludeTables: MatchPatternConfig[];
+}

package/built/rules/too-many-joins/rule.d.ts

@@ -0,0 +1,7 @@
+import { SQLCount } from '../../database';
+import { RuleLogic } from '../../types';
+import Options from './options';
+export interface JoinCount extends SQLCount {
+    joins: number;
+}
+export default function rule(options: Options): RuleLogic;

package/built/rules/tooManyUpdates.d.ts

@@ -0,0 +1,3 @@
+import RuleInstance from '../ruleInstance';
+declare const RULE: RuleInstance;
+export default RULE;

package/built/rules/unauthenticated-encryption/metadata.d.ts

@@ -0,0 +1,3 @@
+import { Metadata } from '../lib/metadata';
+declare const _default: Metadata;
+export default _default;

package/built/rules/unauthenticated-encryption/rule.d.ts

@@ -0,0 +1,2 @@
+import { RuleLogic } from '../../types';
+export default function rule(): RuleLogic;

package/built/rules/unbatchedMaterializedQuery.d.ts

@@ -0,0 +1,3 @@
+import RuleInstance from '../ruleInstance';
+declare const RULE: RuleInstance;
+export default RULE;

package/built/rules/updateInGetRequest.d.ts

@@ -0,0 +1,3 @@
+import RuleInstance from '../ruleInstance';
+declare const RULE: RuleInstance;
+export default RULE;

package/built/scan.d.ts

@@ -0,0 +1,5 @@
+import { ScanResults } from './index';
+/**
+ * Perform all configured checks on a single AppMap file.
+ */
+export default function scan(appmapFile: string, configurationFile: string): Promise<ScanResults>;

package/built/scope/commandScope.d.ts

@@ -0,0 +1,6 @@
+import { Event } from '@appland/models';
+import { Scope } from '../types';
+import ScopeIterator from './scopeIterator';
+export default class CommandScope extends ScopeIterator {
+    scopes(events: IterableIterator<Event>): Generator<Scope>;
+}

package/built/scope/httpClientRequestScope.d.ts

@@ -0,0 +1,6 @@
+import { Event } from '@appland/models';
+import { Scope } from '../types';
+import ScopeIterator from './scopeIterator';
+export default class HTTPClientRequestScope extends ScopeIterator {
+    scopes(events: Generator<Event>): Generator<Scope>;
+}

package/built/scope/httpServerRequestScope.d.ts

@@ -0,0 +1,6 @@
+import { Event } from '@appland/models';
+import { Scope } from '../types';
+import ScopeIterator from './scopeIterator';
+export default class HTTPServerRequestScope extends ScopeIterator {
+    scopes(events: Generator<Event>): Generator<Scope>;
+}

package/built/scope/rootScope.d.ts

@@ -0,0 +1,6 @@
+import { Event } from '@appland/models';
+import { Scope } from '../types';
+import ScopeIterator from './scopeIterator';
+export default class RootScope extends ScopeIterator {
+    scopes(events: IterableIterator<Event>): Generator<Scope>;
+}

package/built/scope/scopeImpl.d.ts

@@ -0,0 +1,8 @@
+import { Event, EventNavigator } from '@appland/models';
+import { Scope } from '../types';
+export default class ScopeImpl implements Scope {
+    scope: Event;
+    descendants: EventNavigator;
+    constructor(event: Event);
+    events(): Generator<Event>;
+}

package/built/scope/scopeIterator.d.ts

@@ -0,0 +1,6 @@
+import { Event } from '@appland/models';
+import { Scope } from '../types';
+export default abstract class ScopeIterator {
+    abstract scopes(events: Iterable<Event>): Generator<Scope>;
+    protected advanceToReturnEvent(scopeEvent: Event, events: Iterator<Event>): void;
+}

package/built/scope/sqlTransactionScope.d.ts

@@ -0,0 +1,13 @@
+import type { Event } from '@appland/models';
+import ScopeIterator from './scopeIterator';
+import type { Scope } from '../types';
+export interface TransactionDetails {
+    transaction: {
+        status: 'commit' | 'rollback';
+        events: Event[];
+    };
+}
+export declare function hasTransactionDetails(event: Event & Partial<TransactionDetails>): event is Event & TransactionDetails;
+export default class SQLTransactionScope extends ScopeIterator {
+    scopes(events: IterableIterator<Event>): Generator<Scope, void, void>;
+}

package/built/sqlWarning.d.ts

@@ -0,0 +1,2 @@
+import { ParseError } from '@appland/models';
+export default function sqlWarning(parseError: ParseError): void;

package/built/telemetry.d.ts

@@ -0,0 +1,50 @@
+/// <reference types="node" />
+import { TelemetryClient } from 'applicationinsights';
+import { PathLike } from 'fs';
+declare class Session {
+    id: string;
+    expiration: number;
+    constructor();
+    static beyondExpiration(expiration: number): boolean;
+    static expirationFromNow(): number;
+    static newSessionId(): string;
+    touch(): void;
+    get valid(): boolean;
+}
+export interface TelemetryData {
+    name: string;
+    properties?: Record<string, string | undefined>;
+    metrics?: Record<string, number | undefined>;
+}
+export interface TelemetryOptions {
+    includeEnvironment: boolean;
+}
+export default class Telemetry {
+    private static _session?;
+    private static _client?;
+    private static debug;
+    static readonly machineId: string;
+    static get enabled(): boolean;
+    static get session(): Session;
+    static get client(): TelemetryClient;
+    static sendEvent(data: TelemetryData, options?: TelemetryOptions): void;
+    static flush(exitCB: () => unknown): void;
+}
+export declare enum GitState {
+    NotInstalled = 0,
+    NoRepository = 1,
+    Ok = 2
+}
+export declare const GitRepositoryEnvKeys: readonly ["GITHUB_REPOSITORY", "CIRCLE_REPOSITORY_URL", "GIT_URL", "CI_REPOSITORY_URL"];
+export declare const GitBranchEnvKeys: readonly ["GITHUB_REF_NAME", "CIRCLE_BRANCH", "GIT_BRANCH", "TRAVIS_BRANCH", "CI_COMMIT_REF_NAME"];
+export declare const GitCommitEnvKeys: readonly ["GITHUB_SHA", "CIRCLE_SHA1", "GIT_COMMIT", "TRAVIS_COMMIT", "CI_COMMIT_SHA"];
+declare class GitProperties {
+    static contributors(sinceDaysAgo: number, cwd?: PathLike): Promise<Array<string>>;
+    static repository(cwd?: PathLike): Promise<string | undefined>;
+    static branch(cwd?: PathLike): Promise<string | undefined>;
+    static commit(cwd?: PathLike): Promise<string | undefined>;
+    static state(cwd?: PathLike): Promise<GitState>;
+    static clearCache(): void;
+}
+export declare const Git: typeof GitProperties;
+export {};

package/built/util/eventAggregator.d.ts

@@ -0,0 +1,20 @@
+/// <reference types="node" />
+import { EventEmitter } from 'events';
+export declare type PendingEvent<E> = {
+    emitter: EventEmitter;
+    event: string;
+    arg: E;
+};
+export declare const MaxMSBetween: number;
+export declare type CancelFn = () => void;
+export default class EventAggregator<E> {
+    private callback;
+    private maxMsBetween;
+    private pending;
+    private timeout?;
+    constructor(callback: (events: PendingEvent<E>[]) => void, maxMsBetween?: number);
+    private push;
+    private refresh;
+    private emitPending;
+    attach(emitter: EventEmitter, event: string): CancelFn;
+}

package/built/util/isAncestorPath.d.ts

@@ -0,0 +1 @@
+export default function isAncestorPath(ancestor: string, descendant: string): boolean;

package/built/wellKnownLabels.d.ts

@@ -0,0 +1,5 @@
+declare enum WellKnownLabels {
+    JobCreate = "job.create",
+    JobCancel = "job.cancel"
+}
+export default WellKnownLabels;

package/package.json

@@ -1,15 +1,14 @@
 {
   "name": "@appland/scanner",
-  "version": "1.83.0",
+  "version": "1.83.1",
   "description": "Analyze AppMaps for code flaws",
   "bin": "built/cli.js",
   "main": "built/index.js",
   "files": [
     "built",
-    "doc",
-    "src/types.d.ts"
+    "doc"
   ],
-  "types": "src/index.ts",
+  "types": "built/index.d.ts",
   "scripts": {
     "build": "node bin/preBuild.js && tsc -p tsconfig.build.json && yarn schema && yarn doc",
     "build-native": "yarn build && ./bin/build-native",
@@ -20,8 +19,8 @@
     "doc-up-to-date": "git diff --exit-code doc/",
     "lint": "eslint src --ext .ts",
     "ci": "yarn lint && yarn build && yarn schema-up-to-date && yarn doc-up-to-date && yarn test",
-    "test": "jest --filter=./test/testFilter.js",
-    "jest": "jest --filter=./test/testFilter.js",
+    "test": "jest --filter=./test/testFilter.js --detectOpenHandles",
+    "jest": "jest --filter=./test/testFilter.js --detectOpenHandles",
     "semantic-release": "semantic-release",
     "watch": "node bin/preBuild.js && tsc -p tsconfig.build.json --watch"
   },
@@ -65,7 +64,7 @@
   "dependencies": {
     "@appland/client": "^1.5.0",
     "@appland/models": "^2.6.3",
-    "@appland/openapi": "1.6.0",
+    "@appland/openapi": "1.6.1",
     "@appland/sql-parser": "^1.5.0",
     "@types/cli-progress": "^3.9.2",
     "ajv": "^8.8.2",
@@ -83,7 +82,7 @@
     "lru-cache": "^6.0.0",
     "minimatch": "^5.1.2",
     "octokit": "^2.0.19",
-    "openapi-diff": "^0.23.5",
+    "openapi-diff": "^0.23.6",
     "ora": "~5",
     "pretty-format": "^27.4.6",
     "read-pkg-up": "^7.0.1",

package/src/types.d.ts

@@ -1,72 +0,0 @@
-import { AppMap, Event } from '@appland/models';
-import { SqliteParser } from '@appland/models/types/sqlite-parser';
-
-/**
- * Scope provides an Event at the root of the scope, and a Generator to iterate over its descendants.
- */
-interface Scope {
-  scope: Event;
-  events: () => Generator<Event>;
-}
-
-/**
- * Level indicates the priority of a finding.
- */
-export type Level = 'warning' | 'error';
-
-type StringFilter = (value: string) => boolean;
-
-/**
- * EventFilter is used by Rule to select Events that will be analyzed for findings.
- * The event filter is always applied to the Scope.scope event. If enumerateScope is true,
- * the filter is applied to all Scope.events as well.
- */
-type EventFilter = (e: Event, appMapIndex: AppMapIndex) => boolean;
-
-/**
- * MatchResult is created by a rule when it matches an Event.
- */
-export interface MatchResult {
-  level?: Level;
-  event: Event;
-  message: string;
-  participatingEvents?: Record<string, Event>;
-  groupMessage?: string;
-  occurranceCount?: number;
-  relatedEvents?: Event[];
-}
-
-type MatcherResult =
-  | Promise<boolean | string | MatchResult[]>
-  | boolean
-  | string
-  | MatchResult[]
-  | undefined;
-
-type EventType = 'http_server_request' | 'http_client_request' | 'sql_query' | 'function';
-
-export type QueryAST = SqliteParser.ListStatement | null;
-
-interface AppMapIndex {
-  appMap: AppMap;
-
-  sqlAST(event: Event): QueryAST | undefined;
-
-  sqlNormalized(event: Event): string;
-}
-
-/**
- * Matcher function is part of a rule. It's applied to an Event to determine whether there is a finding
- * on this event. If the Matcher returns true, a string, or a MatchResult[], then finding(s) are created.
- */
-type Matcher = (e: Event, appMapIndex: AppMapIndex, eventFilter: EventFilter) => MatcherResult;
-
-export interface RuleLogic {
-  // Tests an event in the scope see if it matches the rule conditions.
-  matcher: Matcher;
-  // When specified by the rule, only events which pass the where filter
-  // will be passed to the matcher.
-  where?: EventFilter;
-  // When specified by the rule, provides a detailed message for a finding on a specific event.
-  message?: (scope: Event, event: Event) => string;
-}