feat: update deploy process to facilitate staging/prod environments

guanzo · guanzo · commit c6ecedc0bbb2 · 2023-11-06T14:18:30.000-08:00
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -4,16 +4,11 @@ on:
     branches:
       - "main"
     tags: ["*"]
-env:
-  ROOT_DOMAIN: strn.pl
 jobs:
   cicd:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-        with:
-          # https://github.com/filecoin-saturn-team token to allow force pushing to protected branches
-          token: ${{ secrets.FORCE_PUSH_TOKEN }}
 
       - uses: actions/setup-node@v2
         with:
@@ -25,33 +20,13 @@ jobs:
       - name: Run Tests
         run: npm run test
 
+      # Just checking if build succeeds.
       - name: Build
         env:
-          STATIC_ORIGIN: https://saturn.tech
-          L1_ORIGIN: https://l1s.saturn.ms
-          TRUSTED_L1_ORIGIN: https://saturn.ms
-          UNTRUSTED_L1_ORIGIN: https://l1s.saturn.ms
-          LOG_INGESTOR_URL: https://twb3qukm2i654i3tnvx36char40aymqq.lambda-url.us-west-2.on.aws
+          STATIC_FILE_ORIGIN: https://saturn-test.network
+          L1_ORIGIN: https://l1s.saturn-test.ms
+          TRUSTED_L1_ORIGIN: https://saturn-test.ms
+          LOG_INGESTOR_URL: https://p6wofrb2zgwrf26mcxjpprivie0lshfx.lambda-url.us-west-2.on.aws
+          JWT_AUTH_URL: https://fz3dyeyxmebszwhuiky7vggmsu0rlkoy.lambda-url.us-west-2.on.aws/
+          ORCHESTRATOR_URL: https://orchestrator.strn-test.pl/nodes?maxNodes=100
         run: npm run build
