wasp/waspc/test/Generator/NpmDependenciesTest.hs

module Generator.NpmDependenciesTest where

import Test.Tasty.Hspec
import qualified Wasp.AppSpec.App.Dependency as D
import Wasp.Generator.NpmDependencies

spec_combineNpmDepsForPackage :: Spec
spec_combineNpmDepsForPackage = do
  let waspDeps =
        D.fromList
          [ ("a", "1"),
            ("b", "2")
          ]

  let waspDevDeps =
        D.fromList
          [ ("alpha", "10"),
            ("beta", "20")
          ]

  it "a conflicting version number is detected" $ do
    let npmDepsForWasp =
          NpmDepsForWasp
            { waspDependencies = waspDeps,
              waspDevDependencies = []
            }
    let npmDepsForUser =
          NpmDepsForUser
            { userDependencies =
                D.fromList
                  [ ("a", "1"),
                    ("b", "3")
                  ],
              userDevDependencies = []
            }

    combineNpmDepsForPackage npmDepsForWasp npmDepsForUser
      `shouldBe` Left
        NpmDepsForPackageError
          { dependenciesConflictErrors =
              [ DependencyConflictError
                  (D.make ("b", "2"))
                  (D.make ("b", "3"))
              ],
            devDependenciesConflictErrors = []
          }

  it "wasp deps completely overlap with user deps, no duplication" $ do
    let npmDepsForWasp =
          NpmDepsForWasp
            { waspDependencies = waspDeps,
              waspDevDependencies = []
            }
    let npmDepsForUser =
          NpmDepsForUser
            { userDependencies =
                D.fromList
                  [ ("a", "1"),
                    ("b", "2")
                  ],
              userDevDependencies = []
            }

    combineNpmDepsForPackage npmDepsForWasp npmDepsForUser
      `shouldBe` Right
        NpmDepsForPackage
          { dependencies =
              D.fromList
                [ ("a", "1"),
                  ("b", "2")
                ],
            devDependencies = []
          }

  it "user dependencies supplement wasp dependencies" $ do
    let npmDepsForWasp =
          NpmDepsForWasp
            { waspDependencies = waspDeps,
              waspDevDependencies = []
            }
    let npmDepsForUser =
          NpmDepsForUser
            { userDependencies =
                D.fromList
                  [ ("c", "3"),
                    ("d", "4")
                  ],
              userDevDependencies = []
            }

    combineNpmDepsForPackage npmDepsForWasp npmDepsForUser
      `shouldBe` Right
        NpmDepsForPackage
          { dependencies =
              D.fromList
                [ ("a", "1"),
                  ("b", "2"),
                  ("c", "3"),
                  ("d", "4")
                ],
            devDependencies = []
          }

  it "user dependencies partially overlap wasp dependencies, so only non-overlapping supplement" $ do
    let npmDepsForWasp =
          NpmDepsForWasp
            { waspDependencies = waspDeps,
              waspDevDependencies = []
            }
    let npmDepsForUser =
          NpmDepsForUser
            { userDependencies =
                D.fromList
                  [ ("a", "1"),
                    ("d", "4")
                  ],
              userDevDependencies = []
            }

    combineNpmDepsForPackage npmDepsForWasp npmDepsForUser
      `shouldBe` Right
        NpmDepsForPackage
          { dependencies =
              D.fromList
                [ ("a", "1"),
                  ("b", "2"),
                  ("d", "4")
                ],
            devDependencies = []
          }

  it "report error if user dependency overlaps wasp dependency, different version" $ do
    let npmDepsForWasp =
          NpmDepsForWasp
            { waspDependencies = waspDeps,
              waspDevDependencies = []
            }
    let npmDepsForUser =
          NpmDepsForUser
            { userDependencies =
                D.fromList
                  [ ("a", "2"),
                    ("foo", "bar")
                  ],
              userDevDependencies = []
            }

    combineNpmDepsForPackage npmDepsForWasp npmDepsForUser
      `shouldBe` Left
        NpmDepsForPackageError
          { dependenciesConflictErrors =
              [ DependencyConflictError
                  (D.make ("a", "1"))
                  (D.make ("a", "2"))
              ],
            devDependenciesConflictErrors = []
          }

  it "a conflicting version number is detected with wasp devDependencies" $ do
    let npmDepsForWasp =
          NpmDepsForWasp
            { waspDependencies = waspDeps,
              waspDevDependencies = waspDevDeps
            }
    let npmDepsForUser =
          NpmDepsForUser
            { userDependencies =
                D.fromList
                  [ ("a", "1"),
                    ("alpha", "70")
                  ],
              userDevDependencies = []
            }

    combineNpmDepsForPackage npmDepsForWasp npmDepsForUser
      `shouldBe` Left
        NpmDepsForPackageError
          { dependenciesConflictErrors =
              [ DependencyConflictError
                  (D.make ("alpha", "10"))
                  (D.make ("alpha", "70"))
              ],
            devDependenciesConflictErrors = []
          }

  it "dev dependencies are also combined" $ do
    let npmDepsForWasp =
          NpmDepsForWasp
            { waspDependencies = waspDeps,
              waspDevDependencies = waspDevDeps
            }

    let npmDepsForUser =
          NpmDepsForUser
            { userDependencies =
                D.fromList
                  [ ("a", "1"),
                    ("d", "4")
                  ],
              userDevDependencies =
                D.fromList
                  [ ("alpha", "10"),
                    ("gamma", "30")
                  ]
            }
    combineNpmDepsForPackage npmDepsForWasp npmDepsForUser
      `shouldBe` Right
        NpmDepsForPackage
          { dependencies =
              D.fromList
                [ ("a", "1"),
                  ("b", "2"),
                  ("d", "4")
                ],
            devDependencies =
              D.fromList
                [ ("alpha", "10"),
                  ("beta", "20"),
                  ("gamma", "30")
                ]
          }

  it "wasp dev dependency overlaps with user dependency, should remain devDependency" $ do
    let npmDepsForWasp =
          NpmDepsForWasp
            { waspDependencies = waspDeps,
              waspDevDependencies = waspDevDeps
            }

    let npmDepsForUser =
          NpmDepsForUser
            { userDependencies =
                D.fromList
                  [ ("alpha", "10")
                  ],
              userDevDependencies = []
            }

    combineNpmDepsForPackage npmDepsForWasp npmDepsForUser
      `shouldBe` Right
        NpmDepsForPackage
          { dependencies =
              D.fromList
                [ ("a", "1"),
                  ("b", "2")
                ],
            devDependencies =
              D.fromList
                [ ("alpha", "10"),
                  ("beta", "20")
                ]
          }

  it "conflictErrorToMessage" $ do
    conflictErrorToMessage
      ( DependencyConflictError
          { waspDependency = D.make ("a", "1"),
            userDependency = D.make ("a", "2")
          }
      )
      `shouldBe` "Error: Dependency conflict for user dependency (a, 2): "
        ++ "Version must be set to the exactly "
        ++ "the same version as the one wasp is using: 1"

  it
    "NpmDependencies are equal even if dependencies have different order"
    $ do
      NpmDepsForPackage
        { dependencies = waspDeps,
          devDependencies = []
        }
      `shouldBe` NpmDepsForPackage
        { dependencies = reverse waspDeps,
          devDependencies = []
        }

  it
    "NpmDependencies are equal even if dependencies have different order, with dev dependencies"
    $ do
      NpmDepsForPackage
        { dependencies = waspDeps,
          devDependencies = reverse waspDeps
        }
      `shouldBe` NpmDepsForPackage
        { dependencies = reverse waspDeps,
          devDependencies = waspDeps
        }

  it
    "NpmDependencies can be unequal"
    $ do
      NpmDepsForPackage
        { dependencies = waspDeps,
          devDependencies = []
        }
      `shouldNotBe` NpmDepsForPackage
        { dependencies = [],
          devDependencies = []
        }