diff --git a/ApiService.js b/ApiService.js new file mode 100644 index 0000000..53500e1 --- /dev/null +++ b/ApiService.js @@ -0,0 +1,59 @@ +// File: ApiService.js + +import axios from 'axios'; + +// INCORRECT: Hard-coded API key +const API_KEY = 'abc123xyz789'; + +// CORRECT: Using environment variable for sensitive information +const SECURE_API_KEY = process.env.REACT_APP_API_KEY; + +// INCORRECT: Exposing sensitive information in a public variable +export const PUBLIC_VARIABLE = { + apiEndpoint: 'https://api.example.com', + apiKey: API_KEY // This should not be exposed +}; + +// CORRECT: Secure API call function +const secureApiCall = async (endpoint) => { + try { + const response = await axios.get(`${process.env.REACT_APP_API_URL}${endpoint}`, { + headers: { + 'Authorization': `Bearer ${SECURE_API_KEY}` + } + }); + return response.data; + } catch (error) { + console.error('API call failed:', error); + throw error; + } +}; + +// INCORRECT: Insecure API call function +const insecureApiCall = async (endpoint) => { + try { + const response = await axios.get(`https://api.example.com${endpoint}?api_key=${API_KEY}`); + return response.data; + } catch (error) { + console.error('API call failed:', error); + throw error; + } +}; + +// CORRECT: Function that doesn't expose sensitive information +export const fetchUserData = async (userId) => { + return secureApiCall(`/users/${userId}`); +}; + +// INCORRECT: Function that might leak sensitive information +export const fetchUserDataInsecure = async (userId) => { + const result = await insecureApiCall(`/users/${userId}`); + console.log('API Key used:', API_KEY); // This logs sensitive information + return result; +}; + +// CORRECT: Using a .env file for configuration (this would be in a .env file, not in the code) +// REACT_APP_API_URL=https://api.example.com +// REACT_APP_API_KEY=your-secret-api-key + +export { secureApiCall, insecureApiCall }; diff --git a/DashboardLayout.js b/DashboardLayout.js new file mode 100644 index 0000000..f3c73d6 --- /dev/null +++ b/DashboardLayout.js @@ -0,0 +1,65 @@ +// File: DashboardLayout.js + +import React from 'react'; +import { Grid, Paper, Typography, useMediaQuery } from '@mui/material'; +import { useTheme } from '@mui/material/styles'; + +const DashboardLayout = () => { + const theme = useTheme(); + const isMobile = useMediaQuery(theme.breakpoints.down('sm')); + + // CORRECT: Using flex properties within sx prop + const CorrectLayoutExample = () => ( + + + + + Sidebar + {/* Sidebar content */} + + + + + Main Content + {/* Main content */} + + + + + ); + + // INCORRECT: Using container and item props + const IncorrectLayoutExample = () => ( + + + + Sidebar + {/* Sidebar content */} + + + + + Main Content + {/* Main content */} + + + + ); + + return ( + <> + Correct Layout + + Incorrect Layout + + + ); +}; + +export default DashboardLayout; diff --git a/DataProcessor.js b/DataProcessor.js new file mode 100644 index 0000000..aade663 --- /dev/null +++ b/DataProcessor.js @@ -0,0 +1,65 @@ +// File: DataProcessor.js + +import React, { useState, useEffect } from 'react'; + +// CORRECT: Clear, descriptive function name and appropriate commenting +const processData = (rawData) => { + // This function processes raw data into a format suitable for display + // It filters out inactive items and sorts by date + const activeItems = rawData.filter(item => item.status === 'active'); + return activeItems.sort((a, b) => new Date(b.date) - new Date(a.date)); +}; + +// INCORRECT: Poorly named function with unnecessary comments +const doStuff = (data) => { + // This function does stuff with the data + // It does things to the data + // Then it returns the result + return data.filter(x => x.y === 'z').sort((a, b) => b.d - a.d); +}; + +const DataProcessor = ({ rawData }) => { + // CORRECT: Clear state naming + const [processedData, setProcessedData] = useState([]); + + useEffect(() => { + // Process data when rawData changes + const result = processData(rawData); + setProcessedData(result); + + // INCORRECT: Commented out code should be removed + // const oldResult = doStuff(rawData); + // setProcessedData(oldResult); + + // INCORRECT: Console.log should be removed before pushing + console.log('Data processed:', result); + }, [rawData]); + + // CORRECT: Clear, concise rendering logic + return ( +
+

