Skip to content
Merged
Show file tree
Hide file tree
Changes from 6 commits
Commits
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
85 changes: 41 additions & 44 deletions .circleci/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -48,45 +48,44 @@ build_docker_image: &build_docker_image
./build.sh
no_output_timeout: 20m

build_steps: &build_steps
# Initialization.
- checkout
- setup_remote_docker
- run: *install_dependency
- run: *install_deploysuite
# Restoration of node_modules from cache.
# - restore_cache: *restore_cache_settings_for_build
# Build of Docker image.
- run:
name: "configuring environment"
command: |
./awsconfiguration.sh ${DEPLOY_ENV}
source awsenvconf
./psvar-processor.sh -t appenv -p /config/${APPNAME}/buildvar
source buildvar_env
# ./buildenv.sh -e ${DEPLOY_ENV} -b dev_communityapp_buildvar,dev_communityapp_deployvar -l dev_communityapp_buildvar_ps
- run: *build_docker_image
# Caching node modules.
# - save_cache: *save_cache_settings
# Deployment.
- deploy:
name: Running MasterScript
command: |
source awsenvconf
# source buildenvvar
./psvar-processor.sh -t appenv -p /config/${APPNAME}/deployvar
source deployvar_env
./master_deploy.sh -d ECS -e $DEPLOY_ENV -t latest -j /config/${APPNAME}/appvar -i ${APPNAME} -p FARGATE
# ./master_deploy.sh -d ECS -e DEV -t latest -s dev_communityapp_taskvar -i communityapp -p FARGATE
if [ "${DEPLOY_ENV}" = "PROD" ];
then
# Executing plan
curl --request POST \
--url https://circleci.com/api/v2/project/github/$CIRCLE_PROJECT_USERNAME/$CIRCLE_PROJECT_REPONAME/pipeline \
--header "Circle-Token: ${CIRCLE_TOKEN}" \
--header 'content-type: application/json' \
--data '{"branch":"'"$CIRCLE_BRANCH"'","parameters":{"run_smoketesting":true , "run_performancetesting":false, "run_basedeployment": false}}'
fi
build_steps: &build_steps # Initialization.
- checkout
- setup_remote_docker
- run: *install_dependency
- run: *install_deploysuite
# Restoration of node_modules from cache.
# - restore_cache: *restore_cache_settings_for_build
# Build of Docker image.
- run:
name: "configuring environment"
command: |
./awsconfiguration.sh ${DEPLOY_ENV}
source awsenvconf
./psvar-processor.sh -t appenv -p /config/${APPNAME}/buildvar
source buildvar_env
# ./buildenv.sh -e ${DEPLOY_ENV} -b dev_communityapp_buildvar,dev_communityapp_deployvar -l dev_communityapp_buildvar_ps
- run: *build_docker_image
# Caching node modules.
# - save_cache: *save_cache_settings
# Deployment.
- deploy:
name: Running MasterScript
command: |
source awsenvconf
# source buildenvvar
./psvar-processor.sh -t appenv -p /config/${APPNAME}/deployvar
source deployvar_env
./master_deploy.sh -d ECS -e $DEPLOY_ENV -t latest -j /config/${APPNAME}/appvar -i ${APPNAME} -p FARGATE
# ./master_deploy.sh -d ECS -e DEV -t latest -s dev_communityapp_taskvar -i communityapp -p FARGATE
if [ "${DEPLOY_ENV}" = "PROD" ];
then
# Executing plan
curl --request POST \
--url https://circleci.com/api/v2/project/github/$CIRCLE_PROJECT_USERNAME/$CIRCLE_PROJECT_REPONAME/pipeline \
--header "Circle-Token: ${CIRCLE_TOKEN}" \
--header 'content-type: application/json' \
--data '{"branch":"'"$CIRCLE_BRANCH"'","parameters":{"run_smoketesting":true , "run_performancetesting":false, "run_basedeployment": false}}'

Choose a reason for hiding this comment

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

[❗❗ security]
The curl command uses the Circle-Token in the header, which is sensitive information. Ensure that this token is stored securely and not exposed in logs or error messages. Consider using environment variables or CircleCI's built-in secrets management to handle sensitive data.

fi

jobs:
# Build & Deploy against development backend
Expand All @@ -95,7 +94,7 @@ jobs:
environment:
DEPLOY_ENV: "DEV"
LOGICAL_ENV: "dev"
APPNAME: "community-app"
APPNAME: "community-app"
steps: *build_steps

# Build & Deploy against production backend
Expand All @@ -107,7 +106,6 @@ jobs:
APPNAME: "community-app"
steps: *build_steps


# Test job for the cases when we do not need deployment. It just rapidly
# installs (updates) app dependencies, and runs tests (ESLint, Stylelint,
# Jest unit-tests).
Expand All @@ -123,7 +121,7 @@ jobs:
command: git config --global url."https://git@".insteadOf git://
- run:
name: App npm install
command: npm install
command: npm ci

Choose a reason for hiding this comment

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

[⚠️ correctness]
Switching from npm install to npm ci is a good practice for CI environments as it ensures a clean install based on the lock file. However, ensure that the package-lock.json is up-to-date and committed to the repository to avoid discrepancies between local and CI environments.

no_output_timeout: 20m
- save_cache:
key: test-node-modules-{{ checksum "package-lock.json" }}
Expand Down Expand Up @@ -181,8 +179,7 @@ workflows:
branches:
only:
- develop
- v6
- PM-2479
- PM-3204_cookies-utm-codes_only

