@sentry/wizard 3.40.0 → 3.41.0

package/test/utils/clack-utils.test.ts

@@ -1,9 +1,12 @@
 import {
   askForToolConfigPath,
   createNewConfigFile,
+  installPackage,
 } from '../../src/utils/clack-utils';
 
 import * as fs from 'fs';
+import * as ChildProcess from 'child_process';
+import { PackageManager } from '../../src/utils/package-manager';
 
 type ClackMock = {
   confirm: jest.Mock;
@@ -15,6 +18,7 @@ type ClackMock = {
     success: jest.Mock;
     warn: jest.Mock;
   };
+  spinner: () => { start: jest.Mock; stop: jest.Mock };
 };
 
 let clackMock: ClackMock;
@@ -31,6 +35,9 @@ jest.mock('@clack/prompts', () => {
     cancel: jest.fn(),
     // passthrough for abortIfCancelled
     isCancel: jest.fn().mockReturnValue(false),
+    spinner: jest
+      .fn()
+      .mockImplementation(() => ({ start: jest.fn(), stop: jest.fn() })),
   };
   return clackMock;
 });
@@ -140,3 +147,88 @@ describe('createNewConfigFile', () => {
     expect(result).toBe(false);
   });
 });
+
+describe('installPackage', () => {
+  afterEach(() => {
+    jest.clearAllMocks();
+  });
+
+  it('force-installs a package if the forceInstall flag is set', async () => {
+    const packageManagerMock: PackageManager = {
+      name: 'npm',
+      label: 'NPM',
+      installCommand: 'npm install',
+      buildCommand: 'npm run build',
+      runScriptCommand: 'npm run',
+      flags: '',
+      forceInstallFlag: '--force',
+      detect: jest.fn(),
+      addOverride: jest.fn(),
+    };
+
+    const execSpy = jest
+      .spyOn(ChildProcess, 'exec')
+      // @ts-expect-error - don't care about the return value
+      .mockImplementationOnce((cmd, cb) => {
+        if (cb) {
+          // @ts-expect-error - don't care about the options value
+          cb(null, '', '');
+        }
+      });
+
+    await installPackage({
+      alreadyInstalled: false,
+      packageName: '@sentry/sveltekit',
+      packageNameDisplayLabel: '@sentry/sveltekit',
+      forceInstall: true,
+      askBeforeUpdating: false,
+      packageManager: packageManagerMock,
+    });
+
+    expect(execSpy).toHaveBeenCalledWith(
+      'npm install @sentry/sveltekit  --force',
+      expect.any(Function),
+    );
+  });
+
+  it.each([false, undefined])(
+    "doesn't force-install a package if the forceInstall flag is %s",
+    async (flag) => {
+      const packageManagerMock: PackageManager = {
+        name: 'npm',
+        label: 'NPM',
+        installCommand: 'npm install',
+        buildCommand: 'npm run build',
+        runScriptCommand: 'npm run',
+        flags: '',
+        forceInstallFlag: '--force',
+        detect: jest.fn(),
+        addOverride: jest.fn(),
+      };
+
+      const execSpy = jest
+        .spyOn(ChildProcess, 'exec')
+        // @ts-expect-error - don't care about the return value
+        .mockImplementationOnce((cmd, cb) => {
+          if (cb) {
+            // @ts-expect-error - don't care about the options value
+            cb(null, '', '');
+          }
+        });
+
+      await installPackage({
+        alreadyInstalled: false,
+        packageName: '@sentry/sveltekit',
+        packageNameDisplayLabel: '@sentry/sveltekit',
+        forceInstall: flag,
+        askBeforeUpdating: false,
+        packageManager: packageManagerMock,
+      });
+
+      expect(execSpy).toHaveBeenCalledWith(
+        'npm install @sentry/sveltekit  ',
+        expect.any(Function),
+      );
+    },
+  );
+});

package/types/xcode.d.ts

