Merge pull request #320 from lightningrodlabs/projects-unit-tests

Write unit tests for functions in the projects/ folder

Author: Connoropolous

.github/workflows/dry-run.yml

@@ -25,6 +25,8 @@ jobs:
           npm install
           npm run web-install
           npm run electron-install
+          npm run zod-models-install
+          npm run zod-models-build
         shell: bash
       - name: setup for codesigning (macos only)
         if: ${{ runner.os == 'macOs' }}

.github/workflows/release.yml

@@ -36,6 +36,8 @@ jobs:
           npm install
           npm run web-install
           npm run electron-install
+          npm run zod-models-install
+          npm run zod-models-build
         shell: bash
       - name: setup for codesigning (macos only)
         if: ${{ runner.os == 'macOs' }}

scripts/build.sh

@@ -1,5 +1,7 @@
 #!/bin/bash
 
+set -e
+
 # assumes that 
 # dna/workdir/projects.dna
 # and

web/src/migrating/export.ts

@@ -26,7 +26,7 @@ export async function updateProjectMeta(
 export async function internalExportProjectsData(
   constructProjectDataFetchersFunction: typeof constructProjectDataFetchers,
   collectExportProjectDataFunction: typeof collectExportProjectData,
-  _updateProjectMeta: typeof updateProjectMeta,
+  iUpdateProjectMeta: typeof updateProjectMeta,
   store: any,
   toVersion: string,
   onStep: (completed: number, toComplete: number) => void,
@@ -58,7 +58,6 @@ export async function internalExportProjectsData(
       projectCellId
     )
     try {
-
       await Promise.all([
         projectDataFetchers.fetchProjectMeta(),
         projectDataFetchers.fetchEntryPoints(),
@@ -94,7 +93,7 @@ export async function internalExportProjectsData(
       ...projectMetaDetails,
       isMigrated: toVersion,
     }
-    await _updateProjectMeta(newProjectMeta, actionHash, projectCellId)
+    await iUpdateProjectMeta(newProjectMeta, actionHash, projectCellId)
     completedTracker++
     onStep(completedTracker, projectCellIds.length)
   }

web/src/migrating/import/cloneFunctions.ts

@@ -10,8 +10,8 @@ import { cellIdFromString } from '../../utils'
 import { Tag } from '../../types/tag'
 import { Outcome } from '../../types/outcome'
 import { Connection } from '../../types/connection'
-import { LayeringAlgorithm, ProjectMeta } from '../../types'
-import { ProjectMetaWithActionHash } from 'zod-models'
+import { ProjectMeta } from '../../types'
+import { LayeringAlgorithm, ProjectMetaWithActionHash } from 'zod-models'
 
 export type ActionHashMap = { [oldActionHash: ActionHashB64]: ActionHashB64 }
 
@@ -108,7 +108,7 @@ export const cloneProjectMeta = (
     // add a fallback layering algorithm in case the project has none
     layeringAlgorithm: old['layeringAlgorithm']
       ? old['layeringAlgorithm']
-      : "LongestPath",
+      : LayeringAlgorithm.LongestPath,
     createdAt: Date.now(),
     creatorAgentPubKey: agentAddress,
     passphrase: passphrase,

web/src/migrating/import/createActionHashMapAndImportProjectData.ts

@@ -1,3 +1,4 @@
+import { ProjectExportDataV1 } from 'zod-models'
 import ProjectsZomeApi from '../../api/projectsApi'
 import { getAppWs } from '../../hcWebsockets'
 import { createConnection } from '../../redux/persistent/projects/connections/actions'
@@ -15,7 +16,6 @@ import {
   EntryPoint,
 } from '../../types'
 import { CellIdString } from '../../types/shared'
-import { ProjectExportDataV1 } from '../export'
 import {
   cloneDataSet,
   cloneTag,
@@ -30,7 +30,7 @@ export async function internalCreateActionHashMapAndImportProjectData(
   projectsCellIdString: CellIdString,
   dispatch: any,
   projectsZomeApi: ProjectsZomeApi,
-  _cloneDataSet: typeof cloneDataSet
+  iCloneDataSet: typeof cloneDataSet
 ) {
   /*
   outcomes, connections,
@@ -42,7 +42,7 @@ export async function internalCreateActionHashMapAndImportProjectData(
 
   // TAGS
   // do tags because outcomes reference them
-  const tagActionHashMap = await _cloneDataSet<Tag>(
+  const tagActionHashMap = await iCloneDataSet<Tag>(
     projectData.tags,
     cloneTag,
     projectsZomeApi.tag.create,
@@ -51,7 +51,7 @@ export async function internalCreateActionHashMapAndImportProjectData(
     projectsCellIdString
   )
 
-  const outcomeActionHashMap = await _cloneDataSet<Outcome>(
+  const outcomeActionHashMap = await iCloneDataSet<Outcome>(
     projectData.outcomes,
     // closure in the depended upon hashmap
     cloneOutcome(tagActionHashMap),
@@ -61,7 +61,7 @@ export async function internalCreateActionHashMapAndImportProjectData(
     projectsCellIdString
   )
 
-  const connectionsActionHashMap = await _cloneDataSet<Connection>(
+  const connectionsActionHashMap = await iCloneDataSet<Connection>(
     projectData.connections,
     // closure in the depended upon
     cloneConnection(outcomeActionHashMap),
@@ -71,7 +71,7 @@ export async function internalCreateActionHashMapAndImportProjectData(
     projectsCellIdString
   )
 
-  const outcomeMembersActionHashMap = await _cloneDataSet<OutcomeMember>(
+  const outcomeMembersActionHashMap = await iCloneDataSet<OutcomeMember>(
     projectData.outcomeMembers,
     // closure in the depended upon
     cloneData<OutcomeMember>(outcomeActionHashMap),
@@ -81,7 +81,7 @@ export async function internalCreateActionHashMapAndImportProjectData(
     projectsCellIdString
   )
 
-  const outcomeCommentActionHashMap = await _cloneDataSet<OutcomeComment>(
+  const outcomeCommentActionHashMap = await iCloneDataSet<OutcomeComment>(
     projectData.outcomeComments,
     // closure in the depended upon
     cloneData<OutcomeComment>(outcomeActionHashMap),
@@ -91,7 +91,7 @@ export async function internalCreateActionHashMapAndImportProjectData(
     projectsCellIdString
   )
 
-  const entryPointActionHashMap = await _cloneDataSet<EntryPoint>(
+  const entryPointActionHashMap = await iCloneDataSet<EntryPoint>(
     projectData.entryPoints,
     // closure in the depended upon
     cloneData<EntryPoint>(outcomeActionHashMap),

web/src/migrating/import/import.ts

@@ -22,8 +22,8 @@ const stringToJSONSchema = z.string().transform((str, ctx): any => {
 export async function internalImportProjectsData(
   // dependencies
   profilesZomeApi: ProfilesZomeApi,
-  _installProjectAndImport: typeof installProjectAndImport,
-  _installProject: typeof installProject,
+  iInstallProjectAndImport: typeof installProjectAndImport,
+  iInstallProject: typeof installProject,
   store: any,
   // main input data and callbacks
   migrationData: string,
@@ -70,11 +70,11 @@ export async function internalImportProjectsData(
   // one completes
   for await (let projectData of projectsToMigrate) {
     const passphrase = projectData.projectMeta.passphrase
-    await _installProjectAndImport(
+    await iInstallProjectAndImport(
       myAgentPubKey,
       projectData,
       passphrase,
-      store.dispatch,
+      store.dispatch
     )
     stepsSoFar++
     onStep(stepsSoFar, totalSteps)
@@ -83,7 +83,7 @@ export async function internalImportProjectsData(
   // join each project that has already been migrated by a peer
   for await (let projectData of migratedProjectsToJoin) {
     const passphrase = projectData.projectMeta.passphrase
-    await internalJoinProject(passphrase, store.dispatch, _installProject)
+    await internalJoinProject(passphrase, store.dispatch, iInstallProject)
     stepsSoFar++
     onStep(stepsSoFar, totalSteps)
   }

web/src/projects/createProject.ts

@@ -31,11 +31,12 @@ export async function internalCreateProject(
   agentAddress: AgentPubKeyB64,
   dispatch: any,
   iInstallProject: typeof installProject,
+  iFinalizeCreateProject: typeof finalizeCreateProject,
   projectsZomeApi: ProjectsZomeApi
 ) {
   const startTime = Date.now()
   const [cellIdString] = await iInstallProject(passphrase)
-  await finalizeCreateProject(
+  await iFinalizeCreateProject(
     cellIdString,
     projectMeta,
     agentAddress,
@@ -60,6 +61,7 @@ export async function createProject(
     agentAddress,
     dispatch,
     installProject,
+    finalizeCreateProject,
     projectsZomeApi
   )
 }

web/src/projects/installProject.ts

@@ -8,6 +8,7 @@ import { cellIdToString } from '../utils'
 export async function internalInstallProject(
   passphrase: string,
   adminWs: AdminWebsocket,
+  iGetAgentPubKey: typeof getAgentPubKey
 ): Promise<[CellIdString, CellId, string]> {
   const uid = passphraseToUid(passphrase)
   // add a bit of randomness so that
@@ -19,17 +20,21 @@ export async function internalInstallProject(
   const installed_app_id = `${PROJECT_APP_PREFIX}-${Math.random()
     .toString()
     .slice(-6)}-${uid}`
-  const agent_key = getAgentPubKey()
+  const agent_key = iGetAgentPubKey()
   if (!agent_key) {
     throw new Error(
       'Cannot install a new project because no AgentPubKey is known locally'
     )
   }
   // the dna hash HAS to act deterministically
   // in order for the 'joining' of Projects to work
-  const happPath = window.require
-    ? await window.require('electron').ipcRenderer.invoke('getProjectsPath')
-    : './happ/workdir/projects/projects.happ'
+  let happPath: string
+  if (typeof window !== 'undefined' && window.require)
+    happPath = await window
+      .require('electron')
+      .ipcRenderer.invoke('getProjectsPath')
+  else happPath = './happ/workdir/projects/projects.happ'
+
   // INSTALL
   const installedApp = await adminWs.installApp({
     agent_key,
@@ -56,5 +61,5 @@ export async function installProject(
   passphrase: string
 ): Promise<[CellIdString, CellId, string]> {
   const adminWs = await getAdminWs()
-  return internalInstallProject(passphrase, adminWs)
+  return internalInstallProject(passphrase, adminWs, getAgentPubKey)
 }

web/src/redux/ephemeral/animations/layout.ts

@@ -71,7 +71,7 @@ export default function performLayoutAnimation(
 
   const projectMeta = nextState.projects.projectMeta
   const layeringAlgorithm =
-    projectMeta[projectId]?.layeringAlgorithm || "LongestPath"
+    projectMeta[projectId]?.layeringAlgorithm || LayeringAlgorithm.LongestPath
   // this is our final destination layout
   // that we'll be animating to
   const newLayout = layoutFormula(

web/src/redux/ephemeral/map-view-settings/reducer.ts

@@ -16,7 +16,7 @@ export interface CollapsedOutcomesState {
 const defaultState: CollapsedOutcomesState = {
   hiddenAchievedOutcomes: [],
   hiddenSmallOutcomes: [],
-  selectedLayeringAlgo: "LongestPath",
+  selectedLayeringAlgo: LayeringAlgorithm.LongestPath,
 }
 
 export default function (

web/src/routes/Dashboard/Dashboard.connector.ts

@@ -2,9 +2,7 @@ import { connect } from 'react-redux'
 
 import { getAdminWs, getAppWs } from '../../hcWebsockets'
 import { fetchEntryPointDetails } from '../../redux/persistent/projects/entry-points/actions'
-import {
-  fetchMembers,
-} from '../../redux/persistent/projects/members/actions'
+import { fetchMembers } from '../../redux/persistent/projects/members/actions'
 import {
   fetchProjectMeta,
   updateProjectMeta,
@@ -118,11 +116,17 @@ function mapDispatchToProps(dispatch): DashboardDispatchProps {
         creatorAgentPubKey: agentAddress,
         createdAt: Date.now(),
         isImported: false,
-        layeringAlgorithm: "CoffmanGraham",
+        layeringAlgorithm: LayeringAlgorithm.CoffmanGraham,
         topPriorityOutcomes: [],
         isMigrated: null,
       }
-      await createProject(passphrase, projectMeta, agentAddress, dispatch, projectsZomeApi)
+      await createProject(
+        passphrase,
+        projectMeta,
+        agentAddress,
+        dispatch,
+        projectsZomeApi
+      )
     },
     joinProject: async (passphrase: string) => {
       const appWs = await getAppWs()

web/src/stories/testData/testProjectMeta.ts

@@ -8,7 +8,7 @@ const testProject: WithActionHash<ProjectMeta> = {
   image: null,
   passphrase: 'testPassphrase',
   isImported: false,
-  layeringAlgorithm: "CoffmanGraham",
+  layeringAlgorithm: LayeringAlgorithm.CoffmanGraham,
   topPriorityOutcomes: [],
   isMigrated: null,
   actionHash: 'testProjectActionHash',

web/src/types/connection.ts

@@ -1,3 +1,7 @@
-import { Connection as _Connection } from 'zod-models'
+import {
+  ConnectionSchema as _ConnectionSchema,
+  Connection as _Connection,
+} from 'zod-models'
 
+export const ConnectionSchema = _ConnectionSchema
 export type Connection = _Connection

web/src/types/entryPoint.ts

@@ -1,3 +1,7 @@
-import { EntryPoint as _EntryPoint } from 'zod-models'
+import {
+  EntryPoint as _EntryPoint,
+  EntryPointSchema as _EntryPointSchema,
+} from 'zod-models'
 
+export const EntryPointSchema = _EntryPointSchema
 export type EntryPoint = _EntryPoint

web/src/types/index.ts

@@ -14,4 +14,4 @@ export * from './realtimeInfoInput'
 export * from './createOutcomeWithConnectionInput'
 export * from './createOutcomeWithConnectionOutput'
 export * from './deleteOutcomeFullyResponse'
-export * from './whoAmIOutput'
+export * from './whoAmIOutput'

web/src/types/outcome.ts

@@ -10,9 +10,11 @@ import {
   UncertainScope as _UncertainScope,
   Scope as _Scope,
   Outcome as _Outcome,
+  AchievementStatus as _AchievementStatus,
+  OutcomeSchema as _OutcomeSchema,
 } from 'zod-models'
 
-export type AchievementStatus = 'Achieved' | 'NotAchieved'
+export type AchievementStatus = _AchievementStatus
 
 export type SmallTask = _SmallTask
 export type SmallScope = _SmallScope
@@ -36,6 +38,7 @@ export type ComputedAchievementStatus = {
 }
 
 export type Outcome = _Outcome
+export const OutcomeSchema = _OutcomeSchema
 /*
 Uncertain
 {

web/src/types/outcomeComment.ts

@@ -1,3 +1,7 @@
-import { OutcomeComment as _OutcomeComment } from 'zod-models'
+import {
+  OutcomeComment as _OutcomeComment,
+  OutcomeCommentSchema as _OutcomeCommentSchema,
+} from 'zod-models'
 
+export const OutcomeCommentSchema = _OutcomeCommentSchema
 export type OutcomeComment = _OutcomeComment

web/src/types/outcomeMember.ts

@@ -1,3 +1,7 @@
-import { OutcomeMember as _OutcomeMember } from 'zod-models'
+import {
+  OutcomeMember as _OutcomeMember,
+  OutcomeMemberSchema as _OutcomeMemberSchema,
+} from 'zod-models'
 
+export const OutcomeMemberSchema = _OutcomeMemberSchema
 export type OutcomeMember = _OutcomeMember

web/src/types/projectMeta.ts

@@ -4,6 +4,7 @@ import { Profile } from './profile'
 import { AgentPubKeyB64, CellIdString, WithActionHash } from './shared'
 import { ProjectMetaV1 } from 'zod-models'
 
+export { LayeringAlgorithm } from 'zod-models'
 export type ProjectAggregated = {
   projectMeta: WithActionHash<ProjectMetaV1>
   cellId: CellIdString
@@ -14,3 +15,5 @@ export type ProjectAggregated = {
     outcome: WithActionHash<Outcome>
   }[]
 }
+
+export type ProjectMeta = ProjectMetaV1

web/src/types/tag.ts

@@ -1,3 +1,4 @@
-import { Tag as _Tag } from 'zod-models'
+import { Tag as _Tag, TagSchema as _TagSchema } from 'zod-models'
 
+export const TagSchema = _TagSchema
 export type Tag = _Tag