Processed Data

+
    + {processedData.map(item => ( +
  • {item.name}
    • + ))} +
+
+ ); + + // INCORRECT: Alternative rendering with poor practices + // return ( + //
+ //

Processed Data

+ // {console.log('Rendering processed data')} {/* Remove console.log */} + //
    + // {processedData.map((item, index) => { + // console.log('Rendering item:', item); // Remove console.log + // return
  • {item.name}
    • ; // Use item.id instead of index for key + // })} + //
+ //
+ // ); +}; + +export default DataProcessor; diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..261eeb9 --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/README.md b/README.md new file mode 100644 index 0000000..5807fe1 --- /dev/null +++ b/README.md @@ -0,0 +1 @@ +# example-javascript \ No newline at end of file diff --git a/UserProfile.js b/UserProfile.js new file mode 100644 index 0000000..5527e29 --- /dev/null +++ b/UserProfile.js @@ -0,0 +1,72 @@ +// File: UserProfile.js + +import React, { useState, useEffect } from 'react'; +import { useSelector, useDispatch } from 'react-redux'; +import { Grid, TextField, Button } from '@mui/material'; +import { setUserDetails, updateUserPreferences } from '../../redux/slices/userSlice'; + +const UserProfile = () => { + // CORRECT: Local state for form inputs + const [formInputs, setFormInputs] = useState({ + name: '', + email: '', + bio: '' + }); + + // INCORRECT: Using local state for data that should be in Redux + const [userPreferences, setUserPreferences] = useState({ + theme: 'light', + notifications: true + }); + + // CORRECT: Redux usage + const dispatch = useDispatch(); + const userDetails = useSelector((state) => state.user.details); + const globalUserPreferences = useSelector((state) => state.user.preferences); + + // INCORRECT: Disabling eslint warning without proper justification + // eslint-disable-next-line + const unusedVariable = useSelector((state) => state.user.someUnusedState); + + useEffect(() => { + // Simulating API call to fetch user details + const fetchUserDetails = async () => { + // ... fetch logic + const userData = { name: 'John Doe', email: 'john@example.com', bio: 'Web developer' }; + dispatch(setUserDetails(userData)); + }; + fetchUserDetails(); + }, [dispatch]); + + const handleInputChange = (e) => { + setFormInputs({ ...formInputs, [e.target.name]: e.target.value }); + }; + + const handleSubmit = () => { + dispatch(setUserDetails(formInputs)); + // INCORRECT: Updating local state instead of Redux + setUserPreferences({ ...userPreferences, theme: 'dark' }); + // CORRECT: Updating Redux state + dispatch(updateUserPreferences({ theme: 'dark' })); + }; + + return ( + + + + + {/* More form fields */} + + + + + ); +}; + +export default UserProfile; diff --git a/catalogueIndex.js b/catalogueIndex.js new file mode 100644 index 0000000..65eda4c --- /dev/null +++ b/catalogueIndex.js @@ -0,0 +1,47 @@ +// File: catalogueIndex.js +// INCORRECT: File name doesn't follow the convention (should start with capital letter) + +import React, { useState } from 'react'; +import { Grid, Button, Modal } from '@mui/material'; +import { useSelector, useDispatch } from 'react-redux'; +import { setCurrentProduct } from '../../redux/slices/catalogueSlice'; + +// CORRECT: Component name follows camelCase with initial capital letter +const CatalogueIndex = () => { + // CORRECT: State naming convention + const [isProductModalOpen, setIsProductModalOpen] = useState(false); + + // INCORRECT: Poor state naming + const [is_open, setIs_open] = useState(false); + + // CORRECT: Redux usage + const dispatch = useDispatch(); + const currentProduct = useSelector((state) => state.catalogue.currentProduct); + + // CORRECT: Function naming and comment for complex logic + const handleProductSelection = (productId) => { + // This function handles the selection of a product, updates the Redux store, + // and opens the product modal + dispatch(setCurrentProduct(productId)); + setIsProductModalOpen(true); + }; + + // INCORRECT: Poor function naming and no comment for complex logic + const doStuff = (x) => { + dispatch(setCurrentProduct(x)); + setIs_open(true); + }; + + return ( + + {/* Component content */} + + + setIsProductModalOpen(false)}> + {/* Modal content */} + + + ); +}; + +export default CatalogueIndex;