move form to another workspace #339
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
WalkthroughThis update enhances the application by introducing the ability to change a form's workspace. Users can now select a new workspace for a form using the Changes
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Review Status
Actionable comments generated: 1
Configuration used: CodeRabbit UI
Files selected for processing (4)
- app/Http/Controllers/Forms/FormController.php (1 hunks)
- client/components/open/forms/components/FormWorkspaceModal.vue (1 hunks)
- client/components/pages/forms/show/ExtraMenu.vue (3 hunks)
- routes/api.php (1 hunks)
Additional comments: 5
client/components/open/forms/components/FormWorkspaceModal.vue (1)
- 1-48: The template structure and modal implementation look good. However, consider adding
aria-labelattributes to interactive elements (e.g., buttons) for improved accessibility. This ensures that users with assistive technologies can better understand the purpose of each interactive element.app/Http/Controllers/Forms/FormController.php (1)
- 222-240: The implementation of the
updateWorkspacemethod looks solid. However, consider adding validation to ensure that the user has permission to move the form to the target workspace. This prevents unauthorized workspace changes and enhances security.Additionally, it's a good practice to check if the form already belongs to the target workspace before proceeding with the update. This can save unnecessary database operations.
routes/api.php (1)
- 93-93: The new route for updating a form's workspace is correctly defined and follows the RESTful API conventions. However, ensure that appropriate middleware is applied to this route to enforce authentication and authorization checks, safeguarding against unauthorized access.
client/components/pages/forms/show/ExtraMenu.vue (2)
- 110-120: The addition of the "Change workspace" link in the form menu is implemented correctly. However, consider adding an
aria-labelto the link for improved accessibility, providing screen reader users with context about the action.- 166-166: The integration of the
FormWorkspaceModalcomponent is done correctly. It's good practice to conditionally render components based on the state (showFormWorkspaceModal) to improve performance by not rendering the component until needed.
Comment on lines
51
to
103
| <script setup> | ||
| import { ref, defineProps, defineEmits, computed } from 'vue' | ||
| const emit = defineEmits(['close']) | ||
| const workspacesStore = useWorkspacesStore() | ||
| const formsStore = useFormsStore() | ||
|
|
||
| const selectedWorkspace = ref(null); | ||
| const props = defineProps({ | ||
| show: { type: Boolean, required: true }, | ||
| form: { type: Object, required: true }, | ||
| }) | ||
| const workspaces = computed(() => workspacesStore.getAll) | ||
| const workspace = computed(() => workspacesStore.getByKey(props.form?.workspace_id)) | ||
| const loading = ref(false) | ||
| const workspacesSelectOptions = computed(()=> workspaces.value.filter((w)=>{ | ||
| return w.id !== workspace.value.id | ||
| }).map(workspace => ({ name: workspace.name, value: workspace.id }))) | ||
|
|
||
|
|
||
| const onSubmit = () => { | ||
| const endpoint = '/open/forms/' + props.form.id + '/workspace/' + selectedWorkspace.value | ||
| if(! selectedWorkspace.value) { | ||
| useAlert().error('Please select a workspace!') | ||
| return; | ||
| } | ||
| opnFetch(endpoint, { method: 'POST' }).then(data => { | ||
| loading.value = false; | ||
| emit('close') | ||
| useAlert().success('Form workspace updated successfully.') | ||
| workspacesStore.setCurrentId(selectedWorkspace.value) | ||
| formsStore.resetState() | ||
| formsStore.loadAll(selectedWorkspace.value) | ||
| const router = useRouter() | ||
| const route = useRoute() | ||
| if (route.name !== 'home') { | ||
| router.push({ name: 'home' }) | ||
| } | ||
| formsStore.loadAll(selectedWorkspace.value) | ||
| }).catch((error) => { | ||
| useAlert().error(err?.data?.message ?? 'Something went wrong, please try again!') | ||
| loading.value = false; | ||
| }) | ||
| } | ||
|
|
||
| const isUrl = (str) => { | ||
| try { | ||
| new URL(str) | ||
| } catch (_) { | ||
| return false | ||
| } | ||
| return true | ||
| } | ||
| </script> |
There was a problem hiding this comment.
In the onSubmit method, there's a potential issue with how errors are handled. Specifically, the catch block references err which is not defined within its scope. It should be error as per the catch block's parameter.
- useAlert().error(err?.data?.message ?? 'Something went wrong, please try again!')
+ useAlert().error(error?.data?.message ?? 'Something went wrong, please try again!')Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
Suggested change
| <script setup> | |
| import { ref, defineProps, defineEmits, computed } from 'vue' | |
| const emit = defineEmits(['close']) | |
| const workspacesStore = useWorkspacesStore() | |
| const formsStore = useFormsStore() | |
| const selectedWorkspace = ref(null); | |
| const props = defineProps({ | |
| show: { type: Boolean, required: true }, | |
| form: { type: Object, required: true }, | |
| }) | |
| const workspaces = computed(() => workspacesStore.getAll) | |
| const workspace = computed(() => workspacesStore.getByKey(props.form?.workspace_id)) | |
| const loading = ref(false) | |
| const workspacesSelectOptions = computed(()=> workspaces.value.filter((w)=>{ | |
| return w.id !== workspace.value.id | |
| }).map(workspace => ({ name: workspace.name, value: workspace.id }))) | |
| const onSubmit = () => { | |
| const endpoint = '/open/forms/' + props.form.id + '/workspace/' + selectedWorkspace.value | |
| if(! selectedWorkspace.value) { | |
| useAlert().error('Please select a workspace!') | |
| return; | |
| } | |
| opnFetch(endpoint, { method: 'POST' }).then(data => { | |
| loading.value = false; | |
| emit('close') | |
| useAlert().success('Form workspace updated successfully.') | |
| workspacesStore.setCurrentId(selectedWorkspace.value) | |
| formsStore.resetState() | |
| formsStore.loadAll(selectedWorkspace.value) | |
| const router = useRouter() | |
| const route = useRoute() | |
| if (route.name !== 'home') { | |
| router.push({ name: 'home' }) | |
| } | |
| formsStore.loadAll(selectedWorkspace.value) | |
| }).catch((error) => { | |
| useAlert().error(err?.data?.message ?? 'Something went wrong, please try again!') | |
| loading.value = false; | |
| }) | |
| } | |
| const isUrl = (str) => { | |
| try { | |
| new URL(str) | |
| } catch (_) { | |
| return false | |
| } | |
| return true | |
| } | |
| </script> | |
| useAlert().error(error?.data?.message ?? 'Something went wrong, please try again!') |
There was a problem hiding this comment.
Review Status
Actionable comments generated: 0
Configuration used: CodeRabbit UI
Files selected for processing (1)
- app/Http/Controllers/Forms/FormController.php (1 hunks)
Files skipped from review as they are similar to previous changes (1)
- app/Http/Controllers/Forms/FormController.php
There was a problem hiding this comment.
Review Status
Actionable comments generated: 0
Configuration used: CodeRabbit UI
Files selected for processing (1)
- client/components/open/forms/components/FormWorkspaceModal.vue (1 hunks)
Files skipped from review as they are similar to previous changes (1)
- client/components/open/forms/components/FormWorkspaceModal.vue
JhumanJ
approved these changes
Mar 12, 2024
There was a problem hiding this comment.
Great work @madassdev! For next time: even if not mentioned, it's always best to add a test case when adding new API endpoints 👍
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary by CodeRabbit