Merge pull request #110 from topcoder-platform/dev

Uni Nav in Online Review Release - 2023-01-10 -> master

Author: testflyjets

.circleci/config.yml

@@ -44,7 +44,7 @@ running_npm_build: &running_npm_build
     name: Running npm Build
     command: |
         npm install
-        npm run build
+        APP_ENV=${LOGICAL_ENV} npm run build
 
 workspace_persist: &workspace_persist
     root: .
@@ -58,29 +58,49 @@ running_version_patch: &running_version_patch
     name: Patching Version
     command: |
         npm install
-        git config user.name brooketopcoder
-        git config user.email brooke.souza@topcoder.com
+        git config user.name $CIRCLE_USERNAME
+        git config user.email security@topcoder.com
         npm version patch -m "Increment Version [ci skip]"
-        git push --set-upstream origin master
+        git push --set-upstream origin $CIRCLE_BRANCH
 
 update_types: &update_types
     name: Updating Types
     command: |
         npm ci
         npm run types
         diffstatus=$(git status --porcelain)
-        git config user.name brooketopcoder
-        git config user.email brooke.souza@topcoder.com
+        git config user.name $CIRCLE_USERNAME
+        git config user.email security@topcoder.com
         git add types
         git diff-index --cached --quiet HEAD || git commit -m "Add Types [ci skip]"
-        git push --set-upstream origin master
+        git push --set-upstream origin $CIRCLE_BRANCH
+
+check_types: &check_types
+    name: Checking Types
+    command: |
+        npm ci
+        npm run types
+        diffstatus=$(git status --porcelain)
+        git config user.name $CIRCLE_USERNAME
+        git config user.email [email protected]
+        git add types
+        git diff-index --cached --quiet HEAD || echo 'WARNING: Types need updating'
+        git diff-index --cached --quiet HEAD || exit 1
 
 finger_print_add: &finger_print_add
     fingerprints:
             - "a5:ad:51:96:10:a9:09:fb:7b:b4:fc:b7:08:df:ab:fa"
 
 # DEFINE STEPS FOR JOBS
 
+check_types_steps: &check_types_steps
+    - add_ssh_keys: *finger_print_add          
+    - checkout
+    - setup_remote_docker
+    - run: *install_build_dependency
+    - run: *install_deploysuite
+    - run: *check_types
+
 build_steps_prod: &build_steps_prod
     # Initialization.
     - add_ssh_keys: *finger_print_add          
@@ -118,6 +138,14 @@ deploy_steps: &deploy_steps
 
 jobs:
 
+    check-types:
+        <<: *defaults
+        environment:
+            DEPLOY_ENV: "DEV"
+            LOGICAL_ENV: "dev"
+            APPNAME: "universal-navigation"
+        steps: *check_types_steps
+
     build-dev:
         <<: *defaults
         environment:
@@ -158,6 +186,13 @@ workflows:
     build:
         jobs:
 
+            - check-types:
+                context : org-global
+                filters:
+                    branches:
+                        ignore:
+                            - master
+                            
             - build-dev:
                 context : org-global
                 filters:

README.md

@@ -75,6 +75,8 @@ See the [IAC README](../iac/README.md) for instructions for deploying the stack.
 The dev version of the UniNav script allows the following origins.
 
 Customer & Member Mktg
+- https://topcoder.com
+- https://www.topcoder.com
 - https://topcoder-dev.com
 - https://www.topcoder-dev.com
 

iac/uni-nav.deploy.yml

@@ -80,14 +80,32 @@ Resources:
                         Items:
 
                             # Customer & Member Marketing Prod & Dev
-                            - !Sub https://${Domain} 
-                            - !Sub https://www.${Domain}
+                            - https://www.topcoder.com
+                            - https://topcoder.com
+
+                            # Customer Marketing Dev
+                            - !If 
+                                - IsProd
+                                - !Ref AWS::NoValue
+                                - !Sub https://${Domain} 
+                            - !If 
+                                - IsProd
+                                - !Ref AWS::NoValue
+                                - !Sub https://www.${Domain}
+                            - !If 
+                                - IsProd
+                                - !Ref AWS::NoValue
+                                - https://uninav.topcoder.com
 
                             # Customer Marketing Local
                             - !If 
                                 - IsProd
                                 - !Ref AWS::NoValue