@@ -0,0 +1,526 @@
+// The xcode package is not typed, so we need to manually maintain this file.
+// This typing is created by hand and needs to be updated when the types change.
+// As most fields are from parsing Xcode project files, it is hard to tell which fields are optional.
+// Therefore most fields are marked as nullable, except the ones we are certain about.
+
+declare module 'xcode' {
+  interface PBXFileOptions {
+    lastKnownFileType?: string;
+    group?: string;
+    customFramework?: boolean;
+    defaultEncoding?: string;
+    explicitFileType?: string;
+    sourceTree?: string;
+    weak?: boolean;
+    compilerFlags?: string;
+    embed?: boolean;
+    sign?: boolean;
+  }
+
+  class PBXFile {
+    basename?: string;
+    lastKnownFileType?: string;
+    group?: string;
+    customFramework?: boolean;
+    dirname?: string;
+    path?: string;
+    fileEncoding?: string;
+    explicitFileType?: string;
+    defaultEncoding?: string;
+    sourceTree?: string;
+    includeInIndex?: number;
+    settings?: {
+      ATTRIBUTES?: string[];
+      COMPILER_FLAGS?: string;
+    };
+
+    constructor(filepath: string, opt?: PBXFileOptions);
+  }
+
+  export interface PBXBuildFile {
+    isa: 'PBXBuildFile';
+    fileRef?: string;
+    fileRef_comment?: string;
+    productRef?: string;
+    productRef_comment?: string;
+    settings?: {
+      ATTRIBUTES?: string[];
+      COMPILER_FLAGS?: string;
+    };
+  }
+
+  interface PBXWriterOptions {
+    omitEmptyValues?: boolean;
+  }
+
+  class PBXWriter {
+    constructor(contents: string, options: PBXWriterOptions);
+
+    write(output: string): void;
+    writeFlush(output: string): void;
+    writeSync(): string;
+    writeHeadComment(): void;
+    writeProject(): void;
+    writeObject(object: Record<string, Array | object | string | number>): void;
+    writeObjectsSections(
+      objects: Record<string, Array | object | string | number>,
+    ): void;
+    writeArray(
+      arr: Array<
+        | {
+            value?: string;
+            comment?: string;
+          }
+        | Record<string, Array | object | string | number>
+      >,
+      name: string,
+    ): void;
+
+    writeSectionComment(name: string, begin: boolean): void;
+    writeSection(
+      section: Record<string, Array | object | string | number>,
+    ): void;
+    writeInlineObject(
+      name: string,
+      comment: string,
+      object: Record<string, Array | object | string | number>,
+    ): void;
+  }
+
+  export interface PBXNativeTarget {
+    name: string;
+    productType: string;
+
+    buildConfigurationList?: string;
+    buildConfigurationList_comment?: string;
+    buildPhases?: {
+      value: string;
+      comment?: string;
+    }[];
+    buildRules?: {
+      [key: string]: unknown;
+    }[];
+    dependencies?: {
+      [key: string]: unknown;
+    }[];
+    fileSystemSynchronizedGroups?: {
+      value: string;
+      comment?: string;
+    }[];
+    packageProductDependencies?: {
+      value: string;
+      comment: string;
+    }[];
+    productName?: string;
+    productReference?: string;
+    productReference_comment?: string;
+    productType?: string;
+  }
+
+  export interface XCConfigurationList {
+    buildConfigurations?: {
+      value: string;
+    }[];
+  }
+
+  export interface PBXGroup {
+    path?: string;
+    children?: {
+      value: string;
+      comment?: string;
+    }[];
+  }
+
+  interface PBXCopyFilesBuildPhase {
+    [key: string]: unknown;
+  }
+
+  export interface XCBuildConfiguration {
+    buildSettings?: {
+      [key: string]: string;
+    };
+  }
+
+  export interface PBXFrameworksBuildPhase {
+    files?: {
+      value: string;
+      comment?: string;
+    }[];
+  }
+
+  interface XCRemoteSwiftPackageReference {
+    isa: 'XCRemoteSwiftPackageReference';
+    repositoryURL: string;
+    requirement: {
+      kind: string;
+      minimumVersion: string;
+    };
+  }
+
+  interface XCSwiftPackageProductDependency {
+    isa: 'XCSwiftPackageProductDependency';
+    package: string;
+    productName: string;
+    package_comment?: string;
+  }
+
+  export interface PBXShellScriptBuildPhase {
+    shellScript: string;
+    inputFileListPaths?: string[];
+    outputFileListPaths?: string[];
+    inputPaths?: string[];
+    outputPaths?: string[];
+    shellPath?: string;
+  }
+
+  export interface PBXSourcesBuildPhase {
+    files?: {
+      value: string;
+      comment?: string;
+    }[];
+  }
+
+  export interface PBXFileReference {
+    path: string;
+  }
+
+  export interface PBXObjects {
+    PBXBuildFile?: {
+      [key: string]: PBXBuildFile | string;
+    };
+    PBXCopyFilesBuildPhase?: {
+      [key: string]: PBXCopyFilesBuildPhase | string;
+    };
+    PBXFileReference?: {
+      [key: string]: PBXFileReference | string;
+    };
+    PBXFrameworksBuildPhase?: {
+      [key: string]: PBXFrameworksBuildPhase | string;
+    };
+    PBXGroup?: {
+      [key: string]: PBXGroup | string;
+    };
+    PBXNativeTarget?: {
+      [key: string]: PBXNativeTarget | string;
+    };
+    PBXProject?: {
+      [key: string]: PBXProject | string;
+    };
+    PBXShellScriptBuildPhase?: {
+      [key: string]: PBXShellScriptBuildPhase | string;
+    };
+    PBXSourcesBuildPhase?: {
+      [key: string]: PBXSourcesBuildPhase | string;
+    };
+
+    XCBuildConfiguration?: {
+      [key: string]: XCBuildConfiguration | string;
+    };
+    /**
+     * The XCConfigurationList is not always present in the project file.
+     *
+     * If the configuration list is not present, Xcode will declare the project as damaged.
+     */
+    XCConfigurationList?: {
+      [key: string]: XCConfigurationList | string;
+    };
+    XCRemoteSwiftPackageReference?: {
+      [key: string]: XCRemoteSwiftPackageReference | string;
+    };
+    XCSwiftPackageProductDependency?: {
+      [key: string]: XCSwiftPackageProductDependency | string;
+    };
+
+    mainGroup: string;
+    packageReferences?: {
+      value: string;
+      comment?: string;
+    }[];
+  }
+
+  export interface PBXProject {
+    attributes?: {
+      BuildIndependentTargetsInParallel?: number;
+      LastSwiftUpdateCheck?: number;
+      LastUpgradeCheck?: number;
+      TargetAttributes?: {
+        [key: string]: {
+          CreatedOnToolsVersion?: string;
+        };
+      };
+    };
+    buildConfigurationList?: string;
+    buildConfigurationList_comment?: string;
+    developmentRegion?: string;
+    hasScannedForEncodings?: number;
+    knownRegions?: string[];
+    mainGroup?: string;
+    minimizedProjectReferenceProxies?: number;
+    preferredProjectObjectVersion?: number;
+    productRefGroup?: string;
+    productRefGroup_comment?: string;
+    projectDirPath?: string;
+    projectRoot?: string;
+    targets?: {
+      value: string;
+      comment?: string;
+    }[];
+  }
+
+  export class Project extends import('events').EventEmitter {
+    hash: {
+      project: {
+        objects: PBXObjects;
+      };
+    };
+
+    filepath: string;
+
+    constructor(filename: string);
+
+    parse(cb: (err: Error | null) => void): void;
+    parseSync(): void;
+
+    writeSync(options?: PBXWriterOptions): string;
+    allUuids(): string[];
+    generateUuid(): string;
+
+    addPluginFile(path: string, opt?: PBXFileOptions): void;
+    removePluginFile(path: string, opt?: PBXFileOptions): void;
+
+    addProductFile(targetPath: string, opt?: PBXFileOptions): void;
+    removeProductFile(path: string, opt?: PBXFileOptions): void;
+
+    addSourceFile(path: string, opt?: PBXFileOptions, group?: string): void;
+    removeSourceFile(path: string, opt?: PBXFileOptions, group?: string): void;
+
+    addHeaderFile(path: string, opt?: PBXFileOptions, group?: string): void;
+    removeHeaderFile(path: string, opt?: PBXFileOptions, group?: string): void;
+
+    addResourceFile(path: string, opt?: PBXFileOptions, group?: string): void;
+    removeResourceFile(
+      path: string,
+      opt?: PBXFileOptions,
+      group?: string,
+    ): void;
+
+    addFramework(fpath: string, opt?: PBXFileOptions): void;
+    removeFramework(fpath: string, opt?: PBXFileOptions): void;
+
+    addCopyfile(fpath: string, opt?: PBXFileOptions): void;
+    removeCopyfile(fpath: string, opt?: PBXFileOptions): void;
+
+    pbxCopyfilesBuildPhaseObj(target: string): PBXObjects;
+    addToPbxCopyfilesBuildPhase(file: PBXObjects): void;
+    removeFromPbxCopyfilesBuildPhase(file: PBXObjects): void;
+
+    addStaticLibrary(
+      path: string,
+      opt: {
+        plugin?: boolean;
+        target?: string;
+      },
+    ): void;
+
+    addToPbxBuildFileSection(file: PBXFile): void;
+    removeFromPbxBuildFileSection(file: PBXFile): void;
+
+    addPbxGroup(
+      filePathsArray: string[],
+      name: string,
+      path: string,
+      sourceTree: string,
+    ): void;
+    removePbxGroup(name: string): void;
+
+    addToPbxProjectSection(target: PBXNativeTarget): void;
+    addToPbxNativeTargetSection(target: PBXNativeTarget): void;
+    addToPbxFileReferenceSection(file: PBXFile): void;
+
+    removeFromPbxFileReferenceSection(file: PBXFile): void;
+
+    addToXcVersionGroupSection(file: PBXFile): void;
+
+    addToPluginsPbxGroup(file: PBXFile): void;
+    removeFromPluginsPbxGroup(file: PBXFile): void;
+
+    addToResourcesPbxGroup(file: PBXFile): void;
+    removeFromResourcesPbxGroup(file: PBXFile): void;
+
+    addToFrameworksPbxGroup(file: PBXFile): void;
+    removeFromFrameworksPbxGroup(file: PBXFile): void;
+
+    addToProductsPbxGroup(file: PBXFile): void;
+    removeFromProductsPbxGroup(file: PBXFile): void;
+
+    addToPbxSourcesBuildPhase(file: PBXFile): void;
+    removeFromPbxSourcesBuildPhase(file: PBXFile): void;
+
+    addToPbxResourcesBuildPhase(file: PBXFile): void;
+    removeFromPbxResourcesBuildPhase(file: PBXFile): void;
+
+    addToPbxFrameworksBuildPhase(file: PBXFile): void;
+    removeFromPbxFrameworksBuildPhase(file: PBXFile): void;
+
+    addXCConfigurationList(
+      configurationObjectsArray: string[],
+      defaultConfigurationName: string,
+      comment: string,
+    ): void;
+
+    addTargetDependency(target: string, dependencyTargets: string[]): void;
+
+    addBuildPhase(
+      filePathsArray: string[],
+      buildPhaseType: 'PBXShellScriptBuildPhase',
+      comment: string,
+      target: string,
+      optionsOrFolderType:
+        | {
+            inputPaths: string[];
+            outputPaths?: string[];
+            inputFileListPaths: string[];
+            outputFileListPaths: string[];
+            shellPath: string;
+            shellScript: string;
+          }
+        | string,
+      subfolderPath?: string,
+    ): void;
+
+    pbxProjectSection(): PBXObjects;
+    pbxBuildFileSection(): PBXObjects;
+    pbxXCBuildConfigurationSection(): PBXObjects;
+    pbxFileReferenceSection(): PBXObjects;
+    pbxNativeTargetSection(): PBXObjects;
+    xcVersionGroupSection(): PBXObjects;
+
+    pbxXCConfigurationList(): PBXObjects;
+    pbxGroupByName(name: string): PBXObjects;
+    pbxTargetByName(name: string): PBXObjects;
+    findTargetKey(name: string): string;
+
+    pbxItemByComment(name: string, pbxSectionName: string): PBXObjects;
+    pbxSourcesBuildPhaseObj(target: string): PBXObjects;
+    pbxResourcesBuildPhaseObj(target: string): PBXObjects;
+    pbxFrameworksBuildPhaseObj(target: string): PBXObjects;
+    pbxEmbedFrameworksBuildPhaseObj(target: string): PBXObjects;
+
+    buildPhase(group: string, target: string): PBXObjects;
+    buildPhaseObject(name: string, group: string, target: string): PBXObjects;
+
+    addBuildProperty(prop: string, value: string, build_name: string): void;
+    removeBuildProperty(prop: string, build_name: string): void;
+
+    updateBuildProperty(
+      prop: string,
+      value: string,
+      build: string,
+      targetName: string,
+    ): void;
+
+    updateProductName(name: string): void;
+    removeFromFrameworkSearchPaths(file: string): void;
+
+    addToFrameworkSearchPaths(file: string): void;
+    removeFromLibrarySearchPaths(file: string): void;
+
+    addToLibrarySearchPaths(file: string): void;
+    removeFromHeaderSearchPaths(file: string): void;
+
+    addToHeaderSearchPaths(file: string): void;
+    addToOtherLinkerFlags(flag: string): void;
+    removeFromOtherLinkerFlags(flag: string): void;
+
+    addToBuildSettings(buildSetting: string, value: string): void;
+    removeFromBuildSettings(buildSetting: string): void;
+
+    readonly productName: string;
+
+    hasFile(filePath: string): boolean;
+
+    addTarget(
+      name: string,
+      type: string,
+      subfolder: string,
+      bundleId: string,
+    ): void;
+
+    getFirstProject(): {
+      uuid: string;
+      firstProject: PBXObjects;
+    };
+    getFirstTarget(): {
+      uuid: string;
+      firstTarget: PBXObjects;
+    } | null;
+    getTarget(productType: string): {
+      uuid: string;
+      target: PBXObjects;
+    } | null;
+
+    addToPbxGroupType(file: string, groupKey: string, groupType: string): void;
+    addToPbxVariantGroup(file: string, groupKey: string): void;
+    addToPbxGroup(file: string, groupKey: string): void;
+
+    pbxCreateGroupWithType(
+      name: string,
+      pathName: string,
+      groupType: string,
+    ): void;
+    pbxCreateVariantGroup(name: string): void;
+    pbxCreateGroup(name: string, pathName: string): void;
+
+    removeFromPbxGroupAndType(
+      file: string,
+      groupKey: string,
+      groupType: string,
+    ): void;
+    removeFromPbxGroup(file: string, groupKey: string): void;
+    removeFromPbxVariantGroup(file: string, groupKey: string): void;
+
+    getPBXGroupByKeyAndType(key: string, groupType: string): PBXObjects;
+    getPBXGroupByKey(key: string): PBXObjects;
+    getPBXVariantGroupByKey(key: string): PBXObjects;
+
+    findPBXGroupKeyAndType(
+      criteria: {
+        path?: string;
+      },
+      groupType: string,
+    ): string;
+
+    findPBXGroupKey(criteria: { path?: string }): string;
+
+    findPBXVariantGroupKey(criteria: { path?: string }): string;
+
+    addLocalizationVariantGroup(name: string): void;
+
+    addKnownRegion(name: string): void;
+    removeKnownRegion(name: string): void;
+
+    hasKnownRegion(name: string): boolean;
+
+    getPBXObject(name: string): PBXObjects;
+
+    addFile(path: string, group: string, opt?: PBXFileOptions): void;
+    removeFile(path: string, group: string, opt?: PBXFileOptions): void;
+
+    getBuildProperty(prop: string, build: string, targetName: string): string;
+    getBuildConfigByName(name: string): PBXObjects;
+
+    addDataModelDocument(
+      filePath: string,
+      group: string,
+      opt?: PBXFileOptions,
+    ): void;
+    addTargetAttribute(prop: string, value: string, target: string): void;
+    removeTargetAttribute(prop: string, target: string): void;
+  }
+
+  export const project: (filename: string) => Project;
+
+  export default {
+    project: project,
+  };
+}