Skip to content

Github issue#2396, Refactor the way we are storing project template id while creating project #2397

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
vikasrohit merged 1 commit into from
Aug 22, 2018
Merged

Github issue#2396, Refactor the way we are storing project template id while creating project #2397

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion src/projects/components/projectsCard/ProjectCardHeader.jsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,11 @@ import './ProjectCardHeader.scss'
function ProjectCardHeader({ project, onClick, projectTemplates }) {
if (!project) return null

const projectTemplateId = project.templateId
const projectTemplateKey = _.get(project, 'details.products[0]')
const projectTemplate = getProjectTemplateByKey(projectTemplates, projectTemplateKey)
const projectTemplate = projectTemplateId
? _.find(projectTemplates, pt => pt.id === projectTemplateId)
: getProjectTemplateByKey(projectTemplates, projectTemplateKey)
// icon for the product, use default generic work project icon for categories which no longer exist now
const productIcon = _.get(projectTemplate, 'icon', 'tech-32px-outline-work-project')
return (
Expand Down
4 changes: 2 additions & 2 deletions src/projects/create/components/FillProjectDetails.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,8 +39,8 @@ class FillProjectDetails extends Component {

render() {
const { project, dirtyProject, processing, submitBtnText, onBackClick, projectTemplates } = this.props
const projectKey = _.get(project, 'details.products[0]')
const projectTemplate = _.find(projectTemplates, { key: projectKey })
const projectTemplateId = _.get(project, 'templateId')
const projectTemplate = _.find(projectTemplates, { id: projectTemplateId })
const formDisclaimer = _.get(projectTemplate, 'scope.formDisclaimer')

const sections = projectTemplate.scope.sections
Expand Down
49 changes: 23 additions & 26 deletions src/projects/create/components/ProjectWizard.jsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,7 @@ import qs from 'query-string'
import React, { Component } from 'react'
import PropTypes from 'prop-types'
import { withRouter } from 'react-router-dom'
import { getProjectCreationTemplateField, getProjectTemplateByAlias,
getProjectTemplateByKey, getProjectTemplatesByCategory, getProjectTypeByAlias } from '../../../helpers/templates'
import { getProjectCreationTemplateField, getProjectTemplateByAlias, getProjectTemplatesByCategory, getProjectTypeByAlias } from '../../../helpers/templates'
import Wizard from '../../../components/Wizard'
import SelectProjectTemplate from './SelectProjectTemplate'
import SelectProjectType from './SelectProjectType'
Expand Down Expand Up @@ -53,14 +52,15 @@ class ProjectWizard extends Component {
const incompleteProjectStr = window.localStorage.getItem(LS_INCOMPLETE_PROJECT)
if (incompleteProjectStr) {
const incompleteProject = JSON.parse(incompleteProjectStr)
const incompleteProjectTemplateKey = _.get(incompleteProject, 'details.products[0]')
const incompleteProjectTemplateId = _.get(incompleteProject, 'templateId')
const incompleteProjectTemplate = _.find(projectTemplates, pt => pt.id === incompleteProjectTemplateId)
let wizardStep = WZ_STEP_INCOMP_PROJ_CONF
let updateQuery = {}
if (incompleteProjectTemplateKey && params && params.project) {
const project = getProjectTemplateByAlias(projectTemplates, params.project)
if (project) {
if (incompleteProjectTemplate && params && params.project) {
const projectTemplate = getProjectTemplateByAlias(projectTemplates, params.project)
if (projectTemplate) {
// load project details page directly
if (project.key === incompleteProjectTemplateKey) {
if (projectTemplate.key === incompleteProjectTemplate.key) {
Copy link
Collaborator

@maxceem maxceem Aug 22, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just for consistency this line looks like can be replaced to use id: projectTemplate.id === incompleteProjectTemplate.id.

Copy link
Author

@vikasrohit vikasrohit Aug 22, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good catch. However, I left that intentionally considering that in future we have to keep versions of templates i.e. we would try to eliminate the usage of templates by id as much as possible. In this specific case I am using key because this loads the project template based on the key in URL and in case we get new a template for the same key (through versioning), it would still got the project details page with the latest template of that key instead of asking the project template again.

wizardStep = WZ_STEP_FILL_PROJ_DETAILS
updateQuery = {$merge : incompleteProject}
} else {
Expand Down Expand Up @@ -111,15 +111,15 @@ class ProjectWizard extends Component {
const { onStepChange } = nextProps
const params = nextProps.match.params
const type = _.get(nextProps.project, 'type', null)
const projectTemplateKey = _.get(nextProps.project, 'details.products[0]', null)
const projectTemplateId = _.get(nextProps.project, 'templateId', null)
// redirect user to project details form, if we already have type and project available
let wizardStep = type && projectTemplateKey ? WZ_STEP_FILL_PROJ_DETAILS : null
let wizardStep = type && projectTemplateId ? WZ_STEP_FILL_PROJ_DETAILS : null
const updateQuery = {}
if (params && params.project) { // if there exists project path param
wizardStep = this.loadProjectFromURL(params, updateQuery)
} else { // if there is not project path param, it should be first step of the wizard
updateQuery['type'] = { $set : null }
updateQuery['details'] = { products : { $set: [] } }
updateQuery['details'] = { $set : {} }
wizardStep = WZ_STEP_SELECT_PROJ_TYPE
}
// if wizard step deduced above and stored in state are not the same, update the state
Expand Down Expand Up @@ -166,7 +166,8 @@ class ProjectWizard extends Component {
// show details step
if (projectTemplate) {
updateQuery['type'] = { $set : projectTemplate.category }
updateQuery['details'] = { products : { $set: [projectTemplate.key] } }
updateQuery['templateId'] = { $set : projectTemplate.id }
updateQuery['details'] = {}

const refCode = _.get(qs.parse(window.location.search), 'refCode', '').trim().substr(0, PROJECT_REF_CODE_MAX_LENGTH)
if (refCode) {
Expand Down Expand Up @@ -211,11 +212,11 @@ class ProjectWizard extends Component {
window.localStorage.removeItem(LS_INCOMPLETE_PROJECT)
// following code assumes that componentDidMount has already updated state with correct project
const projectType = _.get(this.state.project, 'type')
const projectTemplateKey = _.get(this.state.project, 'details.products[0]')
const projectTemplateId = _.get(this.state.project, 'templateId')
let wizardStep = WZ_STEP_SELECT_PROJ_TYPE
let project = null
if (projectTemplateKey) {
project = { type: projectType, details: { products: [projectTemplateKey] } }
if (projectTemplateId) {
project = { type: projectType, templateId: projectTemplateId }
wizardStep = WZ_STEP_FILL_PROJ_DETAILS
}
const refCode = this.getRefCodeFromURL()
Expand Down Expand Up @@ -243,18 +244,13 @@ class ProjectWizard extends Component {
})
}

updateProjectTemplate(projectTemplateKey) {
updateProjectTemplate(projectTemplate) {
window.scrollTo(0, 0)
const { onStepChange, onProjectUpdate, projectTemplates } = this.props
const { onStepChange, onProjectUpdate } = this.props
const updateQuery = {}
if (projectTemplateKey) {
const projectTemplate = getProjectTemplateByKey(projectTemplates, projectTemplateKey)

const detailsQuery = { products : [projectTemplateKey] }
this.restoreCommonDetails(projectTemplate, updateQuery, detailsQuery)

if (projectTemplate) {
updateQuery.type = { $set : projectTemplate.category }
updateQuery.details = { $set : detailsQuery }
updateQuery.templateId = { $set: projectTemplate.id }
}
this.setState({
project: update(this.state.project, updateQuery),
Expand All @@ -275,8 +271,9 @@ class ProjectWizard extends Component {
if (projectType) {
updateQuery.type = { $set : projectType }

// sets the appropriate project template if project category has only one project template
if (visibleProjectTemplates.length === 1) {
updateQuery.details = { $set : { products : [visibleProjectTemplates[0].key]} }
updateQuery.templateId = { $set : visibleProjectTemplates[0].id }
}
}

Expand Down Expand Up @@ -392,8 +389,8 @@ class ProjectWizard extends Component {
const type = wizardStep === WZ_STEP_SELECT_PROJ_TEMPLATE ? this.state.project.type : null
this.setState({
// resets project sub type or product
project: update(this.state.project, { type: { $set : type }, details: { products: {$set : [] }}}),
dirtyProject: update(this.state.project, { type: { $set : type }, details: { products: {$set : [] }}}),
project: update(this.state.project, { type: { $set : type }, details: {}}),
dirtyProject: update(this.state.project, { type: { $set : type }, details: {}}),
wizardStep
}, () => {
typeof onStepChange === 'function' && onStepChange(wizardStep, this.state.dirtyProject)
Expand Down
2 changes: 1 addition & 1 deletion src/projects/create/components/SelectProjectTemplate.jsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ const SelectProjectTemplate = ({
icon={icon}
info={projectTemplate.info}
key={projectTemplate.id}
onClick={() => onProjectTemplateChange(projectTemplate.key)}
onClick={() => onProjectTemplateChange(projectTemplate)}
type={projectTemplate.name}
/>
)
Expand Down
16 changes: 8 additions & 8 deletions src/projects/create/containers/CreateContainer.jsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ import { loadProjectTemplates, loadProjectCategories } from '../../../actions/te
import CoderBot from '../../../components/CoderBot/CoderBot'
import spinnerWhileLoading from '../../../components/LoadingSpinner'
import ProjectWizard from '../components/ProjectWizard'
import { getProjectTemplateByKey, getProjectTemplateByAlias, getProjectTypeByKey } from '../../../helpers/templates'
import { getProjectTemplateByAlias, getProjectTypeByKey } from '../../../helpers/templates'
import {
CREATE_PROJECT_FAILURE,
LS_INCOMPLETE_PROJECT,
Expand Down Expand Up @@ -169,8 +169,8 @@ class CreateContainer extends React.Component {

if (wizardStep === ProjectWizard.Steps.WZ_STEP_FILL_PROJ_DETAILS && isProjectDirty) {// Project Details step

const projectTemplateKey = _.get(this.state.updatedProject, 'details.products[0]')
const projectTemplate = getProjectTemplateByKey(projectTemplates, projectTemplateKey)
const projectTemplateId = _.get(this.state.updatedProject, 'templateId')
const projectTemplate = _.find(projectTemplates, pt => pt.id === projectTemplateId)
this.prepareProjectForCreation(this.state.updatedProject, projectTemplate)
console.log('saving incomplete project', this.state.updatedProject)
window.localStorage.setItem(LS_INCOMPLETE_PROJECT, JSON.stringify(this.state.updatedProject))
Expand Down Expand Up @@ -214,7 +214,7 @@ class CreateContainer extends React.Component {
*/
createProject(project) {
const { templates: { projectTemplates }} = this.props
const projectTemplate = getProjectTemplateByKey(projectTemplates, _.get(project, 'details.products[0]'))
const projectTemplate = _.find(projectTemplates, _.get(project, 'templateId'))

this.setState({ creatingProject: true }, () => {
if (this.props.userRoles && this.props.userRoles.length > 0) {
Expand Down Expand Up @@ -262,8 +262,8 @@ class CreateContainer extends React.Component {
const projectType = getProjectTypeByKey(projectTypes, projectTypeKey)
const typeAlias = _.get(projectType, 'aliases[0]')

const projectTemplateKey = _.get(updatedProject, 'details.products[0]', null)
const projectTemplate = getProjectTemplateByKey(projectTemplates, projectTemplateKey)
const projectTemplateId = _.get(updatedProject, 'templateId', null)
const projectTemplate = _.find(projectTemplates, pt => pt.id === projectTemplateId)
const templateAlias = _.get(projectTemplate, 'aliases[0]')

if (wizardStep === ProjectWizard.Steps.WZ_STEP_INCOMP_PROJ_CONF) {
Expand Down Expand Up @@ -291,8 +291,8 @@ class CreateContainer extends React.Component {
}
onProjectUpdate={ (updatedProject, dirty=true) => {
// const projectType = _.get(this.state.updatedProject, 'type', null)
const prevProduct = _.get(this.state.updatedProject, 'details.products[0]', null)
const product = _.get(updatedProject, 'details.products[0]', null)
const prevProduct = _.get(this.state.updatedProject, 'templateId', null)
const product = _.get(updatedProject, 'templateId', null)
// compares updated product with previous product to know if user has updated the product
if (prevProduct !== product) {
if (product) {
Expand Down