- "build-prod":
context: org-global
Expand Down
2 changes: 1 addition & 1 deletion Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -165,7 +165,7 @@ ENV TOPGEAR_ALLOWED_SUBMISSIONS_DOMAINS=$TOPGEAR_ALLOWED_SUBMISSIONS_DOMAINS

RUN npm config set unsafe-perm true
RUN git config --global url."https://git@".insteadOf git://
RUN npm install
RUN npm ci

Choose a reason for hiding this comment

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

[⚠️ correctness]
Switching from npm install to npm ci is a good practice for CI/CD environments as it ensures a clean install based on the package-lock.json file, leading to more consistent builds. However, ensure that the package-lock.json file is up-to-date and committed to the repository, as npm ci will fail if the file is missing or out of sync with package.json.

RUN npm test
RUN npm run build

Expand Down
47 changes: 33 additions & 14 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -162,9 +162,9 @@
"showdown": "^1.8.6",
"slick-carousel": "^1.8.1",
"supertest": "^3.1.0",
"tc-core-library-js": "github:appirio-tech/tc-core-library-js#v2.6.3.1",
"tc-core-library-js": "github:topcoder-platform/tc-core-library-js#master",
"tc-ui": "^1.0.12",
"topcoder-react-lib": "github:topcoder-platform/topcoder-react-lib#auth0",
"topcoder-react-lib": "github:topcoder-platform/topcoder-react-lib#develop",
"topcoder-react-ui-kit": "2.0.1",
"topcoder-react-utils": "github:topcoder-platform/topcoder-react-utils#v6",
"turndown": "^4.0.2",
Expand Down
7 changes: 6 additions & 1 deletion src/shared/containers/challenge-detail/index.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,7 @@ import { getService } from 'services/contentful';
import { getSubmissionArtifacts as getSubmissionArtifactsService } from 'services/submissions';
import getReviewSummationsService from 'services/reviewSummations';
import { buildMmSubmissionData, buildStatisticsData } from 'utils/mm-review-summations';
import { appendUtmParamsToUrl } from 'utils/utm';
// import {
// getDisplayRecommendedChallenges,
// getRecommendedTags,
Expand Down Expand Up @@ -349,7 +350,11 @@ class ChallengeDetailPageContainer extends React.Component {
} = this.props;
if (!auth.tokenV3) {
const utmSource = communityId || 'community-app-main';
window.location.href = `${config.URL.AUTH}/member?retUrl=${encodeURIComponent(`${window.location.origin}${window.location.pathname}`)}&utm_source=${utmSource}&regSource=challenges`;
window.location.href = appendUtmParamsToUrl(

Choose a reason for hiding this comment

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

[❗❗ security]
The appendUtmParamsToUrl function is used to construct the URL with UTM parameters. Ensure that this function properly encodes all URL components to prevent any potential URL injection vulnerabilities.

`${config.URL.AUTH}/member?retUrl=${encodeURIComponent(`${window.location.origin}${window.location.pathname}`)}&regSource=challenges`, {
utm_source: utmSource,
},
);
} else {
// Show security reminder to all registrants
this.setState({
Expand Down
69 changes: 69 additions & 0 deletions src/shared/utils/utm.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
// UTM cookie configuration constants
const TC_UTM_COOKIE_NAME = 'tc_utm';

/**
* Retrieves and parses the tc_utm cookie
* @returns Parsed UTM parameters or null if cookie doesn't exist
*/
export function getUtmCookie() {
try {
const cookies = document.cookie.split(';');
const cookieStr = cookies.find(cookie => cookie.trim().startsWith(`${TC_UTM_COOKIE_NAME}=`));

if (!cookieStr) {
return null;
}

// handle values that might contain '='
const cookieValue = decodeURIComponent(cookieStr.split('=').slice(1).join('='));
return JSON.parse(cookieValue);

Choose a reason for hiding this comment

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

[⚠️ maintainability]
Consider logging the error or providing more context in the catch block to aid in debugging if JSON parsing fails.

} catch (error) {
return null;
}
}

/**
* Appends UTM parameters from the tc_utm cookie to a given URL
* Only appends parameters that exist in the cookie
* @param url - The base URL to append parameters to
* @returns URL with UTM parameters appended, or original URL if no cookie exists
*/
export function appendUtmParamsToUrl(url, defaultParams = {}) {
if (!url) {
return url;
}

const utmParams = getUtmCookie();

// If there are no cookie params and no defaults, nothing to do
if (
(!utmParams || Object.keys(utmParams).length === 0)
&& (!defaultParams || Object.keys(defaultParams).length === 0)
) {
return url;
}

try {
const urlObj = new URL(url, window.location.origin);
const paramNames = ['utm_source', 'utm_medium', 'utm_campaign'];

paramNames.forEach((param) => {
const cookieVal = utmParams && utmParams[param];
const defaultVal = defaultParams && defaultParams[param];

// Cookie takes precedence and will overwrite existing query param
if (cookieVal) {
urlObj.searchParams.set(param, cookieVal);
} else if (defaultVal) {
// Only apply default if the URL does not already have the param
if (!urlObj.searchParams.has(param)) {
urlObj.searchParams.set(param, defaultVal);
}
}
});

return urlObj.toString();
} catch (error) {
return url;

Choose a reason for hiding this comment

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

[⚠️ maintainability]
Consider logging the error or providing more context in the catch block to aid in debugging if URL manipulation fails.

}
}
Loading