-                                - http://localhost
+                                - http://localhost:8080 
+                            - !If 
+                                - IsProd
+                                - !Ref AWS::NoValue
+                                - http://topcoder.topcoder-dev.com
 
                             # Forum Prod & Dev
                             - !Sub https://discussions.${Domain} 

index.html

@@ -52,6 +52,7 @@
 
       tcUniNav('init', 'footer-el', {
         type: 'footer',
+        fullFooter: true,
       })
 
       tcUniNav('update', 'tool-nav', {

package.json

@@ -7,13 +7,14 @@
     "types": "./types/src/main.d.ts",
     "repository": "https://github.com/topcoder-platform/universal-navigation.git",
     "scripts": {
-        "build:footer": "APP_BUILD_TARGET=footer vite build",
-        "build:marketing": "APP_BUILD_TARGET=marketing vite build",
-        "build:tool": "APP_BUILD_TARGET=tool vite build",
+        "build:footer": "APP_BUILD_TARGET=footer vite build --mode=$NODE_ENV",
+        "build:marketing": "APP_BUILD_TARGET=marketing vite build --mode=$NODE_ENV",
+        "build:tool": "APP_BUILD_TARGET=tool vite build --mode=$NODE_ENV",
         "build:navs": "npm run build:marketing & npm run build:footer && npm run build:tool",
-        "build": "npm run build:navs && vite build && npx rimraf ./types && npm run types",
+        "build:base": "npm run build:navs && vite build --mode=$NODE_ENV && npx rimraf ./types && npm run types",
+        "build": "NODE_ENV=production npm run build:base",
         "check": "svelte-check --tsconfig ./tsconfig.json",
-        "demo:dist": "npx http-server --cors --host localhost --port 8080 ./dist",
+        "demo:dist": "npx http-server --cors --host localhost --port 8083 ./dist",
         "demo:marketing": "npx http-server --host localhost --port 8081 ./demo/marketing -P http://localhost:8081? -o /",
         "demo:tool": "npx http-server --host localhost --port 8082 ./demo/tool -P http://localhost:8081? -o /",
         "demo": "npx npm-run-all -p demo:*",

public/assets/icon-arrow.svg

@@ -49,7 +49,7 @@ There are 2 sample integrations in the [/demo](./demo/) folder:
 
 2. Serve the demo app
     - `% npm run demo`
-    - http://localhost:8080
+    - http://localhost:8083
 
 3. Navigate to the specific nav:
     - Marketing Nav: http://localhost:8081
@@ -67,12 +67,14 @@ The build reads the app version in `package.json` and automatically outputs the
 
 ## Typescript Type Declaration Generation
 
-Typescript type declarations (i.e. `*.d.ts`) are automatically generated for each branch as part of the Github build worklow.
+Typescript type declarations (i.e. `*.d.ts`) are automatically generated upon build. When developing the nav, it is preferred that each branch regenerates its types before PR merge.
 
-After pushing changes to Github, Github builds the app and automatically runs the command to generate types. 
+However, this is obviously error prone, so every time a push is made to master, the CI process will  regenerate the types and commit them to the master branch if there are differences.
 
-If there are any differences, Github automatically commits those into the branch.
+In addition, all pushes to the master branch will automatically increment the patch version number, which will allow the consumers of the types to get the updates with `npm update` or `yarn upgrade`.
 
-If a PR exists for a branch that has out of date types, the PR will display an error until the types are generated and committed, but it will not pervent the merging of the PR.
+Both the types commit and the version patch commit will be authored by the user who merged the PR.
 
->**NOTE** In order to disseminate updates to the types via npm, you must increment the version number in the [../package.json](../package.json).
+For non-master branches, there is a build job in the CI that will check to see if there are any updates to the types required and exit with an error code 1 with message `WARNING: Types need updating`.
+
+The error will not prevent merging a PR or deploying to an environment but will just be a flag for the PR owner and reviewers.