Sign upLogin

evandcoleman/node-appletv

View on GitHub
Star

Showing 38 of 38 total issues

File appletv.ts has 377 lines of code (exceeds 250 allowed). Consider refactoring.
Open

import { Service } from 'mdns';
import * as path from 'path';
import { load, Message as ProtoMessage } from 'protobufjs'
import { v4 as uuid } from 'uuid';
import { EventEmitter } from 'events';
Severity: Minor
Found in src/lib/appletv.ts - About 5 hrs to fix

    AppleTV has 21 functions (exceeds 20 allowed). Consider refactoring.
    Open

    export class AppleTV extends EventEmitter /* <AppleTV.Events> */ {
  public name: string;
  public address: string;
  public port: number;
  public uid: string;
    Severity: Minor
    Found in src/lib/appletv.ts - About 2 hrs to fix

      Function key has a Cognitive Complexity of 15 (exceeds 5 allowed). Consider refactoring.
      Open

        export function key(string: string): AppleTV.Key {
    if (string == "up") {
      return AppleTV.Key.Up;
    } else if (string == "down") {
      return AppleTV.Key.Down;
      Severity: Minor
      Found in src/lib/appletv.ts - About 1 hr to fix

      Cognitive Complexity

      Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

      A method's cognitive complexity is based on a few simple rules:

      • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
      • Code is considered more complex for each "break in the linear flow of the code"
      • Code is considered more complex when "flow breaking structures are nested"

      Further reading

      Function completePairing has 41 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

        private async completePairing(pin: string): Promise<AppleTV> {
    await this.sendThirdSequence(pin);
    let message = await this.device.waitForSequence(0x04);
    let pairingData = message.payload.pairingData;
    this.deviceProof = tlv.decode(pairingData)[tlv.Tag.Proof];
      Severity: Minor
      Found in src/lib/pairing.ts - About 1 hr to fix

        Function completeVerification has 39 lines of code (exceeds 25 allowed). Consider refactoring.
        Open

          private async completeVerification(verifyPublic: Buffer, sessionPublicKey: Buffer, encryptionKey: Buffer, sharedSecret: Buffer): Promise<{}> {
    let material = Buffer.concat([verifyPublic, Buffer.from(this.device.credentials.pairingId), sessionPublicKey]);
    let keyPair = ed25519.MakeKeypair(this.device.credentials.encryptionKey);
    let signed = ed25519.Sign(material, keyPair);
    let plainTLV = tlv.encode(
        Severity: Minor
        Found in src/lib/verifier.ts - About 1 hr to fix

          Function initiatePair has 38 lines of code (exceeds 25 allowed). Consider refactoring.
          Open

            async initiatePair(): Promise<(pin: string) => Promise<AppleTV>> {
    let that = this;
    let tlvData = tlv.encode(
      tlv.Tag.PairingMethod, 0x00,
      tlv.Tag.Sequence, 0x01,
          Severity: Minor
          Found in src/lib/pairing.ts - About 1 hr to fix

            Function requestPairingData has 37 lines of code (exceeds 25 allowed). Consider refactoring.
            Open

              private async requestPairingData(verifyPublic: Buffer, verifyPrivate: Buffer): Promise<PairingData> {
    let encodedData = tlv.encode(
      tlv.Tag.Sequence, 0x01,
      tlv.Tag.PublicKey, verifyPublic
    );
            Severity: Minor
            Found in src/lib/verifier.ts - About 1 hr to fix

              Function sendKeyCommand has 32 lines of code (exceeds 25 allowed). Consider refactoring.
              Open

                sendKeyCommand(key: AppleTV.Key): Promise<AppleTV> {
    switch (key) {
      case AppleTV.Key.Up:
        return this.sendKeyPressAndRelease(1, 0x8C);
      case AppleTV.Key.Down:
              Severity: Minor
              Found in src/lib/appletv.ts - About 1 hr to fix

                Function pair has 32 lines of code (exceeds 25 allowed). Consider refactoring.
                Open

                export function pair(device: AppleTV, logger: Logger): Promise<AppleTV> {
  let spinner = ora("Connecting to " + device.name).start()
  return device
    .openConnection()
    .then(() => {
                Severity: Minor
                Found in src/bin/pair.ts - About 1 hr to fix

                  Function encode has a Cognitive Complexity of 11 (exceeds 5 allowed). Consider refactoring.
                  Open

                  function encode(type, data, ...args: any[]): Buffer {

    var encodedTLVBuffer = Buffer.alloc(0);

    // coerce data to Buffer if needed
                  Severity: Minor
                  Found in src/lib/util/tlv.ts - About 1 hr to fix

                  Cognitive Complexity

                  Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

                  A method's cognitive complexity is based on a few simple rules:

                  • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
                  • Code is considered more complex for each "break in the linear flow of the code"
                  • Code is considered more complex when "flow breaking structures are nested"

                  Further reading

                  Function onReceiveMessage has a Cognitive Complexity of 11 (exceeds 5 allowed). Consider refactoring.
                  Open

                    private onReceiveMessage(message: Message) {
    this.emit('message', message);
    if (message.type == Message.Type.SetStateMessage) {
      if (message.payload == null) {
        this.emit('nowPlaying', null);
                  Severity: Minor
                  Found in src/lib/appletv.ts - About 1 hr to fix

                  Cognitive Complexity

                  Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

                  A method's cognitive complexity is based on a few simple rules:

                  • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
                  • Code is considered more complex for each "break in the linear flow of the code"
                  • Code is considered more complex when "flow breaking structures are nested"

                  Further reading

                  Function key has 31 lines of code (exceeds 25 allowed). Consider refactoring.
                  Open

                    export function key(string: string): AppleTV.Key {
    if (string == "up") {
      return AppleTV.Key.Up;
    } else if (string == "down") {
      return AppleTV.Key.Down;
                  Severity: Minor
                  Found in src/lib/appletv.ts - About 1 hr to fix

                    Function sendProtocolMessage has 30 lines of code (exceeds 25 allowed). Consider refactoring.
                    Open

                      private sendProtocolMessage(message: ProtoMessage<{}>, name: string, type: number, waitForResponse: boolean, credentials?: Credentials): Promise<Message> {
    let that = this;
    return new Promise<Message>((resolve, reject) => {
      let ProtocolMessage: any = message.$type;
                    Severity: Minor
                    Found in src/lib/connection.ts - About 1 hr to fix

                      Function encode has 29 lines of code (exceeds 25 allowed). Consider refactoring.
                      Open

                      function encode(type, data, ...args: any[]): Buffer {

    var encodedTLVBuffer = Buffer.alloc(0);

    // coerce data to Buffer if needed
                      Severity: Minor
                      Found in src/lib/util/tlv.ts - About 1 hr to fix

                        Function scan has 29 lines of code (exceeds 25 allowed). Consider refactoring.
                        Open

                        export function scan(logger: Logger, timeout?: number, uniqueIdentifier?: string): Promise<AppleTV> {
  let browser = new Browser();
  let spinner = ora('Scanning for Apple TVs...').start();
  return browser
    .scan(uniqueIdentifier, timeout)
                        Severity: Minor
                        Found in src/bin/scan.ts - About 1 hr to fix

                          Identical blocks of code found in 2 locations. Consider refactoring.
                          Open

                            device.on('error', (error: Error) => {
    logger.error(error.message);
    logger.debug(error.stack);
  });
                          Severity: Minor
                          Found in src/bin/index.ts and 1 other location - About 55 mins to fix
                          src/bin/index.ts on lines 37..40

                          Duplicated Code

                          Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

                          Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

                          When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

                          Tuning

                          This issue has a mass of 54.

                          We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

                          The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

                          If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

                          See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

                          Refactorings

                          Further Reading

                          Identical blocks of code found in 2 locations. Consider refactoring.
                          Open

                                device.on('error', (error: Error) => {
        logger.error(error.message);
        logger.debug(error.stack);
      });
                          Severity: Minor
                          Found in src/bin/index.ts and 1 other location - About 55 mins to fix
                          src/bin/index.ts on lines 20..23

                          Duplicated Code

                          Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

                          Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

                          When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

                          Tuning

                          This issue has a mass of 54.

                          We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

                          The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

                          If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

                          See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

                          Refactorings

                          Further Reading

                          Identical blocks of code found in 6 locations. Consider refactoring.
                          Open

                              try {
      let device = await openDevice(credentials, logger);
      let data = await device.requestArtwork();
      if (options.output) {
        await promisify(writeFile)(options.output, data);
                          Severity: Major
                          Found in src/bin/index.ts and 5 other locations - About 40 mins to fix
                          src/bin/index.ts on lines 32..48
                          src/bin/index.ts on lines 61..70
                          src/bin/index.ts on lines 108..118
                          src/bin/index.ts on lines 135..150
                          src/bin/index.ts on lines 162..171

                          Duplicated Code

                          Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

                          Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

                          When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

                          Tuning

                          This issue has a mass of 48.

                          We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

                          The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

                          If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

                          See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

                          Refactorings

                          Further Reading

                          Identical blocks of code found in 6 locations. Consider refactoring.
                          Open

                              try {
      let device = await openDevice(credentials, logger);
      let message = await device
        .requestPlaybackQueue({
          location: options.location || 0,
                          Severity: Major
                          Found in src/bin/index.ts and 5 other locations - About 40 mins to fix
                          src/bin/index.ts on lines 32..48
                          src/bin/index.ts on lines 61..70
                          src/bin/index.ts on lines 83..96
                          src/bin/index.ts on lines 108..118
                          src/bin/index.ts on lines 162..171

                          Duplicated Code

                          Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

                          Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

                          When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

                          Tuning

                          This issue has a mass of 48.

                          We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

                          The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

                          If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

                          See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

                          Refactorings

                          Further Reading

                          Identical blocks of code found in 6 locations. Consider refactoring.
                          Open

                              try {
      let device = await scan(logger, options.timeout);
      device.on('debug', (message: string) => {
        logger.debug(message);
      });
                          Severity: Major
                          Found in src/bin/index.ts and 5 other locations - About 40 mins to fix
                          src/bin/index.ts on lines 61..70
                          src/bin/index.ts on lines 83..96
                          src/bin/index.ts on lines 108..118
                          src/bin/index.ts on lines 135..150
                          src/bin/index.ts on lines 162..171

                          Duplicated Code

                          Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

                          Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

                          When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

                          Tuning

                          This issue has a mass of 48.

                          We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

                          The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

                          If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

                          See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

                          Refactorings

                          Further Reading

                          Severity
                          Category
                          Status
                          Source
                          Language