Deploy to Production – 2023-12-18

LICENSE.txt

@@ -1,6 +1,6 @@
 AI Incident Database: A program for the archiving of artificial intelligence incidents.
 
-Copyright (C) 2022  Responsible AI Collaborative, Inc.
+Copyright (C) 2023  Responsible AI Collaborative, Inc.
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

README.md

@@ -448,6 +448,12 @@ GATSBY_EXCLUDE_DATASTORE_FROM_BUNDLE=1 # specific to Netlify, for large sites
 GATSBY_CPU_COUNT=2 # limits the number of Gatsby threads, helping with deployment stability
 NODE_VERSION=18 # this is required by Gatsby v5
 NODE_OPTIONS=--max-old-space-size=4096 # increase default heap size to prevent crashes during build
+# The following "CLOUDFLARE_R2" variables are required to create the /research/snapshots/ page
+CLOUDFLARE_R2_ACCOUNT_ID=[The Cloudflare R2 account ID (e.g.: 8f4144a9d995a9921d0200db59f6a00e)]
+CLOUDFLARE_R2_ACCESS_KEY_ID=[The Cloudflare R2 access key ID (e.g.: 7aa73208bc89cee3195879e578b291ee)]
+CLOUDFLARE_R2_SECRET_ACCESS_KEY=[The Cloudflare R2 secret access key]
+CLOUDFLARE_R2_BUCKET_NAME=[The Cloudflare R2 bucket name (e.g.: 'aiid-public')]
+GATSBY_CLOUDFLARE_R2_PUBLIC_BUCKET_URL=[The Cloudflare R2 public bucket URL (e.g.: https://pub-daddb16dc28841779b83690f75eb5c58.r2.dev)]
 ```
 ### Github Actions
 Two workflows take care of deploying the Realm app to both `production` and `staging` environments, defined in `realm-production.yml` and `realm-staging.yml`. Each workflow looks for environment variables defined in a GitHub Environment named `production` and `staging`. 

site/gatsby-site/config.js

@@ -201,6 +201,13 @@ const config = {
   rollbar: {
     token: process.env.GATSBY_ROLLBAR_TOKEN,
   },
+  cloudflareR2: {
+    accountId: process.env.CLOUDFLARE_R2_ACCOUNT_ID,
+    accessKeyId: process.env.CLOUDFLARE_R2_ACCESS_KEY_ID,
+    secretAccessKey: process.env.CLOUDFLARE_R2_SECRET_ACCESS_KEY,
+    bucketName: process.env.CLOUDFLARE_R2_BUCKET_NAME,
+    publicBucketUrl: process.env.GATSBY_CLOUDFLARE_R2_PUBLIC_BUCKET_URL,
+  },
 };
 
 module.exports = config;

site/gatsby-site/cypress/e2e/integration/apps/checklistsForm.cy.js

@@ -4,6 +4,18 @@ const { gql } = require('@apollo/client');
 describe('Checklists App Form', () => {
   const url = '/apps/checklists?id=testChecklist';
 
+  const defaultChecklist = {
+    __typename: 'Checklist',
+    about: '',
+    id: 'testChecklist',
+    name: 'Test Checklist',
+    owner_id: 'a-fake-user-id-that-does-not-exist',
+    risks: [],
+    tags_goals: [],
+    tags_methods: [],
+    tags_other: [],
+  };
+
   const usersQuery = {
     query: gql`
       {
@@ -19,27 +31,36 @@ describe('Checklists App Form', () => {
     timeout: 120000, // mongodb admin api is extremely slow
   };
 
-  it('Should have read-only access for non-logged-in users', () => {
+  const withLogin = (callback) => {
+    cy.login(Cypress.env('e2eUsername'), Cypress.env('e2ePassword'));
+
+    cy.query(usersQuery).then(({ data: { users } }) => {
+      const user = users.find((user) => user.adminData.email == Cypress.env('e2eUsername'));
+
+      callback({ user });
+    });
+  };
+
+  const interceptFindChecklist = (checklist) => {
     cy.conditionalIntercept(
       '**/graphql',
       (req) => req.body.operationName == 'findChecklist',
       'findChecklist',
-      {
-        data: {
-          checklist: {
-            __typename: 'Checklist',
-            about: '',
-            id: 'testChecklist',
-            name: 'Test Checklist',
-            owner_id: 'a-fake-user-id-that-does-not-exist',
-            risks: [],
-            tags_goals: [],
-            tags_methods: [],
-            tags_other: [],
-          },
-        },
-      }
+      { data: { checklist } }
     );
+  };
+
+  const interceptUpsertChecklist = (checklist) => {
+    cy.conditionalIntercept(
+      '**/graphql',
+      (req) => req.body.operationName == 'upsertChecklist',
+      'upsertChecklist',
+      { data: { checklist } }
+    );
+  };
+
+  it('Should have read-only access for non-logged-in users', () => {
+    interceptFindChecklist(defaultChecklist);
 
     cy.visit(url);
 
@@ -55,26 +76,7 @@ describe('Checklists App Form', () => {
   maybeIt('Should have read-only access for logged-in non-owners', () => {
     cy.login(Cypress.env('e2eUsername'), Cypress.env('e2ePassword'));
 
-    cy.conditionalIntercept(
-      '**/graphql',
-      (req) => req.body.operationName == 'findChecklist',
-      'findChecklist',
-      {
-        data: {
-          checklist: {
-            __typename: 'Checklist',
-            about: '',
-            id: 'testChecklist',
-            name: 'Test Checklist',
-            owner_id: 'a-fake-user-id-that-does-not-exist',
-            risks: [],
-            tags_goals: [],
-            tags_methods: [],
-            tags_other: [],
-          },
-        },
-      }
-    );
+    interceptFindChecklist(defaultChecklist);
 
     cy.visit(url);
 
@@ -88,51 +90,13 @@ describe('Checklists App Form', () => {
   });
 
   maybeIt('Should allow editing for owner', () => {
-    cy.login(Cypress.env('e2eUsername'), Cypress.env('e2ePassword'));
-
-    cy.query(usersQuery).then(({ data: { users } }) => {
-      const user = users.find((user) => user.adminData.email == Cypress.env('e2eUsername'));
-
-      cy.conditionalIntercept(
-        '**/graphql',
-        (req) => req.body.operationName == 'findChecklist',
-        'findChecklist',
-        {
-          data: {
-            checklist: {
-              __typename: 'Checklist',
-              about: '',
-              id: 'testChecklist',
-              name: 'Test Checklist',
-              owner_id: user.userId,
-              risks: [],
-              tags_goals: [],
-              tags_methods: [],
-              tags_other: [],
-            },
-          },
-        }
-      );
-      cy.conditionalIntercept(
-        '**/graphql',
-        (req) => req.body.operationName == 'upsertChecklist',
-        'upsertChecklist',
-        {
-          data: {
-            checklist: {
-              __typename: 'Checklist',
-              about: "It's a system that does something probably.",
-              id: 'testChecklist',
-              name: 'Test Checklist',
-              owner_id: user.userId,
-              risks: [],
-              tags_goals: [],
-              tags_methods: [],
-              tags_other: [],
-            },
-          },
-        }
-      );
+    withLogin(({ user }) => {
+      interceptFindChecklist({ ...defaultChecklist, owner_id: user.userId });
+      interceptUpsertChecklist({
+        ...defaultChecklist,
+        owner_id: user.userId,
+        about: "It's a system that does something probably.",
+      });
 
       cy.visit(url);
 

site/gatsby-site/cypress/e2e/integration/apps/checklistsIndex.cy.js

@@ -36,7 +36,13 @@ describe('Checklists App Index', () => {
     cy.get(newChecklistButtonQuery).should('exist');
   });
 
-  maybeIt('Should show delete buttons only for owned checklists', () => {
+  /* We're now showing only the user's owned checklists,
+   * so we can't test that the delete button doesn't show up on unowned ones.
+   * Eventually, we'll probably have public checklists show up here too,
+   * so this can be skipped with a TODO to activate it
+   * once there are unowned checklists displayed.
+   */
+  it.skip('Should show delete buttons only for owned checklists', () => {
     cy.login(Cypress.env('e2eUsername'), Cypress.env('e2ePassword'));
 
     cy.query(usersQuery).then(({ data: { users } }) => {

site/gatsby-site/cypress/e2e/integration/snapshots.cy.js

@@ -0,0 +1,30 @@
+import { conditionalIt } from '../../support/utils';
+
+describe('The Database Snapshots Page', () => {
+  const url = '/research/snapshots';
+
+  it('Successfully loads', () => {
+    cy.visit(url);
+  });
+
+  conditionalIt(
+    !Cypress.env('isEmptyEnvironment'),
+    'Should display a list of snapshots to download',
+    () => {
+      cy.visit(url);
+
+      cy.get('[data-cy="snapshots-list"] li')
+        .should('exist')
+        .and('be.visible')
+        .and('have.length.gt', 0);
+
+      cy.get('[data-cy="snapshots-list"] li').each((item) => {
+        expect(item[0].innerText).to.match(
+          /^\d{4}-\d{2}-\d{2} \d{1,2}:\d{2} (AM|PM) · \d+(\.\d{2})? MB · backup-\d{14}\.tar\.bz2$/
+        );
+
+        expect(item.find('a').attr('href')).to.match(/^https:\/\/.*\/backup-\d{14}\.tar\.bz2$/);
+      });
+    }
+  );
+});

site/gatsby-site/cypress/e2e/integration/socialShareButtons.cy.js

@@ -26,7 +26,7 @@ describe('Social Share buttons on pages', { retries: { runMode: 4 } }, () => {
     });
   }
 
-  urlsToTest.forEach(({ page, url, shareButtonSections }) => {
+  urlsToTest.forEach(({ page, url, title, shareButtonSections }) => {
     it(`${page} page should have ${shareButtonSections} Social Share button sections`, () => {
       cy.visit(url);
 
@@ -38,8 +38,7 @@ describe('Social Share buttons on pages', { retries: { runMode: 4 } }, () => {
     const canonicalUrl = `https://incidentdatabase.ai${url}`;
 
     // Twitter share
-    // TODO: https://github.com/responsible-ai-collaborative/aiid/issues/2481
-    it.skip(`${page} page should have a Twitter share button`, () => {
+    it(`${page} page should have a Twitter share button`, () => {
       cy.visit(url);
 
       cy.get('[data-cy=btn-share-twitter]').should('exist');
@@ -57,9 +56,8 @@ describe('Social Share buttons on pages', { retries: { runMode: 4 } }, () => {
       cy.get('@popup_twitter', { timeout: 8000 }).should('be.called');
       cy.url().should(
         'contain',
-        `https://twitter.com/i/flow/login?redirect_after_login=%2Fintent%2Ftweet%3Ftext%3D`
+        `https://twitter.com/intent/tweet?text=${encodeURI(title)}&url=${canonicalUrl}`
       );
-      cy.url().should('contain', `url%3D${encodeURIComponent(canonicalUrl)}`);
     });
 
     // LinkedIn share

site/gatsby-site/gatsby-config.js

@@ -220,20 +220,6 @@ const plugins = [
       ],
     },
   },
-  {
-    resolve: `gatsby-source-s3`,
-    options: {
-      aws: {
-        // This AWS IAM user has been provisioned no permissions, but the plugin requires a user to
-        // get a listing of the public S3 bucket. User: backupindexpublic
-        accessKeyId: 'AKIA25BP4AERUFDGAJUJ',
-        secretAccessKeyId: 'backupindexpublic',
-        secretAccessKey: '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',
-      },
-      buckets: ['aiid-backups-public'],
-      // expiration: 120,
-    },
-  },
   {
     resolve: `gatsby-theme-i18n`,
     options: {