Add hash to not update Notion if nothing changes (avoids flooding your Notion updates un-necessarily)

Author: cliftonc

dist/index.js

@@ -1455,6 +1455,32 @@ SOFTWARE.
 
 
 
+object-hash
+MIT
+The MIT License (MIT)
+
+Copyright (c) 2014 object-hash contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+
+
 octokit
 MIT
 The MIT License

dist/licenses.txt

@@ -19,6 +19,7 @@
     "@actions/github": "^5.0.0",
     "@notionhq/client": "^0.4.11",
     "@tryfabric/martian": "^1.1.1",
+    "object-hash": "^2.2.0",
     "octokit": "^1.7.1",
     "yaml": "^1.10.2"
   },

package-lock.json

@@ -27,6 +27,7 @@ This action expects a Notion database with the following properties, this will b
   - Language: select
   - Status: select
   - Updated: date
+  - Hash: text
 
 The following notion page and database is connected to the tests by default, and can be used as a template: https://infinitaslearning.notion.site/Notion-Github-Catalogue-ac2395eda37144e698e6b8faef1003c7
 

package.json

@@ -13,7 +13,7 @@ const getRepos = async () => {
 
   const parseServiceDefinition = async (repo, path, pushMissing) => {
     const repoData = []
-    core.debug(`Processing ${path} ...`)
+    core.debug(`Processing ${path} in ${repo.name} ...`)
     try {
       const { data } = await octokit.request('GET /repos/{owner}/{repo}/contents/{path}', {
         owner: repo.full_name.split('/')[0],

readme.md

@@ -4,9 +4,9 @@ const process = require('process')
 
 process.env.INPUT_NOTION_TOKEN = process.env.NOTION_TOKEN
 process.env.INPUT_GITHUB_TOKEN = process.env.GITHUB_TOKEN
-process.env.INPUT_REPOSITORY_TYPE = 'all'
+process.env.INPUT_REPOSITORY_TYPE = 'public'
 process.env.INPUT_GITHUB_OWNER = 'infinitaslearning'
-process.env.INPUT_REPOSITORY_FILTER = 'notion-github-catalog'
+process.env.INPUT_REPOSITORY_FILTER = '.*'
 process.env.INPUT_DATABASE = 'cecaf0beb15945158d155866ff9acce8'
 process.env.INPUT_OWNER_DATABASE = '7943615f4dba43b3a3b0f991f4f7136d'
 process.env.INPUT_SYSTEM_DATABASE = '121534684fe840a1953500e603c2b602'

src/github.js

@@ -2,6 +2,12 @@ const core = require('@actions/core')
 const { ensureLinks } = require('./links')
 const { getDependsOn } = require('./depends')
 const { mappingFn } = require('./mappingFn')
+const hash = require('object-hash')
+
+let createdServices = 0
+let updatedServices = 0
+let skippedServices = 0
+let erroredServices = 0
 
 const updateServices = async (repositories, { notion, database, systems, owners, structure }) => {
   for (const repo of repositories) {
@@ -22,29 +28,38 @@ const updateServices = async (repositories, { notion, database, systems, owners,
     // Lets just update the first one to not make the problem worse
     if (search.results.length > 0) {
       const pageId = search.results[0].id
+      const pageHash = search.results[0].properties?.Hash?.rich_text[0]?.text?.content
       core.debug(`Updating notion info for ${repoName}`)
-      await updateNotionRow(repo, pageId, { notion, database, systems, owners, structure })
+      await updateNotionRow(repo, pageId, pageHash, { notion, database, systems, owners, structure })
     } else {
       core.debug(`Creating notion info for ${repoName}`)
       await createNotionRow(repo, { notion, database, systems, owners, structure })
     }
   }
+  core.info(`Completed with ${createdServices} created, ${updatedServices} updated, ${skippedServices} unchanged and ${erroredServices} with errors`)
 }
 
-const updateNotionRow = async (repo, pageId, { notion, database, systems, owners, structure }) => {
+const updateNotionRow = async (repo, pageId, pageHash, { notion, database, systems, owners, structure }) => {
   try {
     let dependsOn = []
     if (repo.spec?.dependsOn?.length > 0) {
       dependsOn = await getDependsOn(repo.spec.dependsOn, { notion, database })
     }
-    await notion.pages.update({
-      page_id: pageId,
-      properties: createProperties(repo, dependsOn, { systems, owners, structure })
-    })
+    const { properties, doUpdate } = createProperties(repo, pageHash, dependsOn, { systems, owners, structure })
+    if (doUpdate) {
+      await notion.pages.update({
+        page_id: pageId,
+        properties
+      })
+      updatedServices++
+    } else {
+      skippedServices++
+    }
     if (repo.metadata?.links) {
       await ensureLinks(pageId, repo.metadata.links, { notion })
     }
   } catch (ex) {
+    erroredServices++
     core.warning(`Error updating notion document for ${repo._repo.name}: ${ex.message} ...`)
   }
 }
@@ -55,29 +70,49 @@ const createNotionRow = async (repo, { notion, database, systems, owners, struct
     if (repo.spec?.dependsOn?.length > 0) {
       dependsOn = await getDependsOn(repo.spec.dependsOn, { notion, database })
     }
+    const { properties } = createProperties(repo, null, dependsOn, { systems, owners, structure })
     const page = await notion.pages.create({
       parent: {
         database_id: database
       },
-      properties: createProperties(repo, dependsOn, { systems, owners, structure })
+      properties
     })
+    createdServices++
     if (repo.metadata?.links) {
       await ensureLinks(page.id, repo.metadata.links, { notion })
     }
   } catch (ex) {
+    erroredServices++
     core.warning(`Error creating notion document for ${repo._repo.name}: ${ex.message}`)
   }
 }
 
-const createProperties = (repo, dependsOn, { systems, owners, structure }) => {
+const createProperties = (repo, pageHash, dependsOn, { systems, owners, structure }) => {
   // This iterates over the structure, executes a mapping function for each based on the data provided
-  const page = {}
+  const properties = {}
   for (const field of structure) {
     if (mappingFn[field.name]) {
-      page[field.name] = mappingFn[field.name](repo, { dependsOn, systems, owners })
+      properties[field.name] = mappingFn[field.name](repo, { dependsOn, systems, owners })
+    }
+  }
+  // Always have to check the hash afterwards, excluding the hash and the key
+  const newPageHash = hash(properties, {
+    excludeKeys: (key) => {
+      return key === 'Hash' || key === 'Updated'
     }
+  })
+
+  const doUpdate = newPageHash && newPageHash !== pageHash
+  properties.Hash = {
+    rich_text: [
+      {
+        text: {
+          content: newPageHash
+        }
+      }
+    ]
   }
-  return page
+  return { properties, doUpdate }
 }
 
 exports.updateServices = updateServices