-
-      - uses: EndBug/add-and-commit@v9
-        if: github.ref_type == 'tag'
-        with:
-          add: "dist"
-          default_author: user_info
-          message: "[skip ci] CI Build"
-          push: origin HEAD:main --force
-
-      - name: Trigger ./dist/* file replication in filecoin-saturn/homepage repo
-        if: github.ref_type == 'tag'
-        run: |
-          code="$(curl -L \
-          -X POST \
-          -H "Accept: application/vnd.github+json" \
-          -H "Authorization: Bearer ${{secrets.ACCESS_TOKEN}}" \
-          -H "X-GitHub-Api-Version: 2022-11-28" \
-          https://api.github.com/repos/filecoin-saturn/homepage/actions/workflows/copy-retrieval-client-files.yml/dispatches \
-          -d '{"ref": "main"}' \
-          -sw "%{http_code}\n")"
-
-          test "$code" -eq 204 || exit 1
diff --git a/.gitignore b/.gitignore
@@ -3,5 +3,4 @@
 node_modules
 test-files
 
-# dist folder is watched by homepage git hook.
-dist/index.html
+dist/
diff --git a/README.md b/README.md
@@ -27,6 +27,16 @@ a requirement when retrieving content in a trustless manner from community hoste
 
    The service worker file can be found here: https://saturn.tech/saturn-sw.js
 
+## Deployment
+
+- To deploy to staging, push to `main`. Then trigger a staging homepage fleek deploy.
+
+- To deploy to production, push a tag. Then trigger a prod homepage fleek deploy.
+
+```bash
+git tag -m deploy $(date +%s)
+git push --follow-tags
+```
 
 ## License
 
diff --git a/bin/deploy.sh b/bin/deploy.sh
diff --git a/public/index.html b/public/index.html
@@ -2,7 +2,7 @@
 <html>
   <head>
     <meta charset="utf-8"/>
-    <script async src="<%= WIDGET_ORIGIN %>/widget.js#integration=<%= CLIENT_KEY %>"></script>
+    <script async src="<%= STATIC_FILE_ORIGIN %>/widget.js#integration=<%= CLIENT_KEY %>"></script>
     <style>
         :root {
             --cell-width: 400px;
diff --git a/src/sw/controller.js b/src/sw/controller.js
@@ -24,12 +24,14 @@ export class Controller {
 
     constructor () {
         this.clientId = getRetrievalClientId()
-        this.clientKey = getClientKey()
         this.saturn = new Saturn({
-            clientKey: this.clientKey,
+            cdnURL: process.env.L1_ORIGIN,
+            logURL: process.env.LOG_INGESTOR_URL,
+            orchURL: process.env.ORCHESTRATOR_URL,
+            authURL: process.env.JWT_AUTH_URL,
+            clientKey: getClientKey(),
             storage: indexedDbStorage()
         })
-
     }
 
     start () {
diff --git a/src/sw/interceptor.js b/src/sw/interceptor.js
@@ -28,7 +28,6 @@ export class Interceptor {
     }
 
     async fetch() {
-        const contentItr = await this.saturn.fetchContent(this.cidPath)
         const self = this
 
         const readableStream = new ReadableStream({
diff --git a/src/sw/saturn-sw.js b/src/sw/saturn-sw.js
@@ -10,7 +10,7 @@ import {
     DEDICATED_WORKER_PATH
 } from '@src/constants'
 
-const origin = process.env.STATIC_ORIGIN
+const origin = process.env.STATIC_FILE_ORIGIN
 
 if (typeof ServiceWorkerGlobalScope !== 'undefined') {
     const url = origin + SW_CORE_PATH
diff --git a/src/widget/widget-config.js b/src/widget/widget-config.js
@@ -1,7 +1,7 @@
 
 // Retrieves widget config based on the script tag url.
 
-export const WIDGET_BASE_URL = `${process.env.WIDGET_ORIGIN}/widget.js`
+export const WIDGET_BASE_URL = `${process.env.STATIC_FILE_ORIGIN}/widget.js`
 
 const CLIENT_KEY_IDENTIFIER = 'integration'
 
diff --git a/src/widget/widget.js b/src/widget/widget.js
@@ -57,7 +57,7 @@ function initWidget () {
     const config = widgetConfigFromScriptTag()
     const clientKey = config.clientKey
     addHeadElement('link', {
-        href: process.env.UNTRUSTED_L1_ORIGIN,
+        href: process.env.L1_ORIGIN,
         crossOrigin: '',
         rel: 'preconnect',
         id: 'saturn-preconnect'
diff --git a/webpack.config.js b/webpack.config.js
@@ -21,17 +21,15 @@ const devServerPort = 8030
 export default (env, { mode }) => {
     // Switch to .env files once this gets unwieldy
     const e = process.env
-    const STATIC_ORIGIN = e.STATIC_ORIGIN ?? 'http://localhost:8030'
+    const STATIC_FILE_ORIGIN = e.STATIC_FILE_ORIGIN ?? `http://localhost:${devServerPort}`
     const L1_ORIGIN = e.L1_ORIGIN ?? 'https://l1s.saturn-test.ms'
-    const TRUSTED_L1_ORIGIN = e.TRUSTED_L1_ORIGIN ?? 'https://l1s.saturn-test.ms'
-    const UNTRUSTED_L1_ORIGIN = e.UNTRUSTED_L1_ORIGIN ?? 'https://saturn-test.ms'
+    const TRUSTED_L1_ORIGIN = e.TRUSTED_L1_ORIGIN ?? 'https://saturn-test.ms'
     const LOG_INGESTOR_URL = e.LOG_INGESTOR_URL ?? 'https://p6wofrb2zgwrf26mcxjpprivie0lshfx.lambda-url.us-west-2.on.aws'
     const JWT_AUTH_URL = e.JWT_AUTH_URL ?? 'https://fz3dyeyxmebszwhuiky7vggmsu0rlkoy.lambda-url.us-west-2.on.aws'
-    const ORCHESTRATOR_URL = e.ORCHESTRATOR_URL ?? 'https://orchestrator.strn-test.pl/nodes'
-    const WIDGET_ORIGIN = e.WIDGET_ORIGIN ?? `http://localhost:${8030}`
+    const ORCHESTRATOR_URL = e.ORCHESTRATOR_URL ?? 'https://orchestrator.strn-test.pl/nodes?maxNodes=100'
 
     return {
-    // Uncomment snapshot for webpack to detect edits in node_modules/
+        // Uncomment snapshot for webpack to detect edits in node_modules/
         snapshot: {
             managedPaths: [],
         },
@@ -53,19 +51,17 @@ export default (env, { mode }) => {
         output: {
             path: abspath('dist'),
             clean: true,
-            publicPath: STATIC_ORIGIN + '/',
+            publicPath: STATIC_FILE_ORIGIN + '/',
         },
         plugins: [
             new webpack.EnvironmentPlugin({
                 COMMITHASH: JSON.stringify(gitPlugin.commithash()),
-                STATIC_ORIGIN,
+                STATIC_FILE_ORIGIN,
                 L1_ORIGIN,
                 TRUSTED_L1_ORIGIN,
-                UNTRUSTED_L1_ORIGIN,
                 LOG_INGESTOR_URL,
                 JWT_AUTH_URL,
                 ORCHESTRATOR_URL,
-                WIDGET_ORIGIN
             }),
             new ESLintPlugin({
                 emitError: false,
@@ -80,7 +76,7 @@ export default (env, { mode }) => {
                 templateParameters: {
                     // Arc prod client key
                     CLIENT_KEY: '1205a0fe-142c-40a2-a830-8bbaf6382c3f',
-                    WIDGET_ORIGIN,
+                    STATIC_FILE_ORIGIN,
                 }
             })
         ],

Original file line number	Diff line number	Diff line change
`@@ -28,7 +28,6 @@ export class Interceptor {`
`28`	`28`	`}`
`29`	`29`
`30`	`30`	`async fetch() {`
`31`		`- const contentItr = await this.saturn.fetchContent(this.cidPath)`
`32`	`31`	`const self = this`
`33`	`32`
`34`	`33`	`const readableStream = new ReadableStream({`